Skip to content

Commit fd002a4

Browse files
committed
Update section component descriptions
1 parent 23890ae commit fd002a4

File tree

1 file changed

+3
-7
lines changed
  • packages/ui-extensions/src/surfaces/customer-account/components

1 file changed

+3
-7
lines changed

packages/ui-extensions/src/surfaces/customer-account/components/Section.d.ts

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,7 @@ import {BaseElementPropsWithChildren, IdProps} from './shared';
22

33
export interface SectionProps extends IdProps {
44
/**
5-
* A label used to describe the section that will be announced by assistive technologies.
6-
*
7-
* When no `heading` property is provided or included as a children of the Section, you **must** provide an
8-
* `accessibilityLabel` to describe the Section. This is important as it allows assistive technologies to provide
9-
* the right context to users.
5+
* A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.
106
*/
117
accessibilityLabel?: string;
128

@@ -18,11 +14,11 @@ export interface SectionProps extends IdProps {
1814

1915
export interface SectionElementSlots {
2016
/**
21-
* The primary action for the section. Accepts a single [button](/docs/api/checkout-ui-extensions/web-components/actions/button) component.
17+
* The main call-to-action for the section. Accepts a single [button](/docs/api/{API_NAME}/{API_VERSION}/web-components/actions/button) component.
2218
*/
2319
'primary-action'?: HTMLElement;
2420
/**
25-
* The secondary actions for the section. Accepts multiple [Button](/docs/api/checkout-ui-extensions/web-components/actions/button) elements.
21+
* Additional actions for the section. Accepts one or more [button](/docs/api/{API_NAME}/{API_VERSION}/web-components/actions/button) components.
2622
*/
2723
'secondary-actions'?: HTMLElement;
2824
}

0 commit comments

Comments
 (0)