diff --git a/.changeset/slow-rocks-press.md b/.changeset/slow-rocks-press.md new file mode 100644 index 00000000000..1f66965825c --- /dev/null +++ b/.changeset/slow-rocks-press.md @@ -0,0 +1,6 @@ +--- +'@shopify/polaris': minor +'polaris.shopify.com': patch +--- + +Updated `Box` and `AlphaStack` to accept aria attributes diff --git a/polaris-react/src/components/AlphaStack/AlphaStack.tsx b/polaris-react/src/components/AlphaStack/AlphaStack.tsx index 9c8fe713d28..ee9b1246990 100644 --- a/polaris-react/src/components/AlphaStack/AlphaStack.tsx +++ b/polaris-react/src/components/AlphaStack/AlphaStack.tsx @@ -16,7 +16,7 @@ type Element = 'div' | 'ul' | 'ol' | 'fieldset'; type Gap = ResponsiveProp; -export interface AlphaStackProps { +export interface AlphaStackProps extends React.AriaAttributes { children?: React.ReactNode; /** HTML Element type * @default 'div' @@ -34,6 +34,8 @@ export interface AlphaStackProps { * @default '4' */ gap?: Gap; + /** HTML id attribute */ + id?: string; } export const AlphaStack = ({ @@ -42,6 +44,8 @@ export const AlphaStack = ({ align = 'start', fullWidth = false, gap = '4', + id, + ...restProps }: AlphaStackProps) => { const className = classNames( styles.AlphaStack, @@ -59,6 +63,7 @@ export const AlphaStack = ({ { className, style: sanitizeCustomProperties(style), + ...restProps, }, children, ); diff --git a/polaris-react/src/components/Box/Box.tsx b/polaris-react/src/components/Box/Box.tsx index e404b62a2fc..fe479236f9f 100644 --- a/polaris-react/src/components/Box/Box.tsx +++ b/polaris-react/src/components/Box/Box.tsx @@ -68,7 +68,7 @@ export type BackgroundColors = | ColorsActionTokenAlias | ColorsSurfaceTokenAlias; -export interface BoxProps { +export interface BoxProps extends React.AriaAttributes { children?: React.ReactNode; /** HTML Element type * @default 'div' @@ -216,6 +216,7 @@ export const Box = forwardRef( insetInlineEnd, zIndex, opacity, + ...restProps }, ref, ) => { @@ -326,6 +327,7 @@ export const Box = forwardRef( id, ref, style: sanitizeCustomProperties(style), + ...restProps, }, children, ); diff --git a/polaris-react/src/components/Box/tests/Box.test.tsx b/polaris-react/src/components/Box/tests/Box.test.tsx index a13be52bcae..966d657b05f 100644 --- a/polaris-react/src/components/Box/tests/Box.test.tsx +++ b/polaris-react/src/components/Box/tests/Box.test.tsx @@ -111,4 +111,17 @@ describe('Box', () => { }) as React.CSSProperties, }); }); + + it('renders the aria attributes that matches the aria attributes passed in', () => { + const box = mountWithApp( + + {children} + , + ); + + expect(box).toContainReactComponent('div', { + 'aria-required': true, + 'aria-describedby': 'test', + }); + }); }); diff --git a/polaris.shopify.com/src/data/props.json b/polaris.shopify.com/src/data/props.json index aa66fd64571..a236d59cc11 100644 --- a/polaris.shopify.com/src/data/props.json +++ b/polaris.shopify.com/src/data/props.json @@ -4296,84 +4296,6 @@ "description": "" } }, - "NavigableOption": { - "polaris-react/src/utilities/listbox/types.ts": { - "filePath": "polaris-react/src/utilities/listbox/types.ts", - "name": "NavigableOption", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/utilities/listbox/types.ts", - "syntaxKind": "PropertySignature", - "name": "domId", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/utilities/listbox/types.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/utilities/listbox/types.ts", - "syntaxKind": "PropertySignature", - "name": "element", - "value": "HTMLElement", - "description": "" - }, - { - "filePath": "polaris-react/src/utilities/listbox/types.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "" - }, - { - "filePath": "polaris-react/src/utilities/listbox/types.ts", - "syntaxKind": "PropertySignature", - "name": "isAction", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/utilities/listbox/types.ts", - "syntaxKind": "PropertySignature", - "name": "index", - "value": "number", - "description": "", - "isOptional": true - } - ], - "value": "export interface NavigableOption {\n domId: string;\n value: string;\n element: HTMLElement;\n disabled: boolean;\n isAction?: boolean;\n index?: number;\n}" - } - }, - "ListboxContextType": { - "polaris-react/src/utilities/listbox/context.ts": { - "filePath": "polaris-react/src/utilities/listbox/context.ts", - "name": "ListboxContextType", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/utilities/listbox/context.ts", - "syntaxKind": "MethodSignature", - "name": "onOptionSelect", - "value": "(option: NavigableOption) => void", - "description": "" - }, - { - "filePath": "polaris-react/src/utilities/listbox/context.ts", - "syntaxKind": "MethodSignature", - "name": "setLoading", - "value": "(label?: string) => void", - "description": "" - } - ], - "value": "export interface ListboxContextType {\n onOptionSelect(option: NavigableOption): void;\n setLoading(label?: string): void;\n}" - } - }, "LinkLikeComponentProps": { "polaris-react/src/utilities/link/types.ts": { "filePath": "polaris-react/src/utilities/link/types.ts", @@ -7305,57 +7227,82 @@ "description": "" } }, - "StickyItem": { - "polaris-react/src/utilities/sticky-manager/sticky-manager.ts": { - "filePath": "polaris-react/src/utilities/sticky-manager/sticky-manager.ts", - "name": "StickyItem", + "NavigableOption": { + "polaris-react/src/utilities/listbox/types.ts": { + "filePath": "polaris-react/src/utilities/listbox/types.ts", + "name": "NavigableOption", "description": "", "members": [ { - "filePath": "polaris-react/src/utilities/sticky-manager/sticky-manager.ts", + "filePath": "polaris-react/src/utilities/listbox/types.ts", "syntaxKind": "PropertySignature", - "name": "stickyNode", - "value": "HTMLElement", - "description": "Node of the sticky element" + "name": "domId", + "value": "string", + "description": "" }, { - "filePath": "polaris-react/src/utilities/sticky-manager/sticky-manager.ts", + "filePath": "polaris-react/src/utilities/listbox/types.ts", "syntaxKind": "PropertySignature", - "name": "placeHolderNode", - "value": "HTMLElement", - "description": "Placeholder element" + "name": "value", + "value": "string", + "description": "" }, { - "filePath": "polaris-react/src/utilities/sticky-manager/sticky-manager.ts", + "filePath": "polaris-react/src/utilities/listbox/types.ts", "syntaxKind": "PropertySignature", - "name": "boundingElement", + "name": "element", "value": "HTMLElement", - "description": "Element outlining the fixed position boundaries", - "isOptional": true + "description": "" }, { - "filePath": "polaris-react/src/utilities/sticky-manager/sticky-manager.ts", + "filePath": "polaris-react/src/utilities/listbox/types.ts", "syntaxKind": "PropertySignature", - "name": "offset", + "name": "disabled", "value": "boolean", - "description": "Offset vertical spacing from the top of the scrollable container" + "description": "" }, { - "filePath": "polaris-react/src/utilities/sticky-manager/sticky-manager.ts", + "filePath": "polaris-react/src/utilities/listbox/types.ts", "syntaxKind": "PropertySignature", - "name": "disableWhenStacked", + "name": "isAction", "value": "boolean", - "description": "Should the element remain in a fixed position when the layout is stacked (smaller screens)" + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/utilities/sticky-manager/sticky-manager.ts", + "filePath": "polaris-react/src/utilities/listbox/types.ts", + "syntaxKind": "PropertySignature", + "name": "index", + "value": "number", + "description": "", + "isOptional": true + } + ], + "value": "export interface NavigableOption {\n domId: string;\n value: string;\n element: HTMLElement;\n disabled: boolean;\n isAction?: boolean;\n index?: number;\n}" + } + }, + "ListboxContextType": { + "polaris-react/src/utilities/listbox/context.ts": { + "filePath": "polaris-react/src/utilities/listbox/context.ts", + "name": "ListboxContextType", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/utilities/listbox/context.ts", "syntaxKind": "MethodSignature", - "name": "handlePositioning", - "value": "(stick: boolean, top?: number, left?: number, width?: string | number) => void", - "description": "Method to handle positioning" + "name": "onOptionSelect", + "value": "(option: NavigableOption) => void", + "description": "" + }, + { + "filePath": "polaris-react/src/utilities/listbox/context.ts", + "syntaxKind": "MethodSignature", + "name": "setLoading", + "value": "(label?: string) => void", + "description": "" } ], - "value": "interface StickyItem {\n /** Node of the sticky element */\n stickyNode: HTMLElement;\n /** Placeholder element */\n placeHolderNode: HTMLElement;\n /** Element outlining the fixed position boundaries */\n boundingElement?: HTMLElement | null;\n /** Offset vertical spacing from the top of the scrollable container */\n offset: boolean;\n /** Should the element remain in a fixed position when the layout is stacked (smaller screens) */\n disableWhenStacked: boolean;\n /** Method to handle positioning */\n handlePositioning(\n stick: boolean,\n top?: number,\n left?: number,\n width?: string | number,\n ): void;\n}" + "value": "export interface ListboxContextType {\n onOptionSelect(option: NavigableOption): void;\n setLoading(label?: string): void;\n}" } }, "PortalsContainerElement": { @@ -7460,6 +7407,59 @@ "value": "export interface ResourceListContextType {\n registerCheckableButtons?(\n key: CheckableButtonKey,\n button: CheckboxHandles,\n ): void;\n selectMode?: boolean;\n selectable?: boolean;\n selectedItems?: ResourceListSelectedItems;\n resourceName?: {\n singular: string;\n plural: string;\n };\n loading?: boolean;\n onSelectionChange?(\n selected: boolean,\n id: string,\n sortNumber: number | undefined,\n shiftKey: boolean,\n ): void;\n}" } }, + "StickyItem": { + "polaris-react/src/utilities/sticky-manager/sticky-manager.ts": { + "filePath": "polaris-react/src/utilities/sticky-manager/sticky-manager.ts", + "name": "StickyItem", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/utilities/sticky-manager/sticky-manager.ts", + "syntaxKind": "PropertySignature", + "name": "stickyNode", + "value": "HTMLElement", + "description": "Node of the sticky element" + }, + { + "filePath": "polaris-react/src/utilities/sticky-manager/sticky-manager.ts", + "syntaxKind": "PropertySignature", + "name": "placeHolderNode", + "value": "HTMLElement", + "description": "Placeholder element" + }, + { + "filePath": "polaris-react/src/utilities/sticky-manager/sticky-manager.ts", + "syntaxKind": "PropertySignature", + "name": "boundingElement", + "value": "HTMLElement", + "description": "Element outlining the fixed position boundaries", + "isOptional": true + }, + { + "filePath": "polaris-react/src/utilities/sticky-manager/sticky-manager.ts", + "syntaxKind": "PropertySignature", + "name": "offset", + "value": "boolean", + "description": "Offset vertical spacing from the top of the scrollable container" + }, + { + "filePath": "polaris-react/src/utilities/sticky-manager/sticky-manager.ts", + "syntaxKind": "PropertySignature", + "name": "disableWhenStacked", + "value": "boolean", + "description": "Should the element remain in a fixed position when the layout is stacked (smaller screens)" + }, + { + "filePath": "polaris-react/src/utilities/sticky-manager/sticky-manager.ts", + "syntaxKind": "MethodSignature", + "name": "handlePositioning", + "value": "(stick: boolean, top?: number, left?: number, width?: string | number) => void", + "description": "Method to handle positioning" + } + ], + "value": "interface StickyItem {\n /** Node of the sticky element */\n stickyNode: HTMLElement;\n /** Placeholder element */\n placeHolderNode: HTMLElement;\n /** Element outlining the fixed position boundaries */\n boundingElement?: HTMLElement | null;\n /** Offset vertical spacing from the top of the scrollable container */\n offset: boolean;\n /** Should the element remain in a fixed position when the layout is stacked (smaller screens) */\n disableWhenStacked: boolean;\n /** Method to handle positioning */\n handlePositioning(\n stick: boolean,\n top?: number,\n left?: number,\n width?: string | number,\n ): void;\n}" + } + }, "DropZoneEvent": { "polaris-react/src/components/DropZone/utils/index.ts": { "filePath": "polaris-react/src/components/DropZone/utils/index.ts", @@ -7671,147 +7671,46 @@ "value": "export interface AccountConnectionProps {\n /** Content to display as title */\n title?: React.ReactNode;\n /** Content to display as additional details */\n details?: React.ReactNode;\n /** Content to display as terms of service */\n termsOfService?: React.ReactNode;\n /** The name of the service */\n accountName?: string;\n /** URL for the user’s avatar image */\n avatarUrl?: string;\n /** Set if the account is connected */\n connected?: boolean;\n /** Action for account connection */\n action?: Action;\n}" } }, - "ActionMenuProps": { - "polaris-react/src/components/ActionMenu/ActionMenu.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "name": "ActionMenuProps", + "Props": { + "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx": { + "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", + "name": "Props", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", "syntaxKind": "PropertySignature", - "name": "actions", - "value": "MenuActionDescriptor[]", - "description": "Collection of page-level secondary actions", + "name": "children", + "value": "ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", "syntaxKind": "PropertySignature", - "name": "groups", - "value": "MenuGroupDescriptor[]", - "description": "Collection of page-level action groups", + "name": "fallback", + "value": "ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", "syntaxKind": "PropertySignature", - "name": "rollup", - "value": "boolean", - "description": "Roll up all actions into a Popover > ActionList", + "name": "onMount", + "value": "() => void", + "description": "", "isOptional": true - }, + } + ], + "value": "interface Props {\n children?: ReactNode;\n fallback?: ReactNode;\n onMount?: () => void;\n}" + }, + "polaris-react/src/components/FocusManager/FocusManager.tsx": { + "filePath": "polaris-react/src/components/FocusManager/FocusManager.tsx", + "name": "Props", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "rollupActionsLabel", - "value": "string", - "description": "Label for rolled up actions activator", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "MethodSignature", - "name": "onActionRollup", - "value": "(hasRolledUp: boolean) => void", - "description": "Callback that returns true when secondary actions are rolled up into action groups, and false when not", - "isOptional": true - } - ], - "value": "export interface ActionMenuProps {\n /** Collection of page-level secondary actions */\n actions?: MenuActionDescriptor[];\n /** Collection of page-level action groups */\n groups?: MenuGroupDescriptor[];\n /** Roll up all actions into a Popover > ActionList */\n rollup?: boolean;\n /** Label for rolled up actions activator */\n rollupActionsLabel?: string;\n /** Callback that returns true when secondary actions are rolled up into action groups, and false when not */\n onActionRollup?(hasRolledUp: boolean): void;\n}" - } - }, - "ActionListProps": { - "polaris-react/src/components/ActionList/ActionList.tsx": { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "name": "ActionListProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "items", - "value": "readonly ActionListItemDescriptor[]", - "description": "Collection of actions for list", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "sections", - "value": "readonly ActionListSection[]", - "description": "Collection of sectioned action items", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "actionRole", - "value": "string", - "description": "Defines a specific role attribute for each action in the list", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any item is clicked or keypressed", - "isOptional": true - } - ], - "value": "export interface ActionListProps {\n /** Collection of actions for list */\n items?: readonly ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" - } - }, - "ActionListItemProps": { - "polaris-react/src/components/ActionList/ActionList.tsx": { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "ActionListItemProps", - "value": "ItemProps", - "description": "" - } - }, - "Props": { - "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx": { - "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", - "name": "Props", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", - "syntaxKind": "PropertySignature", - "name": "fallback", - "value": "ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", - "syntaxKind": "PropertySignature", - "name": "onMount", - "value": "() => void", - "description": "", - "isOptional": true - } - ], - "value": "interface Props {\n children?: ReactNode;\n fallback?: ReactNode;\n onMount?: () => void;\n}" - }, - "polaris-react/src/components/FocusManager/FocusManager.tsx": { - "filePath": "polaris-react/src/components/FocusManager/FocusManager.tsx", - "name": "Props", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/FocusManager/FocusManager.tsx", + "filePath": "polaris-react/src/components/FocusManager/FocusManager.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", @@ -8056,6 +7955,56 @@ "value": "interface Props {\n /** Callback when the search is dismissed */\n onDismiss?(): void;\n /** Determines whether the overlay should be visible */\n visible: boolean;\n}" } }, + "ActionMenuProps": { + "polaris-react/src/components/ActionMenu/ActionMenu.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "name": "ActionMenuProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "actions", + "value": "MenuActionDescriptor[]", + "description": "Collection of page-level secondary actions", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "groups", + "value": "MenuGroupDescriptor[]", + "description": "Collection of page-level action groups", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "rollup", + "value": "boolean", + "description": "Roll up all actions into a Popover > ActionList", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "rollupActionsLabel", + "value": "string", + "description": "Label for rolled up actions activator", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "MethodSignature", + "name": "onActionRollup", + "value": "(hasRolledUp: boolean) => void", + "description": "Callback that returns true when secondary actions are rolled up into action groups, and false when not", + "isOptional": true + } + ], + "value": "export interface ActionMenuProps {\n /** Collection of page-level secondary actions */\n actions?: MenuActionDescriptor[];\n /** Collection of page-level action groups */\n groups?: MenuGroupDescriptor[];\n /** Roll up all actions into a Popover > ActionList */\n rollup?: boolean;\n /** Label for rolled up actions activator */\n rollupActionsLabel?: string;\n /** Callback that returns true when secondary actions are rolled up into action groups, and false when not */\n onActionRollup?(hasRolledUp: boolean): void;\n}" + } + }, "CardBackgroundColorTokenScale": { "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", @@ -8109,6 +8058,57 @@ "value": "export interface AlphaCardProps {\n children?: React.ReactNode;\n /** Background color\n * @default 'surface'\n */\n background?: CardBackgroundColorTokenScale;\n /** The spacing around the card\n * @default '5'\n */\n padding?: SpacingSpaceScale;\n /** Border radius value above a set breakpoint */\n roundedAbove?: BreakpointsAlias;\n}" } }, + "ActionListProps": { + "polaris-react/src/components/ActionList/ActionList.tsx": { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "name": "ActionListProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "items", + "value": "readonly ActionListItemDescriptor[]", + "description": "Collection of actions for list", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "sections", + "value": "readonly ActionListSection[]", + "description": "Collection of sectioned action items", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "actionRole", + "value": "string", + "description": "Defines a specific role attribute for each action in the list", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any item is clicked or keypressed", + "isOptional": true + } + ], + "value": "export interface ActionListProps {\n /** Collection of actions for list */\n items?: readonly ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" + } + }, + "ActionListItemProps": { + "polaris-react/src/components/ActionList/ActionList.tsx": { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ActionListItemProps", + "value": "ItemProps", + "description": "" + } + }, "Align": { "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", @@ -8227,9 +8227,17 @@ "description": "The spacing between children", "isOptional": true, "defaultValue": "'4'" + }, + { + "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "HTML id attribute", + "isOptional": true } ], - "value": "export interface AlphaStackProps {\n children?: React.ReactNode;\n /** HTML Element type\n * @default 'div'\n */\n as?: Element;\n /** Vertical alignment of children\n * @default 'start'\n */\n align?: Align;\n /** Toggle children to be full width\n * @default false\n */\n fullWidth?: boolean;\n /** The spacing between children\n * @default '4'\n */\n gap?: Gap;\n}" + "value": "export interface AlphaStackProps extends React.AriaAttributes {\n children?: React.ReactNode;\n /** HTML Element type\n * @default 'div'\n */\n as?: Element;\n /** Vertical alignment of children\n * @default 'start'\n */\n align?: Align;\n /** Toggle children to be full width\n * @default false\n */\n fullWidth?: boolean;\n /** The spacing between children\n * @default '4'\n */\n gap?: Gap;\n /** HTML id attribute */\n id?: string;\n}" } }, "State": { @@ -8500,6 +8508,28 @@ ], "value": "interface State {\n actionsMenuVisible: boolean;\n focused: boolean;\n focusedInner: boolean;\n selected: boolean;\n}" }, + "polaris-react/src/components/Sticky/Sticky.tsx": { + "filePath": "polaris-react/src/components/Sticky/Sticky.tsx", + "name": "State", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Sticky/Sticky.tsx", + "syntaxKind": "PropertySignature", + "name": "isSticky", + "value": "boolean", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Sticky/Sticky.tsx", + "syntaxKind": "PropertySignature", + "name": "style", + "value": "{ [key: string]: unknown; }", + "description": "" + } + ], + "value": "interface State {\n isSticky: boolean;\n style: {[key: string]: unknown};\n}" + }, "polaris-react/src/components/Tabs/Tabs.tsx": { "filePath": "polaris-react/src/components/Tabs/Tabs.tsx", "name": "State", @@ -8557,49 +8587,27 @@ ], "value": "interface State {\n disclosureWidth: number;\n tabWidths: number[];\n visibleTabs: number[];\n hiddenTabs: number[];\n containerWidth: number;\n showDisclosure: boolean;\n tabToFocus: number;\n}" }, - "polaris-react/src/components/Sticky/Sticky.tsx": { - "filePath": "polaris-react/src/components/Sticky/Sticky.tsx", + "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx": { + "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", "name": "State", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Sticky/Sticky.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", "syntaxKind": "PropertySignature", - "name": "isSticky", - "value": "boolean", + "name": "sliderHeight", + "value": "number", "description": "" }, { - "filePath": "polaris-react/src/components/Sticky/Sticky.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", "syntaxKind": "PropertySignature", - "name": "style", - "value": "{ [key: string]: unknown; }", + "name": "draggerHeight", + "value": "number", "description": "" } ], - "value": "interface State {\n isSticky: boolean;\n style: {[key: string]: unknown};\n}" - }, - "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx": { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", - "name": "State", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", - "syntaxKind": "PropertySignature", - "name": "sliderHeight", - "value": "number", - "description": "" - }, - { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", - "syntaxKind": "PropertySignature", - "name": "draggerHeight", - "value": "number", - "description": "" - } - ], - "value": "interface State {\n sliderHeight: number;\n draggerHeight: number;\n}" + "value": "interface State {\n sliderHeight: number;\n draggerHeight: number;\n}" }, "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx": { "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", @@ -10168,7 +10176,7 @@ "isOptional": true } ], - "value": "export interface BoxProps {\n children?: React.ReactNode;\n /** HTML Element type\n * @default 'div'\n */\n as?: Element;\n /** Background color */\n background?: BackgroundColors;\n /** Border style */\n border?: BorderTokenAlias;\n /** Vertical end border style */\n borderBlockEnd?: BorderTokenAlias;\n /** Horizontal start border style */\n borderInlineStart?: BorderTokenAlias;\n /** Horizontal end border style */\n borderInlineEnd?: BorderTokenAlias;\n /** Vertical start border style */\n borderBlockStart?: BorderTokenAlias;\n /** Border radius */\n borderRadius?: BorderRadiusTokenScale;\n /** Vertical end horizontal start border radius */\n borderRadiusEndStart?: BorderRadiusTokenScale;\n /** Vertical end horizontal end border radius */\n borderRadiusEndEnd?: BorderRadiusTokenScale;\n /** Vertical start horizontal start border radius */\n borderRadiusStartStart?: BorderRadiusTokenScale;\n /** Vertical start horizontal end border radius */\n borderRadiusStartEnd?: BorderRadiusTokenScale;\n /** Border width */\n borderWidth?: ShapeBorderWidthScale;\n /** Vertical start border width */\n borderBlockStartWidth?: ShapeBorderWidthScale;\n /** Vertical end border width */\n borderBlockEndWidth?: ShapeBorderWidthScale;\n /** Horizontal start border width */\n borderInlineStartWidth?: ShapeBorderWidthScale;\n /** Horizontal end border width */\n borderInlineEndWidth?: ShapeBorderWidthScale;\n /** Color of children */\n color?: ColorTokenScale;\n /** HTML id attribute */\n id?: string;\n /** Minimum height of container */\n minHeight?: string;\n /** Minimum width of container */\n minWidth?: string;\n /** Maximum width of container */\n maxWidth?: string;\n /** Clip horizontal content of children */\n overflowX?: Overflow;\n /** Clip vertical content of children */\n overflowY?: Overflow;\n /** Spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * padding='4'\n * padding={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n padding?: Spacing;\n /** Vertical start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingBlockStart='4'\n * paddingBlockStart={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingBlockStart?: Spacing;\n /** Vertical end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingBlockEnd='4'\n * paddingBlockEnd={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingBlockEnd?: Spacing;\n /** Horizontal start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingInlineStart='4'\n * paddingInlineStart={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingInlineStart?: Spacing;\n /** Horizontal end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingInlineEnd='4'\n * paddingInlineEnd={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingInlineEnd?: Spacing;\n /** Shadow on box */\n shadow?: DepthShadowAlias;\n /** Width of container */\n width?: string;\n // These could be moved to new layout component(s) in the future\n /** Position of box */\n position?: Position;\n /** Top position of box */\n insetBlockStart?: Spacing;\n /** Bottom position of box */\n insetBlockEnd?: Spacing;\n /** Left position of box */\n insetInlineStart?: Spacing;\n /** Right position of box */\n insetInlineEnd?: Spacing;\n /** Opacity of box */\n opacity?: string;\n /** Visually hide the contents (still announced by screenreader) */\n visuallyHidden?: boolean;\n /** z-index of box */\n zIndex?: string;\n}" + "value": "export interface BoxProps extends React.AriaAttributes {\n children?: React.ReactNode;\n /** HTML Element type\n * @default 'div'\n */\n as?: Element;\n /** Background color */\n background?: BackgroundColors;\n /** Border style */\n border?: BorderTokenAlias;\n /** Vertical end border style */\n borderBlockEnd?: BorderTokenAlias;\n /** Horizontal start border style */\n borderInlineStart?: BorderTokenAlias;\n /** Horizontal end border style */\n borderInlineEnd?: BorderTokenAlias;\n /** Vertical start border style */\n borderBlockStart?: BorderTokenAlias;\n /** Border radius */\n borderRadius?: BorderRadiusTokenScale;\n /** Vertical end horizontal start border radius */\n borderRadiusEndStart?: BorderRadiusTokenScale;\n /** Vertical end horizontal end border radius */\n borderRadiusEndEnd?: BorderRadiusTokenScale;\n /** Vertical start horizontal start border radius */\n borderRadiusStartStart?: BorderRadiusTokenScale;\n /** Vertical start horizontal end border radius */\n borderRadiusStartEnd?: BorderRadiusTokenScale;\n /** Border width */\n borderWidth?: ShapeBorderWidthScale;\n /** Vertical start border width */\n borderBlockStartWidth?: ShapeBorderWidthScale;\n /** Vertical end border width */\n borderBlockEndWidth?: ShapeBorderWidthScale;\n /** Horizontal start border width */\n borderInlineStartWidth?: ShapeBorderWidthScale;\n /** Horizontal end border width */\n borderInlineEndWidth?: ShapeBorderWidthScale;\n /** Color of children */\n color?: ColorTokenScale;\n /** HTML id attribute */\n id?: string;\n /** Minimum height of container */\n minHeight?: string;\n /** Minimum width of container */\n minWidth?: string;\n /** Maximum width of container */\n maxWidth?: string;\n /** Clip horizontal content of children */\n overflowX?: Overflow;\n /** Clip vertical content of children */\n overflowY?: Overflow;\n /** Spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * padding='4'\n * padding={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n padding?: Spacing;\n /** Vertical start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingBlockStart='4'\n * paddingBlockStart={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingBlockStart?: Spacing;\n /** Vertical end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingBlockEnd='4'\n * paddingBlockEnd={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingBlockEnd?: Spacing;\n /** Horizontal start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingInlineStart='4'\n * paddingInlineStart={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingInlineStart?: Spacing;\n /** Horizontal end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingInlineEnd='4'\n * paddingInlineEnd={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingInlineEnd?: Spacing;\n /** Shadow on box */\n shadow?: DepthShadowAlias;\n /** Width of container */\n width?: string;\n // These could be moved to new layout component(s) in the future\n /** Position of box */\n position?: Position;\n /** Top position of box */\n insetBlockStart?: Spacing;\n /** Bottom position of box */\n insetBlockEnd?: Spacing;\n /** Left position of box */\n insetInlineStart?: Spacing;\n /** Right position of box */\n insetInlineEnd?: Spacing;\n /** Opacity of box */\n opacity?: string;\n /** Visually hide the contents (still announced by screenreader) */\n visuallyHidden?: boolean;\n /** z-index of box */\n zIndex?: string;\n}" } }, "BreadcrumbsProps": { @@ -10421,18 +10429,18 @@ "value": "PropsFromWrapper & (PropsWithUrl | PropsWithClick)", "description": "" }, - "polaris-react/src/components/Tabs/Tabs.tsx": { - "filePath": "polaris-react/src/components/Tabs/Tabs.tsx", + "polaris-react/src/components/Sticky/Sticky.tsx": { + "filePath": "polaris-react/src/components/Sticky/Sticky.tsx", "syntaxKind": "TypeAliasDeclaration", "name": "CombinedProps", - "value": "TabsProps & {\n i18n: ReturnType;\n}", + "value": "StickyProps & {\n stickyManager: ReturnType;\n}", "description": "" }, - "polaris-react/src/components/Sticky/Sticky.tsx": { - "filePath": "polaris-react/src/components/Sticky/Sticky.tsx", + "polaris-react/src/components/Tabs/Tabs.tsx": { + "filePath": "polaris-react/src/components/Tabs/Tabs.tsx", "syntaxKind": "TypeAliasDeclaration", "name": "CombinedProps", - "value": "StickyProps & {\n stickyManager: ReturnType;\n}", + "value": "TabsProps & {\n i18n: ReturnType;\n}", "description": "" } }, @@ -12959,66 +12967,6 @@ "value": "export interface ExceptionListProps {\n /** Collection of items for list */\n items: Item[];\n}" } }, - "FocusProps": { - "polaris-react/src/components/Focus/Focus.tsx": { - "filePath": "polaris-react/src/components/Focus/Focus.tsx", - "name": "FocusProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Focus/Focus.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Focus/Focus.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Focus/Focus.tsx", - "syntaxKind": "PropertySignature", - "name": "root", - "value": "any", - "description": "" - } - ], - "value": "export interface FocusProps {\n children?: React.ReactNode;\n disabled?: boolean;\n root: React.RefObject | HTMLElement | null;\n}" - } - }, - "Context": { - "polaris-react/src/components/FocusManager/FocusManager.tsx": { - "filePath": "polaris-react/src/components/FocusManager/FocusManager.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Context", - "value": "NonNullable>", - "description": "" - } - }, - "FooterHelpProps": { - "polaris-react/src/components/FooterHelp/FooterHelp.tsx": { - "filePath": "polaris-react/src/components/FooterHelp/FooterHelp.tsx", - "name": "FooterHelpProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/FooterHelp/FooterHelp.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to display inside the layout.", - "isOptional": true - } - ], - "value": "export interface FooterHelpProps {\n /** The content to display inside the layout. */\n children?: React.ReactNode;\n}" - } - }, "AppliedFilterInterface": { "polaris-react/src/components/Filters/Filters.tsx": { "filePath": "polaris-react/src/components/Filters/Filters.tsx", @@ -13260,6 +13208,66 @@ ] } }, + "FocusProps": { + "polaris-react/src/components/Focus/Focus.tsx": { + "filePath": "polaris-react/src/components/Focus/Focus.tsx", + "name": "FocusProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Focus/Focus.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Focus/Focus.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Focus/Focus.tsx", + "syntaxKind": "PropertySignature", + "name": "root", + "value": "any", + "description": "" + } + ], + "value": "export interface FocusProps {\n children?: React.ReactNode;\n disabled?: boolean;\n root: React.RefObject | HTMLElement | null;\n}" + } + }, + "Context": { + "polaris-react/src/components/FocusManager/FocusManager.tsx": { + "filePath": "polaris-react/src/components/FocusManager/FocusManager.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Context", + "value": "NonNullable>", + "description": "" + } + }, + "FooterHelpProps": { + "polaris-react/src/components/FooterHelp/FooterHelp.tsx": { + "filePath": "polaris-react/src/components/FooterHelp/FooterHelp.tsx", + "name": "FooterHelpProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/FooterHelp/FooterHelp.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The content to display inside the layout.", + "isOptional": true + } + ], + "value": "export interface FooterHelpProps {\n /** The content to display inside the layout. */\n children?: React.ReactNode;\n}" + } + }, "Enctype": { "polaris-react/src/components/Form/Form.tsx": { "filePath": "polaris-react/src/components/Form/Form.tsx", @@ -13493,6 +13501,31 @@ "value": "export interface FrameProps {\n /** Sets the logo for the TopBar, Navigation, and ContextualSaveBar components */\n logo?: Logo;\n /** A horizontal offset that pushes the frame to the right, leaving empty space on the left */\n offset?: string;\n /** The content to display inside the frame. */\n children?: React.ReactNode;\n /** Accepts a top bar component that will be rendered at the top-most portion of an application frame */\n topBar?: React.ReactNode;\n /** Accepts a navigation component that will be rendered in the left sidebar of an application frame */\n navigation?: React.ReactNode;\n /** Accepts a global ribbon component that will be rendered fixed to the bottom of an application frame */\n globalRibbon?: React.ReactNode;\n /** A boolean property indicating whether the mobile navigation is currently visible\n * @default false\n */\n showMobileNavigation?: boolean;\n /** Accepts a ref to the html anchor element you wish to focus when clicking the skip to content link */\n skipToContentTarget?: React.RefObject;\n /** A callback function to handle clicking the mobile navigation dismiss button */\n onNavigationDismiss?(): void;\n}" } }, + "FullscreenBarProps": { + "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx": { + "filePath": "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx", + "name": "FullscreenBarProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx", + "syntaxKind": "PropertySignature", + "name": "onAction", + "value": "() => void", + "description": "Callback when back button is clicked" + }, + { + "filePath": "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Render child elements", + "isOptional": true + } + ], + "value": "export interface FullscreenBarProps {\n /** Callback when back button is clicked */\n onAction: () => void;\n /** Render child elements */\n children?: React.ReactNode;\n}" + } + }, "Breakpoints": { "polaris-react/src/components/Grid/Grid.tsx": { "filePath": "polaris-react/src/components/Grid/Grid.tsx", @@ -13595,31 +13628,6 @@ "value": "export interface HeadingProps {\n /**\n * The element name to use for the heading\n * @default 'h2'\n */\n element?: HeadingTagName;\n /** The content to display inside the heading */\n children?: React.ReactNode;\n /** A unique identifier for the heading, used for reference in anchor links */\n id?: string;\n}" } }, - "FullscreenBarProps": { - "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx": { - "filePath": "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx", - "name": "FullscreenBarProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx", - "syntaxKind": "PropertySignature", - "name": "onAction", - "value": "() => void", - "description": "Callback when back button is clicked" - }, - { - "filePath": "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Render child elements", - "isOptional": true - } - ], - "value": "export interface FullscreenBarProps {\n /** Callback when back button is clicked */\n onAction: () => void;\n /** Render child elements */\n children?: React.ReactNode;\n}" - } - }, "IconProps": { "polaris-react/src/components/Icon/Icon.tsx": { "filePath": "polaris-react/src/components/Icon/Icon.tsx", @@ -14273,47 +14281,6 @@ "value": "export interface IndicatorProps {\n pulse?: boolean;\n}" } }, - "InlineCodeProps": { - "polaris-react/src/components/InlineCode/InlineCode.tsx": { - "filePath": "polaris-react/src/components/InlineCode/InlineCode.tsx", - "name": "InlineCodeProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/InlineCode/InlineCode.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", - "description": "The content to render inside the code block" - } - ], - "value": "export interface InlineCodeProps {\n /** The content to render inside the code block */\n children: ReactNode;\n}" - } - }, - "InlineErrorProps": { - "polaris-react/src/components/InlineError/InlineError.tsx": { - "filePath": "polaris-react/src/components/InlineError/InlineError.tsx", - "name": "InlineErrorProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/InlineError/InlineError.tsx", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "any", - "description": "Content briefly explaining how to resolve the invalid form field input." - }, - { - "filePath": "polaris-react/src/components/InlineError/InlineError.tsx", - "syntaxKind": "PropertySignature", - "name": "fieldID", - "value": "string", - "description": "Unique identifier of the invalid form field that the message describes" - } - ], - "value": "export interface InlineErrorProps {\n /** Content briefly explaining how to resolve the invalid form field input. */\n message: Error;\n /** Unique identifier of the invalid form field that the message describes */\n fieldID: string;\n}" - } - }, "BlockAlign": { "polaris-react/src/components/Inline/Inline.tsx": { "filePath": "polaris-react/src/components/Inline/Inline.tsx", @@ -14377,39 +14344,45 @@ "value": "export interface InlineProps {\n children?: React.ReactNode;\n /** Horizontal alignment of children\n * @default 'start'\n */\n align?: Align;\n /** Vertical alignment of children\n * @default 'center'\n */\n blockAlign?: BlockAlign;\n /** The spacing between elements. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @default '4'\n * @example\n * gap='2'\n * gap={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n gap?: Gap;\n /** Wrap stack elements to additional rows as needed on small screens\n * @default true\n */\n wrap?: boolean;\n}" } }, - "KeypressListenerProps": { - "polaris-react/src/components/KeypressListener/KeypressListener.tsx": { - "filePath": "polaris-react/src/components/KeypressListener/KeypressListener.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "KeypressListenerProps", - "value": "NonMutuallyExclusiveProps & (\n | {useCapture?: boolean; options?: undefined}\n | {useCapture?: undefined; options?: AddEventListenerOptions}\n )", - "description": "" - } - }, - "KeyEvent": { - "polaris-react/src/components/KeypressListener/KeypressListener.tsx": { - "filePath": "polaris-react/src/components/KeypressListener/KeypressListener.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "KeyEvent", - "value": "'keydown' | 'keyup'", - "description": "" + "InlineCodeProps": { + "polaris-react/src/components/InlineCode/InlineCode.tsx": { + "filePath": "polaris-react/src/components/InlineCode/InlineCode.tsx", + "name": "InlineCodeProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/InlineCode/InlineCode.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ReactNode", + "description": "The content to render inside the code block" + } + ], + "value": "export interface InlineCodeProps {\n /** The content to render inside the code block */\n children: ReactNode;\n}" } }, - "KonamiCodeProps": { - "polaris-react/src/components/KonamiCode/KonamiCode.tsx": { - "filePath": "polaris-react/src/components/KonamiCode/KonamiCode.tsx", - "name": "KonamiCodeProps", + "InlineErrorProps": { + "polaris-react/src/components/InlineError/InlineError.tsx": { + "filePath": "polaris-react/src/components/InlineError/InlineError.tsx", + "name": "InlineErrorProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/KonamiCode/KonamiCode.tsx", - "syntaxKind": "MethodSignature", - "name": "handler", - "value": "(event: KeyboardEvent) => void", - "description": "" + "filePath": "polaris-react/src/components/InlineError/InlineError.tsx", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "any", + "description": "Content briefly explaining how to resolve the invalid form field input." + }, + { + "filePath": "polaris-react/src/components/InlineError/InlineError.tsx", + "syntaxKind": "PropertySignature", + "name": "fieldID", + "value": "string", + "description": "Unique identifier of the invalid form field that the message describes" } ], - "value": "export interface KonamiCodeProps {\n handler(event: KeyboardEvent): void;\n}" + "value": "export interface InlineErrorProps {\n /** Content briefly explaining how to resolve the invalid form field input. */\n message: Error;\n /** Unique identifier of the invalid form field that the message describes */\n fieldID: string;\n}" } }, "KeyboardKeyProps": { @@ -14430,6 +14403,41 @@ "value": "export interface KeyboardKeyProps {\n /** The content to display inside the key */\n children?: string;\n}" } }, + "KeypressListenerProps": { + "polaris-react/src/components/KeypressListener/KeypressListener.tsx": { + "filePath": "polaris-react/src/components/KeypressListener/KeypressListener.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "KeypressListenerProps", + "value": "NonMutuallyExclusiveProps & (\n | {useCapture?: boolean; options?: undefined}\n | {useCapture?: undefined; options?: AddEventListenerOptions}\n )", + "description": "" + } + }, + "KeyEvent": { + "polaris-react/src/components/KeypressListener/KeypressListener.tsx": { + "filePath": "polaris-react/src/components/KeypressListener/KeypressListener.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "KeyEvent", + "value": "'keydown' | 'keyup'", + "description": "" + } + }, + "KonamiCodeProps": { + "polaris-react/src/components/KonamiCode/KonamiCode.tsx": { + "filePath": "polaris-react/src/components/KonamiCode/KonamiCode.tsx", + "name": "KonamiCodeProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/KonamiCode/KonamiCode.tsx", + "syntaxKind": "MethodSignature", + "name": "handler", + "value": "(event: KeyboardEvent) => void", + "description": "" + } + ], + "value": "export interface KonamiCodeProps {\n handler(event: KeyboardEvent): void;\n}" + } + }, "LabelProps": { "polaris-react/src/components/Label/Label.tsx": { "filePath": "polaris-react/src/components/Label/Label.tsx", @@ -14569,6 +14577,88 @@ "value": "export interface LayoutProps {\n /** Automatically adds sections to layout. */\n sectioned?: boolean;\n /** The content to display inside the layout. */\n children?: React.ReactNode;\n}" } }, + "LinkProps": { + "polaris-react/src/components/Link/Link.tsx": { + "filePath": "polaris-react/src/components/Link/Link.tsx", + "name": "LinkProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Link/Link.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "ID for the link", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Link/Link.tsx", + "syntaxKind": "PropertySignature", + "name": "url", + "value": "string", + "description": "The url to link to", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Link/Link.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The content to display inside the link", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Link/Link.tsx", + "syntaxKind": "PropertySignature", + "name": "external", + "value": "boolean", + "description": "Makes the link open in a new tab", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Link/Link.tsx", + "syntaxKind": "PropertySignature", + "name": "monochrome", + "value": "boolean", + "description": "Makes the link color the same as the current text color and adds an underline", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Link/Link.tsx", + "syntaxKind": "PropertySignature", + "name": "removeUnderline", + "value": "boolean", + "description": "Removes text decoration underline to the link", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Link/Link.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "Callback when a link is clicked", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Link/Link.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "Descriptive text to be read to screenreaders", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Link/Link.tsx", + "syntaxKind": "PropertySignature", + "name": "dataPrimaryLink", + "value": "boolean", + "description": "Indicates whether or not the link is the primary navigation link when rendered inside of an `IndexTable.Row`", + "isOptional": true + } + ], + "value": "export interface LinkProps {\n /** ID for the link */\n id?: string;\n /** The url to link to */\n url?: string;\n /** The content to display inside the link */\n children?: React.ReactNode;\n /** Makes the link open in a new tab */\n external?: boolean;\n /** Makes the link color the same as the current text color and adds an underline */\n monochrome?: boolean;\n /** Removes text decoration underline to the link*/\n removeUnderline?: boolean;\n /** Callback when a link is clicked */\n onClick?(): void;\n /** Descriptive text to be read to screenreaders */\n accessibilityLabel?: string;\n /** Indicates whether or not the link is the primary navigation link when rendered inside of an `IndexTable.Row` */\n dataPrimaryLink?: boolean;\n}" + } + }, "Type": { "polaris-react/src/components/List/List.tsx": { "filePath": "polaris-react/src/components/List/List.tsx", @@ -14750,88 +14840,6 @@ "description": "" } }, - "LinkProps": { - "polaris-react/src/components/Link/Link.tsx": { - "filePath": "polaris-react/src/components/Link/Link.tsx", - "name": "LinkProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Link/Link.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "ID for the link", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Link/Link.tsx", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "The url to link to", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Link/Link.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to display inside the link", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Link/Link.tsx", - "syntaxKind": "PropertySignature", - "name": "external", - "value": "boolean", - "description": "Makes the link open in a new tab", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Link/Link.tsx", - "syntaxKind": "PropertySignature", - "name": "monochrome", - "value": "boolean", - "description": "Makes the link color the same as the current text color and adds an underline", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Link/Link.tsx", - "syntaxKind": "PropertySignature", - "name": "removeUnderline", - "value": "boolean", - "description": "Removes text decoration underline to the link", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Link/Link.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "Callback when a link is clicked", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Link/Link.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Descriptive text to be read to screenreaders", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Link/Link.tsx", - "syntaxKind": "PropertySignature", - "name": "dataPrimaryLink", - "value": "boolean", - "description": "Indicates whether or not the link is the primary navigation link when rendered inside of an `IndexTable.Row`", - "isOptional": true - } - ], - "value": "export interface LinkProps {\n /** ID for the link */\n id?: string;\n /** The url to link to */\n url?: string;\n /** The content to display inside the link */\n children?: React.ReactNode;\n /** Makes the link open in a new tab */\n external?: boolean;\n /** Makes the link color the same as the current text color and adds an underline */\n monochrome?: boolean;\n /** Removes text decoration underline to the link*/\n removeUnderline?: boolean;\n /** Callback when a link is clicked */\n onClick?(): void;\n /** Descriptive text to be read to screenreaders */\n accessibilityLabel?: string;\n /** Indicates whether or not the link is the primary navigation link when rendered inside of an `IndexTable.Row` */\n dataPrimaryLink?: boolean;\n}" - } - }, "LoadingProps": { "polaris-react/src/components/Loading/Loading.tsx": { "filePath": "polaris-react/src/components/Loading/Loading.tsx", @@ -15299,46 +15307,136 @@ "value": "interface NavigationContextType {\n location: string;\n onNavigationDismiss?(): void;\n withinContentContainer?: boolean;\n}" } }, - "PageActionsProps": { - "polaris-react/src/components/PageActions/PageActions.tsx": { - "filePath": "polaris-react/src/components/PageActions/PageActions.tsx", - "name": "PageActionsProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/PageActions/PageActions.tsx", - "syntaxKind": "PropertySignature", - "name": "primaryAction", - "value": "any", - "description": "The primary action for the page", + "Alignment": { + "polaris-react/src/components/OptionList/OptionList.tsx": { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Alignment", + "value": "'top' | 'center' | 'bottom'", + "description": "" + }, + "polaris-react/src/components/ResourceItem/ResourceItem.tsx": { + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Alignment", + "value": "'leading' | 'trailing' | 'center' | 'fill' | 'baseline'", + "description": "" + }, + "polaris-react/src/components/Stack/Stack.tsx": { + "filePath": "polaris-react/src/components/Stack/Stack.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Alignment", + "value": "'leading' | 'trailing' | 'center' | 'fill' | 'baseline'", + "description": "" + }, + "polaris-react/src/components/Text/Text.tsx": { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Alignment", + "value": "'start' | 'center' | 'end' | 'justify'", + "description": "" + }, + "polaris-react/src/components/TextField/TextField.tsx": { + "filePath": "polaris-react/src/components/TextField/TextField.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Alignment", + "value": "'left' | 'center' | 'right'", + "description": "" + }, + "polaris-react/src/components/OptionList/components/Option/Option.tsx": { + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Alignment", + "value": "'top' | 'center' | 'bottom'", + "description": "" + } + }, + "OptionListProps": { + "polaris-react/src/components/OptionList/OptionList.tsx": { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "name": "OptionListProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the option list", "isOptional": true }, { - "filePath": "polaris-react/src/components/PageActions/PageActions.tsx", + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", "syntaxKind": "PropertySignature", - "name": "secondaryActions", - "value": "any", - "description": "The secondary actions for the page", + "name": "title", + "value": "string", + "description": "List title", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "options", + "value": "OptionDescriptor[]", + "description": "Collection of options to be listed", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string", + "description": "Defines a specific role attribute for the list itself", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "optionRole", + "value": "string", + "description": "Defines a specific role attribute for each option in the list", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "sections", + "value": "SectionDescriptor[]", + "description": "Sections containing a header and related options", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "string[]", + "description": "The selected options" + }, + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "allowMultiple", + "value": "boolean", + "description": "Allow more than one option to be selected", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "verticalAlign", + "value": "Alignment", + "description": "Vertically align child content to the center, top, or bottom.", "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "MethodSignature", + "name": "onChange", + "value": "(selected: string[]) => void", + "description": "Callback when selection is changed" } ], - "value": "export interface PageActionsProps {\n /** The primary action for the page */\n primaryAction?: (DisableableAction & LoadableAction) | React.ReactNode;\n /** The secondary actions for the page */\n secondaryActions?: ComplexAction[] | React.ReactNode;\n}" - } - }, - "MaybeJSX": { - "polaris-react/src/components/PageActions/PageActions.tsx": { - "filePath": "polaris-react/src/components/PageActions/PageActions.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeJSX", - "value": "JSX.Element | null", - "description": "" - }, - "polaris-react/src/components/Page/components/Header/Header.tsx": { - "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "MaybeJSX", - "value": "JSX.Element | null", - "description": "" + "value": "export interface OptionListProps {\n /** A unique identifier for the option list */\n id?: string;\n /** List title */\n title?: string;\n /** Collection of options to be listed */\n options?: OptionDescriptor[];\n /** Defines a specific role attribute for the list itself */\n role?: 'listbox' | 'combobox' | string;\n /** Defines a specific role attribute for each option in the list */\n optionRole?: string;\n /** Sections containing a header and related options */\n sections?: SectionDescriptor[];\n /** The selected options */\n selected: string[];\n /** Allow more than one option to be selected */\n allowMultiple?: boolean;\n /** Vertically align child content to the center, top, or bottom. */\n verticalAlign?: Alignment;\n /** Callback when selection is changed */\n onChange(selected: string[]): void;\n}" } }, "PageProps": { @@ -15488,174 +15586,84 @@ "value": "export interface PageProps extends HeaderProps {\n /** The contents of the page */\n children?: React.ReactNode;\n /** Remove the normal max-width on the page */\n fullWidth?: boolean;\n /** Decreases the maximum layout width. Intended for single-column layouts */\n narrowWidth?: boolean;\n /** Displays a divider between the page header and the page content */\n divider?: boolean;\n}" } }, - "Alignment": { - "polaris-react/src/components/OptionList/OptionList.tsx": { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Alignment", - "value": "'top' | 'center' | 'bottom'", - "description": "" - }, - "polaris-react/src/components/ResourceItem/ResourceItem.tsx": { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Alignment", - "value": "'leading' | 'trailing' | 'center' | 'fill' | 'baseline'", - "description": "" - }, - "polaris-react/src/components/Stack/Stack.tsx": { - "filePath": "polaris-react/src/components/Stack/Stack.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Alignment", - "value": "'leading' | 'trailing' | 'center' | 'fill' | 'baseline'", - "description": "" - }, - "polaris-react/src/components/Text/Text.tsx": { - "filePath": "polaris-react/src/components/Text/Text.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Alignment", - "value": "'start' | 'center' | 'end' | 'justify'", - "description": "" - }, - "polaris-react/src/components/TextField/TextField.tsx": { - "filePath": "polaris-react/src/components/TextField/TextField.tsx", + "PageActionsProps": { + "polaris-react/src/components/PageActions/PageActions.tsx": { + "filePath": "polaris-react/src/components/PageActions/PageActions.tsx", + "name": "PageActionsProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/PageActions/PageActions.tsx", + "syntaxKind": "PropertySignature", + "name": "primaryAction", + "value": "any", + "description": "The primary action for the page", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/PageActions/PageActions.tsx", + "syntaxKind": "PropertySignature", + "name": "secondaryActions", + "value": "any", + "description": "The secondary actions for the page", + "isOptional": true + } + ], + "value": "export interface PageActionsProps {\n /** The primary action for the page */\n primaryAction?: (DisableableAction & LoadableAction) | React.ReactNode;\n /** The secondary actions for the page */\n secondaryActions?: ComplexAction[] | React.ReactNode;\n}" + } + }, + "MaybeJSX": { + "polaris-react/src/components/PageActions/PageActions.tsx": { + "filePath": "polaris-react/src/components/PageActions/PageActions.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "Alignment", - "value": "'left' | 'center' | 'right'", + "name": "MaybeJSX", + "value": "JSX.Element | null", "description": "" }, - "polaris-react/src/components/OptionList/components/Option/Option.tsx": { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "polaris-react/src/components/Page/components/Header/Header.tsx": { + "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "Alignment", - "value": "'top' | 'center' | 'bottom'", + "name": "MaybeJSX", + "value": "JSX.Element | null", "description": "" } }, - "OptionListProps": { - "polaris-react/src/components/OptionList/OptionList.tsx": { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "name": "OptionListProps", + "AccessibilityLabels": { + "polaris-react/src/components/Pagination/Pagination.tsx": { + "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", + "name": "AccessibilityLabels", "description": "", "members": [ { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", "syntaxKind": "PropertySignature", - "name": "id", + "name": "previous", "value": "string", - "description": "A unique identifier for the option list", - "isOptional": true + "description": "" }, { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", "syntaxKind": "PropertySignature", - "name": "title", + "name": "next", "value": "string", - "description": "List title", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "options", - "value": "OptionDescriptor[]", - "description": "Collection of options to be listed", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "role", - "value": "string", - "description": "Defines a specific role attribute for the list itself", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "optionRole", - "value": "string", - "description": "Defines a specific role attribute for each option in the list", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "sections", - "value": "SectionDescriptor[]", - "description": "Sections containing a header and related options", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "selected", - "value": "string[]", - "description": "The selected options" - }, - { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "allowMultiple", - "value": "boolean", - "description": "Allow more than one option to be selected", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "verticalAlign", - "value": "Alignment", - "description": "Vertically align child content to the center, top, or bottom.", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "MethodSignature", - "name": "onChange", - "value": "(selected: string[]) => void", - "description": "Callback when selection is changed" - } - ], - "value": "export interface OptionListProps {\n /** A unique identifier for the option list */\n id?: string;\n /** List title */\n title?: string;\n /** Collection of options to be listed */\n options?: OptionDescriptor[];\n /** Defines a specific role attribute for the list itself */\n role?: 'listbox' | 'combobox' | string;\n /** Defines a specific role attribute for each option in the list */\n optionRole?: string;\n /** Sections containing a header and related options */\n sections?: SectionDescriptor[];\n /** The selected options */\n selected: string[];\n /** Allow more than one option to be selected */\n allowMultiple?: boolean;\n /** Vertically align child content to the center, top, or bottom. */\n verticalAlign?: Alignment;\n /** Callback when selection is changed */\n onChange(selected: string[]): void;\n}" - } - }, - "AccessibilityLabels": { - "polaris-react/src/components/Pagination/Pagination.tsx": { - "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", - "name": "AccessibilityLabels", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", - "syntaxKind": "PropertySignature", - "name": "previous", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", - "syntaxKind": "PropertySignature", - "name": "next", - "value": "string", - "description": "" - } - ], - "value": "interface AccessibilityLabels {\n previous: string;\n next: string;\n}" - } - }, - "PaginationProps": { - "polaris-react/src/components/Pagination/Pagination.tsx": { - "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", - "name": "PaginationProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", - "syntaxKind": "PropertySignature", - "name": "nextKeys", - "value": "Key[]", - "description": "Keyboard shortcuts for the next button", + "description": "" + } + ], + "value": "interface AccessibilityLabels {\n previous: string;\n next: string;\n}" + } + }, + "PaginationProps": { + "polaris-react/src/components/Pagination/Pagination.tsx": { + "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", + "name": "PaginationProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Pagination/Pagination.tsx", + "syntaxKind": "PropertySignature", + "name": "nextKeys", + "value": "Key[]", + "description": "Keyboard shortcuts for the next button", "isOptional": true }, { @@ -16085,6 +16093,65 @@ "value": "export interface PopoverPublicAPI {\n forceUpdatePosition(): void;\n}" } }, + "PortalProps": { + "polaris-react/src/components/Portal/Portal.tsx": { + "filePath": "polaris-react/src/components/Portal/Portal.tsx", + "name": "PortalProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Portal/Portal.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Portal/Portal.tsx", + "syntaxKind": "PropertySignature", + "name": "idPrefix", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Portal/Portal.tsx", + "syntaxKind": "MethodSignature", + "name": "onPortalCreated", + "value": "() => void", + "description": "", + "isOptional": true + } + ], + "value": "export interface PortalProps {\n children?: React.ReactNode;\n idPrefix?: string;\n onPortalCreated?(): void;\n}" + } + }, + "PortalsManagerProps": { + "polaris-react/src/components/PortalsManager/PortalsManager.tsx": { + "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", + "name": "PortalsManagerProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "" + }, + { + "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", + "syntaxKind": "PropertySignature", + "name": "container", + "value": "HTMLDivElement", + "description": "", + "isOptional": true + } + ], + "value": "export interface PortalsManagerProps {\n children: React.ReactNode;\n container?: PortalsContainerElement;\n}" + } + }, "Positioning": { "polaris-react/src/components/PositionedOverlay/PositionedOverlay.tsx": { "filePath": "polaris-react/src/components/PositionedOverlay/PositionedOverlay.tsx", @@ -16251,40 +16318,6 @@ "value": "export interface PositionedOverlayProps {\n active: boolean;\n activator: HTMLElement;\n preferInputActivator?: boolean;\n preferredPosition?: PreferredPosition;\n preferredAlignment?: PreferredAlignment;\n fullWidth?: boolean;\n fixed?: boolean;\n preventInteraction?: boolean;\n classNames?: string;\n zIndexOverride?: number;\n render(overlayDetails: OverlayDetails): React.ReactNode;\n onScrollOut?(): void;\n}" } }, - "PortalProps": { - "polaris-react/src/components/Portal/Portal.tsx": { - "filePath": "polaris-react/src/components/Portal/Portal.tsx", - "name": "PortalProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Portal/Portal.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Portal/Portal.tsx", - "syntaxKind": "PropertySignature", - "name": "idPrefix", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Portal/Portal.tsx", - "syntaxKind": "MethodSignature", - "name": "onPortalCreated", - "value": "() => void", - "description": "", - "isOptional": true - } - ], - "value": "export interface PortalProps {\n children?: React.ReactNode;\n idPrefix?: string;\n onPortalCreated?(): void;\n}" - } - }, "ProgressBarProps": { "polaris-react/src/components/ProgressBar/ProgressBar.tsx": { "filePath": "polaris-react/src/components/ProgressBar/ProgressBar.tsx", @@ -16339,55 +16372,135 @@ "value": "export interface ProgressBarProps {\n /**\n * The progression of certain tasks\n * @default 0\n */\n progress?: number;\n /**\n * Size of progressbar\n * @default 'medium'\n */\n size?: Size;\n /**\n * Color of progressbar\n * @default 'highlight'\n */\n color?: Color;\n /**\n * Whether the fill animation is triggered\n * @default 'true'\n */\n animated?: boolean;\n /**\n * Id (ids) of element (elements) that describes progressbar\n */\n ariaLabelledBy?: string;\n}" } }, - "PortalsManagerProps": { - "polaris-react/src/components/PortalsManager/PortalsManager.tsx": { - "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", - "name": "PortalsManagerProps", + "RadioButtonProps": { + "polaris-react/src/components/RadioButton/RadioButton.tsx": { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "name": "RadioButtonProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", "syntaxKind": "PropertySignature", - "name": "children", + "name": "ariaDescribedBy", + "value": "string", + "description": "Indicates the ID of the element that describes the the radio button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "PropertySignature", + "name": "label", "value": "React.ReactNode", - "description": "" + "description": "Label for the radio button" }, { - "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", "syntaxKind": "PropertySignature", - "name": "container", - "value": "HTMLDivElement", - "description": "", + "name": "labelHidden", + "value": "boolean", + "description": "Visually hide the label", "isOptional": true - } - ], - "value": "export interface PortalsManagerProps {\n children: React.ReactNode;\n container?: PortalsContainerElement;\n}" - } - }, - "BaseProps": { - "polaris-react/src/components/ResourceItem/ResourceItem.tsx": { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", - "name": "BaseProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Visually hidden text for screen readers used for item link", + "name": "checked", + "value": "boolean", + "description": "Radio button is selected", "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "Individual item name used by various text labels", + "name": "helpText", + "value": "React.ReactNode", + "description": "Additional text to aid in use", "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Disable input", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "ID for form input", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "Name for form input", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "Value for form input", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onChange", + "value": "(newValue: boolean, id: string) => void", + "description": "Callback when the radio button is toggled", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onFocus", + "value": "() => void", + "description": "Callback when radio button is focussed", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onBlur", + "value": "() => void", + "description": "Callback when focus is removed", + "isOptional": true + } + ], + "value": "export interface RadioButtonProps {\n /** Indicates the ID of the element that describes the the radio button*/\n ariaDescribedBy?: string;\n /** Label for the radio button */\n label: React.ReactNode;\n /** Visually hide the label */\n labelHidden?: boolean;\n /** Radio button is selected */\n checked?: boolean;\n /** Additional text to aid in use */\n helpText?: React.ReactNode;\n /** Disable input */\n disabled?: boolean;\n /** ID for form input */\n id?: string;\n /** Name for form input */\n name?: string;\n /** Value for form input */\n value?: string;\n /** Callback when the radio button is toggled */\n onChange?(newValue: boolean, id: string): void;\n /** Callback when radio button is focussed */\n onFocus?(): void;\n /** Callback when focus is removed */\n onBlur?(): void;\n}" + } + }, + "BaseProps": { + "polaris-react/src/components/ResourceItem/ResourceItem.tsx": { + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "name": "BaseProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden text for screen readers used for item link", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "Individual item name used by various text labels", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", "syntaxKind": "PropertySignature", "name": "ariaControls", "value": "string", @@ -16782,111 +16895,6 @@ "value": "interface PropsFromWrapper {\n context: React.ContextType;\n i18n: ReturnType;\n}" } }, - "RadioButtonProps": { - "polaris-react/src/components/RadioButton/RadioButton.tsx": { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "name": "RadioButtonProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "PropertySignature", - "name": "ariaDescribedBy", - "value": "string", - "description": "Indicates the ID of the element that describes the the radio button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "React.ReactNode", - "description": "Label for the radio button" - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "PropertySignature", - "name": "labelHidden", - "value": "boolean", - "description": "Visually hide the label", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "PropertySignature", - "name": "checked", - "value": "boolean", - "description": "Radio button is selected", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "PropertySignature", - "name": "helpText", - "value": "React.ReactNode", - "description": "Additional text to aid in use", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disable input", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "ID for form input", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "Name for form input", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value for form input", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onChange", - "value": "(newValue: boolean, id: string) => void", - "description": "Callback when the radio button is toggled", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onFocus", - "value": "() => void", - "description": "Callback when radio button is focussed", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onBlur", - "value": "() => void", - "description": "Callback when focus is removed", - "isOptional": true - } - ], - "value": "export interface RadioButtonProps {\n /** Indicates the ID of the element that describes the the radio button*/\n ariaDescribedBy?: string;\n /** Label for the radio button */\n label: React.ReactNode;\n /** Visually hide the label */\n labelHidden?: boolean;\n /** Radio button is selected */\n checked?: boolean;\n /** Additional text to aid in use */\n helpText?: React.ReactNode;\n /** Disable input */\n disabled?: boolean;\n /** ID for form input */\n id?: string;\n /** Name for form input */\n name?: string;\n /** Value for form input */\n value?: string;\n /** Callback when the radio button is toggled */\n onChange?(newValue: boolean, id: string): void;\n /** Callback when radio button is focussed */\n onFocus?(): void;\n /** Callback when focus is removed */\n onBlur?(): void;\n}" - } - }, "ResourceListProps": { "polaris-react/src/components/ResourceList/ResourceList.tsx": { "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", @@ -17149,66 +17157,6 @@ "value": "export interface ScrollableProps extends React.HTMLProps {\n /** Content to display in scrollable area */\n children?: React.ReactNode;\n /** Scroll content vertically\n * @default true\n * */\n vertical?: boolean;\n /** Scroll content horizontally\n * @default true\n * */\n horizontal?: boolean;\n /** Add a shadow when content is scrollable */\n shadow?: boolean;\n /** Slightly hints content upon mounting when scrollable */\n hint?: boolean;\n /** Adds a tabIndex to scrollable when children are not focusable */\n focusable?: boolean;\n /** Called when scrolled to the bottom of the scroll area */\n onScrolledToBottom?(): void;\n}" } }, - "SettingActionProps": { - "polaris-react/src/components/SettingAction/SettingAction.tsx": { - "filePath": "polaris-react/src/components/SettingAction/SettingAction.tsx", - "name": "SettingActionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/SettingAction/SettingAction.tsx", - "syntaxKind": "PropertySignature", - "name": "action", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/SettingAction/SettingAction.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "export interface SettingActionProps {\n action?: React.ReactNode;\n children?: React.ReactNode;\n}" - } - }, - "SettingToggleProps": { - "polaris-react/src/components/SettingToggle/SettingToggle.tsx": { - "filePath": "polaris-react/src/components/SettingToggle/SettingToggle.tsx", - "name": "SettingToggleProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/SettingToggle/SettingToggle.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Inner content of the card", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/SettingToggle/SettingToggle.tsx", - "syntaxKind": "PropertySignature", - "name": "action", - "value": "ComplexAction", - "description": "Card header actions", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/SettingToggle/SettingToggle.tsx", - "syntaxKind": "PropertySignature", - "name": "enabled", - "value": "boolean", - "description": "Sets toggle state to activated or deactivated", - "isOptional": true - } - ], - "value": "export interface SettingToggleProps {\n /** Inner content of the card */\n children?: React.ReactNode;\n /** Card header actions */\n action?: ComplexAction;\n /** Sets toggle state to activated or deactivated */\n enabled?: boolean;\n}" - } - }, "StrictOption": { "polaris-react/src/components/Select/Select.tsx": { "filePath": "polaris-react/src/components/Select/Select.tsx", @@ -17491,10 +17439,70 @@ "value": "export interface SelectProps {\n /** List of options or option groups to choose from */\n options?: (SelectOption | SelectGroup)[];\n /** Label for the select */\n label: React.ReactNode;\n /** Adds an action to the label */\n labelAction?: LabelledProps['action'];\n /** Visually hide the label */\n labelHidden?: boolean;\n /** Show the label to the left of the value, inside the control */\n labelInline?: boolean;\n /** Disable input */\n disabled?: boolean;\n /** Additional text to aide in use */\n helpText?: React.ReactNode;\n /** Example text to display as placeholder */\n placeholder?: string;\n /** ID for form input */\n id?: string;\n /** Name for form input */\n name?: string;\n /** Value for form input */\n value?: string;\n /** Display an error state */\n error?: Error | boolean;\n /** Callback when selection is changed */\n onChange?(selected: string, id: string): void;\n /** Callback when select is focused */\n onFocus?(): void;\n /** Callback when focus is removed */\n onBlur?(): void;\n /** Visual required indicator, add an asterisk to label */\n requiredIndicator?: boolean;\n}" } }, - "SheetProps": { - "polaris-react/src/components/Sheet/Sheet.tsx": { - "filePath": "polaris-react/src/components/Sheet/Sheet.tsx", - "name": "SheetProps", + "SettingActionProps": { + "polaris-react/src/components/SettingAction/SettingAction.tsx": { + "filePath": "polaris-react/src/components/SettingAction/SettingAction.tsx", + "name": "SettingActionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/SettingAction/SettingAction.tsx", + "syntaxKind": "PropertySignature", + "name": "action", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/SettingAction/SettingAction.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "export interface SettingActionProps {\n action?: React.ReactNode;\n children?: React.ReactNode;\n}" + } + }, + "SettingToggleProps": { + "polaris-react/src/components/SettingToggle/SettingToggle.tsx": { + "filePath": "polaris-react/src/components/SettingToggle/SettingToggle.tsx", + "name": "SettingToggleProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/SettingToggle/SettingToggle.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Inner content of the card", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/SettingToggle/SettingToggle.tsx", + "syntaxKind": "PropertySignature", + "name": "action", + "value": "ComplexAction", + "description": "Card header actions", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/SettingToggle/SettingToggle.tsx", + "syntaxKind": "PropertySignature", + "name": "enabled", + "value": "boolean", + "description": "Sets toggle state to activated or deactivated", + "isOptional": true + } + ], + "value": "export interface SettingToggleProps {\n /** Inner content of the card */\n children?: React.ReactNode;\n /** Card header actions */\n action?: ComplexAction;\n /** Sets toggle state to activated or deactivated */\n enabled?: boolean;\n}" + } + }, + "SheetProps": { + "polaris-react/src/components/Sheet/Sheet.tsx": { + "filePath": "polaris-react/src/components/Sheet/Sheet.tsx", + "name": "SheetProps", "description": "", "members": [ { @@ -17825,6 +17833,15 @@ "value": "export interface StackProps {\n /** Elements to display inside stack */\n children?: React.ReactNode;\n /** Wrap stack elements to additional rows as needed on small screens (Defaults to true) */\n wrap?: boolean;\n /** Stack the elements vertically */\n vertical?: boolean;\n /** Adjust spacing between elements */\n spacing?: Spacing;\n /** Adjust vertical alignment of elements */\n alignment?: Alignment;\n /** Adjust horizontal alignment of elements */\n distribution?: Distribution;\n}" } }, + "StickyProps": { + "polaris-react/src/components/Sticky/Sticky.tsx": { + "filePath": "polaris-react/src/components/Sticky/Sticky.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "StickyProps", + "value": "{\n /** Element outlining the fixed position boundaries */\n boundingElement?: HTMLElement | null;\n /** Offset vertical spacing from the top of the scrollable container */\n offset?: boolean;\n /** Should the element remain in a fixed position when the layout is stacked (smaller screens) */\n disableWhenStacked?: boolean;\n /** Callback run when sticky header is added or removed */\n onStickyChange?: (isSticky: boolean) => void;\n} & (\n | {children: React.ReactNode}\n | {children(isSticky: boolean): React.ReactNode}\n)", + "description": "" + } + }, "SubheadingProps": { "polaris-react/src/components/Subheading/Subheading.tsx": { "filePath": "polaris-react/src/components/Subheading/Subheading.tsx", @@ -17917,41 +17934,6 @@ "description": "" } }, - "StickyProps": { - "polaris-react/src/components/Sticky/Sticky.tsx": { - "filePath": "polaris-react/src/components/Sticky/Sticky.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "StickyProps", - "value": "{\n /** Element outlining the fixed position boundaries */\n boundingElement?: HTMLElement | null;\n /** Offset vertical spacing from the top of the scrollable container */\n offset?: boolean;\n /** Should the element remain in a fixed position when the layout is stacked (smaller screens) */\n disableWhenStacked?: boolean;\n /** Callback run when sticky header is added or removed */\n onStickyChange?: (isSticky: boolean) => void;\n} & (\n | {children: React.ReactNode}\n | {children(isSticky: boolean): React.ReactNode}\n)", - "description": "" - } - }, - "TextContainerProps": { - "polaris-react/src/components/TextContainer/TextContainer.tsx": { - "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", - "name": "TextContainerProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", - "syntaxKind": "PropertySignature", - "name": "spacing", - "value": "Spacing", - "description": "The amount of vertical spacing children will get between them", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to render in the text container.", - "isOptional": true - } - ], - "value": "export interface TextContainerProps {\n /** The amount of vertical spacing children will get between them */\n spacing?: Spacing;\n /** The content to render in the text container. */\n children?: React.ReactNode;\n}" - } - }, "Variant": { "polaris-react/src/components/Text/Text.tsx": { "filePath": "polaris-react/src/components/Text/Text.tsx", @@ -18057,79 +18039,30 @@ "value": "export interface TextProps {\n /** Adjust horizontal alignment of text */\n alignment?: Alignment;\n /** The element type */\n as: Element;\n /** Prevent text from overflowing */\n breakWord?: boolean;\n /** Text to display */\n children: ReactNode;\n /** Adjust color of text */\n color?: Color;\n /** Adjust weight of text */\n fontWeight?: FontWeight;\n /** HTML id attribute */\n id?: string;\n /** Truncate text overflow with ellipsis */\n truncate?: boolean;\n /** Typographic style of text */\n variant: Variant;\n /** Visually hide the text */\n visuallyHidden?: boolean;\n}" } }, - "Variation": { - "polaris-react/src/components/TextStyle/TextStyle.tsx": { - "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Variation", - "value": "'positive' | 'negative' | 'warning' | 'strong' | 'subdued' | 'code'", - "description": "" - } - }, - "VariationValue": { - "polaris-react/src/components/TextStyle/TextStyle.tsx": { - "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", - "syntaxKind": "EnumDeclaration", - "name": "VariationValue", - "value": "enum VariationValue {\n Positive = 'positive',\n Negative = 'negative',\n Warning = 'warning',\n Strong = 'strong',\n Subdued = 'subdued',\n Code = 'code',\n}", - "members": [ - { - "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", - "name": "Positive", - "value": "positive" - }, - { - "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", - "name": "Negative", - "value": "negative" - }, - { - "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", - "name": "Warning", - "value": "warning" - }, - { - "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", - "name": "Strong", - "value": "strong" - }, - { - "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", - "name": "Subdued", - "value": "subdued" - }, - { - "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", - "name": "Code", - "value": "code" - } - ] - } - }, - "TextStyleProps": { - "polaris-react/src/components/TextStyle/TextStyle.tsx": { - "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", - "name": "TextStyleProps", + "TextContainerProps": { + "polaris-react/src/components/TextContainer/TextContainer.tsx": { + "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", + "name": "TextContainerProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", + "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", "syntaxKind": "PropertySignature", - "name": "variation", - "value": "Variation", - "description": "Give text additional visual meaning", + "name": "spacing", + "value": "Spacing", + "description": "The amount of vertical spacing children will get between them", "isOptional": true }, { - "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", + "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", - "description": "The content that should get the intended styling", + "description": "The content to render in the text container.", "isOptional": true } ], - "value": "export interface TextStyleProps {\n /** Give text additional visual meaning */\n variation?: Variation;\n /** The content that should get the intended styling */\n children?: React.ReactNode;\n}" + "value": "export interface TextContainerProps {\n /** The amount of vertical spacing children will get between them */\n spacing?: Spacing;\n /** The content to render in the text container. */\n children?: React.ReactNode;\n}" } }, "InputMode": { @@ -18257,6 +18190,81 @@ "description": "" } }, + "Variation": { + "polaris-react/src/components/TextStyle/TextStyle.tsx": { + "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Variation", + "value": "'positive' | 'negative' | 'warning' | 'strong' | 'subdued' | 'code'", + "description": "" + } + }, + "VariationValue": { + "polaris-react/src/components/TextStyle/TextStyle.tsx": { + "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", + "syntaxKind": "EnumDeclaration", + "name": "VariationValue", + "value": "enum VariationValue {\n Positive = 'positive',\n Negative = 'negative',\n Warning = 'warning',\n Strong = 'strong',\n Subdued = 'subdued',\n Code = 'code',\n}", + "members": [ + { + "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", + "name": "Positive", + "value": "positive" + }, + { + "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", + "name": "Negative", + "value": "negative" + }, + { + "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", + "name": "Warning", + "value": "warning" + }, + { + "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", + "name": "Strong", + "value": "strong" + }, + { + "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", + "name": "Subdued", + "value": "subdued" + }, + { + "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", + "name": "Code", + "value": "code" + } + ] + } + }, + "TextStyleProps": { + "polaris-react/src/components/TextStyle/TextStyle.tsx": { + "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", + "name": "TextStyleProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", + "syntaxKind": "PropertySignature", + "name": "variation", + "value": "Variation", + "description": "Give text additional visual meaning", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The content that should get the intended styling", + "isOptional": true + } + ], + "value": "export interface TextStyleProps {\n /** Give text additional visual meaning */\n variation?: Variation;\n /** The content that should get the intended styling */\n children?: React.ReactNode;\n}" + } + }, "ThumbnailProps": { "polaris-react/src/components/Thumbnail/Thumbnail.tsx": { "filePath": "polaris-react/src/components/Thumbnail/Thumbnail.tsx", @@ -18737,74 +18745,6 @@ "value": "export interface UnstyledButtonProps extends BaseButton {\n /** The content to display inside the button */\n children?: React.ReactNode;\n /** A custom class name to apply styles to button */\n className?: string;\n [key: string]: any;\n}" } }, - "VideoThumbnailProps": { - "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx": { - "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", - "name": "VideoThumbnailProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", - "syntaxKind": "PropertySignature", - "name": "thumbnailUrl", - "value": "string", - "description": "URL source for thumbnail image." - }, - { - "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", - "syntaxKind": "PropertySignature", - "name": "videoLength", - "value": "number", - "description": "Length of video in seconds.", - "isOptional": true, - "defaultValue": "0" - }, - { - "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", - "syntaxKind": "PropertySignature", - "name": "videoProgress", - "value": "number", - "description": "Video progress in seconds. Displays a progress bar at the bottom of the thumbnail. Only renders when videoLength is also set.", - "isOptional": true, - "defaultValue": "0" - }, - { - "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", - "syntaxKind": "PropertySignature", - "name": "showVideoProgress", - "value": "boolean", - "description": "Indicate whether to allow video progress to be displayed", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Custom ARIA label for play button.", - "isOptional": true, - "defaultValue": "'Play video of length {human readable duration}'" - }, - { - "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "Callback on click or keypress of thumbnail. Use to trigger render of the video player in your chosen format, for example within a modal or fullscreen container." - }, - { - "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", - "syntaxKind": "MethodSignature", - "name": "onBeforeStartPlaying", - "value": "() => void", - "description": "Callback on mouse enter, focus, or touch start of thumbnail. Use to trigger video preload.", - "isOptional": true - } - ], - "value": "export interface VideoThumbnailProps {\n /** URL source for thumbnail image. */\n thumbnailUrl: string;\n /**\n * Length of video in seconds.\n * @default 0\n */\n videoLength?: number;\n /**\n * Video progress in seconds. Displays a progress bar at the bottom of the thumbnail. Only renders when videoLength is also set.\n * @default 0\n */\n videoProgress?: number;\n /**\n * Indicate whether to allow video progress to be displayed\n * @default false\n */\n showVideoProgress?: boolean;\n /** Custom ARIA label for play button.\n * @default 'Play video of length {human readable duration}'\n */\n accessibilityLabel?: string;\n /** Callback on click or keypress of thumbnail. Use to trigger render of the video player in your chosen format, for example within a modal or fullscreen container. */\n onClick(): void;\n /** Callback on mouse enter, focus, or touch start of thumbnail. Use to trigger video preload. */\n onBeforeStartPlaying?(): void;\n}" - } - }, "UnstyledLinkProps": { "polaris-react/src/components/UnstyledLink/UnstyledLink.tsx": { "filePath": "polaris-react/src/components/UnstyledLink/UnstyledLink.tsx", @@ -21722,6 +21662,74 @@ "value": "export interface UnstyledLinkProps extends LinkLikeComponentProps {}" } }, + "VideoThumbnailProps": { + "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx": { + "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", + "name": "VideoThumbnailProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", + "syntaxKind": "PropertySignature", + "name": "thumbnailUrl", + "value": "string", + "description": "URL source for thumbnail image." + }, + { + "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", + "syntaxKind": "PropertySignature", + "name": "videoLength", + "value": "number", + "description": "Length of video in seconds.", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", + "syntaxKind": "PropertySignature", + "name": "videoProgress", + "value": "number", + "description": "Video progress in seconds. Displays a progress bar at the bottom of the thumbnail. Only renders when videoLength is also set.", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", + "syntaxKind": "PropertySignature", + "name": "showVideoProgress", + "value": "boolean", + "description": "Indicate whether to allow video progress to be displayed", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "Custom ARIA label for play button.", + "isOptional": true, + "defaultValue": "'Play video of length {human readable duration}'" + }, + { + "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "Callback on click or keypress of thumbnail. Use to trigger render of the video player in your chosen format, for example within a modal or fullscreen container." + }, + { + "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", + "syntaxKind": "MethodSignature", + "name": "onBeforeStartPlaying", + "value": "() => void", + "description": "Callback on mouse enter, focus, or touch start of thumbnail. Use to trigger video preload.", + "isOptional": true + } + ], + "value": "export interface VideoThumbnailProps {\n /** URL source for thumbnail image. */\n thumbnailUrl: string;\n /**\n * Length of video in seconds.\n * @default 0\n */\n videoLength?: number;\n /**\n * Video progress in seconds. Displays a progress bar at the bottom of the thumbnail. Only renders when videoLength is also set.\n * @default 0\n */\n videoProgress?: number;\n /**\n * Indicate whether to allow video progress to be displayed\n * @default false\n */\n showVideoProgress?: boolean;\n /** Custom ARIA label for play button.\n * @default 'Play video of length {human readable duration}'\n */\n accessibilityLabel?: string;\n /** Callback on click or keypress of thumbnail. Use to trigger render of the video player in your chosen format, for example within a modal or fullscreen container. */\n onClick(): void;\n /** Callback on mouse enter, focus, or touch start of thumbnail. Use to trigger video preload. */\n onBeforeStartPlaying?(): void;\n}" + } + }, "VisuallyHiddenProps": { "polaris-react/src/components/VisuallyHidden/VisuallyHidden.tsx": { "filePath": "polaris-react/src/components/VisuallyHidden/VisuallyHidden.tsx", @@ -22104,912 +22112,902 @@ "value": "export interface MenuGroupProps extends MenuGroupDescriptor {\n /** Visually hidden menu description for screen readers */\n accessibilityLabel?: string;\n /** Whether or not the menu is open */\n active?: boolean;\n /** Callback when the menu is clicked */\n onClick?(openActions: () => void): void;\n /** Callback for opening the MenuGroup by title */\n onOpen(title: string): void;\n /** Callback for closing the MenuGroup by title */\n onClose(title: string): void;\n /** Callback for getting the offsetWidth of the MenuGroup */\n getOffsetWidth?(width: number): void;\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n}" } }, - "SecondaryAction": { - "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "name": "SecondaryAction", + "ItemProps": { + "polaris-react/src/components/ActionList/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/ActionList/components/Item/Item.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ItemProps", + "value": "ActionListItemDescriptor", + "description": "" + }, + "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx", + "name": "ItemProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "helpText", + "name": "button", + "value": "React.ReactElement", + "description": "" + } + ], + "value": "export interface ItemProps {\n button: React.ReactElement;\n}" + }, + "polaris-react/src/components/Connected/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "position", + "value": "ItemPosition", + "description": "Position of the item" + }, + { + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Item content", + "isOptional": true + } + ], + "value": "export interface ItemProps {\n /** Position of the item */\n position: ItemPosition;\n /** Item content */\n children?: React.ReactNode;\n}" + }, + "polaris-react/src/components/FormLayout/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "children", "value": "React.ReactNode", "description": "", "isOptional": true - }, + } + ], + "value": "export interface ItemProps {\n children?: React.ReactNode;\n}" + }, + "polaris-react/src/components/List/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onAction", - "value": "() => void", + "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Content to display inside the item", + "isOptional": true + } + ], + "value": "export interface ItemProps {\n /** Content to display inside the item */\n children?: React.ReactNode;\n}" + }, + "polaris-react/src/components/Navigation/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "any", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "getOffsetWidth", - "value": "(width: number) => void", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "badge", + "value": "ReactNode", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "string | string[]", - "description": "The content to display inside the button", - "isOptional": true + "name": "label", + "value": "string", + "description": "" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "primary", + "name": "disabled", "value": "boolean", - "description": "Provides extra visual weight and identifies the primary action in a set of buttons", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "destructive", - "value": "boolean", - "description": "Indicates a dangerous or potentially negative action", + "name": "accessibilityLabel", + "value": "string", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "size", - "value": "\"medium\" | \"large\" | \"slim\"", - "description": "Changes the size of the button, giving it more or less padding", - "isOptional": true, - "defaultValue": "'medium'" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "PropertySignature", - "name": "textAlign", - "value": "\"start\" | \"end\" | \"center\" | \"left\" | \"right\"", - "description": "Changes the inner text alignment of the button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "PropertySignature", - "name": "outline", + "name": "selected", "value": "boolean", - "description": "Gives the button a subtle alternative to the default button styling, appropriate for certain backdrops", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "fullWidth", + "name": "exactMatch", "value": "boolean", - "description": "Allows the button to grow to the width of its container", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "disclosure", - "value": "boolean | \"up\" | \"down\" | \"select\"", - "description": "Displays the button with a disclosure icon. Defaults to `down` when set to true", + "name": "new", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "plain", - "value": "boolean", - "description": "Renders a button that looks like a link", + "name": "subNavigationItems", + "value": "SubNavigationItem[]", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "monochrome", - "value": "boolean", - "description": "Makes `plain` and `outline` Button colors (text, borders, icons) the same as the current text color. Also adds an underline to `plain` Buttons", + "name": "secondaryAction", + "value": "SecondaryAction", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "PropertySignature", - "name": "removeUnderline", - "value": "boolean", - "description": "Removes underline from button text (including on interaction) when `monochrome` and `plain` are true", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "Icon to display to the left of the button content", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "MethodSignature", + "name": "onToggleExpandedState", + "value": "() => void", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "connectedDisclosure", - "value": "ConnectedDisclosure", - "description": "Disclosure button connected right of the button. Toggles a popover action list.", + "name": "expanded", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "dataPrimaryLink", + "name": "shouldResizeIcon", "value": "boolean", - "description": "Indicates whether or not the button is the primary navigation link when rendered inside of an `IndexTable.Row`", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the button", + "name": "truncateText", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", "name": "url", "value": "string", - "description": "A destination to link to, rendered in the href attribute of a link", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "external", + "name": "matches", "value": "boolean", - "description": "Forces url to open in a new tab", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "download", - "value": "string | boolean", - "description": "Tells the browser to download the url instead of opening it. Provides a hint for the downloaded filename if it is a string value", + "name": "matchPaths", + "value": "string[]", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "submit", - "value": "boolean", - "description": "Allows the button to submit a form", + "name": "excludePaths", + "value": "string[]", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", + "name": "external", "value": "boolean", - "description": "Disables the button, disallowing merchant interaction", + "description": "", "isOptional": true - }, + } + ], + "value": "export interface ItemProps extends ItemURLDetails {\n icon?: IconProps['source'];\n badge?: ReactNode;\n label: string;\n disabled?: boolean;\n accessibilityLabel?: string;\n selected?: boolean;\n exactMatch?: boolean;\n new?: boolean;\n subNavigationItems?: SubNavigationItem[];\n secondaryAction?: SecondaryAction;\n onClick?(): void;\n onToggleExpandedState?(): void;\n expanded?: boolean;\n shouldResizeIcon?: boolean;\n truncateText?: boolean;\n}" + }, + "polaris-react/src/components/Stack/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "loading", - "value": "boolean", - "description": "Replaces button text with a spinner while a background action is being performed", + "name": "children", + "value": "React.ReactNode", + "description": "Elements to display inside item", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "pressed", + "name": "fill", "value": "boolean", - "description": "Sets the button in a pressed state", + "description": "Fill the remaining horizontal space in the stack with the item", "isOptional": true - }, + } + ], + "value": "export interface ItemProps {\n /** Elements to display inside item */\n children?: React.ReactNode;\n /** Fill the remaining horizontal space in the stack with the item */\n fill?: boolean;\n /**\n * @default false\n */\n}" + }, + "polaris-react/src/components/Tabs/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", + "name": "id", "value": "string", - "description": "Visually hidden text for screen readers", - "isOptional": true + "description": "" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "role", - "value": "string", - "description": "A valid WAI-ARIA role to define the semantic value of this element", - "isOptional": true + "name": "focused", + "value": "boolean", + "description": "" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "ariaControls", + "name": "panelID", "value": "string", - "description": "Id of the element the button controls", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "ariaExpanded", - "value": "boolean", - "description": "Tells screen reader the controlled element is expanded", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "ariaDescribedBy", + "name": "url", "value": "string", - "description": "Indicates the ID of the element that describes the button", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "ariaChecked", - "value": "\"false\" | \"true\"", - "description": "Indicates the current checked state of the button when acting as a toggle or switch", + "name": "accessibilityLabel", + "value": "string", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "MethodSignature", "name": "onClick", "value": "() => void", - "description": "Callback when clicked", + "description": "", "isOptional": true - }, + } + ], + "value": "export interface ItemProps {\n id: string;\n focused: boolean;\n panelID?: string;\n children?: React.ReactNode;\n url?: string;\n accessibilityLabel?: string;\n onClick?(): void;\n}" + }, + "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "interface ItemProps {\n children?: React.ReactNode;\n}" + } + }, + "SecondaryAction": { + "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "name": "SecondaryAction", + "description": "", + "members": [ { "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onFocus", - "value": "() => void", - "description": "Callback when button becomes focussed", + "syntaxKind": "PropertySignature", + "name": "helpText", + "value": "React.ReactNode", + "description": "", "isOptional": true }, { "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "MethodSignature", - "name": "onBlur", + "name": "onAction", "value": "() => void", - "description": "Callback when focus leaves button", + "description": "", "isOptional": true }, { "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "MethodSignature", - "name": "onKeyPress", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keypress event is registered on the button", + "name": "getOffsetWidth", + "value": "(width: number) => void", + "description": "", "isOptional": true }, { "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyUp", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keyup event is registered on the button", - "isOptional": true + "syntaxKind": "PropertySignature", + "name": "children", + "value": "string | string[]", + "description": "The content to display inside the button", + "isOptional": true }, { "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyDown", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keydown event is registered on the button", + "syntaxKind": "PropertySignature", + "name": "primary", + "value": "boolean", + "description": "Provides extra visual weight and identifies the primary action in a set of buttons", "isOptional": true }, { "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onMouseEnter", - "value": "() => void", - "description": "Callback when mouse enter", + "syntaxKind": "PropertySignature", + "name": "destructive", + "value": "boolean", + "description": "Indicates a dangerous or potentially negative action", "isOptional": true }, { "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onTouchStart", - "value": "() => void", - "description": "Callback when element is touched", - "isOptional": true + "syntaxKind": "PropertySignature", + "name": "size", + "value": "\"medium\" | \"large\" | \"slim\"", + "description": "Changes the size of the button, giving it more or less padding", + "isOptional": true, + "defaultValue": "'medium'" }, { "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onPointerDown", - "value": "() => void", - "description": "Callback when pointerdown event is being triggered", - "isOptional": true - } - ], - "value": "interface SecondaryAction extends ButtonProps {\n helpText?: React.ReactNode;\n onAction?(): void;\n getOffsetWidth?(width: number): void;\n}" - }, - "polaris-react/src/components/Navigation/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "SecondaryAction", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "" + "name": "textAlign", + "value": "\"start\" | \"end\" | \"center\" | \"left\" | \"right\"", + "description": "Changes the inner text alignment of the button", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "" + "name": "outline", + "value": "boolean", + "description": "Gives the button a subtle alternative to the default button styling, appropriate for certain backdrops", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "" + "name": "fullWidth", + "value": "boolean", + "description": "Allows the button to grow to the width of its container", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "PropertySignature", + "name": "disclosure", + "value": "boolean | \"up\" | \"down\" | \"select\"", + "description": "Displays the button with a disclosure icon. Defaults to `down` when set to true", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "tooltip", - "value": "TooltipProps", - "description": "", + "name": "plain", + "value": "boolean", + "description": "Renders a button that looks like a link", "isOptional": true - } - ], - "value": "interface SecondaryAction {\n url: string;\n accessibilityLabel: string;\n icon: IconProps['source'];\n onClick?(): void;\n tooltip?: TooltipProps;\n}" - } - }, - "RollupActionsProps": { - "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "name": "RollupActionsProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Accessibilty label", + "name": "monochrome", + "value": "boolean", + "description": "Makes `plain` and `outline` Button colors (text, borders, icons) the same as the current text color. Also adds an underline to `plain` Buttons", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "items", - "value": "ActionListItemDescriptor[]", - "description": "Collection of actions for the list", + "name": "removeUnderline", + "value": "boolean", + "description": "Removes underline from button text (including on interaction) when `monochrome` and `plain` are true", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "sections", - "value": "ActionListSection[]", - "description": "Collection of sectioned action items", + "name": "icon", + "value": "any", + "description": "Icon to display to the left of the button content", "isOptional": true - } - ], - "value": "export interface RollupActionsProps {\n /** Accessibilty label */\n accessibilityLabel?: string;\n /** Collection of actions for the list */\n items?: ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: ActionListSection[];\n}" - } - }, - "SectionProps": { - "polaris-react/src/components/ActionList/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "section", - "value": "ActionListSection", - "description": "Section of action items" + "name": "connectedDisclosure", + "value": "ConnectedDisclosure", + "description": "Disclosure button connected right of the button. Toggles a popover action list.", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "hasMultipleSections", + "name": "dataPrimaryLink", "value": "boolean", - "description": "Should there be multiple sections" + "description": "Indicates whether or not the button is the primary navigation link when rendered inside of an `IndexTable.Row`", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "actionRole", + "name": "id", "value": "string", - "description": "Defines a specific role attribute for each action in the list", + "description": "A unique identifier for the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any item is clicked or keypressed", + "name": "url", + "value": "string", + "description": "A destination to link to, rendered in the href attribute of a link", "isOptional": true - } - ], - "value": "export interface SectionProps {\n /** Section of action items */\n section: ActionListSection;\n /** Should there be multiple sections */\n hasMultipleSections: boolean;\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'option' | 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" - }, - "polaris-react/src/components/Layout/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "name": "external", + "value": "boolean", + "description": "Forces url to open in a new tab", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "secondary", - "value": "boolean", - "description": "", + "name": "download", + "value": "string | boolean", + "description": "Tells the browser to download the url instead of opening it. Provides a hint for the downloaded filename if it is a string value", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "fullWidth", + "name": "submit", "value": "boolean", - "description": "", + "description": "Allows the button to submit a form", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "oneHalf", + "name": "disabled", "value": "boolean", - "description": "", + "description": "Disables the button, disallowing merchant interaction", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "oneThird", + "name": "loading", "value": "boolean", - "description": "", + "description": "Replaces button text with a spinner while a background action is being performed", "isOptional": true - } - ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\n secondary?: boolean;\n fullWidth?: boolean;\n oneHalf?: boolean;\n oneThird?: boolean;\n}" - }, - "polaris-react/src/components/Listbox/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "divider", + "name": "pressed", "value": "boolean", - "description": "", + "description": "Sets the button in a pressed state", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", - "description": "", + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden text for screen readers", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "title", - "value": "ReactNode", - "description": "" - } - ], - "value": "interface SectionProps {\n divider?: boolean;\n children?: ReactNode;\n title: ReactNode;\n}" - }, - "polaris-react/src/components/Modal/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ + "name": "role", + "value": "string", + "description": "A valid WAI-ARIA role to define the semantic value of this element", + "isOptional": true + }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "name": "ariaControls", + "value": "string", + "description": "Id of the element the button controls", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "flush", + "name": "ariaExpanded", "value": "boolean", - "description": "", + "description": "Tells screen reader the controlled element is expanded", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "subdued", - "value": "boolean", - "description": "", + "name": "ariaDescribedBy", + "value": "string", + "description": "Indicates the ID of the element that describes the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "titleHidden", - "value": "boolean", - "description": "", + "name": "ariaChecked", + "value": "\"false\" | \"true\"", + "description": "Indicates the current checked state of the button when acting as a toggle or switch", "isOptional": true - } - ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\n flush?: boolean;\n subdued?: boolean;\n titleHidden?: boolean;\n}" - }, - "polaris-react/src/components/Navigation/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "items", - "value": "ItemProps[]", - "description": "" + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "Callback when clicked", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onFocus", + "value": "() => void", + "description": "Callback when button becomes focussed", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onBlur", + "value": "() => void", + "description": "Callback when focus leaves button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "fill", - "value": "boolean", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyPress", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keypress event is registered on the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "rollup", - "value": "{ after: number; view: string; hide: string; activePath: string; }", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyUp", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keyup event is registered on the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "action", - "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyDown", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keydown event is registered on the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "separator", - "value": "boolean", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onMouseEnter", + "value": "() => void", + "description": "Callback when mouse enter", "isOptional": true - } - ], - "value": "export interface SectionProps {\n items: ItemProps[];\n icon?: IconProps['source'];\n title?: string;\n fill?: boolean;\n rollup?: {\n after: number;\n view: string;\n hide: string;\n activePath: string;\n };\n action?: {\n icon: IconProps['source'];\n accessibilityLabel: string;\n onClick(): void;\n tooltip?: TooltipProps;\n };\n separator?: boolean;\n}" - }, - "polaris-react/src/components/Popover/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onTouchStart", + "value": "() => void", + "description": "Callback when element is touched", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onPointerDown", + "value": "() => void", + "description": "Callback when pointerdown event is being triggered", "isOptional": true } ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\n}" - } - }, - "MappedAction": { - "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx": { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "name": "MappedAction", + "value": "interface SecondaryAction extends ButtonProps {\n helpText?: React.ReactNode;\n onAction?(): void;\n getOffsetWidth?(width: number): void;\n}" + }, + "polaris-react/src/components/Navigation/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "name": "SecondaryAction", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "wrapOverflow", - "value": "boolean", - "description": "", - "isOptional": true + "name": "url", + "value": "string", + "description": "" }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "Visually hidden text for screen readers", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "badge", - "value": "{ status: \"new\"; content: string; }", - "description": "", - "isOptional": true, - "deprecationMessage": "Badge component" - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "helpText", - "value": "React.ReactNode", - "description": "Additional hint text to display with item", - "isOptional": true + "description": "" }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", "name": "icon", "value": "any", - "description": "", - "isOptional": true, - "deprecationMessage": "Source of the icon" + "description": "" }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "string", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", "description": "", - "isOptional": true, - "deprecationMessage": "Image source" - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "prefix", - "value": "React.ReactNode", - "description": "Prefix source", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "suffix", - "value": "React.ReactNode", - "description": "Suffix source", + "name": "tooltip", + "value": "TooltipProps", + "description": "", "isOptional": true - }, + } + ], + "value": "interface SecondaryAction {\n url: string;\n accessibilityLabel: string;\n icon: IconProps['source'];\n onClick?(): void;\n tooltip?: TooltipProps;\n}" + } + }, + "SectionProps": { + "polaris-react/src/components/ActionList/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "ellipsis", - "value": "boolean", - "description": "Add an ellipsis suffix to action content", - "isOptional": true + "name": "section", + "value": "ActionListSection", + "description": "Section of action items" }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "active", + "name": "hasMultipleSections", "value": "boolean", - "description": "Whether the action is active or not", - "isOptional": true + "description": "Should there be multiple sections" }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "role", + "name": "actionRole", "value": "string", - "description": "Defines a role for the action", + "description": "Defines a specific role attribute for each action in the list", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Whether or not the action is disabled", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any item is clicked or keypressed", "isOptional": true - }, + } + ], + "value": "export interface SectionProps {\n /** Section of action items */\n section: ActionListSection;\n /** Should there be multiple sections */\n hasMultipleSections: boolean;\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'option' | 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" + }, + "polaris-react/src/components/Layout/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the action", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "content", - "value": "string", - "description": "Content the action displays", + "name": "secondary", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "A destination to link to, rendered in the action", + "name": "fullWidth", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "external", + "name": "oneHalf", "value": "boolean", - "description": "Forces url to open in a new tab", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onAction", - "value": "() => void", - "description": "Callback when an action takes place", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onMouseEnter", - "value": "() => void", - "description": "Callback when mouse enter", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onTouchStart", - "value": "() => void", - "description": "Callback when element is touched", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "destructive", + "name": "oneThird", "value": "boolean", - "description": "Destructive action", + "description": "", "isOptional": true } ], - "value": "interface MappedAction extends ActionListItemDescriptor {\n wrapOverflow?: boolean;\n}" - } - }, - "ItemProps": { - "polaris-react/src/components/ActionList/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/ActionList/components/Item/Item.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "ItemProps", - "value": "ActionListItemDescriptor", - "description": "" - }, - "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "button", - "value": "React.ReactElement", - "description": "" - } - ], - "value": "export interface ItemProps {\n button: React.ReactElement;\n}" + "value": "export interface SectionProps {\n children?: React.ReactNode;\n secondary?: boolean;\n fullWidth?: boolean;\n oneHalf?: boolean;\n oneThird?: boolean;\n}" }, - "polaris-react/src/components/Connected/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", - "name": "ItemProps", + "polaris-react/src/components/Listbox/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "name": "SectionProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "position", - "value": "ItemPosition", - "description": "Position of the item" - }, - { - "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Item content", - "isOptional": true - } - ], - "value": "export interface ItemProps {\n /** Position of the item */\n position: ItemPosition;\n /** Item content */\n children?: React.ReactNode;\n}" - }, - "polaris-react/src/components/FormLayout/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ + "name": "divider", + "value": "boolean", + "description": "", + "isOptional": true + }, { - "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", "syntaxKind": "PropertySignature", "name": "children", - "value": "React.ReactNode", + "value": "ReactNode", "description": "", "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "ReactNode", + "description": "" } ], - "value": "export interface ItemProps {\n children?: React.ReactNode;\n}" + "value": "interface SectionProps {\n divider?: boolean;\n children?: ReactNode;\n title: ReactNode;\n}" }, - "polaris-react/src/components/List/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", - "name": "ItemProps", + "polaris-react/src/components/Modal/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "name": "SectionProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", - "description": "Content to display inside the item", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "flush", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "subdued", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "titleHidden", + "value": "boolean", + "description": "", "isOptional": true } ], - "value": "export interface ItemProps {\n /** Content to display inside the item */\n children?: React.ReactNode;\n}" + "value": "export interface SectionProps {\n children?: React.ReactNode;\n flush?: boolean;\n subdued?: boolean;\n titleHidden?: boolean;\n}" }, - "polaris-react/src/components/Navigation/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "ItemProps", + "polaris-react/src/components/Navigation/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "name": "SectionProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "items", + "value": "ItemProps[]", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", "name": "icon", "value": "any", @@ -23017,269 +23015,313 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "badge", - "value": "ReactNode", + "name": "title", + "value": "string", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "" + "name": "fill", + "value": "boolean", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", + "name": "rollup", + "value": "{ after: number; view: string; hide: string; activePath: string; }", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", + "name": "action", + "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "selected", + "name": "separator", "value": "boolean", "description": "", "isOptional": true - }, + } + ], + "value": "export interface SectionProps {\n items: ItemProps[];\n icon?: IconProps['source'];\n title?: string;\n fill?: boolean;\n rollup?: {\n after: number;\n view: string;\n hide: string;\n activePath: string;\n };\n action?: {\n icon: IconProps['source'];\n accessibilityLabel: string;\n onClick(): void;\n tooltip?: TooltipProps;\n };\n separator?: boolean;\n}" + }, + "polaris-react/src/components/Popover/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "exactMatch", - "value": "boolean", + "name": "children", + "value": "React.ReactNode", "description": "", "isOptional": true - }, + } + ], + "value": "export interface SectionProps {\n children?: React.ReactNode;\n}" + } + }, + "MappedAction": { + "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx": { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "name": "MappedAction", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "new", + "name": "wrapOverflow", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "subNavigationItems", - "value": "SubNavigationItem[]", - "description": "", + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden text for screen readers", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "secondaryAction", - "value": "SecondaryAction", + "name": "badge", + "value": "{ status: \"new\"; content: string; }", "description": "", + "isOptional": true, + "deprecationMessage": "Badge component" + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "helpText", + "value": "React.ReactNode", + "description": "Additional hint text to display with item", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "any", "description": "", - "isOptional": true + "isOptional": true, + "deprecationMessage": "Source of the icon" }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onToggleExpandedState", - "value": "() => void", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "image", + "value": "string", "description": "", + "isOptional": true, + "deprecationMessage": "Image source" + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "React.ReactNode", + "description": "Prefix source", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "expanded", - "value": "boolean", - "description": "", + "name": "suffix", + "value": "React.ReactNode", + "description": "Suffix source", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "shouldResizeIcon", + "name": "ellipsis", "value": "boolean", - "description": "", + "description": "Add an ellipsis suffix to action content", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "truncateText", + "name": "active", "value": "boolean", - "description": "", + "description": "Whether the action is active or not", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "url", + "name": "role", "value": "string", - "description": "", + "description": "Defines a role for the action", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "matches", + "name": "disabled", "value": "boolean", - "description": "", + "description": "Whether or not the action is disabled", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "matchPaths", - "value": "string[]", - "description": "", + "name": "id", + "value": "string", + "description": "A unique identifier for the action", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "excludePaths", - "value": "string[]", - "description": "", + "name": "content", + "value": "string", + "description": "Content the action displays", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "url", + "value": "string", + "description": "A destination to link to, rendered in the action", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", "name": "external", "value": "boolean", - "description": "", + "description": "Forces url to open in a new tab", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onAction", + "value": "() => void", + "description": "Callback when an action takes place", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onMouseEnter", + "value": "() => void", + "description": "Callback when mouse enter", "isOptional": true - } - ], - "value": "export interface ItemProps extends ItemURLDetails {\n icon?: IconProps['source'];\n badge?: ReactNode;\n label: string;\n disabled?: boolean;\n accessibilityLabel?: string;\n selected?: boolean;\n exactMatch?: boolean;\n new?: boolean;\n subNavigationItems?: SubNavigationItem[];\n secondaryAction?: SecondaryAction;\n onClick?(): void;\n onToggleExpandedState?(): void;\n expanded?: boolean;\n shouldResizeIcon?: boolean;\n truncateText?: boolean;\n}" - }, - "polaris-react/src/components/Stack/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Elements to display inside item", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onTouchStart", + "value": "() => void", + "description": "Callback when element is touched", "isOptional": true }, { - "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "fill", + "name": "destructive", "value": "boolean", - "description": "Fill the remaining horizontal space in the stack with the item", + "description": "Destructive action", "isOptional": true } ], - "value": "export interface ItemProps {\n /** Elements to display inside item */\n children?: React.ReactNode;\n /** Fill the remaining horizontal space in the stack with the item */\n fill?: boolean;\n /**\n * @default false\n */\n}" - }, - "polaris-react/src/components/Tabs/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "name": "ItemProps", + "value": "interface MappedAction extends ActionListItemDescriptor {\n wrapOverflow?: boolean;\n}" + } + }, + "MappedOption": { + "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx": { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "MappedOption", + "value": "ArrayElement & {\n selected: boolean;\n singleSelection: boolean;\n}", + "description": "" + } + }, + "RollupActionsProps": { + "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "name": "RollupActionsProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", "syntaxKind": "PropertySignature", - "name": "id", + "name": "accessibilityLabel", "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "focused", - "value": "boolean", - "description": "" + "description": "Accessibilty label", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", "syntaxKind": "PropertySignature", - "name": "panelID", - "value": "string", - "description": "", + "name": "items", + "value": "ActionListItemDescriptor[]", + "description": "Collection of actions for the list", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "name": "sections", + "value": "ActionListSection[]", + "description": "Collection of sectioned action items", "isOptional": true - }, + } + ], + "value": "export interface RollupActionsProps {\n /** Accessibilty label */\n accessibilityLabel?: string;\n /** Collection of actions for the list */\n items?: ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: ActionListSection[];\n}" + } + }, + "PipProps": { + "polaris-react/src/components/Badge/components/Pip/Pip.tsx": { + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "name": "PipProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", + "name": "status", + "value": "Status", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", + "name": "progress", + "value": "Progress", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "", - "isOptional": true - } - ], - "value": "export interface ItemProps {\n id: string;\n focused: boolean;\n panelID?: string;\n children?: React.ReactNode;\n url?: string;\n accessibilityLabel?: string;\n onClick?(): void;\n}" - }, - "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", + "name": "accessibilityLabelOverride", + "value": "string", "description": "", "isOptional": true } ], - "value": "interface ItemProps {\n children?: React.ReactNode;\n}" - } - }, - "BulkActionButtonProps": { - "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx": { - "filePath": "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "BulkActionButtonProps", - "value": "{\n disclosure?: boolean;\n indicator?: boolean;\n handleMeasurement?(width: number): void;\n} & DisableableAction", - "description": "" + "value": "export interface PipProps {\n status?: Status;\n progress?: Progress;\n accessibilityLabelOverride?: string;\n}" } }, "BulkActionsMenuProps": { @@ -23369,81 +23411,15 @@ "value": "export interface BulkActionsMenuProps extends MenuGroupDescriptor {\n isNewBadgeInBadgeActions: boolean;\n}" } }, - "MappedOption": { - "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx": { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx", + "BulkActionButtonProps": { + "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx": { + "filePath": "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "MappedOption", - "value": "ArrayElement & {\n selected: boolean;\n singleSelection: boolean;\n}", + "name": "BulkActionButtonProps", + "value": "{\n disclosure?: boolean;\n indicator?: boolean;\n handleMeasurement?(width: number): void;\n} & DisableableAction", "description": "" } }, - "CardSectionProps": { - "polaris-react/src/components/Card/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", - "name": "CardSectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "subdued", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "flush", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "fullWidth", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "hideOnPrint", - "value": "boolean", - "description": "Allow the card to be hidden when printing", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "actions", - "value": "ComplexAction[]", - "description": "", - "isOptional": true - } - ], - "value": "export interface CardSectionProps {\n title?: React.ReactNode;\n children?: React.ReactNode;\n subdued?: boolean;\n flush?: boolean;\n fullWidth?: boolean;\n /** Allow the card to be hidden when printing */\n hideOnPrint?: boolean;\n actions?: ComplexAction[];\n}" - } - }, "CardHeaderProps": { "polaris-react/src/components/Card/components/Header/Header.tsx": { "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", @@ -23551,79 +23527,79 @@ "value": "export interface HuePickerProps {\n hue: number;\n onChange(hue: number): void;\n}" } }, - "SlidableProps": { - "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx": { - "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", - "name": "SlidableProps", + "CardSectionProps": { + "polaris-react/src/components/Card/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", + "name": "CardSectionProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", + "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "draggerX", - "value": "number", + "name": "title", + "value": "React.ReactNode", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", + "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "draggerY", - "value": "number", + "name": "children", + "value": "React.ReactNode", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", - "syntaxKind": "MethodSignature", - "name": "onChange", - "value": "(position: Position) => void", - "description": "" - }, - { - "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", - "syntaxKind": "MethodSignature", - "name": "onDraggerHeight", - "value": "(height: number) => void", - "description": "", - "isOptional": true - } - ], - "value": "export interface SlidableProps {\n draggerX?: number;\n draggerY?: number;\n onChange(position: Position): void;\n onDraggerHeight?(height: number): void;\n}" - } - }, - "PipProps": { - "polaris-react/src/components/Badge/components/Pip/Pip.tsx": { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", - "name": "PipProps", - "description": "", - "members": [ + "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "subdued", + "value": "boolean", + "description": "", + "isOptional": true + }, { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "status", - "value": "Status", + "name": "flush", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "progress", - "value": "Progress", + "name": "fullWidth", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabelOverride", - "value": "string", + "name": "hideOnPrint", + "value": "boolean", + "description": "Allow the card to be hidden when printing", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "actions", + "value": "ComplexAction[]", "description": "", "isOptional": true } ], - "value": "export interface PipProps {\n status?: Status;\n progress?: Progress;\n accessibilityLabelOverride?: string;\n}" + "value": "export interface CardSectionProps {\n title?: React.ReactNode;\n children?: React.ReactNode;\n subdued?: boolean;\n flush?: boolean;\n fullWidth?: boolean;\n /** Allow the card to be hidden when printing */\n hideOnPrint?: boolean;\n actions?: ComplexAction[];\n}" + } + }, + "ItemPosition": { + "polaris-react/src/components/Connected/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ItemPosition", + "value": "'left' | 'right' | 'primary'", + "description": "" } }, "CellProps": { @@ -23924,326 +23900,400 @@ "value": "export interface CellProps {\n children?: ReactNode;\n className?: string;\n flush?: boolean;\n}" } }, - "ItemPosition": { - "polaris-react/src/components/Connected/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "ItemPosition", - "value": "'left' | 'right' | 'primary'", - "description": "" + "SlidableProps": { + "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx": { + "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", + "name": "SlidableProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", + "syntaxKind": "PropertySignature", + "name": "draggerX", + "value": "number", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", + "syntaxKind": "PropertySignature", + "name": "draggerY", + "value": "number", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", + "syntaxKind": "MethodSignature", + "name": "onChange", + "value": "(position: Position) => void", + "description": "" + }, + { + "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", + "syntaxKind": "MethodSignature", + "name": "onDraggerHeight", + "value": "(height: number) => void", + "description": "", + "isOptional": true + } + ], + "value": "export interface SlidableProps {\n draggerX?: number;\n draggerY?: number;\n onChange(position: Position): void;\n onDraggerHeight?(height: number): void;\n}" } }, - "MonthProps": { - "polaris-react/src/components/DatePicker/components/Month/Month.tsx": { - "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", - "name": "MonthProps", + "DayProps": { + "polaris-react/src/components/DatePicker/components/Day/Day.tsx": { + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "name": "DayProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "PropertySignature", - "name": "focusedDate", + "name": "focused", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "syntaxKind": "PropertySignature", + "name": "day", "value": "Date", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "PropertySignature", "name": "selected", - "value": "Range", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "PropertySignature", - "name": "hoverDate", - "value": "Date", + "name": "inRange", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "PropertySignature", - "name": "month", - "value": "number", - "description": "" + "name": "inHoveringRange", + "value": "boolean", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "PropertySignature", - "name": "year", - "value": "number", - "description": "" + "name": "disabled", + "value": "boolean", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "PropertySignature", - "name": "disableDatesBefore", - "value": "Date", + "name": "lastDayOfMonth", + "value": "any", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "PropertySignature", - "name": "disableDatesAfter", - "value": "Date", + "name": "isLastSelectedDay", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "PropertySignature", - "name": "disableSpecificDates", - "value": "Date[]", + "name": "isFirstSelectedDay", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "PropertySignature", - "name": "allowRange", + "name": "isHoveringRight", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "PropertySignature", - "name": "weekStartsOn", - "value": "number", - "description": "" + "name": "rangeIsDifferent", + "value": "boolean", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabelPrefixes", - "value": "[string, string]", - "description": "" + "name": "weekday", + "value": "string", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "syntaxKind": "PropertySignature", + "name": "selectedAccessibilityLabelPrefix", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "MethodSignature", - "name": "onChange", - "value": "(date: Range) => void", + "name": "onClick", + "value": "(day: Date) => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "MethodSignature", "name": "onHover", - "value": "(hoverEnd: Date) => void", + "value": "(day?: Date) => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", "syntaxKind": "MethodSignature", "name": "onFocus", - "value": "(date: Date) => void", + "value": "(day: Date) => void", "description": "", "isOptional": true } ], - "value": "export interface MonthProps {\n focusedDate?: Date;\n selected?: Range;\n hoverDate?: Date;\n month: number;\n year: number;\n disableDatesBefore?: Date;\n disableDatesAfter?: Date;\n disableSpecificDates?: Date[];\n allowRange?: boolean;\n weekStartsOn: number;\n accessibilityLabelPrefixes: [string | undefined, string];\n onChange?(date: Range): void;\n onHover?(hoverEnd: Date): void;\n onFocus?(date: Date): void;\n}" + "value": "export interface DayProps {\n focused?: boolean;\n day?: Date;\n selected?: boolean;\n inRange?: boolean;\n inHoveringRange?: boolean;\n disabled?: boolean;\n lastDayOfMonth?: any;\n isLastSelectedDay?: boolean;\n isFirstSelectedDay?: boolean;\n isHoveringRight?: boolean;\n rangeIsDifferent?: boolean;\n weekday?: string;\n selectedAccessibilityLabelPrefix?: string;\n onClick?(day: Date): void;\n onHover?(day?: Date): void;\n onFocus?(day: Date): void;\n}" } }, - "DayProps": { - "polaris-react/src/components/DatePicker/components/Day/Day.tsx": { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", - "name": "DayProps", + "WeekdayProps": { + "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx": { + "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", + "name": "WeekdayProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", "syntaxKind": "PropertySignature", - "name": "focused", - "value": "boolean", - "description": "", - "isOptional": true + "name": "label", + "value": "string", + "description": "" }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", "syntaxKind": "PropertySignature", - "name": "day", - "value": "Date", - "description": "", - "isOptional": true + "name": "title", + "value": "string", + "description": "" }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", "syntaxKind": "PropertySignature", - "name": "selected", + "name": "current", "value": "boolean", - "description": "", - "isOptional": true - }, + "description": "" + } + ], + "value": "export interface WeekdayProps {\n label: string;\n title: string;\n current: boolean;\n}" + } + }, + "MonthProps": { + "polaris-react/src/components/DatePicker/components/Month/Month.tsx": { + "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", + "name": "MonthProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", "syntaxKind": "PropertySignature", - "name": "inRange", - "value": "boolean", + "name": "focusedDate", + "value": "Date", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", "syntaxKind": "PropertySignature", - "name": "inHoveringRange", - "value": "boolean", + "name": "selected", + "value": "Range", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", + "name": "hoverDate", + "value": "Date", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", "syntaxKind": "PropertySignature", - "name": "lastDayOfMonth", - "value": "any", - "description": "", - "isOptional": true + "name": "month", + "value": "number", + "description": "" }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", "syntaxKind": "PropertySignature", - "name": "isLastSelectedDay", - "value": "boolean", + "name": "year", + "value": "number", + "description": "" + }, + { + "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", + "syntaxKind": "PropertySignature", + "name": "disableDatesBefore", + "value": "Date", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", "syntaxKind": "PropertySignature", - "name": "isFirstSelectedDay", - "value": "boolean", + "name": "disableDatesAfter", + "value": "Date", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", "syntaxKind": "PropertySignature", - "name": "isHoveringRight", - "value": "boolean", + "name": "disableSpecificDates", + "value": "Date[]", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", "syntaxKind": "PropertySignature", - "name": "rangeIsDifferent", + "name": "allowRange", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", "syntaxKind": "PropertySignature", - "name": "weekday", - "value": "string", - "description": "", - "isOptional": true + "name": "weekStartsOn", + "value": "number", + "description": "" }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", "syntaxKind": "PropertySignature", - "name": "selectedAccessibilityLabelPrefix", - "value": "string", - "description": "", - "isOptional": true + "name": "accessibilityLabelPrefixes", + "value": "[string, string]", + "description": "" }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "(day: Date) => void", + "name": "onChange", + "value": "(date: Range) => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", "syntaxKind": "MethodSignature", "name": "onHover", - "value": "(day?: Date) => void", + "value": "(hoverEnd: Date) => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", "syntaxKind": "MethodSignature", "name": "onFocus", - "value": "(day: Date) => void", + "value": "(date: Date) => void", "description": "", "isOptional": true } ], - "value": "export interface DayProps {\n focused?: boolean;\n day?: Date;\n selected?: boolean;\n inRange?: boolean;\n inHoveringRange?: boolean;\n disabled?: boolean;\n lastDayOfMonth?: any;\n isLastSelectedDay?: boolean;\n isFirstSelectedDay?: boolean;\n isHoveringRight?: boolean;\n rangeIsDifferent?: boolean;\n weekday?: string;\n selectedAccessibilityLabelPrefix?: string;\n onClick?(day: Date): void;\n onHover?(day?: Date): void;\n onFocus?(day: Date): void;\n}" + "value": "export interface MonthProps {\n focusedDate?: Date;\n selected?: Range;\n hoverDate?: Date;\n month: number;\n year: number;\n disableDatesBefore?: Date;\n disableDatesAfter?: Date;\n disableSpecificDates?: Date[];\n allowRange?: boolean;\n weekStartsOn: number;\n accessibilityLabelPrefixes: [string | undefined, string];\n onChange?(date: Range): void;\n onHover?(hoverEnd: Date): void;\n onFocus?(date: Date): void;\n}" } }, - "WeekdayProps": { - "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx": { - "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", - "name": "WeekdayProps", + "FileUploadProps": { + "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx": { + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "name": "FileUploadProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", "syntaxKind": "PropertySignature", - "name": "label", + "name": "actionTitle", "value": "string", - "description": "" + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", "syntaxKind": "PropertySignature", - "name": "title", + "name": "actionHint", "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "boolean", - "description": "" + "description": "", + "isOptional": true } ], - "value": "export interface WeekdayProps {\n label: string;\n title: string;\n current: boolean;\n}" + "value": "export interface FileUploadProps {\n actionTitle?: string;\n actionHint?: string;\n}" } }, - "FileUploadProps": { - "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx": { - "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", - "name": "FileUploadProps", + "GroupProps": { + "polaris-react/src/components/FormLayout/components/Group/Group.tsx": { + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "name": "GroupProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", "syntaxKind": "PropertySignature", - "name": "actionTitle", - "value": "string", + "name": "children", + "value": "React.ReactNode", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", "syntaxKind": "PropertySignature", - "name": "actionHint", + "name": "condensed", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "syntaxKind": "PropertySignature", + "name": "title", "value": "string", "description": "", "isOptional": true + }, + { + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "syntaxKind": "PropertySignature", + "name": "helpText", + "value": "React.ReactNode", + "description": "", + "isOptional": true } ], - "value": "export interface FileUploadProps {\n actionTitle?: string;\n actionHint?: string;\n}" + "value": "export interface GroupProps {\n children?: React.ReactNode;\n condensed?: boolean;\n title?: string;\n helpText?: React.ReactNode;\n}" } }, "PopoverableAction": { @@ -24427,48 +24477,6 @@ "value": "interface ComputedProperty {\n [key: string]: number;\n}" } }, - "GroupProps": { - "polaris-react/src/components/FormLayout/components/Group/Group.tsx": { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "name": "GroupProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "syntaxKind": "PropertySignature", - "name": "condensed", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "syntaxKind": "PropertySignature", - "name": "helpText", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "export interface GroupProps {\n children?: React.ReactNode;\n condensed?: boolean;\n title?: string;\n helpText?: React.ReactNode;\n}" - } - }, "AnimationType": { "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx": { "filePath": "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx", @@ -25165,6 +25173,39 @@ "value": "export interface TextOptionProps {\n children: React.ReactNode;\n // Whether the option is selected\n selected?: boolean;\n // Whether the option is disabled\n disabled?: boolean;\n}" } }, + "CloseButtonProps": { + "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx": { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "name": "CloseButtonProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "syntaxKind": "PropertySignature", + "name": "pressed", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "syntaxKind": "PropertySignature", + "name": "titleHidden", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "" + } + ], + "value": "export interface CloseButtonProps {\n pressed?: boolean;\n titleHidden?: boolean;\n onClick(): void;\n}" + } + }, "DialogProps": { "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx": { "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", @@ -25289,52 +25330,19 @@ "syntaxKind": "PropertySignature", "name": "secondaryActions", "value": "ComplexAction[]", - "description": "Collection of secondary actions", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to display inside modal", - "isOptional": true - } - ], - "value": "export interface FooterProps {\n /** Primary action */\n primaryAction?: ComplexAction;\n /** Collection of secondary actions */\n secondaryActions?: ComplexAction[];\n /** The content to display inside modal */\n children?: React.ReactNode;\n}" - } - }, - "CloseButtonProps": { - "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx": { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "name": "CloseButtonProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "syntaxKind": "PropertySignature", - "name": "pressed", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "syntaxKind": "PropertySignature", - "name": "titleHidden", - "value": "boolean", - "description": "", + "description": "Collection of secondary actions", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "" + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The content to display inside modal", + "isOptional": true } ], - "value": "export interface CloseButtonProps {\n pressed?: boolean;\n titleHidden?: boolean;\n onClick(): void;\n}" + "value": "export interface FooterProps {\n /** Primary action */\n primaryAction?: ComplexAction;\n /** Collection of secondary actions */\n secondaryActions?: ComplexAction[];\n /** The content to display inside modal */\n children?: React.ReactNode;\n}" } }, "ItemURLDetails": { @@ -25640,6 +25648,65 @@ "value": "interface PrimaryAction\n extends DestructableAction,\n DisableableAction,\n LoadableAction,\n IconableAction,\n TooltipAction {\n /** Provides extra visual weight and identifies the primary action in a set of buttons */\n primary?: boolean;\n}" } }, + "PaneProps": { + "polaris-react/src/components/Popover/components/Pane/Pane.tsx": { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "name": "PaneProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "fixed", + "value": "boolean", + "description": "Fix the pane to the top of the popover", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "sectioned", + "value": "boolean", + "description": "Automatically wrap children in padded sections", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The pane content", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "height", + "value": "string", + "description": "Sets a fixed height and max-height on the Scrollable", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "MethodSignature", + "name": "onScrolledToBottom", + "value": "() => void", + "description": "Callback when the bottom of the popover is reached by mouse or keyboard", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "captureOverscroll", + "value": "boolean", + "description": "Prevents page scrolling when the end of the scrollable Popover content is reached", + "isOptional": true, + "defaultValue": "false" + } + ], + "value": "export interface PaneProps {\n /** Fix the pane to the top of the popover */\n fixed?: boolean;\n /** Automatically wrap children in padded sections */\n sectioned?: boolean;\n /** The pane content */\n children?: React.ReactNode;\n /** Sets a fixed height and max-height on the Scrollable */\n height?: string;\n /** Callback when the bottom of the popover is reached by mouse or keyboard */\n onScrolledToBottom?(): void;\n /**\n * Prevents page scrolling when the end of the scrollable Popover content is reached\n * @default false\n */\n captureOverscroll?: boolean;\n}" + } + }, "PopoverCloseSource": { "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx": { "filePath": "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx", @@ -25829,65 +25896,6 @@ "value": "export interface PopoverOverlayProps {\n children?: React.ReactNode;\n fullWidth?: boolean;\n fullHeight?: boolean;\n fluidContent?: boolean;\n preferredPosition?: PositionedOverlayProps['preferredPosition'];\n preferredAlignment?: PositionedOverlayProps['preferredAlignment'];\n active: boolean;\n id: string;\n zIndexOverride?: number;\n activator: HTMLElement;\n preferInputActivator?: PositionedOverlayProps['preferInputActivator'];\n sectioned?: boolean;\n fixed?: boolean;\n hideOnPrint?: boolean;\n onClose(source: PopoverCloseSource): void;\n autofocusTarget?: PopoverAutofocusTarget;\n preventCloseOnChildOverlayClick?: boolean;\n captureOverscroll?: boolean;\n}" } }, - "PaneProps": { - "polaris-react/src/components/Popover/components/Pane/Pane.tsx": { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "name": "PaneProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "fixed", - "value": "boolean", - "description": "Fix the pane to the top of the popover", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "sectioned", - "value": "boolean", - "description": "Automatically wrap children in padded sections", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The pane content", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "height", - "value": "string", - "description": "Sets a fixed height and max-height on the Scrollable", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "MethodSignature", - "name": "onScrolledToBottom", - "value": "() => void", - "description": "Callback when the bottom of the popover is reached by mouse or keyboard", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "captureOverscroll", - "value": "boolean", - "description": "Prevents page scrolling when the end of the scrollable Popover content is reached", - "isOptional": true, - "defaultValue": "false" - } - ], - "value": "export interface PaneProps {\n /** Fix the pane to the top of the popover */\n fixed?: boolean;\n /** Automatically wrap children in padded sections */\n sectioned?: boolean;\n /** The pane content */\n children?: React.ReactNode;\n /** Sets a fixed height and max-height on the Scrollable */\n height?: string;\n /** Callback when the bottom of the popover is reached by mouse or keyboard */\n onScrolledToBottom?(): void;\n /**\n * Prevents page scrolling when the end of the scrollable Popover content is reached\n * @default false\n */\n captureOverscroll?: boolean;\n}" - } - }, "PolarisContainerProps": { "polaris-react/src/components/PortalsManager/components/PortalsContainer/PortalsContainer.tsx": { "filePath": "polaris-react/src/components/PortalsManager/components/PortalsContainer/PortalsContainer.tsx", @@ -26210,46 +26218,6 @@ "value": "export interface SingleThumbProps extends RangeSliderProps {\n value: number;\n id: string;\n min: number;\n max: number;\n step: number;\n}" } }, - "PanelProps": { - "polaris-react/src/components/Tabs/components/Panel/Panel.tsx": { - "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", - "name": "PanelProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", - "syntaxKind": "PropertySignature", - "name": "hidden", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", - "syntaxKind": "PropertySignature", - "name": "tabID", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "export interface PanelProps {\n hidden?: boolean;\n id: string;\n tabID: string;\n children?: React.ReactNode;\n}" - } - }, "TabProps": { "polaris-react/src/components/Tabs/components/Tab/Tab.tsx": { "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", @@ -26312,31 +26280,114 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "syntaxKind": "PropertySignature", + "name": "measuring", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "(id: string) => void", + "description": "", + "isOptional": true + } + ], + "value": "export interface TabProps {\n id: string;\n focused?: boolean;\n siblingTabHasFocus?: boolean;\n selected?: boolean;\n panelID?: string;\n children?: React.ReactNode;\n url?: string;\n measuring?: boolean;\n accessibilityLabel?: string;\n onClick?(id: string): void;\n}" + } + }, + "TabMeasurements": { + "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx": { + "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", + "name": "TabMeasurements", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", + "syntaxKind": "PropertySignature", + "name": "containerWidth", + "value": "number", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", + "syntaxKind": "PropertySignature", + "name": "disclosureWidth", + "value": "number", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", + "syntaxKind": "PropertySignature", + "name": "hiddenTabWidths", + "value": "number[]", + "description": "" + } + ], + "value": "interface TabMeasurements {\n containerWidth: number;\n disclosureWidth: number;\n hiddenTabWidths: number[];\n}" + } + }, + "TabMeasurerProps": { + "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx": { + "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", + "name": "TabMeasurerProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", + "syntaxKind": "PropertySignature", + "name": "tabToFocus", + "value": "number", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", + "syntaxKind": "PropertySignature", + "name": "siblingTabHasFocus", + "value": "boolean", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", + "syntaxKind": "PropertySignature", + "name": "activator", + "value": "React.ReactElement", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", "syntaxKind": "PropertySignature", - "name": "measuring", - "value": "boolean", - "description": "", - "isOptional": true + "name": "selected", + "value": "number", + "description": "" }, { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "", - "isOptional": true + "name": "tabs", + "value": "TabDescriptor[]", + "description": "" }, { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "(id: string) => void", - "description": "", - "isOptional": true + "name": "handleMeasurement", + "value": "(measurements: TabMeasurements) => void", + "description": "" } ], - "value": "export interface TabProps {\n id: string;\n focused?: boolean;\n siblingTabHasFocus?: boolean;\n selected?: boolean;\n panelID?: string;\n children?: React.ReactNode;\n url?: string;\n measuring?: boolean;\n accessibilityLabel?: string;\n onClick?(id: string): void;\n}" + "value": "export interface TabMeasurerProps {\n tabToFocus: number;\n siblingTabHasFocus: boolean;\n activator: React.ReactElement;\n selected: number;\n tabs: TabDescriptor[];\n handleMeasurement(measurements: TabMeasurements): void;\n}" } }, "ResizerProps": { @@ -26380,6 +26431,55 @@ "value": "export interface ResizerProps {\n contents?: string;\n currentHeight?: number | null;\n minimumLines?: number;\n onHeightChange(height: number): void;\n}" } }, + "HandleStepFn": { + "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx": { + "filePath": "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "HandleStepFn", + "value": "(step: number) => void", + "description": "" + } + }, + "PanelProps": { + "polaris-react/src/components/Tabs/components/Panel/Panel.tsx": { + "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", + "name": "PanelProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", + "syntaxKind": "PropertySignature", + "name": "tabID", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "export interface PanelProps {\n hidden?: boolean;\n id: string;\n tabID: string;\n children?: React.ReactNode;\n}" + } + }, "TooltipOverlayProps": { "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx": { "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", @@ -26511,15 +26611,6 @@ "value": "export interface MenuProps {\n /** Accepts an activator component that renders inside of a button that opens the menu */\n activatorContent: React.ReactNode;\n /** An array of action objects that are rendered inside of a popover triggered by this menu */\n actions: ActionListProps['sections'];\n /** Accepts a message that facilitates direct, urgent communication with the merchant through the menu */\n message?: MessageProps;\n /** A boolean property indicating whether the menu is currently open */\n open: boolean;\n /** A callback function to handle opening the menu popover */\n onOpen(): void;\n /** A callback function to handle closing the menu popover */\n onClose(): void;\n /** A callback function to handle closing the menu popover */\n onClose(): void;\n /** A string that provides the accessibility labeling */\n accessibilityLabel?: string;\n}" } }, - "HandleStepFn": { - "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx": { - "filePath": "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "HandleStepFn", - "value": "(step: number) => void", - "description": "" - } - }, "SearchProps": { "polaris-react/src/components/TopBar/components/Search/Search.tsx": { "filePath": "polaris-react/src/components/TopBar/components/Search/Search.tsx", @@ -26562,89 +26653,6 @@ "value": "export interface SearchProps {\n /** Toggles whether or not the search is visible */\n visible?: boolean;\n /** The content to display inside the search */\n children?: React.ReactNode;\n /** Whether or not the search results overlay has a visible backdrop */\n overlayVisible?: boolean;\n /** Callback when the search is dismissed */\n onDismiss?(): void;\n}" } }, - "TabMeasurements": { - "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx": { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", - "name": "TabMeasurements", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", - "syntaxKind": "PropertySignature", - "name": "containerWidth", - "value": "number", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", - "syntaxKind": "PropertySignature", - "name": "disclosureWidth", - "value": "number", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", - "syntaxKind": "PropertySignature", - "name": "hiddenTabWidths", - "value": "number[]", - "description": "" - } - ], - "value": "interface TabMeasurements {\n containerWidth: number;\n disclosureWidth: number;\n hiddenTabWidths: number[];\n}" - } - }, - "TabMeasurerProps": { - "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx": { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", - "name": "TabMeasurerProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", - "syntaxKind": "PropertySignature", - "name": "tabToFocus", - "value": "number", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", - "syntaxKind": "PropertySignature", - "name": "siblingTabHasFocus", - "value": "boolean", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", - "syntaxKind": "PropertySignature", - "name": "activator", - "value": "React.ReactElement", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", - "syntaxKind": "PropertySignature", - "name": "selected", - "value": "number", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", - "syntaxKind": "PropertySignature", - "name": "tabs", - "value": "TabDescriptor[]", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", - "syntaxKind": "MethodSignature", - "name": "handleMeasurement", - "value": "(measurements: TabMeasurements) => void", - "description": "" - } - ], - "value": "export interface TabMeasurerProps {\n tabToFocus: number;\n siblingTabHasFocus: boolean;\n activator: React.ReactElement;\n selected: number;\n tabs: TabDescriptor[];\n handleMeasurement(measurements: TabMeasurements): void;\n}" - } - }, "SearchFieldProps": { "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx": { "filePath": "polaris-react/src/components/TopBar/components/SearchField/SearchField.tsx", @@ -26866,6 +26874,48 @@ "value": "interface SecondaryProps {\n expanded: boolean;\n children?: React.ReactNode;\n id?: string;\n}" } }, + "TitleProps": { + "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx": { + "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", + "name": "TitleProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "Page title, in large type", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", + "syntaxKind": "PropertySignature", + "name": "subtitle", + "value": "string", + "description": "Page subtitle, in regular type", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", + "syntaxKind": "PropertySignature", + "name": "titleMetadata", + "value": "React.ReactNode", + "description": "Important and non-interactive status information shown immediately after the title.", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", + "syntaxKind": "PropertySignature", + "name": "compactTitle", + "value": "boolean", + "description": "Removes spacing between title and subtitle", + "isOptional": true + } + ], + "value": "export interface TitleProps {\n /** Page title, in large type */\n title?: string;\n /** Page subtitle, in regular type*/\n subtitle?: string;\n /** Important and non-interactive status information shown immediately after the title. */\n titleMetadata?: React.ReactNode;\n /** Removes spacing between title and subtitle */\n compactTitle?: boolean;\n}" + } + }, "MessageProps": { "polaris-react/src/components/TopBar/components/Menu/components/Message/Message.tsx": { "filePath": "polaris-react/src/components/TopBar/components/Menu/components/Message/Message.tsx", @@ -26911,47 +26961,5 @@ ], "value": "export interface MessageProps {\n title: string;\n description: string;\n action: {onClick(): void; content: string};\n link: {to: string; content: string};\n badge?: {content: string; status: BadgeProps['status']};\n}" } - }, - "TitleProps": { - "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx": { - "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", - "name": "TitleProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "Page title, in large type", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "Page subtitle, in regular type", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", - "syntaxKind": "PropertySignature", - "name": "titleMetadata", - "value": "React.ReactNode", - "description": "Important and non-interactive status information shown immediately after the title.", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", - "syntaxKind": "PropertySignature", - "name": "compactTitle", - "value": "boolean", - "description": "Removes spacing between title and subtitle", - "isOptional": true - } - ], - "value": "export interface TitleProps {\n /** Page title, in large type */\n title?: string;\n /** Page subtitle, in regular type*/\n subtitle?: string;\n /** Important and non-interactive status information shown immediately after the title. */\n titleMetadata?: React.ReactNode;\n /** Removes spacing between title and subtitle */\n compactTitle?: boolean;\n}" - } } } \ No newline at end of file