chore(action-button): implement accessibility features #6348
+1,101
−2
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| /** | ||
| * Copyright 2026 Adobe. All rights reserved. | ||
| * This file is licensed to you under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. You may obtain a copy | ||
| * of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software distributed under | ||
| * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS | ||
| * OF ANY KIND, either express or implied. See the License for the specific language | ||
| * governing permissions and limitations under the License. | ||
| */ | ||
|
|
||
| import type { ElementSize } from '@spectrum-web-components/core/mixins/index.js'; | ||
|
|
||
| // ────────────────── | ||
| // SHARED | ||
| // ────────────────── | ||
|
|
||
| export const ACTION_BUTTON_VALID_SIZES = [ | ||
| 'xs', | ||
| 's', | ||
| 'm', | ||
| 'l', | ||
| 'xl', | ||
| ] as const satisfies readonly ElementSize[]; | ||
|
|
||
| export const ACTION_BUTTON_STATIC_COLORS = ['white', 'black'] as const; | ||
|
|
||
| // ────────────────── | ||
| // TYPES | ||
| // ────────────────── | ||
|
|
||
| export type ActionButtonSize = (typeof ACTION_BUTTON_VALID_SIZES)[number]; | ||
| export type ActionButtonStaticColor = | ||
| (typeof ACTION_BUTTON_STATIC_COLORS)[number]; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| /** | ||
| * Copyright 2026 Adobe. All rights reserved. | ||
| * This file is licensed to you under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. You may obtain a copy | ||
| * of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software distributed under | ||
| * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS | ||
| * OF ANY KIND, either express or implied. See the License for the specific language | ||
| * governing permissions and limitations under the License. | ||
| */ | ||
| export * from './ActionButton.types.js'; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| /** | ||
| * Copyright 2026 Adobe. All rights reserved. | ||
| * This file is licensed to you under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. You may obtain a copy | ||
| * of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software distributed under | ||
| * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS | ||
| * OF ANY KIND, either express or implied. See the License for the specific language | ||
| * governing permissions and limitations under the License. | ||
| */ | ||
|
|
||
| import { CSSResultArray, html, TemplateResult } from 'lit'; | ||
| import { property, state } from 'lit/decorators.js'; | ||
| import { classMap } from 'lit/directives/class-map.js'; | ||
| import { ifDefined } from 'lit/directives/if-defined.js'; | ||
|
|
||
| import { | ||
| ACTION_BUTTON_VALID_SIZES, | ||
| type ActionButtonSize, | ||
| type ActionButtonStaticColor, | ||
| } from '@spectrum-web-components/core/components/action-button'; | ||
| import { ButtonBase } from '@spectrum-web-components/core/components/button'; | ||
|
|
||
| import styles from './action-button.css'; | ||
|
|
||
| /** | ||
| * A compact action button for toolbars, action groups, and icon-first chrome. | ||
| * | ||
| * @element swc-action-button | ||
| * @since 0.0.1 | ||
| * | ||
| * @slot - Visible button label. | ||
| * @slot icon - Optional leading icon displayed before the label. | ||
| * | ||
| * @example | ||
| * <swc-action-button>Edit</swc-action-button> | ||
| * | ||
| * @example | ||
| * <swc-action-button quiet> | ||
| * <sp-icon-edit slot="icon"></sp-icon-edit> | ||
| * Edit | ||
| * </swc-action-button> | ||
| */ | ||
| export class ActionButton extends ButtonBase { | ||
| // ────────────────────── | ||
| // API OVERRIDES | ||
| // ────────────────────── | ||
|
|
||
| /** @internal */ | ||
| static override readonly VALID_SIZES: readonly ActionButtonSize[] = | ||
| ACTION_BUTTON_VALID_SIZES; | ||
|
|
||
| // ─────────────────── | ||
| // API ADDITIONS | ||
| // ─────────────────── | ||
|
|
||
| /** Applies the quiet (low-emphasis) visual treatment. */ | ||
| @property({ type: Boolean, reflect: true }) | ||
| public quiet: boolean = false; | ||
|
|
||
| /** Static color treatment for display over colored or image backgrounds. */ | ||
| @property({ type: String, reflect: true, attribute: 'static-color' }) | ||
| public staticColor?: ActionButtonStaticColor; | ||
|
|
||
| // ────────────────────────────── | ||
| // RENDERING & STYLING | ||
| // ────────────────────────────── | ||
|
|
||
| public static override get styles(): CSSResultArray { | ||
| return [styles]; | ||
| } | ||
|
|
||
| // Observe aria-haspopup / aria-expanded without @property so they don't | ||
| // conflict with ARIAMixin types on HTMLElement or appear in the public CEM. | ||
| static override get observedAttributes(): string[] { | ||
| return [...super.observedAttributes, 'aria-haspopup', 'aria-expanded']; | ||
| } | ||
|
|
||
| // Forwarded to the inner <button> for menu-trigger patterns; stripped from | ||
| // the host after reading to avoid duplicate ARIA state on both elements. | ||
| @state() | ||
| private _ariaHasPopup?: string; | ||
|
|
||
| @state() | ||
| private _ariaExpanded?: string; | ||
|
|
||
| // Guard against re-entrant attributeChangedCallback: removeAttribute fires a | ||
| // second callback with value=null; the guard prevents that from clearing the | ||
| // state we just set. | ||
| private _ariaForwardingInProgress = false; | ||
|
|
||
| /** @internal */ | ||
| override attributeChangedCallback( | ||
| name: string, | ||
| old: string | null, | ||
| value: string | null | ||
| ): void { | ||
| const isAriaPassthrough = | ||
| name === 'aria-haspopup' || name === 'aria-expanded'; | ||
| if (isAriaPassthrough && this._ariaForwardingInProgress) { | ||
| return; | ||
| } | ||
| if (isAriaPassthrough) { | ||
| if (name === 'aria-haspopup') { | ||
| this._ariaHasPopup = value ?? undefined; | ||
| } else { | ||
| this._ariaExpanded = value ?? undefined; | ||
| } | ||
| if (value !== null) { | ||
| this._ariaForwardingInProgress = true; | ||
| this.removeAttribute(name); | ||
| this._ariaForwardingInProgress = false; | ||
| } | ||
| return; | ||
| } | ||
| super.attributeChangedCallback(name, old, value); | ||
| } | ||
|
|
||
| protected override render(): TemplateResult { | ||
| return html` | ||
| <button | ||
| class=${classMap({ | ||
| 'swc-ActionButton': true, | ||
| 'swc-ActionButton--hasIcon': this.hasIcon, | ||
| 'swc-ActionButton--iconOnly': this.hasIcon && !this.hasLabel, | ||
| 'swc-ActionButton--pendingActive': this.pendingActive, | ||
| })} | ||
| type="button" | ||
| @click=${this.handleClick} | ||
| ?disabled=${this.disabled} | ||
| aria-disabled=${ifDefined( | ||
| this.pending && !this.disabled ? 'true' : undefined | ||
| )} | ||
| aria-label=${ifDefined( | ||
| this.pending ? this.getPendingAccessibleName() : this.accessibleLabel | ||
| )} | ||
| aria-haspopup=${ifDefined(this._ariaHasPopup)} | ||
| aria-expanded=${ifDefined(this._ariaExpanded)} | ||
| > | ||
| <slot name="icon"></slot> | ||
| <span class="swc-ActionButton-label"> | ||
| <slot></slot> | ||
| </span> | ||
| <span class="swc-ActionButton-pendingIcon" aria-hidden="true"></span> | ||
| </button> | ||
| `; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| /** | ||
| * Copyright 2026 Adobe. All rights reserved. | ||
| * This file is licensed to you under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. You may obtain a copy | ||
| * of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software distributed under | ||
| * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS | ||
| * OF ANY KIND, either express or implied. See the License for the specific language | ||
| * governing permissions and limitations under the License. | ||
| */ | ||
|
|
||
| .swc-ActionButton { | ||
| display: inline-flex; | ||
| align-items: center; | ||
| justify-content: center; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| /** | ||
| * Copyright 2026 Adobe. All rights reserved. | ||
| * This file is licensed to you under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. You may obtain a copy | ||
| * of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software distributed under | ||
| * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS | ||
| * OF ANY KIND, either express or implied. See the License for the specific language | ||
| * governing permissions and limitations under the License. | ||
| */ | ||
| export * from './ActionButton.js'; |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is not deprecated technically. its just not included in scope of MVP but should be addressed sooner than later.
For all deprecation notices: Also we might want to have a chat in a sync about the deprecation language because these are a bit confusing to me since there wont be a future release its removed and we are referencing gen2 components that dont exist yet
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right on! I updated it but can revise as needed. ✨