use
React Hook
Returns the full API object that was passed in to your extension when it was created. Depending on the extension target, this object can contain different properties.
For example, the purchase.checkout.cart-line-item.render-after extension target will return the CartLineDetailsApi object. Other targets may only have access to the StandardApi object, which contains a basic set of properties about the checkout.
For a full list of the API available to each extension target, see the ExtensionTargets type.
Caution
This is deprecated, use instead.
Anchor to useExtensionApiuse
use
<Target>
Was this section helpful?
Accessing Properties
React
import {
reactExtension,
Text,
useExtensionApi,
} from '@shopify/ui-extensions-react/checkout';
export default reactExtension(
'purchase.checkout.block.render',
() => <Extension />,
);
function Extension() {
const {shop} = useExtensionApi();
return <Text>Shop name: {shop.name}</Text>;
}
