| \n Property\n | \nDescription | \nEffect | \nRequired | \n \n
|---|---|---|---|
cart: Cart | \n Cart object from storefront API, and it is used for BOGOS app's logic. | \n\n useCart\n | \nYes | \n
publicStoreDomain: string | \n PUBLIC_STORE_DOMAIN | \n_ | \nYes | \n
publicStorefrontApiToken: string | \n PUBLIC_STOREFRONT_API_TOKEN | \n_ | \nYes | \n
publicStorefrontApiVersion: string | \n PUBLIC_STOREFRONT_API_VERSION | \n_ | \nYes | \n
bogosAccessToken: string | \n Access token generated by BOGOS app | \n_ | \nYes | \n
customerAccessToken?: string | \n \n It is customer access token. This field will be used if there is offer with sub-condition to track customer information: order history, customer tags, etc. \n If this property is used, it will be default when fetching customer information.\n | \n \n useCustomer,\n customer\n | \nNo | \n
customer?: Customer | \n Use this in case you already had customer information and do not want to fetch it again. | \n\n useCustomer,\n customer\n | \nNo | \n
others?: OthersSetting | \n Other settings for BOGOS | \n_ | \nNo | \n
renderCart?: Function | \n \n Use this property in case you already had function to re-render cart. It will be used after adding/removing gift from cart. By default, all the page will be reloaded.\n | \n\n useCart\n disableReloadCartUpdated\n | \nNo | \n
bogosCheckCartValid function to prevent gift invalid after checkout.\n\n ```typescript\n import {bogosCheckCartValid} from '@bogos/freegifts-hydrogen';\n\n async function {your_function_checkout} (args) {\n ...\n await bogosCheckCartValid({});\n ...\n }\n ```\n\n - Details of bogosCheckCartValid function\n\n ```typescript\n export type BogosCheckCartValidParams = {\n cart?: Cart | FGObject; /* If you don't want to fetch catch again */\n reloadIfInvalid?: boolean; /* Default: true. You don't want to reload page if invalid */\n callback?: (isValidCart: boolean) => void; /* If you want to do something after BOGOS check */\n };\n\n export declare const bogosCheckCartValid: (params: BogosCheckCartValidParams) => Promise| \n Property\n | \nDefault | \nDescription | \n \n
|---|---|---|
isPopUp?: boolean | \n true | \nYou can disable it or use it to customize the interface of gift popup/slide. | \n
customGiftImgSize?: string | \n &width=480&height=480 | \nIframe image product with Shopify Filters | \n
enableToastAdded?: boolean | \n false | \nEnable toast success when gifts are added. | \n
scaTextNotifySuccess?: string | \n \"Add gift to cart successfully!\" | \nText for toast success above. | \n
localesFormat?: string | \n \"en-US\" | \nCurrency format | \n
disableReloadCartUpdated?: boolean | \n false | \n\n Disable reloading page after gift changed (add/remove). You can use renderCart function instead\n | \n
| renderCart?: Function | \n_ | \n_ | \n
useCart?: boolean | \n false | \nSet true and use with cart | \n
useCustomer?: boolean | \n false | \nSet true and use with customer | \n
currencyCode?: string | \n your_store_currency | \n\n You can use different currency code from your default currency in Shopify.\n | \n
currencyRate?: number | \n 1 | \n\n Currency conversion rate from your store currency. Formula: Converted currency = Currency conversion rate x Store currency. \n Note: This property is used for display only\n | \n
useRateForOffer?: boolean | \n false | \n\n Use the currency conversion rate above for offer condition or not.\n | \n
disableBogosAttrCart?: boolean | \n false | \n\n Add cart attributes if the gift exists in the customer cart.\n | \n
numberOrders?: number | \n 20 | \n\n Number of orders to track on sub-condition of customers' order history.\n | \n
prefixProduct?: number | \n \"/products/\" | \n\n Path name product.\n | \n
toFixed?: number | \n 0 | \n\n Number of characters after \".\" \n E.g: 100.00\n | \n
debug?: boolean | \n true | \n\n Disable log for debug process.\n | \n
BOGOSGiftIcon\n\n ```typescript\n type GiftItem = {\n id: number;\n discount_type: 'percentage' | 'fixed_amount';\n discount_value: number;\n original_price: number; // Original price - price before discount\n price: number; // Discount price - price after discount\n title: string;\n thumbnail?: string;\n };\n\n type GiftProduct = {\n id: number;\n title: string;\n handle: string;\n thumbnail?: string;\n belongs_to_offer: string;\n variants: GiftItem[];\n };\n \n type FilterVariant = {\n id: string | number;\n title: string;\n price?: string | number;\n };\n\n type ProductInfo = {\n id: string | number;\n handle: string;\n title: string;\n price_max?: string | number;\n collections?: {\n id: string | number;\n title?: string;\n }[];\n product_type?: string;\n vendor?: string;\n variants?: FilterVariant[];\n };\n\n interface BOGOSGiftIconProps {\n product: ProductInfo;\n selectedVariant?: FilterVariant;\n enableForAllCondition?: boolean; /* Default false - only use with specific product condition */\n page: \"collection\" | \"product\";\n };\n\n /* Example Collection page or page has list products */\n BOGOSGiftThumbnail\n\n ```typescript\n /* Other type check above */\n \n interface Props {\n product: ProductInfo;\n selectedVariant?: FilterVariant;\n enableForAllCondition?: boolean;\n numberGiftsThumbnail?: number; /* Default: 3. Number of gift images can be shown per thumbnail */\n arrows?: boolean;\n dots?: boolean;\n prefixProduct?: string; /* Default: \"/products/\". Path name product */\n }\n\n /* Example Product page */\n BOGOSCartMessage\n\n ```typescript\n /* Other type check above */\n \n interface Props {\n delay?: number; /* Default: 3000 (ms). Time delay between auto scroll cart message */\n toFixed?: number; /* Default: 2. Number after '.' E.g: 100.00*/\n }\n\n /* Example */\n bogosCheckGift and use returned value to skip gift products or replace to other pages\n\n ```typescript\n import {bogosCheckGift} from '@bogos/freegifts-hydrogen';\n ```\n\n - Details of bogosCheckGift\n\n ```typescript\n export type ProductObject = {\n handle?: string;\n tags?: string[];\n };\n\n /* item can be product handle */\n export declare const bogosCheckGift: (item: string | ProductObject) => boolean;\n ```\n\n2. Customize gift popup/slider\n\n Change [isPopup](#isPopup) to true and listen event:\n\n ```typescript\n type GiftItem = {\n id: number;\n discount_type: 'percentage' | 'fixed_amount';\n discount_value: number;\n original_price: number; // Original price - price before discount\n price: number; // Discount price - price after discount\n title: string;\n thumbnail?: string;\n };\n\n type GiftProduct = {\n id: number;\n title: string;\n handle: string;\n thumbnail?: string;\n belongs_to_offer: string;\n variants: GiftItem[];\n };\n\n export declare const bogosProcessAddGift: (variantID: number | string, quantity: number, offerId: string) => void;\n\n document.addEventListener(\"fg-gifts:show-slider\", (e) => {\n console.log((e as CustomEvent).detail.arrGiftShow);\n /* render gift slider with arrGiftShow: GiftProduct[] */\n /* use bogosProcessAddGift when click add to cart from popup to process BOGOS */\n });\n \n ```\n\n3. Details of other event listeners\n\n - fg-gifts:updated\n\n ```typescript\n document.addEventListener(\"fg-gifts:updated\", (e) => {\n /* use this function to re-render cart with disableReloadCartUpdated: true */\n console.log((e as CustomEvent).detail);\n /* render gift slider with detail: { \n is_auto?: boolean,\n popup?: gift can be shown \n add?: gift can be added to cart\n update?: gift already in cart need to update\n } */\n });\n ```\n\n - fg-cart:auto-updated\n\n ```typescript\n document.addEventListener(\"fg-gifts:updated\", (e) => {\n /* use this function to re-render cart with disableReloadCartUpdated: true when gifts are auto updated (add/remove) */\n console.log((e as CustomEvent).detail);\n /* detail: { \n popup?: gift can be shown \n add?: gift can be added to cart\n update?: gift already in cart need to update\n } */\n });\n ```\n\n - fg-gifts:added: will not work if you [customize gifts popup](#customize-popup)\n\n ```typescript\n document.addEventListener(\"fg-gifts:added\", (e) => {\n /* use this function to re-render cart with disableReloadCartUpdated: true */\n console.log((e as CustomEvent).detail);\n /* render gift slider with detail: { \n is_auto?: boolean,\n gift?: {\n variant_id,\n quantity\n } gift added from popup\n } */\n });\n ```\n\n4. Some features is not available on this version yet\n\n - Stop the offer when the gift is out of stock\n - Draft-Order API\n\n## Notice\n\n### Publish gift/cloned product to Headless channel (or other channels you want BOGOS package to work with)\n\n- After creating/editing offer, please make sure that the gift/cloned product is available on Headless channel in order for the offer to work.\n\n## Support\n\n[BOGOS: Free Gift](https://apps.shopify.com/freegifts) - [support@secomapp.com](mailto:support@secomapp.com)\n\nOR\n\nYou can contact our live-chat supporters in app on Shopify Admin.\n","readmeFilename":"README.md"}