upstream-twenty/packages/twenty-docs/snippets/ui/generated/feedback/toast.mdx

{/*
 * _____                    _
 *|_   _|_      _____ _ __ | |_ _   _
 *  | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
 *  | |  \ V  V /  __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
 *  |_|   \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
 *                              |___/
 *
 * This file is generated from the documentation data in packages/twenty-ui/generated.
 * To update it, edit the component prop types or design tokens in twenty-ui and run:
 *   npx nx generate:ui twenty-docs
 */}

<ParamField body="action" type="ReactNode">
  Content rendered in the footer, such as an action button.
</ParamField>

<ParamField body="cancelLabel" type="string" default="Cancel">
  Label of the cancel button.
</ParamField>

<ParamField body="closeLabel" type="string" default="Close">
  Accessible name of the close button.
</ParamField>

<ParamField body="description" type="ReactNode">
  Supporting content rendered below the message.
</ParamField>

<ParamField body="duration" type="number" default="6000">
  Milliseconds before `onClose` is called. The countdown pauses while the
  pointer is over the toast.
</ParamField>

<ParamField body="icon" type="ReactNode">
  Replaces the variant's icon.
</ParamField>

<ParamField body="iconLabel" type="string">
  Accessible name of the default icon. Without it, the icon is hidden from
  assistive technology.
</ParamField>

<ParamField body="onCancel" type="(() =&gt; void)">
  Called when the cancel button is clicked. The button renders only when
  this callback is provided.
</ParamField>

<ParamField body="onClose" type="(() =&gt; void)">
  Called when the close button is clicked or the countdown completes. The
  button renders only when this callback is provided.
</ParamField>

<ParamField body="progress" type="number">
  Completion percentage shown in the progress bar. When set, the countdown
  is disabled.
</ParamField>

<ParamField body="render" type="RenderProp&lt;Record&lt;string, unknown&gt;&gt;">
  Replaces the rendered element or composes it with another component.
  Accepts a React element or a function that returns the element to render.
</ParamField>

<ParamField body="variant" type="&quot;success&quot; | &quot;warning&quot; | &quot;default&quot; | &quot;error&quot; | &quot;info&quot;" default="default">
  Visual variant that selects the icon and colors.
</ParamField>