ComposerButton

Components/Actions

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

Overview

Copy

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
Copy

Color

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

  • standard
  • blue
  • cyan
  • purple
  • pink
  • orange
  • red
  • green
Copy

Ellipsis

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

Copy

Max lines

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

Copy

Disabled

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

Copy

Common use case examples

Composer add panel

Add form fields

Copy

Code

Copy

Props

NameTypeDefaultDescription
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.
dataHookstring—Applies a data-hook HTML attribute that can be used in tests.
disabledboolean—Specifies whether user interactions are disabled.
ellipsisboolean—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.
maxLinesnumber—Truncates label text at a specific number of lines when using ellipsis.
onClickMouseEventHandler—Defines a callback function which is called every time a button is clicked.
refnull | 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:

Copy

Driver methods

MethodDescription
isDisabledChecks whether button is disabled
getLabelValueReturns button label value
isFocusedChecks whether button is focused
existsChecks whether the component found with the given data hook.
elementGets the component root element.
clickClicks on the component root element.
baseReturns 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)
  • 1.117.0 (2024-07-25) — feat: add new ComposerButton component (#13965)

Last updated: 22 October 2026

Did this help?