Price Hooks
The returned price useIgPrices() follow the following logic:
If no
productIdorvariantIdis provided, theoriginalPriceis returnedIf the
productIdand/orvariantIdis part of a Test, and the Test is live, or the test and user are both in preview mode:If a
productIdis provided but avariantIdis not, the lowest-priced variant price is returnedIf the
currencyCodeof the Experiment does not matchactiveCurrencyCode,originalPriceis returnedIf a
productIdandvariantIdis provided, the test-group variant price is returned
If the
productIdis not in an active test, theoriginalPriceis returned
useIgPrices()
useIgPrices()Returns the product price based on the user's test group. Intelligems will return the original prices if updated prices are not found. You may pass in either an object with the required data, or an array of objects. If an array is passed in the response will be an object mapped on variant id.
export interface UseIgPricesProps {
productId?: string;
variantId?: string;
originalPrice: number;
originalCompareAtPrice?: number;
currencyCode?: string;
}
export interface UseIgPricesReturn {
igPrice: IgPriceReturn;
igCompareAtPrice?: IgPriceReturn;
isIgPrice: boolean;
isReady: boolean;
}
export interface IgPriceReturn {
value: number | null;
currencyCode: string;
}
type UseIgPricesInput = UseIgPricesProps | UseIgPricesProps[];
export type UseIgPricesOutput<T extends UseIgPricesInput> =
T extends UseIgPricesProps[]
? Record<string, UseIgPricesReturn>
: UseIgPricesReturn;
const useIgPrices = <T extends UseIgPricesInput> (props: UseIgPricesInput) => UseIgPricesOutputuseIgStyles
useIgStylesUseful for manually styling components for integration mode.
const igStyles = useIgStyles();Last updated