From e532551ce8046d4182ecbc64ea22b5934d82a989 Mon Sep 17 00:00:00 2001 From: aveline Date: Wed, 21 Dec 2022 09:34:34 -0800 Subject: [PATCH 1/3] Remove `string` from `role` types --- polaris-react/src/components/OptionList/OptionList.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/polaris-react/src/components/OptionList/OptionList.tsx b/polaris-react/src/components/OptionList/OptionList.tsx index d95342c3ff8..be39f12640e 100644 --- a/polaris-react/src/components/OptionList/OptionList.tsx +++ b/polaris-react/src/components/OptionList/OptionList.tsx @@ -25,7 +25,7 @@ export interface OptionListProps { /** Collection of options to be listed */ options?: OptionDescriptor[]; /** Defines a specific role attribute for the list itself */ - role?: 'listbox' | 'combobox' | string; + role?: 'listbox' | 'combobox'; /** Defines a specific role attribute for each option in the list */ optionRole?: string; /** Sections containing a header and related options */ From ae23c3f479c83c85b54154fb87f9bf638c8bad42 Mon Sep 17 00:00:00 2001 From: aveline Date: Wed, 21 Dec 2022 09:36:50 -0800 Subject: [PATCH 2/3] Update props.json --- polaris.shopify.com/src/data/props.json | 1020 +++++++++++------------ 1 file changed, 510 insertions(+), 510 deletions(-) diff --git a/polaris.shopify.com/src/data/props.json b/polaris.shopify.com/src/data/props.json index 545eff043d4..cb36a5e0824 100644 --- a/polaris.shopify.com/src/data/props.json +++ b/polaris.shopify.com/src/data/props.json @@ -7695,6 +7695,154 @@ "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", + "syntaxKind": "TypeAliasDeclaration", + "name": "CardBackgroundColorTokenScale", + "value": "\"surface\" | \"surface-subdued\"", + "description": "" + } + }, + "Spacing": { + "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Spacing", + "value": "ResponsiveProp", + "description": "" + }, + "polaris-react/src/components/Bleed/Bleed.tsx": { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Spacing", + "value": "ResponsiveProp", + "description": "" + }, + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Spacing", + "value": "ResponsiveProp", + "description": "" + }, + "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Spacing", + "value": "'extraTight' | 'tight' | 'loose'", + "description": "" + }, + "polaris-react/src/components/Stack/Stack.tsx": { + "filePath": "polaris-react/src/components/Stack/Stack.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Spacing", + "value": "'extraTight' | 'tight' | 'baseTight' | 'loose' | 'extraLoose' | 'none'", + "description": "" + }, + "polaris-react/src/components/TextContainer/TextContainer.tsx": { + "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Spacing", + "value": "'tight' | 'loose'", + "description": "" + } + }, + "AlphaCardProps": { + "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "name": "AlphaCardProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "CardBackgroundColorTokenScale", + "description": "Background color", + "isOptional": true, + "defaultValue": "'surface'" + }, + { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "Spacing", + "description": "The spacing around the card", + "isOptional": true, + "defaultValue": "{xs: '4', sm: '5'}" + }, + { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "roundedAbove", + "value": "\"xs\" | \"sm\" | \"md\" | \"lg\" | \"xl\"", + "description": "Border radius value above a set breakpoint", + "isOptional": true + } + ], + "value": "export interface AlphaCardProps {\n 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}" + } + }, "Props": { "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx": { "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", @@ -7979,154 +8127,6 @@ "value": "interface Props {\n /** Callback when the search is dismissed */\n onDismiss?(): void;\n /** Determines whether the overlay should be visible */\n visible: boolean;\n}" } }, - "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", - "syntaxKind": "TypeAliasDeclaration", - "name": "CardBackgroundColorTokenScale", - "value": "\"surface\" | \"surface-subdued\"", - "description": "" - } - }, - "Spacing": { - "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", - "value": "ResponsiveProp", - "description": "" - }, - "polaris-react/src/components/Bleed/Bleed.tsx": { - "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", - "value": "ResponsiveProp", - "description": "" - }, - "polaris-react/src/components/Box/Box.tsx": { - "filePath": "polaris-react/src/components/Box/Box.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", - "value": "ResponsiveProp", - "description": "" - }, - "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", - "value": "'extraTight' | 'tight' | 'loose'", - "description": "" - }, - "polaris-react/src/components/Stack/Stack.tsx": { - "filePath": "polaris-react/src/components/Stack/Stack.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", - "value": "'extraTight' | 'tight' | 'baseTight' | 'loose' | 'extraLoose' | 'none'", - "description": "" - }, - "polaris-react/src/components/TextContainer/TextContainer.tsx": { - "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", - "value": "'tight' | 'loose'", - "description": "" - } - }, - "AlphaCardProps": { - "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "name": "AlphaCardProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "background", - "value": "CardBackgroundColorTokenScale", - "description": "Background color", - "isOptional": true, - "defaultValue": "'surface'" - }, - { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "padding", - "value": "Spacing", - "description": "The spacing around the card", - "isOptional": true, - "defaultValue": "{xs: '4', sm: '5'}" - }, - { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "roundedAbove", - "value": "\"xs\" | \"sm\" | \"md\" | \"lg\" | \"xl\"", - "description": "Border radius value above a set breakpoint", - "isOptional": true - } - ], - "value": "export interface AlphaCardProps {\n 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}" - } - }, "Align": { "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", @@ -15365,7 +15365,7 @@ "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", "syntaxKind": "PropertySignature", "name": "role", - "value": "string", + "value": "\"combobox\" | \"listbox\"", "description": "Defines a specific role attribute for the list itself", "isOptional": true }, @@ -15416,7 +15416,7 @@ "description": "Callback when selection is changed" } ], - "value": "export interface OptionListProps {\n /** A unique identifier for the option list */\n id?: string;\n /** List title */\n title?: string;\n /** Collection of options to be listed */\n options?: OptionDescriptor[];\n /** Defines a specific role attribute for the list itself */\n role?: 'listbox' | 'combobox' | string;\n /** Defines a specific role attribute for each option in the list */\n optionRole?: string;\n /** Sections containing a header and related options */\n sections?: SectionDescriptor[];\n /** The selected options */\n selected: string[];\n /** Allow more than one option to be selected */\n allowMultiple?: boolean;\n /** Vertically align child content to the center, top, or bottom. */\n verticalAlign?: Alignment;\n /** Callback when selection is changed */\n onChange(selected: string[]): void;\n}" + "value": "export interface OptionListProps {\n /** A unique identifier for the option list */\n id?: string;\n /** List title */\n title?: string;\n /** Collection of options to be listed */\n options?: OptionDescriptor[];\n /** Defines a specific role attribute for the list itself */\n role?: 'listbox' | 'combobox';\n /** Defines a specific role attribute for each option in the list */\n optionRole?: string;\n /** Sections containing a header and related options */\n sections?: SectionDescriptor[];\n /** The selected options */\n selected: string[];\n /** Allow more than one option to be selected */\n allowMultiple?: boolean;\n /** Vertically align child content to the center, top, or bottom. */\n verticalAlign?: Alignment;\n /** Callback when selection is changed */\n onChange(selected: string[]): void;\n}" } }, "PageProps": { @@ -17932,15 +17932,6 @@ "value": "export interface SubheadingProps {\n /**\n * The element name to use for the subheading\n * @default 'h3'\n */\n element?: HeadingTagName;\n /** Text to display in subheading */\n children?: React.ReactNode;\n}" } }, - "TagProps": { - "polaris-react/src/components/Tag/Tag.tsx": { - "filePath": "polaris-react/src/components/Tag/Tag.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "TagProps", - "value": "NonMutuallyExclusiveProps & (\n | {onClick?(): void; onRemove?: undefined; url?: undefined}\n | {onClick?: undefined; onRemove?(): void; url?: string}\n )", - "description": "" - } - }, "TabsProps": { "polaris-react/src/components/Tabs/Tabs.tsx": { "filePath": "polaris-react/src/components/Tabs/Tabs.tsx", @@ -17997,30 +17988,13 @@ "value": "export interface TabsProps {\n /** Content to display in tabs */\n children?: React.ReactNode;\n /** Index of selected tab */\n selected: number;\n /** List of tabs */\n tabs: TabDescriptor[];\n /** Fit tabs to container */\n fitted?: boolean;\n /** Text to replace disclosures horizontal dots */\n disclosureText?: string;\n /** Callback when tab is selected */\n onSelect?(selectedTabIndex: number): void;\n}" } }, - "TextContainerProps": { - "polaris-react/src/components/TextContainer/TextContainer.tsx": { - "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", - "name": "TextContainerProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", - "syntaxKind": "PropertySignature", - "name": "spacing", - "value": "Spacing", - "description": "The amount of vertical spacing children will get between them", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to render in the text container.", - "isOptional": true - } - ], - "value": "export interface TextContainerProps {\n /** The amount of vertical spacing children will get between them */\n spacing?: Spacing;\n /** The content to render in the text container. */\n children?: React.ReactNode;\n}" + "TagProps": { + "polaris-react/src/components/Tag/Tag.tsx": { + "filePath": "polaris-react/src/components/Tag/Tag.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "TagProps", + "value": "NonMutuallyExclusiveProps & (\n | {onClick?(): void; onRemove?: undefined; url?: undefined}\n | {onClick?: undefined; onRemove?(): void; url?: string}\n )", + "description": "" } }, "Variant": { @@ -18128,6 +18102,32 @@ "value": "export interface TextProps {\n /** Adjust horizontal alignment of text */\n alignment?: Alignment;\n /** The element type */\n as: Element;\n /** Prevent text from overflowing */\n breakWord?: boolean;\n /** Text to display */\n children: ReactNode;\n /** Adjust color of text */\n color?: Color;\n /** Adjust weight of text */\n fontWeight?: FontWeight;\n /** HTML id attribute */\n id?: string;\n /** Truncate text overflow with ellipsis */\n truncate?: boolean;\n /** Typographic style of text */\n variant: Variant;\n /** Visually hide the text */\n visuallyHidden?: boolean;\n}" } }, + "TextContainerProps": { + "polaris-react/src/components/TextContainer/TextContainer.tsx": { + "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", + "name": "TextContainerProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", + "syntaxKind": "PropertySignature", + "name": "spacing", + "value": "Spacing", + "description": "The amount of vertical spacing children will get between them", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The content to render in the text container.", + "isOptional": true + } + ], + "value": "export interface TextContainerProps {\n /** The amount of vertical spacing children will get between them */\n spacing?: Spacing;\n /** The content to render in the text container. */\n children?: React.ReactNode;\n}" + } + }, "InputMode": { "polaris-react/src/components/TextField/TextField.tsx": { "filePath": "polaris-react/src/components/TextField/TextField.tsx", @@ -22013,174 +22013,48 @@ "description": "" } ], - "value": "export interface FocusManagerContextType {\n trapFocusList: string[];\n add: (id: string) => void;\n remove: (id: string) => boolean;\n}" - } - }, - "PortalsManager": { - "polaris-react/src/utilities/portals/context.tsx": { - "filePath": "polaris-react/src/utilities/portals/context.tsx", - "name": "PortalsManager", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/utilities/portals/context.tsx", - "syntaxKind": "PropertySignature", - "name": "container", - "value": "HTMLDivElement", - "description": "" - } - ], - "value": "export interface PortalsManager {\n container: PortalsContainerElement;\n}" - } - }, - "MeasuredActions": { - "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "name": "MeasuredActions", - "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}" - } - }, - "MenuGroupProps": { - "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "name": "MenuGroupProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Visually hidden menu description for screen readers", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "active", - "value": "boolean", - "description": "Whether or not the menu is open", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "(openActions: () => void) => void", - "description": "Callback when the menu is clicked", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "onOpen", - "value": "(title: string) => void", - "description": "Callback for opening the MenuGroup by title" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "onClose", - "value": "(title: string) => void", - "description": "Callback for closing the MenuGroup by title" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "getOffsetWidth", - "value": "(width: number) => void", - "description": "Callback for getting the offsetWidth of the MenuGroup", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "sections", - "value": "readonly ActionListSection[]", - "description": "Collection of sectioned action items", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "Menu group title" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "actions", - "value": "ActionListItemDescriptor[]", - "description": "List of actions" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "Icon to display", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "details", - "value": "React.ReactNode", - "description": "Action details", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables action button", - "isOptional": true - }, + "value": "export interface FocusManagerContextType {\n trapFocusList: string[];\n add: (id: string) => void;\n remove: (id: string) => boolean;\n}" + } + }, + "PortalsManager": { + "polaris-react/src/utilities/portals/context.tsx": { + "filePath": "polaris-react/src/utilities/portals/context.tsx", + "name": "PortalsManager", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/utilities/portals/context.tsx", "syntaxKind": "PropertySignature", - "name": "index", - "value": "number", - "description": "Zero-indexed numerical position. Overrides the group's order in the menu.", - "isOptional": true - }, + "name": "container", + "value": "HTMLDivElement", + "description": "" + } + ], + "value": "export interface PortalsManager {\n container: PortalsContainerElement;\n}" + } + }, + "MeasuredActions": { + "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "name": "MeasuredActions", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any action takes place", - "isOptional": true + "name": "showable", + "value": "MenuActionDescriptor[]", + "description": "" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", "syntaxKind": "PropertySignature", - "name": "badge", - "value": "{ status: \"new\"; content: string; }", - "description": "", - "isOptional": true + "name": "rolledUp", + "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", + "description": "" } ], - "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 MeasuredActions {\n showable: MenuActionDescriptor[];\n rolledUp: (MenuActionDescriptor | MenuGroupDescriptor)[];\n}" } }, "RollupActionsProps": { @@ -22593,6 +22467,132 @@ "value": "interface SecondaryAction {\n url: string;\n accessibilityLabel: string;\n icon: IconProps['source'];\n onClick?(): void;\n tooltip?: TooltipProps;\n}" } }, + "MenuGroupProps": { + "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "name": "MenuGroupProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden menu description for screen readers", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "active", + "value": "boolean", + "description": "Whether or not the menu is open", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "(openActions: () => void) => void", + "description": "Callback when the menu is clicked", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "onOpen", + "value": "(title: string) => void", + "description": "Callback for opening the MenuGroup by title" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "onClose", + "value": "(title: string) => void", + "description": "Callback for closing the MenuGroup by title" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "getOffsetWidth", + "value": "(width: number) => void", + "description": "Callback for getting the offsetWidth of the MenuGroup", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "sections", + "value": "readonly ActionListSection[]", + "description": "Collection of sectioned action items", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "Menu group title" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "actions", + "value": "ActionListItemDescriptor[]", + "description": "List of actions" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "any", + "description": "Icon to display", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "details", + "value": "React.ReactNode", + "description": "Action details", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Disables action button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "index", + "value": "number", + "description": "Zero-indexed numerical position. Overrides the group's order in the menu.", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any action takes place", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "badge", + "value": "{ status: \"new\"; content: string; }", + "description": "", + "isOptional": true + } + ], + "value": "export interface MenuGroupProps extends MenuGroupDescriptor {\n /** Visually hidden menu description for screen readers */\n accessibilityLabel?: string;\n /** Whether or not the menu is open */\n active?: boolean;\n /** Callback when the menu is clicked */\n onClick?(openActions: () => void): void;\n /** Callback for opening the MenuGroup by title */\n onOpen(title: string): void;\n /** Callback for closing the MenuGroup by title */\n onClose(title: string): void;\n /** Callback for getting the offsetWidth of the MenuGroup */\n getOffsetWidth?(width: number): void;\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n}" + } + }, "ItemProps": { "polaris-react/src/components/ActionList/components/Item/Item.tsx": { "filePath": "polaris-react/src/components/ActionList/components/Item/Item.tsx", @@ -23179,6 +23179,15 @@ "value": "export interface SectionProps {\n children?: React.ReactNode;\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": "" + } + }, "MappedAction": { "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx": { "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", @@ -23352,15 +23361,6 @@ "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": "" - } - }, "PipProps": { "polaris-react/src/components/Badge/components/Pip/Pip.tsx": { "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", @@ -23525,24 +23525,6 @@ "value": "export interface CardHeaderProps {\n title?: React.ReactNode;\n actions?: DisableableAction[];\n children?: React.ReactNode;\n}" } }, - "CardSubsectionProps": { - "polaris-react/src/components/Card/components/Subsection/Subsection.tsx": { - "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", - "name": "CardSubsectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "export interface CardSubsectionProps {\n children?: React.ReactNode;\n}" - } - }, "CardSectionProps": { "polaris-react/src/components/Card/components/Section/Section.tsx": { "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", @@ -23609,6 +23591,24 @@ "value": "export interface CardSectionProps {\n title?: React.ReactNode;\n children?: React.ReactNode;\n subdued?: boolean;\n flush?: boolean;\n fullWidth?: boolean;\n /** Allow the card to be hidden when printing */\n hideOnPrint?: boolean;\n actions?: ComplexAction[];\n}" } }, + "CardSubsectionProps": { + "polaris-react/src/components/Card/components/Subsection/Subsection.tsx": { + "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", + "name": "CardSubsectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "export interface CardSubsectionProps {\n children?: React.ReactNode;\n}" + } + }, "AlphaPickerProps": { "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx": { "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", @@ -24147,7 +24147,38 @@ "isOptional": true } ], - "value": "export interface DayProps {\n focused?: boolean;\n day?: Date;\n selected?: boolean;\n inRange?: boolean;\n inHoveringRange?: boolean;\n disabled?: boolean;\n lastDayOfMonth?: any;\n isLastSelectedDay?: boolean;\n isFirstSelectedDay?: boolean;\n isHoveringRight?: boolean;\n rangeIsDifferent?: boolean;\n weekday?: string;\n selectedAccessibilityLabelPrefix?: string;\n onClick?(day: Date): void;\n onHover?(day?: Date): void;\n onFocus?(day: Date): void;\n}" + "value": "export interface DayProps {\n focused?: boolean;\n day?: Date;\n selected?: boolean;\n inRange?: boolean;\n inHoveringRange?: boolean;\n disabled?: boolean;\n lastDayOfMonth?: any;\n isLastSelectedDay?: boolean;\n isFirstSelectedDay?: boolean;\n isHoveringRight?: boolean;\n rangeIsDifferent?: boolean;\n weekday?: string;\n selectedAccessibilityLabelPrefix?: string;\n onClick?(day: Date): void;\n onHover?(day?: Date): void;\n onFocus?(day: Date): void;\n}" + } + }, + "WeekdayProps": { + "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx": { + "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", + "name": "WeekdayProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", + "syntaxKind": "PropertySignature", + "name": "current", + "value": "boolean", + "description": "" + } + ], + "value": "export interface WeekdayProps {\n label: string;\n title: string;\n current: boolean;\n}" } }, "MonthProps": { @@ -24268,37 +24299,6 @@ "value": "export interface MonthProps {\n focusedDate?: Date;\n selected?: Range;\n hoverDate?: Date;\n month: number;\n year: number;\n disableDatesBefore?: Date;\n disableDatesAfter?: Date;\n disableSpecificDates?: Date[];\n allowRange?: boolean;\n weekStartsOn: number;\n accessibilityLabelPrefixes: [string | undefined, string];\n onChange?(date: Range): void;\n onHover?(hoverEnd: Date): void;\n onFocus?(date: Date): void;\n}" } }, - "WeekdayProps": { - "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx": { - "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", - "name": "WeekdayProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", - "syntaxKind": "PropertySignature", - "name": "current", - "value": "boolean", - "description": "" - } - ], - "value": "export interface WeekdayProps {\n label: string;\n title: string;\n current: boolean;\n}" - } - }, "FileUploadProps": { "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx": { "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", @@ -24622,6 +24622,23 @@ "description": "" } }, + "CheckboxWrapperProps": { + "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx": { + "filePath": "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx", + "name": "CheckboxWrapperProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ReactNode", + "description": "" + } + ], + "value": "interface CheckboxWrapperProps {\n children: ReactNode;\n}" + } + }, "RowStatus": { "polaris-react/src/components/IndexTable/components/Row/Row.tsx": { "filePath": "polaris-react/src/components/IndexTable/components/Row/Row.tsx", @@ -24750,23 +24767,6 @@ "value": "export interface ScrollContainerProps {\n children: React.ReactNode;\n scrollableContainerRef: React.RefObject;\n onScroll(canScrollLeft: boolean, canScrollRight: boolean): void;\n}" } }, - "CheckboxWrapperProps": { - "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx": { - "filePath": "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx", - "name": "CheckboxWrapperProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", - "description": "" - } - ], - "value": "interface CheckboxWrapperProps {\n children: ReactNode;\n}" - } - }, "AnnotatedSectionProps": { "polaris-react/src/components/Layout/components/AnnotatedSection/AnnotatedSection.tsx": { "filePath": "polaris-react/src/components/Layout/components/AnnotatedSection/AnnotatedSection.tsx", @@ -25244,39 +25244,6 @@ "value": "export interface TextOptionProps {\n children: React.ReactNode;\n // Whether the option is selected\n selected?: boolean;\n // Whether the option is disabled\n disabled?: boolean;\n}" } }, - "CloseButtonProps": { - "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx": { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "name": "CloseButtonProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "syntaxKind": "PropertySignature", - "name": "pressed", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "syntaxKind": "PropertySignature", - "name": "titleHidden", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "" - } - ], - "value": "export interface CloseButtonProps {\n pressed?: boolean;\n titleHidden?: boolean;\n onClick(): void;\n}" - } - }, "CSSTransitionProps": { "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx": { "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", @@ -25391,6 +25358,39 @@ "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", + "syntaxKind": "PropertySignature", + "name": "pressed", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "syntaxKind": "PropertySignature", + "name": "titleHidden", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "" + } + ], + "value": "export interface CloseButtonProps {\n pressed?: boolean;\n titleHidden?: boolean;\n onClick(): void;\n}" + } + }, "FooterProps": { "polaris-react/src/components/Modal/components/Footer/Footer.tsx": { "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", @@ -25606,6 +25606,65 @@ ] } }, + "PaneProps": { + "polaris-react/src/components/Popover/components/Pane/Pane.tsx": { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "name": "PaneProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "fixed", + "value": "boolean", + "description": "Fix the pane to the top of the popover", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "sectioned", + "value": "boolean", + "description": "Automatically wrap children in padded sections", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The pane content", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "height", + "value": "string", + "description": "Sets a fixed height and max-height on the Scrollable", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "MethodSignature", + "name": "onScrolledToBottom", + "value": "() => void", + "description": "Callback when the bottom of the popover is reached by mouse or keyboard", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "captureOverscroll", + "value": "boolean", + "description": "Prevents page scrolling when the end of the scrollable Popover content is reached", + "isOptional": true, + "defaultValue": "false" + } + ], + "value": "export interface PaneProps {\n /** Fix the pane to the top of the popover */\n fixed?: boolean;\n /** Automatically wrap children in padded sections */\n sectioned?: boolean;\n /** The pane content */\n children?: React.ReactNode;\n /** Sets a fixed height and max-height on the Scrollable */\n height?: string;\n /** Callback when the bottom of the popover is reached by mouse or keyboard */\n onScrolledToBottom?(): void;\n /**\n * Prevents page scrolling when the end of the scrollable Popover content is reached\n * @default false\n */\n captureOverscroll?: boolean;\n}" + } + }, "PrimaryAction": { "polaris-react/src/components/Page/components/Header/Header.tsx": { "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", @@ -25728,65 +25787,6 @@ "value": "interface PrimaryAction\n extends DestructableAction,\n DisableableAction,\n LoadableAction,\n IconableAction,\n TooltipAction {\n /** Provides extra visual weight and identifies the primary action in a set of buttons */\n primary?: boolean;\n}" } }, - "PaneProps": { - "polaris-react/src/components/Popover/components/Pane/Pane.tsx": { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "name": "PaneProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "fixed", - "value": "boolean", - "description": "Fix the pane to the top of the popover", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "sectioned", - "value": "boolean", - "description": "Automatically wrap children in padded sections", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The pane content", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "height", - "value": "string", - "description": "Sets a fixed height and max-height on the Scrollable", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "MethodSignature", - "name": "onScrolledToBottom", - "value": "() => void", - "description": "Callback when the bottom of the popover is reached by mouse or keyboard", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "captureOverscroll", - "value": "boolean", - "description": "Prevents page scrolling when the end of the scrollable Popover content is reached", - "isOptional": true, - "defaultValue": "false" - } - ], - "value": "export interface PaneProps {\n /** Fix the pane to the top of the popover */\n fixed?: boolean;\n /** Automatically wrap children in padded sections */\n sectioned?: boolean;\n /** The pane content */\n children?: React.ReactNode;\n /** Sets a fixed height and max-height on the Scrollable */\n height?: string;\n /** Callback when the bottom of the popover is reached by mouse or keyboard */\n onScrolledToBottom?(): void;\n /**\n * Prevents page scrolling when the end of the scrollable Popover content is reached\n * @default false\n */\n captureOverscroll?: boolean;\n}" - } - }, "PopoverCloseSource": { "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx": { "filePath": "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx", From 4053e9aaec94166d98dc08304806c339e3f2bbc0 Mon Sep 17 00:00:00 2001 From: aveline Date: Wed, 21 Dec 2022 09:37:01 -0800 Subject: [PATCH 3/3] changeset --- .changeset/witty-files-grab.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/witty-files-grab.md diff --git a/.changeset/witty-files-grab.md b/.changeset/witty-files-grab.md new file mode 100644 index 00000000000..0cb23ead8c9 --- /dev/null +++ b/.changeset/witty-files-grab.md @@ -0,0 +1,5 @@ +--- +'@shopify/polaris': major +--- + +Removed `string` from `role` types for `OptionList` component