diff --git a/.changeset/happy-llamas-doubt.md b/.changeset/happy-llamas-doubt.md new file mode 100644 index 00000000000..f822a066436 --- /dev/null +++ b/.changeset/happy-llamas-doubt.md @@ -0,0 +1,6 @@ +--- +'@shopify/polaris': minor +'polaris.shopify.com': patch +--- + +Added support for `ul` element on `Box` diff --git a/polaris-react/src/components/Box/Box.scss b/polaris-react/src/components/Box/Box.scss index aea65bf5056..fc8e66ead3c 100644 --- a/polaris-react/src/components/Box/Box.scss +++ b/polaris-react/src/components/Box/Box.scss @@ -112,3 +112,11 @@ .visuallyHidden { @include visually-hidden; } + +.listReset { + list-style-type: none; + margin-block-start: 0; + margin-block-end: 0; + outline: none; + padding-inline-start: 0; +} diff --git a/polaris-react/src/components/Box/Box.tsx b/polaris-react/src/components/Box/Box.tsx index 6a0bf7b5201..50f7cf86ad5 100644 --- a/polaris-react/src/components/Box/Box.tsx +++ b/polaris-react/src/components/Box/Box.tsx @@ -19,7 +19,7 @@ import { import styles from './Box.scss'; -type Element = 'div' | 'span' | 'section'; +type Element = 'div' | 'span' | 'section' | 'ul'; type Overflow = 'hidden' | 'scroll'; type Position = 'relative' | 'absolute' | 'fixed' | 'sticky'; @@ -321,6 +321,7 @@ export const Box = forwardRef( const className = classNames( styles.Box, visuallyHidden && styles.visuallyHidden, + as === 'ul' && styles.listReset, ); return createElement( diff --git a/polaris.shopify.com/src/data/props.json b/polaris.shopify.com/src/data/props.json index cd8fa603495..3bd0e5a6a59 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": "" - } - }, "Props": { "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx": { "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", @@ -8006,6 +7955,107 @@ "value": "interface Props {\n /** Callback when the search is dismissed */\n onDismiss?(): void;\n /** Determines whether the overlay should be visible */\n visible: boolean;\n}" } }, + "ActionMenuProps": { + "polaris-react/src/components/ActionMenu/ActionMenu.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "name": "ActionMenuProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "actions", + "value": "MenuActionDescriptor[]", + "description": "Collection of page-level secondary actions", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "groups", + "value": "MenuGroupDescriptor[]", + "description": "Collection of page-level action groups", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "rollup", + "value": "boolean", + "description": "Roll up all actions into a Popover > ActionList", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "rollupActionsLabel", + "value": "string", + "description": "Label for rolled up actions activator", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "MethodSignature", + "name": "onActionRollup", + "value": "(hasRolledUp: boolean) => void", + "description": "Callback that returns true when secondary actions are rolled up into action groups, and false when not", + "isOptional": true + } + ], + "value": "export interface ActionMenuProps {\n /** Collection of page-level secondary actions */\n actions?: MenuActionDescriptor[];\n /** Collection of page-level action groups */\n groups?: MenuGroupDescriptor[];\n /** Roll up all actions into a Popover > ActionList */\n rollup?: boolean;\n /** Label for rolled up actions activator */\n rollupActionsLabel?: string;\n /** Callback that returns true when secondary actions are rolled up into action groups, and false when not */\n onActionRollup?(hasRolledUp: boolean): void;\n}" + } + }, + "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", @@ -8103,56 +8153,6 @@ "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 {xs: '4', sm: '5'}\n * @example\n * padding='4'\n * padding={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}\n */\n padding?: Spacing;\n /** Border radius value above a set breakpoint */\n roundedAbove?: BreakpointsAlias;\n}" } }, - "ActionMenuProps": { - "polaris-react/src/components/ActionMenu/ActionMenu.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "name": "ActionMenuProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "actions", - "value": "MenuActionDescriptor[]", - "description": "Collection of page-level secondary actions", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "groups", - "value": "MenuGroupDescriptor[]", - "description": "Collection of page-level action groups", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "rollup", - "value": "boolean", - "description": "Roll up all actions into a Popover > ActionList", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "rollupActionsLabel", - "value": "string", - "description": "Label for rolled up actions activator", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "MethodSignature", - "name": "onActionRollup", - "value": "(hasRolledUp: boolean) => void", - "description": "Callback that returns true when secondary actions are rolled up into action groups, and false when not", - "isOptional": true - } - ], - "value": "export interface ActionMenuProps {\n /** Collection of page-level secondary actions */\n actions?: MenuActionDescriptor[];\n /** Collection of page-level action groups */\n groups?: MenuGroupDescriptor[];\n /** Roll up all actions into a Popover > ActionList */\n rollup?: boolean;\n /** Label for rolled up actions activator */\n rollupActionsLabel?: string;\n /** Callback that returns true when secondary actions are rolled up into action groups, and false when not */\n onActionRollup?(hasRolledUp: boolean): void;\n}" - } - }, "Align": { "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", @@ -8181,7 +8181,7 @@ "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "TypeAliasDeclaration", "name": "Element", - "value": "'div' | 'span' | 'section'", + "value": "'div' | 'span' | 'section' | 'ul'", "description": "" }, "polaris-react/src/components/Text/Text.tsx": { @@ -21984,1150 +21984,912 @@ "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": "" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "syntaxKind": "PropertySignature", + "name": "rolledUp", + "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", "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", + "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/Connected/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "position", - "value": "ItemPosition", - "description": "Position of the item" + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden menu description for screen readers", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Item content", + "name": "active", + "value": "boolean", + "description": "Whether or not the menu is open", "isOptional": true - } - ], - "value": "export interface ItemProps {\n /** Position of the item */\n position: ItemPosition;\n /** Item content */\n children?: React.ReactNode;\n}" - }, - "polaris-react/src/components/FormLayout/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "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 - } - ], - "value": "export interface ItemProps {\n children?: React.ReactNode;\n}" - }, - "polaris-react/src/components/List/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Content to display inside the item", + "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 - } - ], - "value": "export interface ItemProps {\n /** Content to display inside the item */\n children?: React.ReactNode;\n}" - }, - "polaris-react/src/components/Navigation/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "", + "name": "sections", + "value": "readonly ActionListSection[]", + "description": "Collection of sectioned action items", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "badge", - "value": "ReactNode", - "description": "", + "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/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "" + "name": "details", + "value": "React.ReactNode", + "description": "Action details", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "", + "description": "Disables action button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "", + "name": "index", + "value": "number", + "description": "Zero-indexed numerical position. Overrides the group's order in the menu.", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "selected", - "value": "boolean", - "description": "", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any action takes place", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "exactMatch", - "value": "boolean", + "name": "badge", + "value": "{ status: \"new\"; content: string; }", "description": "", "isOptional": true - }, + } + ], + "value": "export interface MenuGroupProps extends MenuGroupDescriptor {\n /** Visually hidden menu description for screen readers */\n accessibilityLabel?: string;\n /** Whether or not the menu is open */\n active?: boolean;\n /** Callback when the menu is clicked */\n onClick?(openActions: () => void): void;\n /** Callback for opening the MenuGroup by title */\n onOpen(title: string): void;\n /** Callback for closing the MenuGroup by title */\n onClose(title: string): void;\n /** Callback for getting the offsetWidth of the MenuGroup */\n getOffsetWidth?(width: number): void;\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n}" + } + }, + "RollupActionsProps": { + "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "name": "RollupActionsProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", "syntaxKind": "PropertySignature", - "name": "new", - "value": "boolean", - "description": "", + "name": "accessibilityLabel", + "value": "string", + "description": "Accessibilty label", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", "syntaxKind": "PropertySignature", - "name": "subNavigationItems", - "value": "SubNavigationItem[]", - "description": "", + "name": "items", + "value": "ActionListItemDescriptor[]", + "description": "Collection of actions for the list", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", "syntaxKind": "PropertySignature", - "name": "secondaryAction", - "value": "SecondaryAction", + "name": "sections", + "value": "ActionListSection[]", + "description": "Collection of sectioned action items", + "isOptional": true + } + ], + "value": "export interface RollupActionsProps {\n /** Accessibilty label */\n accessibilityLabel?: string;\n /** Collection of actions for the list */\n items?: ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: ActionListSection[];\n}" + } + }, + "SecondaryAction": { + "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "name": "SecondaryAction", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "PropertySignature", + "name": "helpText", + "value": "React.ReactNode", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "MethodSignature", - "name": "onClick", + "name": "onAction", "value": "() => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "MethodSignature", - "name": "onToggleExpandedState", - "value": "() => void", + "name": "getOffsetWidth", + "value": "(width: number) => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "expanded", - "value": "boolean", - "description": "", + "name": "children", + "value": "string | string[]", + "description": "The content to display inside the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "shouldResizeIcon", + "name": "primary", "value": "boolean", - "description": "", + "description": "Provides extra visual weight and identifies the primary action in a set of buttons", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "truncateText", + "name": "destructive", "value": "boolean", - "description": "", + "description": "Indicates a dangerous or potentially negative action", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "", + "name": "size", + "value": "\"medium\" | \"large\" | \"slim\"", + "description": "Changes the size of the button, giving it more or less padding", + "isOptional": true, + "defaultValue": "'medium'" + }, + { + "filePath": "polaris-react/src/components/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/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "matches", + "name": "outline", "value": "boolean", - "description": "", + "description": "Gives the button a subtle alternative to the default button styling, appropriate for certain backdrops", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "matchPaths", - "value": "string[]", - "description": "", + "name": "fullWidth", + "value": "boolean", + "description": "Allows the button to grow to the width of its container", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "excludePaths", - "value": "string[]", - "description": "", + "name": "disclosure", + "value": "boolean | \"up\" | \"down\" | \"select\"", + "description": "Displays the button with a disclosure icon. Defaults to `down` when set to true", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "external", + "name": "plain", "value": "boolean", - "description": "", - "isOptional": true - } - ], - "value": "export interface ItemProps extends ItemURLDetails {\n icon?: IconProps['source'];\n badge?: ReactNode;\n label: string;\n disabled?: boolean;\n accessibilityLabel?: string;\n selected?: boolean;\n exactMatch?: boolean;\n new?: boolean;\n subNavigationItems?: SubNavigationItem[];\n secondaryAction?: SecondaryAction;\n onClick?(): void;\n onToggleExpandedState?(): void;\n expanded?: boolean;\n shouldResizeIcon?: boolean;\n truncateText?: boolean;\n}" - }, - "polaris-react/src/components/Stack/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Elements to display inside item", + "description": "Renders a button that looks like a link", "isOptional": true }, { - "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "fill", + "name": "monochrome", "value": "boolean", - "description": "Fill the remaining horizontal space in the stack with the item", + "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 - } - ], - "value": "export interface ItemProps {\n /** Elements to display inside item */\n children?: React.ReactNode;\n /** Fill the remaining horizontal space in the stack with the item */\n fill?: boolean;\n /**\n * @default false\n */\n}" - }, - "polaris-react/src/components/Tabs/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "" }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "focused", + "name": "removeUnderline", "value": "boolean", - "description": "" + "description": "Removes underline from button text (including on interaction) when `monochrome` and `plain` are true", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "panelID", - "value": "string", - "description": "", + "name": "icon", + "value": "any", + "description": "Icon to display to the left of the button content", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "name": "connectedDisclosure", + "value": "ConnectedDisclosure", + "description": "Disclosure button connected right of the button. Toggles a popover action list.", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "", + "name": "dataPrimaryLink", + "value": "boolean", + "description": "Indicates whether or not the button is the primary navigation link when rendered inside of an `IndexTable.Row`", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", + "name": "id", "value": "string", - "description": "", + "description": "A unique identifier for the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "", - "isOptional": true - } - ], - "value": "export interface ItemProps {\n id: string;\n focused: boolean;\n panelID?: string;\n children?: React.ReactNode;\n url?: string;\n accessibilityLabel?: string;\n onClick?(): void;\n}" - }, - "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "name": "url", + "value": "string", + "description": "A destination to link to, rendered in the href attribute of a link", "isOptional": true - } - ], - "value": "interface ItemProps {\n children?: React.ReactNode;\n}" - } - }, - "SectionProps": { - "polaris-react/src/components/ActionList/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "section", - "value": "ActionListSection", - "description": "Section of action items" }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "hasMultipleSections", + "name": "external", "value": "boolean", - "description": "Should there be multiple sections" - }, - { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "actionRole", - "value": "string", - "description": "Defines a specific role attribute for each action in the list", + "description": "Forces url to open in a new tab", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any item is clicked or keypressed", - "isOptional": true - } - ], - "value": "export interface SectionProps {\n /** Section of action items */\n section: ActionListSection;\n /** Should there be multiple sections */\n hasMultipleSections: boolean;\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'option' | 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" - }, - "polaris-react/src/components/Layout/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "name": "download", + "value": "string | boolean", + "description": "Tells the browser to download the url instead of opening it. Provides a hint for the downloaded filename if it is a string value", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "secondary", + "name": "submit", "value": "boolean", - "description": "", + "description": "Allows the button to submit a form", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "fullWidth", + "name": "disabled", "value": "boolean", - "description": "", + "description": "Disables the button, disallowing merchant interaction", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "oneHalf", + "name": "loading", "value": "boolean", - "description": "", + "description": "Replaces button text with a spinner while a background action is being performed", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "oneThird", - "value": "boolean", - "description": "", - "isOptional": true - } - ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\n secondary?: boolean;\n fullWidth?: boolean;\n oneHalf?: boolean;\n oneThird?: boolean;\n}" - }, - "polaris-react/src/components/Listbox/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "divider", + "name": "pressed", "value": "boolean", - "description": "", + "description": "Sets the button in a pressed state", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", - "description": "", + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden text for screen readers", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "ReactNode", - "description": "" - } - ], - "value": "interface SectionProps {\n divider?: boolean;\n children?: ReactNode;\n title: ReactNode;\n}" - }, - "polaris-react/src/components/Navigation/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "items", - "value": "ItemProps[]", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "", + "name": "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/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "title", + "name": "ariaControls", "value": "string", - "description": "", + "description": "Id of the element the button controls", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "fill", + "name": "ariaExpanded", "value": "boolean", - "description": "", + "description": "Tells screen reader the controlled element is expanded", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "rollup", - "value": "{ after: number; view: string; hide: string; activePath: string; }", - "description": "", + "name": "ariaDescribedBy", + "value": "string", + "description": "Indicates the ID of the element that describes the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "action", - "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", - "description": "", + "name": "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/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "separator", - "value": "boolean", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "Callback when clicked", "isOptional": true - } - ], - "value": "export interface SectionProps {\n items: ItemProps[];\n icon?: IconProps['source'];\n title?: string;\n fill?: boolean;\n rollup?: {\n after: number;\n view: string;\n hide: string;\n activePath: string;\n };\n action?: {\n icon: IconProps['source'];\n accessibilityLabel: string;\n onClick(): void;\n tooltip?: TooltipProps;\n };\n separator?: boolean;\n}" - }, - "polaris-react/src/components/Modal/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "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/Modal/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "flush", - "value": "boolean", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onBlur", + "value": "() => void", + "description": "Callback when focus leaves button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "subdued", - "value": "boolean", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyPress", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keypress event is registered on the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "titleHidden", - "value": "boolean", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyUp", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keyup event is registered on the button", "isOptional": true - } - ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\n flush?: boolean;\n subdued?: boolean;\n titleHidden?: boolean;\n}" - }, - "polaris-react/src/components/Popover/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyDown", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keydown event is registered on the button", "isOptional": true - } - ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\n}" - } - }, - "MeasuredActions": { - "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "name": "MeasuredActions", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "syntaxKind": "PropertySignature", - "name": "showable", - "value": "MenuActionDescriptor[]", - "description": "" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "syntaxKind": "PropertySignature", - "name": "rolledUp", - "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", - "description": "" - } - ], - "value": "interface MeasuredActions {\n showable: MenuActionDescriptor[];\n rolledUp: (MenuActionDescriptor | MenuGroupDescriptor)[];\n}" - } - }, - "RollupActionsProps": { - "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "name": "RollupActionsProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Accessibilty label", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onMouseEnter", + "value": "() => void", + "description": "Callback when mouse enter", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "syntaxKind": "PropertySignature", - "name": "items", - "value": "ActionListItemDescriptor[]", - "description": "Collection of actions for the list", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onTouchStart", + "value": "() => void", + "description": "Callback when element is touched", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "syntaxKind": "PropertySignature", - "name": "sections", - "value": "ActionListSection[]", - "description": "Collection of sectioned action items", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onPointerDown", + "value": "() => void", + "description": "Callback when pointerdown event is being triggered", "isOptional": true } ], - "value": "export interface RollupActionsProps {\n /** Accessibilty label */\n accessibilityLabel?: string;\n /** Collection of actions for the list */\n items?: ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: ActionListSection[];\n}" - } - }, - "MenuGroupProps": { - "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "name": "MenuGroupProps", + "value": "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/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", + "name": "url", "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 + "description": "" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "title", + "name": "accessibilityLabel", "value": "string", - "description": "Menu group title" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "actions", - "value": "ActionListItemDescriptor[]", - "description": "List of actions" + "description": "" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", "name": "icon", "value": "any", - "description": "Icon to display", - "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 + "description": "" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", "value": "() => void", - "description": "Callback when any action takes place", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "badge", - "value": "{ status: \"new\"; content: string; }", + "name": "tooltip", + "value": "TooltipProps", "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}" + "value": "interface SecondaryAction {\n url: string;\n accessibilityLabel: string;\n icon: IconProps['source'];\n onClick?(): void;\n tooltip?: TooltipProps;\n}" } }, - "SecondaryAction": { - "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "name": "SecondaryAction", + "ItemProps": { + "polaris-react/src/components/ActionList/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/ActionList/components/Item/Item.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ItemProps", + "value": "ActionListItemDescriptor", + "description": "" + }, + "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx", + "name": "ItemProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "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", + "filePath": "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "plain", - "value": "boolean", - "description": "Renders a button that looks like a link", - "isOptional": true - }, + "name": "button", + "value": "React.ReactElement", + "description": "" + } + ], + "value": "export interface ItemProps {\n button: React.ReactElement;\n}" + }, + "polaris-react/src/components/Connected/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "monochrome", - "value": "boolean", - "description": "Makes `plain` and `outline` Button colors (text, borders, icons) the same as the current text color. Also adds an underline to `plain` Buttons", - "isOptional": true + "name": "position", + "value": "ItemPosition", + "description": "Position of the item" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "removeUnderline", - "value": "boolean", - "description": "Removes underline from button text (including on interaction) when `monochrome` and `plain` are true", + "name": "children", + "value": "React.ReactNode", + "description": "Item content", "isOptional": true - }, + } + ], + "value": "export interface ItemProps {\n /** Position of the item */\n position: ItemPosition;\n /** Item content */\n children?: React.ReactNode;\n}" + }, + "polaris-react/src/components/FormLayout/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "Icon to display to the left of the button content", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true - }, + } + ], + "value": "export interface ItemProps {\n children?: React.ReactNode;\n}" + }, + "polaris-react/src/components/List/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "connectedDisclosure", - "value": "ConnectedDisclosure", - "description": "Disclosure button connected right of the button. Toggles a popover action list.", + "name": "children", + "value": "React.ReactNode", + "description": "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": "dataPrimaryLink", - "value": "boolean", - "description": "Indicates whether or not the button is the primary navigation link when rendered inside of an `IndexTable.Row`", + "name": "icon", + "value": "any", + "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": "panelID", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "url", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "" + "name": "accessibilityLabel", + "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": "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": { @@ -23292,24 +23054,262 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "destructive", + "value": "boolean", + "description": "Destructive action", + "isOptional": true + } + ], + "value": "interface MappedAction extends ActionListItemDescriptor {\n wrapOverflow?: boolean;\n}" + } + }, + "MappedOption": { + "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx": { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "MappedOption", + "value": "ArrayElement & {\n selected: boolean;\n singleSelection: boolean;\n}", + "description": "" + } + }, + "SectionProps": { + "polaris-react/src/components/ActionList/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "section", + "value": "ActionListSection", + "description": "Section of action items" + }, + { + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "hasMultipleSections", + "value": "boolean", + "description": "Should there be multiple sections" + }, + { + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "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/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any item is clicked or keypressed", + "isOptional": true + } + ], + "value": "export interface SectionProps {\n /** Section of action items */\n section: ActionListSection;\n /** Should there be multiple sections */\n hasMultipleSections: boolean;\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'option' | 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" + }, + "polaris-react/src/components/Layout/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "secondary", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "fullWidth", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "oneHalf", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "oneThird", + "value": "boolean", + "description": "", + "isOptional": true + } + ], + "value": "export interface SectionProps {\n children?: React.ReactNode;\n secondary?: boolean;\n fullWidth?: boolean;\n oneHalf?: boolean;\n oneThird?: boolean;\n}" + }, + "polaris-react/src/components/Listbox/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "divider", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "ReactNode", + "description": "" + } + ], + "value": "interface SectionProps {\n divider?: boolean;\n children?: ReactNode;\n title: ReactNode;\n}" + }, + "polaris-react/src/components/Modal/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "flush", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "subdued", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "titleHidden", + "value": "boolean", + "description": "", + "isOptional": true + } + ], + "value": "export interface SectionProps {\n children?: React.ReactNode;\n flush?: boolean;\n subdued?: boolean;\n titleHidden?: boolean;\n}" + }, + "polaris-react/src/components/Navigation/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "items", + "value": "ItemProps[]", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "any", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "fill", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "rollup", + "value": "{ after: number; view: string; hide: string; activePath: string; }", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "action", + "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "destructive", + "name": "separator", "value": "boolean", - "description": "Destructive action", + "description": "", "isOptional": true } ], - "value": "interface MappedAction extends ActionListItemDescriptor {\n wrapOverflow?: boolean;\n}" - } - }, - "MappedOption": { - "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx": { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "MappedOption", - "value": "ArrayElement & {\n selected: boolean;\n singleSelection: boolean;\n}", - "description": "" + "value": "export interface SectionProps {\n items: ItemProps[];\n icon?: IconProps['source'];\n title?: string;\n fill?: boolean;\n rollup?: {\n after: number;\n view: string;\n hide: string;\n activePath: string;\n };\n action?: {\n icon: IconProps['source'];\n accessibilityLabel: string;\n onClick(): void;\n tooltip?: TooltipProps;\n };\n separator?: boolean;\n}" + }, + "polaris-react/src/components/Popover/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "export interface SectionProps {\n children?: React.ReactNode;\n}" } }, "PipProps": { @@ -23355,6 +23355,40 @@ "description": "" } }, + "CardHeaderProps": { + "polaris-react/src/components/Card/components/Header/Header.tsx": { + "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", + "name": "CardHeaderProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", + "syntaxKind": "PropertySignature", + "name": "actions", + "value": "DisableableAction[]", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "export interface CardHeaderProps {\n title?: React.ReactNode;\n actions?: DisableableAction[];\n children?: React.ReactNode;\n}" + } + }, "BulkActionsMenuProps": { "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx": { "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", @@ -23442,40 +23476,6 @@ "value": "export interface BulkActionsMenuProps extends MenuGroupDescriptor {\n isNewBadgeInBadgeActions: boolean;\n}" } }, - "CardHeaderProps": { - "polaris-react/src/components/Card/components/Header/Header.tsx": { - "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", - "name": "CardHeaderProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", - "syntaxKind": "PropertySignature", - "name": "actions", - "value": "DisableableAction[]", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "export interface CardHeaderProps {\n title?: React.ReactNode;\n actions?: DisableableAction[];\n children?: React.ReactNode;\n}" - } - }, "CardSectionProps": { "polaris-react/src/components/Card/components/Section/Section.tsx": { "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", @@ -24741,88 +24741,251 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/AnnotatedSection/AnnotatedSection.tsx", + "filePath": "polaris-react/src/components/Layout/components/AnnotatedSection/AnnotatedSection.tsx", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Layout/components/AnnotatedSection/AnnotatedSection.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "", + "isOptional": true + } + ], + "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}" + } + }, + "OptionProps": { + "polaris-react/src/components/Listbox/components/Option/Option.tsx": { + "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", + "name": "OptionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "any", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", + "syntaxKind": "PropertySignature", + "name": "divider", + "value": "boolean", + "description": "", + "isOptional": true + } + ], + "value": "export interface OptionProps {\n // Unique item value\n value: string;\n // Visually hidden text for screen readers\n accessibilityLabel?: string;\n // Children. When a string, children are rendered in a styled TextOption\n children?: string | React.ReactNode;\n // Option is selected\n selected?: boolean;\n // Option is disabled\n disabled?: boolean;\n // Adds a border-bottom to the Option\n divider?: boolean;\n}" + }, + "polaris-react/src/components/OptionList/components/Option/Option.tsx": { + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "name": "OptionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", "syntaxKind": "PropertySignature", - "name": "description", + "name": "label", "value": "React.ReactNode", - "description": "", - "isOptional": true + "description": "" }, { - "filePath": "polaris-react/src/components/Layout/components/AnnotatedSection/AnnotatedSection.tsx", + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", "syntaxKind": "PropertySignature", - "name": "id", + "name": "value", "value": "string", - "description": "", - "isOptional": true - } - ], - "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": [ + "description": "" + }, { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "", - "isOptional": true + "name": "section", + "value": "number", + "description": "" }, { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", + "name": "index", + "value": "number", "description": "" }, { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", + "name": "media", + "value": "React.ReactElement", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "any", + "name": "disabled", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", "syntaxKind": "PropertySignature", - "name": "selected", + "name": "active", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", + "name": "select", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", "syntaxKind": "PropertySignature", - "name": "divider", + "name": "allowMultiple", "value": "boolean", "description": "", "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "syntaxKind": "PropertySignature", + "name": "verticalAlign", + "value": "Alignment", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "(section: number, option: number) => void", + "description": "" } ], - "value": "interface ActionProps extends OptionProps {\n icon?: IconProps['source'];\n}" + "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}" } }, "HeaderProps": { @@ -24992,174 +25155,11 @@ "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}" - } - }, - "OptionProps": { - "polaris-react/src/components/Listbox/components/Option/Option.tsx": { - "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", - "name": "OptionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "any", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", - "syntaxKind": "PropertySignature", - "name": "selected", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", - "syntaxKind": "PropertySignature", - "name": "divider", - "value": "boolean", - "description": "", - "isOptional": true - } - ], - "value": "export interface OptionProps {\n // Unique item value\n value: string;\n // Visually hidden text for screen readers\n accessibilityLabel?: string;\n // Children. When a string, children are rendered in a styled TextOption\n children?: string | React.ReactNode;\n // Option is selected\n selected?: boolean;\n // Option is disabled\n disabled?: boolean;\n // Adds a border-bottom to the Option\n divider?: boolean;\n}" - }, - "polaris-react/src/components/OptionList/components/Option/Option.tsx": { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", - "name": "OptionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "React.ReactNode", - "description": "" - }, - { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", - "syntaxKind": "PropertySignature", - "name": "section", - "value": "number", - "description": "" - }, - { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", - "syntaxKind": "PropertySignature", - "name": "index", - "value": "number", - "description": "" - }, - { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", - "syntaxKind": "PropertySignature", - "name": "media", - "value": "React.ReactElement", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", - "syntaxKind": "PropertySignature", - "name": "active", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", - "syntaxKind": "PropertySignature", - "name": "select", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", - "syntaxKind": "PropertySignature", - "name": "allowMultiple", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", - "syntaxKind": "PropertySignature", - "name": "verticalAlign", - "value": "Alignment", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", - "syntaxKind": "PropertySignature", - "name": "role", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "(section: number, option: number) => void", - "description": "" + "description": "Removes spacing between title and subtitle", + "isOptional": true } ], - "value": "export interface OptionProps {\n id: string;\n label: React.ReactNode;\n value: string;\n section: number;\n index: number;\n media?: React.ReactElement;\n disabled?: boolean;\n active?: boolean;\n select?: boolean;\n allowMultiple?: boolean;\n verticalAlign?: Alignment;\n role?: string;\n onClick(section: number, option: number): void;\n}" + "value": "export interface 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}" } }, "TextOptionProps": { @@ -25195,357 +25195,357 @@ "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}" } }, - "ItemURLDetails": { - "polaris-react/src/components/Navigation/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "ItemURLDetails", + "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/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", + "name": "pressed", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", "syntaxKind": "PropertySignature", - "name": "matches", + "name": "titleHidden", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "" + } + ], + "value": "export interface CloseButtonProps {\n pressed?: boolean;\n titleHidden?: boolean;\n onClick(): void;\n}" + } + }, + "DialogProps": { + "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx": { + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "name": "DialogProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", "syntaxKind": "PropertySignature", - "name": "exactMatch", - "value": "boolean", + "name": "labelledBy", + "value": "string", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", "syntaxKind": "PropertySignature", - "name": "matchPaths", - "value": "string[]", + "name": "instant", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", "syntaxKind": "PropertySignature", - "name": "excludePaths", - "value": "string[]", + "name": "children", + "value": "React.ReactNode", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", "syntaxKind": "PropertySignature", - "name": "external", + "name": "limitHeight", "value": "boolean", "description": "", "isOptional": true - } - ], - "value": "interface ItemURLDetails {\n url?: string;\n matches?: boolean;\n exactMatch?: boolean;\n matchPaths?: string[];\n excludePaths?: string[];\n external?: boolean;\n}" - } - }, - "SubNavigationItem": { - "polaris-react/src/components/Navigation/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "SubNavigationItem", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "" }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", + "name": "large", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", "syntaxKind": "PropertySignature", - "name": "new", + "name": "small", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", "syntaxKind": "MethodSignature", - "name": "onClick", + "name": "onClose", "value": "() => void", - "description": "", - "isOptional": true + "description": "" }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "matches", - "value": "boolean", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "syntaxKind": "MethodSignature", + "name": "onEntered", + "value": "() => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "exactMatch", - "value": "boolean", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "syntaxKind": "MethodSignature", + "name": "onExited", + "value": "() => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", "syntaxKind": "PropertySignature", - "name": "matchPaths", - "value": "string[]", + "name": "in", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", "syntaxKind": "PropertySignature", - "name": "excludePaths", - "value": "string[]", + "name": "fullScreen", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", "syntaxKind": "PropertySignature", - "name": "external", - "value": "boolean", + "name": "setClosing", + "value": "Dispatch>", "description": "", "isOptional": true } ], - "value": "export interface SubNavigationItem extends ItemURLDetails {\n url: string;\n label: string;\n disabled?: boolean;\n new?: boolean;\n onClick?(): void;\n}" + "value": "export interface DialogProps {\n labelledBy?: string;\n instant?: boolean;\n children?: React.ReactNode;\n limitHeight?: boolean;\n large?: boolean;\n small?: boolean;\n onClose(): void;\n onEntered?(): void;\n onExited?(): void;\n in?: boolean;\n fullScreen?: boolean;\n setClosing?: Dispatch>;\n}" } }, - "MatchState": { - "polaris-react/src/components/Navigation/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "EnumDeclaration", - "name": "MatchState", - "value": "enum MatchState {\n MatchForced,\n MatchUrl,\n MatchPaths,\n Excluded,\n NoMatch,\n}", + "FooterProps": { + "polaris-react/src/components/Modal/components/Footer/Footer.tsx": { + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "name": "FooterProps", + "description": "", "members": [ { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "MatchForced", - "value": 0 - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "MatchUrl", - "value": 1 - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "MatchPaths", - "value": 2 + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "syntaxKind": "PropertySignature", + "name": "primaryAction", + "value": "ComplexAction", + "description": "Primary action", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "Excluded", - "value": 3 + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "syntaxKind": "PropertySignature", + "name": "secondaryActions", + "value": "ComplexAction[]", + "description": "Collection of secondary actions", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "NoMatch", - "value": 4 + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The content to display inside modal", + "isOptional": true } - ] + ], + "value": "export interface FooterProps {\n /** Primary action */\n primaryAction?: ComplexAction;\n /** Collection of secondary actions */\n secondaryActions?: ComplexAction[];\n /** The content to display inside modal */\n children?: React.ReactNode;\n}" } }, - "DialogProps": { - "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx": { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", - "name": "DialogProps", + "ItemURLDetails": { + "polaris-react/src/components/Navigation/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "name": "ItemURLDetails", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "labelledBy", + "name": "url", "value": "string", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "instant", + "name": "matches", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", + "name": "exactMatch", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "limitHeight", - "value": "boolean", + "name": "matchPaths", + "value": "string[]", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "large", - "value": "boolean", + "name": "excludePaths", + "value": "string[]", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "small", + "name": "external", "value": "boolean", "description": "", "isOptional": true + } + ], + "value": "interface ItemURLDetails {\n url?: string;\n matches?: boolean;\n exactMatch?: boolean;\n matchPaths?: string[];\n excludePaths?: string[];\n external?: boolean;\n}" + } + }, + "SubNavigationItem": { + "polaris-react/src/components/Navigation/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "name": "SubNavigationItem", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "url", + "value": "string", + "description": "" }, { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", - "syntaxKind": "MethodSignature", - "name": "onClose", - "value": "() => void", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", "description": "" }, { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", - "syntaxKind": "MethodSignature", - "name": "onEntered", - "value": "() => void", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "new", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "MethodSignature", - "name": "onExited", + "name": "onClick", "value": "() => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "in", + "name": "matches", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "fullScreen", + "name": "exactMatch", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "setClosing", - "value": "Dispatch>", + "name": "matchPaths", + "value": "string[]", "description": "", "isOptional": true - } - ], - "value": "export interface DialogProps {\n labelledBy?: string;\n instant?: boolean;\n children?: React.ReactNode;\n limitHeight?: boolean;\n large?: boolean;\n small?: boolean;\n onClose(): void;\n onEntered?(): void;\n onExited?(): void;\n in?: boolean;\n fullScreen?: boolean;\n setClosing?: Dispatch>;\n}" - } - }, - "CloseButtonProps": { - "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx": { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "name": "CloseButtonProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "pressed", - "value": "boolean", + "name": "excludePaths", + "value": "string[]", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "titleHidden", + "name": "external", "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 SubNavigationItem extends ItemURLDetails {\n url: string;\n label: string;\n disabled?: boolean;\n new?: boolean;\n onClick?(): void;\n}" } }, - "FooterProps": { - "polaris-react/src/components/Modal/components/Footer/Footer.tsx": { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", - "name": "FooterProps", - "description": "", + "MatchState": { + "polaris-react/src/components/Navigation/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "EnumDeclaration", + "name": "MatchState", + "value": "enum MatchState {\n MatchForced,\n MatchUrl,\n MatchPaths,\n Excluded,\n NoMatch,\n}", "members": [ { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", - "syntaxKind": "PropertySignature", - "name": "primaryAction", - "value": "ComplexAction", - "description": "Primary action", - "isOptional": true + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "name": "MatchForced", + "value": 0 }, { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", - "syntaxKind": "PropertySignature", - "name": "secondaryActions", - "value": "ComplexAction[]", - "description": "Collection of secondary actions", - "isOptional": true + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "name": "MatchUrl", + "value": 1 }, { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to display inside modal", - "isOptional": true + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "name": "MatchPaths", + "value": 2 + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "name": "Excluded", + "value": 3 + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "name": "NoMatch", + "value": 4 } - ], - "value": "export interface FooterProps {\n /** Primary action */\n primaryAction?: ComplexAction;\n /** Collection of secondary actions */\n secondaryActions?: ComplexAction[];\n /** The content to display inside modal */\n children?: React.ReactNode;\n}" + ] } }, "PrimaryAction": { @@ -26240,46 +26240,6 @@ "value": "export interface SingleThumbProps extends RangeSliderProps {\n value: number;\n id: string;\n min: number;\n max: number;\n step: number;\n}" } }, - "PanelProps": { - "polaris-react/src/components/Tabs/components/Panel/Panel.tsx": { - "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", - "name": "PanelProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", - "syntaxKind": "PropertySignature", - "name": "hidden", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", - "syntaxKind": "PropertySignature", - "name": "tabID", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "export interface PanelProps {\n hidden?: boolean;\n id: string;\n tabID: string;\n children?: React.ReactNode;\n}" - } - }, "TabProps": { "polaris-react/src/components/Tabs/components/Tab/Tab.tsx": { "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", @@ -26369,6 +26329,46 @@ "value": "export interface TabProps {\n id: string;\n focused?: boolean;\n siblingTabHasFocus?: boolean;\n selected?: boolean;\n panelID?: string;\n children?: React.ReactNode;\n url?: string;\n measuring?: boolean;\n accessibilityLabel?: string;\n onClick?(id: string): void;\n}" } }, + "PanelProps": { + "polaris-react/src/components/Tabs/components/Panel/Panel.tsx": { + "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", + "name": "PanelProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", + "syntaxKind": "PropertySignature", + "name": "tabID", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "export interface PanelProps {\n hidden?: boolean;\n id: string;\n tabID: string;\n children?: React.ReactNode;\n}" + } + }, "TabMeasurements": { "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx": { "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", @@ -26863,6 +26863,39 @@ "value": "export interface DiscardConfirmationModalProps {\n open: boolean;\n onDiscard(): void;\n onCancel(): void;\n}" } }, + "SecondaryProps": { + "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "name": "SecondaryProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "syntaxKind": "PropertySignature", + "name": "expanded", + "value": "boolean", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "interface SecondaryProps {\n expanded: boolean;\n children?: React.ReactNode;\n id?: string;\n}" + } + }, "TitleProps": { "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx": { "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", @@ -26905,39 +26938,6 @@ "value": "export interface TitleProps {\n /** Page title, in large type */\n title?: string;\n /** Page subtitle, in regular type*/\n subtitle?: string;\n /** Important and non-interactive status information shown immediately after the title. */\n titleMetadata?: React.ReactNode;\n /** Removes spacing between title and subtitle */\n compactTitle?: boolean;\n}" } }, - "SecondaryProps": { - "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", - "name": "SecondaryProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", - "syntaxKind": "PropertySignature", - "name": "expanded", - "value": "boolean", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "", - "isOptional": true - } - ], - "value": "interface SecondaryProps {\n expanded: boolean;\n children?: React.ReactNode;\n id?: string;\n}" - } - }, "MessageProps": { "polaris-react/src/components/TopBar/components/Menu/components/Message/Message.tsx": { "filePath": "polaris-react/src/components/TopBar/components/Menu/components/Message/Message.tsx",