Vaadin WC API reference

Description

<vaadin-button> is an accessible and customizable button that allows users to perform actions.

<vaadin-button>Press me</vaadin-button>

Styling

The following shadow DOM parts are available for styling:

Part name Description
label The label (text) inside the button.
prefix A slot for content before the label (e.g. an icon).
suffix A slot for content after the label (e.g. an icon).

The following attributes are available for styling:

Attribute Description
active Set when the button is pressed down, either with mouse, touch or the keyboard.
disabled Set when the button is disabled.
focus-ring Set when the button is focused using the keyboard.
focused Set when the button is focused.

See Styling Components documentation.

Properties

disabled

Type: boolean

When disabled, the button is rendered as "dimmed" and prevents all user interactions (mouse and keyboard).

Since disabled buttons are not focusable and cannot react to hover events by default, it can cause accessibility issues by making them entirely invisible to assistive technologies, and prevents the use of Tooltips to explain why the action is not available. This can be addressed by enabling the feature flag accessibleDisabledButtons, which makes disabled buttons focusable and hoverable, while still preventing them from being triggered:

// Set before any button is attached to the DOM.
window.Vaadin.featureFlags.accessibleDisabledButtons = true