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
57 lines
2.0 KiB
Plaintext
57 lines
2.0 KiB
Plaintext
---
|
|
title: MainButton
|
|
description: Present prominent actions with shared design defaults.
|
|
---
|
|
|
|
import { StoryEmbed } from '/snippets/ui/StoryEmbed.mdx';
|
|
|
|
import MainButtonReference from '/snippets/ui/generated/input/main-button.mdx';
|
|
|
|
Use the shared `MainButton` component for a prominent action. It composes
|
|
[Button](/ui/primitives/input/button) with a solid surface, elevation, semibold
|
|
text, and 12px horizontal padding. Its default color is neutral and size is `md`.
|
|
|
|
<StoryEmbed
|
|
storyId="ui-components-mainbutton--default"
|
|
title="MainButton example"
|
|
height={240}
|
|
/>
|
|
|
|
## State ownership
|
|
|
|
`MainButton` uses Button's state model and adds no state of its own. Your application supplies `loading`, `disabled`, and `soon`; there are no controlled and uncontrolled selection modes. See [Button's state ownership example](/ui/primitives/input/button#state-ownership) for managing an asynchronous action.
|
|
|
|
## Usage
|
|
|
|
```tsx
|
|
import { MainButton } from 'twenty-ui/components';
|
|
|
|
export const SaveProfile = () => (
|
|
<MainButton type="submit" fullWidth>
|
|
Save profile
|
|
</MainButton>
|
|
);
|
|
```
|
|
|
|
Width follows the content unless you set `fullWidth` or provide application
|
|
layout styling. Override `variant`, `color`, `size`, and `elevated` as needed;
|
|
for example, use `variant="outline"` and `elevated={false}` for an outlined action.
|
|
Keep page layout in your application's styling.
|
|
|
|
## Interaction
|
|
|
|
`MainButton` accepts Button's native attributes, event handlers, refs, icon slots,
|
|
`loading`, `disabled`, and `soon` props. Buttons default to `type="button"`;
|
|
set `type="submit"` explicitly for form submission.
|
|
|
|
Use `href` for a link. Supply `render` to choose a custom root, including an
|
|
application-owned router link. The root must preserve a native button, or an
|
|
anchor when `href` is set. Button derives the interaction behavior from `href`.
|
|
|
|
[ButtonGroup](/ui/primitives/input/button-group) can set a shared size, surface,
|
|
and color. Consumer classes, including state functions, pass through to the root.
|
|
|
|
## Props
|
|
|
|
<MainButtonReference />
|