Skip to content

Action

Actions are essential building blocks for the interface that perform inline operations.

Overview

Typically living within other components, Actions are flexible buttons that have an icon, can have a text label, notification style indicator, active state, and other useful properties.

Actions are distinct components, since they are more visually prominent. Whereas, Buttons are suited well for primary operations and call-to-actions such as "Save", "Cancel", "Back", and "Next".

Usage

Sample

Accessibility

Keyboard navigation

KeyFunction
SpacePresses the component.
EnterPresses the component.
TabMoves focus in and out of the component.
Tab and ShiftMoves focus in and out of the component.

Writing and copy

  • Keep text for Action labels simple and succinct
  • Avoid using more than 1-2 words in each item
  • Do not use punctuation like commas or periods in Action label text
  • Do not use contractions (you're, aren't, can't, haven't) in order to reduce confusion
  • Avoid writing Action text as questions
  • Recommended character maximum for each item: 15

API reference

Properties

PropertyAttributeDescriptionTypeDefault
activeactiveWhen present, the component is highlighted.booleanfalse
alignmentalignmentSpecifies the horizontal alignment of button elements with text content."center" | "end" | "start"
appearanceappearanceSpecifies the appearance of the component."solid" | "transparent""solid"
compactcompact
deprecatedNo longer necessary.
When present, the side padding of the component is reduced.
booleanfalse
disableddisabledWhen present, interaction is prevented and the component is displayed with lower opacity.booleanfalse
formformThe id of the form that will be associated with the component. When not set, the component will be associated with its ancestor form element, if any.string
iconiconSpecifies an icon to display.string
iconFlipRtlicon-flip-rtlWhen present, the icon will be flipped when the element direction is right-to-left ("rtl").booleanfalse
indicatorindicatorWhen present, displays a visual indicator.booleanfalse
labellabelSpecifies the label of the component. If no label is provided, the label inherits what's provided for the text prop.string
loadingloadingWhen present, a busy indicator is displayed.booleanfalse
messageOverridesUse this property to override individual strings used by the component.Record<string, unknown>
scalescaleSpecifies the size of the component."l" | "m" | "s""m"
textrequiredtextSpecifies text that accompanies the icon.string
textEnabledtext-enabledWhen present, the text is displayed.booleanfalse
typetypeSpecifies the default behavior of the component."button" | "reset" | "submit""button"

Slots

NameDescription
default (unnamed)A slot for adding non-interactive content, such as a calcite-icon.
tooltip
deprecated Use the calcite-tooltip component instead.

Styles

NameDescription
--calcite-action-background-color-hoverSpecifies the component's background color when hovered or focused.
--calcite-action-background-color-pressSpecifies the component's background color when active.
--calcite-action-background-color-pressed
deprecated Use --calcite-action-background-color-press. Specifies the component's background color when active.
--calcite-action-background-colorSpecifies the component's background color.
--calcite-action-corner-radius-end-end
deprecated Use --calcite-action-corner-radius. Specifies the component's corner radius end end.
--calcite-action-corner-radius-end-start
deprecated Use --calcite-action-corner-radius. Specifies the component's corner radius end start.
--calcite-action-corner-radius-start-end
deprecated Use --calcite-action-corner-radius. Specifies the component's corner radius start end.
--calcite-action-corner-radius-start-start
deprecated Use --calcite-action-corner-radius. Specifies the component's corner radius start start.
--calcite-action-corner-radiusSpecifies the component's corner radius.
--calcite-action-indicator-colorSpecifies the component's indicator color.
--calcite-action-text-color-pressSpecifies the component's text color when pressed or hovered.
--calcite-action-text-color-pressed
deprecated Use --calcite-action-text-color-press. Specifies the component's text color when hovered.
--calcite-action-text-colorSpecifies the component's text color.

Methods

NameDescriptionSignature
componentOnReadyCreate a promise that resolves once component is fully loaded.componentOnReady(): Promise<void>
setFocusSets focus on the component.setFocus(options?: FocusOptions): Promise<void>

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.