Button

Buttons allow users to perform an action or to navigate to another page. They have multiple styles for various needs, and are ideal for calling attention to where a user needs to do something in order to move forward in a flow.

install	`yarn add @adobe/react-spectrum`
added	3.0.0
usage	`import {Button} from '@adobe/react-spectrum'`

View guidelines

Spectrum

Example#

<Button variant="accent">Save</Button>

<Button variant="accent">Save</Button>

<Button variant="accent">
  Save
</Button>

Content#

Buttons must have a visible label, and can optionally have an icon. Text only buttons accept a string as children. Icons can also be added as children, with a sibling Text element for the label.

import {Text} from '@adobe/react-spectrum';

<Button variant="primary">
  <Bell />
  <Text>Icon + Label</Text>
</Button>

import {Text} from '@adobe/react-spectrum';

<Button variant="primary">
  <Bell />
  <Text>Icon + Label</Text>
</Button>

import {Text} from '@adobe/react-spectrum';

<Button variant="primary">
  <Bell />
  <Text>
    Icon + Label
  </Text>
</Button>

Accessibility#

If no visible label is provided (e.g. an icon only button), an alternative text label must be provided to identify the control for accessibility. This should be added using the aria-label prop.

Internationalization#

In order to internationalize a button, a localized string should be passed to the children or aria-label prop.

Events#

Buttons support user interactions via mouse, keyboard, and touch. You can handle all of these via the onPress prop.

The following example uses an onPress handler to update a counter stored in React state.

function Example() {
  let [count, setCount] = React.useState(0);

  return (
    <Button variant="primary" onPress={() => setCount((c) => c + 1)}>
      {count} Dogs
    </Button>
  );
}

function Example() {
  let [count, setCount] = React.useState(0);

  return (
    <Button
      variant="primary"
      onPress={() => setCount((c) => c + 1)}
    >
      {count} Dogs
    </Button>
  );
}

function Example() {
  let [count, setCount] =
    React.useState(0);

  return (
    <Button
      variant="primary"
      onPress={() =>
        setCount((c) =>
          c + 1
        )}
    >
      {count} Dogs
    </Button>
  );
}

Pending#

Buttons can indicate that a quick progress task is taking place (e.g., saving settings on a server). After a 1 second delay, an indeterminate spinner will be displayed in place of the button label and icon. You can trigger this behavior with the isPending prop. Button events are disabled while isPending is true.

function Example() {
  let [isLoading, setIsLoading] = React.useState(false);

  let handlePress = () => {
    // Trigger button pending state
    setIsLoading(true);

    setTimeout(() => {
      // Cancel button pending state
      setIsLoading(false);
    }, 3000);
  };

  return (
    <Button variant="primary" isPending={isLoading} onPress={handlePress}>
      Click me!
    </Button>
  );
}

function Example() {
  let [isLoading, setIsLoading] = React.useState(false);

  let handlePress = () => {
    // Trigger button pending state
    setIsLoading(true);

    setTimeout(() => {
      // Cancel button pending state
      setIsLoading(false);
    }, 3000);
  };

  return (
    <Button
      variant="primary"
      isPending={isLoading}
      onPress={handlePress}
    >
      Click me!
    </Button>
  );
}

function Example() {
  let [
    isLoading,
    setIsLoading
  ] = React.useState(
    false
  );

  let handlePress =
    () => {
      // Trigger button pending state
      setIsLoading(true);

      setTimeout(() => {
        // Cancel button pending state
        setIsLoading(
          false
        );
      }, 3000);
    };

  return (
    <Button
      variant="primary"
      isPending={isLoading}
      onPress={handlePress}
    >
      Click me!
    </Button>
  );
}

Props#

Name	Type	Default	Description
`variant`	`'accent' \| 'primary' \| 'secondary' \| 'negative' \| LegacyButtonVariant`	—	The visual style of the button.
`style`	`'fill' \| 'outline'`	—	The background style of the button.
`staticColor`	`'white' \| 'black'`	—	The static color style to apply. Useful when the button appears over a color background.
`isPending`	`boolean`	—	Whether to disable events immediately and display a loading spinner after a 1 second delay.
`type`	`'button' \| 'submit' \| 'reset'`	`'button'`	The behavior of the button when used in an HTML form.
`isDisabled`	`boolean`	—	Whether the button is disabled.
`children`	`ReactNode`	—	The content to display in the button.
`autoFocus`	`boolean`	—	Whether the element should receive focus on render.
`href`	`string`	—	A URL to link to if elementType="a".
`target`	`string`	—	The target window for the link.
`rel`	`string`	—	The relationship between the linked resource and the current page. See MDN.
`elementType`	`ElementType \| JSXElementConstructor<any>`	`'button'`	The HTML element or React element used to render the button, e.g. 'div', 'a', or `RouterLink`.

Events

Name	Type	Description
`onPress`	`( (e: PressEvent )) => void`	Handler that is called when the press is released over the target.
`onPressStart`	`( (e: PressEvent )) => void`	Handler that is called when a press interaction starts.
`onPressEnd`	`( (e: PressEvent )) => void`	Handler that is called when a press interaction ends, either over the target or when the pointer leaves the target.
`onPressChange`	`( (isPressed: boolean )) => void`	Handler that is called when the press state changes.
`onPressUp`	`( (e: PressEvent )) => void`	Handler that is called when a press is released over the target, regardless of whether it started on the target or not.
`onFocus`	`( (e: FocusEvent<Target> )) => void`	Handler that is called when the element receives focus.
`onBlur`	`( (e: FocusEvent<Target> )) => void`	Handler that is called when the element loses focus.
`onFocusChange`	`( (isFocused: boolean )) => void`	Handler that is called when the element's focus status changes.
`onKeyDown`	`( (e: KeyboardEvent )) => void`	Handler that is called when a key is pressed.
`onKeyUp`	`( (e: KeyboardEvent )) => void`	Handler that is called when a key is released.

Layout

Name	Type	Description
`flex`	`Responsive<string \| number \| boolean>`	When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
`flexGrow`	`Responsive<number>`	When used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
`flexShrink`	`Responsive<number>`	When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
`flexBasis`	`Responsive<number \| string>`	When used in a flex layout, specifies the initial main size of the element. See MDN.
`alignSelf`	`Responsive<'auto' \| 'normal' \| 'start' \| 'end' \| 'center' \| 'flex-start' \| 'flex-end' \| 'self-start' \| 'self-end' \| 'stretch'>`	Overrides the `alignItems` property of a flex or grid container. See MDN.
`justifySelf`	`Responsive<'auto' \| 'normal' \| 'start' \| 'end' \| 'flex-start' \| 'flex-end' \| 'self-start' \| 'self-end' \| 'center' \| 'left' \| 'right' \| 'stretch'>`	Specifies how the element is justified inside a flex or grid container. See MDN.
`order`	`Responsive<number>`	The layout order for the element within a flex or grid container. See MDN.
`gridArea`	`Responsive<string>`	When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
`gridColumn`	`Responsive<string>`	When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
`gridRow`	`Responsive<string>`	When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
`gridColumnStart`	`Responsive<string>`	When used in a grid layout, specifies the starting column to span within the grid. See MDN.
`gridColumnEnd`	`Responsive<string>`	When used in a grid layout, specifies the ending column to span within the grid. See MDN.
`gridRowStart`	`Responsive<string>`	When used in a grid layout, specifies the starting row to span within the grid. See MDN.
`gridRowEnd`	`Responsive<string>`	When used in a grid layout, specifies the ending row to span within the grid. See MDN.

Spacing

Name	Type	Description
`margin`	`Responsive<DimensionValue>`	The margin for all four sides of the element. See MDN.
`marginTop`	`Responsive<DimensionValue>`	The margin for the top side of the element. See MDN.
`marginBottom`	`Responsive<DimensionValue>`	The margin for the bottom side of the element. See MDN.
`marginStart`	`Responsive<DimensionValue>`	The margin for the logical start side of the element, depending on layout direction. See MDN.
`marginEnd`	`Responsive<DimensionValue>`	The margin for the logical end side of an element, depending on layout direction. See MDN.
`marginX`	`Responsive<DimensionValue>`	The margin for both the left and right sides of the element. See MDN.
`marginY`	`Responsive<DimensionValue>`	The margin for both the top and bottom sides of the element. See MDN.

Sizing

Name	Type	Description
`width`	`Responsive<DimensionValue>`	The width of the element. See MDN.
`minWidth`	`Responsive<DimensionValue>`	The minimum width of the element. See MDN.
`maxWidth`	`Responsive<DimensionValue>`	The maximum width of the element. See MDN.
`height`	`Responsive<DimensionValue>`	The height of the element. See MDN.
`minHeight`	`Responsive<DimensionValue>`	The minimum height of the element. See MDN.
`maxHeight`	`Responsive<DimensionValue>`	The maximum height of the element. See MDN.

Positioning

Name	Type	Description
`position`	`Responsive<'static' \| 'relative' \| 'absolute' \| 'fixed' \| 'sticky'>`	Specifies how the element is positioned. See MDN.
`top`	`Responsive<DimensionValue>`	The top position for the element. See MDN.
`bottom`	`Responsive<DimensionValue>`	The bottom position for the element. See MDN.
`left`	`Responsive<DimensionValue>`	The left position for the element. See MDN. Consider using `start` instead for RTL support.
`right`	`Responsive<DimensionValue>`	The right position for the element. See MDN. Consider using `start` instead for RTL support.
`start`	`Responsive<DimensionValue>`	The logical start position for the element, depending on layout direction. See MDN.
`end`	`Responsive<DimensionValue>`	The logical end position for the element, depending on layout direction. See MDN.
`zIndex`	`Responsive<number>`	The stacking order for the element. See MDN.
`isHidden`	`Responsive<boolean>`	Hides the element.

Accessibility

Name	Type	Description
`id`	`string`	The element's unique identifier. See MDN.
`excludeFromTabOrder`	`boolean`	Whether to exclude the element from the sequential tab order. If true, the element will not be focusable via the keyboard by tabbing. This should be avoided except in rare scenarios where an alternative means of accessing the element or its functionality via the keyboard is available.
`aria-expanded`	`boolean \| 'true' \| 'false'`	Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
`aria-haspopup`	`boolean \| 'menu' \| 'listbox' \| 'tree' \| 'grid' \| 'dialog' \| 'true' \| 'false'`	Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
`aria-controls`	`string`	Identifies the element (or elements) whose contents or presence are controlled by the current element.
`aria-pressed`	`boolean \| 'true' \| 'false' \| 'mixed'`	Indicates the current "pressed" state of toggle buttons.
`aria-label`	`string`	Defines a string value that labels the current element.
`aria-labelledby`	`string`	Identifies the element (or elements) that labels the current element.
`aria-describedby`	`string`	Identifies the element (or elements) that describes the object.
`aria-details`	`string`	Identifies the element (or elements) that provide a detailed, extended description for the object.

Advanced

Name	Type	Description
`UNSAFE_className`	`string`	Sets the CSS className for the element. Only use as a last resort. Use style props instead.
`UNSAFE_style`	`CSSProperties`	Sets inline style for the element. Only use as a last resort. Use style props instead.

Visual options#

Accent#

View guidelines

<Flex wrap gap="size-250">
  <Button variant="accent" style="fill">Save</Button>
  <Button variant="accent" style="outline">Save</Button>
</Flex>

<Flex wrap gap="size-250">
  <Button variant="accent" style="fill">Save</Button>
  <Button variant="accent" style="outline">Save</Button>
</Flex>

<Flex
  wrap
  gap="size-250"
>
  <Button
    variant="accent"
    style="fill"
  >
    Save
  </Button>
  <Button
    variant="accent"
    style="outline"
  >
    Save
  </Button>
</Flex>

Primary#

View guidelines

<Flex wrap gap="size-250">
  <Button variant="primary" style="fill">Save</Button>
  <Button variant="primary" style="outline">Save</Button>
</Flex>

<Flex wrap gap="size-250">
  <Button variant="primary" style="fill">Save</Button>
  <Button variant="primary" style="outline">Save</Button>
</Flex>

<Flex
  wrap
  gap="size-250"
>
  <Button
    variant="primary"
    style="fill"
  >
    Save
  </Button>
  <Button
    variant="primary"
    style="outline"
  >
    Save
  </Button>
</Flex>

Secondary#

View guidelines

<Flex wrap gap="size-250">
  <Button variant="secondary" style="fill">Save</Button>
  <Button variant="secondary" style="outline">Save</Button>
</Flex>

<Flex wrap gap="size-250">
  <Button variant="secondary" style="fill">Save</Button>
  <Button variant="secondary" style="outline">Save</Button>
</Flex>

<Flex
  wrap
  gap="size-250"
>
  <Button
    variant="secondary"
    style="fill"
  >
    Save
  </Button>
  <Button
    variant="secondary"
    style="outline"
  >
    Save
  </Button>
</Flex>

Negative#

View guidelines

<Flex wrap gap="size-250">
  <Button variant="negative" style="fill">Save</Button>
  <Button variant="negative" style="outline">Save</Button>
</Flex>

<Flex wrap gap="size-250">
  <Button variant="negative" style="fill">Save</Button>
  <Button variant="negative" style="outline">Save</Button>
</Flex>

<Flex
  wrap
  gap="size-250"
>
  <Button
    variant="negative"
    style="fill"
  >
    Save
  </Button>
  <Button
    variant="negative"
    style="outline"
  >
    Save
  </Button>
</Flex>

Static color#

View guidelines

<Flex wrap gap="size-250">
  <View backgroundColor="static-blue-700" padding="size-500">
    <Flex wrap gap="size-200">
      <Button variant="primary" staticColor="white" style="fill">Save</Button>
      <Button variant="primary" staticColor="white" style="outline">
        Save
      </Button>
    </Flex>
  </View>
  <View backgroundColor="static-yellow-400" padding="size-500">
    <Flex wrap gap="size-200">
      <Button variant="primary" staticColor="black" style="fill">Save</Button>
      <Button variant="primary" staticColor="black" style="outline">
        Save
      </Button>
    </Flex>
  </View>
</Flex>

<Flex wrap gap="size-250">
  <View
    backgroundColor="static-blue-700"
    padding="size-500"
  >
    <Flex wrap gap="size-200">
      <Button
        variant="primary"
        staticColor="white"
        style="fill"
      >
        Save
      </Button>
      <Button
        variant="primary"
        staticColor="white"
        style="outline"
      >
        Save
      </Button>
    </Flex>
  </View>
  <View
    backgroundColor="static-yellow-400"
    padding="size-500"
  >
    <Flex wrap gap="size-200">
      <Button
        variant="primary"
        staticColor="black"
        style="fill"
      >
        Save
      </Button>
      <Button
        variant="primary"
        staticColor="black"
        style="outline"
      >
        Save
      </Button>
    </Flex>
  </View>
</Flex>

<Flex
  wrap
  gap="size-250"
>
  <View
    backgroundColor="static-blue-700"
    padding="size-500"
  >
    <Flex
      wrap
      gap="size-200"
    >
      <Button
        variant="primary"
        staticColor="white"
        style="fill"
      >
        Save
      </Button>
      <Button
        variant="primary"
        staticColor="white"
        style="outline"
      >
        Save
      </Button>
    </Flex>
  </View>
  <View
    backgroundColor="static-yellow-400"
    padding="size-500"
  >
    <Flex
      wrap
      gap="size-200"
    >
      <Button
        variant="primary"
        staticColor="black"
        style="fill"
      >
        Save
      </Button>
      <Button
        variant="primary"
        staticColor="black"
        style="outline"
      >
        Save
      </Button>
    </Flex>
  </View>
</Flex>

Disabled#

View guidelines

<Button variant="accent" isDisabled>Save</Button>

<Button variant="accent" isDisabled>Save</Button>

<Button
  variant="accent"
  isDisabled
>
  Save
</Button>

Icon only#

View guidelines

<Flex direction="row" gap={8}>
  <Button variant="accent" aria-label="Ring for service"><Bell /></Button>
  <Button variant="primary" aria-label="Ring for service"><Bell /></Button>
  <Button variant="secondary" aria-label="Ring for service"><Bell /></Button>
</Flex>

<Flex direction="row" gap={8}>
  <Button variant="accent" aria-label="Ring for service">
    <Bell />
  </Button>
  <Button variant="primary" aria-label="Ring for service">
    <Bell />
  </Button>
  <Button
    variant="secondary"
    aria-label="Ring for service"
  >
    <Bell />
  </Button>
</Flex>

<Flex
  direction="row"
  gap={8}
>
  <Button
    variant="accent"
    aria-label="Ring for service"
  >
    <Bell />
  </Button>
  <Button
    variant="primary"
    aria-label="Ring for service"
  >
    <Bell />
  </Button>
  <Button
    variant="secondary"
    aria-label="Ring for service"
  >
    <Bell />
  </Button>
</Flex>

Name	Type	Description
`type`	`'pressstart' \| 'pressend' \| 'pressup' \| 'press'`	The type of press event being fired.
`pointerType`	`PointerType`	The pointer type that triggered the press event.
`target`	`Element`	The target element of the press event.
`shiftKey`	`boolean`	Whether the shift keyboard modifier was held during the press event.
`ctrlKey`	`boolean`	Whether the ctrl keyboard modifier was held during the press event.
`metaKey`	`boolean`	Whether the meta keyboard modifier was held during the press event.
`altKey`	`boolean`	Whether the alt keyboard modifier was held during the press event.

Method	Description
`continuePropagation(): void`	By default, press events stop propagation to parent elements. In cases where a handler decides not to handle a specific event, it can call `continuePropagation()` to allow a parent to handle it.

Button

Example#

Content#

Accessibility#

Internationalization#

Events#

Pending#

Props#

Visual options#

Accent#

Primary#

Secondary#

Negative#

Static color#

Disabled#

Icon only#

Properties

Methods