@spectrum-web-components/action-button

Description

An <sp-action-button> represents an action a user can take.

Usage

yarn add @spectrum-web-components/action-button

Import the side effectful registration of <sp-action-button> via:

import '@spectrum-web-components/action-button/sp-action-button.js';

When looking to leverage the ActionButton base class as a type and/or for extension purposes, do so via:

import { ActionButton } from '@spectrum-web-components/action-button';

Sizes

Small

<sp-action-group>
    <sp-action-button size="s">Do action</sp-action-button>
    <sp-action-button size="s" selected>Do action</sp-action-button>
    <sp-action-button size="s" disabled>Do action</sp-action-button>
</sp-action-group>

Medium

<sp-action-group>
    <sp-action-button size="m">Do action</sp-action-button>
    <sp-action-button size="m" selected>Do action</sp-action-button>
    <sp-action-button size="m" disabled>Do action</sp-action-button>
</sp-action-group>

Large

<sp-action-group>
    <sp-action-button size="l">Do action</sp-action-button>
    <sp-action-button size="l" selected>Do action</sp-action-button>
    <sp-action-button size="l" disabled>Do action</sp-action-button>
</sp-action-group>

Extra Large

<sp-action-group>
    <sp-action-button size="xl">Do action</sp-action-button>
    <sp-action-button size="xl" selected>Do action</sp-action-button>
    <sp-action-button size="xl" disabled>Do action</sp-action-button>
</sp-action-group>

Variants

Action button with icon

<sp-action-button>
    <sp-icon-edit slot="icon"></sp-icon-edit>
    This is an action button
</sp-action-button>

Icon only action button

<sp-action-button label="Edit">
    <sp-icon-edit slot="icon"></sp-icon-edit>
</sp-action-button>

Emphasized action button

<sp-action-button label="Edit" emphasized selected>
    <sp-icon-edit slot="icon"></sp-icon-edit>
</sp-action-button>

Action button with hold affordance

The use of the hold-affordance attribute signifies that the <sp-action-button> in question will be delivered with a visual affordance outlining that special interaction with the button will dispatch a longpress event. Via a pointer input, this even will be dispatched when 300ms has passed after a pointerdown event without the presence of a pointerup or pointercancel event. Via the keyboard, an event with a code of Space or or ArrowDown while altKey === true will dispatch the event.

<sp-action-group>
    <overlay-trigger placement="bottom">
        <sp-action-button label="Edit" hold-affordance slot="trigger">
            <sp-icon-edit slot="icon"></sp-icon-edit>
        </sp-action-button>
        <sp-popover slot="longpress-content" dialog tip>
            <p class="spectrum-Body spectrum-Body--sizeM" style="color: var(--spectrum-body-m-text-color,var(--spectrum-alias-text-color));">This content is triggered by the "longpress" interaction.</p>
        </sp-popover>
    </overlay-trigger>

    <overlay-trigger placement="top">
        <sp-action-button hold-affordance quiet slot="trigger">
            Show Longpress Content
        </sp-action-button>
        <sp-popover slot="longpress-content" dialog tip>
            <p class="spectrum-Body spectrum-Body--sizeM" style="color: var(--spectrum-body-m-text-color,var(--spectrum-alias-text-color));">This content is triggered by the "longpress" interaction.</p>
        </sp-popover>
    </overlay-trigger>

    <overlay-trigger placement="top">
        <sp-action-button hold-affordance selected slot="trigger">
            <sp-icon-edit slot="icon"></sp-icon-edit>
            Extended Content with Longpress
        </sp-action-button>
        <sp-popover slot="longpress-content" dialog tip>
            <p class="spectrum-Body spectrum-Body--sizeM" style="color: var(--spectrum-body-m-text-color,var(--spectrum-alias-text-color));">This content is triggered by the "longpress" interaction.</p>
        </sp-popover>
    </overlay-trigger>
</sp-action-group>

Toggles

With the application of the toggles attribute, the button will self manage its selected property on click:

<sp-action-button toggles>Toggle button</sp-action-button>