diff --git a/.changeset/thin-bobcats-kneel.md b/.changeset/thin-bobcats-kneel.md new file mode 100644 index 00000000000..b9491e25d5c --- /dev/null +++ b/.changeset/thin-bobcats-kneel.md @@ -0,0 +1,6 @@ +--- +'@shopify/polaris': patch +'polaris.shopify.com': patch +--- + +Renamed `spacing` prop to `gap` on `Inline`, `AlphaStack`, `Columns`, and `Tiles` diff --git a/polaris-react/src/components/AlphaCard/AlphaCard.stories.tsx b/polaris-react/src/components/AlphaCard/AlphaCard.stories.tsx index 67cb3509d3e..593f7777547 100644 --- a/polaris-react/src/components/AlphaCard/AlphaCard.stories.tsx +++ b/polaris-react/src/components/AlphaCard/AlphaCard.stories.tsx @@ -9,7 +9,7 @@ export default { export function Default() { return ( - + Online store dashboard @@ -22,7 +22,7 @@ export function Default() { export function BackgroundSubdued() { return ( - + Online store dashboard @@ -35,7 +35,7 @@ export function BackgroundSubdued() { export function BorderRadiusRoundedAbove() { return ( - + Online store dashboard diff --git a/polaris-react/src/components/AlphaStack/AlphaStack.scss b/polaris-react/src/components/AlphaStack/AlphaStack.scss index 479d9c18179..0a212e1817d 100644 --- a/polaris-react/src/components/AlphaStack/AlphaStack.scss +++ b/polaris-react/src/components/AlphaStack/AlphaStack.scss @@ -1,30 +1,30 @@ @import '../../styles/common'; .AlphaStack { - --pc-stack-spacing-xs: var(--p-space-4); - --pc-stack-spacing-sm: var(--pc-stack-spacing-xs); - --pc-stack-spacing-md: var(--pc-stack-spacing-sm); - --pc-stack-spacing-lg: var(--pc-stack-spacing-md); - --pc-stack-spacing-xl: var(--pc-stack-spacing-lg); + --pc-stack-gap-xs: var(--p-space-4); + --pc-stack-gap-sm: var(--pc-stack-gap-xs); + --pc-stack-gap-md: var(--pc-stack-gap-sm); + --pc-stack-gap-lg: var(--pc-stack-gap-md); + --pc-stack-gap-xl: var(--pc-stack-gap-lg); display: flex; flex-direction: column; align-items: var(--pc-stack-align); - gap: var(--pc-stack-spacing-xs); + gap: var(--pc-stack-gap-xs); @media #{$p-breakpoints-sm-up} { - gap: var(--pc-stack-spacing-sm); + gap: var(--pc-stack-gap-sm); } @media #{$p-breakpoints-md-up} { - gap: var(--pc-stack-spacing-md); + gap: var(--pc-stack-gap-md); } @media #{$p-breakpoints-lg-up} { - gap: var(--pc-stack-spacing-lg); + gap: var(--pc-stack-gap-lg); } @media #{$p-breakpoints-xl-up} { - gap: var(--pc-stack-spacing-xl); + gap: var(--pc-stack-gap-xl); } > * { diff --git a/polaris-react/src/components/AlphaStack/AlphaStack.stories.tsx b/polaris-react/src/components/AlphaStack/AlphaStack.stories.tsx index 72adc534194..6979ef8298c 100644 --- a/polaris-react/src/components/AlphaStack/AlphaStack.stories.tsx +++ b/polaris-react/src/components/AlphaStack/AlphaStack.stories.tsx @@ -17,9 +17,9 @@ export function Default() { ); } -export function Spacing() { +export function Gap() { return ( - + Paid Processing Fulfilled @@ -61,9 +61,9 @@ export function FullWidthChildren() { ); } -export function ResponsiveSpacing() { +export function ResponsiveGap() { return ( - + Paid Processing Fulfilled diff --git a/polaris-react/src/components/AlphaStack/AlphaStack.tsx b/polaris-react/src/components/AlphaStack/AlphaStack.tsx index 170d8ac9cbc..61fdd010640 100644 --- a/polaris-react/src/components/AlphaStack/AlphaStack.tsx +++ b/polaris-react/src/components/AlphaStack/AlphaStack.tsx @@ -14,7 +14,7 @@ type Align = 'start' | 'end' | 'center'; type Element = 'div' | 'ul' | 'ol' | 'fieldset'; -type Spacing = ResponsiveProp; +type Gap = ResponsiveProp; export interface AlphaStackProps { /** HTML Element type @@ -32,7 +32,7 @@ export interface AlphaStackProps { /** The spacing between elements * @default '4' */ - spacing?: Spacing; + gap?: Gap; } export const AlphaStack = ({ @@ -40,7 +40,7 @@ export const AlphaStack = ({ children, align = 'start', fullWidth, - spacing = '4', + gap = '4', }: AlphaStackProps) => { const className = classNames( styles.AlphaStack, @@ -50,7 +50,7 @@ export const AlphaStack = ({ const style = { '--pc-stack-align': align ? `${align}` : '', - ...getResponsiveProps('stack', 'spacing', 'space', spacing), + ...getResponsiveProps('stack', 'gap', 'space', gap), } as React.CSSProperties; return createElement( diff --git a/polaris-react/src/components/AlphaStack/tests/AlphaStack.test.tsx b/polaris-react/src/components/AlphaStack/tests/AlphaStack.test.tsx index e4ed5bc49df..b3638694c32 100644 --- a/polaris-react/src/components/AlphaStack/tests/AlphaStack.test.tsx +++ b/polaris-react/src/components/AlphaStack/tests/AlphaStack.test.tsx @@ -19,14 +19,14 @@ describe('', () => { expect(stack).toContainReactComponent('div', { style: expect.objectContaining({ '--pc-stack-align': 'start', - '--pc-stack-spacing-xs': 'var(--p-space-4)', + '--pc-stack-gap-xs': 'var(--p-space-4)', }) as React.CSSProperties, }); }); it('overrides custom properties if they are passed in', () => { const stack = mountWithApp( - + {children} , ); @@ -34,20 +34,20 @@ describe('', () => { expect(stack).toContainReactComponent('div', { style: expect.objectContaining({ '--pc-stack-align': 'center', - '--pc-stack-spacing-xs': 'var(--p-space-10)', + '--pc-stack-gap-xs': 'var(--p-space-10)', }) as React.CSSProperties, }); }); - it('accepts spacing based on breakpoints', () => { + it('accepts gap based on breakpoints', () => { const stack = mountWithApp( - {children}, + {children}, ); expect(stack).toContainReactComponent('div', { style: expect.objectContaining({ - '--pc-stack-spacing-md': 'var(--p-space-8)', - '--pc-stack-spacing-xs': 'var(--p-space-2)', + '--pc-stack-gap-md': 'var(--p-space-8)', + '--pc-stack-gap-xs': 'var(--p-space-2)', }) as React.CSSProperties, }); }); diff --git a/polaris-react/src/components/Columns/Columns.scss b/polaris-react/src/components/Columns/Columns.scss index 574457e78e3..25556b65338 100644 --- a/polaris-react/src/components/Columns/Columns.scss +++ b/polaris-react/src/components/Columns/Columns.scss @@ -6,32 +6,32 @@ --pc-columns-md: var(--pc-columns-sm); --pc-columns-lg: var(--pc-columns-md); --pc-columns-xl: var(--pc-columns-lg); - --pc-columns-space-xs: var(--p-space-4); - --pc-columns-space-sm: var(--pc-columns-space-xs); - --pc-columns-space-md: var(--pc-columns-space-sm); - --pc-columns-space-lg: var(--pc-columns-space-md); - --pc-columns-space-xl: var(--pc-columns-space-lg); + --pc-columns-gap-xs: var(--p-space-4); + --pc-columns-gap-sm: var(--pc-columns-gap-xs); + --pc-columns-gap-md: var(--pc-columns-gap-sm); + --pc-columns-gap-lg: var(--pc-columns-gap-md); + --pc-columns-gap-xl: var(--pc-columns-gap-lg); display: grid; - gap: var(--pc-columns-space-xs); + gap: var(--pc-columns-gap-xs); grid-template-columns: var(--pc-columns-xs); @media #{$p-breakpoints-sm-up} { - gap: var(--pc-columns-space-sm); + gap: var(--pc-columns-gap-sm); grid-template-columns: var(--pc-columns-sm); } @media #{$p-breakpoints-md-up} { - gap: var(--pc-columns-space-md); + gap: var(--pc-columns-gap-md); grid-template-columns: var(--pc-columns-md); } @media #{$p-breakpoints-lg-up} { - gap: var(--pc-columns-space-lg); + gap: var(--pc-columns-gap-lg); grid-template-columns: var(--pc-columns-lg); } @media #{$p-breakpoints-xl-up} { - gap: var(--pc-columns-space-xl); + gap: var(--pc-columns-gap-xl); grid-template-columns: var(--pc-columns-xl); } } diff --git a/polaris-react/src/components/Columns/Columns.stories.tsx b/polaris-react/src/components/Columns/Columns.stories.tsx index 02e84862a3f..4e576ead271 100644 --- a/polaris-react/src/components/Columns/Columns.stories.tsx +++ b/polaris-react/src/components/Columns/Columns.stories.tsx @@ -32,7 +32,7 @@ export function ColumnsWithTemplateColumns() { md: '1fr 3fr auto 1fr', lg: '1fr 4fr auto 2fr 3fr auto', }} - spacing={{xs: '4'}} + gap={{xs: '4'}} >
Column one
Column two
@@ -50,7 +50,7 @@ export function ColumnsWithMixedPropTypes() {
one
two
@@ -68,7 +68,7 @@ export function ColumnsWithVaryingGap() {
Column one
Column two
@@ -81,7 +81,7 @@ export function ColumnsWithVaryingGap() { export function ColumnsWithFreeAndFixedWidths() { return ( - +
Column one
- +
@@ -23,7 +23,7 @@ function BoxWithPaddingExample() {
- +
diff --git a/polaris.shopify.com/pages/examples/columns-with-set-number.tsx b/polaris.shopify.com/pages/examples/columns-with-set-number.tsx index 8dd5f7dce0a..ffb1e56eaa9 100644 --- a/polaris.shopify.com/pages/examples/columns-with-set-number.tsx +++ b/polaris.shopify.com/pages/examples/columns-with-set-number.tsx @@ -11,7 +11,7 @@ function ColumnsWithSetNumberExample() { xs: '3fr 3fr', md: '4fr 2fr', }} - spacing={{ + gap={{ xs: '4', md: '2', }} diff --git a/polaris.shopify.com/pages/examples/columns-with-varying-spacing.tsx b/polaris.shopify.com/pages/examples/columns-with-varying-gap.tsx similarity index 97% rename from polaris.shopify.com/pages/examples/columns-with-varying-spacing.tsx rename to polaris.shopify.com/pages/examples/columns-with-varying-gap.tsx index 2a6cd21e6f2..d15755a2715 100644 --- a/polaris.shopify.com/pages/examples/columns-with-varying-spacing.tsx +++ b/polaris.shopify.com/pages/examples/columns-with-varying-gap.tsx @@ -6,7 +6,7 @@ import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; function ColumnsWithVaryingGapExample() { return ( - + diff --git a/polaris.shopify.com/pages/examples/inline-with-spacing.tsx b/polaris.shopify.com/pages/examples/inline-with-gap.tsx similarity index 91% rename from polaris.shopify.com/pages/examples/inline-with-spacing.tsx rename to polaris.shopify.com/pages/examples/inline-with-gap.tsx index 9bb6936fe6f..95062b129b0 100644 --- a/polaris.shopify.com/pages/examples/inline-with-spacing.tsx +++ b/polaris.shopify.com/pages/examples/inline-with-gap.tsx @@ -3,9 +3,9 @@ import {Inline, AlphaStack} from '@shopify/polaris'; import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; -function InlineWithSpacingExample() { +function InlineWithGapExample() { return ( - + @@ -54,4 +54,4 @@ const Placeholder = ({height = 'auto', width = 'auto'}) => { ); }; -export default withPolarisExample(InlineWithSpacingExample); +export default withPolarisExample(InlineWithGapExample); diff --git a/polaris.shopify.com/pages/examples/inline-with-horizontal-alignment.tsx b/polaris.shopify.com/pages/examples/inline-with-horizontal-alignment.tsx index a24767809e9..0e5303cd287 100644 --- a/polaris.shopify.com/pages/examples/inline-with-horizontal-alignment.tsx +++ b/polaris.shopify.com/pages/examples/inline-with-horizontal-alignment.tsx @@ -6,7 +6,7 @@ import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; function InlineWithHorizontalAlignmentExample() { return ( - + diff --git a/polaris.shopify.com/pages/examples/inline-with-vertical-alignment.tsx b/polaris.shopify.com/pages/examples/inline-with-vertical-alignment.tsx index f9a2c6d3cf2..44e74eade56 100644 --- a/polaris.shopify.com/pages/examples/inline-with-vertical-alignment.tsx +++ b/polaris.shopify.com/pages/examples/inline-with-vertical-alignment.tsx @@ -5,9 +5,9 @@ import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; function InlineWithVerticalAlignmentExample() { return ( - - - + + + @@ -22,8 +22,8 @@ function InlineWithVerticalAlignmentExample() { - - + + diff --git a/polaris.shopify.com/pages/examples/tiles-with-spacing.tsx b/polaris.shopify.com/pages/examples/tiles-with-gap.tsx similarity index 89% rename from polaris.shopify.com/pages/examples/tiles-with-spacing.tsx rename to polaris.shopify.com/pages/examples/tiles-with-gap.tsx index f93a2b7ca00..4f46cf0fab9 100644 --- a/polaris.shopify.com/pages/examples/tiles-with-spacing.tsx +++ b/polaris.shopify.com/pages/examples/tiles-with-gap.tsx @@ -3,7 +3,7 @@ import {Tiles, Text} from '@shopify/polaris'; import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; -function TilesWithSpacingExample() { +function TilesWithGapExample() { return ( @@ -39,4 +39,4 @@ const Placeholder = ({label = '', height = 'auto', width = 'auto'}) => { ); }; -export default withPolarisExample(TilesWithSpacingExample); +export default withPolarisExample(TilesWithGapExample); diff --git a/polaris.shopify.com/src/data/props.json b/polaris.shopify.com/src/data/props.json index d0fc6e7bc41..3dfa9c9a597 100644 --- a/polaris.shopify.com/src/data/props.json +++ b/polaris.shopify.com/src/data/props.json @@ -7227,6 +7227,84 @@ "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}" + } + }, "PortalsContainerElement": { "polaris-react/src/utilities/portals/types.ts": { "filePath": "polaris-react/src/utilities/portals/types.ts", @@ -7329,84 +7407,6 @@ "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}" } }, - "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}" - } - }, "StickyItem": { "polaris-react/src/utilities/sticky-manager/sticky-manager.ts": { "filePath": "polaris-react/src/utilities/sticky-manager/sticky-manager.ts", @@ -7722,57 +7722,54 @@ "description": "" } }, - "CardBackgroundColorTokenScale": { - "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "CardBackgroundColorTokenScale", - "value": "\"surface\" | \"surface-subdued\"", - "description": "" - } - }, - "AlphaCardProps": { - "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "name": "AlphaCardProps", + "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/AlphaCard/AlphaCard.tsx", + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Elements to display inside card", + "name": "actions", + "value": "MenuActionDescriptor[]", + "description": "Collection of page-level secondary actions", "isOptional": true }, { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", "syntaxKind": "PropertySignature", - "name": "background", - "value": "CardBackgroundColorTokenScale", - "description": "Background color", - "isOptional": true, - "defaultValue": "'surface'" + "name": "groups", + "value": "MenuGroupDescriptor[]", + "description": "Collection of page-level action groups", + "isOptional": true }, { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", "syntaxKind": "PropertySignature", - "name": "padding", - "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "The spacing around the card", - "isOptional": true, - "defaultValue": "'5'" + "name": "rollup", + "value": "boolean", + "description": "Roll up all actions into a Popover > ActionList", + "isOptional": true }, { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", "syntaxKind": "PropertySignature", - "name": "roundedAbove", - "value": "\"xs\" | \"sm\" | \"md\" | \"lg\" | \"xl\"", - "description": "Border radius value above a set breakpoint", + "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 AlphaCardProps {\n /** Elements to display inside card */\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}" + "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}" } }, "Props": { @@ -8059,54 +8056,57 @@ "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", + "CardBackgroundColorTokenScale": { + "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "CardBackgroundColorTokenScale", + "value": "\"surface\" | \"surface-subdued\"", + "description": "" + } + }, + "AlphaCardProps": { + "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "name": "AlphaCardProps", "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", + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", "syntaxKind": "PropertySignature", - "name": "groups", - "value": "MenuGroupDescriptor[]", - "description": "Collection of page-level action groups", + "name": "children", + "value": "React.ReactNode", + "description": "Elements to display inside card", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", "syntaxKind": "PropertySignature", - "name": "rollup", - "value": "boolean", - "description": "Roll up all actions into a Popover > ActionList", - "isOptional": true + "name": "background", + "value": "CardBackgroundColorTokenScale", + "description": "Background color", + "isOptional": true, + "defaultValue": "'surface'" }, { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", "syntaxKind": "PropertySignature", - "name": "rollupActionsLabel", - "value": "string", - "description": "Label for rolled up actions activator", - "isOptional": true + "name": "padding", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "The spacing around the card", + "isOptional": true, + "defaultValue": "'5'" }, { - "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", + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "roundedAbove", + "value": "\"xs\" | \"sm\" | \"md\" | \"lg\" | \"xl\"", + "description": "Border radius value above a set breakpoint", "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}" + "value": "export interface AlphaCardProps {\n /** Elements to display inside card */\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}" } }, "Align": { @@ -8148,47 +8148,33 @@ "description": "" } }, - "Spacing": { + "Gap": { "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", - "value": "ResponsiveProp", - "description": "" - }, - "polaris-react/src/components/Box/Box.tsx": { - "filePath": "polaris-react/src/components/Box/Box.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", + "name": "Gap", "value": "ResponsiveProp", "description": "" }, - "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", - "value": "'extraTight' | 'tight' | 'loose'", - "description": "" - }, "polaris-react/src/components/Columns/Columns.tsx": { "filePath": "polaris-react/src/components/Columns/Columns.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", + "name": "Gap", "value": "{\n [Breakpoint in BreakpointsAlias]?: SpacingSpaceScale;\n}", "description": "" }, - "polaris-react/src/components/Stack/Stack.tsx": { - "filePath": "polaris-react/src/components/Stack/Stack.tsx", + "polaris-react/src/components/Grid/Grid.tsx": { + "filePath": "polaris-react/src/components/Grid/Grid.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", - "value": "'extraTight' | 'tight' | 'baseTight' | 'loose' | 'extraLoose' | 'none'", + "name": "Gap", + "value": "{\n [Breakpoint in Breakpoints]?: string;\n}", "description": "" }, - "polaris-react/src/components/TextContainer/TextContainer.tsx": { - "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", + "polaris-react/src/components/Tiles/Tiles.tsx": { + "filePath": "polaris-react/src/components/Tiles/Tiles.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", - "value": "'tight' | 'loose'", + "name": "Gap", + "value": "{\n [Breakpoint in BreakpointsAlias]?: SpacingSpaceScale;\n}", "description": "" } }, @@ -8235,14 +8221,14 @@ { "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", "syntaxKind": "PropertySignature", - "name": "spacing", - "value": "Spacing", + "name": "gap", + "value": "Gap", "description": "The spacing between elements", "isOptional": true, "defaultValue": "'4'" } ], - "value": "export interface AlphaStackProps {\n /** HTML Element type\n * @default 'div'\n */\n as?: Element;\n /** Elements to display inside stack */\n children?: React.ReactNode;\n /** The vertical alignment of elements\n * @default 'start'\n */\n align?: Align;\n /** Toggle elements to be full width */\n fullWidth?: boolean;\n /** The spacing between elements\n * @default '4'\n */\n spacing?: Spacing;\n}" + "value": "export interface AlphaStackProps {\n /** HTML Element type\n * @default 'div'\n */\n as?: Element;\n /** Elements to display inside stack */\n children?: React.ReactNode;\n /** The vertical alignment of elements\n * @default 'start'\n */\n align?: Align;\n /** Toggle elements to be full width */\n fullWidth?: boolean;\n /** The spacing between elements\n * @default '4'\n */\n gap?: Gap;\n}" } }, "State": { @@ -9772,6 +9758,36 @@ "description": "" } }, + "Spacing": { + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Spacing", + "value": "ResponsiveProp", + "description": "" + }, + "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Spacing", + "value": "'extraTight' | 'tight' | 'loose'", + "description": "" + }, + "polaris-react/src/components/Stack/Stack.tsx": { + "filePath": "polaris-react/src/components/Stack/Stack.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Spacing", + "value": "'extraTight' | 'tight' | 'baseTight' | 'loose' | 'extraLoose' | 'none'", + "description": "" + }, + "polaris-react/src/components/TextContainer/TextContainer.tsx": { + "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Spacing", + "value": "'tight' | 'loose'", + "description": "" + } + }, "Border": { "polaris-react/src/components/Box/Box.tsx": { "filePath": "polaris-react/src/components/Box/Box.tsx", @@ -10897,24 +10913,6 @@ "value": "export interface CalloutCardProps {\n /** The content to display inside the callout card. */\n children?: React.ReactNode;\n /** The title of the card */\n title: React.ReactNode;\n /** URL to the card illustration */\n illustration: string;\n /** Primary action for the card */\n primaryAction: Action;\n /** Secondary action for the card */\n secondaryAction?: Action;\n /** Callback when banner is dismissed */\n onDismiss?(): void;\n}" } }, - "CaptionProps": { - "polaris-react/src/components/Caption/Caption.tsx": { - "filePath": "polaris-react/src/components/Caption/Caption.tsx", - "name": "CaptionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Caption/Caption.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to use as a graph label or timestamp", - "isOptional": true - } - ], - "value": "export interface CaptionProps {\n /** The content to use as a graph label or timestamp */\n children?: React.ReactNode;\n}" - } - }, "CardProps": { "polaris-react/src/components/Card/Card.tsx": { "filePath": "polaris-react/src/components/Card/Card.tsx", @@ -11005,6 +11003,24 @@ "value": "export interface CardProps {\n /** Title content for the card */\n title?: React.ReactNode;\n /** Inner content of the card */\n children?: React.ReactNode;\n /** A less prominent card */\n subdued?: boolean;\n /** Auto wrap content in section */\n sectioned?: boolean;\n /** Card header actions */\n actions?: DisableableAction[];\n /** Primary action in the card footer */\n primaryFooterAction?: ComplexAction;\n /** Secondary actions in the card footer */\n secondaryFooterActions?: ComplexAction[];\n /** The content of the disclosure button rendered when there is more than one secondary footer action */\n secondaryFooterActionsDisclosureText?: string;\n /** Alignment of the footer actions on the card, defaults to right */\n footerActionAlignment?: 'right' | 'left';\n /** Allow the card to be hidden when printing */\n hideOnPrint?: boolean;\n}" } }, + "CaptionProps": { + "polaris-react/src/components/Caption/Caption.tsx": { + "filePath": "polaris-react/src/components/Caption/Caption.tsx", + "name": "CaptionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Caption/Caption.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The content to use as a graph label or timestamp", + "isOptional": true + } + ], + "value": "export interface CaptionProps {\n /** The content to use as a graph label or timestamp */\n children?: React.ReactNode;\n}" + } + }, "CheckableButtonProps": { "polaris-react/src/components/CheckableButton/CheckableButton.tsx": { "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", @@ -11791,8 +11807,8 @@ { "filePath": "polaris-react/src/components/Columns/Columns.tsx", "syntaxKind": "PropertySignature", - "name": "spacing", - "value": "Spacing", + "name": "gap", + "value": "Gap", "description": "The spacing between columns", "isOptional": true, "defaultValue": "'4'" @@ -11815,7 +11831,7 @@ "isOptional": true } ], - "value": "export interface ColumnsProps {\n /** The spacing between columns\n * @default '4'\n */\n spacing?: Spacing;\n /** The number of columns to display\n * @default {xs: 6, sm: 6, md: 6, lg: 6, xl: 6}\n */\n columns?: Columns;\n /** Elements to display inside columns */\n children?: React.ReactNode;\n}" + "value": "export interface ColumnsProps {\n /** The spacing between columns\n * @default '4'\n */\n gap?: Gap;\n /** The number of columns to display\n * @default {xs: 6, sm: 6, md: 6, lg: 6, xl: 6}\n */\n columns?: Columns;\n /** Elements to display inside columns */\n children?: React.ReactNode;\n}" } }, "ComboboxProps": { @@ -13416,31 +13432,6 @@ "value": "export interface FormLayoutProps {\n /** The content to display inside the layout. */\n children?: React.ReactNode;\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}" - } - }, "FrameProps": { "polaris-react/src/components/Frame/Frame.tsx": { "filePath": "polaris-react/src/components/Frame/Frame.tsx", @@ -13524,6 +13515,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", @@ -13549,22 +13565,6 @@ "description": "" } }, - "Gap": { - "polaris-react/src/components/Grid/Grid.tsx": { - "filePath": "polaris-react/src/components/Grid/Grid.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Gap", - "value": "{\n [Breakpoint in Breakpoints]?: string;\n}", - "description": "" - }, - "polaris-react/src/components/Tiles/Tiles.tsx": { - "filePath": "polaris-react/src/components/Tiles/Tiles.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Gap", - "value": "{\n [Breakpoint in BreakpointsAlias]?: SpacingSpaceScale;\n}", - "description": "" - } - }, "GridProps": { "polaris-react/src/components/Grid/Grid.tsx": { "filePath": "polaris-react/src/components/Grid/Grid.tsx", @@ -14331,7 +14331,7 @@ { "filePath": "polaris-react/src/components/Inline/Inline.tsx", "syntaxKind": "PropertySignature", - "name": "spacing", + "name": "gap", "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", "description": "The spacing between elements", "isOptional": true, @@ -14355,7 +14355,7 @@ "isOptional": true } ], - "value": "export interface InlineProps {\n /** Adjust horizontal alignment of elements\n * @default 'start'\n */\n align?: Align;\n /** Adjust vertical alignment of elements\n * @default 'center'\n */\n blockAlign?: BlockAlign;\n /** The spacing between elements\n * @default '4'\n */\n spacing?: SpacingSpaceScale;\n /** Wrap stack elements to additional rows as needed on small screens\n * @default true\n */\n wrap?: boolean;\n /** Elements to display inside stack */\n children?: React.ReactNode;\n}" + "value": "export interface InlineProps {\n /** Adjust horizontal alignment of elements\n * @default 'start'\n */\n align?: Align;\n /** Adjust vertical alignment of elements\n * @default 'center'\n */\n blockAlign?: BlockAlign;\n /** The spacing between elements\n * @default '4'\n */\n gap?: SpacingSpaceScale;\n /** Wrap stack elements to additional rows as needed on small screens\n * @default true\n */\n wrap?: boolean;\n /** Elements to display inside stack */\n children?: React.ReactNode;\n}" } }, "InlineCodeProps": { @@ -21795,37 +21795,6 @@ "value": "export interface VisuallyHiddenProps {\n /** The content to be hidden visually */\n children?: React.ReactNode;\n}" } }, - "FocusManagerContextType": { - "polaris-react/src/utilities/focus-manager/context.tsx": { - "filePath": "polaris-react/src/utilities/focus-manager/context.tsx", - "name": "FocusManagerContextType", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/utilities/focus-manager/context.tsx", - "syntaxKind": "PropertySignature", - "name": "trapFocusList", - "value": "string[]", - "description": "" - }, - { - "filePath": "polaris-react/src/utilities/focus-manager/context.tsx", - "syntaxKind": "PropertySignature", - "name": "add", - "value": "(id: string) => void", - "description": "" - }, - { - "filePath": "polaris-react/src/utilities/focus-manager/context.tsx", - "syntaxKind": "PropertySignature", - "name": "remove", - "value": "(id: string) => boolean", - "description": "" - } - ], - "value": "export interface FocusManagerContextType {\n trapFocusList: string[];\n add: (id: string) => void;\n remove: (id: string) => boolean;\n}" - } - }, "ComboboxTextFieldType": { "polaris-react/src/utilities/combobox/context.tsx": { "filePath": "polaris-react/src/utilities/combobox/context.tsx", @@ -21992,1159 +21961,1190 @@ "value": "export interface ComboboxListboxOptionType {\n // Whether the option should visually support multiple selection\n allowMultiple?: boolean;\n}" } }, - "PortalsManager": { - "polaris-react/src/utilities/portals/context.tsx": { - "filePath": "polaris-react/src/utilities/portals/context.tsx", - "name": "PortalsManager", + "FocusManagerContextType": { + "polaris-react/src/utilities/focus-manager/context.tsx": { + "filePath": "polaris-react/src/utilities/focus-manager/context.tsx", + "name": "FocusManagerContextType", "description": "", "members": [ { - "filePath": "polaris-react/src/utilities/portals/context.tsx", + "filePath": "polaris-react/src/utilities/focus-manager/context.tsx", "syntaxKind": "PropertySignature", - "name": "container", - "value": "HTMLDivElement", + "name": "trapFocusList", + "value": "string[]", "description": "" - } + }, + { + "filePath": "polaris-react/src/utilities/focus-manager/context.tsx", + "syntaxKind": "PropertySignature", + "name": "add", + "value": "(id: string) => void", + "description": "" + }, + { + "filePath": "polaris-react/src/utilities/focus-manager/context.tsx", + "syntaxKind": "PropertySignature", + "name": "remove", + "value": "(id: string) => boolean", + "description": "" + } + ], + "value": "export interface FocusManagerContextType {\n trapFocusList: string[];\n add: (id: string) => void;\n remove: (id: string) => boolean;\n}" + } + }, + "PortalsManager": { + "polaris-react/src/utilities/portals/context.tsx": { + "filePath": "polaris-react/src/utilities/portals/context.tsx", + "name": "PortalsManager", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/utilities/portals/context.tsx", + "syntaxKind": "PropertySignature", + "name": "container", + "value": "HTMLDivElement", + "description": "" + } ], "value": "export interface PortalsManager {\n container: PortalsContainerElement;\n}" } }, - "MeasuredActions": { - "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "name": "MeasuredActions", + "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/Actions/Actions.tsx", + "filePath": "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "showable", - "value": "MenuActionDescriptor[]", + "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/ActionMenu/components/Actions/Actions.tsx", + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "rolledUp", - "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", - "description": "" + "name": "children", + "value": "React.ReactNode", + "description": "Item content", + "isOptional": true } ], - "value": "interface MeasuredActions {\n showable: MenuActionDescriptor[];\n rolledUp: (MenuActionDescriptor | MenuGroupDescriptor)[];\n}" - } - }, - "MenuGroupProps": { - "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "name": "MenuGroupProps", + "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/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "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/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/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "badge", + "value": "ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "Visually hidden menu description for screen readers", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "active", + "name": "selected", "value": "boolean", - "description": "Whether or not the menu is open", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "(openActions: () => void) => void", - "description": "Callback when the menu is clicked", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "exactMatch", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "onOpen", - "value": "(title: string) => void", - "description": "Callback for opening the MenuGroup by title" + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "new", + "value": "boolean", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "subNavigationItems", + "value": "SubNavigationItem[]", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "secondaryAction", + "value": "SecondaryAction", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "MethodSignature", - "name": "onClose", - "value": "(title: string) => void", - "description": "Callback for closing the MenuGroup by title" + "name": "onClick", + "value": "() => void", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "MethodSignature", - "name": "getOffsetWidth", - "value": "(width: number) => void", - "description": "Callback for getting the offsetWidth of the MenuGroup", + "name": "onToggleExpandedState", + "value": "() => void", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "sections", - "value": "readonly ActionListSection[]", - "description": "Collection of sectioned action items", + "name": "expanded", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "Menu group title" + "name": "shouldResizeIcon", + "value": "boolean", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "actions", - "value": "ActionListItemDescriptor[]", - "description": "List of actions" + "name": "url", + "value": "string", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "Icon to display", + "name": "matches", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "details", - "value": "React.ReactNode", - "description": "Action details", + "name": "matchPaths", + "value": "string[]", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables action button", + "name": "excludePaths", + "value": "string[]", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "index", - "value": "number", - "description": "Zero-indexed numerical position. Overrides the group's order in the menu.", + "name": "external", + "value": "boolean", + "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}" + }, + "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/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any action takes place", + "name": "children", + "value": "React.ReactNode", + "description": "Elements to display inside item", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "badge", - "value": "{ status: \"new\"; content: string; }", - "description": "", + "name": "fill", + "value": "boolean", + "description": "Fill the remaining horizontal space in the stack with the item", "isOptional": true } ], - "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}" - } - }, - "RollupActionsProps": { - "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "name": "RollupActionsProps", + "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/RollupActions/RollupActions.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", + "name": "id", "value": "string", - "description": "Accessibilty label", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "focused", + "value": "boolean", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "panelID", + "value": "string", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "items", - "value": "ActionListItemDescriptor[]", - "description": "Collection of actions for the list", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "sections", - "value": "ActionListSection[]", - "description": "Collection of sectioned action items", + "name": "url", + "value": "string", + "description": "", "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}" - } - }, - "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", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "helpText", - "value": "React.ReactNode", + "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": "onAction", + "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/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "getOffsetWidth", - "value": "(width: number) => void", + "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}" + } + }, + "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/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "string | string[]", - "description": "The content to display inside the button", - "isOptional": true + "name": "section", + "value": "ActionListSection", + "description": "Section of action items" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "primary", + "name": "hasMultipleSections", "value": "boolean", - "description": "Provides extra visual weight and identifies the primary action in a set of buttons", - "isOptional": true + "description": "Should there be multiple sections" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "destructive", - "value": "boolean", - "description": "Indicates a dangerous or potentially negative action", + "name": "actionRole", + "value": "string", + "description": "Defines a specific role attribute for each action in the list", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.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'" - }, + "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/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "textAlign", - "value": "\"start\" | \"end\" | \"center\" | \"left\" | \"right\"", - "description": "Changes the inner text alignment of the button", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "outline", + "name": "secondary", "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/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", "name": "fullWidth", "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/Layout/components/Section/Section.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": "oneHalf", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "plain", + "name": "oneThird", "value": "boolean", - "description": "Renders a button that looks like a link", + "description": "", "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/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "monochrome", + "name": "divider", "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", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "removeUnderline", - "value": "boolean", - "description": "Removes underline from button text (including on interaction) when `monochrome` and `plain` are true", + "name": "children", + "value": "ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "Icon to display to the left of the button content", - "isOptional": true - }, + "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": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "connectedDisclosure", - "value": "ConnectedDisclosure", - "description": "Disclosure button connected right of the button. Toggles a popover action list.", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "dataPrimaryLink", + "name": "flush", "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/Modal/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the button", + "name": "subdued", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "A destination to link to, rendered in the href attribute of a link", + "name": "titleHidden", + "value": "boolean", + "description": "", "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", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "external", - "value": "boolean", - "description": "Forces url to open in a new tab", + "name": "icon", + "value": "any", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.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": "title", + "value": "string", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "submit", + "name": "fill", "value": "boolean", - "description": "Allows the button to submit a form", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the button, disallowing merchant interaction", + "name": "rollup", + "value": "{ after: number; view: string; hide: string; activePath: string; }", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "loading", - "value": "boolean", - "description": "Replaces button text with a spinner while a background action is being performed", + "name": "action", + "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "pressed", + "name": "separator", "value": "boolean", - "description": "Sets the button in a pressed state", + "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/Popover/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true + } + ], + "value": "export interface SectionProps {\n children?: React.ReactNode;\n}" + } + }, + "MeasuredActions": { + "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "name": "MeasuredActions", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "syntaxKind": "PropertySignature", + "name": "showable", + "value": "MenuActionDescriptor[]", + "description": "" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "syntaxKind": "PropertySignature", + "name": "rolledUp", + "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", + "description": "" + } + ], + "value": "interface MeasuredActions {\n showable: MenuActionDescriptor[];\n rolledUp: (MenuActionDescriptor | MenuGroupDescriptor)[];\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", "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "Visually hidden text for screen readers", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "PropertySignature", - "name": "role", - "value": "string", - "description": "A valid WAI-ARIA role to define the semantic value of this element", + "description": "Accessibilty label", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", "syntaxKind": "PropertySignature", - "name": "ariaControls", - "value": "string", - "description": "Id of the element the button controls", + "name": "items", + "value": "ActionListItemDescriptor[]", + "description": "Collection of actions for the list", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", "syntaxKind": "PropertySignature", - "name": "ariaExpanded", - "value": "boolean", - "description": "Tells screen reader the controlled element is expanded", + "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}" + } + }, + "MenuGroupProps": { + "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "name": "MenuGroupProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "ariaDescribedBy", + "name": "accessibilityLabel", "value": "string", - "description": "Indicates the ID of the element that describes the button", + "description": "Visually hidden menu description for screen readers", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.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": "active", + "value": "boolean", + "description": "Whether or not the menu is open", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "MethodSignature", "name": "onClick", - "value": "() => void", - "description": "Callback when clicked", - "isOptional": true - }, - { - "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/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onBlur", - "value": "() => void", - "description": "Callback when focus leaves button", - "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", + "value": "(openActions: () => void) => void", + "description": "Callback when the menu is clicked", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "MethodSignature", - "name": "onKeyUp", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keyup event is registered on the button", - "isOptional": true + "name": "onOpen", + "value": "(title: string) => void", + "description": "Callback for opening the MenuGroup by title" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "MethodSignature", - "name": "onKeyDown", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keydown event is registered on the button", - "isOptional": true + "name": "onClose", + "value": "(title: string) => void", + "description": "Callback for closing the MenuGroup by title" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "MethodSignature", - "name": "onMouseEnter", - "value": "() => void", - "description": "Callback when mouse enter", + "name": "getOffsetWidth", + "value": "(width: number) => void", + "description": "Callback for getting the offsetWidth of the MenuGroup", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onTouchStart", - "value": "() => void", - "description": "Callback when element is touched", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "sections", + "value": "readonly ActionListSection[]", + "description": "Collection of sectioned action items", "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": "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", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "url", + "name": "title", "value": "string", - "description": "" + "description": "Menu group title" }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "" + "name": "actions", + "value": "ActionListItemDescriptor[]", + "description": "List of actions" }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", "name": "icon", "value": "any", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "", + "description": "Icon to display", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "tooltip", - "value": "TooltipProps", - "description": "", + "name": "details", + "value": "React.ReactNode", + "description": "Action details", "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/ActionList/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "section", - "value": "ActionListSection", - "description": "Section of action items" }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "hasMultipleSections", + "name": "disabled", "value": "boolean", - "description": "Should there be multiple sections" + "description": "Disables action button", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "actionRole", - "value": "string", - "description": "Defines a specific role attribute for each action in the list", + "name": "index", + "value": "number", + "description": "Zero-indexed numerical position. Overrides the group's order in the menu.", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", "name": "onActionAnyItem", "value": "() => void", - "description": "Callback when any item is clicked or keypressed", + "description": "Callback when any action takes place", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "badge", + "value": "{ status: \"new\"; content: string; }", + "description": "", "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", + "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", "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", + "name": "helpText", "value": "React.ReactNode", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "secondary", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "fullWidth", - "value": "boolean", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onAction", + "value": "() => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "oneHalf", - "value": "boolean", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "getOffsetWidth", + "value": "(width: number) => void", "description": "", "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", - "value": "boolean", - "description": "", + "name": "children", + "value": "string | string[]", + "description": "The content to display inside the button", "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": "primary", "value": "boolean", - "description": "", + "description": "Provides extra visual weight and identifies the primary action in a set of buttons", "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": "destructive", + "value": "boolean", + "description": "Indicates a dangerous or potentially negative action", "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": "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/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "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/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "flush", + "name": "outline", "value": "boolean", - "description": "", + "description": "Gives the button a subtle alternative to the default button styling, appropriate for certain backdrops", "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", + "name": "fullWidth", "value": "boolean", - "description": "", + "description": "Allows the button to grow to the width of its container", "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": "disclosure", + "value": "boolean | \"up\" | \"down\" | \"select\"", + "description": "Displays the button with a disclosure icon. Defaults to `down` when set to true", "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/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "", + "name": "plain", + "value": "boolean", + "description": "Renders a button that looks like a link", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "", + "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/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "fill", + "name": "removeUnderline", "value": "boolean", - "description": "", + "description": "Removes underline from button text (including on interaction) when `monochrome` and `plain` are true", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "rollup", - "value": "{ after: number; view: string; hide: string; activePath: string; }", - "description": "", + "name": "icon", + "value": "any", + "description": "Icon to display to the left of the button content", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "action", - "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", - "description": "", + "name": "connectedDisclosure", + "value": "ConnectedDisclosure", + "description": "Disclosure button connected right of the button. Toggles a popover action list.", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "separator", + "name": "dataPrimaryLink", "value": "boolean", - "description": "", + "description": "Indicates whether or not the button is the primary navigation link when rendered inside of an `IndexTable.Row`", "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", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "name": "id", + "value": "string", + "description": "A unique identifier for the button", "isOptional": true - } - ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\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}" - }, - "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", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Item content", + "name": "url", + "value": "string", + "description": "A destination to link to, rendered in the href attribute of a link", "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", + "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 - } - ], - "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/List/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Content to display inside the item", + "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 - } - ], - "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", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "", + "name": "submit", + "value": "boolean", + "description": "Allows the button to submit a form", "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": "badge", - "value": "ReactNode", - "description": "", + "name": "disabled", + "value": "boolean", + "description": "Disables the button, disallowing merchant interaction", "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": "label", - "value": "string", - "description": "" + "name": "loading", + "value": "boolean", + "description": "Replaces button text with a spinner while a background action is being performed", + "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": "disabled", + "name": "pressed", "value": "boolean", - "description": "", + "description": "Sets the button in a pressed state", "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": "", + "description": "Visually hidden text for screen readers", "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": "selected", - "value": "boolean", - "description": "", + "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/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "exactMatch", - "value": "boolean", - "description": "", + "name": "ariaControls", + "value": "string", + "description": "Id of the element the button controls", "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": "new", + "name": "ariaExpanded", "value": "boolean", - "description": "", + "description": "Tells screen reader the controlled element is expanded", "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": "subNavigationItems", - "value": "SubNavigationItem[]", - "description": "", + "name": "ariaDescribedBy", + "value": "string", + "description": "Indicates the ID of the element that describes 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": "secondaryAction", - "value": "SecondaryAction", - "description": "", + "name": "ariaChecked", + "value": "\"false\" | \"true\"", + "description": "Indicates the current checked state of the button when acting as a toggle or switch", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "MethodSignature", "name": "onClick", "value": "() => void", - "description": "", + "description": "Callback when clicked", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "MethodSignature", - "name": "onToggleExpandedState", + "name": "onFocus", "value": "() => void", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "expanded", - "value": "boolean", - "description": "", + "description": "Callback when button becomes focussed", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "shouldResizeIcon", - "value": "boolean", - "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/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "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/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "matches", - "value": "boolean", - "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/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "matchPaths", - "value": "string[]", - "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/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "excludePaths", - "value": "string[]", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onMouseEnter", + "value": "() => void", + "description": "Callback when mouse enter", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "external", - "value": "boolean", - "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}" - }, - "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/ActionMenu/components/SecondaryAction/SecondaryAction.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", - "syntaxKind": "PropertySignature", - "name": "fill", - "value": "boolean", - "description": "Fill the remaining horizontal space in the stack with the item", + "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 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}" + "value": "interface SecondaryAction extends ButtonProps {\n helpText?: React.ReactNode;\n onAction?(): void;\n getOffsetWidth?(width: number): void;\n}" }, - "polaris-react/src/components/Tabs/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "name": "ItemProps", + "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/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "id", + "name": "url", "value": "string", "description": "" }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "focused", - "value": "boolean", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "panelID", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "url", + "name": "accessibilityLabel", "value": "string", - "description": "", - "isOptional": true + "description": "" }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "", - "isOptional": true + "name": "icon", + "value": "any", + "description": "" }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/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/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", + "name": "tooltip", + "value": "TooltipProps", "description": "", "isOptional": true } ], - "value": "interface ItemProps {\n children?: React.ReactNode;\n}" + "value": "interface SecondaryAction {\n url: string;\n accessibilityLabel: string;\n icon: IconProps['source'];\n onClick?(): void;\n tooltip?: TooltipProps;\n}" } }, "MappedAction": { @@ -23548,15 +23548,33 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", + "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}" + } + }, + "CardSubsectionProps": { + "polaris-react/src/components/Card/components/Subsection/Subsection.tsx": { + "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", + "name": "CardSubsectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", "syntaxKind": "PropertySignature", - "name": "actions", - "value": "ComplexAction[]", + "name": "children", + "value": "React.ReactNode", "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}" + "value": "export interface CardSubsectionProps {\n children?: React.ReactNode;\n}" } }, "AlphaPickerProps": { @@ -23679,24 +23697,6 @@ "value": "export interface SlidableProps {\n draggerX?: number;\n draggerY?: number;\n onChange(position: Position): void;\n onDraggerHeight?(height: number): void;\n}" } }, - "CardSubsectionProps": { - "polaris-react/src/components/Card/components/Subsection/Subsection.tsx": { - "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", - "name": "CardSubsectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "export interface CardSubsectionProps {\n children?: React.ReactNode;\n}" - } - }, "CellProps": { "polaris-react/src/components/DataTable/components/Cell/Cell.tsx": { "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", @@ -23995,6 +23995,15 @@ "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": "" + } + }, "DayProps": { "polaris-react/src/components/DatePicker/components/Day/Day.tsx": { "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", @@ -24251,13 +24260,30 @@ "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}" } }, - "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": "" + "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/DropZone/components/FileUpload/FileUpload.tsx", + "syntaxKind": "PropertySignature", + "name": "actionTitle", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "syntaxKind": "PropertySignature", + "name": "actionHint", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface FileUploadProps {\n actionTitle?: string;\n actionHint?: string;\n}" } }, "WeekdayProps": { @@ -24291,32 +24317,6 @@ "value": "export interface WeekdayProps {\n label: string;\n title: string;\n current: boolean;\n}" } }, - "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/DropZone/components/FileUpload/FileUpload.tsx", - "syntaxKind": "PropertySignature", - "name": "actionTitle", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", - "syntaxKind": "PropertySignature", - "name": "actionHint", - "value": "string", - "description": "", - "isOptional": true - } - ], - "value": "export interface FileUploadProps {\n actionTitle?: string;\n actionHint?: string;\n}" - } - }, "PopoverableAction": { "polaris-react/src/components/Filters/components/ConnectedFilterControl/ConnectedFilterControl.tsx": { "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/ConnectedFilterControl.tsx", @@ -25968,56 +25968,56 @@ "value": "export interface PolarisContainerProps {}" } }, - "SingleThumbProps": { - "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx": { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", - "name": "SingleThumbProps", + "DualThumbProps": { + "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx": { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "name": "DualThumbProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "value", - "value": "number", + "value": "DualValue", "description": "Initial value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "id", "value": "string", "description": "ID for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "min", "value": "number", "description": "Minimum possible value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "max", "value": "number", "description": "Maximum possible value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "step", "value": "number", "description": "Increment value for range input changes" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "label", "value": "ReactNode", "description": "Label for the range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "labelAction", "value": "Action", @@ -26025,7 +26025,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "labelHidden", "value": "boolean", @@ -26033,7 +26033,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "output", "value": "boolean", @@ -26041,7 +26041,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "helpText", "value": "ReactNode", @@ -26049,7 +26049,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "error", "value": "any", @@ -26057,7 +26057,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", @@ -26065,7 +26065,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "prefix", "value": "ReactNode", @@ -26073,7 +26073,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "suffix", "value": "ReactNode", @@ -26081,14 +26081,14 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "MethodSignature", "name": "onChange", "value": "(value: RangeSliderValue, id: string) => void", "description": "Callback when the range input is changed" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "MethodSignature", "name": "onFocus", "value": "() => void", @@ -26096,7 +26096,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "MethodSignature", "name": "onBlur", "value": "() => void", @@ -26104,59 +26104,94 @@ "isOptional": true } ], - "value": "export interface SingleThumbProps extends RangeSliderProps {\n value: number;\n id: string;\n min: number;\n max: number;\n step: number;\n}" + "value": "export interface DualThumbProps extends RangeSliderProps {\n value: DualValue;\n id: string;\n min: number;\n max: number;\n step: number;\n}" } }, - "DualThumbProps": { + "KeyHandlers": { "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx": { "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "name": "DualThumbProps", + "name": "KeyHandlers", "description": "", "members": [ { "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "name": "[key: string]", + "value": "() => void" + } + ], + "value": "interface KeyHandlers {\n [key: string]: () => void;\n}" + } + }, + "Control": { + "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx": { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "syntaxKind": "EnumDeclaration", + "name": "Control", + "value": "enum Control {\n Lower,\n Upper,\n}", + "members": [ + { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "name": "Lower", + "value": 0 + }, + { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "name": "Upper", + "value": 1 + } + ] + } + }, + "SingleThumbProps": { + "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx": { + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "name": "SingleThumbProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "value", - "value": "DualValue", + "value": "number", "description": "Initial value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "id", "value": "string", "description": "ID for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "min", "value": "number", "description": "Minimum possible value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "max", "value": "number", "description": "Maximum possible value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "step", "value": "number", "description": "Increment value for range input changes" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "label", "value": "ReactNode", "description": "Label for the range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "labelAction", "value": "Action", @@ -26164,7 +26199,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "labelHidden", "value": "boolean", @@ -26172,7 +26207,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "output", "value": "boolean", @@ -26180,7 +26215,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "helpText", "value": "ReactNode", @@ -26188,7 +26223,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "error", "value": "any", @@ -26196,7 +26231,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", @@ -26204,7 +26239,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "prefix", "value": "ReactNode", @@ -26212,7 +26247,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "suffix", "value": "ReactNode", @@ -26220,65 +26255,30 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "MethodSignature", "name": "onChange", "value": "(value: RangeSliderValue, id: string) => void", "description": "Callback when the range input is changed" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "syntaxKind": "MethodSignature", - "name": "onFocus", - "value": "() => void", - "description": "Callback when range input is focused", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "syntaxKind": "MethodSignature", - "name": "onBlur", - "value": "() => void", - "description": "Callback when focus is removed", - "isOptional": true - } - ], - "value": "export interface DualThumbProps extends RangeSliderProps {\n value: DualValue;\n id: string;\n min: number;\n max: number;\n step: number;\n}" - } - }, - "KeyHandlers": { - "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx": { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "name": "KeyHandlers", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "name": "[key: string]", - "value": "() => void" - } - ], - "value": "interface KeyHandlers {\n [key: string]: () => void;\n}" - } - }, - "Control": { - "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx": { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "syntaxKind": "EnumDeclaration", - "name": "Control", - "value": "enum Control {\n Lower,\n Upper,\n}", - "members": [ - { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "name": "Lower", - "value": 0 + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "syntaxKind": "MethodSignature", + "name": "onFocus", + "value": "() => void", + "description": "Callback when range input is focused", + "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "name": "Upper", - "value": 1 + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "syntaxKind": "MethodSignature", + "name": "onBlur", + "value": "() => void", + "description": "Callback when focus is removed", + "isOptional": true } - ] + ], + "value": "export interface SingleThumbProps extends RangeSliderProps {\n value: number;\n id: string;\n min: number;\n max: number;\n step: number;\n}" } }, "PanelProps": { @@ -26410,6 +26410,89 @@ "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": "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}" + } + }, "ResizerProps": { "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx": { "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", @@ -26530,87 +26613,65 @@ "value": "export interface TooltipOverlayProps {\n id: string;\n active: boolean;\n preventInteraction?: PositionedOverlayProps['preventInteraction'];\n preferredPosition?: PositionedOverlayProps['preferredPosition'];\n children?: React.ReactNode;\n activator: HTMLElement;\n accessibilityLabel?: string;\n onClose(): void;\n}" } }, - "TabMeasurements": { - "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx": { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", - "name": "TabMeasurements", + "MenuProps": { + "polaris-react/src/components/TopBar/components/Menu/Menu.tsx": { + "filePath": "polaris-react/src/components/TopBar/components/Menu/Menu.tsx", + "name": "MenuProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", + "filePath": "polaris-react/src/components/TopBar/components/Menu/Menu.tsx", "syntaxKind": "PropertySignature", - "name": "containerWidth", - "value": "number", - "description": "" + "name": "activatorContent", + "value": "React.ReactNode", + "description": "Accepts an activator component that renders inside of a button that opens the menu" }, { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", + "filePath": "polaris-react/src/components/TopBar/components/Menu/Menu.tsx", "syntaxKind": "PropertySignature", - "name": "disclosureWidth", - "value": "number", - "description": "" + "name": "actions", + "value": "readonly ActionListSection[]", + "description": "An array of action objects that are rendered inside of a popover triggered by this menu" }, { - "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", + "filePath": "polaris-react/src/components/TopBar/components/Menu/Menu.tsx", "syntaxKind": "PropertySignature", - "name": "tabToFocus", - "value": "number", - "description": "" + "name": "message", + "value": "MessageProps", + "description": "Accepts a message that facilitates direct, urgent communication with the merchant through the menu", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", + "filePath": "polaris-react/src/components/TopBar/components/Menu/Menu.tsx", "syntaxKind": "PropertySignature", - "name": "siblingTabHasFocus", + "name": "open", "value": "boolean", - "description": "" + "description": "A boolean property indicating whether the menu is currently open" }, { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", - "syntaxKind": "PropertySignature", - "name": "activator", - "value": "React.ReactElement", - "description": "" + "filePath": "polaris-react/src/components/TopBar/components/Menu/Menu.tsx", + "syntaxKind": "MethodSignature", + "name": "onOpen", + "value": "() => void", + "description": "A callback function to handle opening the menu popover" }, { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", - "syntaxKind": "PropertySignature", - "name": "selected", - "value": "number", - "description": "" + "filePath": "polaris-react/src/components/TopBar/components/Menu/Menu.tsx", + "syntaxKind": "MethodSignature", + "name": "onClose", + "value": "{ (): void; (): void; }", + "description": "A callback function to handle closing the menu popover" }, { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", + "filePath": "polaris-react/src/components/TopBar/components/Menu/Menu.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": "" + "name": "accessibilityLabel", + "value": "string", + "description": "A string that provides the accessibility labeling", + "isOptional": true } ], - "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}" + "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}" } }, "SearchProps": { @@ -26735,67 +26796,6 @@ "value": "export interface SearchFieldProps {\n /** Initial value for the input */\n value: string;\n /** Hint text to display */\n placeholder?: string;\n /** Force the focus state on the input */\n focused?: boolean;\n /** Force a state where search is active but the text field component is not focused */\n active?: boolean;\n /** Callback when value is changed */\n onChange(value: string): void;\n /** Callback when input is focused */\n onFocus?(): void;\n /** Callback when focus is removed */\n onBlur?(): void;\n /** Callback when search field cancel button is clicked */\n onCancel?(): void;\n /** Show a border when the search field is focused */\n showFocusBorder?: boolean;\n}" } }, - "MenuProps": { - "polaris-react/src/components/TopBar/components/Menu/Menu.tsx": { - "filePath": "polaris-react/src/components/TopBar/components/Menu/Menu.tsx", - "name": "MenuProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/TopBar/components/Menu/Menu.tsx", - "syntaxKind": "PropertySignature", - "name": "activatorContent", - "value": "React.ReactNode", - "description": "Accepts an activator component that renders inside of a button that opens the menu" - }, - { - "filePath": "polaris-react/src/components/TopBar/components/Menu/Menu.tsx", - "syntaxKind": "PropertySignature", - "name": "actions", - "value": "readonly ActionListSection[]", - "description": "An array of action objects that are rendered inside of a popover triggered by this menu" - }, - { - "filePath": "polaris-react/src/components/TopBar/components/Menu/Menu.tsx", - "syntaxKind": "PropertySignature", - "name": "message", - "value": "MessageProps", - "description": "Accepts a message that facilitates direct, urgent communication with the merchant through the menu", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TopBar/components/Menu/Menu.tsx", - "syntaxKind": "PropertySignature", - "name": "open", - "value": "boolean", - "description": "A boolean property indicating whether the menu is currently open" - }, - { - "filePath": "polaris-react/src/components/TopBar/components/Menu/Menu.tsx", - "syntaxKind": "MethodSignature", - "name": "onOpen", - "value": "() => void", - "description": "A callback function to handle opening the menu popover" - }, - { - "filePath": "polaris-react/src/components/TopBar/components/Menu/Menu.tsx", - "syntaxKind": "MethodSignature", - "name": "onClose", - "value": "{ (): void; (): void; }", - "description": "A callback function to handle closing the menu popover" - }, - { - "filePath": "polaris-react/src/components/TopBar/components/Menu/Menu.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A string that provides the accessibility labeling", - "isOptional": true - } - ], - "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}" - } - }, "UserMenuProps": { "polaris-react/src/components/TopBar/components/UserMenu/UserMenu.tsx": { "filePath": "polaris-react/src/components/TopBar/components/UserMenu/UserMenu.tsx",