From 26b5591ea483ec348dface80a5c6831599ef76dc Mon Sep 17 00:00:00 2001 From: Lo Kim Date: Mon, 24 Oct 2022 13:56:10 -0400 Subject: [PATCH 1/3] [Box] Add support for `section` element type --- polaris-react/src/components/Box/Box.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/polaris-react/src/components/Box/Box.tsx b/polaris-react/src/components/Box/Box.tsx index 36fe569d0ea..384f49cae8a 100644 --- a/polaris-react/src/components/Box/Box.tsx +++ b/polaris-react/src/components/Box/Box.tsx @@ -8,7 +8,7 @@ import {classNames, sanitizeCustomProperties} from '../../utilities/css'; import styles from './Box.scss'; -type Element = 'div' | 'span'; +type Element = 'div' | 'span' | 'section'; type Overflow = 'hidden' | 'scroll'; From 8c2a908f62370938efe6175b07070eadfdab7e9b Mon Sep 17 00:00:00 2001 From: Lo Kim Date: Mon, 24 Oct 2022 13:56:24 -0400 Subject: [PATCH 2/3] [polaris.shopify.com] Run `get-props` script --- polaris.shopify.com/src/data/props.json | 1678 ++++++++++++----------- 1 file changed, 840 insertions(+), 838 deletions(-) diff --git a/polaris.shopify.com/src/data/props.json b/polaris.shopify.com/src/data/props.json index 1cb6fa21d9d..b69686ea39f 100644 --- a/polaris.shopify.com/src/data/props.json +++ b/polaris.shopify.com/src/data/props.json @@ -7763,57 +7763,6 @@ "value": "export interface ActionMenuProps {\n /** Collection of page-level secondary actions */\n actions?: MenuActionDescriptor[];\n /** Collection of page-level action groups */\n groups?: MenuGroupDescriptor[];\n /** Roll up all actions into a Popover > ActionList */\n rollup?: boolean;\n /** Label for rolled up actions activator */\n rollupActionsLabel?: string;\n /** Callback that returns true when secondary actions are rolled up into action groups, and false when not */\n onActionRollup?(hasRolledUp: boolean): void;\n}" } }, - "CardBackgroundColorTokenScale": { - "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "CardBackgroundColorTokenScale", - "value": "\"surface\" | \"surface-subdued\"", - "description": "" - } - }, - "AlphaCardProps": { - "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "name": "AlphaCardProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Elements to display inside card", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "background", - "value": "CardBackgroundColorTokenScale", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "padding", - "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "roundedAbove", - "value": "\"xs\" | \"sm\" | \"md\" | \"lg\" | \"xl\"", - "description": "", - "isOptional": true - } - ], - "value": "export interface AlphaCardProps {\n /** Elements to display inside card */\n children?: React.ReactNode;\n background?: CardBackgroundColorTokenScale;\n padding?: SpacingSpaceScale;\n roundedAbove?: BreakpointsAlias;\n}" - } - }, "Props": { "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx": { "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", @@ -8098,6 +8047,57 @@ "value": "interface Props {\n /** Callback when the search is dismissed */\n onDismiss?(): void;\n /** Determines whether the overlay should be visible */\n visible: boolean;\n}" } }, + "CardBackgroundColorTokenScale": { + "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "CardBackgroundColorTokenScale", + "value": "\"surface\" | \"surface-subdued\"", + "description": "" + } + }, + "AlphaCardProps": { + "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "name": "AlphaCardProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Elements to display inside card", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "CardBackgroundColorTokenScale", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "roundedAbove", + "value": "\"xs\" | \"sm\" | \"md\" | \"lg\" | \"xl\"", + "description": "", + "isOptional": true + } + ], + "value": "export interface AlphaCardProps {\n /** Elements to display inside card */\n children?: React.ReactNode;\n background?: CardBackgroundColorTokenScale;\n padding?: SpacingSpaceScale;\n roundedAbove?: BreakpointsAlias;\n}" + } + }, "Align": { "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", @@ -9798,7 +9798,7 @@ "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "TypeAliasDeclaration", "name": "Element", - "value": "'div' | 'span'", + "value": "'div' | 'span' | 'section'", "description": "" }, "polaris-react/src/components/Text/Text.tsx": { @@ -11803,40 +11803,6 @@ "value": "export interface ColumnsProps extends PropsWithChildren {\n /** The space between columns */\n spacing?: Spacing;\n /** The number of columns to display\n * @default {xs: 6, sm: 6, md: 6, lg: 6, xl: 6}\n */\n columns?: Columns;\n children?: React.ReactNode;\n}" } }, - "ConnectedProps": { - "polaris-react/src/components/Connected/Connected.tsx": { - "filePath": "polaris-react/src/components/Connected/Connected.tsx", - "name": "ConnectedProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Connected/Connected.tsx", - "syntaxKind": "PropertySignature", - "name": "left", - "value": "React.ReactNode", - "description": "Content to display on the left", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Connected/Connected.tsx", - "syntaxKind": "PropertySignature", - "name": "right", - "value": "React.ReactNode", - "description": "Content to display on the right", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Connected/Connected.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Connected content", - "isOptional": true - } - ], - "value": "export interface ConnectedProps {\n /** Content to display on the left */\n left?: React.ReactNode;\n /** Content to display on the right */\n right?: React.ReactNode;\n /** Connected content */\n children?: React.ReactNode;\n}" - } - }, "ComboboxProps": { "polaris-react/src/components/Combobox/Combobox.tsx": { "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", @@ -11910,6 +11876,40 @@ "value": "export interface ComboboxProps {\n /** The text field component to activate the Popover */\n activator: React.ReactElement;\n /** Allows more than one option to be selected */\n allowMultiple?: boolean;\n /** The content to display inside the popover */\n children?: React.ReactElement | null;\n /** The preferred direction to open the popover */\n preferredPosition?: PopoverProps['preferredPosition'];\n /** Whether or not more options are available to lazy load when the bottom of the listbox reached. Use the hasMoreResults boolean provided by the GraphQL API of the paginated data. */\n willLoadMoreOptions?: boolean;\n /** Height to set on the Popover Pane. */\n height?: string;\n /** Callback fired when the bottom of the lisbox is reached. Use to lazy load when listbox option data is paginated. */\n onScrolledToBottom?(): void;\n /** Callback fired when the popover closes */\n onClose?(): void;\n}" } }, + "ConnectedProps": { + "polaris-react/src/components/Connected/Connected.tsx": { + "filePath": "polaris-react/src/components/Connected/Connected.tsx", + "name": "ConnectedProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Connected/Connected.tsx", + "syntaxKind": "PropertySignature", + "name": "left", + "value": "React.ReactNode", + "description": "Content to display on the left", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Connected/Connected.tsx", + "syntaxKind": "PropertySignature", + "name": "right", + "value": "React.ReactNode", + "description": "Content to display on the right", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Connected/Connected.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Connected content", + "isOptional": true + } + ], + "value": "export interface ConnectedProps {\n /** Content to display on the left */\n left?: React.ReactNode;\n /** Content to display on the right */\n right?: React.ReactNode;\n /** Connected content */\n children?: React.ReactNode;\n}" + } + }, "Width": { "polaris-react/src/components/ContentBlock/ContentBlock.tsx": { "filePath": "polaris-react/src/components/ContentBlock/ContentBlock.tsx", @@ -12958,6 +12958,32 @@ "value": "export interface EventListenerProps extends BaseEventProps {\n passive?: boolean;\n}" } }, + "Description": { + "polaris-react/src/components/ExceptionList/ExceptionList.tsx": { + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Description", + "value": "string | React.ReactElement | (string | React.ReactElement)[]", + "description": "" + } + }, + "ExceptionListProps": { + "polaris-react/src/components/ExceptionList/ExceptionList.tsx": { + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", + "name": "ExceptionListProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "items", + "value": "Item[]", + "description": "Collection of items for list" + } + ], + "value": "export interface ExceptionListProps {\n /** Collection of items for list */\n items: Item[];\n}" + } + }, "AppliedFilterInterface": { "polaris-react/src/components/Filters/Filters.tsx": { "filePath": "polaris-react/src/components/Filters/Filters.tsx", @@ -13199,32 +13225,6 @@ ] } }, - "Description": { - "polaris-react/src/components/ExceptionList/ExceptionList.tsx": { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Description", - "value": "string | React.ReactElement | (string | React.ReactElement)[]", - "description": "" - } - }, - "ExceptionListProps": { - "polaris-react/src/components/ExceptionList/ExceptionList.tsx": { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", - "name": "ExceptionListProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "items", - "value": "Item[]", - "description": "Collection of items for list" - } - ], - "value": "export interface ExceptionListProps {\n /** Collection of items for list */\n items: Item[];\n}" - } - }, "FocusProps": { "polaris-react/src/components/Focus/Focus.tsx": { "filePath": "polaris-react/src/components/Focus/Focus.tsx", @@ -13518,6 +13518,31 @@ "value": "export interface FrameProps {\n /** Sets the logo for the TopBar, Navigation, and ContextualSaveBar components */\n logo?: Logo;\n /** A horizontal offset that pushes the frame to the right, leaving empty space on the left */\n offset?: string;\n /** The content to display inside the frame. */\n children?: React.ReactNode;\n /** Accepts a top bar component that will be rendered at the top-most portion of an application frame */\n topBar?: React.ReactNode;\n /** Accepts a navigation component that will be rendered in the left sidebar of an application frame */\n navigation?: React.ReactNode;\n /** Accepts a global ribbon component that will be rendered fixed to the bottom of an application frame */\n globalRibbon?: React.ReactNode;\n /** A boolean property indicating whether the mobile navigation is currently visible\n * @default false\n */\n showMobileNavigation?: boolean;\n /** Accepts a ref to the html anchor element you wish to focus when clicking the skip to content link */\n skipToContentTarget?: React.RefObject;\n /** A callback function to handle clicking the mobile navigation dismiss button */\n onNavigationDismiss?(): void;\n}" } }, + "FullscreenBarProps": { + "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx": { + "filePath": "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx", + "name": "FullscreenBarProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx", + "syntaxKind": "PropertySignature", + "name": "onAction", + "value": "() => void", + "description": "Callback when back button is clicked" + }, + { + "filePath": "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Render child elements", + "isOptional": true + } + ], + "value": "export interface FullscreenBarProps {\n /** Callback when back button is clicked */\n onAction: () => void;\n /** Render child elements */\n children?: React.ReactNode;\n}" + } + }, "Breakpoints": { "polaris-react/src/components/Grid/Grid.tsx": { "filePath": "polaris-react/src/components/Grid/Grid.tsx", @@ -13636,35 +13661,10 @@ "value": "export interface HeadingProps {\n /**\n * The element name to use for the heading\n * @default 'h2'\n */\n element?: HeadingTagName;\n /** The content to display inside the heading */\n children?: React.ReactNode;\n /** A unique identifier for the heading, used for reference in anchor links */\n id?: string;\n}" } }, - "FullscreenBarProps": { - "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx": { - "filePath": "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx", - "name": "FullscreenBarProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx", - "syntaxKind": "PropertySignature", - "name": "onAction", - "value": "() => void", - "description": "Callback when back button is clicked" - }, - { - "filePath": "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Render child elements", - "isOptional": true - } - ], - "value": "export interface FullscreenBarProps {\n /** Callback when back button is clicked */\n onAction: () => void;\n /** Render child elements */\n children?: React.ReactNode;\n}" - } - }, - "IconProps": { - "polaris-react/src/components/Icon/Icon.tsx": { - "filePath": "polaris-react/src/components/Icon/Icon.tsx", - "name": "IconProps", + "IconProps": { + "polaris-react/src/components/Icon/Icon.tsx": { + "filePath": "polaris-react/src/components/Icon/Icon.tsx", + "name": "IconProps", "description": "", "members": [ { @@ -14381,24 +14381,6 @@ "value": "export interface InlineCodeProps {\n /** The content to render inside the code block */\n children: ReactNode;\n}" } }, - "KeyboardKeyProps": { - "polaris-react/src/components/KeyboardKey/KeyboardKey.tsx": { - "filePath": "polaris-react/src/components/KeyboardKey/KeyboardKey.tsx", - "name": "KeyboardKeyProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/KeyboardKey/KeyboardKey.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "string", - "description": "The content to display inside the key", - "isOptional": true - } - ], - "value": "export interface KeyboardKeyProps {\n /** The content to display inside the key */\n children?: string;\n}" - } - }, "InlineErrorProps": { "polaris-react/src/components/InlineError/InlineError.tsx": { "filePath": "polaris-react/src/components/InlineError/InlineError.tsx", @@ -14423,6 +14405,42 @@ "value": "export interface InlineErrorProps {\n /** Content briefly explaining how to resolve the invalid form field input. */\n message: Error;\n /** Unique identifier of the invalid form field that the message describes */\n fieldID: string;\n}" } }, + "KeyboardKeyProps": { + "polaris-react/src/components/KeyboardKey/KeyboardKey.tsx": { + "filePath": "polaris-react/src/components/KeyboardKey/KeyboardKey.tsx", + "name": "KeyboardKeyProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/KeyboardKey/KeyboardKey.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "string", + "description": "The content to display inside the key", + "isOptional": true + } + ], + "value": "export interface KeyboardKeyProps {\n /** The content to display inside the key */\n children?: string;\n}" + } + }, + "KeypressListenerProps": { + "polaris-react/src/components/KeypressListener/KeypressListener.tsx": { + "filePath": "polaris-react/src/components/KeypressListener/KeypressListener.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "KeypressListenerProps", + "value": "NonMutuallyExclusiveProps & (\n | {useCapture?: boolean; options?: undefined}\n | {useCapture?: undefined; options?: AddEventListenerOptions}\n )", + "description": "" + } + }, + "KeyEvent": { + "polaris-react/src/components/KeypressListener/KeypressListener.tsx": { + "filePath": "polaris-react/src/components/KeypressListener/KeypressListener.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "KeyEvent", + "value": "'keydown' | 'keyup'", + "description": "" + } + }, "KonamiCodeProps": { "polaris-react/src/components/KonamiCode/KonamiCode.tsx": { "filePath": "polaris-react/src/components/KonamiCode/KonamiCode.tsx", @@ -14553,24 +14571,6 @@ "value": "export interface LabelledProps {\n /** A unique identifier for the label */\n id: LabelProps['id'];\n /** Text for the label */\n label: React.ReactNode;\n /** Error to display beneath the label */\n error?: Error | boolean;\n /** An action */\n action?: Action;\n /** Additional hint text to display */\n helpText?: React.ReactNode;\n /** Content to display inside the connected */\n children?: React.ReactNode;\n /** Visually hide the label */\n labelHidden?: boolean;\n /** Visual required indicator for the label */\n requiredIndicator?: boolean;\n}" } }, - "KeypressListenerProps": { - "polaris-react/src/components/KeypressListener/KeypressListener.tsx": { - "filePath": "polaris-react/src/components/KeypressListener/KeypressListener.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "KeypressListenerProps", - "value": "NonMutuallyExclusiveProps & (\n | {useCapture?: boolean; options?: undefined}\n | {useCapture?: undefined; options?: AddEventListenerOptions}\n )", - "description": "" - } - }, - "KeyEvent": { - "polaris-react/src/components/KeypressListener/KeypressListener.tsx": { - "filePath": "polaris-react/src/components/KeypressListener/KeypressListener.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "KeyEvent", - "value": "'keydown' | 'keyup'", - "description": "" - } - }, "LayoutProps": { "polaris-react/src/components/Layout/Layout.tsx": { "filePath": "polaris-react/src/components/Layout/Layout.tsx", @@ -17120,7 +17120,8 @@ "name": "vertical", "value": "boolean", "description": "Scroll content vertically", - "isOptional": true + "isOptional": true, + "defaultValue": "true" }, { "filePath": "polaris-react/src/components/Scrollable/Scrollable.tsx", @@ -17128,7 +17129,8 @@ "name": "horizontal", "value": "boolean", "description": "Scroll content horizontally", - "isOptional": true + "isOptional": true, + "defaultValue": "true" }, { "filePath": "polaris-react/src/components/Scrollable/Scrollable.tsx", @@ -17163,7 +17165,7 @@ "isOptional": true } ], - "value": "export interface ScrollableProps extends React.HTMLProps {\n /** Content to display in scrollable area */\n children?: React.ReactNode;\n /** Scroll content vertically */\n vertical?: boolean;\n /** Scroll content horizontally */\n horizontal?: boolean;\n /** Add a shadow when content is scrollable */\n shadow?: boolean;\n /** Slightly hints content upon mounting when scrollable */\n hint?: boolean;\n /** Adds a tabIndex to scrollable when children are not focusable */\n focusable?: boolean;\n /** Called when scrolled to the bottom of the scroll area */\n onScrolledToBottom?(): void;\n}" + "value": "export interface ScrollableProps extends React.HTMLProps {\n /** Content to display in scrollable area */\n children?: React.ReactNode;\n /** Scroll content vertically\n * @default true\n * */\n vertical?: boolean;\n /** Scroll content horizontally\n * @default true\n * */\n horizontal?: boolean;\n /** Add a shadow when content is scrollable */\n shadow?: boolean;\n /** Slightly hints content upon mounting when scrollable */\n hint?: boolean;\n /** Adds a tabIndex to scrollable when children are not focusable */\n focusable?: boolean;\n /** Called when scrolled to the bottom of the scroll area */\n onScrolledToBottom?(): void;\n}" } }, "StrictOption": { @@ -18048,6 +18050,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", @@ -18173,32 +18201,6 @@ "description": "" } }, - "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}" - } - }, "Variation": { "polaris-react/src/components/TextStyle/TextStyle.tsx": { "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", @@ -18348,89 +18350,6 @@ "value": "export interface TilesProps {\n /** Elements to display inside tile */\n children: React.ReactNode;\n /** Adjust spacing between elements */\n gap?: Gap;\n /** Adjust number of columns */\n columns?: Columns;\n}" } }, - "TooltipProps": { - "polaris-react/src/components/Tooltip/Tooltip.tsx": { - "filePath": "polaris-react/src/components/Tooltip/Tooltip.tsx", - "name": "TooltipProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Tooltip/Tooltip.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The element that will activate to tooltip", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tooltip/Tooltip.tsx", - "syntaxKind": "PropertySignature", - "name": "content", - "value": "React.ReactNode", - "description": "The content to display within the tooltip" - }, - { - "filePath": "polaris-react/src/components/Tooltip/Tooltip.tsx", - "syntaxKind": "PropertySignature", - "name": "active", - "value": "boolean", - "description": "Toggle whether the tooltip is visible", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tooltip/Tooltip.tsx", - "syntaxKind": "PropertySignature", - "name": "dismissOnMouseOut", - "value": "boolean", - "description": "Dismiss tooltip when not interacting with its children", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tooltip/Tooltip.tsx", - "syntaxKind": "PropertySignature", - "name": "preferredPosition", - "value": "PreferredPosition", - "description": "The direction the tooltip tries to display", - "isOptional": true, - "defaultValue": "'below'" - }, - { - "filePath": "polaris-react/src/components/Tooltip/Tooltip.tsx", - "syntaxKind": "PropertySignature", - "name": "activatorWrapper", - "value": "string", - "description": "The element type to wrap the activator in", - "isOptional": true, - "defaultValue": "'span'" - }, - { - "filePath": "polaris-react/src/components/Tooltip/Tooltip.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Visually hidden text for screen readers", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tooltip/Tooltip.tsx", - "syntaxKind": "MethodSignature", - "name": "onOpen", - "value": "() => void", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tooltip/Tooltip.tsx", - "syntaxKind": "MethodSignature", - "name": "onClose", - "value": "() => void", - "description": "", - "isOptional": true - } - ], - "value": "export interface TooltipProps {\n /** The element that will activate to tooltip */\n children?: React.ReactNode;\n /** The content to display within the tooltip */\n content: React.ReactNode;\n /** Toggle whether the tooltip is visible */\n active?: boolean;\n /** Dismiss tooltip when not interacting with its children */\n dismissOnMouseOut?: TooltipOverlayProps['preventInteraction'];\n /**\n * The direction the tooltip tries to display\n * @default 'below'\n */\n preferredPosition?: TooltipOverlayProps['preferredPosition'];\n /**\n * The element type to wrap the activator in\n * @default 'span'\n */\n activatorWrapper?: string;\n /** Visually hidden text for screen readers */\n accessibilityLabel?: string;\n /* Callback fired when the tooltip is activated */\n onOpen?(): void;\n /* Callback fired when the tooltip is dismissed */\n onClose?(): void;\n}" - } - }, "TopBarProps": { "polaris-react/src/components/TopBar/TopBar.tsx": { "filePath": "polaris-react/src/components/TopBar/TopBar.tsx", @@ -18529,47 +18448,113 @@ "value": "export interface TopBarProps {\n /** Toggles whether or not a navigation component has been provided. Controls the presence of the mobile nav toggle button */\n showNavigationToggle?: boolean;\n /** Accepts a user component that is made available as a static member of the top bar component and renders as the primary menu */\n userMenu?: React.ReactNode;\n /** Accepts a menu component that is made available as a static member of the top bar component */\n secondaryMenu?: React.ReactNode;\n /** Accepts a component that is used to help users switch between different contexts */\n contextControl?: React.ReactNode;\n /** Accepts a search field component that is made available as a `TextField` static member of the top bar component */\n searchField?: React.ReactNode;\n /** Accepts a search results component that is ideally composed of a card component containing a list of actionable search results */\n searchResults?: React.ReactNode;\n /** A boolean property indicating whether search results are currently visible. */\n searchResultsVisible?: boolean;\n /** Whether or not the search results overlay has a visible backdrop */\n searchResultsOverlayVisible?: boolean;\n /** A callback function that handles the dismissal of search results */\n onSearchResultsDismiss?: SearchProps['onDismiss'];\n /** A callback function that handles hiding and showing mobile navigation */\n onNavigationToggle?(): void;\n /** Accepts a component that is used to supplement the logo markup */\n logoSuffix?: React.ReactNode;\n}" } }, - "TrapFocusProps": { - "polaris-react/src/components/TrapFocus/TrapFocus.tsx": { - "filePath": "polaris-react/src/components/TrapFocus/TrapFocus.tsx", - "name": "TrapFocusProps", + "TooltipProps": { + "polaris-react/src/components/Tooltip/Tooltip.tsx": { + "filePath": "polaris-react/src/components/Tooltip/Tooltip.tsx", + "name": "TooltipProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/TrapFocus/TrapFocus.tsx", + "filePath": "polaris-react/src/components/Tooltip/Tooltip.tsx", "syntaxKind": "PropertySignature", - "name": "trapping", - "value": "boolean", - "description": "", + "name": "children", + "value": "React.ReactNode", + "description": "The element that will activate to tooltip", "isOptional": true }, { - "filePath": "polaris-react/src/components/TrapFocus/TrapFocus.tsx", + "filePath": "polaris-react/src/components/Tooltip/Tooltip.tsx", "syntaxKind": "PropertySignature", - "name": "children", + "name": "content", "value": "React.ReactNode", + "description": "The content to display within the tooltip" + }, + { + "filePath": "polaris-react/src/components/Tooltip/Tooltip.tsx", + "syntaxKind": "PropertySignature", + "name": "active", + "value": "boolean", + "description": "Toggle whether the tooltip is visible", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tooltip/Tooltip.tsx", + "syntaxKind": "PropertySignature", + "name": "dismissOnMouseOut", + "value": "boolean", + "description": "Dismiss tooltip when not interacting with its children", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tooltip/Tooltip.tsx", + "syntaxKind": "PropertySignature", + "name": "preferredPosition", + "value": "PreferredPosition", + "description": "The direction the tooltip tries to display", + "isOptional": true, + "defaultValue": "'below'" + }, + { + "filePath": "polaris-react/src/components/Tooltip/Tooltip.tsx", + "syntaxKind": "PropertySignature", + "name": "activatorWrapper", + "value": "string", + "description": "The element type to wrap the activator in", + "isOptional": true, + "defaultValue": "'span'" + }, + { + "filePath": "polaris-react/src/components/Tooltip/Tooltip.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden text for screen readers", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tooltip/Tooltip.tsx", + "syntaxKind": "MethodSignature", + "name": "onOpen", + "value": "() => void", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tooltip/Tooltip.tsx", + "syntaxKind": "MethodSignature", + "name": "onClose", + "value": "() => void", "description": "", "isOptional": true } ], - "value": "export interface TrapFocusProps {\n trapping?: boolean;\n children?: React.ReactNode;\n}" + "value": "export interface TooltipProps {\n /** The element that will activate to tooltip */\n children?: React.ReactNode;\n /** The content to display within the tooltip */\n content: React.ReactNode;\n /** Toggle whether the tooltip is visible */\n active?: boolean;\n /** Dismiss tooltip when not interacting with its children */\n dismissOnMouseOut?: TooltipOverlayProps['preventInteraction'];\n /**\n * The direction the tooltip tries to display\n * @default 'below'\n */\n preferredPosition?: TooltipOverlayProps['preferredPosition'];\n /**\n * The element type to wrap the activator in\n * @default 'span'\n */\n activatorWrapper?: string;\n /** Visually hidden text for screen readers */\n accessibilityLabel?: string;\n /* Callback fired when the tooltip is activated */\n onOpen?(): void;\n /* Callback fired when the tooltip is dismissed */\n onClose?(): void;\n}" } }, - "TruncateProps": { - "polaris-react/src/components/Truncate/Truncate.tsx": { - "filePath": "polaris-react/src/components/Truncate/Truncate.tsx", - "name": "TruncateProps", + "TrapFocusProps": { + "polaris-react/src/components/TrapFocus/TrapFocus.tsx": { + "filePath": "polaris-react/src/components/TrapFocus/TrapFocus.tsx", + "name": "TrapFocusProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Truncate/Truncate.tsx", + "filePath": "polaris-react/src/components/TrapFocus/TrapFocus.tsx", + "syntaxKind": "PropertySignature", + "name": "trapping", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TrapFocus/TrapFocus.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", - "description": "" + "description": "", + "isOptional": true } ], - "value": "export interface TruncateProps {\n children: React.ReactNode;\n}" + "value": "export interface TrapFocusProps {\n trapping?: boolean;\n children?: React.ReactNode;\n}" } }, "UnstyledButtonProps": { @@ -18787,6 +18772,23 @@ "value": "export interface UnstyledButtonProps extends BaseButton {\n /** The content to display inside the button */\n children?: React.ReactNode;\n /** A custom class name to apply styles to button */\n className?: string;\n [key: string]: any;\n}" } }, + "TruncateProps": { + "polaris-react/src/components/Truncate/Truncate.tsx": { + "filePath": "polaris-react/src/components/Truncate/Truncate.tsx", + "name": "TruncateProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Truncate/Truncate.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "" + } + ], + "value": "export interface TruncateProps {\n children: React.ReactNode;\n}" + } + }, "UnstyledLinkProps": { "polaris-react/src/components/UnstyledLink/UnstyledLink.tsx": { "filePath": "polaris-react/src/components/UnstyledLink/UnstyledLink.tsx", @@ -22004,360 +22006,312 @@ "value": "export interface PortalsManager {\n container: PortalsContainerElement;\n}" } }, - "SectionProps": { - "polaris-react/src/components/ActionList/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "name": "SectionProps", + "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/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "section", - "value": "ActionListSection", - "description": "Section of action items" - }, + "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/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "hasMultipleSections", - "value": "boolean", - "description": "Should there be multiple sections" + "name": "position", + "value": "ItemPosition", + "description": "Position of the item" }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "actionRole", - "value": "string", - "description": "Defines a specific role attribute for each action in the list", + "name": "children", + "value": "React.ReactNode", + "description": "Item content", "isOptional": true - }, + } + ], + "value": "export interface ItemProps {\n /** Position of the item */\n position: ItemPosition;\n /** Item content */\n children?: React.ReactNode;\n}" + }, + "polaris-react/src/components/FormLayout/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any item is clicked or keypressed", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true } ], - "value": "export interface SectionProps {\n /** Section of action items */\n section: ActionListSection;\n /** Should there be multiple sections */\n hasMultipleSections: boolean;\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'option' | 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" + "value": "export interface ItemProps {\n children?: React.ReactNode;\n}" }, - "polaris-react/src/components/Layout/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "name": "SectionProps", + "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/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", + "description": "Content to display inside the item", + "isOptional": true + } + ], + "value": "export interface ItemProps {\n /** Content to display inside the item */\n children?: React.ReactNode;\n}" + }, + "polaris-react/src/components/Navigation/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "any", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "secondary", - "value": "boolean", + "name": "badge", + "value": "ReactNode", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "fullWidth", + "name": "label", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "oneHalf", + "name": "accessibilityLabel", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "selected", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "oneThird", + "name": "exactMatch", "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/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "divider", + "name": "new", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", + "name": "subNavigationItems", + "value": "SubNavigationItem[]", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.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", + "name": "secondaryAction", + "value": "SecondaryAction", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "flush", - "value": "boolean", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "subdued", - "value": "boolean", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "MethodSignature", + "name": "onToggleExpandedState", + "value": "() => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "titleHidden", + "name": "expanded", "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", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", + "name": "shouldResizeIcon", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "title", + "name": "url", "value": "string", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "fill", + "name": "matches", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "rollup", - "value": "{ after: number; view: string; hide: string; activePath: string; }", + "name": "matchPaths", + "value": "string[]", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "action", - "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", + "name": "excludePaths", + "value": "string[]", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "separator", + "name": "external", "value": "boolean", "description": "", "isOptional": true } ], - "value": "export interface SectionProps {\n items: ItemProps[];\n icon?: IconProps['source'];\n title?: string;\n fill?: boolean;\n rollup?: {\n after: number;\n view: string;\n hide: string;\n activePath: string;\n };\n action?: {\n icon: IconProps['source'];\n accessibilityLabel: string;\n onClick(): void;\n tooltip?: TooltipProps;\n };\n separator?: boolean;\n}" + "value": "export interface ItemProps extends ItemURLDetails {\n icon?: IconProps['source'];\n badge?: ReactNode;\n label: string;\n disabled?: boolean;\n accessibilityLabel?: string;\n selected?: boolean;\n exactMatch?: boolean;\n new?: boolean;\n subNavigationItems?: SubNavigationItem[];\n secondaryAction?: SecondaryAction;\n onClick?(): void;\n onToggleExpandedState?(): void;\n expanded?: boolean;\n shouldResizeIcon?: boolean;\n}" }, - "polaris-react/src/components/Popover/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", - "name": "SectionProps", + "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/Popover/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", - "description": "", + "description": "Elements to display inside item", "isOptional": true - } - ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\n}" - } - }, - "ItemProps": { - "polaris-react/src/components/ActionList/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/ActionList/components/Item/Item.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "ItemProps", - "value": "ActionListItemDescriptor", - "description": "" - }, - "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "button", - "value": "React.ReactElement", - "description": "" - } - ], - "value": "export interface ItemProps {\n button: React.ReactElement;\n}" - }, - "polaris-react/src/components/Connected/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "position", - "value": "ItemPosition", - "description": "Position of the item" }, { - "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Item content", + "name": "fill", + "value": "boolean", + "description": "Fill the remaining horizontal space in the stack with the item", "isOptional": true } ], - "value": "export interface ItemProps {\n /** Position of the item */\n position: ItemPosition;\n /** Item content */\n children?: React.ReactNode;\n}" + "value": "export interface 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/FormLayout/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", + "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/FormLayout/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "export interface ItemProps {\n children?: React.ReactNode;\n}" - }, - "polaris-react/src/components/List/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ + "name": "id", + "value": "string", + "description": "" + }, { - "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Content to display inside the item", - "isOptional": true - } - ], - "value": "export interface ItemProps {\n /** Content to display inside the item */\n children?: React.ReactNode;\n}" - }, - "polaris-react/src/components/Navigation/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ + "name": "focused", + "value": "boolean", + "description": "" + }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", + "name": "panelID", + "value": "string", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "badge", - "value": "ReactNode", + "name": "children", + "value": "React.ReactNode", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "label", + "name": "url", "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", @@ -22365,213 +22319,261 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "selected", - "value": "boolean", + "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": "exactMatch", - "value": "boolean", + "name": "children", + "value": "React.ReactNode", "description": "", "isOptional": true - }, + } + ], + "value": "interface ItemProps {\n children?: React.ReactNode;\n}" + } + }, + "SectionProps": { + "polaris-react/src/components/ActionList/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "new", - "value": "boolean", - "description": "", - "isOptional": true + "name": "section", + "value": "ActionListSection", + "description": "Section of action items" }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "subNavigationItems", - "value": "SubNavigationItem[]", - "description": "", - "isOptional": true + "name": "hasMultipleSections", + "value": "boolean", + "description": "Should there be multiple sections" }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "secondaryAction", - "value": "SecondaryAction", - "description": "", + "name": "actionRole", + "value": "string", + "description": "Defines a specific role attribute for each action in the list", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "onActionAnyItem", "value": "() => void", - "description": "", + "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/Navigation/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onToggleExpandedState", - "value": "() => void", + "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/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "expanded", + "name": "secondary", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "shouldResizeIcon", + "name": "fullWidth", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", + "name": "oneHalf", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "matches", + "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/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "matchPaths", - "value": "string[]", + "name": "divider", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "excludePaths", - "value": "string[]", + "name": "children", + "value": "ReactNode", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "external", - "value": "boolean", - "description": "", - "isOptional": true + "name": "title", + "value": "ReactNode", + "description": "" } ], - "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}" + "value": "interface SectionProps {\n divider?: boolean;\n children?: ReactNode;\n title: ReactNode;\n}" }, - "polaris-react/src/components/Stack/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", - "name": "ItemProps", + "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/Stack/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", - "description": "Elements to display inside item", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "fill", + "name": "flush", "value": "boolean", - "description": "Fill the remaining horizontal space in the stack with the item", + "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 ItemProps {\n /** Elements to display inside item */\n children?: React.ReactNode;\n /** Fill the remaining horizontal space in the stack with the item */\n fill?: boolean;\n /**\n * @default false\n */\n}" + "value": "export interface SectionProps {\n children?: React.ReactNode;\n flush?: boolean;\n subdued?: boolean;\n titleHidden?: boolean;\n}" }, - "polaris-react/src/components/Tabs/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "name": "ItemProps", + "polaris-react/src/components/Navigation/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "name": "SectionProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", + "name": "items", + "value": "ItemProps[]", "description": "" }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "focused", - "value": "boolean", - "description": "" + "name": "icon", + "value": "any", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "panelID", + "name": "title", "value": "string", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", + "name": "fill", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", + "name": "rollup", + "value": "{ after: number; view: string; hide: string; activePath: string; }", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", + "name": "action", + "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "separator", + "value": "boolean", "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}" + "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/Filters/components/ConnectedFilterControl/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", - "name": "ItemProps", + "polaris-react/src/components/Popover/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", + "name": "SectionProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", @@ -22579,7 +22581,7 @@ "isOptional": true } ], - "value": "interface ItemProps {\n children?: React.ReactNode;\n}" + "value": "export interface SectionProps {\n children?: React.ReactNode;\n}" } }, "MeasuredActions": { @@ -22732,40 +22734,6 @@ "value": "export interface MenuGroupProps extends MenuGroupDescriptor {\n /** Visually hidden menu description for screen readers */\n accessibilityLabel?: string;\n /** Whether or not the menu is open */\n active?: boolean;\n /** Callback when the menu is clicked */\n onClick?(openActions: () => void): void;\n /** Callback for opening the MenuGroup by title */\n onOpen(title: string): void;\n /** Callback for closing the MenuGroup by title */\n onClose(title: string): void;\n /** Callback for getting the offsetWidth of the MenuGroup */\n getOffsetWidth?(width: number): void;\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n}" } }, - "RollupActionsProps": { - "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "name": "RollupActionsProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Accessibilty label", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "syntaxKind": "PropertySignature", - "name": "items", - "value": "ActionListItemDescriptor[]", - "description": "Collection of actions for the list", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "syntaxKind": "PropertySignature", - "name": "sections", - "value": "ActionListSection[]", - "description": "Collection of sectioned action items", - "isOptional": true - } - ], - "value": "export interface 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", @@ -23315,6 +23283,49 @@ "value": "interface MappedAction extends ActionListItemDescriptor {\n wrapOverflow?: boolean;\n}" } }, + "RollupActionsProps": { + "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "name": "RollupActionsProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "Accessibilty label", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "syntaxKind": "PropertySignature", + "name": "items", + "value": "ActionListItemDescriptor[]", + "description": "Collection of actions for the list", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "syntaxKind": "PropertySignature", + "name": "sections", + "value": "ActionListSection[]", + "description": "Collection of sectioned action items", + "isOptional": true + } + ], + "value": "export interface 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}" + } + }, + "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", @@ -23358,15 +23369,6 @@ "description": "" } }, - "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": "" - } - }, "BulkActionsMenuProps": { "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx": { "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", @@ -23692,15 +23694,6 @@ "value": "export interface SlidableProps {\n draggerX?: number;\n draggerY?: number;\n onChange(position: Position): void;\n onDraggerHeight?(height: number): void;\n}" } }, - "ItemPosition": { - "polaris-react/src/components/Connected/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "ItemPosition", - "value": "'left' | 'right' | 'primary'", - "description": "" - } - }, "CellProps": { "polaris-react/src/components/DataTable/components/Cell/Cell.tsx": { "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", @@ -23999,6 +23992,15 @@ "value": "export interface CellProps {\n children?: ReactNode;\n className?: string;\n flush?: boolean;\n}" } }, + "ItemPosition": { + "polaris-react/src/components/Connected/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ItemPosition", + "value": "'left' | 'right' | 'primary'", + "description": "" + } + }, "DayProps": { "polaris-react/src/components/DatePicker/components/Day/Day.tsx": { "filePath": "polaris-react/src/components/DatePicker/components/Day/Day.tsx", @@ -24583,15 +24585,6 @@ "value": "export interface CSSAnimationProps {\n in: boolean;\n className: string;\n type: AnimationType;\n children?: React.ReactNode;\n}" } }, - "Cell": { - "polaris-react/src/components/Grid/components/Cell/Cell.tsx": { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Cell", - "value": "{\n [Breakpoint in Breakpoints]?: string;\n}", - "description": "" - } - }, "ToastManagerProps": { "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx": { "filePath": "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx", @@ -24609,6 +24602,15 @@ "value": "export interface ToastManagerProps {\n toastMessages: ToastPropsWithID[];\n}" } }, + "Cell": { + "polaris-react/src/components/Grid/components/Cell/Cell.tsx": { + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Cell", + "value": "{\n [Breakpoint in Breakpoints]?: string;\n}", + "description": "" + } + }, "CheckboxWrapperProps": { "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx": { "filePath": "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx", @@ -26266,97 +26268,14 @@ }, { "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", - "name": "TabMeasurements", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", - "syntaxKind": "PropertySignature", - "name": "containerWidth", - "value": "number", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", - "syntaxKind": "PropertySignature", - "name": "disclosureWidth", - "value": "number", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", - "syntaxKind": "PropertySignature", - "name": "hiddenTabWidths", - "value": "number[]", - "description": "" - } - ], - "value": "interface TabMeasurements {\n containerWidth: number;\n disclosureWidth: number;\n hiddenTabWidths: number[];\n}" - } - }, - "TabMeasurerProps": { - "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx": { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", - "name": "TabMeasurerProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", - "syntaxKind": "PropertySignature", - "name": "tabToFocus", - "value": "number", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", - "syntaxKind": "PropertySignature", - "name": "siblingTabHasFocus", - "value": "boolean", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", - "syntaxKind": "PropertySignature", - "name": "activator", - "value": "React.ReactElement", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", - "syntaxKind": "PropertySignature", - "name": "selected", - "value": "number", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", - "syntaxKind": "PropertySignature", - "name": "tabs", - "value": "TabDescriptor[]", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", - "syntaxKind": "MethodSignature", - "name": "handleMeasurement", - "value": "(measurements: TabMeasurements) => void", - "description": "" + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true } ], - "value": "export interface TabMeasurerProps {\n tabToFocus: number;\n siblingTabHasFocus: boolean;\n activator: React.ReactElement;\n selected: number;\n tabs: TabDescriptor[];\n handleMeasurement(measurements: TabMeasurements): void;\n}" + "value": "export interface PanelProps {\n hidden?: boolean;\n id: string;\n tabID: string;\n children?: React.ReactNode;\n}" } }, "TabProps": { @@ -26448,6 +26367,89 @@ "value": "export interface TabProps {\n id: string;\n focused?: boolean;\n siblingTabHasFocus?: boolean;\n selected?: boolean;\n panelID?: string;\n children?: React.ReactNode;\n url?: string;\n measuring?: boolean;\n accessibilityLabel?: string;\n onClick?(id: string): void;\n}" } }, + "TabMeasurements": { + "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx": { + "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", + "name": "TabMeasurements", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", + "syntaxKind": "PropertySignature", + "name": "containerWidth", + "value": "number", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", + "syntaxKind": "PropertySignature", + "name": "disclosureWidth", + "value": "number", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", + "syntaxKind": "PropertySignature", + "name": "hiddenTabWidths", + "value": "number[]", + "description": "" + } + ], + "value": "interface TabMeasurements {\n containerWidth: number;\n disclosureWidth: number;\n hiddenTabWidths: number[];\n}" + } + }, + "TabMeasurerProps": { + "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx": { + "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", + "name": "TabMeasurerProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", + "syntaxKind": "PropertySignature", + "name": "tabToFocus", + "value": "number", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", + "syntaxKind": "PropertySignature", + "name": "siblingTabHasFocus", + "value": "boolean", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", + "syntaxKind": "PropertySignature", + "name": "activator", + "value": "React.ReactElement", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "number", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", + "syntaxKind": "PropertySignature", + "name": "tabs", + "value": "TabDescriptor[]", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", + "syntaxKind": "MethodSignature", + "name": "handleMeasurement", + "value": "(measurements: TabMeasurements) => void", + "description": "" + } + ], + "value": "export interface TabMeasurerProps {\n tabToFocus: number;\n siblingTabHasFocus: boolean;\n activator: React.ReactElement;\n selected: number;\n tabs: TabDescriptor[];\n handleMeasurement(measurements: TabMeasurements): void;\n}" + } + }, "ResizerProps": { "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx": { "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", @@ -26559,76 +26561,6 @@ "value": "export interface MenuProps {\n /** Accepts an activator component that renders inside of a button that opens the menu */\n activatorContent: React.ReactNode;\n /** An array of action objects that are rendered inside of a popover triggered by this menu */\n actions: ActionListProps['sections'];\n /** Accepts a message that facilitates direct, urgent communication with the merchant through the menu */\n message?: MessageProps;\n /** A boolean property indicating whether the menu is currently open */\n open: boolean;\n /** A callback function to handle opening the menu popover */\n onOpen(): void;\n /** A callback function to handle closing the menu popover */\n onClose(): void;\n /** A callback function to handle closing the menu popover */\n onClose(): void;\n /** A string that provides the accessibility labeling */\n accessibilityLabel?: string;\n}" } }, - "TooltipOverlayProps": { - "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx": { - "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", - "name": "TooltipOverlayProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", - "syntaxKind": "PropertySignature", - "name": "active", - "value": "boolean", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", - "syntaxKind": "PropertySignature", - "name": "preventInteraction", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", - "syntaxKind": "PropertySignature", - "name": "preferredPosition", - "value": "PreferredPosition", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", - "syntaxKind": "PropertySignature", - "name": "activator", - "value": "HTMLElement", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", - "syntaxKind": "MethodSignature", - "name": "onClose", - "value": "() => void", - "description": "" - } - ], - "value": "export interface TooltipOverlayProps {\n id: string;\n active: boolean;\n preventInteraction?: PositionedOverlayProps['preventInteraction'];\n preferredPosition?: PositionedOverlayProps['preferredPosition'];\n children?: React.ReactNode;\n activator: HTMLElement;\n accessibilityLabel?: string;\n onClose(): void;\n}" - } - }, "SearchProps": { "polaris-react/src/components/TopBar/components/Search/Search.tsx": { "filePath": "polaris-react/src/components/TopBar/components/Search/Search.tsx", @@ -26828,35 +26760,74 @@ "value": "export interface UserMenuProps {\n /** An array of action objects that are rendered inside of a popover triggered by this menu */\n actions: {items: IconableAction[]}[];\n /** Accepts a message that facilitates direct, urgent communication with the merchant through the user menu */\n message?: MenuProps['message'];\n /** A string detailing the merchant’s full name to be displayed in the user menu */\n name: string;\n /** A string allowing further detail on the merchant’s name displayed in the user menu */\n detail?: string;\n /** A string that provides the accessibility labeling */\n accessibilityLabel?: string;\n /** The merchant’s initials, rendered in place of an avatar image when not provided */\n initials: AvatarProps['initials'];\n /** An avatar image representing the merchant */\n avatar?: AvatarProps['source'];\n /** A boolean property indicating whether the user menu is currently open */\n open: boolean;\n /** A callback function to handle opening and closing the user menu */\n onToggle(): void;\n}" } }, - "DiscardConfirmationModalProps": { - "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx": { - "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", - "name": "DiscardConfirmationModalProps", + "TooltipOverlayProps": { + "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx": { + "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", + "name": "TooltipOverlayProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", + "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", "syntaxKind": "PropertySignature", - "name": "open", + "name": "id", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", + "syntaxKind": "PropertySignature", + "name": "active", "value": "boolean", "description": "" }, { - "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", - "syntaxKind": "MethodSignature", - "name": "onDiscard", - "value": "() => void", + "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", + "syntaxKind": "PropertySignature", + "name": "preventInteraction", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", + "syntaxKind": "PropertySignature", + "name": "preferredPosition", + "value": "PreferredPosition", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", + "syntaxKind": "PropertySignature", + "name": "activator", + "value": "HTMLElement", "description": "" }, { - "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", + "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", "syntaxKind": "MethodSignature", - "name": "onCancel", + "name": "onClose", "value": "() => void", "description": "" } ], - "value": "export interface DiscardConfirmationModalProps {\n open: boolean;\n onDiscard(): void;\n onCancel(): void;\n}" + "value": "export interface TooltipOverlayProps {\n id: string;\n active: boolean;\n preventInteraction?: PositionedOverlayProps['preventInteraction'];\n preferredPosition?: PositionedOverlayProps['preferredPosition'];\n children?: React.ReactNode;\n activator: HTMLElement;\n accessibilityLabel?: string;\n onClose(): void;\n}" } }, "SecondaryProps": { @@ -26892,6 +26863,37 @@ "value": "interface SecondaryProps {\n expanded: boolean;\n children?: React.ReactNode;\n id?: string;\n}" } }, + "DiscardConfirmationModalProps": { + "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx": { + "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", + "name": "DiscardConfirmationModalProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", + "syntaxKind": "PropertySignature", + "name": "open", + "value": "boolean", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", + "syntaxKind": "MethodSignature", + "name": "onDiscard", + "value": "() => void", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", + "syntaxKind": "MethodSignature", + "name": "onCancel", + "value": "() => void", + "description": "" + } + ], + "value": "export interface DiscardConfirmationModalProps {\n open: boolean;\n onDiscard(): void;\n onCancel(): void;\n}" + } + }, "TitleProps": { "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx": { "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", From b53b794fb9cbdef13f2678ea25f415bb0ba0afe0 Mon Sep 17 00:00:00 2001 From: Lo Kim Date: Mon, 24 Oct 2022 13:56:55 -0400 Subject: [PATCH 3/3] Add changeset --- .changeset/odd-zebras-yell.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .changeset/odd-zebras-yell.md diff --git a/.changeset/odd-zebras-yell.md b/.changeset/odd-zebras-yell.md new file mode 100644 index 00000000000..edec75f310d --- /dev/null +++ b/.changeset/odd-zebras-yell.md @@ -0,0 +1,6 @@ +--- +'@shopify/polaris': minor +'polaris.shopify.com': minor +--- + +Added support for `section` element types to `Box`