diff --git a/.changeset/seven-bats-share.md b/.changeset/seven-bats-share.md new file mode 100644 index 00000000000..a144e33a83a --- /dev/null +++ b/.changeset/seven-bats-share.md @@ -0,0 +1,6 @@ +--- +'@shopify/polaris': patch +'polaris.shopify.com': patch +--- + +Cleaned up prop descriptions and added missing default values for `Box`, `AlphaCard`, `AlphaStack`, `Columns`, `Tiles`, `Bleed`, and `Inline` diff --git a/polaris-react/src/components/AlphaCard/AlphaCard.tsx b/polaris-react/src/components/AlphaCard/AlphaCard.tsx index ec8429e17f3..66cde60cfbb 100644 --- a/polaris-react/src/components/AlphaCard/AlphaCard.tsx +++ b/polaris-react/src/components/AlphaCard/AlphaCard.tsx @@ -15,7 +15,6 @@ type CardBackgroundColorTokenScale = Extract< >; export interface AlphaCardProps { - /** Elements to display inside card */ children?: React.ReactNode; /** Background color * @default 'surface' diff --git a/polaris-react/src/components/AlphaStack/AlphaStack.tsx b/polaris-react/src/components/AlphaStack/AlphaStack.tsx index 61fdd010640..9c8fe713d28 100644 --- a/polaris-react/src/components/AlphaStack/AlphaStack.tsx +++ b/polaris-react/src/components/AlphaStack/AlphaStack.tsx @@ -17,19 +17,20 @@ type Element = 'div' | 'ul' | 'ol' | 'fieldset'; type Gap = ResponsiveProp; export interface AlphaStackProps { + children?: React.ReactNode; /** HTML Element type * @default 'div' */ as?: Element; - /** Elements to display inside stack */ - children?: React.ReactNode; - /** The vertical alignment of elements + /** Vertical alignment of children * @default 'start' */ align?: Align; - /** Toggle elements to be full width */ + /** Toggle children to be full width + * @default false + */ fullWidth?: boolean; - /** The spacing between elements + /** The spacing between children * @default '4' */ gap?: Gap; @@ -39,7 +40,7 @@ export const AlphaStack = ({ as = 'div', children, align = 'start', - fullWidth, + fullWidth = false, gap = '4', }: AlphaStackProps) => { const className = classNames( diff --git a/polaris-react/src/components/Bleed/Bleed.tsx b/polaris-react/src/components/Bleed/Bleed.tsx index 18c98c479aa..19c61292670 100644 --- a/polaris-react/src/components/Bleed/Bleed.tsx +++ b/polaris-react/src/components/Bleed/Bleed.tsx @@ -6,21 +6,20 @@ import {sanitizeCustomProperties} from '../../utilities/css'; import styles from './Bleed.scss'; export interface BleedProps { - /** Elements to display inside tile */ - children: React.ReactNode; - /** Negative horizontal space around the element - * * @default '5' + children?: React.ReactNode; + /** Negative horizontal space around children + * @default '5' */ horizontal?: SpacingSpaceScale; - /** Negative vertical space around the element */ + /** Negative vertical space around children */ vertical?: SpacingSpaceScale; - /** Negative top space around the element */ + /** Negative top space around children */ top?: SpacingSpaceScale; - /** Negative bottom space around the element */ + /** Negative bottom space around children */ bottom?: SpacingSpaceScale; - /** Negative left space around the element */ + /** Negative left space around children */ left?: SpacingSpaceScale; - /** Negative right space around the element */ + /** Negative right space around children */ right?: SpacingSpaceScale; } diff --git a/polaris-react/src/components/Box/Box.tsx b/polaris-react/src/components/Box/Box.tsx index 8f8b2cef351..b94c6ddd4b3 100644 --- a/polaris-react/src/components/Box/Box.tsx +++ b/polaris-react/src/components/Box/Box.tsx @@ -69,7 +69,10 @@ export type BackgroundColors = | ColorsSurfaceTokenAlias; export interface BoxProps { - /** HTML Element type */ + children?: React.ReactNode; + /** HTML Element type + * @default 'div' + */ as?: Element; /** Background color */ background?: BackgroundColors; @@ -91,7 +94,7 @@ export interface BoxProps { borderRadiusEndEnd?: BorderRadiusTokenScale; /** Vertical start horizontal start border radius */ borderRadiusStartStart?: BorderRadiusTokenScale; - /** Verital start horizontal end border radius */ + /** Vertical start horizontal end border radius */ borderRadiusStartEnd?: BorderRadiusTokenScale; /** Border width */ borderWidth?: ShapeBorderWidthScale; @@ -147,28 +150,26 @@ export interface BoxProps { * paddingInlineEnd={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}} */ paddingInlineEnd?: Spacing; - /** Shadow */ + /** Shadow on box */ shadow?: DepthShadowAlias; /** Width of container */ width?: string; - /** Elements to display inside box */ - children?: React.ReactNode; // These could be moved to new layout component(s) in the future - /** Position of the box */ + /** Position of box */ position?: Position; - /** Top position of the box */ + /** Top position of box */ top?: Spacing; - /** Bottom position of the box */ + /** Bottom position of box */ right?: Spacing; - /** Left position of the box */ + /** Left position of box */ bottom?: Spacing; - /** Right position of the box */ + /** Right position of box */ left?: Spacing; - /** Opcity of the box */ + /** Opacity of box */ opacity?: string; /** Visually hide the contents (still announced by screenreader) */ visuallyHidden?: boolean; - /** z-index of the box */ + /** z-index of box */ zIndex?: string; } diff --git a/polaris-react/src/components/Columns/Columns.tsx b/polaris-react/src/components/Columns/Columns.tsx index 0803bf86185..9e9db70d0a2 100644 --- a/polaris-react/src/components/Columns/Columns.tsx +++ b/polaris-react/src/components/Columns/Columns.tsx @@ -19,13 +19,12 @@ type Columns = { type Gap = ResponsiveProp; export interface ColumnsProps { - /** Elements to display inside columns */ children?: React.ReactNode; /** The number of columns to display * @default {xs: 6, sm: 6, md: 6, lg: 6, xl: 6} */ columns?: Columns; - /** The spacing between columns. Accepts a spacing token or an object of spacing tokens for different screen sizes. + /** The spacing between children. Accepts a spacing token or an object of spacing tokens for different screen sizes. * @default '4' * @example * gap='2' diff --git a/polaris-react/src/components/Inline/Inline.tsx b/polaris-react/src/components/Inline/Inline.tsx index 2ea47de9147..fd3a1030af2 100644 --- a/polaris-react/src/components/Inline/Inline.tsx +++ b/polaris-react/src/components/Inline/Inline.tsx @@ -18,11 +18,12 @@ type BlockAlign = 'start' | 'center' | 'end' | 'baseline' | 'stretch'; type Gap = ResponsiveProp; export interface InlineProps { - /** Adjust horizontal alignment of elements + children?: React.ReactNode; + /** Horizontal alignment of children * @default 'start' */ align?: Align; - /** Adjust vertical alignment of elements + /** Vertical alignment of children * @default 'center' */ blockAlign?: BlockAlign; @@ -37,8 +38,6 @@ export interface InlineProps { * @default true */ wrap?: boolean; - /** Elements to display inside stack */ - children?: React.ReactNode; } export const Inline = function Inline({ diff --git a/polaris-react/src/components/Tiles/Tiles.tsx b/polaris-react/src/components/Tiles/Tiles.tsx index a8e9deb56ba..7f5383b6c07 100644 --- a/polaris-react/src/components/Tiles/Tiles.tsx +++ b/polaris-react/src/components/Tiles/Tiles.tsx @@ -15,15 +15,19 @@ type Gap = { }; export interface TilesProps { - /** Elements to display inside tile */ - children: React.ReactNode; - /** Adjust spacing between elements */ - gap?: Gap; - /** Adjust number of columns */ + children?: React.ReactNode; + /** The number of columns to display + * @default {xs: 6, sm: 6, md: 6, lg: 6, xl: 6} + */ columns?: Columns; + /** The spacing between children. Accepts an object of spacing tokens for different screen sizes. + * @default {xs: 4, sm: 4, md: 4, lg: 4, xl: 4} + * @example gap={{xs: '1', sm: '2', md: '3', lg: '4', xl: '5'}} + */ + gap?: Gap; } -export const Tiles = ({children, gap, columns}: TilesProps) => { +export const Tiles = ({children, columns, gap}: TilesProps) => { const style = { '--pc-tile-gap-xs': gap?.xs ? `var(--p-space-${gap?.xs})` : undefined, '--pc-tile-gap-sm': gap?.sm ? `var(--p-space-${gap?.sm})` : undefined, diff --git a/polaris.shopify.com/src/data/props.json b/polaris.shopify.com/src/data/props.json index 1c8c85b22fc..bdece943bc1 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", @@ -8056,6 +8005,57 @@ "value": "interface Props {\n /** Callback when the search is dismissed */\n onDismiss?(): void;\n /** Determines whether the overlay should be visible */\n visible: boolean;\n}" } }, + "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": "" + } + }, "CardBackgroundColorTokenScale": { "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", @@ -8076,7 +8076,7 @@ "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", - "description": "Elements to display inside card", + "description": "", "isOptional": true }, { @@ -8106,7 +8106,7 @@ "isOptional": true } ], - "value": "export interface AlphaCardProps {\n /** Elements to display inside card */\n children?: React.ReactNode;\n /** Background color\n * @default 'surface'\n */\n background?: CardBackgroundColorTokenScale;\n /** The spacing around the card\n * @default '5'\n */\n padding?: SpacingSpaceScale;\n /** Border radius value above a set breakpoint */\n roundedAbove?: BreakpointsAlias;\n}" + "value": "export interface AlphaCardProps {\n children?: React.ReactNode;\n /** Background color\n * @default 'surface'\n */\n background?: CardBackgroundColorTokenScale;\n /** The spacing around the card\n * @default '5'\n */\n padding?: SpacingSpaceScale;\n /** Border radius value above a set breakpoint */\n roundedAbove?: BreakpointsAlias;\n}" } }, "Align": { @@ -8191,6 +8191,14 @@ "name": "AlphaStackProps", "description": "", "members": [ + { + "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, { "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", "syntaxKind": "PropertySignature", @@ -8200,20 +8208,12 @@ "isOptional": true, "defaultValue": "'div'" }, - { - "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Elements to display inside stack", - "isOptional": true - }, { "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", "syntaxKind": "PropertySignature", "name": "align", "value": "Align", - "description": "The vertical alignment of elements", + "description": "Vertical alignment of children", "isOptional": true, "defaultValue": "'start'" }, @@ -8222,20 +8222,21 @@ "syntaxKind": "PropertySignature", "name": "fullWidth", "value": "boolean", - "description": "Toggle elements to be full width", - "isOptional": true + "description": "Toggle children to be full width", + "isOptional": true, + "defaultValue": "false" }, { "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", "syntaxKind": "PropertySignature", "name": "gap", "value": "Gap", - "description": "The spacing between elements", + "description": "The spacing between children", "isOptional": true, "defaultValue": "'4'" } ], - "value": "export interface AlphaStackProps {\n /** HTML Element type\n * @default 'div'\n */\n as?: Element;\n /** Elements to display inside stack */\n children?: React.ReactNode;\n /** The vertical alignment of elements\n * @default 'start'\n */\n align?: Align;\n /** Toggle elements to be full width */\n fullWidth?: boolean;\n /** The spacing between elements\n * @default '4'\n */\n gap?: Gap;\n}" + "value": "export interface AlphaStackProps {\n children?: React.ReactNode;\n /** HTML Element type\n * @default 'div'\n */\n as?: Element;\n /** Vertical alignment of children\n * @default 'start'\n */\n align?: Align;\n /** Toggle children to be full width\n * @default false\n */\n fullWidth?: boolean;\n /** The spacing between children\n * @default '4'\n */\n gap?: Gap;\n}" } }, "State": { @@ -8607,6 +8608,21 @@ ], "value": "interface State {\n sliderHeight: number;\n draggerHeight: number;\n}" }, + "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx": { + "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", + "name": "State", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", + "syntaxKind": "PropertySignature", + "name": "dragging", + "value": "boolean", + "description": "" + } + ], + "value": "interface State {\n dragging: boolean;\n}" + }, "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx": { "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", "name": "State", @@ -8629,21 +8645,6 @@ ], "value": "interface State {\n sliderHeight: number;\n draggerHeight: number;\n}" }, - "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx": { - "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", - "name": "State", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", - "syntaxKind": "PropertySignature", - "name": "dragging", - "value": "boolean", - "description": "" - } - ], - "value": "interface State {\n dragging: boolean;\n}" - }, "polaris-react/src/components/Filters/components/ConnectedFilterControl/ConnectedFilterControl.tsx": { "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/ConnectedFilterControl.tsx", "name": "State", @@ -9684,22 +9685,24 @@ "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", - "description": "Elements to display inside tile" + "description": "", + "isOptional": true }, { "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", "syntaxKind": "PropertySignature", "name": "horizontal", "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "Negative horizontal space around the element\n* @default '5'", - "isOptional": true + "description": "Negative horizontal space around children", + "isOptional": true, + "defaultValue": "'5'" }, { "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", "syntaxKind": "PropertySignature", "name": "vertical", "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "Negative vertical space around the element", + "description": "Negative vertical space around children", "isOptional": true }, { @@ -9707,7 +9710,7 @@ "syntaxKind": "PropertySignature", "name": "top", "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "Negative top space around the element", + "description": "Negative top space around children", "isOptional": true }, { @@ -9715,7 +9718,7 @@ "syntaxKind": "PropertySignature", "name": "bottom", "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "Negative bottom space around the element", + "description": "Negative bottom space around children", "isOptional": true }, { @@ -9723,7 +9726,7 @@ "syntaxKind": "PropertySignature", "name": "left", "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "Negative left space around the element", + "description": "Negative left space around children", "isOptional": true }, { @@ -9731,11 +9734,11 @@ "syntaxKind": "PropertySignature", "name": "right", "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "Negative right space around the element", + "description": "Negative right space around children", "isOptional": true } ], - "value": "export interface BleedProps {\n /** Elements to display inside tile */\n children: React.ReactNode;\n /** Negative horizontal space around the element\n * * @default '5'\n */\n horizontal?: SpacingSpaceScale;\n /** Negative vertical space around the element */\n vertical?: SpacingSpaceScale;\n /** Negative top space around the element */\n top?: SpacingSpaceScale;\n /** Negative bottom space around the element */\n bottom?: SpacingSpaceScale;\n /** Negative left space around the element */\n left?: SpacingSpaceScale;\n /** Negative right space around the element */\n right?: SpacingSpaceScale;\n}" + "value": "export interface BleedProps {\n children?: React.ReactNode;\n /** Negative horizontal space around children\n * @default '5'\n */\n horizontal?: SpacingSpaceScale;\n /** Negative vertical space around children */\n vertical?: SpacingSpaceScale;\n /** Negative top space around children */\n top?: SpacingSpaceScale;\n /** Negative bottom space around children */\n bottom?: SpacingSpaceScale;\n /** Negative left space around children */\n left?: SpacingSpaceScale;\n /** Negative right space around children */\n right?: SpacingSpaceScale;\n}" } }, "Overflow": { @@ -9850,13 +9853,22 @@ "name": "BoxProps", "description": "", "members": [ + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, { "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "PropertySignature", "name": "as", "value": "Element", "description": "HTML Element type", - "isOptional": true + "isOptional": true, + "defaultValue": "'div'" }, { "filePath": "polaris-react/src/components/Box/Box.tsx", @@ -9943,7 +9955,7 @@ "syntaxKind": "PropertySignature", "name": "borderRadiusStartEnd", "value": "BorderRadiusTokenScale", - "description": "Verital start horizontal end border radius", + "description": "Vertical start horizontal end border radius", "isOptional": true }, { @@ -10087,7 +10099,7 @@ "syntaxKind": "PropertySignature", "name": "shadow", "value": "\"button\" | \"base\" | \"transparent\" | \"faint\" | \"deep\" | \"top-bar\" | \"card\" | \"popover\" | \"layer\" | \"modal\"", - "description": "Shadow", + "description": "Shadow on box", "isOptional": true }, { @@ -10098,20 +10110,12 @@ "description": "Width of container", "isOptional": true }, - { - "filePath": "polaris-react/src/components/Box/Box.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Elements to display inside box", - "isOptional": true - }, { "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "PropertySignature", "name": "position", "value": "Position", - "description": "Position of the box", + "description": "Position of box", "isOptional": true }, { @@ -10119,7 +10123,7 @@ "syntaxKind": "PropertySignature", "name": "top", "value": "Spacing", - "description": "Top position of the box", + "description": "Top position of box", "isOptional": true }, { @@ -10127,7 +10131,7 @@ "syntaxKind": "PropertySignature", "name": "right", "value": "Spacing", - "description": "Bottom position of the box", + "description": "Bottom position of box", "isOptional": true }, { @@ -10135,7 +10139,7 @@ "syntaxKind": "PropertySignature", "name": "bottom", "value": "Spacing", - "description": "Left position of the box", + "description": "Left position of box", "isOptional": true }, { @@ -10143,7 +10147,7 @@ "syntaxKind": "PropertySignature", "name": "left", "value": "Spacing", - "description": "Right position of the box", + "description": "Right position of box", "isOptional": true }, { @@ -10151,7 +10155,7 @@ "syntaxKind": "PropertySignature", "name": "opacity", "value": "string", - "description": "Opcity of the box", + "description": "Opacity of box", "isOptional": true }, { @@ -10167,11 +10171,11 @@ "syntaxKind": "PropertySignature", "name": "zIndex", "value": "string", - "description": "z-index of the box", + "description": "z-index of box", "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 /** Minimum height of container */\n minHeight?: string;\n /** Minimum width of container */\n minWidth?: string;\n /** Maximum width of container */\n maxWidth?: string;\n /** Clip horizontal content of children */\n overflowX?: Overflow;\n /** Clip vertical content of children */\n overflowY?: Overflow;\n /** Spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * padding='4'\n * padding={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n padding?: Spacing;\n /** Vertical start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingBlockStart='4'\n * paddingBlockStart={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingBlockStart?: Spacing;\n /** Vertical end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingBlockEnd='4'\n * paddingBlockEnd={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingBlockEnd?: Spacing;\n /** Horizontal start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingInlineStart='4'\n * paddingInlineStart={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingInlineStart?: Spacing;\n /** Horizontal end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingInlineEnd='4'\n * paddingInlineEnd={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingInlineEnd?: Spacing;\n /** Shadow */\n shadow?: DepthShadowAlias;\n /** Width of container */\n width?: string;\n /** Elements to display inside box */\n children?: React.ReactNode;\n // These could be moved to new layout component(s) in the future\n /** Position of the box */\n position?: Position;\n /** Top position of the box */\n top?: Spacing;\n /** Bottom position of the box */\n right?: Spacing;\n /** Left position of the box */\n bottom?: Spacing;\n /** Right position of the box */\n left?: Spacing;\n /** Opcity of the box */\n opacity?: string;\n /** Visually hide the contents (still announced by screenreader) */\n visuallyHidden?: boolean;\n /** z-index of the box */\n zIndex?: string;\n}" + "value": "export interface BoxProps {\n children?: React.ReactNode;\n /** HTML Element type\n * @default 'div'\n */\n as?: Element;\n /** Background color */\n background?: BackgroundColors;\n /** Border style */\n border?: BorderTokenAlias;\n /** Vertical end border style */\n borderBlockEnd?: BorderTokenAlias;\n /** Horizontal start border style */\n borderInlineStart?: BorderTokenAlias;\n /** Horizontal end border style */\n borderInlineEnd?: BorderTokenAlias;\n /** Vertical start border style */\n borderBlockStart?: BorderTokenAlias;\n /** Border radius */\n borderRadius?: BorderRadiusTokenScale;\n /** Vertical end horizontal start border radius */\n borderRadiusEndStart?: BorderRadiusTokenScale;\n /** Vertical end horizontal end border radius */\n borderRadiusEndEnd?: BorderRadiusTokenScale;\n /** Vertical start horizontal start border radius */\n borderRadiusStartStart?: BorderRadiusTokenScale;\n /** Vertical start horizontal end border radius */\n borderRadiusStartEnd?: BorderRadiusTokenScale;\n /** Border width */\n borderWidth?: ShapeBorderWidthScale;\n /** Vertical start border width */\n borderBlockStartWidth?: ShapeBorderWidthScale;\n /** Vertical end border width */\n borderBlockEndWidth?: ShapeBorderWidthScale;\n /** Horizontal start border width */\n borderInlineStartWidth?: ShapeBorderWidthScale;\n /** Horizontal end border width */\n borderInlineEndWidth?: ShapeBorderWidthScale;\n /** Color of children */\n color?: ColorTokenScale;\n /** HTML id attribute */\n id?: string;\n /** Minimum height of container */\n minHeight?: string;\n /** Minimum width of container */\n minWidth?: string;\n /** Maximum width of container */\n maxWidth?: string;\n /** Clip horizontal content of children */\n overflowX?: Overflow;\n /** Clip vertical content of children */\n overflowY?: Overflow;\n /** Spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * padding='4'\n * padding={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n padding?: Spacing;\n /** Vertical start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingBlockStart='4'\n * paddingBlockStart={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingBlockStart?: Spacing;\n /** Vertical end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingBlockEnd='4'\n * paddingBlockEnd={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingBlockEnd?: Spacing;\n /** Horizontal start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingInlineStart='4'\n * paddingInlineStart={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingInlineStart?: Spacing;\n /** Horizontal end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @example\n * paddingInlineEnd='4'\n * paddingInlineEnd={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n paddingInlineEnd?: Spacing;\n /** Shadow on box */\n shadow?: DepthShadowAlias;\n /** Width of container */\n width?: string;\n // These could be moved to new layout component(s) in the future\n /** Position of box */\n position?: Position;\n /** Top position of box */\n top?: Spacing;\n /** Bottom position of box */\n right?: Spacing;\n /** Left position of box */\n bottom?: Spacing;\n /** Right position of box */\n left?: Spacing;\n /** Opacity of box */\n opacity?: string;\n /** Visually hide the contents (still announced by screenreader) */\n visuallyHidden?: boolean;\n /** z-index of box */\n zIndex?: string;\n}" } }, "BreadcrumbsProps": { @@ -11797,7 +11801,7 @@ "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", - "description": "Elements to display inside columns", + "description": "", "isOptional": true }, { @@ -11814,12 +11818,12 @@ "syntaxKind": "PropertySignature", "name": "gap", "value": "Gap", - "description": "The spacing between columns. Accepts a spacing token or an object of spacing tokens for different screen sizes.", + "description": "The spacing between children. Accepts a spacing token or an object of spacing tokens for different screen sizes.", "isOptional": true, "defaultValue": "'4'" } ], - "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}" + "value": "export interface ColumnsProps {\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 children. 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": { @@ -14298,12 +14302,20 @@ "name": "InlineProps", "description": "", "members": [ + { + "filePath": "polaris-react/src/components/Inline/Inline.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, { "filePath": "polaris-react/src/components/Inline/Inline.tsx", "syntaxKind": "PropertySignature", "name": "align", "value": "Align", - "description": "Adjust horizontal alignment of elements", + "description": "Horizontal alignment of children", "isOptional": true, "defaultValue": "'start'" }, @@ -14312,7 +14324,7 @@ "syntaxKind": "PropertySignature", "name": "blockAlign", "value": "BlockAlign", - "description": "Adjust vertical alignment of elements", + "description": "Vertical alignment of children", "isOptional": true, "defaultValue": "'center'" }, @@ -14333,17 +14345,9 @@ "description": "Wrap stack elements to additional rows as needed on small screens", "isOptional": true, "defaultValue": "true" - }, - { - "filePath": "polaris-react/src/components/Inline/Inline.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Elements to display inside stack", - "isOptional": true } ], - "value": "export interface InlineProps {\n /** Adjust horizontal alignment of elements\n * @default 'start'\n */\n align?: Align;\n /** Adjust vertical alignment of elements\n * @default 'center'\n */\n blockAlign?: BlockAlign;\n /** The spacing between elements. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @default '4'\n * @example\n * gap='2'\n * gap={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n gap?: Gap;\n /** Wrap stack elements to additional rows as needed on small screens\n * @default true\n */\n wrap?: boolean;\n /** Elements to display inside stack */\n children?: React.ReactNode;\n}" + "value": "export interface InlineProps {\n children?: React.ReactNode;\n /** Horizontal alignment of children\n * @default 'start'\n */\n align?: Align;\n /** Vertical alignment of children\n * @default 'center'\n */\n blockAlign?: BlockAlign;\n /** The spacing between elements. Accepts a spacing token or an object of spacing tokens for different screen sizes.\n * @default '4'\n * @example\n * gap='2'\n * gap={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n gap?: Gap;\n /** Wrap stack elements to additional rows as needed on small screens\n * @default true\n */\n wrap?: boolean;\n}" } }, "InlineCodeProps": { @@ -14742,151 +14746,46 @@ "value": "export interface ListProps {\n focusIndex: number;\n disclosureTabs: TabDescriptor[];\n onClick?(id: string): void;\n onKeyPress?(event: React.KeyboardEvent): void;\n}" } }, - "LoadingProps": { - "polaris-react/src/components/Loading/Loading.tsx": { - "filePath": "polaris-react/src/components/Loading/Loading.tsx", - "name": "LoadingProps", - "description": "", - "members": [], - "value": "export interface LoadingProps {}" - }, - "polaris-react/src/components/Listbox/components/Loading/Loading.tsx": { - "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", - "name": "LoadingProps", - "description": "", + "AutoSelection": { + "polaris-react/src/components/Listbox/Listbox.tsx": { + "filePath": "polaris-react/src/components/Listbox/Listbox.tsx", + "syntaxKind": "EnumDeclaration", + "name": "AutoSelection", + "value": "export enum AutoSelection {\n /** Default active option is the first selected option. If no options are selected, defaults to first interactive option. */\n FirstSelected = 'FIRST_SELECTED',\n /** Default active option is always the first interactive option. */\n First = 'FIRST',\n /** Default to the manual selection pattern. */\n None = 'NONE',\n}", "members": [ { - "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true + "filePath": "polaris-react/src/components/Listbox/Listbox.tsx", + "name": "FirstSelected", + "value": "FIRST_SELECTED" }, { - "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "" + "filePath": "polaris-react/src/components/Listbox/Listbox.tsx", + "name": "First", + "value": "FIRST" + }, + { + "filePath": "polaris-react/src/components/Listbox/Listbox.tsx", + "name": "None", + "value": "NONE" } - ], - "value": "export interface LoadingProps {\n children?: React.ReactNode;\n accessibilityLabel: string;\n}" + ] } }, - "MediaCardProps": { - "polaris-react/src/components/MediaCard/MediaCard.tsx": { - "filePath": "polaris-react/src/components/MediaCard/MediaCard.tsx", - "name": "MediaCardProps", + "ListboxProps": { + "polaris-react/src/components/Listbox/Listbox.tsx": { + "filePath": "polaris-react/src/components/Listbox/Listbox.tsx", + "name": "ListboxProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/MediaCard/MediaCard.tsx", + "filePath": "polaris-react/src/components/Listbox/Listbox.tsx", "syntaxKind": "PropertySignature", "name": "children", - "value": "React.ReactNode", - "description": "The visual media to display in the card" + "value": "ReactNode", + "description": "Inner content of the listbox" }, { - "filePath": "polaris-react/src/components/MediaCard/MediaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "React.ReactNode", - "description": "Heading content" - }, - { - "filePath": "polaris-react/src/components/MediaCard/MediaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "Body content" - }, - { - "filePath": "polaris-react/src/components/MediaCard/MediaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "primaryAction", - "value": "ComplexAction", - "description": "Main call to action, rendered as a basic button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/MediaCard/MediaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "secondaryAction", - "value": "ComplexAction", - "description": "Secondary call to action, rendered as a plain button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/MediaCard/MediaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "popoverActions", - "value": "ActionListItemDescriptor[]", - "description": "Action list items to render in ellipsis popover", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/MediaCard/MediaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "portrait", - "value": "boolean", - "description": "Whether or not card content should be laid out vertically", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "polaris-react/src/components/MediaCard/MediaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "size", - "value": "Size", - "description": "Size of the visual media in the card", - "isOptional": true, - "defaultValue": "'medium'" - } - ], - "value": "interface MediaCardProps {\n /** The visual media to display in the card */\n children: React.ReactNode;\n /** Heading content */\n title: React.ReactNode;\n /** Body content */\n description: string;\n /** Main call to action, rendered as a basic button */\n primaryAction?: ComplexAction;\n /** Secondary call to action, rendered as a plain button */\n secondaryAction?: ComplexAction;\n /** Action list items to render in ellipsis popover */\n popoverActions?: ActionListItemDescriptor[];\n /** Whether or not card content should be laid out vertically\n * @default false\n */\n portrait?: boolean;\n /** Size of the visual media in the card\n * @default 'medium'\n */\n size?: Size;\n}" - } - }, - "AutoSelection": { - "polaris-react/src/components/Listbox/Listbox.tsx": { - "filePath": "polaris-react/src/components/Listbox/Listbox.tsx", - "syntaxKind": "EnumDeclaration", - "name": "AutoSelection", - "value": "export enum AutoSelection {\n /** Default active option is the first selected option. If no options are selected, defaults to first interactive option. */\n FirstSelected = 'FIRST_SELECTED',\n /** Default active option is always the first interactive option. */\n First = 'FIRST',\n /** Default to the manual selection pattern. */\n None = 'NONE',\n}", - "members": [ - { - "filePath": "polaris-react/src/components/Listbox/Listbox.tsx", - "name": "FirstSelected", - "value": "FIRST_SELECTED" - }, - { - "filePath": "polaris-react/src/components/Listbox/Listbox.tsx", - "name": "First", - "value": "FIRST" - }, - { - "filePath": "polaris-react/src/components/Listbox/Listbox.tsx", - "name": "None", - "value": "NONE" - } - ] - } - }, - "ListboxProps": { - "polaris-react/src/components/Listbox/Listbox.tsx": { - "filePath": "polaris-react/src/components/Listbox/Listbox.tsx", - "name": "ListboxProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Listbox/Listbox.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", - "description": "Inner content of the listbox" - }, - { - "filePath": "polaris-react/src/components/Listbox/Listbox.tsx", + "filePath": "polaris-react/src/components/Listbox/Listbox.tsx", "syntaxKind": "PropertySignature", "name": "autoSelection", "value": "AutoSelection", @@ -14947,6 +14846,111 @@ "description": "" } }, + "LoadingProps": { + "polaris-react/src/components/Loading/Loading.tsx": { + "filePath": "polaris-react/src/components/Loading/Loading.tsx", + "name": "LoadingProps", + "description": "", + "members": [], + "value": "export interface LoadingProps {}" + }, + "polaris-react/src/components/Listbox/components/Loading/Loading.tsx": { + "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", + "name": "LoadingProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "" + } + ], + "value": "export interface LoadingProps {\n children?: React.ReactNode;\n accessibilityLabel: string;\n}" + } + }, + "MediaCardProps": { + "polaris-react/src/components/MediaCard/MediaCard.tsx": { + "filePath": "polaris-react/src/components/MediaCard/MediaCard.tsx", + "name": "MediaCardProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/MediaCard/MediaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The visual media to display in the card" + }, + { + "filePath": "polaris-react/src/components/MediaCard/MediaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "React.ReactNode", + "description": "Heading content" + }, + { + "filePath": "polaris-react/src/components/MediaCard/MediaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "Body content" + }, + { + "filePath": "polaris-react/src/components/MediaCard/MediaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "primaryAction", + "value": "ComplexAction", + "description": "Main call to action, rendered as a basic button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/MediaCard/MediaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "secondaryAction", + "value": "ComplexAction", + "description": "Secondary call to action, rendered as a plain button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/MediaCard/MediaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "popoverActions", + "value": "ActionListItemDescriptor[]", + "description": "Action list items to render in ellipsis popover", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/MediaCard/MediaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "portrait", + "value": "boolean", + "description": "Whether or not card content should be laid out vertically", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "polaris-react/src/components/MediaCard/MediaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "Size", + "description": "Size of the visual media in the card", + "isOptional": true, + "defaultValue": "'medium'" + } + ], + "value": "interface MediaCardProps {\n /** The visual media to display in the card */\n children: React.ReactNode;\n /** Heading content */\n title: React.ReactNode;\n /** Body content */\n description: string;\n /** Main call to action, rendered as a basic button */\n primaryAction?: ComplexAction;\n /** Secondary call to action, rendered as a plain button */\n secondaryAction?: ComplexAction;\n /** Action list items to render in ellipsis popover */\n popoverActions?: ActionListItemDescriptor[];\n /** Whether or not card content should be laid out vertically\n * @default false\n */\n portrait?: boolean;\n /** Size of the visual media in the card\n * @default 'medium'\n */\n size?: Size;\n}" + } + }, "MessageIndicatorProps": { "polaris-react/src/components/MessageIndicator/MessageIndicator.tsx": { "filePath": "polaris-react/src/components/MessageIndicator/MessageIndicator.tsx", @@ -18319,26 +18323,29 @@ "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", - "description": "Elements to display inside tile" + "description": "", + "isOptional": true }, { "filePath": "polaris-react/src/components/Tiles/Tiles.tsx", "syntaxKind": "PropertySignature", - "name": "gap", - "value": "Gap", - "description": "Adjust spacing between elements", - "isOptional": true + "name": "columns", + "value": "Columns", + "description": "The number of columns to display", + "isOptional": true, + "defaultValue": "{xs: 6, sm: 6, md: 6, lg: 6, xl: 6}" }, { "filePath": "polaris-react/src/components/Tiles/Tiles.tsx", "syntaxKind": "PropertySignature", - "name": "columns", - "value": "Columns", - "description": "Adjust number of columns", - "isOptional": true + "name": "gap", + "value": "Gap", + "description": "The spacing between children. Accepts an object of spacing tokens for different screen sizes.", + "isOptional": true, + "defaultValue": "{xs: 4, sm: 4, md: 4, lg: 4, xl: 4}" } ], - "value": "export interface TilesProps {\n /** Elements to display inside tile */\n children: React.ReactNode;\n /** Adjust spacing between elements */\n gap?: Gap;\n /** Adjust number of columns */\n columns?: Columns;\n}" + "value": "export interface TilesProps {\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 children. Accepts an object of spacing tokens for different screen sizes.\n * @default {xs: 4, sm: 4, md: 4, lg: 4, xl: 4}\n * @example gap={{xs: '1', sm: '2', md: '3', lg: '4', xl: '5'}}\n */\n gap?: Gap;\n}" } }, "TooltipProps": { @@ -21997,352 +22004,564 @@ "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", + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden menu description for screen readers", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.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", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "sections", + "value": "readonly ActionListSection[]", + "description": "Collection of sectioned action items", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "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" + }, + { + "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/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "details", "value": "React.ReactNode", + "description": "Action details", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Disables action button", + "isOptional": true + }, + { + "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/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "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 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 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/List/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Content to display inside the item", + "name": "accessibilityLabel", + "value": "string", + "description": "Accessibilty label", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "syntaxKind": "PropertySignature", + "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 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": "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": "helpText", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onAction", + "value": "() => void", + "description": "", + "isOptional": true + }, + { + "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/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "string | string[]", + "description": "The content to display inside the button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "PropertySignature", + "name": "primary", + "value": "boolean", + "description": "Provides extra visual weight and identifies the primary action in a set of buttons", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "PropertySignature", + "name": "destructive", + "value": "boolean", + "description": "Indicates a dangerous or potentially negative action", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "\"medium\" | \"large\" | \"slim\"", + "description": "Changes the size of the button, giving it more or less padding", + "isOptional": true, + "defaultValue": "'medium'" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "PropertySignature", + "name": "textAlign", + "value": "\"start\" | \"end\" | \"center\" | \"left\" | \"right\"", + "description": "Changes the inner text alignment of the button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "PropertySignature", + "name": "outline", + "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/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "PropertySignature", + "name": "fullWidth", + "value": "boolean", + "description": "Allows the button to grow to the width of its container", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "PropertySignature", + "name": "disclosure", + "value": "boolean | \"up\" | \"down\" | \"select\"", + "description": "Displays the button with a disclosure icon. Defaults to `down` when set to true", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "PropertySignature", + "name": "plain", + "value": "boolean", + "description": "Renders a button that looks like a link", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.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", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "PropertySignature", + "name": "removeUnderline", + "value": "boolean", + "description": "Removes underline from button text (including on interaction) when `monochrome` and `plain` are true", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", "name": "icon", "value": "any", - "description": "", + "description": "Icon to display to the left of the button content", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "PropertySignature", + "name": "connectedDisclosure", + "value": "ConnectedDisclosure", + "description": "Disclosure button connected right of the button. Toggles a popover action list.", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "badge", - "value": "ReactNode", - "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/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "label", + "name": "id", "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "", + "description": "A unique identifier for the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", + "name": "url", "value": "string", - "description": "", + "description": "A destination to link to, rendered in the href attribute of a link", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "selected", + "name": "external", "value": "boolean", - "description": "", + "description": "Forces url to open in a new tab", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "exactMatch", - "value": "boolean", - "description": "", + "name": "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/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "new", + "name": "submit", "value": "boolean", - "description": "", + "description": "Allows the button to submit a form", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "subNavigationItems", - "value": "SubNavigationItem[]", - "description": "", + "name": "disabled", + "value": "boolean", + "description": "Disables the button, disallowing merchant interaction", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "secondaryAction", - "value": "SecondaryAction", - "description": "", + "name": "loading", + "value": "boolean", + "description": "Replaces button text with a spinner while a background action is being performed", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "PropertySignature", + "name": "pressed", + "value": "boolean", + "description": "Sets the button in a pressed state", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onToggleExpandedState", - "value": "() => void", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden text for screen readers", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "expanded", - "value": "boolean", - "description": "", + "name": "role", + "value": "string", + "description": "A valid WAI-ARIA role to define the semantic value of this element", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "shouldResizeIcon", - "value": "boolean", - "description": "", + "name": "ariaControls", + "value": "string", + "description": "Id of the element the button controls", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "truncateText", + "name": "ariaExpanded", "value": "boolean", - "description": "", + "description": "Tells screen reader the controlled element is expanded", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "url", + "name": "ariaDescribedBy", "value": "string", - "description": "", + "description": "Indicates the ID of the element that describes the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "matches", - "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 }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "matchPaths", - "value": "string[]", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "Callback when clicked", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "excludePaths", - "value": "string[]", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onFocus", + "value": "() => void", + "description": "Callback when button becomes focussed", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "external", - "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 - } - ], - "value": "export interface ItemProps extends ItemURLDetails {\n icon?: IconProps['source'];\n badge?: ReactNode;\n label: string;\n disabled?: boolean;\n accessibilityLabel?: string;\n selected?: boolean;\n exactMatch?: boolean;\n new?: boolean;\n subNavigationItems?: SubNavigationItem[];\n secondaryAction?: SecondaryAction;\n onClick?(): void;\n onToggleExpandedState?(): void;\n expanded?: boolean;\n shouldResizeIcon?: boolean;\n truncateText?: boolean;\n}" - }, - "polaris-react/src/components/Stack/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Elements to display inside item", + "filePath": "polaris-react/src/components/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/Stack/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "fill", - "value": "boolean", - "description": "Fill the remaining horizontal space in the stack with the item", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyUp", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keyup event is registered on the button", "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", - "syntaxKind": "PropertySignature", - "name": "focused", - "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/Tabs/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "panelID", - "value": "string", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onMouseEnter", + "value": "() => void", + "description": "Callback when mouse enter", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onTouchStart", + "value": "() => void", + "description": "Callback when element is touched", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onPointerDown", + "value": "() => void", + "description": "Callback when pointerdown event is being triggered", + "isOptional": true + } + ], + "value": "interface SecondaryAction extends ButtonProps {\n helpText?: React.ReactNode;\n onAction?(): void;\n getOffsetWidth?(width: number): void;\n}" + }, + "polaris-react/src/components/Navigation/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "name": "SecondaryAction", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", "name": "url", "value": "string", - "description": "", - "isOptional": true + "description": "" }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "", - "isOptional": true + "description": "" + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "any", + "description": "" }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "MethodSignature", "name": "onClick", "value": "() => void", "description": "", "isOptional": true - } - ], - "value": "export interface ItemProps {\n id: string;\n focused: boolean;\n panelID?: string;\n children?: React.ReactNode;\n url?: string;\n accessibilityLabel?: string;\n onClick?(): void;\n}" - }, - "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", + "name": "tooltip", + "value": "TooltipProps", "description": "", "isOptional": true } ], - "value": "interface ItemProps {\n children?: React.ReactNode;\n}" + "value": "interface SecondaryAction {\n url: string;\n accessibilityLabel: string;\n icon: IconProps['source'];\n onClick?(): void;\n tooltip?: TooltipProps;\n}" } }, "SectionProps": { @@ -22583,438 +22802,352 @@ "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", + "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", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Accessibilty label", - "isOptional": true - }, - { - "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", - "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": "sections", - "value": "ActionListSection[]", - "description": "Collection of sectioned action items", + "name": "children", + "value": "React.ReactNode", + "description": "Item content", "isOptional": true } ], - "value": "export interface RollupActionsProps {\n /** Accessibilty label */\n accessibilityLabel?: string;\n /** Collection of actions for the list */\n items?: ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: ActionListSection[];\n}" - } - }, - "SecondaryAction": { - "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "name": "SecondaryAction", + "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/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "helpText", + "name": "children", "value": "React.ReactNode", "description": "", "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onAction", - "value": "() => void", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "getOffsetWidth", - "value": "(width: number) => void", - "description": "", - "isOptional": true - }, + } + ], + "value": "export interface ItemProps {\n children?: React.ReactNode;\n}" + }, + "polaris-react/src/components/List/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", "syntaxKind": "PropertySignature", "name": "children", - "value": "string | string[]", - "description": "The content to display inside the button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "PropertySignature", - "name": "primary", - "value": "boolean", - "description": "Provides extra visual weight and identifies the primary action in a set of buttons", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "PropertySignature", - "name": "destructive", - "value": "boolean", - "description": "Indicates a dangerous or potentially negative action", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "PropertySignature", - "name": "size", - "value": "\"medium\" | \"large\" | \"slim\"", - "description": "Changes the size of the button, giving it more or less padding", - "isOptional": true, - "defaultValue": "'medium'" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "PropertySignature", - "name": "textAlign", - "value": "\"start\" | \"end\" | \"center\" | \"left\" | \"right\"", - "description": "Changes the inner text alignment of the button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "PropertySignature", - "name": "outline", - "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/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "PropertySignature", - "name": "fullWidth", - "value": "boolean", - "description": "Allows the button to grow to the width of its container", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "PropertySignature", - "name": "disclosure", - "value": "boolean | \"up\" | \"down\" | \"select\"", - "description": "Displays the button with a disclosure icon. Defaults to `down` when set to true", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "PropertySignature", - "name": "plain", - "value": "boolean", - "description": "Renders a button that looks like a link", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.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", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "PropertySignature", - "name": "removeUnderline", - "value": "boolean", - "description": "Removes underline from button text (including on interaction) when `monochrome` and `plain` are true", + "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/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", "name": "icon", "value": "any", - "description": "Icon to display to the left of the button content", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "PropertySignature", - "name": "connectedDisclosure", - "value": "ConnectedDisclosure", - "description": "Disclosure button connected right of the button. Toggles a popover action list.", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "PropertySignature", - "name": "dataPrimaryLink", - "value": "boolean", - "description": "Indicates whether or not the button is the primary navigation link when rendered inside of an `IndexTable.Row`", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the button", + "name": "badge", + "value": "ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "url", + "name": "label", "value": "string", - "description": "A destination to link to, rendered in the href attribute of a link", - "isOptional": true + "description": "" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "external", + "name": "disabled", "value": "boolean", - "description": "Forces url to open in a new tab", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "download", - "value": "string | boolean", - "description": "Tells the browser to download the url instead of opening it. Provides a hint for the downloaded filename if it is a string value", + "name": "accessibilityLabel", + "value": "string", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "submit", + "name": "selected", "value": "boolean", - "description": "Allows the button to submit a form", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", + "name": "exactMatch", "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/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "loading", + "name": "new", "value": "boolean", - "description": "Replaces button text with a spinner while a background action is being performed", + "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": "pressed", - "value": "boolean", - "description": "Sets the button in a pressed state", + "name": "subNavigationItems", + "value": "SubNavigationItem[]", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Visually hidden text for screen readers", + "name": "secondaryAction", + "value": "SecondaryAction", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "PropertySignature", - "name": "role", - "value": "string", - "description": "A valid WAI-ARIA role to define the semantic value of this element", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "PropertySignature", - "name": "ariaControls", - "value": "string", - "description": "Id of the element the button controls", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "MethodSignature", + "name": "onToggleExpandedState", + "value": "() => void", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "ariaExpanded", + "name": "expanded", "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/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "ariaDescribedBy", - "value": "string", - "description": "Indicates the ID of the element that describes the button", + "name": "shouldResizeIcon", + "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": "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", + "name": "truncateText", + "value": "boolean", + "description": "", "isOptional": true }, { - "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/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "url", + "value": "string", + "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/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "matches", + "value": "boolean", + "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", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "matchPaths", + "value": "string[]", + "description": "", "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", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "excludePaths", + "value": "string[]", + "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/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "external", + "value": "boolean", + "description": "", "isOptional": true - }, + } + ], + "value": "export interface ItemProps extends ItemURLDetails {\n icon?: IconProps['source'];\n badge?: ReactNode;\n label: string;\n disabled?: boolean;\n accessibilityLabel?: string;\n selected?: boolean;\n exactMatch?: boolean;\n new?: boolean;\n subNavigationItems?: SubNavigationItem[];\n secondaryAction?: SecondaryAction;\n onClick?(): void;\n onToggleExpandedState?(): void;\n expanded?: boolean;\n shouldResizeIcon?: boolean;\n 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", - "syntaxKind": "MethodSignature", - "name": "onTouchStart", - "value": "() => void", - "description": "Callback when element is touched", + "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", - "syntaxKind": "MethodSignature", - "name": "onPointerDown", - "value": "() => void", - "description": "Callback when pointerdown event is being triggered", + "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "fill", + "value": "boolean", + "description": "Fill the remaining horizontal space in the stack with the item", "isOptional": true } ], - "value": "interface SecondaryAction extends ButtonProps {\n helpText?: React.ReactNode;\n onAction?(): void;\n getOffsetWidth?(width: number): void;\n}" + "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/Navigation/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "SecondaryAction", + "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/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "url", + "name": "id", "value": "string", "description": "" }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", + "name": "focused", + "value": "boolean", "description": "" }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "" + "name": "panelID", + "value": "string", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "url", + "value": "string", + "description": "", + "isOptional": true + }, + { + "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/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "tooltip", - "value": "TooltipProps", + "name": "children", + "value": "React.ReactNode", "description": "", "isOptional": true } ], - "value": "interface SecondaryAction {\n url: string;\n accessibilityLabel: string;\n icon: IconProps['source'];\n onClick?(): void;\n tooltip?: TooltipProps;\n}" + "value": "interface ItemProps {\n children?: React.ReactNode;\n}" } }, "MappedAction": { @@ -23329,150 +23462,6 @@ "value": "export interface BulkActionsMenuProps extends MenuGroupDescriptor {\n isNewBadgeInBadgeActions: boolean;\n}" } }, - "MenuGroupProps": { - "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "name": "MenuGroupProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Visually hidden menu description for screen readers", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.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", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "sections", - "value": "readonly ActionListSection[]", - "description": "Collection of sectioned action items", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "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" - }, - { - "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/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "details", - "value": "React.ReactNode", - "description": "Action details", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables action button", - "isOptional": true - }, - { - "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/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "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}" - } - }, - "CardSubsectionProps": { - "polaris-react/src/components/Card/components/Subsection/Subsection.tsx": { - "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", - "name": "CardSubsectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "export interface CardSubsectionProps {\n children?: React.ReactNode;\n}" - } - }, "CardHeaderProps": { "polaris-react/src/components/Card/components/Header/Header.tsx": { "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", @@ -23507,61 +23496,6 @@ "value": "export interface CardHeaderProps {\n title?: React.ReactNode;\n actions?: DisableableAction[];\n children?: React.ReactNode;\n}" } }, - "AlphaPickerProps": { - "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx": { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", - "name": "AlphaPickerProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", - "syntaxKind": "PropertySignature", - "name": "color", - "value": "HSBColor", - "description": "" - }, - { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", - "syntaxKind": "PropertySignature", - "name": "alpha", - "value": "number", - "description": "" - }, - { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", - "syntaxKind": "MethodSignature", - "name": "onChange", - "value": "(hue: number) => void", - "description": "" - } - ], - "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}" - } - }, "CardSectionProps": { "polaris-react/src/components/Card/components/Section/Section.tsx": { "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", @@ -23609,23 +23543,72 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "hideOnPrint", + "value": "boolean", + "description": "Allow the card to be hidden when printing", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "actions", + "value": "ComplexAction[]", + "description": "", + "isOptional": true + } + ], + "value": "export interface CardSectionProps {\n title?: React.ReactNode;\n children?: React.ReactNode;\n subdued?: boolean;\n flush?: boolean;\n fullWidth?: boolean;\n /** Allow the card to be hidden when printing */\n hideOnPrint?: boolean;\n actions?: ComplexAction[];\n}" + } + }, + "CardSubsectionProps": { + "polaris-react/src/components/Card/components/Subsection/Subsection.tsx": { + "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", + "name": "CardSubsectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "export interface CardSubsectionProps {\n children?: React.ReactNode;\n}" + } + }, + "AlphaPickerProps": { + "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx": { + "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", + "name": "AlphaPickerProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", + "syntaxKind": "PropertySignature", + "name": "color", + "value": "HSBColor", + "description": "" + }, + { + "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", "syntaxKind": "PropertySignature", - "name": "hideOnPrint", - "value": "boolean", - "description": "Allow the card to be hidden when printing", - "isOptional": true + "name": "alpha", + "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/AlphaPicker/AlphaPicker.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 AlphaPickerProps {\n color: HSBColor;\n alpha: number;\n onChange(hue: number): void;\n}" } }, "SlidableProps": { @@ -23669,6 +23652,30 @@ "value": "export interface SlidableProps {\n draggerX?: number;\n draggerY?: number;\n onChange(position: Position): void;\n onDraggerHeight?(height: 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}" + } + }, "ItemPosition": { "polaris-react/src/components/Connected/components/Item/Item.tsx": { "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", @@ -24470,6 +24477,48 @@ "value": "interface ComputedProperty {\n [key: string]: number;\n}" } }, + "GroupProps": { + "polaris-react/src/components/FormLayout/components/Group/Group.tsx": { + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "name": "GroupProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "syntaxKind": "PropertySignature", + "name": "condensed", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "syntaxKind": "PropertySignature", + "name": "helpText", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "export interface GroupProps {\n children?: React.ReactNode;\n condensed?: boolean;\n title?: string;\n helpText?: React.ReactNode;\n}" + } + }, "AnimationType": { "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx": { "filePath": "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx", @@ -24535,48 +24584,6 @@ "value": "export interface ToastManagerProps {\n toastMessages: ToastPropsWithID[];\n}" } }, - "GroupProps": { - "polaris-react/src/components/FormLayout/components/Group/Group.tsx": { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "name": "GroupProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "syntaxKind": "PropertySignature", - "name": "condensed", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "syntaxKind": "PropertySignature", - "name": "helpText", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "export interface GroupProps {\n children?: React.ReactNode;\n condensed?: boolean;\n title?: string;\n helpText?: React.ReactNode;\n}" - } - }, "Cell": { "polaris-react/src/components/Grid/components/Cell/Cell.tsx": { "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", @@ -24773,6 +24780,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", @@ -24896,120 +24968,55 @@ "deprecationMessage": "Additional navigation markup" }, { - "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", - "syntaxKind": "PropertySignature", - "name": "additionalMetadata", - "value": "any", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", - "syntaxKind": "MethodSignature", - "name": "onActionRollup", - "value": "(hasRolledUp: boolean) => void", - "description": "Callback that returns true when secondary actions are rolled up into action groups, and false when not", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "Page title, in large type", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", - "syntaxKind": "PropertySignature", - "name": "subtitle", - "value": "string", - "description": "Page subtitle, in regular type", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Page/components/Header/Header.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/Header.tsx", - "syntaxKind": "PropertySignature", - "name": "compactTitle", - "value": "boolean", - "description": "Removes spacing between title and subtitle", - "isOptional": true - } - ], - "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", + "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", "syntaxKind": "PropertySignature", - "name": "icon", + "name": "additionalMetadata", "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": "", + "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", + "syntaxKind": "MethodSignature", + "name": "onActionRollup", + "value": "(hasRolledUp: boolean) => void", + "description": "Callback that returns true when secondary actions are rolled up into action groups, and false when not", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "any", - "description": "", + "name": "title", + "value": "string", + "description": "Page title, in large type", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", "syntaxKind": "PropertySignature", - "name": "selected", - "value": "boolean", - "description": "", + "name": "subtitle", + "value": "string", + "description": "Page subtitle, in regular type", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "", + "name": "titleMetadata", + "value": "React.ReactNode", + "description": "Important and non-interactive status information shown immediately after the title.", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", "syntaxKind": "PropertySignature", - "name": "divider", + "name": "compactTitle", "value": "boolean", - "description": "", + "description": "Removes spacing between title and subtitle", "isOptional": true } ], - "value": "interface ActionProps extends OptionProps {\n icon?: IconProps['source'];\n}" + "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}" } }, "OptionProps": { @@ -25175,70 +25182,70 @@ "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", + "TextOptionProps": { + "polaris-react/src/components/Listbox/components/TextOption/TextOption.tsx": { + "filePath": "polaris-react/src/components/Listbox/components/TextOption/TextOption.tsx", + "name": "TextOptionProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "filePath": "polaris-react/src/components/Listbox/components/TextOption/TextOption.tsx", "syntaxKind": "PropertySignature", - "name": "pressed", + "name": "children", + "value": "React.ReactNode", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Listbox/components/TextOption/TextOption.tsx", + "syntaxKind": "PropertySignature", + "name": "selected", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "filePath": "polaris-react/src/components/Listbox/components/TextOption/TextOption.tsx", "syntaxKind": "PropertySignature", - "name": "titleHidden", + "name": "disabled", "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}" + "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}" } }, - "TextOptionProps": { - "polaris-react/src/components/Listbox/components/TextOption/TextOption.tsx": { - "filePath": "polaris-react/src/components/Listbox/components/TextOption/TextOption.tsx", - "name": "TextOptionProps", + "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/Listbox/components/TextOption/TextOption.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Listbox/components/TextOption/TextOption.tsx", + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", "syntaxKind": "PropertySignature", - "name": "selected", + "name": "pressed", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/TextOption/TextOption.tsx", + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", + "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 TextOptionProps {\n children: React.ReactNode;\n // Whether the option is selected\n selected?: boolean;\n // Whether the option is disabled\n disabled?: boolean;\n}" + "value": "export interface CloseButtonProps {\n pressed?: boolean;\n titleHidden?: boolean;\n onClick(): void;\n}" } }, "DialogProps": { @@ -26515,6 +26522,76 @@ "description": "" } }, + "TooltipOverlayProps": { + "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx": { + "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", + "name": "TooltipOverlayProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", + "syntaxKind": "PropertySignature", + "name": "active", + "value": "boolean", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", + "syntaxKind": "PropertySignature", + "name": "preventInteraction", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", + "syntaxKind": "PropertySignature", + "name": "preferredPosition", + "value": "PreferredPosition", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", + "syntaxKind": "PropertySignature", + "name": "activator", + "value": "HTMLElement", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", + "syntaxKind": "MethodSignature", + "name": "onClose", + "value": "() => void", + "description": "" + } + ], + "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", @@ -26775,76 +26852,6 @@ "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}" } }, - "TooltipOverlayProps": { - "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx": { - "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", - "name": "TooltipOverlayProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", - "syntaxKind": "PropertySignature", - "name": "active", - "value": "boolean", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", - "syntaxKind": "PropertySignature", - "name": "preventInteraction", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", - "syntaxKind": "PropertySignature", - "name": "preferredPosition", - "value": "PreferredPosition", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", - "syntaxKind": "PropertySignature", - "name": "activator", - "value": "HTMLElement", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", - "syntaxKind": "MethodSignature", - "name": "onClose", - "value": "() => void", - "description": "" - } - ], - "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}" - } - }, "DiscardConfirmationModalProps": { "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx": { "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx",