@shopify/shop-minis-react/src/hooks/util/useErrorToast.doc.ts

React component library for Shopify Shop Minis with Tailwind CSS v4 support (source-only, requires TypeScript)

import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'

const data: ReferenceEntityTemplateSchema = {
  name: 'useErrorToast',
  category: 'hooks',
  subCategory: 'util',
  isVisualComponent: false,
  related: [],
  description:
    'The `useErrorToast` hook provides functionality for showing error toasts. It returns a function that can be used to display an error toast with a given error message.',
  type: 'hook',
  defaultExample: {
    codeblock: {
      tabs: [
        {
          code: './useErrorToast.example.tsx',
          language: 'tsx',
        },
      ],
      title: 'Example code',
    },
  },
  definitions: [
    {
      title: '',
      type: 'UseErrorToastGeneratedType',
      description: 'A hook that returns a function to show an error toast.',
    },
  ],
}

export default data