e7da97194a
Some checks failed
App Prod-Parity E2E Dispatch / dispatch (push) Failing after 10s
CD Storybook UI / build (push) Failing after 3m25s
CD Storybook UI / dispatch (push) Has been skipped
CD deploy main / website-changed-files (push) Successful in 18m8s
CI Agent Skills / changed-files-check (push) Successful in 18m9s
CI Create App E2E minimal / changed-files-check (push) Successful in 24s
CI Create App / changed-files-check (push) Successful in 26s
CI Docs / changed-files-check (push) Successful in 26s
CI Emails / changed-files-check (push) Successful in 28s
CI Example App Hello World / changed-files-check (push) Successful in 23s
CI Front / changed-files-check (push) Has been skipped
CI Example App Postcard / changed-files-check (push) Successful in 27s
CI UI / changed-files-check (push) Has been skipped
CI Utils Test / changed-files-check (push) Successful in 45s
CI Twenty Apps / discover (push) Successful in 1m3s
CD deploy main / deploy-main (push) Failing after 3s
CI Agent Skills / agent-skills-validate (push) Has been skipped
CI Create App / create-app-test (lint) (push) Has been skipped
CI Emails / emails-test (push) Has been skipped
CI Front / front-task (lingui:compile) (push) Has been skipped
CI Front / front-task (lint) (push) Has been skipped
CI Example App Postcard / example-app-postcard (push) Has been skipped
CI UI / ui-task (lint) (push) Has been skipped
CI UI / ui-task (pack-size) (push) Has been skipped
CI UI / ui-task (size) (push) Has been skipped
CI UI / ui-task (test) (push) Has been skipped
CI UI / ui-task (typecheck) (push) Has been skipped
CI Utils Test / utils-test (push) Has been skipped
CI Twenty Apps / ${{ matrix.app.name }} (push) Has been skipped
CI Emails / ci-emails-status-check (push) Successful in 2s
CI Example App Hello World / ci-example-app-hello-world-status-check (push) Successful in 2s
CI Example App Postcard / ci-example-app-postcard-status-check (push) Successful in 3s
CI UI / ui-sb-test (push) Has been skipped
CI Utils Test / ci-utils-test-status-check (push) Successful in 2s
CI Twenty Apps / ci-twenty-apps-status-check (push) Successful in 2s
CI UI / ci-ui-status-check (push) Successful in 2s
CI Desktop / desktop (push) Failing after 1m8s
Push docs to Crowdin / Push documentation to Crowdin (push) Failing after 55s
Push translations to Crowdin / Extract and upload translations (push) Failing after 5s
Push website translations to Crowdin / Extract and upload website translations (push) Failing after 5s
CI Create App / create-app-test (test) (push) Has been skipped
CI Create App / create-app-test (typecheck) (push) Has been skipped
CI Docs / docs-lint (push) Has been skipped
CI Example App Hello World / example-app-hello-world (push) Has been skipped
CI Front / front-task (lingui:extract) (push) Has been skipped
CI Front / front-task (test) (push) Has been skipped
CI Front / front-task (typecheck) (push) Has been skipped
CI UI / ui-sb-build (push) Failing after 1m32s
CI Twenty Apps / ${{ matrix.app.name }} (${{ matrix.server-source }}) (push) Has been skipped
CI Agent Skills / agent-skills-publish (push) Has been skipped
CI Create App / ci-create-app-status-check (push) Successful in 2s
CI Agent Skills / agent-skills-remote-source (push) Has been skipped
CI Create App E2E minimal / create-app-e2e-minimal (push) Has been cancelled
CI E2E Main / e2e-test (push) Has been cancelled
CI Front / front-sb-build (push) Has been cancelled
CI Front / front-build (push) Has been cancelled
CI Create App E2E minimal / ci-create-app-e2e-minimal-status-check (push) Has been cancelled
CI E2E Main / ci-e2e-main-status-check (push) Has been cancelled
CI E2E Main / notify-main-ci-failure (push) Has been cancelled
CI E2E Main / qa-scout-comment (push) Has been cancelled
CI Front / front-sb-test (push) Has been cancelled
CI Front / front-sb-screenshots (push) Has been cancelled
CI Front / ci-front-status-check (push) Has been cancelled
DPA Sub-Processor Sync / sync-subprocessors (push) Failing after 3s
AI Catalog Sync / sync-catalog (push) Failing after 2s
75 lines
2.9 KiB
Plaintext
75 lines
2.9 KiB
Plaintext
{/*
|
|
* _____ _
|
|
*|_ _|_ _____ _ __ | |_ _ _
|
|
* | | \ \ /\ / / _ \ '_ \| __| | | | 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="aria-label" type="string" required>
|
|
Required accessible name describing the action.
|
|
</ParamField>
|
|
|
|
<ParamField body="children" type="ReactNode" required>
|
|
Icon content. Decorative and hidden from assistive technology.
|
|
</ParamField>
|
|
|
|
<ParamField body="className" type="string | ((state: ButtonState) => string | undefined)">
|
|
CSS class applied to the element, or a function that
|
|
returns a class based on the component's state.
|
|
</ParamField>
|
|
|
|
<ParamField body="color" type=""neutral" | "accent" | "danger" | "success"">
|
|
Semantic color of the button.
|
|
</ParamField>
|
|
|
|
<ParamField body="elevated" type="boolean">
|
|
Adds a shadow to the button.
|
|
</ParamField>
|
|
|
|
<ParamField body="focusableWhenDisabled" type="boolean" default="false">
|
|
Whether the button should be focusable when disabled.
|
|
</ParamField>
|
|
|
|
<ParamField body="loading" type="boolean">
|
|
Shows a loading indicator and disables activation while preserving the button width.
|
|
</ParamField>
|
|
|
|
<ParamField body="render" type="ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, ButtonState>">
|
|
Caller-supplied root element or renderer. Preserve a native button, or an anchor when `href` is set. Router integration belongs to the caller.
|
|
</ParamField>
|
|
|
|
<ParamField body="size" type=""sm" | "md"">
|
|
Square button size: `sm` (24px) or `md` (32px).
|
|
</ParamField>
|
|
|
|
<ParamField body="style" type="CSSProperties | ((state: ButtonState) => CSSProperties | undefined)">
|
|
Style applied to the element, or a function that
|
|
returns a style object based on the component's state.
|
|
</ParamField>
|
|
|
|
<ParamField body="tooltip" type="string">
|
|
Text displayed when hovering or focusing the button.
|
|
</ParamField>
|
|
|
|
<ParamField body="tooltipDelay" type="number" default="1000">
|
|
Delay before showing the tooltip.
|
|
</ParamField>
|
|
|
|
<ParamField body="tooltipOffset" type="number" default="5">
|
|
Distance in pixels between the button and the tooltip.
|
|
</ParamField>
|
|
|
|
<ParamField body="tooltipPlace" type=""top" | "right" | "bottom" | "left"" default="bottom">
|
|
Preferred placement of the tooltip relative to the button.
|
|
</ParamField>
|
|
|
|
<ParamField body="variant" type=""solid" | "outline" | "ghost" | "soft"">
|
|
Visual treatment of the button surface.
|
|
</ParamField>
|