From 6a8485cb4095a0fa74e2eabc4b93158cb3479a20 Mon Sep 17 00:00:00 2001 From: aveline Date: Thu, 17 Nov 2022 14:40:52 -0800 Subject: [PATCH 1/5] Fix typo --- .../src/styles/shared/_responsive-props.scss | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/polaris-react/src/styles/shared/_responsive-props.scss b/polaris-react/src/styles/shared/_responsive-props.scss index c2534b1052f..b59edc45cca 100644 --- a/polaris-react/src/styles/shared/_responsive-props.scss +++ b/polaris-react/src/styles/shared/_responsive-props.scss @@ -1,7 +1,7 @@ @mixin responsive-props( $componentName, $componentProp, - $declartionProp, + $declarationProp, $shorthandFallback: null ) { --pc-#{$componentName}-#{$componentProp}-xs: initial; @@ -18,55 +18,55 @@ --pc-#{$componentName}-#{$componentProp}-lg ); @if $shorthandFallback { - #{$declartionProp}: var( + #{$declarationProp}: var( --pc-#{$componentName}-#{$componentProp}-xs, var(--pc-#{$componentName}-#{$shorthandFallback}-xs) ); @media #{$p-breakpoints-sm-up} { - #{$declartionProp}: var( + #{$declarationProp}: var( --pc-#{$componentName}-#{$componentProp}-sm, var(--pc-#{$componentName}-#{$shorthandFallback}-sm) ); } @media #{$p-breakpoints-md-up} { - #{$declartionProp}: var( + #{$declarationProp}: var( --pc-#{$componentName}-#{$componentProp}-md, var(--pc-#{$componentName}-#{$shorthandFallback}-md) ); } @media #{$p-breakpoints-lg-up} { - #{$declartionProp}: var( + #{$declarationProp}: var( --pc-#{$componentName}-#{$componentProp}-lg, var(--pc-#{$componentName}-#{$shorthandFallback}-lg) ); } @media #{$p-breakpoints-xl-up} { - #{$declartionProp}: var( + #{$declarationProp}: var( --pc-#{$componentName}-#{$componentProp}-xl, var(--pc-#{$componentName}-#{$shorthandFallback}-xl) ); } } @else { - #{$declartionProp}: var(--pc-#{$componentName}-#{$componentProp}-xs); + #{$declarationProp}: var(--pc-#{$componentName}-#{$componentProp}-xs); @media #{$p-breakpoints-sm-up} { - #{$declartionProp}: var(--pc-#{$componentName}-#{$componentProp}-sm); + #{$declarationProp}: var(--pc-#{$componentName}-#{$componentProp}-sm); } @media #{$p-breakpoints-md-up} { - #{$declartionProp}: var(--pc-#{$componentName}-#{$componentProp}-md); + #{$declarationProp}: var(--pc-#{$componentName}-#{$componentProp}-md); } @media #{$p-breakpoints-lg-up} { - #{$declartionProp}: var(--pc-#{$componentName}-#{$componentProp}-lg); + #{$declarationProp}: var(--pc-#{$componentName}-#{$componentProp}-lg); } @media #{$p-breakpoints-xl-up} { - #{$declartionProp}: var(--pc-#{$componentName}-#{$componentProp}-xl); + #{$declarationProp}: var(--pc-#{$componentName}-#{$componentProp}-xl); } } } From cf05742e29b6403ded075fdca6941d5508a01081 Mon Sep 17 00:00:00 2001 From: aveline Date: Thu, 17 Nov 2022 14:47:47 -0800 Subject: [PATCH 2/5] Add examples for responsive spacing props --- polaris-react/src/components/Box/Box.tsx | 30 ++++++++++++++++++++---- 1 file changed, 25 insertions(+), 5 deletions(-) diff --git a/polaris-react/src/components/Box/Box.tsx b/polaris-react/src/components/Box/Box.tsx index d4340faadad..a1016aef714 100644 --- a/polaris-react/src/components/Box/Box.tsx +++ b/polaris-react/src/components/Box/Box.tsx @@ -138,15 +138,35 @@ export interface BoxProps { overflowX?: Overflow; /** Clip vertical content of children */ overflowY?: Overflow; - /** Spacing around children */ + /** Spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes. + * @example + * padding='4' + * padding={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}} + */ padding?: Spacing; - /** Vertical start spacing around children */ + /** Vertical start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes. + * @example + * paddingBlockStart='4' + * paddingBlockStart={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}} + */ paddingBlockStart?: Spacing; - /** Vertical end spacing around children */ + /** Vertical end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes. + * @example + * paddingBlockEnd='4' + * paddingBlockEnd={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}} + */ paddingBlockEnd?: Spacing; - /** Horizontal start spacing around children */ + /** Horizontal start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes. + * @example + * paddingInlineStart='4' + * paddingInlineStart={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}} + */ paddingInlineStart?: Spacing; - /** Horizontal end spacing around children */ + /** Horizontal end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes. + * @example + * paddingInlineEnd='4' + * paddingInlineEnd={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}} + */ paddingInlineEnd?: Spacing; /** Shadow */ shadow?: DepthShadowAlias; From df4b0d8d397b102716dd440fd4d6e206ee95ac59 Mon Sep 17 00:00:00 2001 From: aveline Date: Thu, 17 Nov 2022 14:48:46 -0800 Subject: [PATCH 3/5] Update props.json --- polaris.shopify.com/src/data/props.json | 2280 ++++++++++++----------- 1 file changed, 1144 insertions(+), 1136 deletions(-) diff --git a/polaris.shopify.com/src/data/props.json b/polaris.shopify.com/src/data/props.json index 3dfa9c9a597..d5870eada95 100644 --- a/polaris.shopify.com/src/data/props.json +++ b/polaris.shopify.com/src/data/props.json @@ -7671,57 +7671,6 @@ "value": "export interface AccountConnectionProps {\n /** Content to display as title */\n title?: React.ReactNode;\n /** Content to display as additional details */\n details?: React.ReactNode;\n /** Content to display as terms of service */\n termsOfService?: React.ReactNode;\n /** The name of the service */\n accountName?: string;\n /** URL for the user’s avatar image */\n avatarUrl?: string;\n /** Set if the account is connected */\n connected?: boolean;\n /** Action for account connection */\n action?: Action;\n}" } }, - "ActionListProps": { - "polaris-react/src/components/ActionList/ActionList.tsx": { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "name": "ActionListProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "items", - "value": "readonly ActionListItemDescriptor[]", - "description": "Collection of actions for list", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "sections", - "value": "readonly ActionListSection[]", - "description": "Collection of sectioned action items", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "actionRole", - "value": "string", - "description": "Defines a specific role attribute for each action in the list", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any item is clicked or keypressed", - "isOptional": true - } - ], - "value": "export interface ActionListProps {\n /** Collection of actions for list */\n items?: readonly ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" - } - }, - "ActionListItemProps": { - "polaris-react/src/components/ActionList/ActionList.tsx": { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "ActionListItemProps", - "value": "ItemProps", - "description": "" - } - }, "ActionMenuProps": { "polaris-react/src/components/ActionMenu/ActionMenu.tsx": { "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", @@ -8109,6 +8058,57 @@ "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}" } }, + "ActionListProps": { + "polaris-react/src/components/ActionList/ActionList.tsx": { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "name": "ActionListProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "items", + "value": "readonly ActionListItemDescriptor[]", + "description": "Collection of actions for list", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "sections", + "value": "readonly ActionListSection[]", + "description": "Collection of sectioned action items", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "actionRole", + "value": "string", + "description": "Defines a specific role attribute for each action in the list", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any item is clicked or keypressed", + "isOptional": true + } + ], + "value": "export interface ActionListProps {\n /** Collection of actions for list */\n items?: readonly ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" + } + }, + "ActionListItemProps": { + "polaris-react/src/components/ActionList/ActionList.tsx": { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ActionListItemProps", + "value": "ItemProps", + "description": "" + } + }, "Align": { "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", @@ -10123,7 +10123,7 @@ "syntaxKind": "PropertySignature", "name": "padding", "value": "Spacing", - "description": "Spacing around children", + "description": "Spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.", "isOptional": true }, { @@ -10131,7 +10131,7 @@ "syntaxKind": "PropertySignature", "name": "paddingBlockStart", "value": "Spacing", - "description": "Vertical start spacing around children", + "description": "Vertical start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.", "isOptional": true }, { @@ -10139,7 +10139,7 @@ "syntaxKind": "PropertySignature", "name": "paddingBlockEnd", "value": "Spacing", - "description": "Vertical end spacing around children", + "description": "Vertical end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.", "isOptional": true }, { @@ -10147,7 +10147,7 @@ "syntaxKind": "PropertySignature", "name": "paddingInlineStart", "value": "Spacing", - "description": "Horizontal start spacing around children", + "description": "Horizontal start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.", "isOptional": true }, { @@ -10155,7 +10155,7 @@ "syntaxKind": "PropertySignature", "name": "paddingInlineEnd", "value": "Spacing", - "description": "Horizontal end spacing around children", + "description": "Horizontal end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.", "isOptional": true }, { @@ -10183,7 +10183,7 @@ "isOptional": true } ], - "value": "export interface BoxProps {\n /** HTML Element type */\n as?: Element;\n /** Background color */\n background?: BackgroundColors;\n /** Border style */\n border?: BorderTokenAlias;\n /** Vertical end border style */\n borderBlockEnd?: BorderTokenAlias;\n /** Horizontal start border style */\n borderInlineStart?: BorderTokenAlias;\n /** Horizontal end border style */\n borderInlineEnd?: BorderTokenAlias;\n /** Vertical start border style */\n borderBlockStart?: BorderTokenAlias;\n /** Border radius */\n borderRadius?: BorderRadiusTokenScale;\n /** Vertical end horizontal start border radius */\n borderRadiusEndStart?: BorderRadiusTokenScale;\n /** Vertical end horizontal end border radius */\n borderRadiusEndEnd?: BorderRadiusTokenScale;\n /** Vertical start horizontal start border radius */\n borderRadiusStartStart?: BorderRadiusTokenScale;\n /** Verital start horizontal end border radius */\n borderRadiusStartEnd?: BorderRadiusTokenScale;\n /** Border width */\n borderWidth?: ShapeBorderWidthScale;\n /** Vertical start border width */\n borderBlockStartWidth?: ShapeBorderWidthScale;\n /** Vertical end border width */\n borderBlockEndWidth?: ShapeBorderWidthScale;\n /** Horizontal start border width */\n borderInlineStartWidth?: ShapeBorderWidthScale;\n /** Horizontal end border width */\n borderInlineEndWidth?: ShapeBorderWidthScale;\n /** Color of children */\n color?: ColorTokenScale;\n /** HTML id attribute */\n id?: string;\n /** Set minimum height of container */\n minHeight?: string;\n /** Set minimum width of container */\n minWidth?: string;\n /** Set maximum width of container */\n maxWidth?: string;\n /** Clip horizontal content of children */\n overflowX?: Overflow;\n /** Clip vertical content of children */\n overflowY?: Overflow;\n /** Spacing around children */\n padding?: Spacing;\n /** Vertical start spacing around children */\n paddingBlockStart?: Spacing;\n /** Vertical end spacing around children */\n paddingBlockEnd?: Spacing;\n /** Horizontal start spacing around children */\n paddingInlineStart?: Spacing;\n /** Horizontal end spacing around children */\n paddingInlineEnd?: Spacing;\n /** Shadow */\n shadow?: DepthShadowAlias;\n /** Set width of container */\n width?: string;\n /** Elements to display inside box */\n children?: React.ReactNode;\n}" + "value": "export interface BoxProps {\n /** HTML Element type */\n as?: Element;\n /** Background color */\n background?: BackgroundColors;\n /** Border style */\n border?: BorderTokenAlias;\n /** Vertical end border style */\n borderBlockEnd?: BorderTokenAlias;\n /** Horizontal start border style */\n borderInlineStart?: BorderTokenAlias;\n /** Horizontal end border style */\n borderInlineEnd?: BorderTokenAlias;\n /** Vertical start border style */\n borderBlockStart?: BorderTokenAlias;\n /** Border radius */\n borderRadius?: BorderRadiusTokenScale;\n /** Vertical end horizontal start border radius */\n borderRadiusEndStart?: BorderRadiusTokenScale;\n /** Vertical end horizontal end border radius */\n borderRadiusEndEnd?: BorderRadiusTokenScale;\n /** Vertical start horizontal start border radius */\n borderRadiusStartStart?: BorderRadiusTokenScale;\n /** Verital start horizontal end border radius */\n borderRadiusStartEnd?: BorderRadiusTokenScale;\n /** Border width */\n borderWidth?: ShapeBorderWidthScale;\n /** Vertical start border width */\n borderBlockStartWidth?: ShapeBorderWidthScale;\n /** Vertical end border width */\n borderBlockEndWidth?: ShapeBorderWidthScale;\n /** Horizontal start border width */\n borderInlineStartWidth?: ShapeBorderWidthScale;\n /** Horizontal end border width */\n borderInlineEndWidth?: ShapeBorderWidthScale;\n /** Color of children */\n color?: ColorTokenScale;\n /** HTML id attribute */\n id?: string;\n /** Set minimum height of container */\n minHeight?: string;\n /** Set minimum width of container */\n minWidth?: string;\n /** Set maximum width of container */\n maxWidth?: string;\n /** Clip horizontal content of children */\n overflowX?: Overflow;\n /** Clip vertical content of children */\n overflowY?: Overflow;\n /** Spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * padding='4'\n * padding={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n padding?: Spacing;\n /** Vertical start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingBlockStart='4'\n * paddingBlockStart={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingBlockStart?: Spacing;\n /** Vertical end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingBlockEnd='4'\n * paddingBlockEnd={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingBlockEnd?: Spacing;\n /** Horizontal start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingInlineStart='4'\n * paddingInlineStart={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingInlineStart?: Spacing;\n /** Horizontal end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingInlineEnd='4'\n * paddingInlineEnd={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingInlineEnd?: Spacing;\n /** Shadow */\n shadow?: DepthShadowAlias;\n /** Set width of container */\n width?: string;\n /** Elements to display inside box */\n children?: React.ReactNode;\n}" } }, "BreadcrumbsProps": { @@ -10913,6 +10913,24 @@ "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", @@ -11003,24 +11021,6 @@ "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", @@ -22009,1142 +22009,1150 @@ "value": "export interface PortalsManager {\n container: PortalsContainerElement;\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", + "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/ButtonGroup/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", "syntaxKind": "PropertySignature", - "name": "button", - "value": "React.ReactElement", + "name": "showable", + "value": "MenuActionDescriptor[]", "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/Actions/Actions.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Item content", - "isOptional": true + "name": "rolledUp", + "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", + "description": "" } ], - "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", + "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", "description": "", "members": [ { - "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden menu description for screen readers", "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/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Content to display inside the item", + "name": "active", + "value": "boolean", + "description": "Whether or not the menu is open", "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": "", + "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", "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/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": "label", - "value": "string", - "description": "" + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "onClose", + "value": "(title: string) => void", + "description": "Callback for closing the MenuGroup by title" }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "getOffsetWidth", + "value": "(width: number) => void", + "description": "Callback for getting the offsetWidth of the MenuGroup", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "", + "name": "sections", + "value": "readonly ActionListSection[]", + "description": "Collection of sectioned action items", "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": "accessibilityLabel", + "name": "title", "value": "string", - "description": "", + "description": "Menu group title" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "actions", + "value": "ActionListItemDescriptor[]", + "description": "List of actions" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "any", + "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": "selected", - "value": "boolean", - "description": "", + "name": "details", + "value": "React.ReactNode", + "description": "Action details", "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": "exactMatch", + "name": "disabled", "value": "boolean", - "description": "", + "description": "Disables action button", "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": "new", - "value": "boolean", - "description": "", + "name": "index", + "value": "number", + "description": "Zero-indexed numerical position. Overrides the group's order in the menu.", "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": "subNavigationItems", - "value": "SubNavigationItem[]", + "name": "onActionAnyItem", + "value": "() => void", + "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 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", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "Accessibilty label", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", "syntaxKind": "PropertySignature", - "name": "secondaryAction", - "value": "SecondaryAction", + "name": "items", + "value": "ActionListItemDescriptor[]", + "description": "Collection of actions for the list", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "syntaxKind": "PropertySignature", + "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}" + } + }, + "SecondaryAction": { + "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "name": "SecondaryAction", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "PropertySignature", + "name": "helpText", + "value": "React.ReactNode", "description": "", "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", + "name": "onAction", "value": "() => void", "description": "", "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", - "value": "() => void", + "name": "getOffsetWidth", + "value": "(width: number) => void", "description": "", "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": "expanded", - "value": "boolean", - "description": "", + "name": "children", + "value": "string | string[]", + "description": "The content to display inside 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": "shouldResizeIcon", + "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/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "", + "name": "destructive", + "value": "boolean", + "description": "Indicates a dangerous or potentially negative action", "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": "matches", - "value": "boolean", - "description": "", - "isOptional": true + "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/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "matchPaths", - "value": "string[]", - "description": "", + "name": "textAlign", + "value": "\"start\" | \"end\" | \"center\" | \"left\" | \"right\"", + "description": "Changes the inner text alignment of the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "excludePaths", - "value": "string[]", - "description": "", + "name": "outline", + "value": "boolean", + "description": "Gives the button a subtle alternative to the default button styling, appropriate for certain backdrops", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "external", + "name": "fullWidth", "value": "boolean", - "description": "", + "description": "Allows the button to grow to the width of its container", "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", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Elements to display inside item", + "name": "disclosure", + "value": "boolean | \"up\" | \"down\" | \"select\"", + "description": "Displays the button with a disclosure icon. Defaults to `down` when set to true", "isOptional": true }, { - "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "fill", + "name": "plain", "value": "boolean", - "description": "Fill the remaining horizontal space in the stack with the item", + "description": "Renders a button that looks like a link", "isOptional": true - } - ], - "value": "export interface ItemProps {\n /** Elements to display inside item */\n children?: React.ReactNode;\n /** Fill the remaining horizontal space in the stack with the item */\n fill?: boolean;\n /**\n * @default false\n */\n}" - }, - "polaris-react/src/components/Tabs/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "" }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "focused", + "name": "monochrome", "value": "boolean", - "description": "" + "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/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "panelID", - "value": "string", - "description": "", + "name": "removeUnderline", + "value": "boolean", + "description": "Removes underline from button text (including on interaction) when `monochrome` and `plain` are true", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "name": "icon", + "value": "any", + "description": "Icon to display to the left of the button content", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "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/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "", + "name": "dataPrimaryLink", + "value": "boolean", + "description": "Indicates whether or not the button is the primary navigation link when rendered inside of an `IndexTable.Row`", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "", - "isOptional": true - } - ], - "value": "export interface ItemProps {\n id: string;\n focused: boolean;\n panelID?: string;\n children?: React.ReactNode;\n url?: string;\n accessibilityLabel?: string;\n onClick?(): void;\n}" - }, - "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/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": "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/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", - "syntaxKind": "PropertySignature", - "name": "hasMultipleSections", - "value": "boolean", - "description": "Should there be multiple sections" }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "actionRole", + "name": "url", "value": "string", - "description": "Defines a specific role attribute for each action in the list", + "description": "A destination to link to, rendered in the href attribute of a link", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any item is clicked or keypressed", + "name": "external", + "value": "boolean", + "description": "Forces url to open in a new tab", "isOptional": true - } - ], - "value": "export interface SectionProps {\n /** Section of action items */\n section: ActionListSection;\n /** Should there be multiple sections */\n hasMultipleSections: boolean;\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'option' | 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" - }, - "polaris-react/src/components/Layout/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "name": "download", + "value": "string | boolean", + "description": "Tells the browser to download the url instead of opening it. Provides a hint for the downloaded filename if it is a string value", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "secondary", + "name": "submit", "value": "boolean", - "description": "", + "description": "Allows the button to submit a form", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "fullWidth", + "name": "disabled", "value": "boolean", - "description": "", + "description": "Disables the button, disallowing merchant interaction", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "oneHalf", + "name": "loading", "value": "boolean", - "description": "", + "description": "Replaces button text with a spinner while a background action is being performed", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "oneThird", + "name": "pressed", "value": "boolean", - "description": "", + "description": "Sets the button in a pressed state", "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", - "value": "boolean", - "description": "", + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden text for screen readers", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", - "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/Listbox/components/Section/Section.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": [ - { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "name": "ariaControls", + "value": "string", + "description": "Id of the element the button controls", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "flush", + "name": "ariaExpanded", "value": "boolean", - "description": "", + "description": "Tells screen reader the controlled element is expanded", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "subdued", - "value": "boolean", - "description": "", + "name": "ariaDescribedBy", + "value": "string", + "description": "Indicates the ID of the element that describes the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "titleHidden", - "value": "boolean", - "description": "", + "name": "ariaChecked", + "value": "\"false\" | \"true\"", + "description": "Indicates the current checked state of the button when acting as a toggle or switch", "isOptional": true - } - ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\n flush?: boolean;\n subdued?: boolean;\n titleHidden?: boolean;\n}" - }, - "polaris-react/src/components/Navigation/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "items", - "value": "ItemProps[]", - "description": "" }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "Callback when clicked", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onFocus", + "value": "() => void", + "description": "Callback when button becomes focussed", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "fill", - "value": "boolean", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onBlur", + "value": "() => void", + "description": "Callback when focus leaves button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "rollup", - "value": "{ after: number; view: string; hide: string; activePath: string; }", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyPress", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keypress event is registered on the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "action", - "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyUp", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keyup event is registered on the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "separator", - "value": "boolean", - "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/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onMouseEnter", + "value": "() => void", + "description": "Callback when mouse enter", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onTouchStart", + "value": "() => void", + "description": "Callback when element is touched", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onPointerDown", + "value": "() => void", + "description": "Callback when pointerdown event is being triggered", "isOptional": true } ], - "value": "export interface SectionProps {\n 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}" + "value": "interface SecondaryAction extends ButtonProps {\n helpText?: React.ReactNode;\n onAction?(): void;\n getOffsetWidth?(width: number): void;\n}" }, - "polaris-react/src/components/Popover/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", - "name": "SectionProps", + "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/Popover/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", + "name": "url", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.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": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "tooltip", + "value": "TooltipProps", "description": "", "isOptional": true } ], - "value": "export interface SectionProps {\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}" } }, - "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", - "syntaxKind": "PropertySignature", - "name": "showable", - "value": "MenuActionDescriptor[]", - "description": "" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "filePath": "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "rolledUp", - "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", + "name": "button", + "value": "React.ReactElement", "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", + "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/ActionMenu/components/RollupActions/RollupActions.tsx", + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Accessibilty label", - "isOptional": true + "name": "position", + "value": "ItemPosition", + "description": "Position of the item" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "items", - "value": "ActionListItemDescriptor[]", - "description": "Collection of actions for the list", + "name": "children", + "value": "React.ReactNode", + "description": "Item content", "isOptional": true - }, + } + ], + "value": "export interface ItemProps {\n /** Position of the item */\n position: ItemPosition;\n /** Item content */\n children?: React.ReactNode;\n}" + }, + "polaris-react/src/components/FormLayout/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "sections", - "value": "ActionListSection[]", - "description": "Collection of sectioned action items", + "name": "children", + "value": "React.ReactNode", + "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}" - } - }, - "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 children?: React.ReactNode;\n}" + }, + "polaris-react/src/components/List/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", + "name": "ItemProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Visually hidden menu description for screen readers", + "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/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "active", - "value": "boolean", - "description": "Whether or not the menu is open", - "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", - "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/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "onClose", - "value": "(title: string) => void", - "description": "Callback for closing the MenuGroup by title" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "getOffsetWidth", - "value": "(width: number) => void", - "description": "Callback for getting the offsetWidth of the MenuGroup", + "name": "icon", + "value": "any", + "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": "badge", + "value": "ReactNode", + "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", + "name": "label", "value": "string", - "description": "Menu group title" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "actions", - "value": "ActionListItemDescriptor[]", - "description": "List of actions" + "description": "" }, { - "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": "disabled", + "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": "accessibilityLabel", + "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", + "name": "selected", "value": "boolean", - "description": "Disables action button", + "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": "exactMatch", + "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": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any action takes place", + "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": "badge", - "value": "{ status: \"new\"; content: string; }", + "name": "subNavigationItems", + "value": "SubNavigationItem[]", "description": "", "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}" - } - }, - "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/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "helpText", - "value": "React.ReactNode", + "name": "secondaryAction", + "value": "SecondaryAction", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "MethodSignature", - "name": "onAction", + "name": "onClick", "value": "() => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "MethodSignature", - "name": "getOffsetWidth", - "value": "(width: number) => void", + "name": "onToggleExpandedState", + "value": "() => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "string | string[]", - "description": "The content to display inside the button", + "name": "expanded", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "primary", + "name": "shouldResizeIcon", "value": "boolean", - "description": "Provides extra visual weight and identifies the primary action in a set of buttons", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "destructive", + "name": "truncateText", "value": "boolean", - "description": "Indicates a dangerous or potentially negative action", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "size", - "value": "\"medium\" | \"large\" | \"slim\"", - "description": "Changes the size of the button, giving it more or less padding", - "isOptional": true, - "defaultValue": "'medium'" + "name": "url", + "value": "string", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "textAlign", - "value": "\"start\" | \"end\" | \"center\" | \"left\" | \"right\"", - "description": "Changes the inner text alignment of the button", + "name": "matches", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "outline", - "value": "boolean", - "description": "Gives the button a subtle alternative to the default button styling, appropriate for certain backdrops", + "name": "matchPaths", + "value": "string[]", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "fullWidth", - "value": "boolean", - "description": "Allows the button to grow to the width of its container", + "name": "excludePaths", + "value": "string[]", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "disclosure", - "value": "boolean | \"up\" | \"down\" | \"select\"", - "description": "Displays the button with a disclosure icon. Defaults to `down` when set to true", + "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 truncateText?: boolean;\n}" + }, + "polaris-react/src/components/Stack/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Elements to display inside item", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "plain", + "name": "fill", "value": "boolean", - "description": "Renders a button that looks like a link", + "description": "Fill the remaining horizontal space in the stack with the item", "isOptional": true + } + ], + "value": "export interface ItemProps {\n /** Elements to display inside item */\n children?: React.ReactNode;\n /** Fill the remaining horizontal space in the stack with the item */\n fill?: boolean;\n /**\n * @default false\n */\n}" + }, + "polaris-react/src/components/Tabs/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "monochrome", + "name": "focused", "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": "" + }, + { + "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/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.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": "React.ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "Icon to display to the left of the button content", + "name": "url", + "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": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "", + "isOptional": true + } + ], + "value": "export interface ItemProps {\n id: string;\n focused: boolean;\n panelID?: string;\n children?: React.ReactNode;\n url?: string;\n accessibilityLabel?: string;\n onClick?(): void;\n}" + }, + "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", + "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/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "connectedDisclosure", - "value": "ConnectedDisclosure", - "description": "Disclosure button connected right of the button. Toggles a popover action list.", - "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": "dataPrimaryLink", + "name": "hasMultipleSections", "value": "boolean", - "description": "Indicates whether or not the button is the primary navigation link when rendered inside of an `IndexTable.Row`", - "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": "id", + "name": "actionRole", "value": "string", - "description": "A unique identifier for the button", + "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": "url", - "value": "string", - "description": "A destination to link to, rendered in the href attribute of a link", + "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": "external", - "value": "boolean", - "description": "Forces url to open in a new tab", + "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": "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": "secondary", + "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": "submit", + "name": "fullWidth", "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/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", + "name": "oneHalf", "value": "boolean", - "description": "Disables the button, disallowing merchant interaction", + "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": "loading", + "name": "oneThird", "value": "boolean", - "description": "Replaces button text with a spinner while a background action is being performed", + "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": "pressed", + "name": "divider", "value": "boolean", - "description": "Sets the button in a pressed state", + "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": "accessibilityLabel", - "value": "string", - "description": "Visually hidden text for screen readers", + "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": "role", - "value": "string", - "description": "A valid WAI-ARIA role to define the semantic value of this element", - "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": "ariaControls", - "value": "string", - "description": "Id of the element the button controls", + "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": "ariaExpanded", + "name": "flush", "value": "boolean", - "description": "Tells screen reader the controlled element is expanded", + "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": "ariaDescribedBy", - "value": "string", - "description": "Indicates the ID of the element that describes 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": "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/ActionMenu/components/SecondaryAction/SecondaryAction.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", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyUp", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keyup event is registered on the button", - "isOptional": true - }, - { - "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/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onMouseEnter", - "value": "() => void", - "description": "Callback when mouse enter", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onTouchStart", - "value": "() => void", - "description": "Callback when element is touched", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onPointerDown", - "value": "() => void", - "description": "Callback when pointerdown event is being triggered", + "name": "titleHidden", + "value": "boolean", + "description": "", "isOptional": true } ], - "value": "interface SecondaryAction extends ButtonProps {\n helpText?: React.ReactNode;\n onAction?(): void;\n getOffsetWidth?(width: number): void;\n}" + "value": "export interface SectionProps {\n children?: React.ReactNode;\n flush?: boolean;\n subdued?: boolean;\n titleHidden?: boolean;\n}" }, - "polaris-react/src/components/Navigation/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "SecondaryAction", + "polaris-react/src/components/Navigation/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "name": "SectionProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", + "name": "items", + "value": "ItemProps[]", "description": "" }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "any", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "" + "name": "fill", + "value": "boolean", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "" + "name": "rollup", + "value": "{ after: number; view: string; hide: string; activePath: string; }", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "action", + "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "tooltip", - "value": "TooltipProps", + "name": "separator", + "value": "boolean", "description": "", "isOptional": true } ], - "value": "interface SecondaryAction {\n url: string;\n accessibilityLabel: string;\n icon: IconProps['source'];\n onClick?(): void;\n tooltip?: TooltipProps;\n}" + "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}" } }, "MappedAction": { @@ -23372,6 +23380,40 @@ "description": "" } }, + "CardHeaderProps": { + "polaris-react/src/components/Card/components/Header/Header.tsx": { + "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", + "name": "CardHeaderProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", + "syntaxKind": "PropertySignature", + "name": "actions", + "value": "DisableableAction[]", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "export interface CardHeaderProps {\n title?: React.ReactNode;\n actions?: DisableableAction[];\n children?: React.ReactNode;\n}" + } + }, "BulkActionsMenuProps": { "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx": { "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", @@ -23459,40 +23501,6 @@ "value": "export interface BulkActionsMenuProps extends MenuGroupDescriptor {\n isNewBadgeInBadgeActions: boolean;\n}" } }, - "CardHeaderProps": { - "polaris-react/src/components/Card/components/Header/Header.tsx": { - "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", - "name": "CardHeaderProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", - "syntaxKind": "PropertySignature", - "name": "actions", - "value": "DisableableAction[]", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "export interface CardHeaderProps {\n title?: React.ReactNode;\n actions?: DisableableAction[];\n children?: React.ReactNode;\n}" - } - }, "CardSectionProps": { "polaris-react/src/components/Card/components/Section/Section.tsx": { "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", @@ -23697,6 +23705,15 @@ "value": "export interface SlidableProps {\n draggerX?: number;\n draggerY?: number;\n onChange(position: Position): void;\n onDraggerHeight?(height: number): 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": "" + } + }, "CellProps": { "polaris-react/src/components/DataTable/components/Cell/Cell.tsx": { "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", @@ -23995,15 +24012,6 @@ "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", @@ -24260,6 +24268,37 @@ "value": "export interface MonthProps {\n focusedDate?: Date;\n selected?: Range;\n hoverDate?: Date;\n month: number;\n year: number;\n disableDatesBefore?: Date;\n disableDatesAfter?: Date;\n disableSpecificDates?: Date[];\n allowRange?: boolean;\n weekStartsOn: number;\n accessibilityLabelPrefixes: [string | undefined, string];\n onChange?(date: Range): void;\n onHover?(hoverEnd: Date): void;\n onFocus?(date: Date): void;\n}" } }, + "WeekdayProps": { + "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx": { + "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", + "name": "WeekdayProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", + "syntaxKind": "PropertySignature", + "name": "current", + "value": "boolean", + "description": "" + } + ], + "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", @@ -24286,35 +24325,46 @@ "value": "export interface FileUploadProps {\n actionTitle?: string;\n actionHint?: string;\n}" } }, - "WeekdayProps": { - "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx": { - "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", - "name": "WeekdayProps", + "GroupProps": { + "polaris-react/src/components/FormLayout/components/Group/Group.tsx": { + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "name": "GroupProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "" + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "syntaxKind": "PropertySignature", + "name": "condensed", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", "syntaxKind": "PropertySignature", "name": "title", "value": "string", - "description": "" + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", "syntaxKind": "PropertySignature", - "name": "current", - "value": "boolean", - "description": "" + "name": "helpText", + "value": "React.ReactNode", + "description": "", + "isOptional": true } ], - "value": "export interface WeekdayProps {\n label: string;\n title: string;\n current: boolean;\n}" + "value": "export interface GroupProps {\n children?: React.ReactNode;\n condensed?: boolean;\n title?: string;\n helpText?: React.ReactNode;\n}" } }, "PopoverableAction": { @@ -24489,55 +24539,13 @@ "name": "ComputedProperty", "description": "", "members": [ - { - "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/ConnectedFilterControl.tsx", - "name": "[key: string]", - "value": "number" - } - ], - "value": "interface ComputedProperty {\n [key: string]: number;\n}" - } - }, - "GroupProps": { - "polaris-react/src/components/FormLayout/components/Group/Group.tsx": { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "name": "GroupProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "syntaxKind": "PropertySignature", - "name": "condensed", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "syntaxKind": "PropertySignature", - "name": "helpText", - "value": "React.ReactNode", - "description": "", - "isOptional": true + { + "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/ConnectedFilterControl.tsx", + "name": "[key: string]", + "value": "number" } ], - "value": "export interface GroupProps {\n children?: React.ReactNode;\n condensed?: boolean;\n title?: string;\n helpText?: React.ReactNode;\n}" + "value": "interface ComputedProperty {\n [key: string]: number;\n}" } }, "AnimationType": { @@ -24801,71 +24809,6 @@ "value": "export interface AnnotatedSectionProps {\n children?: React.ReactNode;\n title?: React.ReactNode;\n description?: React.ReactNode;\n id?: string;\n}" } }, - "ActionProps": { - "polaris-react/src/components/Listbox/components/Action/Action.tsx": { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", - "name": "ActionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "any", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", - "syntaxKind": "PropertySignature", - "name": "selected", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", - "syntaxKind": "PropertySignature", - "name": "divider", - "value": "boolean", - "description": "", - "isOptional": true - } - ], - "value": "interface ActionProps extends OptionProps {\n icon?: IconProps['source'];\n}" - } - }, "HeaderProps": { "polaris-react/src/components/Listbox/components/Header/Header.tsx": { "filePath": "polaris-react/src/components/Listbox/components/Header/Header.tsx", @@ -25040,6 +24983,71 @@ "value": "export interface HeaderProps extends TitleProps {\n /** Visually hide the title */\n titleHidden?: boolean;\n /** Primary page-level action */\n primaryAction?: PrimaryAction | React.ReactNode;\n /** Page-level pagination */\n pagination?: PaginationProps;\n /** Collection of breadcrumbs */\n breadcrumbs?: BreadcrumbsProps['breadcrumbs'];\n /** Collection of secondary page-level actions */\n secondaryActions?: MenuActionDescriptor[] | React.ReactNode;\n /** Collection of page-level groups of secondary actions */\n actionGroups?: MenuGroupDescriptor[];\n /** @deprecated Additional navigation markup */\n additionalNavigation?: React.ReactNode;\n // Additional meta data\n additionalMetadata?: React.ReactNode | 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}" } }, + "ActionProps": { + "polaris-react/src/components/Listbox/components/Action/Action.tsx": { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "name": "ActionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "any", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "any", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "divider", + "value": "boolean", + "description": "", + "isOptional": true + } + ], + "value": "interface ActionProps extends OptionProps {\n icon?: IconProps['source'];\n}" + } + }, "OptionProps": { "polaris-react/src/components/Listbox/components/Option/Option.tsx": { "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", @@ -25589,6 +25597,65 @@ ] } }, + "PaneProps": { + "polaris-react/src/components/Popover/components/Pane/Pane.tsx": { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "name": "PaneProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "fixed", + "value": "boolean", + "description": "Fix the pane to the top of the popover", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "sectioned", + "value": "boolean", + "description": "Automatically wrap children in padded sections", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The pane content", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "height", + "value": "string", + "description": "Sets a fixed height and max-height on the Scrollable", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "MethodSignature", + "name": "onScrolledToBottom", + "value": "() => void", + "description": "Callback when the bottom of the popover is reached by mouse or keyboard", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "captureOverscroll", + "value": "boolean", + "description": "Prevents page scrolling when the end of the scrollable Popover content is reached", + "isOptional": true, + "defaultValue": "false" + } + ], + "value": "export interface PaneProps {\n /** Fix the pane to the top of the popover */\n fixed?: boolean;\n /** Automatically wrap children in padded sections */\n sectioned?: boolean;\n /** The pane content */\n children?: React.ReactNode;\n /** Sets a fixed height and max-height on the Scrollable */\n height?: string;\n /** Callback when the bottom of the popover is reached by mouse or keyboard */\n onScrolledToBottom?(): void;\n /**\n * Prevents page scrolling when the end of the scrollable Popover content is reached\n * @default false\n */\n captureOverscroll?: boolean;\n}" + } + }, "PrimaryAction": { "polaris-react/src/components/Page/components/Header/Header.tsx": { "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", @@ -25704,70 +25771,11 @@ "syntaxKind": "PropertySignature", "name": "helpText", "value": "React.ReactNode", - "description": "Text content to render in a tooltip", - "isOptional": true - } - ], - "value": "interface PrimaryAction\n extends DestructableAction,\n DisableableAction,\n LoadableAction,\n IconableAction,\n TooltipAction {\n /** Provides extra visual weight and identifies the primary action in a set of buttons */\n primary?: boolean;\n}" - } - }, - "PaneProps": { - "polaris-react/src/components/Popover/components/Pane/Pane.tsx": { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "name": "PaneProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "fixed", - "value": "boolean", - "description": "Fix the pane to the top of the popover", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "sectioned", - "value": "boolean", - "description": "Automatically wrap children in padded sections", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The pane content", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "height", - "value": "string", - "description": "Sets a fixed height and max-height on the Scrollable", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "MethodSignature", - "name": "onScrolledToBottom", - "value": "() => void", - "description": "Callback when the bottom of the popover is reached by mouse or keyboard", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "captureOverscroll", - "value": "boolean", - "description": "Prevents page scrolling when the end of the scrollable Popover content is reached", - "isOptional": true, - "defaultValue": "false" + "description": "Text content to render in a tooltip", + "isOptional": true } ], - "value": "export interface PaneProps {\n /** Fix the pane to the top of the popover */\n fixed?: boolean;\n /** Automatically wrap children in padded sections */\n sectioned?: boolean;\n /** The pane content */\n children?: React.ReactNode;\n /** Sets a fixed height and max-height on the Scrollable */\n height?: string;\n /** Callback when the bottom of the popover is reached by mouse or keyboard */\n onScrolledToBottom?(): void;\n /**\n * Prevents page scrolling when the end of the scrollable Popover content is reached\n * @default false\n */\n captureOverscroll?: boolean;\n}" + "value": "interface PrimaryAction\n extends DestructableAction,\n DisableableAction,\n LoadableAction,\n IconableAction,\n TooltipAction {\n /** Provides extra visual weight and identifies the primary action in a set of buttons */\n primary?: boolean;\n}" } }, "PopoverCloseSource": { @@ -26493,6 +26501,15 @@ "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}" } }, + "HandleStepFn": { + "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx": { + "filePath": "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "HandleStepFn", + "value": "(step: number) => void", + "description": "" + } + }, "ResizerProps": { "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx": { "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", @@ -26534,13 +26551,65 @@ "value": "export interface ResizerProps {\n contents?: string;\n currentHeight?: number | null;\n minimumLines?: number;\n onHeightChange(height: number): void;\n}" } }, - "HandleStepFn": { - "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx": { - "filePath": "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "HandleStepFn", - "value": "(step: number) => void", - "description": "" + "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}" } }, "TooltipOverlayProps": { @@ -26613,67 +26682,6 @@ "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}" } }, - "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}" - } - }, "SearchProps": { "polaris-react/src/components/TopBar/components/Search/Search.tsx": { "filePath": "polaris-react/src/components/TopBar/components/Search/Search.tsx", @@ -26873,6 +26881,39 @@ "value": "export interface UserMenuProps {\n /** An array of action objects that are rendered inside of a popover triggered by this menu */\n actions: {items: IconableAction[]}[];\n /** Accepts a message that facilitates direct, urgent communication with the merchant through the user menu */\n message?: MenuProps['message'];\n /** A string detailing the merchant’s full name to be displayed in the user menu */\n name: string;\n /** A string allowing further detail on the merchant’s name displayed in the user menu */\n detail?: string;\n /** A string that provides the accessibility labeling */\n accessibilityLabel?: string;\n /** The merchant’s initials, rendered in place of an avatar image when not provided */\n initials: AvatarProps['initials'];\n /** An avatar image representing the merchant */\n avatar?: AvatarProps['source'];\n /** A boolean property indicating whether the user menu is currently open */\n open: boolean;\n /** A callback function to handle opening and closing the user menu */\n onToggle(): void;\n}" } }, + "SecondaryProps": { + "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "name": "SecondaryProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "syntaxKind": "PropertySignature", + "name": "expanded", + "value": "boolean", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "interface SecondaryProps {\n expanded: boolean;\n children?: React.ReactNode;\n id?: string;\n}" + } + }, "DiscardConfirmationModalProps": { "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx": { "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", @@ -26904,37 +26945,46 @@ "value": "export interface DiscardConfirmationModalProps {\n open: boolean;\n onDiscard(): void;\n onCancel(): void;\n}" } }, - "SecondaryProps": { - "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", - "name": "SecondaryProps", + "TitleProps": { + "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx": { + "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", + "name": "TitleProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", "syntaxKind": "PropertySignature", - "name": "expanded", - "value": "boolean", - "description": "" + "name": "title", + "value": "string", + "description": "Page title, in large type", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", "syntaxKind": "PropertySignature", - "name": "children", + "name": "subtitle", + "value": "string", + "description": "Page subtitle, in regular type", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", + "syntaxKind": "PropertySignature", + "name": "titleMetadata", "value": "React.ReactNode", - "description": "", + "description": "Important and non-interactive status information shown immediately after the title.", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "", + "name": "compactTitle", + "value": "boolean", + "description": "Removes spacing between title and subtitle", "isOptional": true } ], - "value": "interface SecondaryProps {\n expanded: boolean;\n children?: React.ReactNode;\n id?: string;\n}" + "value": "export interface TitleProps {\n /** Page title, in large type */\n title?: string;\n /** Page subtitle, in regular type*/\n subtitle?: string;\n /** Important and non-interactive status information shown immediately after the title. */\n titleMetadata?: React.ReactNode;\n /** Removes spacing between title and subtitle */\n compactTitle?: boolean;\n}" } }, "MessageProps": { @@ -26982,47 +27032,5 @@ ], "value": "export interface MessageProps {\n title: string;\n description: string;\n action: {onClick(): void; content: string};\n link: {to: string; content: string};\n badge?: {content: string; status: BadgeProps['status']};\n}" } - }, - "TitleProps": { - "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx": { - "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", - "name": "TitleProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "Page title, in large type", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "Page subtitle, in regular type", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", - "syntaxKind": "PropertySignature", - "name": "titleMetadata", - "value": "React.ReactNode", - "description": "Important and non-interactive status information shown immediately after the title.", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", - "syntaxKind": "PropertySignature", - "name": "compactTitle", - "value": "boolean", - "description": "Removes spacing between title and subtitle", - "isOptional": true - } - ], - "value": "export interface TitleProps {\n /** Page title, in large type */\n title?: string;\n /** Page subtitle, in regular type*/\n subtitle?: string;\n /** Important and non-interactive status information shown immediately after the title. */\n titleMetadata?: React.ReactNode;\n /** Removes spacing between title and subtitle */\n compactTitle?: boolean;\n}" - } } } \ No newline at end of file From ea9bbed22841f659061d42b4ca89b9d7507a7b9a Mon Sep 17 00:00:00 2001 From: aveline Date: Thu, 17 Nov 2022 14:50:33 -0800 Subject: [PATCH 4/5] changeset --- .changeset/new-birds-pretend.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .changeset/new-birds-pretend.md diff --git a/.changeset/new-birds-pretend.md b/.changeset/new-birds-pretend.md new file mode 100644 index 00000000000..0fce819198a --- /dev/null +++ b/.changeset/new-birds-pretend.md @@ -0,0 +1,6 @@ +--- +'@shopify/polaris': patch +'polaris.shopify.com': patch +--- + +Fixed typo in `responsive-props` mixin. Added jsdoc examples for responsive spacing props in `Box`. From 17f13813d47b83c960153ad29e77313e608ca2ab Mon Sep 17 00:00:00 2001 From: aveline Date: Fri, 18 Nov 2022 08:09:24 -0800 Subject: [PATCH 5/5] Update props.json --- polaris.shopify.com/src/data/props.json | 3004 +++++++++++------------ 1 file changed, 1502 insertions(+), 1502 deletions(-) diff --git a/polaris.shopify.com/src/data/props.json b/polaris.shopify.com/src/data/props.json index d5870eada95..60165a62dd8 100644 --- a/polaris.shopify.com/src/data/props.json +++ b/polaris.shopify.com/src/data/props.json @@ -3791,30 +3791,6 @@ "value": "interface MappedActionContextType {\n role?: string;\n url?: string;\n external?: boolean;\n onAction?(): void;\n destructive?: boolean;\n}" } }, - "FeaturesConfig": { - "polaris-react/src/utilities/features/types.ts": { - "filePath": "polaris-react/src/utilities/features/types.ts", - "name": "FeaturesConfig", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/utilities/features/types.ts", - "name": "[key: string]", - "value": "boolean" - } - ], - "value": "export interface FeaturesConfig {\n [key: string]: boolean;\n}" - } - }, - "Features": { - "polaris-react/src/utilities/features/types.ts": { - "filePath": "polaris-react/src/utilities/features/types.ts", - "name": "Features", - "description": "", - "members": [], - "value": "export interface Features {}" - } - }, "IdGenerator": { "polaris-react/src/utilities/unique-id/unique-id-factory.ts": { "filePath": "polaris-react/src/utilities/unique-id/unique-id-factory.ts", @@ -3850,6 +3826,30 @@ "value": "interface Options {\n trapping: boolean;\n}" } }, + "FeaturesConfig": { + "polaris-react/src/utilities/features/types.ts": { + "filePath": "polaris-react/src/utilities/features/types.ts", + "name": "FeaturesConfig", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/utilities/features/types.ts", + "name": "[key: string]", + "value": "boolean" + } + ], + "value": "export interface FeaturesConfig {\n [key: string]: boolean;\n}" + } + }, + "Features": { + "polaris-react/src/utilities/features/types.ts": { + "filePath": "polaris-react/src/utilities/features/types.ts", + "name": "Features", + "description": "", + "members": [], + "value": "export interface Features {}" + } + }, "Logo": { "polaris-react/src/utilities/frame/types.ts": { "filePath": "polaris-react/src/utilities/frame/types.ts", @@ -4296,6 +4296,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}" + } + }, "LinkLikeComponentProps": { "polaris-react/src/utilities/link/types.ts": { "filePath": "polaris-react/src/utilities/link/types.ts", @@ -7227,93 +7305,6 @@ "description": "" } }, - "NavigableOption": { - "polaris-react/src/utilities/listbox/types.ts": { - "filePath": "polaris-react/src/utilities/listbox/types.ts", - "name": "NavigableOption", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/utilities/listbox/types.ts", - "syntaxKind": "PropertySignature", - "name": "domId", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/utilities/listbox/types.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/utilities/listbox/types.ts", - "syntaxKind": "PropertySignature", - "name": "element", - "value": "HTMLElement", - "description": "" - }, - { - "filePath": "polaris-react/src/utilities/listbox/types.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "" - }, - { - "filePath": "polaris-react/src/utilities/listbox/types.ts", - "syntaxKind": "PropertySignature", - "name": "isAction", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/utilities/listbox/types.ts", - "syntaxKind": "PropertySignature", - "name": "index", - "value": "number", - "description": "", - "isOptional": true - } - ], - "value": "export interface NavigableOption {\n domId: string;\n value: string;\n element: HTMLElement;\n disabled: boolean;\n isAction?: boolean;\n index?: number;\n}" - } - }, - "ListboxContextType": { - "polaris-react/src/utilities/listbox/context.ts": { - "filePath": "polaris-react/src/utilities/listbox/context.ts", - "name": "ListboxContextType", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/utilities/listbox/context.ts", - "syntaxKind": "MethodSignature", - "name": "onOptionSelect", - "value": "(option: NavigableOption) => void", - "description": "" - }, - { - "filePath": "polaris-react/src/utilities/listbox/context.ts", - "syntaxKind": "MethodSignature", - "name": "setLoading", - "value": "(label?: string) => void", - "description": "" - } - ], - "value": "export interface ListboxContextType {\n onOptionSelect(option: NavigableOption): void;\n setLoading(label?: string): void;\n}" - } - }, - "PortalsContainerElement": { - "polaris-react/src/utilities/portals/types.ts": { - "filePath": "polaris-react/src/utilities/portals/types.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "PortalsContainerElement", - "value": "HTMLDivElement | null", - "description": "" - } - }, "ResourceListSelectedItems": { "polaris-react/src/utilities/resource-list/types.ts": { "filePath": "polaris-react/src/utilities/resource-list/types.ts", @@ -7407,6 +7398,15 @@ "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}" } }, + "PortalsContainerElement": { + "polaris-react/src/utilities/portals/types.ts": { + "filePath": "polaris-react/src/utilities/portals/types.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PortalsContainerElement", + "value": "HTMLDivElement | null", + "description": "" + } + }, "StickyItem": { "polaris-react/src/utilities/sticky-manager/sticky-manager.ts": { "filePath": "polaris-react/src/utilities/sticky-manager/sticky-manager.ts", @@ -7671,38 +7671,89 @@ "value": "export interface AccountConnectionProps {\n /** Content to display as title */\n title?: React.ReactNode;\n /** Content to display as additional details */\n details?: React.ReactNode;\n /** Content to display as terms of service */\n termsOfService?: React.ReactNode;\n /** The name of the service */\n accountName?: string;\n /** URL for the user’s avatar image */\n avatarUrl?: string;\n /** Set if the account is connected */\n connected?: boolean;\n /** Action for account connection */\n action?: Action;\n}" } }, - "ActionMenuProps": { - "polaris-react/src/components/ActionMenu/ActionMenu.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "name": "ActionMenuProps", + "ActionListProps": { + "polaris-react/src/components/ActionList/ActionList.tsx": { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "name": "ActionListProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", "syntaxKind": "PropertySignature", - "name": "actions", - "value": "MenuActionDescriptor[]", - "description": "Collection of page-level secondary actions", + "name": "items", + "value": "readonly ActionListItemDescriptor[]", + "description": "Collection of actions for list", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", "syntaxKind": "PropertySignature", - "name": "groups", - "value": "MenuGroupDescriptor[]", - "description": "Collection of page-level action groups", + "name": "sections", + "value": "readonly ActionListSection[]", + "description": "Collection of sectioned action items", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", "syntaxKind": "PropertySignature", - "name": "rollup", - "value": "boolean", - "description": "Roll up all actions into a Popover > ActionList", + "name": "actionRole", + "value": "string", + "description": "Defines a specific role attribute for each action in the list", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any item is clicked or keypressed", + "isOptional": true + } + ], + "value": "export interface ActionListProps {\n /** Collection of actions for list */\n items?: readonly ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" + } + }, + "ActionListItemProps": { + "polaris-react/src/components/ActionList/ActionList.tsx": { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ActionListItemProps", + "value": "ItemProps", + "description": "" + } + }, + "ActionMenuProps": { + "polaris-react/src/components/ActionMenu/ActionMenu.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "name": "ActionMenuProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "actions", + "value": "MenuActionDescriptor[]", + "description": "Collection of page-level secondary actions", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "groups", + "value": "MenuGroupDescriptor[]", + "description": "Collection of page-level action groups", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "rollup", + "value": "boolean", + "description": "Roll up all actions into a Popover > ActionList", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", "syntaxKind": "PropertySignature", "name": "rollupActionsLabel", "value": "string", @@ -7721,6 +7772,59 @@ "value": "export interface ActionMenuProps {\n /** Collection of page-level secondary actions */\n actions?: MenuActionDescriptor[];\n /** Collection of page-level action groups */\n groups?: MenuGroupDescriptor[];\n /** Roll up all actions into a Popover > ActionList */\n rollup?: boolean;\n /** Label for rolled up actions activator */\n rollupActionsLabel?: string;\n /** Callback that returns true when secondary actions are rolled up into action groups, and false when not */\n onActionRollup?(hasRolledUp: boolean): void;\n}" } }, + "CardBackgroundColorTokenScale": { + "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "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/AlphaCard/AlphaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Elements to display inside card", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "CardBackgroundColorTokenScale", + "description": "Background color", + "isOptional": true, + "defaultValue": "'surface'" + }, + { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.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'" + }, + { + "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 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}" + } + }, "Props": { "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx": { "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", @@ -8005,110 +8109,6 @@ "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}" } }, - "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/AlphaCard/AlphaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Elements to display inside card", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "background", - "value": "CardBackgroundColorTokenScale", - "description": "Background color", - "isOptional": true, - "defaultValue": "'surface'" - }, - { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.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'" - }, - { - "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 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}" - } - }, - "ActionListProps": { - "polaris-react/src/components/ActionList/ActionList.tsx": { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "name": "ActionListProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "items", - "value": "readonly ActionListItemDescriptor[]", - "description": "Collection of actions for list", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "sections", - "value": "readonly ActionListSection[]", - "description": "Collection of sectioned action items", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "actionRole", - "value": "string", - "description": "Defines a specific role attribute for each action in the list", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any item is clicked or keypressed", - "isOptional": true - } - ], - "value": "export interface ActionListProps {\n /** Collection of actions for list */\n items?: readonly ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" - } - }, - "ActionListItemProps": { - "polaris-react/src/components/ActionList/ActionList.tsx": { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "ActionListItemProps", - "value": "ItemProps", - "description": "" - } - }, "Align": { "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", @@ -8160,7 +8160,7 @@ "filePath": "polaris-react/src/components/Columns/Columns.tsx", "syntaxKind": "TypeAliasDeclaration", "name": "Gap", - "value": "{\n [Breakpoint in BreakpointsAlias]?: SpacingSpaceScale;\n}", + "value": "ResponsiveProp", "description": "" }, "polaris-react/src/components/Grid/Grid.tsx": { @@ -8578,20 +8578,20 @@ ], "value": "interface State {\n disclosureWidth: number;\n tabWidths: number[];\n visibleTabs: number[];\n hiddenTabs: number[];\n containerWidth: number;\n showDisclosure: boolean;\n tabToFocus: number;\n}" }, - "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx": { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", + "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx": { + "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", "name": "State", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", "syntaxKind": "PropertySignature", "name": "sliderHeight", "value": "number", "description": "" }, { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", "syntaxKind": "PropertySignature", "name": "draggerHeight", "value": "number", @@ -8600,20 +8600,20 @@ ], "value": "interface State {\n sliderHeight: number;\n draggerHeight: number;\n}" }, - "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx": { - "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", + "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx": { + "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", "name": "State", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", "syntaxKind": "PropertySignature", "name": "sliderHeight", "value": "number", "description": "" }, { - "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", "syntaxKind": "PropertySignature", "name": "draggerHeight", "value": "number", @@ -11807,11 +11807,10 @@ { "filePath": "polaris-react/src/components/Columns/Columns.tsx", "syntaxKind": "PropertySignature", - "name": "gap", - "value": "Gap", - "description": "The spacing between columns", - "isOptional": true, - "defaultValue": "'4'" + "name": "children", + "value": "React.ReactNode", + "description": "Elements to display inside columns", + "isOptional": true }, { "filePath": "polaris-react/src/components/Columns/Columns.tsx", @@ -11825,13 +11824,14 @@ { "filePath": "polaris-react/src/components/Columns/Columns.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Elements to display inside columns", - "isOptional": true + "name": "gap", + "value": "Gap", + "description": "The spacing between columns. Accepts a spacing token or an object of spacing tokens for different screen sizes.", + "isOptional": true, + "defaultValue": "'4'" } ], - "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}" + "value": "export interface ColumnsProps {\n /** Elements to display inside columns */\n children?: React.ReactNode;\n /** The number of columns to display\n * @default {xs: 6, sm: 6, md: 6, lg: 6, xl: 6}\n */\n columns?: Columns;\n /** The spacing between columns. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @default '4'\n * @example\n * gap='2'\n * gap={{xs: '1', sm: '2', md: '3', lg: '4', xl: '5'}}\n */\n gap?: Gap;\n}" } }, "ComboboxProps": { @@ -22009,619 +22009,582 @@ "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", - "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/Actions/Actions.tsx", + "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": "rolledUp", - "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", + "name": "button", + "value": "React.ReactElement", "description": "" } ], - "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 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/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Visually hidden menu description for screen readers", - "isOptional": true + "name": "position", + "value": "ItemPosition", + "description": "Position of the item" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "active", - "value": "boolean", - "description": "Whether or not the menu is open", - "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", - "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/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "onClose", - "value": "(title: string) => void", - "description": "Callback for closing the MenuGroup by title" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "getOffsetWidth", - "value": "(width: number) => void", - "description": "Callback for getting the offsetWidth of the MenuGroup", + "name": "children", + "value": "React.ReactNode", + "description": "Item content", "isOptional": true - }, + } + ], + "value": "export interface ItemProps {\n /** Position of the item */\n position: ItemPosition;\n /** Item content */\n children?: React.ReactNode;\n}" + }, + "polaris-react/src/components/FormLayout/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "sections", - "value": "readonly ActionListSection[]", - "description": "Collection of sectioned action items", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "Menu group title" - }, + } + ], + "value": "export interface ItemProps {\n children?: React.ReactNode;\n}" + }, + "polaris-react/src/components/List/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "actions", - "value": "ActionListItemDescriptor[]", - "description": "List of actions" - }, + "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/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", + "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": "badge", + "value": "ReactNode", + "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", - "isOptional": true + "name": "label", + "value": "string", + "description": "" }, { - "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": "disabled", + "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": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any action takes place", + "name": "accessibilityLabel", + "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": "badge", - "value": "{ status: \"new\"; content: string; }", + "name": "selected", + "value": "boolean", "description": "", "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", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Accessibilty label", + "name": "exactMatch", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "items", - "value": "ActionListItemDescriptor[]", - "description": "Collection of actions for the list", + "name": "new", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "sections", - "value": "ActionListSection[]", - "description": "Collection of sectioned action items", + "name": "subNavigationItems", + "value": "SubNavigationItem[]", + "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/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "helpText", - "value": "React.ReactNode", + "name": "secondaryAction", + "value": "SecondaryAction", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "MethodSignature", - "name": "onAction", + "name": "onClick", "value": "() => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "MethodSignature", - "name": "getOffsetWidth", - "value": "(width: number) => void", + "name": "onToggleExpandedState", + "value": "() => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "string | string[]", - "description": "The content to display inside the button", + "name": "expanded", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "primary", + "name": "shouldResizeIcon", "value": "boolean", - "description": "Provides extra visual weight and identifies the primary action in a set of buttons", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "destructive", + "name": "truncateText", "value": "boolean", - "description": "Indicates a dangerous or potentially negative action", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "PropertySignature", - "name": "size", - "value": "\"medium\" | \"large\" | \"slim\"", - "description": "Changes the size of the button, giving it more or less padding", - "isOptional": true, - "defaultValue": "'medium'" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "textAlign", - "value": "\"start\" | \"end\" | \"center\" | \"left\" | \"right\"", - "description": "Changes the inner text alignment of the button", + "name": "url", + "value": "string", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "outline", + "name": "matches", "value": "boolean", - "description": "Gives the button a subtle alternative to the default button styling, appropriate for certain backdrops", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "fullWidth", - "value": "boolean", - "description": "Allows the button to grow to the width of its container", + "name": "matchPaths", + "value": "string[]", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "disclosure", - "value": "boolean | \"up\" | \"down\" | \"select\"", - "description": "Displays the button with a disclosure icon. Defaults to `down` when set to true", + "name": "excludePaths", + "value": "string[]", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "plain", + "name": "external", "value": "boolean", - "description": "Renders a button that looks like a link", + "description": "", "isOptional": true - }, + } + ], + "value": "export interface ItemProps extends ItemURLDetails {\n icon?: IconProps['source'];\n badge?: ReactNode;\n label: string;\n disabled?: boolean;\n accessibilityLabel?: string;\n selected?: boolean;\n exactMatch?: boolean;\n new?: boolean;\n subNavigationItems?: SubNavigationItem[];\n secondaryAction?: SecondaryAction;\n onClick?(): void;\n onToggleExpandedState?(): void;\n expanded?: boolean;\n shouldResizeIcon?: boolean;\n truncateText?: boolean;\n}" + }, + "polaris-react/src/components/Stack/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "monochrome", - "value": "boolean", - "description": "Makes `plain` and `outline` Button colors (text, borders, icons) the same as the current text color. Also adds an underline to `plain` Buttons", + "name": "children", + "value": "React.ReactNode", + "description": "Elements to display inside item", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "removeUnderline", + "name": "fill", "value": "boolean", - "description": "Removes underline from button text (including on interaction) when `monochrome` and `plain` are true", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "Icon to display to the left of the button content", + "description": "Fill the remaining horizontal space in the stack with the item", "isOptional": true - }, + } + ], + "value": "export interface ItemProps {\n /** Elements to display inside item */\n children?: React.ReactNode;\n /** Fill the remaining horizontal space in the stack with the item */\n fill?: boolean;\n /**\n * @default false\n */\n}" + }, + "polaris-react/src/components/Tabs/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "connectedDisclosure", - "value": "ConnectedDisclosure", - "description": "Disclosure button connected right of the button. Toggles a popover action list.", - "isOptional": true + "name": "id", + "value": "string", + "description": "" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "dataPrimaryLink", + "name": "focused", "value": "boolean", - "description": "Indicates whether or not the button is the primary navigation link when rendered inside of an `IndexTable.Row`", - "isOptional": true + "description": "" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "id", + "name": "panelID", "value": "string", - "description": "A unique identifier for the button", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "A destination to link to, rendered in the href attribute of a link", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "external", - "value": "boolean", - "description": "Forces url to open in a new tab", + "name": "url", + "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": "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": "accessibilityLabel", + "value": "string", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "PropertySignature", - "name": "submit", - "value": "boolean", - "description": "Allows the button to submit a form", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "", "isOptional": true - }, + } + ], + "value": "export interface ItemProps {\n id: string;\n focused: boolean;\n panelID?: string;\n children?: React.ReactNode;\n url?: string;\n accessibilityLabel?: string;\n onClick?(): void;\n}" + }, + "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the button, disallowing merchant interaction", + "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": "loading", - "value": "boolean", - "description": "Replaces button text with a spinner while a background action is being performed", - "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": "pressed", + "name": "hasMultipleSections", "value": "boolean", - "description": "Sets the button in a pressed state", - "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": "accessibilityLabel", + "name": "actionRole", "value": "string", - "description": "Visually hidden text for screen readers", + "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": "role", - "value": "string", - "description": "A valid WAI-ARIA role to define the semantic value of this element", + "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": "ariaControls", - "value": "string", - "description": "Id of the element the button controls", + "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": "ariaExpanded", + "name": "secondary", "value": "boolean", - "description": "Tells screen reader the controlled element is expanded", + "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": "ariaDescribedBy", - "value": "string", - "description": "Indicates the ID of the element that describes the button", + "name": "fullWidth", + "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": "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/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "Callback when clicked", + "name": "oneHalf", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onFocus", - "value": "() => void", - "description": "Callback when button becomes focussed", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "oneThird", + "value": "boolean", + "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", - "syntaxKind": "MethodSignature", - "name": "onBlur", - "value": "() => void", - "description": "Callback when focus leaves button", + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "divider", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyPress", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keypress event is registered on the button", + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyUp", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keyup event is registered on the button", - "isOptional": true - }, + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.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": [ { - "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", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onMouseEnter", - "value": "() => void", - "description": "Callback when mouse enter", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "flush", + "value": "boolean", + "description": "", "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/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "subdued", + "value": "boolean", + "description": "", "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", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "titleHidden", + "value": "boolean", + "description": "", "isOptional": true } ], - "value": "interface SecondaryAction extends ButtonProps {\n helpText?: React.ReactNode;\n onAction?(): void;\n getOffsetWidth?(width: number): void;\n}" + "value": "export interface SectionProps {\n children?: React.ReactNode;\n flush?: boolean;\n subdued?: boolean;\n titleHidden?: boolean;\n}" }, - "polaris-react/src/components/Navigation/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "SecondaryAction", + "polaris-react/src/components/Navigation/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "name": "SectionProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", + "name": "items", + "value": "ItemProps[]", "description": "" }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", "name": "icon", "value": "any", - "description": "" + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "tooltip", - "value": "TooltipProps", + "name": "fill", + "value": "boolean", "description": "", "isOptional": true - } - ], - "value": "interface SecondaryAction {\n url: string;\n accessibilityLabel: string;\n icon: IconProps['source'];\n onClick?(): void;\n tooltip?: TooltipProps;\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", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.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": [ + "name": "rollup", + "value": "{ after: number; view: string; hide: string; activePath: string; }", + "description": "", + "isOptional": true + }, { - "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "position", - "value": "ItemPosition", - "description": "Position of the item" + "name": "action", + "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Item content", + "name": "separator", + "value": "boolean", + "description": "", "isOptional": true } ], - "value": "export interface ItemProps {\n /** Position of the item */\n position: ItemPosition;\n /** Item content */\n children?: React.ReactNode;\n}" + "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/FormLayout/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", - "name": "ItemProps", + "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/FormLayout/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", @@ -22629,530 +22592,567 @@ "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", + "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/List/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Content to display inside the item", - "isOptional": true + "name": "showable", + "value": "MenuActionDescriptor[]", + "description": "" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "syntaxKind": "PropertySignature", + "name": "rolledUp", + "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", + "description": "" } ], - "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", + "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", "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": "icon", - "value": "any", - "description": "", + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden menu description for screen readers", "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": "badge", - "value": "ReactNode", - "description": "", + "name": "active", + "value": "boolean", + "description": "Whether or not the menu is open", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "" + "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", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "", + "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/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "onClose", + "value": "(title: string) => void", + "description": "Callback for closing the MenuGroup by title" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "getOffsetWidth", + "value": "(width: number) => void", + "description": "Callback for getting the offsetWidth of the MenuGroup", "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": "accessibilityLabel", - "value": "string", - "description": "", + "name": "sections", + "value": "readonly ActionListSection[]", + "description": "Collection of sectioned action items", "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": "selected", - "value": "boolean", - "description": "", - "isOptional": true + "name": "title", + "value": "string", + "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": "exactMatch", - "value": "boolean", - "description": "", - "isOptional": true + "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": "new", - "value": "boolean", - "description": "", + "name": "icon", + "value": "any", + "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": "subNavigationItems", - "value": "SubNavigationItem[]", - "description": "", + "name": "details", + "value": "React.ReactNode", + "description": "Action details", "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": "secondaryAction", - "value": "SecondaryAction", - "description": "", + "name": "disabled", + "value": "boolean", + "description": "Disables action button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "index", + "value": "number", + "description": "Zero-indexed numerical position. Overrides the group's order in the menu.", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onToggleExpandedState", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "onActionAnyItem", "value": "() => void", - "description": "", + "description": "Callback when any action takes place", "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": "expanded", - "value": "boolean", + "name": "badge", + "value": "{ status: \"new\"; content: string; }", "description": "", "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", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", "syntaxKind": "PropertySignature", - "name": "shouldResizeIcon", - "value": "boolean", - "description": "", + "name": "accessibilityLabel", + "value": "string", + "description": "Accessibilty label", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", "syntaxKind": "PropertySignature", - "name": "truncateText", - "value": "boolean", - "description": "", + "name": "items", + "value": "ActionListItemDescriptor[]", + "description": "Collection of actions for the list", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "", + "name": "sections", + "value": "ActionListSection[]", + "description": "Collection of sectioned action items", "isOptional": true - }, + } + ], + "value": "export interface RollupActionsProps {\n /** Accessibilty label */\n accessibilityLabel?: string;\n /** Collection of actions for the list */\n items?: ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: ActionListSection[];\n}" + } + }, + "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/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "matches", - "value": "boolean", + "name": "helpText", + "value": "React.ReactNode", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "matchPaths", - "value": "string[]", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onAction", + "value": "() => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "excludePaths", - "value": "string[]", + "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/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "external", - "value": "boolean", - "description": "", + "name": "children", + "value": "string | string[]", + "description": "The content to display inside the button", "isOptional": true - } - ], - "value": "export interface ItemProps extends ItemURLDetails {\n icon?: IconProps['source'];\n badge?: ReactNode;\n label: string;\n disabled?: boolean;\n accessibilityLabel?: string;\n selected?: boolean;\n exactMatch?: boolean;\n new?: boolean;\n subNavigationItems?: SubNavigationItem[];\n secondaryAction?: SecondaryAction;\n onClick?(): void;\n onToggleExpandedState?(): void;\n expanded?: boolean;\n shouldResizeIcon?: boolean;\n truncateText?: boolean;\n}" - }, - "polaris-react/src/components/Stack/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Elements to display inside item", + "name": "primary", + "value": "boolean", + "description": "Provides extra visual weight and identifies the primary action in a set of buttons", "isOptional": true }, { - "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "fill", + "name": "destructive", "value": "boolean", - "description": "Fill the remaining horizontal space in the stack with the item", + "description": "Indicates a dangerous or potentially negative action", "isOptional": true - } - ], - "value": "export interface ItemProps {\n /** Elements to display inside item */\n children?: React.ReactNode;\n /** Fill the remaining horizontal space in the stack with the item */\n fill?: boolean;\n /**\n * @default false\n */\n}" - }, - "polaris-react/src/components/Tabs/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "" + "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/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "focused", + "name": "textAlign", + "value": "\"start\" | \"end\" | \"center\" | \"left\" | \"right\"", + "description": "Changes the inner text alignment of the button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "PropertySignature", + "name": "outline", "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/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "panelID", - "value": "string", - "description": "", + "name": "fullWidth", + "value": "boolean", + "description": "Allows the button to grow to the width of its container", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "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 }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "", + "name": "plain", + "value": "boolean", + "description": "Renders a button that looks like a link", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "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/Tabs/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "PropertySignature", + "name": "removeUnderline", + "value": "boolean", + "description": "Removes underline from button text (including on interaction) when `monochrome` and `plain` are true", "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/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "name": "icon", + "value": "any", + "description": "Icon to display to the left of the button content", "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/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "section", - "value": "ActionListSection", - "description": "Section of action items" + "name": "connectedDisclosure", + "value": "ConnectedDisclosure", + "description": "Disclosure button connected right of the button. Toggles a popover action list.", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "hasMultipleSections", + "name": "dataPrimaryLink", "value": "boolean", - "description": "Should there be multiple sections" + "description": "Indicates whether or not the button is the primary navigation link when rendered inside of an `IndexTable.Row`", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "actionRole", + "name": "id", "value": "string", - "description": "Defines a specific role attribute for each action in the list", + "description": "A unique identifier for the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any item is clicked or keypressed", + "name": "url", + "value": "string", + "description": "A destination to link to, rendered in the href attribute of a link", "isOptional": true - } - ], - "value": "export interface SectionProps {\n /** Section of action items */\n section: ActionListSection;\n /** Should there be multiple sections */\n hasMultipleSections: boolean;\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'option' | 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" - }, - "polaris-react/src/components/Layout/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "name": "external", + "value": "boolean", + "description": "Forces url to open in a new tab", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "secondary", - "value": "boolean", - "description": "", + "name": "download", + "value": "string | boolean", + "description": "Tells the browser to download the url instead of opening it. Provides a hint for the downloaded filename if it is a string value", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "fullWidth", + "name": "submit", "value": "boolean", - "description": "", + "description": "Allows the button to submit a form", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "oneHalf", + "name": "disabled", "value": "boolean", - "description": "", + "description": "Disables the button, disallowing merchant interaction", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "oneThird", + "name": "loading", "value": "boolean", - "description": "", + "description": "Replaces button text with a spinner while a background action is being performed", "isOptional": true - } - ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\n secondary?: boolean;\n fullWidth?: boolean;\n oneHalf?: boolean;\n oneThird?: boolean;\n}" - }, - "polaris-react/src/components/Listbox/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "divider", + "name": "pressed", "value": "boolean", - "description": "", + "description": "Sets the button in a pressed state", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", - "description": "", + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden text for screen readers", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "title", - "value": "ReactNode", - "description": "" - } - ], - "value": "interface SectionProps {\n divider?: boolean;\n children?: ReactNode;\n title: ReactNode;\n}" - }, - "polaris-react/src/components/Modal/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ + "name": "role", + "value": "string", + "description": "A valid WAI-ARIA role to define the semantic value of this element", + "isOptional": true + }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "name": "ariaControls", + "value": "string", + "description": "Id of the element the button controls", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "flush", + "name": "ariaExpanded", "value": "boolean", - "description": "", + "description": "Tells screen reader the controlled element is expanded", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "subdued", - "value": "boolean", - "description": "", + "name": "ariaDescribedBy", + "value": "string", + "description": "Indicates the ID of the element that describes the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "titleHidden", - "value": "boolean", - "description": "", + "name": "ariaChecked", + "value": "\"false\" | \"true\"", + "description": "Indicates the current checked state of the button when acting as a toggle or switch", "isOptional": true - } - ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\n flush?: boolean;\n subdued?: boolean;\n titleHidden?: boolean;\n}" - }, - "polaris-react/src/components/Navigation/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "items", - "value": "ItemProps[]", - "description": "" + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "Callback when clicked", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onFocus", + "value": "() => void", + "description": "Callback when button becomes focussed", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onBlur", + "value": "() => void", + "description": "Callback when focus leaves button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "fill", - "value": "boolean", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyPress", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keypress event is registered on the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "rollup", - "value": "{ after: number; view: string; hide: string; activePath: string; }", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyUp", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keyup event is registered on the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "action", - "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyDown", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keydown event is registered on the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "separator", - "value": "boolean", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onMouseEnter", + "value": "() => void", + "description": "Callback when mouse enter", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onTouchStart", + "value": "() => void", + "description": "Callback when element is touched", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onPointerDown", + "value": "() => void", + "description": "Callback when pointerdown event is being triggered", "isOptional": true } ], - "value": "export interface SectionProps {\n 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}" + "value": "interface SecondaryAction extends ButtonProps {\n helpText?: React.ReactNode;\n onAction?(): void;\n getOffsetWidth?(width: number): void;\n}" }, - "polaris-react/src/components/Popover/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", - "name": "SectionProps", + "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/Popover/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", + "name": "url", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.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": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "tooltip", + "value": "TooltipProps", "description": "", "isOptional": true } ], - "value": "export interface SectionProps {\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": { @@ -23337,6 +23337,15 @@ "description": "" } }, + "BulkActionButtonProps": { + "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx": { + "filePath": "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "BulkActionButtonProps", + "value": "{\n disclosure?: boolean;\n indicator?: boolean;\n handleMeasurement?(width: number): void;\n} & DisableableAction", + "description": "" + } + }, "PipProps": { "polaris-react/src/components/Badge/components/Pip/Pip.tsx": { "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", @@ -23371,15 +23380,6 @@ "value": "export interface PipProps {\n status?: Status;\n progress?: Progress;\n accessibilityLabelOverride?: string;\n}" } }, - "BulkActionButtonProps": { - "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx": { - "filePath": "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "BulkActionButtonProps", - "value": "{\n disclosure?: boolean;\n indicator?: boolean;\n handleMeasurement?(width: number): void;\n} & DisableableAction", - "description": "" - } - }, "CardHeaderProps": { "polaris-react/src/components/Card/components/Header/Header.tsx": { "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", @@ -23395,23 +23395,89 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", + "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", + "syntaxKind": "PropertySignature", + "name": "actions", + "value": "DisableableAction[]", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "export interface CardHeaderProps {\n title?: React.ReactNode;\n actions?: DisableableAction[];\n children?: React.ReactNode;\n}" + } + }, + "CardSectionProps": { + "polaris-react/src/components/Card/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", + "name": "CardSectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "subdued", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "flush", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "fullWidth", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "actions", - "value": "DisableableAction[]", - "description": "", + "name": "hideOnPrint", + "value": "boolean", + "description": "Allow the card to be hidden when printing", "isOptional": true }, { - "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", + "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", + "name": "actions", + "value": "ComplexAction[]", "description": "", "isOptional": true } ], - "value": "export interface CardHeaderProps {\n title?: React.ReactNode;\n actions?: DisableableAction[];\n children?: React.ReactNode;\n}" + "value": "export interface CardSectionProps {\n title?: React.ReactNode;\n children?: React.ReactNode;\n subdued?: boolean;\n flush?: boolean;\n fullWidth?: boolean;\n /** Allow the card to be hidden when printing */\n hideOnPrint?: boolean;\n actions?: ComplexAction[];\n}" } }, "BulkActionsMenuProps": { @@ -23501,70 +23567,28 @@ "value": "export interface BulkActionsMenuProps extends MenuGroupDescriptor {\n isNewBadgeInBadgeActions: boolean;\n}" } }, - "CardSectionProps": { - "polaris-react/src/components/Card/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", - "name": "CardSectionProps", + "HuePickerProps": { + "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx": { + "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", + "name": "HuePickerProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "subdued", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "flush", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "fullWidth", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", "syntaxKind": "PropertySignature", - "name": "hideOnPrint", - "value": "boolean", - "description": "Allow the card to be hidden when printing", - "isOptional": true + "name": "hue", + "value": "number", + "description": "" }, { - "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "actions", - "value": "ComplexAction[]", - "description": "", - "isOptional": true + "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", + "syntaxKind": "MethodSignature", + "name": "onChange", + "value": "(hue: number) => void", + "description": "" } ], - "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 HuePickerProps {\n hue: number;\n onChange(hue: number): void;\n}" } }, "CardSubsectionProps": { @@ -23616,30 +23640,6 @@ "value": "export interface AlphaPickerProps {\n color: HSBColor;\n alpha: number;\n onChange(hue: number): void;\n}" } }, - "HuePickerProps": { - "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx": { - "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", - "name": "HuePickerProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", - "syntaxKind": "PropertySignature", - "name": "hue", - "value": "number", - "description": "" - }, - { - "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", - "syntaxKind": "MethodSignature", - "name": "onChange", - "value": "(hue: number) => void", - "description": "" - } - ], - "value": "export interface HuePickerProps {\n hue: number;\n onChange(hue: number): void;\n}" - } - }, "Position": { "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx": { "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", @@ -24150,32 +24150,42 @@ "value": "export interface DayProps {\n focused?: boolean;\n day?: Date;\n selected?: boolean;\n inRange?: boolean;\n inHoveringRange?: boolean;\n disabled?: boolean;\n lastDayOfMonth?: any;\n isLastSelectedDay?: boolean;\n isFirstSelectedDay?: boolean;\n isHoveringRight?: boolean;\n rangeIsDifferent?: boolean;\n weekday?: string;\n selectedAccessibilityLabelPrefix?: string;\n onClick?(day: Date): void;\n onHover?(day?: Date): void;\n onFocus?(day: Date): void;\n}" } }, - "MonthProps": { - "polaris-react/src/components/DatePicker/components/Month/Month.tsx": { - "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", - "name": "MonthProps", + "FileUploadProps": { + "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx": { + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "name": "FileUploadProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", "syntaxKind": "PropertySignature", - "name": "focusedDate", - "value": "Date", + "name": "actionTitle", + "value": "string", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", "syntaxKind": "PropertySignature", - "name": "selected", - "value": "Range", + "name": "actionHint", + "value": "string", "description": "", "isOptional": true - }, + } + ], + "value": "export interface FileUploadProps {\n actionTitle?: string;\n actionHint?: string;\n}" + } + }, + "MonthProps": { + "polaris-react/src/components/DatePicker/components/Month/Month.tsx": { + "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", + "name": "MonthProps", + "description": "", + "members": [ { "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", "syntaxKind": "PropertySignature", - "name": "hoverDate", + "name": "focusedDate", "value": "Date", "description": "", "isOptional": true @@ -24183,29 +24193,15 @@ { "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", "syntaxKind": "PropertySignature", - "name": "month", - "value": "number", - "description": "" - }, - { - "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", - "syntaxKind": "PropertySignature", - "name": "year", - "value": "number", - "description": "" - }, - { - "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", - "syntaxKind": "PropertySignature", - "name": "disableDatesBefore", - "value": "Date", + "name": "selected", + "value": "Range", "description": "", "isOptional": true }, { "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", "syntaxKind": "PropertySignature", - "name": "disableDatesAfter", + "name": "hoverDate", "value": "Date", "description": "", "isOptional": true @@ -24213,158 +24209,89 @@ { "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", "syntaxKind": "PropertySignature", - "name": "disableSpecificDates", - "value": "Date[]", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", - "syntaxKind": "PropertySignature", - "name": "allowRange", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", - "syntaxKind": "PropertySignature", - "name": "weekStartsOn", + "name": "month", "value": "number", - "description": "" - }, - { - "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabelPrefixes", - "value": "[string, string]", - "description": "" - }, - { - "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", - "syntaxKind": "MethodSignature", - "name": "onChange", - "value": "(date: Range) => void", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", - "syntaxKind": "MethodSignature", - "name": "onHover", - "value": "(hoverEnd: Date) => void", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", - "syntaxKind": "MethodSignature", - "name": "onFocus", - "value": "(date: Date) => void", - "description": "", - "isOptional": true - } - ], - "value": "export interface MonthProps {\n focusedDate?: Date;\n selected?: Range;\n hoverDate?: Date;\n month: number;\n year: number;\n disableDatesBefore?: Date;\n disableDatesAfter?: Date;\n disableSpecificDates?: Date[];\n allowRange?: boolean;\n weekStartsOn: number;\n accessibilityLabelPrefixes: [string | undefined, string];\n onChange?(date: Range): void;\n onHover?(hoverEnd: Date): void;\n onFocus?(date: Date): void;\n}" - } - }, - "WeekdayProps": { - "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx": { - "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", - "name": "WeekdayProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "boolean", - "description": "" - } - ], - "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": [ + "description": "" + }, { - "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", "syntaxKind": "PropertySignature", - "name": "actionTitle", - "value": "string", + "name": "year", + "value": "number", + "description": "" + }, + { + "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", + "syntaxKind": "PropertySignature", + "name": "disableDatesBefore", + "value": "Date", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", "syntaxKind": "PropertySignature", - "name": "actionHint", - "value": "string", + "name": "disableDatesAfter", + "value": "Date", "description": "", "isOptional": true - } - ], - "value": "export interface FileUploadProps {\n actionTitle?: string;\n actionHint?: string;\n}" - } - }, - "GroupProps": { - "polaris-react/src/components/FormLayout/components/Group/Group.tsx": { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "name": "GroupProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", + "name": "disableSpecificDates", + "value": "Date[]", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", "syntaxKind": "PropertySignature", - "name": "condensed", + "name": "allowRange", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", + "name": "weekStartsOn", + "value": "number", + "description": "" + }, + { + "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabelPrefixes", + "value": "[string, string]", + "description": "" + }, + { + "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", + "syntaxKind": "MethodSignature", + "name": "onChange", + "value": "(date: Range) => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "syntaxKind": "PropertySignature", - "name": "helpText", - "value": "React.ReactNode", + "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", + "syntaxKind": "MethodSignature", + "name": "onHover", + "value": "(hoverEnd: Date) => void", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DatePicker/components/Month/Month.tsx", + "syntaxKind": "MethodSignature", + "name": "onFocus", + "value": "(date: Date) => void", "description": "", "isOptional": true } ], - "value": "export interface GroupProps {\n children?: React.ReactNode;\n condensed?: boolean;\n title?: string;\n helpText?: React.ReactNode;\n}" + "value": "export interface MonthProps {\n focusedDate?: Date;\n selected?: Range;\n hoverDate?: Date;\n month: number;\n year: number;\n disableDatesBefore?: Date;\n disableDatesAfter?: Date;\n disableSpecificDates?: Date[];\n allowRange?: boolean;\n weekStartsOn: number;\n accessibilityLabelPrefixes: [string | undefined, string];\n onChange?(date: Range): void;\n onHover?(hoverEnd: Date): void;\n onFocus?(date: Date): void;\n}" } }, "PopoverableAction": { @@ -24548,192 +24475,168 @@ "value": "interface ComputedProperty {\n [key: string]: number;\n}" } }, - "AnimationType": { - "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx": { - "filePath": "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "AnimationType", - "value": "'fade'", - "description": "" - } - }, - "CSSAnimationProps": { - "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx": { - "filePath": "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx", - "name": "CSSAnimationProps", + "WeekdayProps": { + "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx": { + "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", + "name": "WeekdayProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", "syntaxKind": "PropertySignature", - "name": "in", - "value": "boolean", + "name": "label", + "value": "string", "description": "" }, { - "filePath": "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", "syntaxKind": "PropertySignature", - "name": "className", + "name": "title", "value": "string", "description": "" }, { - "filePath": "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx", + "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", "syntaxKind": "PropertySignature", - "name": "type", - "value": "\"fade\"", + "name": "current", + "value": "boolean", "description": "" - }, - { - "filePath": "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true } ], - "value": "export interface CSSAnimationProps {\n in: boolean;\n className: string;\n type: AnimationType;\n children?: React.ReactNode;\n}" + "value": "export interface WeekdayProps {\n label: string;\n title: string;\n current: boolean;\n}" } }, - "ToastManagerProps": { - "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx": { - "filePath": "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx", - "name": "ToastManagerProps", + "GroupProps": { + "polaris-react/src/components/FormLayout/components/Group/Group.tsx": { + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "name": "GroupProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx", + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", "syntaxKind": "PropertySignature", - "name": "toastMessages", - "value": "ToastPropsWithID[]", - "description": "" - } - ], - "value": "export interface ToastManagerProps {\n toastMessages: ToastPropsWithID[];\n}" - } - }, - "Cell": { - "polaris-react/src/components/Grid/components/Cell/Cell.tsx": { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Cell", - "value": "{\n [Breakpoint in Breakpoints]?: string;\n}", - "description": "" - } - }, - "CheckboxWrapperProps": { - "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx": { - "filePath": "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx", - "name": "CheckboxWrapperProps", - "description": "", - "members": [ + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, { - "filePath": "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx", + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", - "description": "" + "name": "condensed", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "syntaxKind": "PropertySignature", + "name": "helpText", + "value": "React.ReactNode", + "description": "", + "isOptional": true } ], - "value": "interface CheckboxWrapperProps {\n children: ReactNode;\n}" - } - }, - "RowStatus": { - "polaris-react/src/components/IndexTable/components/Row/Row.tsx": { - "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "RowStatus", - "value": "'success' | 'subdued'", - "description": "" + "value": "export interface GroupProps {\n children?: React.ReactNode;\n condensed?: boolean;\n title?: string;\n helpText?: React.ReactNode;\n}" } }, - "TableRowElementType": { - "polaris-react/src/components/IndexTable/components/Row/Row.tsx": { - "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", + "AnimationType": { + "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx": { + "filePath": "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "TableRowElementType", - "value": "HTMLTableRowElement & HTMLLIElement", + "name": "AnimationType", + "value": "'fade'", "description": "" } }, - "RowProps": { - "polaris-react/src/components/IndexTable/components/Row/Row.tsx": { - "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", - "name": "RowProps", + "CSSAnimationProps": { + "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx": { + "filePath": "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx", + "name": "CSSAnimationProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", + "filePath": "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", + "name": "in", + "value": "boolean", "description": "" }, { - "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", + "filePath": "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx", "syntaxKind": "PropertySignature", - "name": "id", + "name": "className", "value": "string", "description": "" }, { - "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", - "syntaxKind": "PropertySignature", - "name": "selected", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", - "syntaxKind": "PropertySignature", - "name": "position", - "value": "number", - "description": "" - }, - { - "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", - "syntaxKind": "PropertySignature", - "name": "subdued", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", - "syntaxKind": "PropertySignature", - "name": "status", - "value": "RowStatus", - "description": "", - "isOptional": true + "filePath": "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "\"fade\"", + "description": "" }, { - "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", + "filePath": "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", + "name": "children", + "value": "React.ReactNode", "description": "", "isOptional": true - }, + } + ], + "value": "export interface CSSAnimationProps {\n in: boolean;\n className: string;\n type: AnimationType;\n children?: React.ReactNode;\n}" + } + }, + "ToastManagerProps": { + "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx": { + "filePath": "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx", + "name": "ToastManagerProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", - "syntaxKind": "MethodSignature", - "name": "onNavigation", - "value": "(id: string) => void", - "description": "", - "isOptional": true - }, + "filePath": "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx", + "syntaxKind": "PropertySignature", + "name": "toastMessages", + "value": "ToastPropsWithID[]", + "description": "" + } + ], + "value": "export interface ToastManagerProps {\n toastMessages: ToastPropsWithID[];\n}" + } + }, + "Cell": { + "polaris-react/src/components/Grid/components/Cell/Cell.tsx": { + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Cell", + "value": "{\n [Breakpoint in Breakpoints]?: string;\n}", + "description": "" + } + }, + "CheckboxWrapperProps": { + "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx": { + "filePath": "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx", + "name": "CheckboxWrapperProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "", - "isOptional": true + "filePath": "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ReactNode", + "description": "" } ], - "value": "export interface RowProps {\n children: React.ReactNode;\n id: string;\n selected?: boolean;\n position: number;\n subdued?: boolean;\n status?: RowStatus;\n disabled?: boolean;\n onNavigation?(id: string): void;\n onClick?(): void;\n}" + "value": "interface CheckboxWrapperProps {\n children: ReactNode;\n}" } }, "ScrollContainerProps": { @@ -24809,6 +24712,71 @@ "value": "export interface AnnotatedSectionProps {\n children?: React.ReactNode;\n title?: React.ReactNode;\n description?: React.ReactNode;\n id?: string;\n}" } }, + "ActionProps": { + "polaris-react/src/components/Listbox/components/Action/Action.tsx": { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "name": "ActionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "any", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "any", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "divider", + "value": "boolean", + "description": "", + "isOptional": true + } + ], + "value": "interface ActionProps extends OptionProps {\n icon?: IconProps['source'];\n}" + } + }, "HeaderProps": { "polaris-react/src/components/Listbox/components/Header/Header.tsx": { "filePath": "polaris-react/src/components/Listbox/components/Header/Header.tsx", @@ -24983,53 +24951,77 @@ "value": "export interface HeaderProps extends TitleProps {\n /** Visually hide the title */\n titleHidden?: boolean;\n /** Primary page-level action */\n primaryAction?: PrimaryAction | React.ReactNode;\n /** Page-level pagination */\n pagination?: PaginationProps;\n /** Collection of breadcrumbs */\n breadcrumbs?: BreadcrumbsProps['breadcrumbs'];\n /** Collection of secondary page-level actions */\n secondaryActions?: MenuActionDescriptor[] | React.ReactNode;\n /** Collection of page-level groups of secondary actions */\n actionGroups?: MenuGroupDescriptor[];\n /** @deprecated Additional navigation markup */\n additionalNavigation?: React.ReactNode;\n // Additional meta data\n additionalMetadata?: React.ReactNode | 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}" } }, - "ActionProps": { - "polaris-react/src/components/Listbox/components/Action/Action.tsx": { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", - "name": "ActionProps", + "RowStatus": { + "polaris-react/src/components/IndexTable/components/Row/Row.tsx": { + "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "RowStatus", + "value": "'success' | 'subdued'", + "description": "" + } + }, + "TableRowElementType": { + "polaris-react/src/components/IndexTable/components/Row/Row.tsx": { + "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "TableRowElementType", + "value": "HTMLTableRowElement & HTMLLIElement", + "description": "" + } + }, + "RowProps": { + "polaris-react/src/components/IndexTable/components/Row/Row.tsx": { + "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", + "name": "RowProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "", - "isOptional": true + "name": "children", + "value": "React.ReactNode", + "description": "" }, { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", "syntaxKind": "PropertySignature", - "name": "value", + "name": "id", "value": "string", "description": "" }, { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", + "name": "selected", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "any", + "name": "position", + "value": "number", + "description": "" + }, + { + "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", + "syntaxKind": "PropertySignature", + "name": "subdued", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", "syntaxKind": "PropertySignature", - "name": "selected", - "value": "boolean", + "name": "status", + "value": "RowStatus", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", @@ -25037,15 +25029,23 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", - "syntaxKind": "PropertySignature", - "name": "divider", - "value": "boolean", + "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", + "syntaxKind": "MethodSignature", + "name": "onNavigation", + "value": "(id: string) => void", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", "description": "", "isOptional": true } ], - "value": "interface ActionProps extends OptionProps {\n icon?: IconProps['source'];\n}" + "value": "export interface RowProps {\n children: React.ReactNode;\n id: string;\n selected?: boolean;\n position: number;\n subdued?: boolean;\n status?: RowStatus;\n disabled?: boolean;\n onNavigation?(id: string): void;\n onClick?(): void;\n}" } }, "OptionProps": { @@ -25177,38 +25177,71 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "syntaxKind": "PropertySignature", + "name": "allowMultiple", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "syntaxKind": "PropertySignature", + "name": "verticalAlign", + "value": "Alignment", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "(section: number, option: number) => void", + "description": "" + } + ], + "value": "export interface OptionProps {\n id: string;\n label: React.ReactNode;\n value: string;\n section: number;\n index: number;\n media?: React.ReactElement;\n disabled?: boolean;\n active?: boolean;\n select?: boolean;\n allowMultiple?: boolean;\n verticalAlign?: Alignment;\n role?: string;\n onClick(section: number, option: number): void;\n}" + } + }, + "CloseButtonProps": { + "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx": { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "name": "CloseButtonProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", "syntaxKind": "PropertySignature", - "name": "allowMultiple", + "name": "pressed", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", - "syntaxKind": "PropertySignature", - "name": "verticalAlign", - "value": "Alignment", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", "syntaxKind": "PropertySignature", - "name": "role", - "value": "string", + "name": "titleHidden", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", "syntaxKind": "MethodSignature", "name": "onClick", - "value": "(section: number, option: number) => void", + "value": "() => void", "description": "" } ], - "value": "export interface OptionProps {\n id: string;\n label: React.ReactNode;\n value: string;\n section: number;\n index: number;\n media?: React.ReactElement;\n disabled?: boolean;\n active?: boolean;\n select?: boolean;\n allowMultiple?: boolean;\n verticalAlign?: Alignment;\n role?: string;\n onClick(section: number, option: number): void;\n}" + "value": "export interface CloseButtonProps {\n pressed?: boolean;\n titleHidden?: boolean;\n onClick(): void;\n}" } }, "TextOptionProps": { @@ -25244,39 +25277,6 @@ "value": "export interface TextOptionProps {\n children: React.ReactNode;\n // Whether the option is selected\n selected?: boolean;\n // Whether the option is disabled\n disabled?: boolean;\n}" } }, - "CloseButtonProps": { - "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx": { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "name": "CloseButtonProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "syntaxKind": "PropertySignature", - "name": "pressed", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "syntaxKind": "PropertySignature", - "name": "titleHidden", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "" - } - ], - "value": "export interface CloseButtonProps {\n pressed?: boolean;\n titleHidden?: boolean;\n onClick(): void;\n}" - } - }, "DialogProps": { "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx": { "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", @@ -26501,15 +26501,6 @@ "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}" } }, - "HandleStepFn": { - "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx": { - "filePath": "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "HandleStepFn", - "value": "(step: number) => void", - "description": "" - } - }, "ResizerProps": { "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx": { "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", @@ -26551,65 +26542,13 @@ "value": "export interface ResizerProps {\n contents?: string;\n currentHeight?: number | null;\n minimumLines?: number;\n onHeightChange(height: number): void;\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}" + "HandleStepFn": { + "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx": { + "filePath": "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "HandleStepFn", + "value": "(step: number) => void", + "description": "" } }, "TooltipOverlayProps": { @@ -26682,6 +26621,67 @@ "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}" } }, + "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}" + } + }, "SearchProps": { "polaris-react/src/components/TopBar/components/Search/Search.tsx": { "filePath": "polaris-react/src/components/TopBar/components/Search/Search.tsx", @@ -26881,6 +26881,37 @@ "value": "export interface UserMenuProps {\n /** An array of action objects that are rendered inside of a popover triggered by this menu */\n actions: {items: IconableAction[]}[];\n /** Accepts a message that facilitates direct, urgent communication with the merchant through the user menu */\n message?: MenuProps['message'];\n /** A string detailing the merchant’s full name to be displayed in the user menu */\n name: string;\n /** A string allowing further detail on the merchant’s name displayed in the user menu */\n detail?: string;\n /** A string that provides the accessibility labeling */\n accessibilityLabel?: string;\n /** The merchant’s initials, rendered in place of an avatar image when not provided */\n initials: AvatarProps['initials'];\n /** An avatar image representing the merchant */\n avatar?: AvatarProps['source'];\n /** A boolean property indicating whether the user menu is currently open */\n open: boolean;\n /** A callback function to handle opening and closing the user menu */\n onToggle(): void;\n}" } }, + "DiscardConfirmationModalProps": { + "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx": { + "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", + "name": "DiscardConfirmationModalProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", + "syntaxKind": "PropertySignature", + "name": "open", + "value": "boolean", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", + "syntaxKind": "MethodSignature", + "name": "onDiscard", + "value": "() => void", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", + "syntaxKind": "MethodSignature", + "name": "onCancel", + "value": "() => void", + "description": "" + } + ], + "value": "export interface DiscardConfirmationModalProps {\n open: boolean;\n onDiscard(): void;\n onCancel(): void;\n}" + } + }, "SecondaryProps": { "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx": { "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", @@ -26914,37 +26945,6 @@ "value": "interface SecondaryProps {\n expanded: boolean;\n children?: React.ReactNode;\n id?: string;\n}" } }, - "DiscardConfirmationModalProps": { - "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx": { - "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", - "name": "DiscardConfirmationModalProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", - "syntaxKind": "PropertySignature", - "name": "open", - "value": "boolean", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", - "syntaxKind": "MethodSignature", - "name": "onDiscard", - "value": "() => void", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", - "syntaxKind": "MethodSignature", - "name": "onCancel", - "value": "() => void", - "description": "" - } - ], - "value": "export interface DiscardConfirmationModalProps {\n open: boolean;\n onDiscard(): void;\n onCancel(): void;\n}" - } - }, "TitleProps": { "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx": { "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx",