> To build a Wix site agentically, or add Wix features like bookings or a store to a site you already have, follow https://www.wix.com/headless/skill.md
> 
> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - If a reference page seems to be missing its schema (parameters, return types, or type definitions), append `?schema=true` to its `.md` URL (e.g. `https://dev.wix.com/docs/contexts/contexts/stores/category-info/use-category-info-context.md?schema=true`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

## Resource: ComposerButton Component

## Article: ComposerButton Component

## Article Link: https://dev.wix.com/docs/wix-design-system/components/actions/composer-button-component.md

## Article Content:

# ComposerButton

_Components/Actions_

Interactive docs page: <https://wix-pages.com/design-system-documentation/#/component/composerbutton>

## Overview

```jsx
<Box align="center">
  <ComposerButton label="Edit" color="green">
    <Icons.Edit />
  </ComposerButton>
</Box>;
```

Composer button as it's name suggest, is a custom button for composers tools and functions.

### Do

- Use it to describe a composer tool, action or a function.

### Don't

- Don't use it for non composer platforms.

### Feature examples

#### Shape

Use shape prop to change the shape of the composer button.

- `Square` is the default shape
- `Round`

```jsx
<StorybookComponents.Stack alignItems="flex-start">
  <ComposerButton shape="square">
    <Icons.Badge />
  </ComposerButton>
  <ComposerButton shape="round">
    <Icons.Badge />
  </ComposerButton>
</StorybookComponents.Stack>;
```

#### Color

Use color prop to change button color, you can choose one of these:

- `standard`
- `blue`
- `cyan`
- `purple`
- `pink`
- `orange`
- `red`
- `green`

```jsx
<StorybookComponents.Stack alignItems="flex-start">
  <ComposerButton color="standard">
    <Icons.Badge />
  </ComposerButton>
  <ComposerButton color="blue">
    <Icons.Badge />
  </ComposerButton>
  <ComposerButton color="cyan">
    <Icons.Badge />
  </ComposerButton>
  <ComposerButton color="purple">
    <Icons.Badge />
  </ComposerButton>
  <ComposerButton color="pink">
    <Icons.Badge />
  </ComposerButton>
  <ComposerButton color="orange">
    <Icons.Badge />
  </ComposerButton>
  <ComposerButton color="red">
    <Icons.Badge />
  </ComposerButton>
  <ComposerButton color="green">
    <Icons.Badge />
  </ComposerButton>
</StorybookComponents.Stack>;
```

#### Ellipsis

Use `ellipsis` prop to get truncated label when it reached max width.

```jsx
<StorybookComponents.Stack width="150px">
  <ComposerButton label="Add a badge to your profile">
    <Icons.Badge />
  </ComposerButton>
  <ComposerButton ellipsis={false} label="Add a badge to your profile">
    <Icons.Badge />
  </ComposerButton>
</StorybookComponents.Stack>;
```

#### Max lines

Use `maxLines` prop to limit the number of lines the button label has before getting truncated.

```jsx
<StorybookComponents.Stack width="150px">
  <ComposerButton label="Add a badge to your profile">
    <Icons.Badge />
  </ComposerButton>
  <ComposerButton maxLines="2" label="Add a badge to your profile">
    <Icons.Badge />
  </ComposerButton>
</StorybookComponents.Stack>;
```

#### Disabled

To disable a composer button, use the `disabled` prop which indicates a button can't be selected.

```jsx
<ComposerButton disabled>
  <Icons.Badge />
</ComposerButton>;
```

### Common use case examples

#### Composer add panel

Add form fields

```jsx
<SidePanel width="300px">
  <SidePanel.Header title="Add form fields"></SidePanel.Header>
  <SidePanel.Content noPadding>
    <Box padding="SP3" direction="vertical">
      <SectionHeader
        skin="light"
        size="small"
        horizontalPadding="xxTiny"
        divider="none"
        title="Contact fields"
      ></SectionHeader>
      <Box padding="SP1">
        <Layout justifyItems="center" cols={3}>
          <Cell span={1}>
            <ComposerButton color="blue" label="First Name">
              <Icons.UserName />
            </ComposerButton>
          </Cell>
          <Cell span={1}>
            <ComposerButton color="blue" label="Last Name">
              <Icons.UserName />
            </ComposerButton>
          </Cell>
          <Cell span={1}>
            <ComposerButton color="blue" label="Email">
              <Icons.Email />
            </ComposerButton>
          </Cell>
          <Cell span={1}>
            <ComposerButton color="blue" label="Phone">
              <Icons.Phone />
            </ComposerButton>
          </Cell>
          <Cell span={1}>
            <ComposerButton color="blue" label="Birthday">
              <Icons.Date />
            </ComposerButton>
          </Cell>
          <Cell span={1}>
            <ComposerButton color="blue" label="Address">
              <Icons.Location />
            </ComposerButton>
          </Cell>
          <Cell span={1}>
            <ComposerButton color="blue" label="Subscribe">
              <Icons.StatusComplete />
            </ComposerButton>
          </Cell>
        </Layout>
      </Box>
    </Box>
    <Divider />
    <Box padding="SP3" direction="vertical">
      <SectionHeader
        skin="light"
        size="small"
        horizontalPadding="xxTiny"
        divider="none"
        title="Buttons"
      ></SectionHeader>
      <Box padding="SP1">
        <Layout justifyItems="center" cols={3}>
          <Cell span={1}>
            <ComposerButton color="purple" label="Submit">
              <Icons.Button />
            </ComposerButton>
          </Cell>
        </Layout>
      </Box>
    </Box>
    <Divider />
    <Box padding="SP3" direction="vertical">
      <SectionHeader
        skin="light"
        size="small"
        horizontalPadding="xxTiny"
        divider="none"
        title="General fields"
      ></SectionHeader>
      <Box padding="SP1">
        <Layout justifyItems="center" cols={3}>
          <Cell span={1}>
            <ComposerButton color="cyan" label="Short answer">
              <Icons.Input />
            </ComposerButton>
          </Cell>
          <Cell span={1}>
            <ComposerButton color="cyan" label="Long answer">
              <Icons.InputArea />
            </ComposerButton>
          </Cell>
          <Cell span={1}>
            <ComposerButton color="cyan" label="Number">
              <Icons.Number />
            </ComposerButton>
          </Cell>
          <Cell span={1}>
            <ComposerButton color="cyan" label="Link">
              <Icons.Link />
            </ComposerButton>
          </Cell>
          <Cell span={1}>
            <ComposerButton color="cyan" label="File upload">
              <Icons.Upload />
            </ComposerButton>
          </Cell>
          <Cell span={1}>
            <ComposerButton color="cyan" label="Signature">
              <Icons.ESignature />
            </ComposerButton>
          </Cell>
        </Layout>
      </Box>
    </Box>
  </SidePanel.Content>
</SidePanel>;
```

## Code

```jsx
import { ComposerButton } from '@wix/design-system';
```

### Props

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `as` | `"button"` | — | Renders component as any other component or a given HTML tag. |
| `children` *(required)* | `ReactNode` | — | Used for passing any `@wix/design-system` icon. For external icon make sure to follow ux sizing guidelines. |
| `color` | `"standard" \| "blue" \| "cyan" \| "green" \| "orange" \| "pink" \| "purple" \| "red" \| "teal" \| "violet"` | — | Sets button color. |
| `dataHook` | `string` | — | Applies a data-hook HTML attribute that can be used in tests. |
| `disabled` | `boolean` | — | Specifies whether user interactions are disabled. |
| `ellipsis` | `boolean` | — | Truncates label that is longer than its parent container and displays ellipsis at the end of the last line. |
| `label` *(required)* | `ReactNode` | — | Sets label value. |
| `maxLines` | `number` | — | Truncates label text at a specific number of lines when using ellipsis. |
| `onClick` | `MouseEventHandler` | — | Defines a callback function which is called every time a button is clicked. |
| `ref` | `null \| string \| (instance: ComposerButtonHandle \| null) => void \| RefObject<ComposerButtonHandle>` | — | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref). |
| `shape` | `"round" \| "square"` | — | Sets button shape. |

## Testkit

Import the driver matching your test environment:

```jsx
// UniDriver
import { ComposerButtonUniDriver } from '@wix/design-system/dist/testkit/unidriver';

// Vanilla
import { ComposerButtonTestkit } from '@wix/design-system/dist/testkit';

// Puppeteer
import { ComposerButtonTestkit } from '@wix/design-system/dist/testkit/puppeteer';

// Testing Library
import { ComposerButtonTestkit } from '@wix/design-system/dist/testkit/testing-library';
```

### Driver methods

| Method | Description |
| --- | --- |
| `isDisabled` | Checks whether button is disabled |
| `getLabelValue` | Returns button label value |
| `isFocused` | Checks whether button is focused |
| `exists` | Checks whether the component found with the given data hook. |
| `element` | Gets the component root element. |
| `click` | Clicks on the component root element. |
| `base` | Returns UniDriver for the base element. |

## Changelog

- **1.340.0** (2026-10-21) — maintenance release, no component-specific changes
- **1.339.0** (2026-10-19) — maintenance release, no component-specific changes
- **1.338.0** (2026-10-15) — maintenance release, no component-specific changes
- **1.330.0** (2026-09-28) — maintenance release, no component-specific changes
- **1.329.0** (2026-09-24) — maintenance release, no component-specific changes
- **1.328.0** (2026-09-22) — maintenance release, no component-specific changes
- **1.326.0** (2026-09-17) — maintenance release, no component-specific changes
- **1.323.0** (2026-09-10) — maintenance release, no component-specific changes
- **1.317.0** (2026-08-26) — maintenance release, no component-specific changes
- **1.310.0** (2026-08-10) — maintenance release, no component-specific changes
- **1.292.0** (2026-06-22) — maintenance release, no component-specific changes
- **1.273.0** (2026-04-30) — maintenance release, no component-specific changes
- **1.266.0** (2026-04-07) — maintenance release, no component-specific changes
- **1.260.0** (2026-03-17) — maintenance release, no component-specific changes
- **1.254.0** (2026-02-03) — maintenance release, no component-specific changes
- **1.250.0** (2026-01-27) — maintenance release, no component-specific changes
- **1.246.0** (2026-01-09) — maintenance release, no component-specific changes
- **1.242.0** (2025-12-19) — maintenance release, no component-specific changes
- **1.241.0** (2025-12-17) — maintenance release, no component-specific changes
- **1.216.0** (2025-09-01) — maintenance release, no component-specific changes
- **1.212.0** (2025-08-11) — maintenance release, no component-specific changes
- **1.118.0** (2024-07-30) — fix: use thin label weight for composer button ([#13989](invalid-url))
- **1.117.0** (2024-07-25) — feat: add new ComposerButton component ([#13965](invalid-url))