GiftOptions

Functions

useGiftOptions(props) ⇒ GiftOptionsTalonProps

This talon contains the logic for a gift options component. It performs effects and returns a data object containing values for rendering the component.

This talon performs the following effects:

• Fetch the gift options associated with the cart
• Update the GiftOptionsTalonProps values with the data returned by the query

Typedefs

GiftOptionsTalonProps : Object

Props data to use when rendering a gift options component.

GiftOptionsOperations : Object

This is a type used by the useGiftOptions talon.

This talon contains the logic for a gift options component. It performs effects and returns a data object containing values for rendering the component.

This talon performs the following effects:

• Fetch the gift options associated with the cart
• Update the GiftOptionsTalonProps values with the data returned by the query

Returns: Parameters

Example (Importing into your project)

import { useGiftOptions } from '@magento/peregrine/lib/talons/CartPage/GiftOptions/useGiftOptions';
CopyCopied to your clipboard
import { useGiftOptions } from '@magento/peregrine/lib/talons/CartPage/GiftOptions/useGiftOptions';

Props data to use when rendering a gift options component.

Properties

This is a type used by the useGiftOptions talon.

Properties

Source Code: pwa-studio/packages/peregrine/lib/talons/CartPage/PriceAdjustments/GiftOptions/useGiftOptions.js

Examples#

useGiftOptions()#

import React from 'react'

import useGiftOptions from '@magento/peregrine/lib/talons/CartPage/PriceAdjustments/GiftOptions/useGiftOptions';
import MyGiftOptionsOperations from './myGiftOptions.gql';

const MyGiftOptions = props => {

    const { mutations, queries } = MyGiftOptionsOperations;

    const {
        includeGiftReceipt,
        includePrintedCard,
        giftMessage,
        toggleIncludeGiftReceiptFlag,
        toggleIncludePrintedCardFlag,
        updateGiftMessage
    } = useGiftOptions({ mutations, queries });

    return (
        // JSX that renders a Gift Options component using talon props
    )
}

export default MyGiftOptions
CopyCopied to your clipboard
1import React from 'react'
2
3import useGiftOptions from '@magento/peregrine/lib/talons/CartPage/PriceAdjustments/GiftOptions/useGiftOptions';
4import MyGiftOptionsOperations from './myGiftOptions.gql';
5
6const MyGiftOptions = props => {
7
8    const { mutations, queries } = MyGiftOptionsOperations;
9
10    const {
11        includeGiftReceipt,
12        includePrintedCard,
13        giftMessage,
14        toggleIncludeGiftReceiptFlag,
15        toggleIncludePrintedCardFlag,
16        updateGiftMessage
17    } = useGiftOptions({ mutations, queries });
18
19    return (
20        // JSX that renders a Gift Options component using talon props
21    )
22}
23
24export default MyGiftOptions

Last updated 10/8/2021

Was this helpful?

Yes

No