From 4e17711f99a9a3c1fea94d4b9b290ee42710a084 Mon Sep 17 00:00:00 2001 From: Lo Kim Date: Tue, 30 Aug 2022 14:47:36 -0400 Subject: [PATCH 01/25] [Layout foundations] Add alpha `Box` component (#7000) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Resolves #6892. Adds a new alpha `Box` component.
Using `Box` to recreate the `Card` component Using `Box` to recreate the `Card` component
🖥 [Local development instructions](https://github.com/Shopify/polaris/blob/main/README.md#local-development) 🗒 [General tophatting guidelines](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md) 📄 [Changelog guidelines](https://github.com/Shopify/polaris/blob/main/.github/CONTRIBUTING.md#changelog)
Copy-paste this code in playground/Playground.tsx: ```jsx import React from 'react'; import {Page, Card, Text, Box} from '../src'; export function Playground() { return ( {/* Add the code you want to test in here */} Online store dashboard This was made using the 📦 Box 📦 component.
This was made using the 🃏 Card 🃏 component. ); } ```
- [ ] Tested on [mobile](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md#cross-browser-testing) - [ ] Tested on [multiple browsers](https://help.shopify.com/en/manual/shopify-admin/supported-browsers) - [ ] Tested for [accessibility](https://github.com/Shopify/polaris/blob/main/documentation/Accessibility%20testing.md) - [ ] Updated the component's `README.md` with documentation changes - [ ] [Tophatted documentation](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting%20documentation.md) changes in the style guide Co-authored-by: Aaron Casanova Co-authored-by: Aveline Thelen Co-authored-by: Alex Page Co-authored-by: Kyle Durand --- .changeset/red-cycles-allow.md | 5 + polaris-react/src/components/Box/Box.scss | 23 ++ polaris-react/src/components/Box/Box.tsx | 253 ++++++++++++++++++++++ polaris-react/src/components/Box/index.ts | 1 + polaris-react/src/index.ts | 3 + yarn.lock | 5 + 6 files changed, 290 insertions(+) create mode 100644 .changeset/red-cycles-allow.md create mode 100644 polaris-react/src/components/Box/Box.scss create mode 100644 polaris-react/src/components/Box/Box.tsx create mode 100644 polaris-react/src/components/Box/index.ts diff --git a/.changeset/red-cycles-allow.md b/.changeset/red-cycles-allow.md new file mode 100644 index 00000000000..76960cccefc --- /dev/null +++ b/.changeset/red-cycles-allow.md @@ -0,0 +1,5 @@ +--- +'@shopify/polaris': minor +--- + +Added `Box` component diff --git a/polaris-react/src/components/Box/Box.scss b/polaris-react/src/components/Box/Box.scss new file mode 100644 index 00000000000..e9f41654a2b --- /dev/null +++ b/polaris-react/src/components/Box/Box.scss @@ -0,0 +1,23 @@ +.Box { + display: block; + background-color: var(--pc-box-background, initial); + /* stylelint-disable declaration-block-no-redundant-longhand-properties */ + border-bottom-left-radius: var(--pc-box-border-radius-bottom-left, initial); + border-bottom-right-radius: var(--pc-box-border-radius-bottom-right, initial); + border-top-left-radius: var(--pc-box-border-radius-top-left, initial); + border-top-right-radius: var(--pc-box-border-radius-top-right, initial); + border-bottom: var(--pc-box-border-bottom, initial); + border-left: var(--pc-box-border-left, initial); + border-right: var(--pc-box-border-right, initial); + border-top: var(--pc-box-border-top, initial); + margin-bottom: var(--pc-box-margin-bottom, initial); + margin-left: var(--pc-box-margin-left, initial); + margin-right: var(--pc-box-margin-right, initial); + margin-top: var(--pc-box-margin-top, initial); + padding-bottom: var(--pc-box-padding-bottom, initial); + padding-left: var(--pc-box-padding-left, initial); + padding-right: var(--pc-box-padding-right, initial); + padding-top: var(--pc-box-padding-top, initial); + /* stylelint-enable declaration-block-no-redundant-longhand-properties */ + box-shadow: var(--pc-box-shadow, initial); +} diff --git a/polaris-react/src/components/Box/Box.tsx b/polaris-react/src/components/Box/Box.tsx new file mode 100644 index 00000000000..12b2684f0f2 --- /dev/null +++ b/polaris-react/src/components/Box/Box.tsx @@ -0,0 +1,253 @@ +import React, {ReactNode, forwardRef} from 'react'; +import type * as Polymorphic from '@radix-ui/react-polymorphic'; +import type {colors, depth, shape, spacing} from '@shopify/polaris-tokens'; + +import {classNames} from '../../utilities/css'; + +import styles from './Box.scss'; + +type ColorsTokenGroup = typeof colors; +type ColorsTokenName = keyof ColorsTokenGroup; +type BackgroundColorTokenScale = Extract< + ColorsTokenName, + | 'background' + | `background-${string}` + | 'surface' + | `surface-${string}` + | 'backdrop' + | 'overlay' +>; + +type DepthTokenGroup = typeof depth; +type DepthTokenName = keyof DepthTokenGroup; +type ShadowsTokenName = Exclude; + +type DepthTokenScale = ShadowsTokenName extends `shadow-${infer Scale}` + ? Scale + : never; + +type ShapeTokenGroup = typeof shape; +type ShapeTokenName = keyof ShapeTokenGroup; + +type BorderShapeTokenScale = ShapeTokenName extends `border-${infer Scale}` + ? Scale + : never; + +type BorderTokenScale = Exclude< + BorderShapeTokenScale, + `radius-${string}` | `width-${string}` +>; + +interface Border { + bottom: BorderTokenScale; + left: BorderTokenScale; + right: BorderTokenScale; + top: BorderTokenScale; +} + +type BorderRadiusTokenScale = Extract< + BorderShapeTokenScale, + `radius-${string}` +> extends `radius-${infer Scale}` + ? Scale + : never; + +interface BorderRadius { + bottomLeft: BorderRadiusTokenScale | ''; + bottomRight: BorderRadiusTokenScale | ''; + topLeft: BorderRadiusTokenScale | ''; + topRight: BorderRadiusTokenScale | ''; +} + +type SpacingTokenGroup = typeof spacing; +type SpacingTokenName = keyof SpacingTokenGroup; + +// TODO: Bring this logic into tokens +type SpacingTokenScale = SpacingTokenName extends `space-${infer Scale}` + ? Scale + : never; + +interface Spacing { + bottom: SpacingTokenScale | ''; + left: SpacingTokenScale | ''; + right: SpacingTokenScale | ''; + top: SpacingTokenScale | ''; +} + +interface BoxBaseProps { + /** Background color of the Box */ + background?: BackgroundColorTokenScale; + /** Border styling of the Box */ + border?: BorderTokenScale; + /** Bottom border styling of the Box */ + borderBottom?: BorderTokenScale; + /** Left border styling of the Box */ + borderLeft?: BorderTokenScale; + /** Right border styling of the Box */ + borderRight?: BorderTokenScale; + /** Top border styling of the Box */ + borderTop?: BorderTokenScale; + /** Border radius of the Box */ + borderRadius?: BorderRadiusTokenScale; + /** Bottom left border radius of the Box */ + borderRadiusBottomLeft?: BorderRadiusTokenScale; + /** Bottom right border radius of the Box */ + borderRadiusBottomRight?: BorderRadiusTokenScale; + /** Top left border radius of the Box */ + borderRadiusTopLeft?: BorderRadiusTokenScale; + /** Top right border radius of the Box */ + borderRadiusTopRight?: BorderRadiusTokenScale; + /** Inner content of the Box */ + children: ReactNode; + /** Spacing outside of the Box */ + margin?: SpacingTokenScale; + /** Bottom spacing outside of the Box */ + marginBottom?: SpacingTokenScale; + /** Left side spacing outside of the Box */ + marginLeft?: SpacingTokenScale; + /** Right side spacing outside of the Box */ + marginRight?: SpacingTokenScale; + /** Top spacing outside of the Box */ + marginTop?: SpacingTokenScale; + /** Spacing inside of the Box */ + padding?: SpacingTokenScale; + /** Bottom spacing inside of the Box */ + paddingBottom?: SpacingTokenScale; + /** Left side spacing inside of the Box */ + paddingLeft?: SpacingTokenScale; + /** Right side spacing inside of the Box */ + paddingRight?: SpacingTokenScale; + /** Top spacing inside of the Box */ + paddingTop?: SpacingTokenScale; + /** Shadow on the Box */ + shadow?: DepthTokenScale; +} + +type PolymorphicBox = Polymorphic.ForwardRefComponent<'div', BoxBaseProps>; + +export type BoxProps = Polymorphic.OwnProps; + +export const Box = forwardRef( + ( + { + as: Component = 'div', + background, + border = '', + borderBottom = '', + borderLeft = '', + borderRight = '', + borderTop = '', + borderRadius = '', + borderRadiusBottomLeft = '', + borderRadiusBottomRight = '', + borderRadiusTopLeft = '', + borderRadiusTopRight = '', + children, + margin = '', + marginBottom = '', + marginLeft = '', + marginRight = '', + marginTop = '', + padding = '', + paddingBottom = '', + paddingLeft = '', + paddingRight = '', + paddingTop = '', + shadow, + }, + ref, + ) => { + const borders = { + bottom: borderBottom ? borderBottom : border, + left: borderLeft ? borderLeft : border, + right: borderRight ? borderRight : border, + top: borderTop ? borderTop : border, + } as Border; + + const borderRadiuses = { + bottomLeft: borderRadiusBottomLeft + ? borderRadiusBottomLeft + : borderRadius, + bottomRight: borderRadiusBottomRight + ? borderRadiusBottomRight + : borderRadius, + topLeft: borderRadiusTopLeft ? borderRadiusTopLeft : borderRadius, + topRight: borderRadiusTopRight ? borderRadiusTopRight : borderRadius, + } as BorderRadius; + + const margins = { + bottom: marginBottom ? marginBottom : margin, + left: marginLeft ? marginLeft : margin, + right: marginRight ? marginRight : margin, + top: marginTop ? marginTop : margin, + } as Spacing; + + const paddings = { + bottom: paddingBottom ? paddingBottom : padding, + left: paddingLeft ? paddingLeft : padding, + right: paddingRight ? paddingRight : padding, + top: paddingTop ? paddingTop : padding, + } as Spacing; + + const style = { + '--pc-box-background': background ? `var(--p-${background})` : '', + '--pc-box-margin-bottom': margins.bottom + ? `var(--p-space-${margins.bottom})` + : '', + '--pc-box-margin-left': margins.left + ? `var(--p-space-${margins.left})` + : '', + '--pc-box-margin-right': margins.right + ? `var(--p-space-${margins.right})` + : '', + '--pc-box-margin-top': margins.top ? `var(--p-space-${margins.top})` : '', + '--pc-box-padding-bottom': paddings.bottom + ? `var(--p-space-${paddings.bottom})` + : '', + '--pc-box-padding-left': paddings.left + ? `var(--p-space-${paddings.left})` + : '', + '--pc-box-padding-right': paddings.right + ? `var(--p-space-${paddings.right})` + : '', + '--pc-box-padding-top': paddings.top + ? `var(--p-space-${paddings.top})` + : '', + '--pc-box-border-bottom': borders.bottom + ? `var(--p-border-${borders.bottom})` + : '', + '--pc-box-border-left': borders.left + ? `var(--p-border-${borders.left})` + : '', + '--pc-box-border-right': borders.right + ? `var(--p-border-${borders.right})` + : '', + '--pc-box-border-top': borders.top + ? `var(--p-border-${borders.top})` + : '', + '--pc-box-border-radius-bottom-left': borderRadiuses.bottomLeft + ? `var(--p-border-radius-${borderRadiuses.bottomLeft})` + : '', + '--pc-box-border-radius-bottom-right': borderRadiuses.bottomRight + ? `var(--p-border-radius-${borderRadiuses.bottomRight})` + : '', + '--pc-box-border-radius-top-left': borderRadiuses.topLeft + ? `var(--p-border-radius-${borderRadiuses.topLeft})` + : '', + '--pc-box-border-radius-top-right': borderRadiuses.topRight + ? `var(--p-border-radius-${borderRadiuses.topRight})` + : '', + '--pc-box-shadow': shadow ? `var(--p-shadow-${shadow})` : '', + } as React.CSSProperties; + + const className = classNames(styles.root); + + return ( + + {children} + + ); + }, +) as PolymorphicBox; + +Box.displayName = 'Box'; diff --git a/polaris-react/src/components/Box/index.ts b/polaris-react/src/components/Box/index.ts new file mode 100644 index 00000000000..305f81d78bc --- /dev/null +++ b/polaris-react/src/components/Box/index.ts @@ -0,0 +1 @@ +export * from './Box'; diff --git a/polaris-react/src/index.ts b/polaris-react/src/index.ts index 814a1ebb1dd..34133fcf8c0 100644 --- a/polaris-react/src/index.ts +++ b/polaris-react/src/index.ts @@ -69,6 +69,9 @@ export type { BannerHandles, } from './components/Banner'; +export {Box} from './components/Box'; +export type {BoxProps} from './components/Box'; + export {Breadcrumbs} from './components/Breadcrumbs'; export type {BreadcrumbsProps} from './components/Breadcrumbs'; diff --git a/yarn.lock b/yarn.lock index 6cdac3355f7..6dc8505ea4e 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2402,6 +2402,11 @@ resolved "https://registry.yarnpkg.com/@polka/url/-/url-1.0.0-next.21.tgz#5de5a2385a35309427f6011992b544514d559aa1" integrity sha512-a5Sab1C4/icpTZVzZc5Ghpz88yQtGOyNqYXcZgOssB2uuAr+wF/MvN6bgtW32q7HHrvBki+BsZ0OuNv6EV3K9g== +"@radix-ui/react-polymorphic@^0.0.14": + version "0.0.14" + resolved "https://registry.yarnpkg.com/@radix-ui/react-polymorphic/-/react-polymorphic-0.0.14.tgz#fc6cefee6686db8c5a7ff14c8c1b9b5abdee325b" + integrity sha512-9nsMZEDU3LeIUeHJrpkkhZVxu/9Fc7P2g2I3WR+uA9mTbNC3hGaabi0dV6wg0CfHb+m4nSs1pejbE/5no3MJTA== + "@rollup/plugin-babel@^5.3.1": version "5.3.1" resolved "https://registry.yarnpkg.com/@rollup/plugin-babel/-/plugin-babel-5.3.1.tgz#04bc0608f4aa4b2e4b1aebf284344d0f68fda283" From 1652413afed0d00326d4b4039ec56a18cf17c88e Mon Sep 17 00:00:00 2001 From: Lo Kim Date: Wed, 31 Aug 2022 13:57:19 -0400 Subject: [PATCH 02/25] [Layout foundations] Refactor `Box` without polymorphic dep (#7062) Co-authored-by: Kyle Durand --- polaris-react/src/components/Box/Box.scss | 2 +- polaris-react/src/components/Box/Box.tsx | 192 ++++++++++++---------- yarn.lock | 5 - 3 files changed, 102 insertions(+), 97 deletions(-) diff --git a/polaris-react/src/components/Box/Box.scss b/polaris-react/src/components/Box/Box.scss index e9f41654a2b..342b32837f8 100644 --- a/polaris-react/src/components/Box/Box.scss +++ b/polaris-react/src/components/Box/Box.scss @@ -1,6 +1,7 @@ .Box { display: block; background-color: var(--pc-box-background, initial); + box-shadow: var(--pc-box-shadow, initial); /* stylelint-disable declaration-block-no-redundant-longhand-properties */ border-bottom-left-radius: var(--pc-box-border-radius-bottom-left, initial); border-bottom-right-radius: var(--pc-box-border-radius-bottom-right, initial); @@ -19,5 +20,4 @@ padding-right: var(--pc-box-padding-right, initial); padding-top: var(--pc-box-padding-top, initial); /* stylelint-enable declaration-block-no-redundant-longhand-properties */ - box-shadow: var(--pc-box-shadow, initial); } diff --git a/polaris-react/src/components/Box/Box.tsx b/polaris-react/src/components/Box/Box.tsx index 12b2684f0f2..4d1ede91966 100644 --- a/polaris-react/src/components/Box/Box.tsx +++ b/polaris-react/src/components/Box/Box.tsx @@ -1,5 +1,4 @@ -import React, {ReactNode, forwardRef} from 'react'; -import type * as Polymorphic from '@radix-ui/react-polymorphic'; +import React, {createElement, forwardRef, ReactNode} from 'react'; import type {colors, depth, shape, spacing} from '@shopify/polaris-tokens'; import {classNames} from '../../utilities/css'; @@ -53,10 +52,10 @@ type BorderRadiusTokenScale = Extract< : never; interface BorderRadius { - bottomLeft: BorderRadiusTokenScale | ''; - bottomRight: BorderRadiusTokenScale | ''; - topLeft: BorderRadiusTokenScale | ''; - topRight: BorderRadiusTokenScale | ''; + bottomLeft: BorderRadiusTokenScale; + bottomRight: BorderRadiusTokenScale; + topLeft: BorderRadiusTokenScale; + topRight: BorderRadiusTokenScale; } type SpacingTokenGroup = typeof spacing; @@ -68,13 +67,14 @@ type SpacingTokenScale = SpacingTokenName extends `space-${infer Scale}` : never; interface Spacing { - bottom: SpacingTokenScale | ''; - left: SpacingTokenScale | ''; - right: SpacingTokenScale | ''; - top: SpacingTokenScale | ''; + bottom: SpacingTokenScale; + left: SpacingTokenScale; + right: SpacingTokenScale; + top: SpacingTokenScale; } -interface BoxBaseProps { +export interface BoxProps { + as?: 'div' | 'span'; /** Background color of the Box */ background?: BackgroundColorTokenScale; /** Border styling of the Box */ @@ -123,36 +123,32 @@ interface BoxBaseProps { shadow?: DepthTokenScale; } -type PolymorphicBox = Polymorphic.ForwardRefComponent<'div', BoxBaseProps>; - -export type BoxProps = Polymorphic.OwnProps; - -export const Box = forwardRef( +export const Box = forwardRef( ( { - as: Component = 'div', + as = 'div', background, - border = '', - borderBottom = '', - borderLeft = '', - borderRight = '', - borderTop = '', - borderRadius = '', - borderRadiusBottomLeft = '', - borderRadiusBottomRight = '', - borderRadiusTopLeft = '', - borderRadiusTopRight = '', + border, + borderBottom, + borderLeft, + borderRight, + borderTop, + borderRadius, + borderRadiusBottomLeft, + borderRadiusBottomRight, + borderRadiusTopLeft, + borderRadiusTopRight, children, - margin = '', - marginBottom = '', - marginLeft = '', - marginRight = '', - marginTop = '', - padding = '', - paddingBottom = '', - paddingLeft = '', - paddingRight = '', - paddingTop = '', + margin, + marginBottom, + marginLeft, + marginRight, + marginTop, + padding, + paddingBottom, + paddingLeft, + paddingRight, + paddingTop, shadow, }, ref, @@ -190,64 +186,78 @@ export const Box = forwardRef( } as Spacing; const style = { - '--pc-box-background': background ? `var(--p-${background})` : '', - '--pc-box-margin-bottom': margins.bottom - ? `var(--p-space-${margins.bottom})` - : '', - '--pc-box-margin-left': margins.left - ? `var(--p-space-${margins.left})` - : '', - '--pc-box-margin-right': margins.right - ? `var(--p-space-${margins.right})` - : '', - '--pc-box-margin-top': margins.top ? `var(--p-space-${margins.top})` : '', - '--pc-box-padding-bottom': paddings.bottom - ? `var(--p-space-${paddings.bottom})` - : '', - '--pc-box-padding-left': paddings.left - ? `var(--p-space-${paddings.left})` - : '', - '--pc-box-padding-right': paddings.right - ? `var(--p-space-${paddings.right})` - : '', - '--pc-box-padding-top': paddings.top - ? `var(--p-space-${paddings.top})` - : '', - '--pc-box-border-bottom': borders.bottom - ? `var(--p-border-${borders.bottom})` - : '', - '--pc-box-border-left': borders.left - ? `var(--p-border-${borders.left})` - : '', - '--pc-box-border-right': borders.right - ? `var(--p-border-${borders.right})` - : '', - '--pc-box-border-top': borders.top - ? `var(--p-border-${borders.top})` - : '', - '--pc-box-border-radius-bottom-left': borderRadiuses.bottomLeft - ? `var(--p-border-radius-${borderRadiuses.bottomLeft})` - : '', - '--pc-box-border-radius-bottom-right': borderRadiuses.bottomRight - ? `var(--p-border-radius-${borderRadiuses.bottomRight})` - : '', - '--pc-box-border-radius-top-left': borderRadiuses.topLeft - ? `var(--p-border-radius-${borderRadiuses.topLeft})` - : '', - '--pc-box-border-radius-top-right': borderRadiuses.topRight - ? `var(--p-border-radius-${borderRadiuses.topRight})` - : '', - '--pc-box-shadow': shadow ? `var(--p-shadow-${shadow})` : '', + ...(background ? {'--pc-box-background': `var(--p-${background})`} : {}), + ...(borders.bottom + ? {'--pc-box-border-bottom': `var(--p-border-${borders.bottom})`} + : {}), + ...(borders.left + ? {'--pc-box-border-left': `var(--p-border-${borders.left})`} + : {}), + ...(borders.right + ? {'--pc-box-border-right': `var(--p-border-${borders.right})`} + : {}), + ...(borders.top + ? {'--pc-box-border-top': `var(--p-border-${borders.top})`} + : {}), + ...(borderRadiuses.bottomLeft + ? { + '--pc-box-border-radius-bottom-left': `var(--p-border-radius-${borderRadiuses.bottomLeft})`, + } + : {}), + ...(borderRadiuses.bottomRight + ? { + '--pc-box-border-radius-bottom-right': `var(--p-border-radius-${borderRadiuses.bottomRight})`, + } + : {}), + ...(borderRadiuses.topLeft + ? { + '--pc-box-border-radius-top-left': `var(--p-border-radius-${borderRadiuses.topLeft})`, + } + : {}), + ...(borderRadiuses.topRight + ? { + '--pc-box-border-radius-top-right': `var(--p-border-radius-${borderRadiuses.topRight})`, + } + : {}), + ...(margins.bottom + ? {'--pc-box-margin-bottom': `var(--p-space-${margins.bottom})`} + : {}), + ...(margins.left + ? {'--pc-box-margin-left': `var(--p-space-${margins.left})`} + : {}), + ...(margins.right + ? {'--pc-box-margin-right': `var(--p-space-${margins.right})`} + : {}), + ...(margins.top + ? {'--pc-box-margin-top': `var(--p-space-${margins.top})`} + : {}), + ...(paddings.bottom + ? {'--pc-box-padding-bottom': `var(--p-space-${paddings.bottom})`} + : {}), + ...(paddings.left + ? {'--pc-box-padding-left': `var(--p-space-${paddings.left})`} + : {}), + ...(paddings.right + ? {'--pc-box-padding-right': `var(--p-space-${paddings.right})`} + : {}), + ...(paddings.top + ? {'--pc-box-padding-top': `var(--p-space-${paddings.top})`} + : {}), + ...(shadow ? {'--pc-box-shadow': `var(--p-shadow-${shadow})`} : {}), } as React.CSSProperties; - const className = classNames(styles.root); + const className = classNames(styles.Box); - return ( - - {children} - + return createElement( + as, + { + className, + style, + ref, + }, + children, ); }, -) as PolymorphicBox; +); Box.displayName = 'Box'; diff --git a/yarn.lock b/yarn.lock index 6dc8505ea4e..6cdac3355f7 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2402,11 +2402,6 @@ resolved "https://registry.yarnpkg.com/@polka/url/-/url-1.0.0-next.21.tgz#5de5a2385a35309427f6011992b544514d559aa1" integrity sha512-a5Sab1C4/icpTZVzZc5Ghpz88yQtGOyNqYXcZgOssB2uuAr+wF/MvN6bgtW32q7HHrvBki+BsZ0OuNv6EV3K9g== -"@radix-ui/react-polymorphic@^0.0.14": - version "0.0.14" - resolved "https://registry.yarnpkg.com/@radix-ui/react-polymorphic/-/react-polymorphic-0.0.14.tgz#fc6cefee6686db8c5a7ff14c8c1b9b5abdee325b" - integrity sha512-9nsMZEDU3LeIUeHJrpkkhZVxu/9Fc7P2g2I3WR+uA9mTbNC3hGaabi0dV6wg0CfHb+m4nSs1pejbE/5no3MJTA== - "@rollup/plugin-babel@^5.3.1": version "5.3.1" resolved "https://registry.yarnpkg.com/@rollup/plugin-babel/-/plugin-babel-5.3.1.tgz#04bc0608f4aa4b2e4b1aebf284344d0f68fda283" From 030905a3639ba85decd94c2f04b0dc8ed812fe56 Mon Sep 17 00:00:00 2001 From: Kyle Durand Date: Thu, 1 Sep 2022 16:37:09 -0400 Subject: [PATCH 03/25] [Layout foundations] Add `Columns` component (#7057) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### WHY are these changes introduced? Fixes https://github.com/Shopify/polaris/issues/6897
Copy-paste this code in playground/Playground.tsx: ```jsx import React from 'react'; import {Page, Columns, Stack} from '../src'; export function Playground() { return (

Equal columns example

one
two
three
four
five
six

Non equal columns example

one
two
three
four
five
six
 ); } ```
### 🎩 checklist - [ ] Tested on [mobile](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md#cross-browser-testing) - [ ] Tested on [multiple browsers](https://help.shopify.com/en/manual/shopify-admin/supported-browsers) - [ ] Tested for [accessibility](https://github.com/Shopify/polaris/blob/main/documentation/Accessibility%20testing.md) - [ ] Updated the component's `README.md` with documentation changes - [ ] [Tophatted documentation](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting%20documentation.md) changes in the style guide Co-authored-by: Lo Kim --- .changeset/proud-pans-deliver.md | 5 + .../src/components/Columns/Columns.scss | 37 ++++++++ .../components/Columns/Columns.stories.tsx | 95 +++++++++++++++++++ .../src/components/Columns/Columns.tsx | 53 +++++++++++ polaris-react/src/components/Columns/index.ts | 1 + .../components/Columns/tests/Columns.test.tsx | 44 +++++++++ polaris-react/src/index.ts | 3 + polaris-react/src/utilities/css.ts | 10 ++ 8 files changed, 248 insertions(+) create mode 100644 .changeset/proud-pans-deliver.md create mode 100644 polaris-react/src/components/Columns/Columns.scss create mode 100644 polaris-react/src/components/Columns/Columns.stories.tsx create mode 100644 polaris-react/src/components/Columns/Columns.tsx create mode 100644 polaris-react/src/components/Columns/index.ts create mode 100644 polaris-react/src/components/Columns/tests/Columns.test.tsx diff --git a/.changeset/proud-pans-deliver.md b/.changeset/proud-pans-deliver.md new file mode 100644 index 00000000000..5fc619e35ec --- /dev/null +++ b/.changeset/proud-pans-deliver.md @@ -0,0 +1,5 @@ +--- +'@shopify/polaris': minor +--- + +Added `Columns` component diff --git a/polaris-react/src/components/Columns/Columns.scss b/polaris-react/src/components/Columns/Columns.scss new file mode 100644 index 00000000000..25556b65338 --- /dev/null +++ b/polaris-react/src/components/Columns/Columns.scss @@ -0,0 +1,37 @@ +@import '../../styles/common'; + +.Columns { + --pc-columns-xs: 6; + --pc-columns-sm: var(--pc-columns-xs); + --pc-columns-md: var(--pc-columns-sm); + --pc-columns-lg: var(--pc-columns-md); + --pc-columns-xl: var(--pc-columns-lg); + --pc-columns-gap-xs: var(--p-space-4); + --pc-columns-gap-sm: var(--pc-columns-gap-xs); + --pc-columns-gap-md: var(--pc-columns-gap-sm); + --pc-columns-gap-lg: var(--pc-columns-gap-md); + --pc-columns-gap-xl: var(--pc-columns-gap-lg); + display: grid; + gap: var(--pc-columns-gap-xs); + grid-template-columns: var(--pc-columns-xs); + + @media #{$p-breakpoints-sm-up} { + gap: var(--pc-columns-gap-sm); + grid-template-columns: var(--pc-columns-sm); + } + + @media #{$p-breakpoints-md-up} { + gap: var(--pc-columns-gap-md); + grid-template-columns: var(--pc-columns-md); + } + + @media #{$p-breakpoints-lg-up} { + gap: var(--pc-columns-gap-lg); + grid-template-columns: var(--pc-columns-lg); + } + + @media #{$p-breakpoints-xl-up} { + gap: var(--pc-columns-gap-xl); + grid-template-columns: var(--pc-columns-xl); + } +} diff --git a/polaris-react/src/components/Columns/Columns.stories.tsx b/polaris-react/src/components/Columns/Columns.stories.tsx new file mode 100644 index 00000000000..15a126ccc21 --- /dev/null +++ b/polaris-react/src/components/Columns/Columns.stories.tsx @@ -0,0 +1,95 @@ +import React from 'react'; +import type {ComponentMeta} from '@storybook/react'; +import {Button, Columns, Page} from '@shopify/polaris'; +import {ChevronLeftMinor, ChevronRightMinor} from '@shopify/polaris-icons'; + +export default { + component: Columns, +} as ComponentMeta; + +export function BasicColumns() { + return ( + + +
one
+
two
+
three
+
four
+
five
+
six
+ + + ); +} + +export function ColumnsWithTemplateColumns() { + return ( + + +
Column one
+
Column two
+
Column three
+
Column four
+
Column five
+
Column six
+ + + ); +} + +export function ColumnsWithMixedPropTypes() { + return ( + + +
one
+
two
+
three
+
four
+
five
+
six
+ + + ); +} + +export function ColumnsWithVaryingGap() { + return ( + + +
Column one
+
Column two
+
Column three
+ + + ); +} + +export function ColumnsWithFreeAndFixedWidths() { + return ( + + +
Column one
+
+
+
+
+ + + ); +} diff --git a/polaris-react/src/components/Columns/Columns.tsx b/polaris-react/src/components/Columns/Columns.tsx new file mode 100644 index 00000000000..0f1660287a9 --- /dev/null +++ b/polaris-react/src/components/Columns/Columns.tsx @@ -0,0 +1,53 @@ +import React from 'react'; +import type {spacing} from '@shopify/polaris-tokens'; + +import {sanitizeCustomProperties} from '../../utilities/css'; + +import styles from './Columns.scss'; + +type Breakpoints = 'xs' | 'sm' | 'md' | 'lg' | 'xl'; +type SpacingName = keyof typeof spacing; +type SpacingScale = SpacingName extends `space-${infer Scale}` ? Scale : never; + +type Columns = { + [Breakpoint in Breakpoints]?: number | string; +}; + +type Gap = { + [Breakpoint in Breakpoints]?: SpacingScale; +}; + +export interface ColumnsProps { + gap?: Gap; + columns?: Columns; + children?: React.ReactNode; +} + +export function Columns({columns, children, gap}: ColumnsProps) { + const style = { + '--pc-columns-xs': formatColumns(columns?.xs), + '--pc-columns-sm': formatColumns(columns?.sm), + '--pc-columns-md': formatColumns(columns?.md), + '--pc-columns-lg': formatColumns(columns?.lg), + '--pc-columns-xl': formatColumns(columns?.xl), + '--pc-columns-gap-xs': gap?.xs ? `var(--p-space-${gap?.xs})` : undefined, + '--pc-columns-gap-sm': gap?.sm ? `var(--p-space-${gap?.sm})` : undefined, + '--pc-columns-gap-md': gap?.md ? `var(--p-space-${gap?.md})` : undefined, + '--pc-columns-gap-lg': gap?.lg ? `var(--p-space-${gap?.lg})` : undefined, + '--pc-columns-gap-xl': gap?.xl ? `var(--p-space-${gap?.xl})` : undefined, + } as React.CSSProperties; + + return ( +
+ {children} +
+ ); +} + +function formatColumns(columns?: number | string) { + if (!columns) return undefined; + + return typeof columns === 'number' + ? `repeat(${columns}, minmax(0, 1fr))` + : columns; +} diff --git a/polaris-react/src/components/Columns/index.ts b/polaris-react/src/components/Columns/index.ts new file mode 100644 index 00000000000..a8b4f25b413 --- /dev/null +++ b/polaris-react/src/components/Columns/index.ts @@ -0,0 +1 @@ +export * from './Columns'; diff --git a/polaris-react/src/components/Columns/tests/Columns.test.tsx b/polaris-react/src/components/Columns/tests/Columns.test.tsx new file mode 100644 index 00000000000..a80af3de49e --- /dev/null +++ b/polaris-react/src/components/Columns/tests/Columns.test.tsx @@ -0,0 +1,44 @@ +import React from 'react'; +import {mountWithApp} from 'tests/utilities'; + +import {Columns} from '..'; + +describe('Columns', () => { + it('does not render custom properties by default', () => { + const columns = mountWithApp(); + + expect(columns).toContainReactComponent('div', {style: undefined}); + }); + + it('only renders custom properties that match the properties passed in', () => { + const columns = mountWithApp(); + + expect(columns).toContainReactComponent('div', { + style: {'--pc-columns-gap-md': 'var(--p-space-1)'} as React.CSSProperties, + }); + }); + + it('formats string columns', () => { + const columns = mountWithApp( + , + ); + + expect(columns).toContainReactComponent('div', { + style: { + '--pc-columns-xs': '1fr 1fr', + '--pc-columns-lg': '1.5fr 0.5fr', + } as React.CSSProperties, + }); + }); + + it('formats number columns', () => { + const columns = mountWithApp(); + + expect(columns).toContainReactComponent('div', { + style: { + '--pc-columns-xs': 'repeat(1, minmax(0, 1fr))', + '--pc-columns-md': 'repeat(4, minmax(0, 1fr))', + } as React.CSSProperties, + }); + }); +}); diff --git a/polaris-react/src/index.ts b/polaris-react/src/index.ts index 34133fcf8c0..7ac9e6d0e99 100644 --- a/polaris-react/src/index.ts +++ b/polaris-react/src/index.ts @@ -110,6 +110,9 @@ export type {CollapsibleProps} from './components/Collapsible'; export {ColorPicker} from './components/ColorPicker'; export type {ColorPickerProps} from './components/ColorPicker'; +export {Columns} from './components/Columns'; +export type {ColumnsProps} from './components/Columns'; + export {Combobox} from './components/Combobox'; export type {ComboboxProps} from './components/Combobox'; diff --git a/polaris-react/src/utilities/css.ts b/polaris-react/src/utilities/css.ts index c79c9619708..8fcda0d6219 100644 --- a/polaris-react/src/utilities/css.ts +++ b/polaris-react/src/utilities/css.ts @@ -7,3 +7,13 @@ export function classNames(...classes: (string | Falsy)[]) { export function variationName(name: string, value: string) { return `${name}${value.charAt(0).toUpperCase()}${value.slice(1)}`; } + +export function sanitizeCustomProperties( + styles: React.CSSProperties, +): React.CSSProperties | undefined { + const nonNullValues = Object.entries(styles).filter( + ([_, value]) => value != null, + ); + + return nonNullValues.length ? Object.fromEntries(nonNullValues) : undefined; +} From 75ab664feb9476482c88839e83fc571620ea6625 Mon Sep 17 00:00:00 2001 From: Chaz Dean <59836805+chazdean@users.noreply.github.com> Date: Fri, 2 Sep 2022 13:36:14 -0400 Subject: [PATCH 04/25] [Layout foundations] Stack component prototype (#7036) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### WHY are these changes introduced? Fixes #6894 ### WHAT is this pull request doing? Adds a new alpha `Stack` component
Alignment Screen Shot 2022-08-30 at 11 00 25 AM
Spacing Screen Shot 2022-08-30 at 11 01 34 AM
### How to 🎩 🖥 [Local development instructions](https://github.com/Shopify/polaris/blob/main/README.md#local-development) 🗒 [General tophatting guidelines](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md) 📄 [Changelog guidelines](https://github.com/Shopify/polaris/blob/main/.github/CONTRIBUTING.md#changelog)
Copy-paste this code in playground/Playground.tsx: ```jsx import React from 'react'; import {Page, AlphaStack, Badge, Text} from '../src'; export function Playground() { return ( start Processing Fulfilled
center Processing Fulfilled
end Processing Fulfilled
spacing 0 Processing Fulfilled
spacing 4 Processing Fulfilled
spacing 10 Processing Fulfilled ); } ```
### 🎩 checklist - [ ] Tested on [mobile](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md#cross-browser-testing) - [ ] Tested on [multiple browsers](https://help.shopify.com/en/manual/shopify-admin/supported-browsers) - [ ] Tested for [accessibility](https://github.com/Shopify/polaris/blob/main/documentation/Accessibility%20testing.md) - [ ] Updated the component's `README.md` with documentation changes - [ ] [Tophatted documentation](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting%20documentation.md) changes in the style guide Co-authored-by: Lo Kim --- .changeset/poor-kiwis-travel.md | 5 ++ .../AlphaStack/AlphaStack.stories.tsx | 51 +++++++++++++++++++ .../src/components/AlphaStack/AlphaStack.tsx | 42 +++++++++++++++ .../src/components/AlphaStack/Stack.scss | 6 +++ .../src/components/AlphaStack/index.ts | 1 + .../AlphaStack/tests/AlphaStack.test.tsx | 14 +++++ polaris-react/src/index.ts | 3 ++ 7 files changed, 122 insertions(+) create mode 100644 .changeset/poor-kiwis-travel.md create mode 100644 polaris-react/src/components/AlphaStack/AlphaStack.stories.tsx create mode 100644 polaris-react/src/components/AlphaStack/AlphaStack.tsx create mode 100644 polaris-react/src/components/AlphaStack/Stack.scss create mode 100644 polaris-react/src/components/AlphaStack/index.ts create mode 100644 polaris-react/src/components/AlphaStack/tests/AlphaStack.test.tsx diff --git a/.changeset/poor-kiwis-travel.md b/.changeset/poor-kiwis-travel.md new file mode 100644 index 00000000000..69a0f495e00 --- /dev/null +++ b/.changeset/poor-kiwis-travel.md @@ -0,0 +1,5 @@ +--- +'@shopify/polaris': minor +--- + +Added `AlphaStack` component diff --git a/polaris-react/src/components/AlphaStack/AlphaStack.stories.tsx b/polaris-react/src/components/AlphaStack/AlphaStack.stories.tsx new file mode 100644 index 00000000000..8758d651d8a --- /dev/null +++ b/polaris-react/src/components/AlphaStack/AlphaStack.stories.tsx @@ -0,0 +1,51 @@ +import React from 'react'; +import type {ComponentMeta} from '@storybook/react'; +import {Badge, AlphaStack} from '@shopify/polaris'; + +export default { + component: AlphaStack, +} as ComponentMeta; + +export function Default() { + return ( + + Paid + Processing + Fulfilled + Completed + + ); +} + +export function Spacing() { + return ( + + Paid + Processing + Fulfilled + Completed + + ); +} + +export function AlignCenter() { + return ( + + Paid + Processing + Fulfilled + Completed + + ); +} + +export function AlignEnd() { + return ( + + Paid + Processing + Fulfilled + Completed + + ); +} diff --git a/polaris-react/src/components/AlphaStack/AlphaStack.tsx b/polaris-react/src/components/AlphaStack/AlphaStack.tsx new file mode 100644 index 00000000000..7d354a07ae1 --- /dev/null +++ b/polaris-react/src/components/AlphaStack/AlphaStack.tsx @@ -0,0 +1,42 @@ +import React from 'react'; +import type {spacing} from '@shopify/polaris-tokens'; + +import {classNames} from '../../utilities/css'; + +import styles from './Stack.scss'; + +type SpacingTokenGroup = typeof spacing; +type SpacingTokenName = keyof SpacingTokenGroup; + +// TODO: Bring this logic into tokens +type Spacing = SpacingTokenName extends `space-${infer Scale}` ? Scale : never; + +type Align = 'start' | 'end' | 'center'; + +export interface AlphaStackProps { + /** Elements to display inside stack */ + children?: React.ReactNode; + /** Adjust spacing between elements */ + spacing?: Spacing; + /** Adjust vertical alignment of elements */ + align?: Align; +} + +export const AlphaStack = ({ + children, + spacing = '4', + align = 'start', +}: AlphaStackProps) => { + const className = classNames(styles.Stack); + + const style = { + '--pc-stack-align': align, + ...(spacing ? {'--pc-stack-spacing': `var(--p-space-${spacing})`} : {}), + } as React.CSSProperties; + + return ( +
+ {children} +
+ ); +}; diff --git a/polaris-react/src/components/AlphaStack/Stack.scss b/polaris-react/src/components/AlphaStack/Stack.scss new file mode 100644 index 00000000000..9860659b2c7 --- /dev/null +++ b/polaris-react/src/components/AlphaStack/Stack.scss @@ -0,0 +1,6 @@ +.Stack { + display: flex; + flex-direction: column; + align-items: var(--pc-stack-align); + gap: var(--pc-stack-spacing); +} diff --git a/polaris-react/src/components/AlphaStack/index.ts b/polaris-react/src/components/AlphaStack/index.ts new file mode 100644 index 00000000000..832515641aa --- /dev/null +++ b/polaris-react/src/components/AlphaStack/index.ts @@ -0,0 +1 @@ +export * from './AlphaStack'; diff --git a/polaris-react/src/components/AlphaStack/tests/AlphaStack.test.tsx b/polaris-react/src/components/AlphaStack/tests/AlphaStack.test.tsx new file mode 100644 index 00000000000..a90c9dc8592 --- /dev/null +++ b/polaris-react/src/components/AlphaStack/tests/AlphaStack.test.tsx @@ -0,0 +1,14 @@ +import React from 'react'; +import {mountWithApp} from 'tests/utilities'; + +import {AlphaStack} from '../AlphaStack'; + +describe('', () => { + const renderChildren = () => [0, 1].map((i) =>
Child {i}
); + + it('renders its children', () => { + const stack = mountWithApp({renderChildren()}); + + expect(stack).toContainReactComponentTimes('div', 3); + }); +}); diff --git a/polaris-react/src/index.ts b/polaris-react/src/index.ts index 7ac9e6d0e99..6ae7d9924f9 100644 --- a/polaris-react/src/index.ts +++ b/polaris-react/src/index.ts @@ -46,6 +46,9 @@ export type { export {ActionMenu} from './components/ActionMenu'; export type {ActionMenuProps} from './components/ActionMenu'; +export {AlphaStack} from './components/AlphaStack'; +export type {AlphaStackProps} from './components/AlphaStack'; + export {Autocomplete} from './components/Autocomplete'; export type {AutocompleteProps} from './components/Autocomplete'; From bbddeab5bc76112d313ad360259c2011ff20af68 Mon Sep 17 00:00:00 2001 From: Lo Kim Date: Fri, 2 Sep 2022 14:53:33 -0400 Subject: [PATCH 05/25] [Layout foundations] Add tests for `Box` (#7094) --- polaris-react/src/components/Box/Box.tsx | 44 +++++++++-------- .../src/components/Box/tests/Box.test.tsx | 48 +++++++++++++++++++ 2 files changed, 72 insertions(+), 20 deletions(-) create mode 100644 polaris-react/src/components/Box/tests/Box.test.tsx diff --git a/polaris-react/src/components/Box/Box.tsx b/polaris-react/src/components/Box/Box.tsx index 4d1ede91966..f4a022f5c6c 100644 --- a/polaris-react/src/components/Box/Box.tsx +++ b/polaris-react/src/components/Box/Box.tsx @@ -1,7 +1,7 @@ import React, {createElement, forwardRef, ReactNode} from 'react'; import type {colors, depth, shape, spacing} from '@shopify/polaris-tokens'; -import {classNames} from '../../utilities/css'; +import {classNames, sanitizeCustomProperties} from '../../utilities/css'; import styles from './Box.scss'; @@ -186,64 +186,68 @@ export const Box = forwardRef( } as Spacing; const style = { - ...(background ? {'--pc-box-background': `var(--p-${background})`} : {}), + ...(background + ? {'--pc-box-background': `var(--p-${background})`} + : undefined), ...(borders.bottom ? {'--pc-box-border-bottom': `var(--p-border-${borders.bottom})`} - : {}), + : undefined), ...(borders.left ? {'--pc-box-border-left': `var(--p-border-${borders.left})`} - : {}), + : undefined), ...(borders.right ? {'--pc-box-border-right': `var(--p-border-${borders.right})`} - : {}), + : undefined), ...(borders.top ? {'--pc-box-border-top': `var(--p-border-${borders.top})`} - : {}), + : undefined), ...(borderRadiuses.bottomLeft ? { '--pc-box-border-radius-bottom-left': `var(--p-border-radius-${borderRadiuses.bottomLeft})`, } - : {}), + : undefined), ...(borderRadiuses.bottomRight ? { '--pc-box-border-radius-bottom-right': `var(--p-border-radius-${borderRadiuses.bottomRight})`, } - : {}), + : undefined), ...(borderRadiuses.topLeft ? { '--pc-box-border-radius-top-left': `var(--p-border-radius-${borderRadiuses.topLeft})`, } - : {}), + : undefined), ...(borderRadiuses.topRight ? { '--pc-box-border-radius-top-right': `var(--p-border-radius-${borderRadiuses.topRight})`, } - : {}), + : undefined), ...(margins.bottom ? {'--pc-box-margin-bottom': `var(--p-space-${margins.bottom})`} - : {}), + : undefined), ...(margins.left ? {'--pc-box-margin-left': `var(--p-space-${margins.left})`} - : {}), + : undefined), ...(margins.right ? {'--pc-box-margin-right': `var(--p-space-${margins.right})`} - : {}), + : undefined), ...(margins.top ? {'--pc-box-margin-top': `var(--p-space-${margins.top})`} - : {}), + : undefined), ...(paddings.bottom ? {'--pc-box-padding-bottom': `var(--p-space-${paddings.bottom})`} - : {}), + : undefined), ...(paddings.left ? {'--pc-box-padding-left': `var(--p-space-${paddings.left})`} - : {}), + : undefined), ...(paddings.right ? {'--pc-box-padding-right': `var(--p-space-${paddings.right})`} - : {}), + : undefined), ...(paddings.top ? {'--pc-box-padding-top': `var(--p-space-${paddings.top})`} - : {}), - ...(shadow ? {'--pc-box-shadow': `var(--p-shadow-${shadow})`} : {}), + : undefined), + ...(shadow + ? {'--pc-box-shadow': `var(--p-shadow-${shadow})`} + : undefined), } as React.CSSProperties; const className = classNames(styles.Box); @@ -252,7 +256,7 @@ export const Box = forwardRef( as, { className, - style, + style: sanitizeCustomProperties(style), ref, }, children, diff --git a/polaris-react/src/components/Box/tests/Box.test.tsx b/polaris-react/src/components/Box/tests/Box.test.tsx new file mode 100644 index 00000000000..9e274673f8a --- /dev/null +++ b/polaris-react/src/components/Box/tests/Box.test.tsx @@ -0,0 +1,48 @@ +import React from 'react'; +import {mountWithApp} from 'tests/utilities'; + +import {Box} from '..'; + +const text = 'This is a box'; +const children =

{text}

; + +describe('Box', () => { + it('renders children', () => { + const box = mountWithApp({children}); + + expect(box).toContainReactComponent('p', {children: text}); + }); + + it('does not render custom properties by default', () => { + const box = mountWithApp({children}); + + expect(box).toContainReactComponent('div', {style: undefined}); + }); + + it('only renders the custom property that matches the property passed in', () => { + const box = mountWithApp({children}); + + expect(box).toContainReactComponent('div', { + style: { + '--pc-box-margin-left': 'var(--p-space-2)', + } as React.CSSProperties, + }); + }); + + it('renders custom properties combined with any overrides if they are passed in', () => { + const box = mountWithApp( + + {children} + , + ); + + expect(box).toContainReactComponent('div', { + style: { + '--pc-box-margin-bottom': 'var(--p-space-1)', + '--pc-box-margin-left': 'var(--p-space-2)', + '--pc-box-margin-right': 'var(--p-space-1)', + '--pc-box-margin-top': 'var(--p-space-1)', + } as React.CSSProperties, + }); + }); +}); From c23014e98c381fbb69da2fa50809c5f61d784955 Mon Sep 17 00:00:00 2001 From: Lo Kim Date: Tue, 6 Sep 2022 14:47:34 -0400 Subject: [PATCH 06/25] [Layout foundations] Remove `display` from root `Box` styling --- polaris-react/src/components/Box/Box.scss | 1 - 1 file changed, 1 deletion(-) diff --git a/polaris-react/src/components/Box/Box.scss b/polaris-react/src/components/Box/Box.scss index 342b32837f8..102f9c4dedb 100644 --- a/polaris-react/src/components/Box/Box.scss +++ b/polaris-react/src/components/Box/Box.scss @@ -1,5 +1,4 @@ .Box { - display: block; background-color: var(--pc-box-background, initial); box-shadow: var(--pc-box-shadow, initial); /* stylelint-disable declaration-block-no-redundant-longhand-properties */ From 68dfef759c6483d13b44cf2e70d9b2346755d74c Mon Sep 17 00:00:00 2001 From: Chaz Dean <59836805+chazdean@users.noreply.github.com> Date: Wed, 7 Sep 2022 09:43:20 -0400 Subject: [PATCH 07/25] [Layout foundations] Add tests for Stack (#7106) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### WHY are these changes introduced? Resolves #7093 ### WHAT is this pull request doing? Adds test for the `AlphaStack` component ### How to 🎩 🖥 [Local development instructions](https://github.com/Shopify/polaris/blob/main/README.md#local-development) 🗒 [General tophatting guidelines](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md) 📄 [Changelog guidelines](https://github.com/Shopify/polaris/blob/main/.github/CONTRIBUTING.md#changelog)
Copy-paste this code in playground/Playground.tsx: ```jsx import React from 'react'; import {Page} from '../src'; export function Playground() { return ( {/* Add the code you want to test in here */} ); } ```
### 🎩 checklist - [ ] Tested on [mobile](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md#cross-browser-testing) - [ ] Tested on [multiple browsers](https://help.shopify.com/en/manual/shopify-admin/supported-browsers) - [ ] Tested for [accessibility](https://github.com/Shopify/polaris/blob/main/documentation/Accessibility%20testing.md) - [ ] Updated the component's `README.md` with documentation changes - [ ] [Tophatted documentation](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting%20documentation.md) changes in the style guide --- .../src/components/AlphaStack/AlphaStack.tsx | 2 +- .../AlphaStack/tests/AlphaStack.test.tsx | 35 ++++++++++++++++--- 2 files changed, 32 insertions(+), 5 deletions(-) diff --git a/polaris-react/src/components/AlphaStack/AlphaStack.tsx b/polaris-react/src/components/AlphaStack/AlphaStack.tsx index 7d354a07ae1..fcd6e84fd33 100644 --- a/polaris-react/src/components/AlphaStack/AlphaStack.tsx +++ b/polaris-react/src/components/AlphaStack/AlphaStack.tsx @@ -30,7 +30,7 @@ export const AlphaStack = ({ const className = classNames(styles.Stack); const style = { - '--pc-stack-align': align, + '--pc-stack-align': align ? `${align}` : '', ...(spacing ? {'--pc-stack-spacing': `var(--p-space-${spacing})`} : {}), } as React.CSSProperties; diff --git a/polaris-react/src/components/AlphaStack/tests/AlphaStack.test.tsx b/polaris-react/src/components/AlphaStack/tests/AlphaStack.test.tsx index a90c9dc8592..099c64895e6 100644 --- a/polaris-react/src/components/AlphaStack/tests/AlphaStack.test.tsx +++ b/polaris-react/src/components/AlphaStack/tests/AlphaStack.test.tsx @@ -3,12 +3,39 @@ import {mountWithApp} from 'tests/utilities'; import {AlphaStack} from '../AlphaStack'; +const text = 'This is a stack'; +const children =

{text}

; + describe('', () => { - const renderChildren = () => [0, 1].map((i) =>
Child {i}
); + it('renders children', () => { + const stack = mountWithApp({children}); + + expect(stack).toContainReactComponent('p', {children: text}); + }); + + it('renders custom properties by default', () => { + const stack = mountWithApp({children}); + + expect(stack).toContainReactComponent('div', { + style: { + '--pc-stack-align': 'start', + '--pc-stack-spacing': 'var(--p-space-4)', + } as React.CSSProperties, + }); + }); - it('renders its children', () => { - const stack = mountWithApp({renderChildren()}); + it('overrides custom properties if they are passed in', () => { + const stack = mountWithApp( + + {children} + , + ); - expect(stack).toContainReactComponentTimes('div', 3); + expect(stack).toContainReactComponent('div', { + style: { + '--pc-stack-align': 'center', + '--pc-stack-spacing': 'var(--p-space-10)', + } as React.CSSProperties, + }); }); }); From 42268be6b0cb1e30132d2ed642bcf8bce0b9f151 Mon Sep 17 00:00:00 2001 From: aveline Date: Wed, 14 Sep 2022 14:51:15 -0700 Subject: [PATCH 08/25] [Layout foundations] Inline component prototype (#7029) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### WHY are these changes introduced? Fixes https://github.com/Shopify/polaris/issues/6895 ### WHAT is this pull request doing? Introduces the `Inline` component which can be used to manage spacing between inline elements Screen Shot 2022-08-25 at 2 45 31 PM
Playground sample code ``` default Inline One Two Three
alignY center Inline One Two Three
alignY top Inline One Two Three
alignY bottom Inline One Two Three
alignY baseline Inline One Two Three
align start Inline One Two Three
align center Inline One Two Three
align end Inline One Two Three
align center alignY center Inline One Two Three
spacing 0 Inline One Two Three
spacing 05 Inline One Two Three
spacing 4 Inline One Two Three
spacing 10 Inline One Two Three
spacing 32 Inline One Two Three ```
Co-authored-by: Kyle Durand --- .changeset/fresh-dingos-press.md | 5 + .../src/components/Inline/Inline.scss | 7 + .../src/components/Inline/Inline.stories.tsx | 143 ++++++++++++++++++ .../src/components/Inline/Inline.tsx | 59 ++++++++ polaris-react/src/components/Inline/index.ts | 1 + .../components/Inline/tests/Inline.test.tsx | 20 +++ polaris-react/src/index.ts | 3 + 7 files changed, 238 insertions(+) create mode 100644 .changeset/fresh-dingos-press.md create mode 100644 polaris-react/src/components/Inline/Inline.scss create mode 100644 polaris-react/src/components/Inline/Inline.stories.tsx create mode 100644 polaris-react/src/components/Inline/Inline.tsx create mode 100644 polaris-react/src/components/Inline/index.ts create mode 100644 polaris-react/src/components/Inline/tests/Inline.test.tsx diff --git a/.changeset/fresh-dingos-press.md b/.changeset/fresh-dingos-press.md new file mode 100644 index 00000000000..8c8003f5ed4 --- /dev/null +++ b/.changeset/fresh-dingos-press.md @@ -0,0 +1,5 @@ +--- +'@shopify/polaris': minor +--- + +Added alpha `Inline` component diff --git a/polaris-react/src/components/Inline/Inline.scss b/polaris-react/src/components/Inline/Inline.scss new file mode 100644 index 00000000000..08c005a957a --- /dev/null +++ b/polaris-react/src/components/Inline/Inline.scss @@ -0,0 +1,7 @@ +.Inline { + display: flex; + gap: var(--pc-inline-spacing); + flex-wrap: var(--pc-inline-wrap); + align-items: var(--pc-inline-align-y); + justify-content: var(--pc-inline-align); +} diff --git a/polaris-react/src/components/Inline/Inline.stories.tsx b/polaris-react/src/components/Inline/Inline.stories.tsx new file mode 100644 index 00000000000..1dc438533a2 --- /dev/null +++ b/polaris-react/src/components/Inline/Inline.stories.tsx @@ -0,0 +1,143 @@ +import React from 'react'; +import type {ComponentMeta} from '@storybook/react'; +import {Badge, Heading, Icon, Inline} from '@shopify/polaris'; +import {CapitalMajor} from '@shopify/polaris-icons'; + +export default { + component: Inline, +} as ComponentMeta; + +export function Default() { + return ( + + One + Two + Three + + + ); +} + +export function AlignYCenter() { + return ( + + One + Two + Three + + + ); +} + +export function AlignYTop() { + return ( + + One + Two + Three + + + ); +} + +export function AlignYBottom() { + return ( + + One + Two + Three + + + ); +} + +export function AlignYBaseline() { + return ( + + One + Two + Three + + + ); +} + +export function AlignStart() { + return ( + + One + Two + Three + + + ); +} + +export function AlignCenter() { + return ( + + One + Two + Three + + + ); +} + +export function AlignEnd() { + return ( + + One + Two + Three + + + ); +} + +export function AlignCenterAlignYCenter() { + return ( + + One + Two + Three + + + ); +} + +export function NonWrapping() { + return ( + + Paid + Processing + Fulfilled + Completed + + ); +} + +export function Spacing() { + return ( + + Paid + Fulfilled + + ); +} + +export function VerticalCentering() { + return ( + + + Order +
+ #1136 +
+ was paid + + Paid + Fulfilled + + ); +} diff --git a/polaris-react/src/components/Inline/Inline.tsx b/polaris-react/src/components/Inline/Inline.tsx new file mode 100644 index 00000000000..b3e5263374c --- /dev/null +++ b/polaris-react/src/components/Inline/Inline.tsx @@ -0,0 +1,59 @@ +import React from 'react'; +import type {spacing} from '@shopify/polaris-tokens'; + +import {elementChildren} from '../../utilities/components'; + +import styles from './Inline.scss'; + +type SpacingTokenGroup = typeof spacing; +type SpacingTokenName = keyof SpacingTokenGroup; + +// TODO: Bring this logic into tokens +type Spacing = SpacingTokenName extends `space-${infer Scale}` ? Scale : never; + +const AlignY = { + top: 'start', + center: 'center', + bottom: 'end', + baseline: 'baseline', +}; + +type Align = 'start' | 'center' | 'end'; + +export interface InlineProps { + /** Elements to display inside stack */ + children?: React.ReactNode; + /** Wrap stack elements to additional rows as needed on small screens (Defaults to true) */ + wrap?: boolean; + /** Adjust spacing between elements */ + spacing?: Spacing; + /** Adjust vertical alignment of elements */ + alignY?: keyof typeof AlignY; + /** Adjust horizontal alignment of elements */ + align?: Align; +} + +export const Inline = function Inline({ + children, + spacing = '1', + align, + alignY, + wrap, +}: InlineProps) { + const style = { + '--pc-inline-align': align, + '--pc-inline-align-y': alignY, + '--pc-inline-wrap': wrap ? 'wrap' : 'nowrap', + '--pc-inline-spacing': `var(--p-space-${spacing})`, + } as React.CSSProperties; + + const itemMarkup = elementChildren(children).map((child, index) => { + return
{child}
; + }); + + return ( +
+ {itemMarkup} +
+ ); +}; diff --git a/polaris-react/src/components/Inline/index.ts b/polaris-react/src/components/Inline/index.ts new file mode 100644 index 00000000000..098890cac66 --- /dev/null +++ b/polaris-react/src/components/Inline/index.ts @@ -0,0 +1 @@ +export * from './Inline'; diff --git a/polaris-react/src/components/Inline/tests/Inline.test.tsx b/polaris-react/src/components/Inline/tests/Inline.test.tsx new file mode 100644 index 00000000000..287859d33b3 --- /dev/null +++ b/polaris-react/src/components/Inline/tests/Inline.test.tsx @@ -0,0 +1,20 @@ +import React from 'react'; +import {mountWithApp} from 'tests/utilities'; + +import {Inline} from '../Inline'; + +describe('', () => { + const childText = 'Child'; + const renderChildren = () => + [0, 1].map((i) => ( +
+ {childText} {i} +
+ )); + + it('renders its children', () => { + const stack = mountWithApp({renderChildren()}); + + expect(stack).toContainReactText(childText); + }); +}); diff --git a/polaris-react/src/index.ts b/polaris-react/src/index.ts index 6ae7d9924f9..9e4ca0483ec 100644 --- a/polaris-react/src/index.ts +++ b/polaris-react/src/index.ts @@ -205,6 +205,9 @@ export type {IndexTableProps} from './components/IndexTable'; export {Indicator} from './components/Indicator'; export type {IndicatorProps} from './components/Indicator'; +export {Inline} from './components/Inline'; +export type {InlineProps} from './components/Inline'; + export {InlineCode} from './components/InlineCode'; export type {InlineCodeProps} from './components/InlineCode'; From ae7c77b61a218a835bcf6c8ea73515d15dca4db1 Mon Sep 17 00:00:00 2001 From: Chaz Dean <59836805+chazdean@users.noreply.github.com> Date: Thu, 15 Sep 2022 11:44:30 -0400 Subject: [PATCH 09/25] [Layout foundations] Add Tile component (#7092) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### WHY are these changes introduced? Fixes #6898 ### WHAT is this pull request doing? Adds a new alpha `Tile` component
Tile component preview Screen Shot 2022-09-08 at 4 48 11 PM
### How to 🎩 🖥 [Local development instructions](https://github.com/Shopify/polaris/blob/main/README.md#local-development) 🗒 [General tophatting guidelines](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md) 📄 [Changelog guidelines](https://github.com/Shopify/polaris/blob/main/.github/CONTRIBUTING.md#changelog)
Copy-paste this code in playground/Playground.tsx: ```jsx import React from 'react'; import {Page, Tile, Box, Text} from '../src'; export function Playground() { return ( Sales View a summary of your online store’s sales. Sales View a summary of your online store’s sales. Sales View a summary of your online store’s sales. Sales View a summary of your online store’s sales. ); } ```
### 🎩 checklist - [ ] Tested on [mobile](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md#cross-browser-testing) - [ ] Tested on [multiple browsers](https://help.shopify.com/en/manual/shopify-admin/supported-browsers) - [ ] Tested for [accessibility](https://github.com/Shopify/polaris/blob/main/documentation/Accessibility%20testing.md) - [ ] Updated the component's `README.md` with documentation changes - [ ] [Tophatted documentation](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting%20documentation.md) changes in the style guide Co-authored-by: Lo Kim --- polaris-react/src/components/Tile/Tile.scss | 7 +++ .../src/components/Tile/Tile.stories.tsx | 60 +++++++++++++++++++ polaris-react/src/components/Tile/Tile.tsx | 45 ++++++++++++++ polaris-react/src/components/Tile/index.ts | 1 + .../src/components/Tile/tests/Tile.test.tsx | 33 ++++++++++ polaris-react/src/index.ts | 3 + 6 files changed, 149 insertions(+) create mode 100644 polaris-react/src/components/Tile/Tile.scss create mode 100644 polaris-react/src/components/Tile/Tile.stories.tsx create mode 100644 polaris-react/src/components/Tile/Tile.tsx create mode 100644 polaris-react/src/components/Tile/index.ts create mode 100644 polaris-react/src/components/Tile/tests/Tile.test.tsx diff --git a/polaris-react/src/components/Tile/Tile.scss b/polaris-react/src/components/Tile/Tile.scss new file mode 100644 index 00000000000..79834ff3cd6 --- /dev/null +++ b/polaris-react/src/components/Tile/Tile.scss @@ -0,0 +1,7 @@ +@import '../../styles/common'; + +.Tile { + display: grid; + grid-template-columns: var(--pc-tile-column-number); + gap: var(--pc-tile-spacing); +} diff --git a/polaris-react/src/components/Tile/Tile.stories.tsx b/polaris-react/src/components/Tile/Tile.stories.tsx new file mode 100644 index 00000000000..dafd70f235a --- /dev/null +++ b/polaris-react/src/components/Tile/Tile.stories.tsx @@ -0,0 +1,60 @@ +import React from 'react'; +import type {ComponentMeta} from '@storybook/react'; +import {Box, Tile, Text} from '@shopify/polaris'; + +export default { + component: Tile, +} as ComponentMeta; + +const styles = { + background: 'var(--p-surface)', + border: 'var(--p-border-base)', + borderRadius: 'var(--p-border-radius-2)', + padding: 'var(--p-space-4)', +}; + +const children = Array.from(Array(4)).map((ele, index) => ( +
+ + Sales + + + View a summary of your online store’s sales. + +
+)); + +export function Default() { + return ( + + {children} + + ); +} + +export function LargeSpacing() { + return ( + + {children} + + ); +} + +export function ManyColumns() { + const children = Array.from(Array(10)).map((ele, index) => ( +
+ + Sales + + + View a summary of your online store’s sales. + +
+ )); + + return ( + + {children} + + ); +} diff --git a/polaris-react/src/components/Tile/Tile.tsx b/polaris-react/src/components/Tile/Tile.tsx new file mode 100644 index 00000000000..880307c7e57 --- /dev/null +++ b/polaris-react/src/components/Tile/Tile.tsx @@ -0,0 +1,45 @@ +import React from 'react'; +import type {spacing} from '@shopify/polaris-tokens'; + +import styles from './Tile.scss'; + +type SpacingTokenName = keyof typeof spacing; + +// TODO: Bring this logic into tokens +type Spacing = SpacingTokenName extends `space-${infer Scale}` ? Scale : never; + +type Columns = + | '1' + | '2' + | '3' + | '4' + | '5' + | '6' + | '7' + | '8' + | '9' + | '10' + | '11' + | '12'; + +export interface TileProps { + /** Elements to display inside tile */ + children: React.ReactNode; + /** Adjust spacing between elements */ + spacing: Spacing; + /** Adjust number of columns */ + columns: Columns; +} + +export const Tile = ({children, spacing, columns}: TileProps) => { + const style = { + '--pc-tile-column-number': `repeat(${columns}, 1fr)`, + '--pc-tile-spacing': `var(--p-space-${spacing})`, + } as React.CSSProperties; + + return ( +
+ {children} +
+ ); +}; diff --git a/polaris-react/src/components/Tile/index.ts b/polaris-react/src/components/Tile/index.ts new file mode 100644 index 00000000000..90058956177 --- /dev/null +++ b/polaris-react/src/components/Tile/index.ts @@ -0,0 +1 @@ +export * from './Tile'; diff --git a/polaris-react/src/components/Tile/tests/Tile.test.tsx b/polaris-react/src/components/Tile/tests/Tile.test.tsx new file mode 100644 index 00000000000..464c6c9fc67 --- /dev/null +++ b/polaris-react/src/components/Tile/tests/Tile.test.tsx @@ -0,0 +1,33 @@ +import React from 'react'; +import {mountWithApp} from 'tests/utilities'; + +import {Tile} from '../Tile'; + +const Children = () =>

This is a tile

; + +describe('', () => { + it('renders children', () => { + const tile = mountWithApp( + + + , + ); + + expect(tile).toContainReactComponent(Children); + }); + + it('uses custom properties when passed in', () => { + const tile = mountWithApp( + + + , + ); + + expect(tile).toContainReactComponent('div', { + style: { + '--pc-tile-column-number': 'repeat(2, 1fr)', + '--pc-tile-spacing': 'var(--p-space-1)', + } as React.CSSProperties, + }); + }); +}); diff --git a/polaris-react/src/index.ts b/polaris-react/src/index.ts index 9e4ca0483ec..893d2403325 100644 --- a/polaris-react/src/index.ts +++ b/polaris-react/src/index.ts @@ -366,6 +366,9 @@ export type {TextStyleProps} from './components/TextStyle'; export {Thumbnail} from './components/Thumbnail'; export type {ThumbnailProps} from './components/Thumbnail'; +export {Tile} from './components/Tile'; +export type {TileProps} from './components/Tile'; + export {Toast} from './components/Toast'; export type {ToastProps} from './components/Toast'; From 8de2c615e3b2a1f1380a05cc7fcfbd6baa81a533 Mon Sep 17 00:00:00 2001 From: Chaz Dean <59836805+chazdean@users.noreply.github.com> Date: Fri, 23 Sep 2022 08:46:08 -0400 Subject: [PATCH 10/25] [Layout foundations] Add alpha `Bleed` component (#7156) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### WHY are these changes introduced? Fixes #6900 ### WHAT is this pull request doing? Adds a new alpha `Bleed` component ![Screen Shot 2022-09-15 at 3 50 42 PM](https://user-images.githubusercontent.com/59836805/190497846-10f49e73-bb01-4338-9ecc-e4052ff952da.png) ### How to 🎩 🖥 [Local development instructions](https://github.com/Shopify/polaris/blob/main/README.md#local-development) 🗒 [General tophatting guidelines](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md) 📄 [Changelog guidelines](https://github.com/Shopify/polaris/blob/main/.github/CONTRIBUTING.md#changelog)
Copy-paste this code in playground/Playground.tsx: ```jsx import React from 'react'; import {Page, Box, Bleed, Text} from '../src'; const styles = { background: 'var(--p-background-selected)', borderRadius: 'var(--p-border-radius-05)', border: '1px solid var(--p-surface-dark)', padding: 'var(--p-space-4)', height: 'var(--p-space-12)', opacity: 0.7, }; export function Playground() { return (
default

vertical

horizontal

specific direction (top)

all directions
); } ```
### 🎩 checklist - [ ] Tested on [mobile](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md#cross-browser-testing) - [ ] Tested on [multiple browsers](https://help.shopify.com/en/manual/shopify-admin/supported-browsers) - [ ] Tested for [accessibility](https://github.com/Shopify/polaris/blob/main/documentation/Accessibility%20testing.md) - [ ] Updated the component's `README.md` with documentation changes - [ ] [Tophatted documentation](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting%20documentation.md) changes in the style guide --- polaris-react/src/components/Bleed/Bleed.scss | 10 ++ .../src/components/Bleed/Bleed.stories.tsx | 64 +++++++++++++ polaris-react/src/components/Bleed/Bleed.tsx | 95 +++++++++++++++++++ polaris-react/src/components/Bleed/index.ts | 1 + .../src/components/Bleed/tests/Bleed.test.tsx | 59 ++++++++++++ polaris-react/src/index.ts | 3 + 6 files changed, 232 insertions(+) create mode 100644 polaris-react/src/components/Bleed/Bleed.scss create mode 100644 polaris-react/src/components/Bleed/Bleed.stories.tsx create mode 100644 polaris-react/src/components/Bleed/Bleed.tsx create mode 100644 polaris-react/src/components/Bleed/index.ts create mode 100644 polaris-react/src/components/Bleed/tests/Bleed.test.tsx diff --git a/polaris-react/src/components/Bleed/Bleed.scss b/polaris-react/src/components/Bleed/Bleed.scss new file mode 100644 index 00000000000..d46b8317b6b --- /dev/null +++ b/polaris-react/src/components/Bleed/Bleed.scss @@ -0,0 +1,10 @@ +@import '../../styles/common'; + +.Bleed { + /* stylelint-disable declaration-block-no-redundant-longhand-properties */ + margin-bottom: calc(-1 * var(--pc-bleed-margin-bottom)); + margin-left: calc(-1 * var(--pc-bleed-margin-left)); + margin-right: calc(-1 * var(--pc-bleed-margin-right)); + margin-top: calc(-1 * var(--pc-bleed-margin-top)); + /* stylelint-enable declaration-block-no-redundant-longhand-properties */ +} diff --git a/polaris-react/src/components/Bleed/Bleed.stories.tsx b/polaris-react/src/components/Bleed/Bleed.stories.tsx new file mode 100644 index 00000000000..a01edd02630 --- /dev/null +++ b/polaris-react/src/components/Bleed/Bleed.stories.tsx @@ -0,0 +1,64 @@ +import React from 'react'; +import type {ComponentMeta} from '@storybook/react'; +import {Bleed, Box} from '@shopify/polaris'; + +export default { + component: Bleed, +} as ComponentMeta; + +const styles = { + background: 'var(--p-surface-neutral-subdued-dark)', + borderRadius: 'var(--p-border-radius-05)', + padding: 'var(--p-space-4)', + height: 'var(--p-space-12)', +}; + +export function Default() { + return ( + + +
+ + + ); +} + +export function WithVerticalDirection() { + return ( + + +
+ + + ); +} + +export function WithHorizontalDirection() { + return ( + + +
+ + + ); +} + +export function WithSpecificDirection() { + return ( + + +
+ + + ); +} + +export function WithAllDirection() { + return ( + + +
+ + + ); +} diff --git a/polaris-react/src/components/Bleed/Bleed.tsx b/polaris-react/src/components/Bleed/Bleed.tsx new file mode 100644 index 00000000000..4745cca36d4 --- /dev/null +++ b/polaris-react/src/components/Bleed/Bleed.tsx @@ -0,0 +1,95 @@ +import React from 'react'; +import type {spacing} from '@shopify/polaris-tokens'; + +import {sanitizeCustomProperties} from '../../utilities/css'; + +import styles from './Bleed.scss'; + +type SpacingTokenName = keyof typeof spacing; + +// TODO: Bring this logic into tokens +type SpacingTokenScale = SpacingTokenName extends `space-${infer Scale}` + ? Scale + : never; + +interface Spacing { + bottom: SpacingTokenScale; + left: SpacingTokenScale; + right: SpacingTokenScale; + top: SpacingTokenScale; +} + +export interface BleedProps { + /** Elements to display inside tile */ + children: React.ReactNode; + spacing?: SpacingTokenScale; + horizontal?: SpacingTokenScale; + vertical?: SpacingTokenScale; + top?: SpacingTokenScale; + bottom?: SpacingTokenScale; + left?: SpacingTokenScale; + right?: SpacingTokenScale; +} + +export const Bleed = ({ + spacing, + horizontal, + vertical, + top, + bottom, + left, + right, + children, +}: BleedProps) => { + const getNegativeMargins = (direction: string) => { + const xAxis = ['left', 'right']; + const yAxis = ['top', 'bottom']; + + const directionValues: {[key: string]: string | undefined} = { + top, + bottom, + left, + right, + horizontal, + vertical, + }; + + if (directionValues[direction]) { + return directionValues[direction]; + } else if (!yAxis.includes(direction) && horizontal) { + return directionValues.horizontal; + } else if (!xAxis.includes(direction) && vertical) { + return directionValues.vertical; + } else { + return spacing; + } + }; + + const negativeMargins = { + top: getNegativeMargins('top'), + left: getNegativeMargins('left'), + right: getNegativeMargins('right'), + bottom: getNegativeMargins('bottom'), + } as Spacing; + + const style = { + ...(negativeMargins.bottom + ? {'--pc-bleed-margin-bottom': `var(--p-space-${negativeMargins.bottom})`} + : undefined), + ...(negativeMargins.left + ? {'--pc-bleed-margin-left': `var(--p-space-${negativeMargins.left})`} + : undefined), + ...(negativeMargins.right + ? {'--pc-bleed-margin-right': `var(--p-space-${negativeMargins.right})`} + : undefined), + ...(negativeMargins.top + ? {'--pc-bleed-margin-top': `var(--p-space-${negativeMargins.top})`} + : undefined), + } as React.CSSProperties; + + return ( +
+ {children} +
+ ); +}; diff --git a/polaris-react/src/components/Bleed/index.ts b/polaris-react/src/components/Bleed/index.ts new file mode 100644 index 00000000000..58ccfa0647a --- /dev/null +++ b/polaris-react/src/components/Bleed/index.ts @@ -0,0 +1 @@ +export * from './Bleed'; diff --git a/polaris-react/src/components/Bleed/tests/Bleed.test.tsx b/polaris-react/src/components/Bleed/tests/Bleed.test.tsx new file mode 100644 index 00000000000..da2c480b410 --- /dev/null +++ b/polaris-react/src/components/Bleed/tests/Bleed.test.tsx @@ -0,0 +1,59 @@ +import React from 'react'; +import {mountWithApp} from 'tests/utilities'; + +import {Bleed} from '../Bleed'; + +const Children = () =>

This is a tile

; + +describe('', () => { + it('renders children', () => { + const bleed = mountWithApp( + + + , + ); + + expect(bleed).toContainReactComponent(Children); + }); + + it('does not render custom properties by default', () => { + const bleed = mountWithApp( + + + , + ); + + expect(bleed).toContainReactComponent('div', {style: undefined}); + }); + + it('only renders the custom property that matches the property passed in', () => { + const bleed = mountWithApp( + + + , + ); + + expect(bleed).toContainReactComponent('div', { + style: { + '--pc-bleed-margin-left': 'var(--p-space-2)', + } as React.CSSProperties, + }); + }); + + it('renders custom properties combined with any overrides if they are passed in', () => { + const bleed = mountWithApp( + + + , + ); + + expect(bleed).toContainReactComponent('div', { + style: { + '--pc-bleed-margin-bottom': 'var(--p-space-1)', + '--pc-bleed-margin-left': 'var(--p-space-2)', + '--pc-bleed-margin-right': 'var(--p-space-3)', + '--pc-bleed-margin-top': 'var(--p-space-1)', + } as React.CSSProperties, + }); + }); +}); diff --git a/polaris-react/src/index.ts b/polaris-react/src/index.ts index 893d2403325..1ee04bbc1f0 100644 --- a/polaris-react/src/index.ts +++ b/polaris-react/src/index.ts @@ -72,6 +72,9 @@ export type { BannerHandles, } from './components/Banner'; +export {Bleed} from './components/Bleed'; +export type {BleedProps} from './components/Bleed'; + export {Box} from './components/Box'; export type {BoxProps} from './components/Box'; From 066013432c4d4a25276782713d6e85e64e27c30b Mon Sep 17 00:00:00 2001 From: aveline Date: Fri, 23 Sep 2022 10:59:05 -0700 Subject: [PATCH 11/25] [Layout] `AlphaCard` with alternate `Box` css (#7207) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add new `AlphaCard` component #6893 - Refactor `Box` to set defaults Screen Shot 2022-09-16 at 11 40 02 AM
Copy-paste this code in playground/Playground.tsx: ```jsx Existing

View a summary of your online store’s performance.

 Alpha default Online store dashboard

View a summary of your online store’s performance.

 Existing with actions

Add variants if this product comes in multiple versions, like different sizes or colors.

Alpha with actions Variants{' '}

Add variants if this product comes in multiple versions, like different sizes or colors.

Existing with sections

View a summary of your online store’s performance.

View a summary of your online store’s performance, including sales, visitors, top products, and referrals.

Alpha with sections Online store dashboard

View a summary of your online store’s performance.

View a summary of your online store’s performance, including sales, visitors, top products, and referrals.

Existing with all the things View Sales } onClose={() => {}} > You can use sales reports to see information about your customers’ orders based on criteria such as sales over time, by channel, or by staff. { const {sales, amount, url} = item; return ( {sales} {amount} ); }} /> Payouts Total Sales By Channel The sales reports are available only if your store is on the Shopify plan or higher. Alpha with all the things Sales View Sales } onClose={() => {}} > You can use sales reports to see information about your customers’ orders based on criteria such as sales over time, by channel, or by staff. Total Sales Breakdown { const {sales, amount, url} = item; return ( {sales} {amount} ); }} /> Deactivated reports Payouts Total Sales By Channel Note The sales reports are available only if your store is on the Shopify plan or higher. ```
Co-authored-by: Kyle Durand Co-authored-by: Laura Griffee <21976492+lgriffee@users.noreply.github.com> Co-authored-by: Aaron Casanova <32409546+aaronccasanova@users.noreply.github.com> Co-authored-by: Lo Kim --- .changeset/shiny-feet-bake.md | 5 + .../AlphaCard/AlphaCard.stories.tsx | 72 + .../src/components/AlphaCard/AlphaCard.tsx | 63 + .../src/components/AlphaCard/index.ts | 1 + .../AlphaCard/tests/AlphaCard.test.tsx | 72 + polaris-react/src/components/Box/Box.scss | 56 +- polaris-react/src/components/Box/Box.tsx | 8 +- polaris-react/src/index.ts | 3 + .../content/components/alpha-card/index.md | 38 + .../examples/alpha-card-border-radius.tsx | 28 + .../pages/examples/alpha-card-default.tsx | 18 + .../pages/examples/alpha-card-flat.tsx | 18 + .../pages/examples/alpha-card-subdued.tsx | 16 + .../public/images/components/alpha-card.png | Bin 0 -> 10954 bytes polaris.shopify.com/src/data/props.json | 4070 ++++++++++------- 15 files changed, 2810 insertions(+), 1658 deletions(-) create mode 100644 .changeset/shiny-feet-bake.md create mode 100644 polaris-react/src/components/AlphaCard/AlphaCard.stories.tsx create mode 100644 polaris-react/src/components/AlphaCard/AlphaCard.tsx create mode 100644 polaris-react/src/components/AlphaCard/index.ts create mode 100644 polaris-react/src/components/AlphaCard/tests/AlphaCard.test.tsx create mode 100644 polaris.shopify.com/content/components/alpha-card/index.md create mode 100644 polaris.shopify.com/pages/examples/alpha-card-border-radius.tsx create mode 100644 polaris.shopify.com/pages/examples/alpha-card-default.tsx create mode 100644 polaris.shopify.com/pages/examples/alpha-card-flat.tsx create mode 100644 polaris.shopify.com/pages/examples/alpha-card-subdued.tsx create mode 100644 polaris.shopify.com/public/images/components/alpha-card.png diff --git a/.changeset/shiny-feet-bake.md b/.changeset/shiny-feet-bake.md new file mode 100644 index 00000000000..ce72203e95a --- /dev/null +++ b/.changeset/shiny-feet-bake.md @@ -0,0 +1,5 @@ +--- +'@shopify/polaris': minor +--- + +Added `AlphaCard` component diff --git a/polaris-react/src/components/AlphaCard/AlphaCard.stories.tsx b/polaris-react/src/components/AlphaCard/AlphaCard.stories.tsx new file mode 100644 index 00000000000..e9c0533022a --- /dev/null +++ b/polaris-react/src/components/AlphaCard/AlphaCard.stories.tsx @@ -0,0 +1,72 @@ +import React from 'react'; +import type {ComponentMeta} from '@storybook/react'; +import {AlphaCard, AlphaStack, Text} from '@shopify/polaris'; + +export default { + component: AlphaCard, +} as ComponentMeta; + +export function Default() { + return ( + + + + Online store dashboard + +

View a summary of your online store’s performance.

+ + + ); +} + +export function BackgroundSubdued() { + return ( + + + + Online store dashboard + +

View a summary of your online store’s performance.

+ + + ); +} + +export function BorderRadius() { + return ( + + + + Online store dashboard + +

View a summary of your online store’s performance.

+ + + ); +} + +export function BorderRadiusRoundedAbove() { + return ( + + + + Online store dashboard + +

View a summary of your online store’s performance.

+ + + ); +} + +export function Flat() { + return ( + + + + Online store dashboard + +

View a summary of your online store’s performance.

+ + + ); +} diff --git a/polaris-react/src/components/AlphaCard/AlphaCard.tsx b/polaris-react/src/components/AlphaCard/AlphaCard.tsx new file mode 100644 index 00000000000..814feefbb09 --- /dev/null +++ b/polaris-react/src/components/AlphaCard/AlphaCard.tsx @@ -0,0 +1,63 @@ +import React from 'react'; + +import {useBreakpoints} from '../../utilities/breakpoints'; +// These should come from polaris-tokens eventually, see #7164 +import { + BackgroundColorTokenScale, + BorderRadiusTokenScale, + Box, + DepthTokenScale, + SpacingTokenScale, +} from '../Box'; + +type CardElevationTokensScale = Extract< + DepthTokenScale, + 'card' | 'transparent' +>; + +type CardBackgroundColorTokenScale = Extract< + BackgroundColorTokenScale, + 'surface' | `surface-${string}` +>; + +type Breakpoint = 'xs' | 'sm' | 'md' | 'lg' | 'xl'; + +export interface AlphaCardProps { + /** Elements to display inside card */ + children?: React.ReactNode; + backgroundColor?: CardBackgroundColorTokenScale; + borderRadius?: BorderRadiusTokenScale; + elevation?: CardElevationTokensScale; + padding?: SpacingTokenScale; + roundedAbove?: Breakpoint; +} + +const defaultBorderRadius = '2'; + +export const AlphaCard = ({ + children, + backgroundColor = 'surface', + borderRadius: borderRadiusProp = defaultBorderRadius, + elevation = 'card', + padding = '5', + roundedAbove, +}: AlphaCardProps) => { + const breakpoints = useBreakpoints(); + + let borderRadius = !roundedAbove ? borderRadiusProp : null; + + if (roundedAbove && breakpoints[`${roundedAbove}Up`]) { + borderRadius = borderRadiusProp; + } + + return ( + + {children} + + ); +}; diff --git a/polaris-react/src/components/AlphaCard/index.ts b/polaris-react/src/components/AlphaCard/index.ts new file mode 100644 index 00000000000..48ec946eecf --- /dev/null +++ b/polaris-react/src/components/AlphaCard/index.ts @@ -0,0 +1 @@ +export * from './AlphaCard'; diff --git a/polaris-react/src/components/AlphaCard/tests/AlphaCard.test.tsx b/polaris-react/src/components/AlphaCard/tests/AlphaCard.test.tsx new file mode 100644 index 00000000000..b9d5961486a --- /dev/null +++ b/polaris-react/src/components/AlphaCard/tests/AlphaCard.test.tsx @@ -0,0 +1,72 @@ +import React from 'react'; +import {mountWithApp} from 'tests/utilities'; +import {matchMedia} from '@shopify/jest-dom-mocks'; +import { + BreakpointsTokenName, + breakpoints, + getMediaConditions, +} from '@shopify/polaris-tokens'; + +import {AlphaCard} from '..'; + +const mediaConditions = getMediaConditions(breakpoints); + +const heading =

Online store dashboard

; +const subheading =

View a summary of your online store performance

; + +describe('AlphaCard', () => { + beforeEach(() => { + matchMedia.mock(); + }); + + afterEach(() => { + matchMedia.restore(); + }); + + it('renders children', () => { + const alphaCard = mountWithApp( + + {heading} + {subheading} + , + ); + + expect(alphaCard).toContainReactComponentTimes('p', 2); + }); + + it('sets default border radius when roundedAbove breakpoint passed in', () => { + setMediaWidth('breakpoints-sm'); + const alphaCard = mountWithApp( + + {heading} + {subheading} + , + ); + + expect(alphaCard).toContainReactComponent('div', { + style: expect.objectContaining({ + '--pc-box-border-radius-bottom-left': 'var(--p-border-radius-2)', + '--pc-box-border-radius-bottom-right': 'var(--p-border-radius-2)', + '--pc-box-border-radius-top-left': 'var(--p-border-radius-2)', + '--pc-box-border-radius-top-right': 'var(--p-border-radius-2)', + }), + }); + }); +}); + +function setMediaWidth(breakpointsTokenName: BreakpointsTokenName) { + const aliasDirectionConditions = Object.values( + mediaConditions[breakpointsTokenName], + ); + + jest.spyOn(window, 'matchMedia').mockImplementation((query) => ({ + matches: aliasDirectionConditions.includes(query), + media: '', + onchange: null, + addListener: jest.fn(), + removeListener: jest.fn(), + addEventListener: jest.fn(), + removeEventListener: jest.fn(), + dispatchEvent: jest.fn(), + })); +} diff --git a/polaris-react/src/components/Box/Box.scss b/polaris-react/src/components/Box/Box.scss index 102f9c4dedb..56d8ad77a91 100644 --- a/polaris-react/src/components/Box/Box.scss +++ b/polaris-react/src/components/Box/Box.scss @@ -1,22 +1,40 @@ +/* stylelint-disable declaration-block-no-redundant-longhand-properties */ .Box { - background-color: var(--pc-box-background, initial); - box-shadow: var(--pc-box-shadow, initial); - /* stylelint-disable declaration-block-no-redundant-longhand-properties */ - border-bottom-left-radius: var(--pc-box-border-radius-bottom-left, initial); - border-bottom-right-radius: var(--pc-box-border-radius-bottom-right, initial); - border-top-left-radius: var(--pc-box-border-radius-top-left, initial); - border-top-right-radius: var(--pc-box-border-radius-top-right, initial); - border-bottom: var(--pc-box-border-bottom, initial); - border-left: var(--pc-box-border-left, initial); - border-right: var(--pc-box-border-right, initial); - border-top: var(--pc-box-border-top, initial); - margin-bottom: var(--pc-box-margin-bottom, initial); - margin-left: var(--pc-box-margin-left, initial); - margin-right: var(--pc-box-margin-right, initial); - margin-top: var(--pc-box-margin-top, initial); - padding-bottom: var(--pc-box-padding-bottom, initial); - padding-left: var(--pc-box-padding-left, initial); - padding-right: var(--pc-box-padding-right, initial); - padding-top: var(--pc-box-padding-top, initial); + --pc-box-shadow: initial; + --pc-box-background: initial; + --pc-box-border-radius-bottom-left: initial; + --pc-box-border-radius-bottom-right: initial; + --pc-box-border-radius-top-left: initial; + --pc-box-border-radius-top-right: initial; + --pc-box-border-bottom: initial; + --pc-box-border-left: initial; + --pc-box-border-right: initial; + --pc-box-border-top: initial; + --pc-box-margin-bottom: initial; + --pc-box-margin-left: initial; + --pc-box-margin-right: initial; + --pc-box-margin-top: initial; + --pc-box-padding-bottom: initial; + --pc-box-padding-left: initial; + --pc-box-padding-right: initial; + --pc-box-padding-top: initial; + background-color: var(--pc-box-background); + box-shadow: var(--pc-box-shadow); + border-bottom-left-radius: var(--pc-box-border-radius-bottom-left); + border-bottom-right-radius: var(--pc-box-border-radius-bottom-right); + border-top-left-radius: var(--pc-box-border-radius-top-left); + border-top-right-radius: var(--pc-box-border-radius-top-right); + border-bottom: var(--pc-box-border-bottom); + border-left: var(--pc-box-border-left); + border-right: var(--pc-box-border-right); + border-top: var(--pc-box-border-top); + margin-bottom: var(--pc-box-margin-bottom); + margin-left: var(--pc-box-margin-left); + margin-right: var(--pc-box-margin-right); + margin-top: var(--pc-box-margin-top); + padding-bottom: var(--pc-box-padding-bottom); + padding-left: var(--pc-box-padding-left); + padding-right: var(--pc-box-padding-right); + padding-top: var(--pc-box-padding-top); /* stylelint-enable declaration-block-no-redundant-longhand-properties */ } diff --git a/polaris-react/src/components/Box/Box.tsx b/polaris-react/src/components/Box/Box.tsx index f4a022f5c6c..904e301400a 100644 --- a/polaris-react/src/components/Box/Box.tsx +++ b/polaris-react/src/components/Box/Box.tsx @@ -7,7 +7,7 @@ import styles from './Box.scss'; type ColorsTokenGroup = typeof colors; type ColorsTokenName = keyof ColorsTokenGroup; -type BackgroundColorTokenScale = Extract< +export type BackgroundColorTokenScale = Extract< ColorsTokenName, | 'background' | `background-${string}` @@ -21,7 +21,7 @@ type DepthTokenGroup = typeof depth; type DepthTokenName = keyof DepthTokenGroup; type ShadowsTokenName = Exclude; -type DepthTokenScale = ShadowsTokenName extends `shadow-${infer Scale}` +export type DepthTokenScale = ShadowsTokenName extends `shadow-${infer Scale}` ? Scale : never; @@ -44,7 +44,7 @@ interface Border { top: BorderTokenScale; } -type BorderRadiusTokenScale = Extract< +export type BorderRadiusTokenScale = Extract< BorderShapeTokenScale, `radius-${string}` > extends `radius-${infer Scale}` @@ -62,7 +62,7 @@ type SpacingTokenGroup = typeof spacing; type SpacingTokenName = keyof SpacingTokenGroup; // TODO: Bring this logic into tokens -type SpacingTokenScale = SpacingTokenName extends `space-${infer Scale}` +export type SpacingTokenScale = SpacingTokenName extends `space-${infer Scale}` ? Scale : never; diff --git a/polaris-react/src/index.ts b/polaris-react/src/index.ts index 1ee04bbc1f0..2c9dca82e0d 100644 --- a/polaris-react/src/index.ts +++ b/polaris-react/src/index.ts @@ -46,6 +46,9 @@ export type { export {ActionMenu} from './components/ActionMenu'; export type {ActionMenuProps} from './components/ActionMenu'; +export {AlphaCard} from './components/AlphaCard'; +export type {AlphaCardProps} from './components/AlphaCard'; + export {AlphaStack} from './components/AlphaStack'; export type {AlphaStackProps} from './components/AlphaStack'; diff --git a/polaris.shopify.com/content/components/alpha-card/index.md b/polaris.shopify.com/content/components/alpha-card/index.md new file mode 100644 index 00000000000..8d037624da0 --- /dev/null +++ b/polaris.shopify.com/content/components/alpha-card/index.md @@ -0,0 +1,38 @@ +--- +title: Alpha Card +description: Cards are used to group similar concepts and tasks together to make Shopify easier for merchants to scan, read, and get things done. +category: Structure +keywords: + - layout + - container + - box + - grid + - panel + - card with call to action in the footer + - card with call to action in the heading + - card with call to action in a section + - card with button in the footer + - card with button in the heading + - card with multiple sections + - card with subsections + - sectioned card + - card with a subdued section + - subdued card for secondary content + - callout + - call out +status: + value: Alpha + message: This component is in development. There could be breaking changes made to it in a non-major release of Polaris. Please use with caution. +examples: + - fileName: alpha-card-default.tsx + title: Default + - fileName: alpha-card-subdued.tsx + title: With subdued for secondary content + description: Use for content that you want to deprioritize. Subdued cards don’t stand out as much as cards with white backgrounds so don’t use them for information or actions that are critical to merchants. + - fileName: alpha-card-border-radius.tsx + title: Border radius + description: Border radius can be adjusted when cards are nested, or added after a certain breakpoint. + - fileName: alpha-card-flat.tsx + title: Elevation + description: Border radius can be adjusted when cards are nested, or added after a certain breakpoint. +--- diff --git a/polaris.shopify.com/pages/examples/alpha-card-border-radius.tsx b/polaris.shopify.com/pages/examples/alpha-card-border-radius.tsx new file mode 100644 index 00000000000..f8177ad5349 --- /dev/null +++ b/polaris.shopify.com/pages/examples/alpha-card-border-radius.tsx @@ -0,0 +1,28 @@ +import {AlphaCard, Text, AlphaStack} from '@shopify/polaris'; +import React from 'react'; +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function AlphaCardExample() { + return ( + + + + + Online store dashboard + +

View a summary of your online store’s performance.

+ + + + + + Online store dashboard + +

View a summary of your online store’s performance.

+ + + + ); +} + +export default withPolarisExample(AlphaCardExample); diff --git a/polaris.shopify.com/pages/examples/alpha-card-default.tsx b/polaris.shopify.com/pages/examples/alpha-card-default.tsx new file mode 100644 index 00000000000..3bcfc34bf9a --- /dev/null +++ b/polaris.shopify.com/pages/examples/alpha-card-default.tsx @@ -0,0 +1,18 @@ +import {AlphaCard, Text, AlphaStack} from '@shopify/polaris'; +import React from 'react'; +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function AlphaCardExample() { + return ( + + + + Online store dashboard + +

View a summary of your online store’s performance.

+ + + ); +} + +export default withPolarisExample(AlphaCardExample); diff --git a/polaris.shopify.com/pages/examples/alpha-card-flat.tsx b/polaris.shopify.com/pages/examples/alpha-card-flat.tsx new file mode 100644 index 00000000000..187e81b8eba --- /dev/null +++ b/polaris.shopify.com/pages/examples/alpha-card-flat.tsx @@ -0,0 +1,18 @@ +import {AlphaCard, Text, AlphaStack} from '@shopify/polaris'; +import React from 'react'; +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function AlphaCardExample() { + return ( + + + + Online store dashboard + +

View a summary of your online store’s performance.

+ + + ); +} + +export default withPolarisExample(AlphaCardExample); diff --git a/polaris.shopify.com/pages/examples/alpha-card-subdued.tsx b/polaris.shopify.com/pages/examples/alpha-card-subdued.tsx new file mode 100644 index 00000000000..d29384c3292 --- /dev/null +++ b/polaris.shopify.com/pages/examples/alpha-card-subdued.tsx @@ -0,0 +1,16 @@ +import {AlphaCard, Text, AlphaStack} from '@shopify/polaris'; +import React from 'react'; +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function AlphaCardExample() { + return + + + Online store dashboard + +

View a summary of your online store’s performance.

+ +; +} + +export default withPolarisExample(AlphaCardExample); diff --git a/polaris.shopify.com/public/images/components/alpha-card.png b/polaris.shopify.com/public/images/components/alpha-card.png new file mode 100644 index 0000000000000000000000000000000000000000..debfe1a62c16063bf2e2bc561877bbedbecabc06 GIT binary patch literal 10954 zcmYjX4_uYy^?x8VP+OOaIis{If|m&yDmFCDS5qTWhOUJEpf}T^whX2**DT-2Ow@`> zlpN*FHM8&_DAP(-|soky>vgH^5x}uzUMsW&vVZC zUTRBFjzime)Lz%n++)SDse^x;_2=bj@5^y=;{&erZN znf>nQ-jXu;Q1_M*=XP(Yo3yceOVZk^?kyAMb!+K32f7vW75?b>NhP;+Z%MoQqqr0= zv%Y&v-u_P zYD%)IT(-YHdY+Yew6mydjRpUCbyl<886Mr@kA-r@8%;^Sx1Pzrp|s`|D|FbFoL$o` z+*13i+_@p+IL=Q%_h5KPG^zt zaaFQpX?e;ER+&d$%$abpp2?Y0oz+&Tx)-)JB|T>Ks@-27PE_zfLW}<@oBc^Qm)6{B z!NZp>`Qg;Df4vuM@vpYgl5}Hf&FA*l&W_0`*f>O8ofImqski1$!#O9bcrU3stL!n= zFt4FJWu^`AK66SFf3RB@-c*|Su?>eYTXGV#fd6x5N*uVV;QOB;019B}1pul2P zpk!HjN}G+acVEm&_={T7xwbkh5LCSi5mbk*#hwB9DFqMoXz`caui#5z$j|lGaO(hG zuHZhXxM`ZI_$mzWE34waVAE^uiPBsAksℑnk+3&GtmgUdTyMRXksHmTL=HIH$$$ zU9RBm50s}w2kOp>zcnRAY*4R*BRlOiu=YT`dC&^Iva`rst{(7y2FMpxfv69VS1V*> zWqC^Y9EDtjd~bh5k2e;!J7SG=H#~F1UPL=!uvGyK!`b`m%@j33s0#4!D16!K@|2Lh zTKe5sn%JP`aPPzN4Am@@faQg{Jp1jYB;Ug-wFi{X(C7^JZ}B?|Rmr~ab=yQSs(Tn` zI-q8%gP=f;>h6c}=Bme>41o7i@ItRCsiaoH?*aHw4TnHBz^w(4W{I1M6+8g&=d6k& zU?iKJ4T$hah6)-2r*59A%kRN*RV5D>f_s6=Jc0vxHrN-!bkR$7XF5z5v9_3kot>I9 ztZ2rTG^Ut&Q$1E$1IVuxvH-{M?oeYe#lp6vF~!>LU3@modqnG!dp6*YXNi}*^8kNR zZ5n+YFog0B4apyI%+I=0y3tcPVb1G;EJ@c$C-^Jx) z^h8uwubV!&1kBxf{xRDo*S`OLDSp?rOw8SW4|HCnX<2cELjg4$tLMzeInB2!XBZA- zY||KoSzK)z-FqR^8zl$za5HpHEh$kkp|GF(R~ujjhHcS6;z38f^9=Yo9&vuAK}dAsGk2*uGWz&j9$-p zBV}tlZc`JwNFt!Q6@n^Pis?Ko!`iTDe@O7(YqsVa>YwlF}O(D~vPAg#wPc%Yq z?ZCOzyjsL(((9Wfd)z2B+$S3PPzX(Us2nJfVzp6p0t7!tm$)=(mY_^!1eU3wN9m23 z;u$Z*<@>~RdCRff-6_xQkMa3C(eVf>q4DhEPH37<#sgW`a8-tk7s239s>OB*Yjv88P-4;{@G$X^n&QaTN95Fxd+ zNoBL8t&2fuu9c#@h+$&JiIGk*Wz0BHaxo3&rix{D(5GHD&*yazK5reJ6hUhSCrMi6 zVvIEAMcLY$hIC{e^;oQoPpVZ3tD?yesl6Eb&Ril&#+l_(t+JWo<{DAvuQX&pCfNWl z95Yu!Ka=6>zD>Q{NdzyE6t82_n4uCAiL{I(la^CL3v80IoGdD8(oCSiLg&bd=5k4y z_#p3LqRbSJO=VEK^>U&!sEc?k#G+`r?&bL<+sq<~?;~QmgA%a$Xolc1+4%qkxp#@W zJ*lpDw+QV)q0s_*EGqF`DGgqw9HUu`v7e!Bwo1y3WrUdz#C8Me4Remb@A@DyZ zyt72$F)A3-Uj~6SqRkt;pxi8;!~GqXlMliFr6DZCn1!T~w(cz&&uk&OgLw`vkoiaQ z%(RLNSPG5%JyF7 z?lyu4`qI`Vl95a44fA&~hNPJL5>Yh8LenTHPZFg}if$h!ifI;IB*)Al5h^+6J|wF5 zCb~D6TiYceqUX{bBt#I~a-{3!NCk3>7mHyUMT7e#9-4SRxFAFj8>RHNH;iX;XNr9v zrA@=52-(a_&a}&=pgGnq)mw7R^cTAe%4I}}ur)KDbo05a-6l_Vu4G!7w^@w53|T&% zXDX3n2hu61m*^;rh$Hv5+eTfoB{=IOQF_pMW&|x001X5$3nP*#cTyV@#hokQ2dGOO z%ex8pBDi0iCya>0`eWP`1W%R=q(sP!djxzYyFiCcyK%3kig_$cCL}%ER5k{tOemy# z#f-vzcn+5v0``|nz&o3cS;%ZR(VOL2LLfSvx^O^)r5IE$2Q;H2nm1Wc9^~nwnLM5O zj0$i-!%7*^IH19TcM!5uAj1O)d9mnT!EAQV6v*TBwRfgKo@DApIeegU5i)m=z?2b& z0~$`r43+^6UScdqB!11;G-NJYIpav7Atog&fe81*W|un2IuSva8K#$!y$fQA}Hb(e~N!^~y3Qo#2zkT{?L{3Pwp z0S!vCuO-b06loempc(NjO(O?1nB)U4Uv}cuiLZA*{fqUoG?!Oa_!3zv-DCT{m$T*4 zQg&pUfNQo*lk-cqxkF@kghk(*Cnu6@i-H@1P|3DRsT)SJZ9j`KnnoU}QzA*T?P7tH zY;#)#QnJmvL?DkaPNJ%uFe2i1_emVX<-mp5?1@u{BxOtkugx;H#KzpjYqOu8Bb&>m z{23psMTuM*W&=GS^-K$zBSqJ=IY7ylSTm1N-C7Y87z{yL&$OUrir3vvf@g~6B^*nA zlGWx}MzYj1EohFW$tI3Z$&%G3hqq9onzx83e^rz6LJ0ZAjGLL({n@h`^BhmqQ?3%T zM4n}<8BZMth>q@hMl5JXEElHHT_%viG&+ODq#@FRWc9J8aupON&4_1V8c8$aS(wK2 z#nz^YqQL4S!pxTx1)33$!ZecA$Fnev(K7_HodE$>pOF2@lz`Poj+!@MY_j@zbVuW` zp(|7yQV(GDxx9fHyhf#Vz&7r?Drqb-wS>bRQjZ=6t50RN;H+fz@fbK0C}8!e`(bu9 z�iq5JXlVuj{B6Sbgep3`cUo>f_NF0C3+E0=|iP4OXAvqX-UGACFWp1zr!G#*v><22I075+|I z<06IsBODwl5QBLYfXvm<%VXEnTerTA9?P3Je|pC^-|Q0^d8`OBrx}^loEu)wuIlYq z9Sd>nY}LibbtF>o*#MbgX~>Mz4{|a!NZK&OxUH(nxj1PZzDU68z(}0PuU@|jHgyse zoJo_cwku&?PY|!0XJM}Zm`&_-SS*s{7BFSZ&IFY|6X*9PDattzlt*dcx1&*Xg0j;bdtK~rTR zJ}Z|DXee|@0#7THX@wz6H1ORrpchGnGUW9g%}qmIKU*r45new_b#Fsj2ga$6e?h=J zB^An$*LN4HF68y=q&GEgI>2YB1<30=6?#(g`pMEL8{zezRPaqOOhCpzW60|_sDFjm z->4x#Uf=yh1#O0FLNd+Za!516Um-Qf>u=L|6<)tw!K10z`Kj(?wuL$N<3nD*Qd%7& zyncZeD|0g-g%7dW_7hb=c>NZIB(LvI(<4bQe$`} z9Z5Qr!7&)ibSTrYOouWZ%U0@gr!SVvP^M#<4rMx)X%UkuW{a3qF&)ZuER&%Osf4l2 z7BQ(}TEq;im=0w+mg!KYW0@8)sbaQ>8CEeJ%D|2w)MO|_`rsDwWGK_IEDv8H(!8WT zWGI6fIhN^A#<5I?G9Am>WrV{ZjfS+{?rcUhROlUKevNEPR|lB?z%fF50P#ks-dla@ zRY3uAeE3AiRwYJ_I-n9?DMmcH**UQtC_CU5R?nsK*@b%%=T&)+InUflHUr;3-uv{f%FYsB8 zh$*sX`l>d~vAPG&u1YMlf)3+$_?gvZduvKyfa+3*Y3V7w1kA0zpxb4^@fQ?6t(9gI ziseMB;vE3bR>OqxRY|fmwWw!E<&Ad97f|sQYsYo1DWT>)>&Ne0eDb*FsL4euLTaCC zAH;!uhc?KFflIbAmTSWA+gu~R?`~8)^83z66;Bc*itl}hLlUHtY$`tF_Y176$?u=9 zwOUA!YAcug{vRwP_9tuMt(n*YvlKB!zlc|%{B7-v0Nj+Z*z_OzHJx{`Tba~k>9tu zMt(n*YvlKB!zlcIja~=j_ie+7)-W|_8%9HZ-!_cG@AtIc4HWYWPoA0let57tz>H4| zhP81s=AqiOcJ0`Wds|16F#1@|hEW)OJhNdWqt6c-MmNnmqcK?QC0KYgj3F}m{GeeJ zMjwxC7-P8>MtsL|jSZvCH8zaG=yNL?#xffk?pLiT!sz35Xkb;1&=`0|!zheCm!o0K z)&|fxxgAN`X-dN=j6Rp3VH8Fmk7yWc{8snFgNlXG$7>f2qcHk-M#DIPj6OeT7z?%d z8V6({8GU}xFbbp3=TWt3!sz1>4P#A-1>YMi_Q@Cs@H>{LP1RCqLSQ9-sRhK8tu5G9 z(%mwFE6FMrUZ1dN8@IK@zK7w9#e<4%>nH@jZ5@T+x2>ZP{I+!@!CzxrM-u$Iv~`5@ zu57feBl?d)#kO@6g5S1|Lh#$xQ3!t9ItsyWTSpT7HMVs;edy!I59a$OC-@FWPo1$a zzcAoixohB_*&olSpK?LEnVA|~_qCcWG^%RD@Y#~|rrH-wKW1MCt2U(C*Z2xMy-Q!? zFGe;L*w-6UgDdRnz|g7<{bR4wf-7RHdsl5R_BE&yzZHq$En`sZbz0E>m15%$Mlw?D z>t}tz8oN52UX_s@d+iU_#8!`~%JA9OV|>9xD>9r`HD_?_wLf@q?Dfd1Ik8i2OAGe1 zAntEFTIcT2?C5&DV0i8G?9*|j4k?}*)!UWRT~B*V_dl(*35zufqg5TPDRwJ*$*(f4 z&_xdxRMlCS#=*s7+oat`2KjMjIZ9CHX{DI{FC_Vz5TisJp04=>f*A}A zzmy+)ZLW;J?YiOCMr%QH_qu*T>j?L{WpBp9COZDL?&Ztht9sQMzo6r)_|^ySjGx}@ z8Phio^Wwl2Y1R>5_HW}V=DoW<4%6^SX&mOJldIy(d)*#iQufc^yfW)94H0+Vu-UK0 qT$K0WXA5HLlzq}+gKP8gUXKqPdDGP&Y&(~6cg5u5Nlg<&HU9%9bH9H8 literal 0 HcmV?d00001 diff --git a/polaris.shopify.com/src/data/props.json b/polaris.shopify.com/src/data/props.json index 84d967a728b..69d62e960f3 100644 --- a/polaris.shopify.com/src/data/props.json +++ b/polaris.shopify.com/src/data/props.json @@ -3732,30 +3732,6 @@ "value": "export interface TabDescriptor {\n /** A unique identifier for the tab */\n id: string;\n /** A destination to link to */\n url?: string;\n /** Content for the tab */\n content: React.ReactNode;\n /** A unique identifier for the panel */\n panelID?: string;\n /** Visually hidden text for screen readers */\n accessibilityLabel?: string;\n}" } }, - "FeaturesConfig": { - "polaris-react/src/utilities/features/types.ts": { - "filePath": "polaris-react/src/utilities/features/types.ts", - "name": "FeaturesConfig", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/utilities/features/types.ts", - "name": "[key: string]", - "value": "boolean" - } - ], - "value": "export interface FeaturesConfig {\n [key: string]: boolean;\n}" - } - }, - "Features": { - "polaris-react/src/utilities/features/types.ts": { - "filePath": "polaris-react/src/utilities/features/types.ts", - "name": "Features", - "description": "", - "members": [], - "value": "export interface Features {}" - } - }, "MappedActionContextType": { "polaris-react/src/utilities/autocomplete/context.ts": { "filePath": "polaris-react/src/utilities/autocomplete/context.ts", @@ -3806,6 +3782,30 @@ "value": "interface MappedActionContextType {\n role?: string;\n url?: string;\n external?: boolean;\n onAction?(): void;\n destructive?: boolean;\n}" } }, + "FeaturesConfig": { + "polaris-react/src/utilities/features/types.ts": { + "filePath": "polaris-react/src/utilities/features/types.ts", + "name": "FeaturesConfig", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/utilities/features/types.ts", + "name": "[key: string]", + "value": "boolean" + } + ], + "value": "export interface FeaturesConfig {\n [key: string]: boolean;\n}" + } + }, + "Features": { + "polaris-react/src/utilities/features/types.ts": { + "filePath": "polaris-react/src/utilities/features/types.ts", + "name": "Features", + "description": "", + "members": [], + "value": "export interface Features {}" + } + }, "IdGenerator": { "polaris-react/src/utilities/unique-id/unique-id-factory.ts": { "filePath": "polaris-react/src/utilities/unique-id/unique-id-factory.ts", @@ -7662,56 +7662,6 @@ "value": "export interface AccountConnectionProps {\n /** Content to display as title */\n title?: React.ReactNode;\n /** Content to display as additional details */\n details?: React.ReactNode;\n /** Content to display as terms of service */\n termsOfService?: React.ReactNode;\n /** The name of the service */\n accountName?: string;\n /** URL for the user’s avatar image */\n avatarUrl?: string;\n /** Set if the account is connected */\n connected?: boolean;\n /** Action for account connection */\n action?: Action;\n}" } }, - "ActionMenuProps": { - "polaris-react/src/components/ActionMenu/ActionMenu.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "name": "ActionMenuProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "actions", - "value": "MenuActionDescriptor[]", - "description": "Collection of page-level secondary actions", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "groups", - "value": "MenuGroupDescriptor[]", - "description": "Collection of page-level action groups", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "rollup", - "value": "boolean", - "description": "Roll up all actions into a Popover > ActionList", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "rollupActionsLabel", - "value": "string", - "description": "Label for rolled up actions activator", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "MethodSignature", - "name": "onActionRollup", - "value": "(hasRolledUp: boolean) => void", - "description": "Callback that returns true when secondary actions are rolled up into action groups, and false when not", - "isOptional": true - } - ], - "value": "export interface ActionMenuProps {\n /** Collection of page-level secondary actions */\n actions?: MenuActionDescriptor[];\n /** Collection of page-level action groups */\n groups?: MenuGroupDescriptor[];\n /** Roll up all actions into a Popover > ActionList */\n rollup?: boolean;\n /** Label for rolled up actions activator */\n rollupActionsLabel?: string;\n /** Callback that returns true when secondary actions are rolled up into action groups, and false when not */\n onActionRollup?(hasRolledUp: boolean): void;\n}" - } - }, "ActionListProps": { "polaris-react/src/components/ActionList/ActionList.tsx": { "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", @@ -7763,6 +7713,91 @@ "description": "" } }, + "CardElevationTokensScale": { + "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "CardElevationTokensScale", + "value": "Extract<\n DepthTokenScale,\n 'card' | 'transparent'\n>", + "description": "" + } + }, + "CardBackgroundColorTokenScale": { + "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "CardBackgroundColorTokenScale", + "value": "Extract<\n BackgroundColorTokenScale,\n 'surface' | `surface-${string}`\n>", + "description": "" + } + }, + "Breakpoint": { + "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Breakpoint", + "value": "'xs' | 'sm' | 'md' | 'lg' | 'xl'", + "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": "backgroundColor", + "value": "CardBackgroundColorTokenScale", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "\"base\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"large\" | \"half\"", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "elevation", + "value": "CardElevationTokensScale", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "roundedAbove", + "value": "Breakpoint", + "description": "", + "isOptional": true + } + ], + "value": "export interface AlphaCardProps {\n /** Elements to display inside card */\n children?: React.ReactNode;\n backgroundColor?: CardBackgroundColorTokenScale;\n borderRadius?: BorderRadiusTokenScale;\n elevation?: CardElevationTokensScale;\n padding?: SpacingTokenScale;\n roundedAbove?: Breakpoint;\n}" + } + }, "Props": { "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx": { "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", @@ -8039,73 +8074,306 @@ "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}" } }, - "State": { - "polaris-react/src/components/AppProvider/AppProvider.tsx": { - "filePath": "polaris-react/src/components/AppProvider/AppProvider.tsx", - "name": "State", + "ActionMenuProps": { + "polaris-react/src/components/ActionMenu/ActionMenu.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "name": "ActionMenuProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/AppProvider/AppProvider.tsx", + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", "syntaxKind": "PropertySignature", - "name": "intl", - "value": "I18n", - "description": "" + "name": "actions", + "value": "MenuActionDescriptor[]", + "description": "Collection of page-level secondary actions", + "isOptional": true }, { - "filePath": "polaris-react/src/components/AppProvider/AppProvider.tsx", + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", "syntaxKind": "PropertySignature", - "name": "link", - "value": "LinkLikeComponent", - "description": "" + "name": "groups", + "value": "MenuGroupDescriptor[]", + "description": "Collection of page-level action groups", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "rollup", + "value": "boolean", + "description": "Roll up all actions into a Popover > ActionList", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "rollupActionsLabel", + "value": "string", + "description": "Label for rolled up actions activator", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "MethodSignature", + "name": "onActionRollup", + "value": "(hasRolledUp: boolean) => void", + "description": "Callback that returns true when secondary actions are rolled up into action groups, and false when not", + "isOptional": true } ], - "value": "interface State {\n intl: I18n;\n link: LinkLikeComponent | undefined;\n}" + "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}" + } + }, + "SpacingTokenGroup": { + "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { + "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "SpacingTokenGroup", + "value": "typeof spacing", + "description": "" }, - "polaris-react/src/components/BulkActions/BulkActions.tsx": { - "filePath": "polaris-react/src/components/BulkActions/BulkActions.tsx", - "name": "State", + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "SpacingTokenGroup", + "value": "typeof spacing", + "description": "" + }, + "polaris-react/src/components/Inline/Inline.tsx": { + "filePath": "polaris-react/src/components/Inline/Inline.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "SpacingTokenGroup", + "value": "typeof spacing", + "description": "" + } + }, + "SpacingTokenName": { + "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { + "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "SpacingTokenName", + "value": "keyof SpacingTokenGroup", + "description": "" + }, + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "SpacingTokenName", + "value": "keyof SpacingTokenGroup", + "description": "" + }, + "polaris-react/src/components/Inline/Inline.tsx": { + "filePath": "polaris-react/src/components/Inline/Inline.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "SpacingTokenName", + "value": "keyof SpacingTokenGroup", + "description": "" + }, + "polaris-react/src/components/Tile/Tile.tsx": { + "filePath": "polaris-react/src/components/Tile/Tile.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "SpacingTokenName", + "value": "keyof typeof spacing", + "description": "" + } + }, + "Spacing": { + "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { + "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Spacing", + "value": "SpacingTokenName extends `space-${infer Scale}` ? Scale : never", + "description": "" + }, + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "name": "Spacing", "description": "", "members": [ { - "filePath": "polaris-react/src/components/BulkActions/BulkActions.tsx", + "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "PropertySignature", - "name": "smallScreenPopoverVisible", - "value": "boolean", + "name": "bottom", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", "description": "" }, { - "filePath": "polaris-react/src/components/BulkActions/BulkActions.tsx", + "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "PropertySignature", - "name": "largeScreenPopoverVisible", - "value": "boolean", + "name": "left", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", "description": "" }, { - "filePath": "polaris-react/src/components/BulkActions/BulkActions.tsx", + "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "PropertySignature", - "name": "containerWidth", - "value": "number", + "name": "right", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", "description": "" }, { - "filePath": "polaris-react/src/components/BulkActions/BulkActions.tsx", + "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "PropertySignature", - "name": "measuring", - "value": "boolean", + "name": "top", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", "description": "" } ], - "value": "interface State {\n smallScreenPopoverVisible: boolean;\n largeScreenPopoverVisible: boolean;\n containerWidth: number;\n measuring: boolean;\n}" + "value": "interface Spacing {\n bottom: SpacingTokenScale;\n left: SpacingTokenScale;\n right: SpacingTokenScale;\n top: SpacingTokenScale;\n}" }, - "polaris-react/src/components/ColorPicker/ColorPicker.tsx": { - "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", - "name": "State", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", - "syntaxKind": "PropertySignature", + "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Spacing", + "value": "'extraTight' | 'tight' | 'loose'", + "description": "" + }, + "polaris-react/src/components/Inline/Inline.tsx": { + "filePath": "polaris-react/src/components/Inline/Inline.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Spacing", + "value": "SpacingTokenName extends `space-${infer Scale}` ? Scale : never", + "description": "" + }, + "polaris-react/src/components/Stack/Stack.tsx": { + "filePath": "polaris-react/src/components/Stack/Stack.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Spacing", + "value": "'extraTight' | 'tight' | 'baseTight' | 'loose' | 'extraLoose' | 'none'", + "description": "" + }, + "polaris-react/src/components/TextContainer/TextContainer.tsx": { + "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Spacing", + "value": "'tight' | 'loose'", + "description": "" + }, + "polaris-react/src/components/Tile/Tile.tsx": { + "filePath": "polaris-react/src/components/Tile/Tile.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Spacing", + "value": "SpacingTokenName extends `space-${infer Scale}` ? Scale : never", + "description": "" + } + }, + "Align": { + "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { + "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Align", + "value": "'start' | 'end' | 'center'", + "description": "" + }, + "polaris-react/src/components/Inline/Inline.tsx": { + "filePath": "polaris-react/src/components/Inline/Inline.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Align", + "value": "'start' | 'center' | 'end'", + "description": "" + } + }, + "AlphaStackProps": { + "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { + "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", + "name": "AlphaStackProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Elements to display inside stack", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", + "syntaxKind": "PropertySignature", + "name": "spacing", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Adjust spacing between elements", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", + "syntaxKind": "PropertySignature", + "name": "align", + "value": "Align", + "description": "Adjust vertical alignment of elements", + "isOptional": true + } + ], + "value": "export interface AlphaStackProps {\n /** Elements to display inside stack */\n children?: React.ReactNode;\n /** Adjust spacing between elements */\n spacing?: Spacing;\n /** Adjust vertical alignment of elements */\n align?: Align;\n}" + } + }, + "State": { + "polaris-react/src/components/AppProvider/AppProvider.tsx": { + "filePath": "polaris-react/src/components/AppProvider/AppProvider.tsx", + "name": "State", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/AppProvider/AppProvider.tsx", + "syntaxKind": "PropertySignature", + "name": "intl", + "value": "I18n", + "description": "" + }, + { + "filePath": "polaris-react/src/components/AppProvider/AppProvider.tsx", + "syntaxKind": "PropertySignature", + "name": "link", + "value": "LinkLikeComponent", + "description": "" + } + ], + "value": "interface State {\n intl: I18n;\n link: LinkLikeComponent | undefined;\n}" + }, + "polaris-react/src/components/BulkActions/BulkActions.tsx": { + "filePath": "polaris-react/src/components/BulkActions/BulkActions.tsx", + "name": "State", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/BulkActions/BulkActions.tsx", + "syntaxKind": "PropertySignature", + "name": "smallScreenPopoverVisible", + "value": "boolean", + "description": "" + }, + { + "filePath": "polaris-react/src/components/BulkActions/BulkActions.tsx", + "syntaxKind": "PropertySignature", + "name": "largeScreenPopoverVisible", + "value": "boolean", + "description": "" + }, + { + "filePath": "polaris-react/src/components/BulkActions/BulkActions.tsx", + "syntaxKind": "PropertySignature", + "name": "containerWidth", + "value": "number", + "description": "" + }, + { + "filePath": "polaris-react/src/components/BulkActions/BulkActions.tsx", + "syntaxKind": "PropertySignature", + "name": "measuring", + "value": "boolean", + "description": "" + } + ], + "value": "interface State {\n smallScreenPopoverVisible: boolean;\n largeScreenPopoverVisible: boolean;\n containerWidth: number;\n measuring: boolean;\n}" + }, + "polaris-react/src/components/ColorPicker/ColorPicker.tsx": { + "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", + "name": "State", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", + "syntaxKind": "PropertySignature", "name": "pickerSize", "value": "{ width: number; height: number; }", "description": "" @@ -8422,20 +8690,20 @@ ], "value": "interface State {\n disclosureWidth: number;\n tabWidths: number[];\n visibleTabs: number[];\n hiddenTabs: number[];\n containerWidth: number;\n showDisclosure: boolean;\n tabToFocus: number;\n}" }, - "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx": { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", + "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx": { + "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", "name": "State", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", "syntaxKind": "PropertySignature", "name": "sliderHeight", "value": "number", "description": "" }, { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", "syntaxKind": "PropertySignature", "name": "draggerHeight", "value": "number", @@ -8444,20 +8712,20 @@ ], "value": "interface State {\n sliderHeight: number;\n draggerHeight: number;\n}" }, - "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx": { - "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", + "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx": { + "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", "name": "State", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", "syntaxKind": "PropertySignature", "name": "sliderHeight", "value": "number", "description": "" }, { - "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", "syntaxKind": "PropertySignature", "name": "draggerHeight", "value": "number", @@ -9501,87 +9769,481 @@ "value": "export interface BannerHandles {\n focus(): void;\n}" } }, - "BreadcrumbsProps": { - "polaris-react/src/components/Breadcrumbs/Breadcrumbs.tsx": { - "filePath": "polaris-react/src/components/Breadcrumbs/Breadcrumbs.tsx", - "name": "BreadcrumbsProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Breadcrumbs/Breadcrumbs.tsx", - "syntaxKind": "PropertySignature", - "name": "breadcrumbs", - "value": "(LinkAction | CallbackAction)[]", - "description": "Collection of breadcrumbs" - } - ], - "value": "export interface BreadcrumbsProps {\n /** Collection of breadcrumbs */\n breadcrumbs: (CallbackAction | LinkAction)[];\n}" + "ColorsTokenGroup": { + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ColorsTokenGroup", + "value": "typeof colors", + "description": "" } }, - "BulkAction": { - "polaris-react/src/components/BulkActions/BulkActions.tsx": { - "filePath": "polaris-react/src/components/BulkActions/BulkActions.tsx", + "ColorsTokenName": { + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "BulkAction", - "value": "DisableableAction & BadgeAction", + "name": "ColorsTokenName", + "value": "keyof ColorsTokenGroup", "description": "" } }, - "BulkActionListSection": { - "polaris-react/src/components/BulkActions/BulkActions.tsx": { - "filePath": "polaris-react/src/components/BulkActions/BulkActions.tsx", + "BackgroundColorTokenScale": { + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "BulkActionListSection", - "value": "ActionListSection", + "name": "BackgroundColorTokenScale", + "value": "Extract<\n ColorsTokenName,\n | 'background'\n | `background-${string}`\n | 'surface'\n | `surface-${string}`\n | 'backdrop'\n | 'overlay'\n>", "description": "" } }, - "TransitionStatus": { - "polaris-react/src/components/BulkActions/BulkActions.tsx": { - "filePath": "polaris-react/src/components/BulkActions/BulkActions.tsx", + "DepthTokenGroup": { + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "TransitionStatus", - "value": "'entering' | 'entered' | 'exiting' | 'exited'", + "name": "DepthTokenGroup", + "value": "typeof depth", "description": "" - }, - "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx": { - "filePath": "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx", - "syntaxKind": "EnumDeclaration", - "name": "TransitionStatus", - "value": "enum TransitionStatus {\n Entering = 'entering',\n Entered = 'entered',\n Exiting = 'exiting',\n Exited = 'exited',\n}", + } + }, + "DepthTokenName": { + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "DepthTokenName", + "value": "keyof DepthTokenGroup", + "description": "" + } + }, + "ShadowsTokenName": { + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ShadowsTokenName", + "value": "Exclude", + "description": "" + } + }, + "DepthTokenScale": { + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "DepthTokenScale", + "value": "ShadowsTokenName extends `shadow-${infer Scale}`\n ? Scale\n : never", + "description": "" + } + }, + "ShapeTokenGroup": { + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ShapeTokenGroup", + "value": "typeof shape", + "description": "" + } + }, + "ShapeTokenName": { + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ShapeTokenName", + "value": "keyof ShapeTokenGroup", + "description": "" + } + }, + "BorderShapeTokenScale": { + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "BorderShapeTokenScale", + "value": "ShapeTokenName extends `border-${infer Scale}`\n ? Scale\n : never", + "description": "" + } + }, + "BorderTokenScale": { + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "BorderTokenScale", + "value": "Exclude<\n BorderShapeTokenScale,\n `radius-${string}` | `width-${string}`\n>", + "description": "" + } + }, + "Border": { + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "name": "Border", + "description": "", "members": [ { - "filePath": "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx", - "name": "Entering", - "value": "entering" + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "bottom", + "value": "BorderTokenScale", + "description": "" }, { - "filePath": "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx", - "name": "Entered", - "value": "entered" + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "left", + "value": "BorderTokenScale", + "description": "" }, { - "filePath": "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx", - "name": "Exiting", - "value": "exiting" + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "right", + "value": "BorderTokenScale", + "description": "" }, { - "filePath": "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx", - "name": "Exited", - "value": "exited" + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "top", + "value": "BorderTokenScale", + "description": "" } - ] - }, - "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx": { - "filePath": "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx", - "syntaxKind": "EnumDeclaration", - "name": "TransitionStatus", - "value": "enum TransitionStatus {\n Entering = 'entering',\n Entered = 'entered',\n Exiting = 'exiting',\n Exited = 'exited',\n}", + ], + "value": "interface Border {\n bottom: BorderTokenScale;\n left: BorderTokenScale;\n right: BorderTokenScale;\n top: BorderTokenScale;\n}" + } + }, + "BorderRadiusTokenScale": { + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "BorderRadiusTokenScale", + "value": "Extract<\n BorderShapeTokenScale,\n `radius-${string}`\n> extends `radius-${infer Scale}`\n ? Scale\n : never", + "description": "" + } + }, + "BorderRadius": { + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "name": "BorderRadius", + "description": "", "members": [ { - "filePath": "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx", - "name": "Entering", - "value": "entering" + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "bottomLeft", + "value": "\"base\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"large\" | \"half\"", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "bottomRight", + "value": "\"base\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"large\" | \"half\"", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "topLeft", + "value": "\"base\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"large\" | \"half\"", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "topRight", + "value": "\"base\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"large\" | \"half\"", + "description": "" + } + ], + "value": "interface BorderRadius {\n bottomLeft: BorderRadiusTokenScale;\n bottomRight: BorderRadiusTokenScale;\n topLeft: BorderRadiusTokenScale;\n topRight: BorderRadiusTokenScale;\n}" + } + }, + "SpacingTokenScale": { + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "SpacingTokenScale", + "value": "SpacingTokenName extends `space-${infer Scale}`\n ? Scale\n : never", + "description": "" + } + }, + "BoxProps": { + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "name": "BoxProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "as", + "value": "\"div\" | \"span\"", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "BackgroundColorTokenScale", + "description": "Background color of the Box", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderTokenScale", + "description": "Border styling of the Box", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "borderBottom", + "value": "BorderTokenScale", + "description": "Bottom border styling of the Box", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "borderLeft", + "value": "BorderTokenScale", + "description": "Left border styling of the Box", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "borderRight", + "value": "BorderTokenScale", + "description": "Right border styling of the Box", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "borderTop", + "value": "BorderTokenScale", + "description": "Top border styling of the Box", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "\"base\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"large\" | \"half\"", + "description": "Border radius of the Box", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "borderRadiusBottomLeft", + "value": "\"base\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"large\" | \"half\"", + "description": "Bottom left border radius of the Box", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "borderRadiusBottomRight", + "value": "\"base\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"large\" | \"half\"", + "description": "Bottom right border radius of the Box", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "borderRadiusTopLeft", + "value": "\"base\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"large\" | \"half\"", + "description": "Top left border radius of the Box", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "borderRadiusTopRight", + "value": "\"base\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"large\" | \"half\"", + "description": "Top right border radius of the Box", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ReactNode", + "description": "Inner content of the Box" + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "margin", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Spacing outside of the Box", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "marginBottom", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Bottom spacing outside of the Box", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "marginLeft", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Left side spacing outside of the Box", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "marginRight", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Right side spacing outside of the Box", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "marginTop", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Top spacing outside of the Box", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Spacing inside of the Box", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "paddingBottom", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Bottom spacing inside of the Box", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "paddingLeft", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Left side spacing inside of the Box", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "paddingRight", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Right side spacing inside of the Box", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "paddingTop", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Top spacing inside of the Box", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "shadow", + "value": "\"button\" | \"base\" | \"transparent\" | \"faint\" | \"deep\" | \"top-bar\" | \"card\" | \"popover\" | \"layer\" | \"modal\"", + "description": "Shadow on the Box", + "isOptional": true + } + ], + "value": "export interface BoxProps {\n as?: 'div' | 'span';\n /** Background color of the Box */\n background?: BackgroundColorTokenScale;\n /** Border styling of the Box */\n border?: BorderTokenScale;\n /** Bottom border styling of the Box */\n borderBottom?: BorderTokenScale;\n /** Left border styling of the Box */\n borderLeft?: BorderTokenScale;\n /** Right border styling of the Box */\n borderRight?: BorderTokenScale;\n /** Top border styling of the Box */\n borderTop?: BorderTokenScale;\n /** Border radius of the Box */\n borderRadius?: BorderRadiusTokenScale;\n /** Bottom left border radius of the Box */\n borderRadiusBottomLeft?: BorderRadiusTokenScale;\n /** Bottom right border radius of the Box */\n borderRadiusBottomRight?: BorderRadiusTokenScale;\n /** Top left border radius of the Box */\n borderRadiusTopLeft?: BorderRadiusTokenScale;\n /** Top right border radius of the Box */\n borderRadiusTopRight?: BorderRadiusTokenScale;\n /** Inner content of the Box */\n children: ReactNode;\n /** Spacing outside of the Box */\n margin?: SpacingTokenScale;\n /** Bottom spacing outside of the Box */\n marginBottom?: SpacingTokenScale;\n /** Left side spacing outside of the Box */\n marginLeft?: SpacingTokenScale;\n /** Right side spacing outside of the Box */\n marginRight?: SpacingTokenScale;\n /** Top spacing outside of the Box */\n marginTop?: SpacingTokenScale;\n /** Spacing inside of the Box */\n padding?: SpacingTokenScale;\n /** Bottom spacing inside of the Box */\n paddingBottom?: SpacingTokenScale;\n /** Left side spacing inside of the Box */\n paddingLeft?: SpacingTokenScale;\n /** Right side spacing inside of the Box */\n paddingRight?: SpacingTokenScale;\n /** Top spacing inside of the Box */\n paddingTop?: SpacingTokenScale;\n /** Shadow on the Box */\n shadow?: DepthTokenScale;\n}" + } + }, + "BreadcrumbsProps": { + "polaris-react/src/components/Breadcrumbs/Breadcrumbs.tsx": { + "filePath": "polaris-react/src/components/Breadcrumbs/Breadcrumbs.tsx", + "name": "BreadcrumbsProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Breadcrumbs/Breadcrumbs.tsx", + "syntaxKind": "PropertySignature", + "name": "breadcrumbs", + "value": "(LinkAction | CallbackAction)[]", + "description": "Collection of breadcrumbs" + } + ], + "value": "export interface BreadcrumbsProps {\n /** Collection of breadcrumbs */\n breadcrumbs: (CallbackAction | LinkAction)[];\n}" + } + }, + "BulkAction": { + "polaris-react/src/components/BulkActions/BulkActions.tsx": { + "filePath": "polaris-react/src/components/BulkActions/BulkActions.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "BulkAction", + "value": "DisableableAction & BadgeAction", + "description": "" + } + }, + "BulkActionListSection": { + "polaris-react/src/components/BulkActions/BulkActions.tsx": { + "filePath": "polaris-react/src/components/BulkActions/BulkActions.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "BulkActionListSection", + "value": "ActionListSection", + "description": "" + } + }, + "TransitionStatus": { + "polaris-react/src/components/BulkActions/BulkActions.tsx": { + "filePath": "polaris-react/src/components/BulkActions/BulkActions.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "TransitionStatus", + "value": "'entering' | 'entered' | 'exiting' | 'exited'", + "description": "" + }, + "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx": { + "filePath": "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx", + "syntaxKind": "EnumDeclaration", + "name": "TransitionStatus", + "value": "enum TransitionStatus {\n Entering = 'entering',\n Entered = 'entered',\n Exiting = 'exiting',\n Exited = 'exited',\n}", + "members": [ + { + "filePath": "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx", + "name": "Entering", + "value": "entering" + }, + { + "filePath": "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx", + "name": "Entered", + "value": "entered" + }, + { + "filePath": "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx", + "name": "Exiting", + "value": "exiting" + }, + { + "filePath": "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx", + "name": "Exited", + "value": "exited" + } + ] + }, + "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx": { + "filePath": "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx", + "syntaxKind": "EnumDeclaration", + "name": "TransitionStatus", + "value": "enum TransitionStatus {\n Entering = 'entering',\n Entered = 'entered',\n Exiting = 'exiting',\n Exited = 'exited',\n}", + "members": [ + { + "filePath": "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx", + "name": "Entering", + "value": "entering" }, { "filePath": "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx", @@ -9800,7 +10462,7 @@ "filePath": "polaris-react/src/components/Button/Button.tsx", "syntaxKind": "PropertySignature", "name": "size", - "value": "\"medium\" | \"large\" | \"slim\"", + "value": "\"large\" | \"medium\" | \"slim\"", "description": "Changes the size of the button, giving it more or less padding", "isOptional": true, "defaultValue": "'medium'" @@ -9809,7 +10471,7 @@ "filePath": "polaris-react/src/components/Button/Button.tsx", "syntaxKind": "PropertySignature", "name": "textAlign", - "value": "\"left\" | \"right\" | \"center\" | \"start\" | \"end\"", + "value": "\"start\" | \"end\" | \"center\" | \"left\" | \"right\"", "description": "Changes the inner text alignment of the button", "isOptional": true }, @@ -10123,102 +10785,29 @@ "description": "" } }, - "Spacing": { - "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", - "value": "'extraTight' | 'tight' | 'loose'", - "description": "" - }, - "polaris-react/src/components/Stack/Stack.tsx": { - "filePath": "polaris-react/src/components/Stack/Stack.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", - "value": "'extraTight' | 'tight' | 'baseTight' | 'loose' | 'extraLoose' | 'none'", - "description": "" - }, - "polaris-react/src/components/TextContainer/TextContainer.tsx": { - "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", - "value": "'tight' | 'loose'", - "description": "" - } - }, - "ButtonGroupProps": { - "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "name": "ButtonGroupProps", + "CalloutCardProps": { + "polaris-react/src/components/CalloutCard/CalloutCard.tsx": { + "filePath": "polaris-react/src/components/CalloutCard/CalloutCard.tsx", + "name": "CalloutCardProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "filePath": "polaris-react/src/components/CalloutCard/CalloutCard.tsx", "syntaxKind": "PropertySignature", - "name": "spacing", - "value": "Spacing", - "description": "Determines the space between button group items", + "name": "children", + "value": "React.ReactNode", + "description": "The content to display inside the callout card.", "isOptional": true }, { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "filePath": "polaris-react/src/components/CalloutCard/CalloutCard.tsx", "syntaxKind": "PropertySignature", - "name": "segmented", - "value": "boolean", - "description": "Join buttons as segmented group", - "isOptional": true + "name": "title", + "value": "string", + "description": "The title of the card" }, { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "fullWidth", - "value": "boolean", - "description": "Buttons will stretch/shrink to occupy the full width", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "connectedTop", - "value": "boolean", - "description": "Remove top left and right border radius", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Button components", - "isOptional": true - } - ], - "value": "export interface ButtonGroupProps {\n /** Determines the space between button group items */\n spacing?: Spacing;\n /** Join buttons as segmented group */\n segmented?: boolean;\n /** Buttons will stretch/shrink to occupy the full width */\n fullWidth?: boolean;\n /** Remove top left and right border radius */\n connectedTop?: boolean;\n /** Button components */\n children?: React.ReactNode;\n}" - } - }, - "CalloutCardProps": { - "polaris-react/src/components/CalloutCard/CalloutCard.tsx": { - "filePath": "polaris-react/src/components/CalloutCard/CalloutCard.tsx", - "name": "CalloutCardProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/CalloutCard/CalloutCard.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to display inside the callout card.", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/CalloutCard/CalloutCard.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The title of the card" - }, - { - "filePath": "polaris-react/src/components/CalloutCard/CalloutCard.tsx", + "filePath": "polaris-react/src/components/CalloutCard/CalloutCard.tsx", "syntaxKind": "PropertySignature", "name": "illustration", "value": "string", @@ -10359,86 +10948,54 @@ "value": "export interface CardProps {\n /** Title content for the card */\n title?: React.ReactNode;\n /** Inner content of the card */\n children?: React.ReactNode;\n /** A less prominent card */\n subdued?: boolean;\n /** Auto wrap content in section */\n sectioned?: boolean;\n /** Card header actions */\n actions?: DisableableAction[];\n /** Primary action in the card footer */\n primaryFooterAction?: ComplexAction;\n /** Secondary actions in the card footer */\n secondaryFooterActions?: ComplexAction[];\n /** The content of the disclosure button rendered when there is more than one secondary footer action */\n secondaryFooterActionsDisclosureText?: string;\n /** Alignment of the footer actions on the card, defaults to right */\n footerActionAlignment?: 'right' | 'left';\n /** Allow the card to be hidden when printing */\n hideOnPrint?: boolean;\n}" } }, - "CheckableButtonProps": { - "polaris-react/src/components/CheckableButton/CheckableButton.tsx": { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "name": "CheckableButtonProps", + "ButtonGroupProps": { + "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "name": "ButtonGroupProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "syntaxKind": "PropertySignature", - "name": "selected", - "value": "boolean | \"indeterminate\"", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", "syntaxKind": "PropertySignature", - "name": "selectMode", - "value": "boolean", - "description": "", + "name": "spacing", + "value": "Spacing", + "description": "Determines the space between button group items", "isOptional": true }, { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", "syntaxKind": "PropertySignature", - "name": "smallScreen", + "name": "segmented", "value": "boolean", - "description": "", + "description": "Join buttons as segmented group", "isOptional": true }, { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", "syntaxKind": "PropertySignature", - "name": "plain", + "name": "fullWidth", "value": "boolean", - "description": "", + "description": "Buttons will stretch/shrink to occupy the full width", "isOptional": true }, { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", "syntaxKind": "PropertySignature", - "name": "measuring", + "name": "connectedTop", "value": "boolean", - "description": "", + "description": "Remove top left and right border radius", "isOptional": true }, { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onToggleAll", - "value": "() => void", - "description": "", + "name": "children", + "value": "React.ReactNode", + "description": "Button components", "isOptional": true } ], - "value": "export interface CheckableButtonProps {\n accessibilityLabel?: string;\n label?: string;\n selected?: boolean | 'indeterminate';\n selectMode?: boolean;\n smallScreen?: boolean;\n plain?: boolean;\n measuring?: boolean;\n disabled?: boolean;\n onToggleAll?(): void;\n}" + "value": "export interface ButtonGroupProps {\n /** Determines the space between button group items */\n spacing?: Spacing;\n /** Join buttons as segmented group */\n segmented?: boolean;\n /** Buttons will stretch/shrink to occupy the full width */\n fullWidth?: boolean;\n /** Remove top left and right border radius */\n connectedTop?: boolean;\n /** Button components */\n children?: React.ReactNode;\n}" } }, "CheckboxProps": { @@ -10864,6 +11421,88 @@ "value": "export interface ChoiceListProps {\n /** Label for list of choices */\n title: React.ReactNode;\n /** Collection of choices */\n choices: Choice[];\n /** Collection of selected choices */\n selected: string[];\n /** Name for form input */\n name?: string;\n /** Allow merchants to select multiple options at once */\n allowMultiple?: boolean;\n /** Toggles display of the title */\n titleHidden?: boolean;\n /** Display an error message */\n error?: Error;\n /** Disable all choices **/\n disabled?: boolean;\n /** Callback when the selected choices change */\n onChange?(selected: string[], name: string): void;\n}" } }, + "CheckableButtonProps": { + "polaris-react/src/components/CheckableButton/CheckableButton.tsx": { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "name": "CheckableButtonProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "boolean | \"indeterminate\"", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "PropertySignature", + "name": "selectMode", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "PropertySignature", + "name": "smallScreen", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "PropertySignature", + "name": "plain", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "PropertySignature", + "name": "measuring", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onToggleAll", + "value": "() => void", + "description": "", + "isOptional": true + } + ], + "value": "export interface CheckableButtonProps {\n accessibilityLabel?: string;\n label?: string;\n selected?: boolean | 'indeterminate';\n selectMode?: boolean;\n smallScreen?: boolean;\n plain?: boolean;\n measuring?: boolean;\n disabled?: boolean;\n onToggleAll?(): void;\n}" + } + }, "Transition": { "polaris-react/src/components/Collapsible/Collapsible.tsx": { "filePath": "polaris-react/src/components/Collapsible/Collapsible.tsx", @@ -11063,55 +11702,217 @@ "value": "export interface ColorPickerProps {\n /** ID for the element */\n id?: string;\n /** The currently selected color */\n color: Color;\n /** Allow user to select an alpha value */\n allowAlpha?: boolean;\n /** Allow HuePicker to take the full width */\n fullWidth?: boolean;\n /** Callback when color is selected */\n onChange(color: HSBAColor): void;\n}" } }, - "ComboboxProps": { - "polaris-react/src/components/Combobox/Combobox.tsx": { - "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", - "name": "ComboboxProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", - "syntaxKind": "PropertySignature", - "name": "activator", - "value": "React.ReactElement", - "description": "The text field component to activate the Popover" - }, - { - "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", - "syntaxKind": "PropertySignature", - "name": "allowMultiple", - "value": "boolean", - "description": "Allows more than one option to be selected", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "any", - "description": "The content to display inside the popover", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", - "syntaxKind": "PropertySignature", - "name": "preferredPosition", - "value": "PreferredPosition", - "description": "The preferred direction to open the popover", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", - "syntaxKind": "PropertySignature", - "name": "willLoadMoreOptions", - "value": "boolean", - "description": "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.", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", - "syntaxKind": "PropertySignature", - "name": "height", + "Breakpoints": { + "polaris-react/src/components/Columns/Columns.tsx": { + "filePath": "polaris-react/src/components/Columns/Columns.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Breakpoints", + "value": "'xs' | 'sm' | 'md' | 'lg' | 'xl'", + "description": "" + }, + "polaris-react/src/components/Grid/Grid.tsx": { + "filePath": "polaris-react/src/components/Grid/Grid.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Breakpoints", + "value": "'xs' | 'sm' | 'md' | 'lg' | 'xl'", + "description": "" + }, + "polaris-react/src/components/Grid/components/Cell/Cell.tsx": { + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Breakpoints", + "value": "'xs' | 'sm' | 'md' | 'lg' | 'xl'", + "description": "" + } + }, + "SpacingName": { + "polaris-react/src/components/Columns/Columns.tsx": { + "filePath": "polaris-react/src/components/Columns/Columns.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "SpacingName", + "value": "keyof typeof spacing", + "description": "" + } + }, + "SpacingScale": { + "polaris-react/src/components/Columns/Columns.tsx": { + "filePath": "polaris-react/src/components/Columns/Columns.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "SpacingScale", + "value": "SpacingName extends `space-${infer Scale}` ? Scale : never", + "description": "" + } + }, + "Columns": { + "polaris-react/src/components/Columns/Columns.tsx": { + "filePath": "polaris-react/src/components/Columns/Columns.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Columns", + "value": "{\n [Breakpoint in Breakpoints]?: number | string;\n}", + "description": "" + }, + "polaris-react/src/components/Grid/Grid.tsx": { + "filePath": "polaris-react/src/components/Grid/Grid.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Columns", + "value": "{\n [Breakpoint in Breakpoints]?: number;\n}", + "description": "" + }, + "polaris-react/src/components/Tile/Tile.tsx": { + "filePath": "polaris-react/src/components/Tile/Tile.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Columns", + "value": "'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12'", + "description": "" + }, + "polaris-react/src/components/Grid/components/Cell/Cell.tsx": { + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "name": "Columns", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "xs", + "value": "2 | 1 | 3 | 4 | 5 | 6", + "description": "Number of columns the section should span on extra small screens", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "sm", + "value": "2 | 1 | 3 | 4 | 5 | 6", + "description": "Number of columns the section should span on small screens", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "md", + "value": "2 | 1 | 3 | 4 | 5 | 6", + "description": "Number of columns the section should span on medium screens", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "lg", + "value": "2 | 1 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12", + "description": "Number of columns the section should span on large screens", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "xl", + "value": "2 | 1 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12", + "description": "Number of columns the section should span on extra large screens", + "isOptional": true + } + ], + "value": "interface Columns {\n /** Number of columns the section should span on extra small screens */\n xs?: 1 | 2 | 3 | 4 | 5 | 6;\n /** Number of columns the section should span on small screens */\n sm?: 1 | 2 | 3 | 4 | 5 | 6;\n /** Number of columns the section should span on medium screens */\n md?: 1 | 2 | 3 | 4 | 5 | 6;\n /** Number of columns the section should span on large screens */\n lg?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;\n /** Number of columns the section should span on extra large screens */\n xl?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;\n}" + } + }, + "Gap": { + "polaris-react/src/components/Columns/Columns.tsx": { + "filePath": "polaris-react/src/components/Columns/Columns.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Gap", + "value": "{\n [Breakpoint in Breakpoints]?: SpacingScale;\n}", + "description": "" + }, + "polaris-react/src/components/Grid/Grid.tsx": { + "filePath": "polaris-react/src/components/Grid/Grid.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Gap", + "value": "{\n [Breakpoint in Breakpoints]?: string;\n}", + "description": "" + } + }, + "ColumnsProps": { + "polaris-react/src/components/Columns/Columns.tsx": { + "filePath": "polaris-react/src/components/Columns/Columns.tsx", + "name": "ColumnsProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Columns/Columns.tsx", + "syntaxKind": "PropertySignature", + "name": "gap", + "value": "Gap", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Columns/Columns.tsx", + "syntaxKind": "PropertySignature", + "name": "columns", + "value": "Columns", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Columns/Columns.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "export interface ColumnsProps {\n gap?: Gap;\n columns?: Columns;\n children?: React.ReactNode;\n}" + } + }, + "ComboboxProps": { + "polaris-react/src/components/Combobox/Combobox.tsx": { + "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", + "name": "ComboboxProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", + "syntaxKind": "PropertySignature", + "name": "activator", + "value": "React.ReactElement", + "description": "The text field component to activate the Popover" + }, + { + "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", + "syntaxKind": "PropertySignature", + "name": "allowMultiple", + "value": "boolean", + "description": "Allows more than one option to be selected", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "any", + "description": "The content to display inside the popover", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", + "syntaxKind": "PropertySignature", + "name": "preferredPosition", + "value": "PreferredPosition", + "description": "The preferred direction to open the popover", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", + "syntaxKind": "PropertySignature", + "name": "willLoadMoreOptions", + "value": "boolean", + "description": "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.", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Combobox/Combobox.tsx", + "syntaxKind": "PropertySignature", + "name": "height", "value": "string", "description": "Height to set on the Popover Pane.", "isOptional": true @@ -11410,7 +12211,7 @@ "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", "syntaxKind": "PropertySignature", "name": "status", - "value": "\"warning\" | \"critical\"", + "value": "\"critical\" | \"warning\"", "description": "Set the color of the icon and title for the given item.", "isOptional": true }, @@ -12031,78 +12832,6 @@ "value": "export interface EmptySearchResultProps {\n title: string;\n description?: string;\n withIllustration?: boolean;\n}" } }, - "BaseEventProps": { - "polaris-react/src/components/EventListener/EventListener.tsx": { - "filePath": "polaris-react/src/components/EventListener/EventListener.tsx", - "name": "BaseEventProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/EventListener/EventListener.tsx", - "syntaxKind": "PropertySignature", - "name": "event", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/EventListener/EventListener.tsx", - "syntaxKind": "PropertySignature", - "name": "capture", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/EventListener/EventListener.tsx", - "syntaxKind": "MethodSignature", - "name": "handler", - "value": "(event: Event) => void", - "description": "" - } - ], - "value": "interface BaseEventProps {\n event: string;\n capture?: boolean;\n handler(event: Event): void;\n}" - } - }, - "EventListenerProps": { - "polaris-react/src/components/EventListener/EventListener.tsx": { - "filePath": "polaris-react/src/components/EventListener/EventListener.tsx", - "name": "EventListenerProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/EventListener/EventListener.tsx", - "syntaxKind": "PropertySignature", - "name": "passive", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/EventListener/EventListener.tsx", - "syntaxKind": "PropertySignature", - "name": "event", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/EventListener/EventListener.tsx", - "syntaxKind": "PropertySignature", - "name": "capture", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/EventListener/EventListener.tsx", - "syntaxKind": "MethodSignature", - "name": "handler", - "value": "(event: Event) => void", - "description": "" - } - ], - "value": "export interface EventListenerProps extends BaseEventProps {\n passive?: boolean;\n}" - } - }, "EmptyStateProps": { "polaris-react/src/components/EmptyState/EmptyState.tsx": { "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", @@ -12184,63 +12913,102 @@ "value": "export interface EmptyStateProps {\n /** The empty state heading */\n heading?: string;\n /**\n * The path to the image to display.\n * The image should have ~40px of white space above when empty state is used within a card, modal, or navigation component\n */\n image: string;\n /** The path to the image to display on large screens */\n largeImage?: string;\n /** Whether or not to limit the image to the size of its container on large screens */\n imageContained?: boolean;\n /** Whether or not the content should span the full width of its container */\n fullWidth?: boolean;\n /** Elements to display inside empty state */\n children?: React.ReactNode;\n /** Primary action for empty state */\n action?: ComplexAction;\n /** Secondary action for empty state */\n secondaryAction?: ComplexAction;\n /** Secondary elements to display below empty state actions */\n footerContent?: React.ReactNode;\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", + "BaseEventProps": { + "polaris-react/src/components/EventListener/EventListener.tsx": { + "filePath": "polaris-react/src/components/EventListener/EventListener.tsx", + "name": "BaseEventProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", + "filePath": "polaris-react/src/components/EventListener/EventListener.tsx", "syntaxKind": "PropertySignature", - "name": "items", - "value": "Item[]", - "description": "Collection of items for list" + "name": "event", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/EventListener/EventListener.tsx", + "syntaxKind": "PropertySignature", + "name": "capture", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/EventListener/EventListener.tsx", + "syntaxKind": "MethodSignature", + "name": "handler", + "value": "(event: Event) => void", + "description": "" } ], - "value": "export interface ExceptionListProps {\n /** Collection of items for list */\n items: Item[];\n}" + "value": "interface BaseEventProps {\n event: string;\n capture?: boolean;\n handler(event: Event): void;\n}" } }, - "FocusProps": { - "polaris-react/src/components/Focus/Focus.tsx": { - "filePath": "polaris-react/src/components/Focus/Focus.tsx", - "name": "FocusProps", + "EventListenerProps": { + "polaris-react/src/components/EventListener/EventListener.tsx": { + "filePath": "polaris-react/src/components/EventListener/EventListener.tsx", + "name": "EventListenerProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Focus/Focus.tsx", + "filePath": "polaris-react/src/components/EventListener/EventListener.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", + "name": "passive", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Focus/Focus.tsx", + "filePath": "polaris-react/src/components/EventListener/EventListener.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", + "name": "event", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/EventListener/EventListener.tsx", + "syntaxKind": "PropertySignature", + "name": "capture", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Focus/Focus.tsx", - "syntaxKind": "PropertySignature", - "name": "root", - "value": "any", + "filePath": "polaris-react/src/components/EventListener/EventListener.tsx", + "syntaxKind": "MethodSignature", + "name": "handler", + "value": "(event: Event) => void", "description": "" } ], - "value": "export interface FocusProps {\n children?: React.ReactNode;\n disabled?: boolean;\n root: React.RefObject | HTMLElement | null;\n}" + "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": { @@ -12484,6 +13252,39 @@ ] } }, + "FocusProps": { + "polaris-react/src/components/Focus/Focus.tsx": { + "filePath": "polaris-react/src/components/Focus/Focus.tsx", + "name": "FocusProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Focus/Focus.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Focus/Focus.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Focus/Focus.tsx", + "syntaxKind": "PropertySignature", + "name": "root", + "value": "any", + "description": "" + } + ], + "value": "export interface FocusProps {\n children?: React.ReactNode;\n disabled?: boolean;\n root: React.RefObject | HTMLElement | null;\n}" + } + }, "Context": { "polaris-react/src/components/FocusManager/FocusManager.tsx": { "filePath": "polaris-react/src/components/FocusManager/FocusManager.tsx", @@ -12661,31 +13462,6 @@ "value": "export interface FormLayoutProps {\n /** The content to display inside the layout. */\n children?: React.ReactNode;\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}" - } - }, "FrameProps": { "polaris-react/src/components/Frame/Frame.tsx": { "filePath": "polaris-react/src/components/Frame/Frame.tsx", @@ -12769,94 +13545,37 @@ "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}" } }, - "Breakpoints": { - "polaris-react/src/components/Grid/Grid.tsx": { - "filePath": "polaris-react/src/components/Grid/Grid.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Breakpoints", - "value": "'xs' | 'sm' | 'md' | 'lg' | 'xl'", - "description": "" - }, - "polaris-react/src/components/Grid/components/Cell/Cell.tsx": { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Breakpoints", - "value": "'xs' | 'sm' | 'md' | 'lg' | 'xl'", - "description": "" - } - }, - "Areas": { - "polaris-react/src/components/Grid/Grid.tsx": { - "filePath": "polaris-react/src/components/Grid/Grid.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Areas", - "value": "{\n [Breakpoint in Breakpoints]?: string[];\n}", - "description": "" - } - }, - "Columns": { - "polaris-react/src/components/Grid/Grid.tsx": { - "filePath": "polaris-react/src/components/Grid/Grid.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Columns", - "value": "{\n [Breakpoint in Breakpoints]?: number;\n}", - "description": "" - }, - "polaris-react/src/components/Grid/components/Cell/Cell.tsx": { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", - "name": "Columns", + "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/Grid/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "xs", - "value": "2 | 1 | 3 | 4 | 5 | 6", - "description": "Number of columns the section should span on extra small screens", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "sm", - "value": "2 | 1 | 3 | 4 | 5 | 6", - "description": "Number of columns the section should span on small screens", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "md", - "value": "2 | 1 | 3 | 4 | 5 | 6", - "description": "Number of columns the section should span on medium screens", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "filePath": "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx", "syntaxKind": "PropertySignature", - "name": "lg", - "value": "2 | 1 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12", - "description": "Number of columns the section should span on large screens", - "isOptional": true + "name": "onAction", + "value": "() => void", + "description": "Callback when back button is clicked" }, { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "filePath": "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx", "syntaxKind": "PropertySignature", - "name": "xl", - "value": "2 | 1 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12", - "description": "Number of columns the section should span on extra large screens", + "name": "children", + "value": "React.ReactNode", + "description": "Render child elements", "isOptional": true } ], - "value": "interface Columns {\n /** Number of columns the section should span on extra small screens */\n xs?: 1 | 2 | 3 | 4 | 5 | 6;\n /** Number of columns the section should span on small screens */\n sm?: 1 | 2 | 3 | 4 | 5 | 6;\n /** Number of columns the section should span on medium screens */\n md?: 1 | 2 | 3 | 4 | 5 | 6;\n /** Number of columns the section should span on large screens */\n lg?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;\n /** Number of columns the section should span on extra large screens */\n xl?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;\n}" + "value": "export interface FullscreenBarProps {\n /** Callback when back button is clicked */\n onAction: () => void;\n /** Render child elements */\n children?: React.ReactNode;\n}" } }, - "Gap": { + "Areas": { "polaris-react/src/components/Grid/Grid.tsx": { "filePath": "polaris-react/src/components/Grid/Grid.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "Gap", - "value": "{\n [Breakpoint in Breakpoints]?: string;\n}", + "name": "Areas", + "value": "{\n [Breakpoint in Breakpoints]?: string[];\n}", "description": "" } }, @@ -13449,39 +14168,89 @@ "value": "export interface IndexTableProps\n extends IndexTableBaseProps,\n IndexProviderProps {}" } }, - "InlineCodeProps": { - "polaris-react/src/components/InlineCode/InlineCode.tsx": { - "filePath": "polaris-react/src/components/InlineCode/InlineCode.tsx", - "name": "InlineCodeProps", + "IndicatorProps": { + "polaris-react/src/components/Indicator/Indicator.tsx": { + "filePath": "polaris-react/src/components/Indicator/Indicator.tsx", + "name": "IndicatorProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/InlineCode/InlineCode.tsx", + "filePath": "polaris-react/src/components/Indicator/Indicator.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", - "description": "The content to render inside the code block" + "name": "pulse", + "value": "boolean", + "description": "", + "isOptional": true } ], - "value": "export interface InlineCodeProps {\n /** The content to render inside the code block */\n children: ReactNode;\n}" + "value": "export interface IndicatorProps {\n pulse?: boolean;\n}" } }, - "IndicatorProps": { - "polaris-react/src/components/Indicator/Indicator.tsx": { - "filePath": "polaris-react/src/components/Indicator/Indicator.tsx", - "name": "IndicatorProps", + "InlineProps": { + "polaris-react/src/components/Inline/Inline.tsx": { + "filePath": "polaris-react/src/components/Inline/Inline.tsx", + "name": "InlineProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Indicator/Indicator.tsx", + "filePath": "polaris-react/src/components/Inline/Inline.tsx", "syntaxKind": "PropertySignature", - "name": "pulse", + "name": "children", + "value": "React.ReactNode", + "description": "Elements to display inside stack", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Inline/Inline.tsx", + "syntaxKind": "PropertySignature", + "name": "wrap", "value": "boolean", - "description": "", + "description": "Wrap stack elements to additional rows as needed on small screens (Defaults to true)", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Inline/Inline.tsx", + "syntaxKind": "PropertySignature", + "name": "spacing", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Adjust spacing between elements", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Inline/Inline.tsx", + "syntaxKind": "PropertySignature", + "name": "alignY", + "value": "\"center\" | \"top\" | \"bottom\" | \"baseline\"", + "description": "Adjust vertical alignment of elements", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Inline/Inline.tsx", + "syntaxKind": "PropertySignature", + "name": "align", + "value": "Align", + "description": "Adjust horizontal alignment of elements", "isOptional": true } ], - "value": "export interface IndicatorProps {\n pulse?: boolean;\n}" + "value": "export interface InlineProps {\n /** Elements to display inside stack */\n children?: React.ReactNode;\n /** Wrap stack elements to additional rows as needed on small screens (Defaults to true) */\n wrap?: boolean;\n /** Adjust spacing between elements */\n spacing?: Spacing;\n /** Adjust vertical alignment of elements */\n alignY?: keyof typeof AlignY;\n /** Adjust horizontal alignment of elements */\n align?: Align;\n}" + } + }, + "InlineCodeProps": { + "polaris-react/src/components/InlineCode/InlineCode.tsx": { + "filePath": "polaris-react/src/components/InlineCode/InlineCode.tsx", + "name": "InlineCodeProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/InlineCode/InlineCode.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ReactNode", + "description": "The content to render inside the code block" + } + ], + "value": "export interface InlineCodeProps {\n /** The content to render inside the code block */\n children: ReactNode;\n}" } }, "InlineErrorProps": { @@ -13602,32 +14371,6 @@ "value": "export interface LabelProps {\n /** Label content */\n children?: React.ReactNode;\n /** A unique identifier for the label */\n id: string;\n /** Visually hide the label */\n hidden?: boolean;\n /** Visual required indicator for the label */\n requiredIndicator?: boolean;\n}" } }, - "LayoutProps": { - "polaris-react/src/components/Layout/Layout.tsx": { - "filePath": "polaris-react/src/components/Layout/Layout.tsx", - "name": "LayoutProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Layout/Layout.tsx", - "syntaxKind": "PropertySignature", - "name": "sectioned", - "value": "boolean", - "description": "Automatically adds sections to layout.", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Layout/Layout.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to display inside the layout.", - "isOptional": true - } - ], - "value": "export interface LayoutProps {\n /** Automatically adds sections to layout. */\n sectioned?: boolean;\n /** The content to display inside the layout. */\n children?: React.ReactNode;\n}" - } - }, "LabelledProps": { "polaris-react/src/components/Labelled/Labelled.tsx": { "filePath": "polaris-react/src/components/Labelled/Labelled.tsx", @@ -13700,6 +14443,32 @@ "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}" } }, + "LayoutProps": { + "polaris-react/src/components/Layout/Layout.tsx": { + "filePath": "polaris-react/src/components/Layout/Layout.tsx", + "name": "LayoutProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Layout/Layout.tsx", + "syntaxKind": "PropertySignature", + "name": "sectioned", + "value": "boolean", + "description": "Automatically adds sections to layout.", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Layout/Layout.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The content to display inside the layout.", + "isOptional": true + } + ], + "value": "export interface LayoutProps {\n /** Automatically adds sections to layout. */\n sectioned?: boolean;\n /** The content to display inside the layout. */\n children?: React.ReactNode;\n}" + } + }, "LinkProps": { "polaris-react/src/components/Link/Link.tsx": { "filePath": "polaris-react/src/components/Link/Link.tsx", @@ -13782,6 +14551,87 @@ "value": "export interface LinkProps {\n /** ID for the link */\n id?: string;\n /** The url to link to */\n url?: string;\n /** The content to display inside the link */\n children?: React.ReactNode;\n /** Makes the link open in a new tab */\n external?: boolean;\n /** Makes the link color the same as the current text color and adds an underline */\n monochrome?: boolean;\n /** Removes text decoration underline to the link*/\n removeUnderline?: boolean;\n /** Callback when a link is clicked */\n onClick?(): void;\n /** Descriptive text to be read to screenreaders */\n accessibilityLabel?: string;\n /** Indicates whether or not the link is the primary navigation link when rendered inside of an `IndexTable.Row` */\n dataPrimaryLink?: boolean;\n}" } }, + "Type": { + "polaris-react/src/components/List/List.tsx": { + "filePath": "polaris-react/src/components/List/List.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Type", + "value": "'bullet' | 'number'", + "description": "" + }, + "polaris-react/src/components/TextField/TextField.tsx": { + "filePath": "polaris-react/src/components/TextField/TextField.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Type", + "value": "'text' | 'email' | 'number' | 'password' | 'search' | 'tel' | 'url' | 'date' | 'datetime-local' | 'month' | 'time' | 'week' | 'currency'", + "description": "" + } + }, + "ListProps": { + "polaris-react/src/components/List/List.tsx": { + "filePath": "polaris-react/src/components/List/List.tsx", + "name": "ListProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/List/List.tsx", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "Type", + "description": "Type of list to display", + "isOptional": true, + "defaultValue": "'bullet'" + }, + { + "filePath": "polaris-react/src/components/List/List.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "List item elements", + "isOptional": true + } + ], + "value": "export interface ListProps {\n /**\n * Type of list to display\n * @default 'bullet'\n */\n type?: Type;\n /** List item elements */\n children?: React.ReactNode;\n}" + }, + "polaris-react/src/components/Tabs/components/List/List.tsx": { + "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", + "name": "ListProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", + "syntaxKind": "PropertySignature", + "name": "focusIndex", + "value": "number", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", + "syntaxKind": "PropertySignature", + "name": "disclosureTabs", + "value": "TabDescriptor[]", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "(id: string) => void", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyPress", + "value": "(event: React.KeyboardEvent) => void", + "description": "", + "isOptional": true + } + ], + "value": "export interface ListProps {\n focusIndex: number;\n disclosureTabs: TabDescriptor[];\n onClick?(id: string): void;\n onKeyPress?(event: React.KeyboardEvent): void;\n}" + } + }, "AutoSelection": { "polaris-react/src/components/Listbox/Listbox.tsx": { "filePath": "polaris-react/src/components/Listbox/Listbox.tsx", @@ -13882,91 +14732,42 @@ "description": "" } }, - "Type": { - "polaris-react/src/components/List/List.tsx": { - "filePath": "polaris-react/src/components/List/List.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Type", - "value": "'bullet' | 'number'", - "description": "" + "LoadingProps": { + "polaris-react/src/components/Loading/Loading.tsx": { + "filePath": "polaris-react/src/components/Loading/Loading.tsx", + "name": "LoadingProps", + "description": "", + "members": [], + "value": "export interface LoadingProps {}" }, - "polaris-react/src/components/TextField/TextField.tsx": { - "filePath": "polaris-react/src/components/TextField/TextField.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Type", - "value": "'text' | 'email' | 'number' | 'password' | 'search' | 'tel' | 'url' | 'date' | 'datetime-local' | 'month' | 'time' | 'week' | 'currency'", - "description": "" - } - }, - "ListProps": { - "polaris-react/src/components/List/List.tsx": { - "filePath": "polaris-react/src/components/List/List.tsx", - "name": "ListProps", + "polaris-react/src/components/Listbox/components/Loading/Loading.tsx": { + "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", + "name": "LoadingProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/List/List.tsx", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "Type", - "description": "Type of list to display", - "isOptional": true, - "defaultValue": "'bullet'" - }, - { - "filePath": "polaris-react/src/components/List/List.tsx", + "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", - "description": "List item elements", + "description": "", "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "" } ], - "value": "export interface ListProps {\n /**\n * Type of list to display\n * @default 'bullet'\n */\n type?: Type;\n /** List item elements */\n children?: React.ReactNode;\n}" - }, - "polaris-react/src/components/Tabs/components/List/List.tsx": { - "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", - "name": "ListProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", - "syntaxKind": "PropertySignature", - "name": "focusIndex", - "value": "number", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", - "syntaxKind": "PropertySignature", - "name": "disclosureTabs", - "value": "TabDescriptor[]", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "(id: string) => void", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tabs/components/List/List.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyPress", - "value": "(event: React.KeyboardEvent) => void", - "description": "", - "isOptional": true - } - ], - "value": "export interface ListProps {\n focusIndex: number;\n disclosureTabs: TabDescriptor[];\n onClick?(id: string): void;\n onKeyPress?(event: React.KeyboardEvent): void;\n}" - } - }, - "MediaCardProps": { - "polaris-react/src/components/MediaCard/MediaCard.tsx": { - "filePath": "polaris-react/src/components/MediaCard/MediaCard.tsx", - "name": "MediaCardProps", + "value": "export interface LoadingProps {\n children?: React.ReactNode;\n accessibilityLabel: string;\n}" + } + }, + "MediaCardProps": { + "polaris-react/src/components/MediaCard/MediaCard.tsx": { + "filePath": "polaris-react/src/components/MediaCard/MediaCard.tsx", + "name": "MediaCardProps", "description": "", "members": [ { @@ -14036,38 +14837,6 @@ "value": "interface MediaCardProps {\n /** The visual media to display in the card */\n children: React.ReactNode;\n /** Heading content */\n title: React.ReactNode;\n /** Body content */\n description: string;\n /** Main call to action, rendered as a basic button */\n primaryAction?: ComplexAction;\n /** Secondary call to action, rendered as a plain button */\n secondaryAction?: ComplexAction;\n /** Action list items to render in ellipsis popover */\n popoverActions?: ActionListItemDescriptor[];\n /** Whether or not card content should be laid out vertically\n * @default false\n */\n portrait?: boolean;\n /** Size of the visual media in the card\n * @default 'medium'\n */\n size?: Size;\n}" } }, - "LoadingProps": { - "polaris-react/src/components/Loading/Loading.tsx": { - "filePath": "polaris-react/src/components/Loading/Loading.tsx", - "name": "LoadingProps", - "description": "", - "members": [], - "value": "export interface LoadingProps {}" - }, - "polaris-react/src/components/Listbox/components/Loading/Loading.tsx": { - "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", - "name": "LoadingProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "" - } - ], - "value": "export interface LoadingProps {\n children?: React.ReactNode;\n accessibilityLabel: string;\n}" - } - }, "MessageIndicatorProps": { "polaris-react/src/components/MessageIndicator/MessageIndicator.tsx": { "filePath": "polaris-react/src/components/MessageIndicator/MessageIndicator.tsx", @@ -15591,220 +16360,170 @@ "value": "export interface RadioButtonProps {\n /** Indicates the ID of the element that describes the the radio button*/\n ariaDescribedBy?: string;\n /** Label for the radio button */\n label: React.ReactNode;\n /** Visually hide the label */\n labelHidden?: boolean;\n /** Radio button is selected */\n checked?: boolean;\n /** Additional text to aid in use */\n helpText?: React.ReactNode;\n /** Disable input */\n disabled?: boolean;\n /** ID for form input */\n id?: string;\n /** Name for form input */\n name?: string;\n /** Value for form input */\n value?: string;\n /** Callback when the radio button is toggled */\n onChange?(newValue: boolean, id: string): void;\n /** Callback when radio button is focussed */\n onFocus?(): void;\n /** Callback when focus is removed */\n onBlur?(): void;\n}" } }, - "ResourceListProps": { - "polaris-react/src/components/ResourceList/ResourceList.tsx": { - "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", - "name": "ResourceListProps", + "BaseProps": { + "polaris-react/src/components/ResourceItem/ResourceItem.tsx": { + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "name": "BaseProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", "syntaxKind": "PropertySignature", - "name": "items", - "value": "TItemType[]", - "description": "Item data; each item is passed to renderItem" + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden text for screen readers used for item link", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", "syntaxKind": "PropertySignature", - "name": "filterControl", - "value": "React.ReactNode", - "description": "", + "name": "name", + "value": "string", + "description": "Individual item name used by various text labels", "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", "syntaxKind": "PropertySignature", - "name": "emptyState", - "value": "React.ReactNode", - "description": "The markup to display when no resources exist yet. Renders when set and items is empty.", + "name": "ariaControls", + "value": "string", + "description": "Id of the element the item onClick controls", "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", "syntaxKind": "PropertySignature", - "name": "emptySearchState", - "value": "React.ReactNode", - "description": "The markup to display when no results are returned on search or filter of the list. Renders when `filterControl` is set, items are empty, and `emptyState` is not set.", - "isOptional": true, - "defaultValue": "EmptySearchResult" + "name": "ariaExpanded", + "value": "boolean", + "description": "Tells screen reader the controlled element is expanded", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", "syntaxKind": "PropertySignature", - "name": "resourceName", - "value": "{ singular: string; plural: string; }", - "description": "Name of the resource, such as customers or products", - "isOptional": true + "name": "id", + "value": "string", + "description": "Unique identifier for the item" }, { - "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", "syntaxKind": "PropertySignature", - "name": "promotedBulkActions", - "value": "(MenuGroupDescriptor | BulkAction)[]", - "description": "Up to 2 bulk actions that will be given more prominence", + "name": "media", + "value": "React.ReactElement", + "description": "Content for the media area at the left of the item, usually an Avatar or Thumbnail", "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", "syntaxKind": "PropertySignature", - "name": "bulkActions", - "value": "(ActionListSection | BulkAction)[]", - "description": "Actions available on the currently selected items", + "name": "persistActions", + "value": "boolean", + "description": "Makes the shortcut actions always visible", "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", "syntaxKind": "PropertySignature", - "name": "selectedItems", - "value": "ResourceListSelectedItems", - "description": "Collection of IDs for the currently selected items", + "name": "shortcutActions", + "value": "DisableableAction[]", + "description": "1 or 2 shortcut actions; must be available on the page linked to by url", "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", "syntaxKind": "PropertySignature", - "name": "isFiltered", - "value": "boolean", - "description": "Whether or not the list has filter(s) applied", + "name": "sortOrder", + "value": "number", + "description": "The order the item is rendered", "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", "syntaxKind": "PropertySignature", - "name": "selectable", - "value": "boolean", - "description": "Renders a Select All button at the top of the list and checkboxes in front of each list item. For use when bulkActions aren't provided. *", + "name": "url", + "value": "string", + "description": "URL for the resource’s details page (required unless onClick is provided)", "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", "syntaxKind": "PropertySignature", - "name": "hasMoreItems", + "name": "external", "value": "boolean", - "description": "Whether or not there are more items than currently set on the items prop. Determines whether or not to set the paginatedSelectAllAction and paginatedSelectAllText props on the BulkActions component.", + "description": "Allows url to open in a new tab", "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", - "syntaxKind": "PropertySignature", - "name": "loading", - "value": "boolean", - "description": "Overlays item list with a spinner while a background action is being performed", + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "(id?: string) => void", + "description": "Callback when clicked (required if url is omitted)", "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", "syntaxKind": "PropertySignature", - "name": "showHeader", - "value": "boolean", - "description": "Boolean to show or hide the header", + "name": "children", + "value": "React.ReactNode", + "description": "Content for the details area", "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", "syntaxKind": "PropertySignature", - "name": "totalItemsCount", - "value": "number", - "description": "Total number of resources", + "name": "verticalAlignment", + "value": "Alignment", + "description": "Adjust vertical alignment of elements", "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", "syntaxKind": "PropertySignature", - "name": "sortValue", + "name": "dataHref", "value": "string", - "description": "Current value of the sort control", + "description": "Prefetched url attribute to bind to the main element being returned", "isOptional": true - }, + } + ], + "value": "interface BaseProps {\n /** Visually hidden text for screen readers used for item link*/\n accessibilityLabel?: string;\n /** Individual item name used by various text labels */\n name?: string;\n /** Id of the element the item onClick controls */\n ariaControls?: string;\n /** Tells screen reader the controlled element is expanded */\n ariaExpanded?: boolean;\n /** Unique identifier for the item */\n id: string;\n /** Content for the media area at the left of the item, usually an Avatar or Thumbnail */\n media?: React.ReactElement;\n /** Makes the shortcut actions always visible */\n persistActions?: boolean;\n /** 1 or 2 shortcut actions; must be available on the page linked to by url */\n shortcutActions?: DisableableAction[];\n /** The order the item is rendered */\n sortOrder?: number;\n /** URL for the resource’s details page (required unless onClick is provided) */\n url?: string;\n /** Allows url to open in a new tab */\n external?: boolean;\n /** Callback when clicked (required if url is omitted) */\n onClick?(id?: string): void;\n /** Content for the details area */\n children?: React.ReactNode;\n /** Adjust vertical alignment of elements */\n verticalAlignment?: Alignment;\n /** Prefetched url attribute to bind to the main element being returned */\n dataHref?: string;\n}" + } + }, + "PropsWithUrl": { + "polaris-react/src/components/ResourceItem/ResourceItem.tsx": { + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "name": "PropsWithUrl", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", "syntaxKind": "PropertySignature", - "name": "sortOptions", - "value": "SelectOption[]", - "description": "Collection of sort options to choose from", - "isOptional": true + "name": "url", + "value": "string", + "description": "URL for the resource’s details page (required unless onClick is provided)" }, { - "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", - "syntaxKind": "PropertySignature", - "name": "alternateTool", - "value": "React.ReactNode", - "description": "ReactNode to display instead of the sort control", + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "(id?: string) => void", + "description": "Callback when clicked (required if url is omitted)", "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", - "syntaxKind": "MethodSignature", - "name": "onSortChange", - "value": "(selected: string, id: string) => void", - "description": "Callback when sort option is changed", + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden text for screen readers used for item link", "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", - "syntaxKind": "MethodSignature", - "name": "onSelectionChange", - "value": "(selectedItems: ResourceListSelectedItems) => void", - "description": "Callback when selection is changed", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", - "syntaxKind": "MethodSignature", - "name": "renderItem", - "value": "(item: TItemType, id: string, index: number) => React.ReactNode", - "description": "Function to render each list item, must return a ResourceItem component" - }, - { - "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", - "syntaxKind": "MethodSignature", - "name": "idForItem", - "value": "(item: TItemType, index: number) => string", - "description": "Function to customize the unique ID for each item", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", - "syntaxKind": "MethodSignature", - "name": "resolveItemId", - "value": "(item: TItemType) => string", - "description": "Function to resolve the ids of items", - "isOptional": true - } - ], - "value": "export interface ResourceListProps {\n /** Item data; each item is passed to renderItem */\n items: TItemType[];\n filterControl?: React.ReactNode;\n /** The markup to display when no resources exist yet. Renders when set and items is empty. */\n emptyState?: React.ReactNode;\n /** The markup to display when no results are returned on search or filter of the list. Renders when `filterControl` is set, items are empty, and `emptyState` is not set.\n * @default EmptySearchResult\n */\n emptySearchState?: React.ReactNode;\n /** Name of the resource, such as customers or products */\n resourceName?: {\n singular: string;\n plural: string;\n };\n /** Up to 2 bulk actions that will be given more prominence */\n promotedBulkActions?: BulkActionsProps['promotedActions'];\n /** Actions available on the currently selected items */\n bulkActions?: BulkActionsProps['actions'];\n /** Collection of IDs for the currently selected items */\n selectedItems?: ResourceListSelectedItems;\n /** Whether or not the list has filter(s) applied */\n isFiltered?: boolean;\n /** Renders a Select All button at the top of the list and checkboxes in front of each list item. For use when bulkActions aren't provided. **/\n selectable?: boolean;\n /** Whether or not there are more items than currently set on the items prop. Determines whether or not to set the paginatedSelectAllAction and paginatedSelectAllText props on the BulkActions component. */\n hasMoreItems?: boolean;\n /** Overlays item list with a spinner while a background action is being performed */\n loading?: boolean;\n /** Boolean to show or hide the header */\n showHeader?: boolean;\n /** Total number of resources */\n totalItemsCount?: number;\n /** Current value of the sort control */\n sortValue?: string;\n /** Collection of sort options to choose from */\n sortOptions?: SelectOption[];\n /** ReactNode to display instead of the sort control */\n alternateTool?: React.ReactNode;\n /** Callback when sort option is changed */\n onSortChange?(selected: string, id: string): void;\n /** Callback when selection is changed */\n onSelectionChange?(selectedItems: ResourceListSelectedItems): void;\n /** Function to render each list item, must return a ResourceItem component */\n renderItem(item: TItemType, id: string, index: number): React.ReactNode;\n /** Function to customize the unique ID for each item */\n idForItem?(item: TItemType, index: number): string;\n /** Function to resolve the ids of items */\n resolveItemId?(item: TItemType): string;\n}" - } - }, - "ResourceListType": { - "polaris-react/src/components/ResourceList/ResourceList.tsx": { - "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "ResourceListType", - "value": "((\n value: ResourceListProps,\n) => ReactElement) & {\n Item: typeof ResourceItem;\n}", - "description": "" - } - }, - "BaseProps": { - "polaris-react/src/components/ResourceItem/ResourceItem.tsx": { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", - "name": "BaseProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Visually hidden text for screen readers used for item link", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "Individual item name used by various text labels", + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "Individual item name used by various text labels", "isOptional": true }, { @@ -15862,14 +16581,6 @@ "description": "The order the item is rendered", "isOptional": true }, - { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "URL for the resource’s details page (required unless onClick is provided)", - "isOptional": true - }, { "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", "syntaxKind": "PropertySignature", @@ -15878,14 +16589,6 @@ "description": "Allows url to open in a new tab", "isOptional": true }, - { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "(id?: string) => void", - "description": "Callback when clicked (required if url is omitted)", - "isOptional": true - }, { "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", "syntaxKind": "PropertySignature", @@ -15911,13 +16614,13 @@ "isOptional": true } ], - "value": "interface BaseProps {\n /** Visually hidden text for screen readers used for item link*/\n accessibilityLabel?: string;\n /** Individual item name used by various text labels */\n name?: string;\n /** Id of the element the item onClick controls */\n ariaControls?: string;\n /** Tells screen reader the controlled element is expanded */\n ariaExpanded?: boolean;\n /** Unique identifier for the item */\n id: string;\n /** Content for the media area at the left of the item, usually an Avatar or Thumbnail */\n media?: React.ReactElement;\n /** Makes the shortcut actions always visible */\n persistActions?: boolean;\n /** 1 or 2 shortcut actions; must be available on the page linked to by url */\n shortcutActions?: DisableableAction[];\n /** The order the item is rendered */\n sortOrder?: number;\n /** URL for the resource’s details page (required unless onClick is provided) */\n url?: string;\n /** Allows url to open in a new tab */\n external?: boolean;\n /** Callback when clicked (required if url is omitted) */\n onClick?(id?: string): void;\n /** Content for the details area */\n children?: React.ReactNode;\n /** Adjust vertical alignment of elements */\n verticalAlignment?: Alignment;\n /** Prefetched url attribute to bind to the main element being returned */\n dataHref?: string;\n}" + "value": "interface PropsWithUrl extends BaseProps {\n url: string;\n onClick?(id?: string): void;\n}" } }, - "PropsWithUrl": { + "PropsWithClick": { "polaris-react/src/components/ResourceItem/ResourceItem.tsx": { "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", - "name": "PropsWithUrl", + "name": "PropsWithClick", "description": "", "members": [ { @@ -15925,15 +16628,15 @@ "syntaxKind": "PropertySignature", "name": "url", "value": "string", - "description": "URL for the resource’s details page (required unless onClick is provided)" + "description": "URL for the resource’s details page (required unless onClick is provided)", + "isOptional": true }, { "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", "syntaxKind": "MethodSignature", "name": "onClick", "value": "(id?: string) => void", - "description": "Callback when clicked (required if url is omitted)", - "isOptional": true + "description": "Callback when clicked (required if url is omitted)" }, { "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", @@ -16039,168 +16742,234 @@ "isOptional": true } ], - "value": "interface PropsWithUrl extends BaseProps {\n url: string;\n onClick?(id?: string): void;\n}" + "value": "interface PropsWithClick extends BaseProps {\n url?: string;\n onClick(id?: string): void;\n}" } }, - "PropsWithClick": { + "ResourceItemProps": { "polaris-react/src/components/ResourceItem/ResourceItem.tsx": { "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", - "name": "PropsWithClick", + "syntaxKind": "TypeAliasDeclaration", + "name": "ResourceItemProps", + "value": "PropsWithUrl | PropsWithClick", + "description": "" + } + }, + "PropsFromWrapper": { + "polaris-react/src/components/ResourceItem/ResourceItem.tsx": { + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "name": "PropsFromWrapper", "description": "", "members": [ { "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "URL for the resource’s details page (required unless onClick is provided)", - "isOptional": true + "name": "context", + "value": "React.ContextType>", + "description": "" }, { "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "(id?: string) => void", - "description": "Callback when clicked (required if url is omitted)" + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "" + } + ], + "value": "interface PropsFromWrapper {\n context: React.ContextType;\n i18n: ReturnType;\n}" + } + }, + "ResourceListProps": { + "polaris-react/src/components/ResourceList/ResourceList.tsx": { + "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", + "name": "ResourceListProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", + "syntaxKind": "PropertySignature", + "name": "items", + "value": "TItemType[]", + "description": "Item data; each item is passed to renderItem" }, { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Visually hidden text for screen readers used for item link", + "name": "filterControl", + "value": "React.ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "Individual item name used by various text labels", + "name": "emptyState", + "value": "React.ReactNode", + "description": "The markup to display when no resources exist yet. Renders when set and items is empty.", "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", "syntaxKind": "PropertySignature", - "name": "ariaControls", - "value": "string", - "description": "Id of the element the item onClick controls", + "name": "emptySearchState", + "value": "React.ReactNode", + "description": "The markup to display when no results are returned on search or filter of the list. Renders when `filterControl` is set, items are empty, and `emptyState` is not set.", + "isOptional": true, + "defaultValue": "EmptySearchResult" + }, + { + "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", + "syntaxKind": "PropertySignature", + "name": "resourceName", + "value": "{ singular: string; plural: string; }", + "description": "Name of the resource, such as customers or products", "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", "syntaxKind": "PropertySignature", - "name": "ariaExpanded", - "value": "boolean", - "description": "Tells screen reader the controlled element is expanded", + "name": "promotedBulkActions", + "value": "(MenuGroupDescriptor | BulkAction)[]", + "description": "Up to 2 bulk actions that will be given more prominence", "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Unique identifier for the item" + "name": "bulkActions", + "value": "(ActionListSection | BulkAction)[]", + "description": "Actions available on the currently selected items", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", "syntaxKind": "PropertySignature", - "name": "media", - "value": "React.ReactElement", - "description": "Content for the media area at the left of the item, usually an Avatar or Thumbnail", + "name": "selectedItems", + "value": "ResourceListSelectedItems", + "description": "Collection of IDs for the currently selected items", "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", "syntaxKind": "PropertySignature", - "name": "persistActions", + "name": "isFiltered", "value": "boolean", - "description": "Makes the shortcut actions always visible", + "description": "Whether or not the list has filter(s) applied", "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", "syntaxKind": "PropertySignature", - "name": "shortcutActions", - "value": "DisableableAction[]", - "description": "1 or 2 shortcut actions; must be available on the page linked to by url", + "name": "selectable", + "value": "boolean", + "description": "Renders a Select All button at the top of the list and checkboxes in front of each list item. For use when bulkActions aren't provided. *", "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", "syntaxKind": "PropertySignature", - "name": "sortOrder", - "value": "number", - "description": "The order the item is rendered", + "name": "hasMoreItems", + "value": "boolean", + "description": "Whether or not there are more items than currently set on the items prop. Determines whether or not to set the paginatedSelectAllAction and paginatedSelectAllText props on the BulkActions component.", "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", "syntaxKind": "PropertySignature", - "name": "external", + "name": "loading", "value": "boolean", - "description": "Allows url to open in a new tab", + "description": "Overlays item list with a spinner while a background action is being performed", "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Content for the details area", + "name": "showHeader", + "value": "boolean", + "description": "Boolean to show or hide the header", "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", "syntaxKind": "PropertySignature", - "name": "verticalAlignment", - "value": "Alignment", - "description": "Adjust vertical alignment of elements", + "name": "totalItemsCount", + "value": "number", + "description": "Total number of resources", "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", "syntaxKind": "PropertySignature", - "name": "dataHref", + "name": "sortValue", "value": "string", - "description": "Prefetched url attribute to bind to the main element being returned", + "description": "Current value of the sort control", "isOptional": true - } - ], - "value": "interface PropsWithClick extends BaseProps {\n url?: string;\n onClick(id?: string): void;\n}" - } - }, - "ResourceItemProps": { - "polaris-react/src/components/ResourceItem/ResourceItem.tsx": { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "ResourceItemProps", - "value": "PropsWithUrl | PropsWithClick", - "description": "" - } - }, - "PropsFromWrapper": { - "polaris-react/src/components/ResourceItem/ResourceItem.tsx": { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", - "name": "PropsFromWrapper", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", "syntaxKind": "PropertySignature", - "name": "context", - "value": "React.ContextType>", - "description": "" + "name": "sortOptions", + "value": "SelectOption[]", + "description": "Collection of sort options to choose from", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "" + "name": "alternateTool", + "value": "React.ReactNode", + "description": "ReactNode to display instead of the sort control", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", + "syntaxKind": "MethodSignature", + "name": "onSortChange", + "value": "(selected: string, id: string) => void", + "description": "Callback when sort option is changed", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", + "syntaxKind": "MethodSignature", + "name": "onSelectionChange", + "value": "(selectedItems: ResourceListSelectedItems) => void", + "description": "Callback when selection is changed", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", + "syntaxKind": "MethodSignature", + "name": "renderItem", + "value": "(item: TItemType, id: string, index: number) => React.ReactNode", + "description": "Function to render each list item, must return a ResourceItem component" + }, + { + "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", + "syntaxKind": "MethodSignature", + "name": "idForItem", + "value": "(item: TItemType, index: number) => string", + "description": "Function to customize the unique ID for each item", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", + "syntaxKind": "MethodSignature", + "name": "resolveItemId", + "value": "(item: TItemType) => string", + "description": "Function to resolve the ids of items", + "isOptional": true } ], - "value": "interface PropsFromWrapper {\n context: React.ContextType;\n i18n: ReturnType;\n}" + "value": "export interface ResourceListProps {\n /** Item data; each item is passed to renderItem */\n items: TItemType[];\n filterControl?: React.ReactNode;\n /** The markup to display when no resources exist yet. Renders when set and items is empty. */\n emptyState?: React.ReactNode;\n /** The markup to display when no results are returned on search or filter of the list. Renders when `filterControl` is set, items are empty, and `emptyState` is not set.\n * @default EmptySearchResult\n */\n emptySearchState?: React.ReactNode;\n /** Name of the resource, such as customers or products */\n resourceName?: {\n singular: string;\n plural: string;\n };\n /** Up to 2 bulk actions that will be given more prominence */\n promotedBulkActions?: BulkActionsProps['promotedActions'];\n /** Actions available on the currently selected items */\n bulkActions?: BulkActionsProps['actions'];\n /** Collection of IDs for the currently selected items */\n selectedItems?: ResourceListSelectedItems;\n /** Whether or not the list has filter(s) applied */\n isFiltered?: boolean;\n /** Renders a Select All button at the top of the list and checkboxes in front of each list item. For use when bulkActions aren't provided. **/\n selectable?: boolean;\n /** Whether or not there are more items than currently set on the items prop. Determines whether or not to set the paginatedSelectAllAction and paginatedSelectAllText props on the BulkActions component. */\n hasMoreItems?: boolean;\n /** Overlays item list with a spinner while a background action is being performed */\n loading?: boolean;\n /** Boolean to show or hide the header */\n showHeader?: boolean;\n /** Total number of resources */\n totalItemsCount?: number;\n /** Current value of the sort control */\n sortValue?: string;\n /** Collection of sort options to choose from */\n sortOptions?: SelectOption[];\n /** ReactNode to display instead of the sort control */\n alternateTool?: React.ReactNode;\n /** Callback when sort option is changed */\n onSortChange?(selected: string, id: string): void;\n /** Callback when selection is changed */\n onSelectionChange?(selectedItems: ResourceListSelectedItems): void;\n /** Function to render each list item, must return a ResourceItem component */\n renderItem(item: TItemType, id: string, index: number): React.ReactNode;\n /** Function to customize the unique ID for each item */\n idForItem?(item: TItemType, index: number): string;\n /** Function to resolve the ids of items */\n resolveItemId?(item: TItemType): string;\n}" + } + }, + "ResourceListType": { + "polaris-react/src/components/ResourceList/ResourceList.tsx": { + "filePath": "polaris-react/src/components/ResourceList/ResourceList.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ResourceListType", + "value": "((\n value: ResourceListProps,\n) => ReactElement) & {\n Item: typeof ResourceItem;\n}", + "description": "" } }, "ScrollableProps": { @@ -16673,25 +17442,6 @@ "value": "export interface SheetProps {\n /** Whether or not the sheet is open */\n open: boolean;\n /** The child elements to render in the sheet */\n children: React.ReactNode;\n /** Callback when the backdrop is clicked or `ESC` is pressed */\n onClose(): void;\n /** Callback when the sheet has completed entering */\n onEntered?(): void;\n /** Callback when the sheet has started to exit */\n onExit?(): void;\n /** ARIA label for sheet */\n accessibilityLabel: string;\n /** The element or the RefObject that activates the Sheet */\n activator?: React.RefObject | React.ReactElement;\n}" } }, - "SkeletonDisplayTextProps": { - "polaris-react/src/components/SkeletonDisplayText/SkeletonDisplayText.tsx": { - "filePath": "polaris-react/src/components/SkeletonDisplayText/SkeletonDisplayText.tsx", - "name": "SkeletonDisplayTextProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/SkeletonDisplayText/SkeletonDisplayText.tsx", - "syntaxKind": "PropertySignature", - "name": "size", - "value": "Size", - "description": "Size of the text", - "isOptional": true, - "defaultValue": "'medium'" - } - ], - "value": "export interface SkeletonDisplayTextProps {\n /**\n * Size of the text\n * @default 'medium'\n */\n size?: Size;\n}" - } - }, "SkeletonBodyTextProps": { "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx": { "filePath": "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx", @@ -16711,6 +17461,25 @@ "value": "export interface SkeletonBodyTextProps {\n /**\n * Number of lines to display\n * @default 3\n */\n lines?: number;\n}" } }, + "SkeletonDisplayTextProps": { + "polaris-react/src/components/SkeletonDisplayText/SkeletonDisplayText.tsx": { + "filePath": "polaris-react/src/components/SkeletonDisplayText/SkeletonDisplayText.tsx", + "name": "SkeletonDisplayTextProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/SkeletonDisplayText/SkeletonDisplayText.tsx", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "Size", + "description": "Size of the text", + "isOptional": true, + "defaultValue": "'medium'" + } + ], + "value": "export interface SkeletonDisplayTextProps {\n /**\n * Size of the text\n * @default 'medium'\n */\n size?: Size;\n}" + } + }, "SkeletonPageProps": { "polaris-react/src/components/SkeletonPage/SkeletonPage.tsx": { "filePath": "polaris-react/src/components/SkeletonPage/SkeletonPage.tsx", @@ -16954,33 +17723,6 @@ "description": "" } }, - "SubheadingProps": { - "polaris-react/src/components/Subheading/Subheading.tsx": { - "filePath": "polaris-react/src/components/Subheading/Subheading.tsx", - "name": "SubheadingProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Subheading/Subheading.tsx", - "syntaxKind": "PropertySignature", - "name": "element", - "value": "HeadingTagName", - "description": "The element name to use for the subheading", - "isOptional": true, - "defaultValue": "'h3'" - }, - { - "filePath": "polaris-react/src/components/Subheading/Subheading.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Text to display in subheading", - "isOptional": true - } - ], - "value": "export interface SubheadingProps {\n /**\n * The element name to use for the subheading\n * @default 'h3'\n */\n element?: HeadingTagName;\n /** Text to display in subheading */\n children?: React.ReactNode;\n}" - } - }, "TabsProps": { "polaris-react/src/components/Tabs/Tabs.tsx": { "filePath": "polaris-react/src/components/Tabs/Tabs.tsx", @@ -17037,6 +17779,42 @@ "value": "export interface TabsProps {\n /** Content to display in tabs */\n children?: React.ReactNode;\n /** Index of selected tab */\n selected: number;\n /** List of tabs */\n tabs: TabDescriptor[];\n /** Fit tabs to container */\n fitted?: boolean;\n /** Text to replace disclosures horizontal dots */\n disclosureText?: string;\n /** Callback when tab is selected */\n onSelect?(selectedTabIndex: number): void;\n}" } }, + "SubheadingProps": { + "polaris-react/src/components/Subheading/Subheading.tsx": { + "filePath": "polaris-react/src/components/Subheading/Subheading.tsx", + "name": "SubheadingProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Subheading/Subheading.tsx", + "syntaxKind": "PropertySignature", + "name": "element", + "value": "HeadingTagName", + "description": "The element name to use for the subheading", + "isOptional": true, + "defaultValue": "'h3'" + }, + { + "filePath": "polaris-react/src/components/Subheading/Subheading.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Text to display in subheading", + "isOptional": true + } + ], + "value": "export interface SubheadingProps {\n /**\n * The element name to use for the subheading\n * @default 'h3'\n */\n element?: HeadingTagName;\n /** Text to display in subheading */\n children?: React.ReactNode;\n}" + } + }, + "TagProps": { + "polaris-react/src/components/Tag/Tag.tsx": { + "filePath": "polaris-react/src/components/Tag/Tag.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "TagProps", + "value": "NonMutuallyExclusiveProps & (\n | {onClick?(): void; onRemove?: undefined; url?: undefined}\n | {onClick?: undefined; onRemove?(): void; url?: string}\n )", + "description": "" + } + }, "Element": { "polaris-react/src/components/Text/Text.tsx": { "filePath": "polaris-react/src/components/Text/Text.tsx", @@ -17135,15 +17913,6 @@ "value": "export interface TextProps {\n /** Adjust horizontal alignment of text */\n alignment?: Alignment;\n /** The element type */\n as: Element;\n /** Text to display */\n children: ReactNode;\n /** Adjust color of text */\n color?: Color;\n /** Adjust weight of text */\n fontWeight?: FontWeight;\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}" } }, - "TagProps": { - "polaris-react/src/components/Tag/Tag.tsx": { - "filePath": "polaris-react/src/components/Tag/Tag.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "TagProps", - "value": "NonMutuallyExclusiveProps & (\n | {onClick?(): void; onRemove?: undefined; url?: undefined}\n | {onClick?: undefined; onRemove?(): void; url?: string}\n )", - "description": "" - } - }, "TextContainerProps": { "polaris-react/src/components/TextContainer/TextContainer.tsx": { "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", @@ -17411,6 +18180,37 @@ "value": "export interface ThumbnailProps {\n /**\n * Size of thumbnail\n * @default 'medium'\n */\n size?: Size;\n /** URL for the image */\n source: string | React.FunctionComponent>;\n /** Alt text for the thumbnail image */\n alt: string;\n /** Transparent background */\n transparent?: boolean;\n}" } }, + "TileProps": { + "polaris-react/src/components/Tile/Tile.tsx": { + "filePath": "polaris-react/src/components/Tile/Tile.tsx", + "name": "TileProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Tile/Tile.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Elements to display inside tile" + }, + { + "filePath": "polaris-react/src/components/Tile/Tile.tsx", + "syntaxKind": "PropertySignature", + "name": "spacing", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Adjust spacing between elements" + }, + { + "filePath": "polaris-react/src/components/Tile/Tile.tsx", + "syntaxKind": "PropertySignature", + "name": "columns", + "value": "Columns", + "description": "Adjust number of columns" + } + ], + "value": "export interface TileProps {\n /** Elements to display inside tile */\n children: React.ReactNode;\n /** Adjust spacing between elements */\n spacing: Spacing;\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", @@ -21391,50 +22191,243 @@ "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", + "MenuGroupProps": { + "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "name": "MenuGroupProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "section", - "value": "ActionListSection", - "description": "Section of action items" + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden menu description for screen readers", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "hasMultipleSections", + "name": "active", "value": "boolean", - "description": "Should there be multiple sections" + "description": "Whether or not the menu is open", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "actionRole", - "value": "string", - "description": "Defines a specific role attribute for each action in the list", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "(openActions: () => void) => void", + "description": "Callback when the menu is clicked", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any item is clicked or keypressed", - "isOptional": true - } - ], - "value": "export interface SectionProps {\n /** Section of action items */\n section: ActionListSection;\n /** Should there be multiple sections */\n hasMultipleSections: boolean;\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'option' | 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" - }, - "polaris-react/src/components/Layout/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "onOpen", + "value": "(title: string) => void", + "description": "Callback for opening the MenuGroup by title" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "onClose", + "value": "(title: string) => void", + "description": "Callback for closing the MenuGroup by title" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "getOffsetWidth", + "value": "(width: number) => void", + "description": "Callback for getting the offsetWidth of the MenuGroup", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "sections", + "value": "readonly ActionListSection[]", + "description": "Collection of sectioned action items", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "Menu group title" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "actions", + "value": "ActionListItemDescriptor[]", + "description": "List of actions" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "any", + "description": "Icon to display", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "details", + "value": "React.ReactNode", + "description": "Action details", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Disables action button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "index", + "value": "number", + "description": "Zero-indexed numerical position. Overrides the group's order in the menu.", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any action takes place", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "badge", + "value": "{ status: \"new\"; content: string; }", + "description": "", + "isOptional": true + } + ], + "value": "export interface MenuGroupProps extends MenuGroupDescriptor {\n /** Visually hidden menu description for screen readers */\n accessibilityLabel?: string;\n /** Whether or not the menu is open */\n active?: boolean;\n /** Callback when the menu is clicked */\n onClick?(openActions: () => void): void;\n /** Callback for opening the MenuGroup by title */\n onOpen(title: string): void;\n /** Callback for closing the MenuGroup by title */\n onClose(title: string): void;\n /** Callback for getting the offsetWidth of the MenuGroup */\n getOffsetWidth?(width: number): void;\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n}" + } + }, + "MeasuredActions": { + "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "name": "MeasuredActions", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "syntaxKind": "PropertySignature", + "name": "showable", + "value": "MenuActionDescriptor[]", + "description": "" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "syntaxKind": "PropertySignature", + "name": "rolledUp", + "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", + "description": "" + } + ], + "value": "interface MeasuredActions {\n showable: MenuActionDescriptor[];\n rolledUp: (MenuActionDescriptor | MenuGroupDescriptor)[];\n}" + } + }, + "RollupActionsProps": { + "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "name": "RollupActionsProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "Accessibilty label", + "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": "" + } + }, + "SectionProps": { + "polaris-react/src/components/ActionList/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "section", + "value": "ActionListSection", + "description": "Section of action items" + }, + { + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "hasMultipleSections", + "value": "boolean", + "description": "Should there be multiple sections" + }, + { + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "actionRole", + "value": "string", + "description": "Defines a specific role attribute for each action in the list", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any item is clicked or keypressed", + "isOptional": true + } + ], + "value": "export interface SectionProps {\n /** Section of action items */\n section: ActionListSection;\n /** Should there be multiple sections */\n hasMultipleSections: boolean;\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'option' | 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" + }, + "polaris-react/src/components/Layout/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ { "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", @@ -21629,188 +22622,38 @@ "value": "export interface SectionProps {\n children?: React.ReactNode;\n}" } }, - "MeasuredActions": { - "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "name": "MeasuredActions", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "syntaxKind": "PropertySignature", - "name": "showable", - "value": "MenuActionDescriptor[]", - "description": "" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "syntaxKind": "PropertySignature", - "name": "rolledUp", - "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", - "description": "" - } - ], - "value": "interface MeasuredActions {\n showable: MenuActionDescriptor[];\n rolledUp: (MenuActionDescriptor | MenuGroupDescriptor)[];\n}" - } - }, - "MenuGroupProps": { - "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "name": "MenuGroupProps", + "PipProps": { + "polaris-react/src/components/Badge/components/Pip/Pip.tsx": { + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "name": "PipProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Visually hidden menu description for screen readers", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "active", - "value": "boolean", - "description": "Whether or not the menu is open", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "(openActions: () => void) => void", - "description": "Callback when the menu is clicked", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "onOpen", - "value": "(title: string) => void", - "description": "Callback for opening the MenuGroup by title" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "onClose", - "value": "(title: string) => void", - "description": "Callback for closing the MenuGroup by title" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "getOffsetWidth", - "value": "(width: number) => void", - "description": "Callback for getting the offsetWidth of the MenuGroup", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "sections", - "value": "readonly ActionListSection[]", - "description": "Collection of sectioned action items", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "Menu group title" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "actions", - "value": "ActionListItemDescriptor[]", - "description": "List of actions" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "Icon to display", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "details", - "value": "React.ReactNode", - "description": "Action details", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables action button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "index", - "value": "number", - "description": "Zero-indexed numerical position. Overrides the group's order in the menu.", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any action takes place", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", "syntaxKind": "PropertySignature", - "name": "badge", - "value": "{ status: \"new\"; content: string; }", + "name": "status", + "value": "Status", "description": "", "isOptional": true - } - ], - "value": "export interface MenuGroupProps extends MenuGroupDescriptor {\n /** Visually hidden menu description for screen readers */\n accessibilityLabel?: string;\n /** Whether or not the menu is open */\n active?: boolean;\n /** Callback when the menu is clicked */\n onClick?(openActions: () => void): void;\n /** Callback for opening the MenuGroup by title */\n onOpen(title: string): void;\n /** Callback for closing the MenuGroup by title */\n onClose(title: string): void;\n /** Callback for getting the offsetWidth of the MenuGroup */\n getOffsetWidth?(width: number): void;\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n}" - } - }, - "RollupActionsProps": { - "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "name": "RollupActionsProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Accessibilty label", - "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", "syntaxKind": "PropertySignature", - "name": "items", - "value": "ActionListItemDescriptor[]", - "description": "Collection of actions for the list", + "name": "progress", + "value": "Progress", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", "syntaxKind": "PropertySignature", - "name": "sections", - "value": "ActionListSection[]", - "description": "Collection of sectioned action items", + "name": "accessibilityLabelOverride", + "value": "string", + "description": "", "isOptional": true } ], - "value": "export interface RollupActionsProps {\n /** Accessibilty label */\n accessibilityLabel?: string;\n /** Collection of actions for the list */\n items?: ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: ActionListSection[];\n}" + "value": "export interface PipProps {\n status?: Status;\n progress?: Progress;\n accessibilityLabelOverride?: string;\n}" } }, "SecondaryAction": { @@ -21871,7 +22714,7 @@ "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", "name": "size", - "value": "\"medium\" | \"large\" | \"slim\"", + "value": "\"large\" | \"medium\" | \"slim\"", "description": "Changes the size of the button, giving it more or less padding", "isOptional": true, "defaultValue": "'medium'" @@ -21880,7 +22723,7 @@ "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", "name": "textAlign", - "value": "\"left\" | \"right\" | \"center\" | \"start\" | \"end\"", + "value": "\"start\" | \"end\" | \"center\" | \"left\" | \"right\"", "description": "Changes the inner text alignment of the button", "isOptional": true }, @@ -22362,49 +23205,6 @@ "value": "interface MappedAction extends ActionListItemDescriptor {\n wrapOverflow?: boolean;\n}" } }, - "MappedOption": { - "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx": { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "MappedOption", - "value": "ArrayElement & {\n selected: boolean;\n singleSelection: boolean;\n}", - "description": "" - } - }, - "PipProps": { - "polaris-react/src/components/Badge/components/Pip/Pip.tsx": { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", - "name": "PipProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", - "syntaxKind": "PropertySignature", - "name": "status", - "value": "Status", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", - "syntaxKind": "PropertySignature", - "name": "progress", - "value": "Progress", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabelOverride", - "value": "string", - "description": "", - "isOptional": true - } - ], - "value": "export interface PipProps {\n status?: Status;\n progress?: Progress;\n accessibilityLabelOverride?: string;\n}" - } - }, "BulkActionButtonProps": { "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx": { "filePath": "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx", @@ -22619,6 +23419,30 @@ "value": "export interface CardSubsectionProps {\n children?: React.ReactNode;\n}" } }, + "HuePickerProps": { + "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx": { + "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", + "name": "HuePickerProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", + "syntaxKind": "PropertySignature", + "name": "hue", + "value": "number", + "description": "" + }, + { + "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", + "syntaxKind": "MethodSignature", + "name": "onChange", + "value": "(hue: number) => void", + "description": "" + } + ], + "value": "export interface HuePickerProps {\n hue: number;\n onChange(hue: number): void;\n}" + } + }, "AlphaPickerProps": { "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx": { "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", @@ -22650,28 +23474,13 @@ "value": "export interface AlphaPickerProps {\n color: HSBColor;\n alpha: number;\n onChange(hue: number): void;\n}" } }, - "HuePickerProps": { - "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx": { - "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", - "name": "HuePickerProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", - "syntaxKind": "PropertySignature", - "name": "hue", - "value": "number", - "description": "" - }, - { - "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", - "syntaxKind": "MethodSignature", - "name": "onChange", - "value": "(hue: number) => void", - "description": "" - } - ], - "value": "export interface HuePickerProps {\n hue: number;\n onChange(hue: number): void;\n}" + "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": "" } }, "Position": { @@ -22739,15 +23548,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", @@ -23630,23 +24430,6 @@ "value": "export interface CSSAnimationProps {\n in: boolean;\n className: string;\n type: AnimationType;\n children?: React.ReactNode;\n}" } }, - "ToastManagerProps": { - "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx": { - "filePath": "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx", - "name": "ToastManagerProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx", - "syntaxKind": "PropertySignature", - "name": "toastMessages", - "value": "ToastPropsWithID[]", - "description": "" - } - ], - "value": "export interface ToastManagerProps {\n toastMessages: ToastPropsWithID[];\n}" - } - }, "Cell": { "polaris-react/src/components/Grid/components/Cell/Cell.tsx": { "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", @@ -23761,6 +24544,23 @@ "value": "export interface RowProps {\n children: React.ReactNode;\n id: string;\n selected?: boolean;\n position: number;\n subdued?: boolean;\n status?: RowStatus;\n disabled?: boolean;\n onNavigation?(id: string): void;\n onClick?(): void;\n}" } }, + "ToastManagerProps": { + "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx": { + "filePath": "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx", + "name": "ToastManagerProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx", + "syntaxKind": "PropertySignature", + "name": "toastMessages", + "value": "ToastPropsWithID[]", + "description": "" + } + ], + "value": "export interface ToastManagerProps {\n toastMessages: ToastPropsWithID[];\n}" + } + }, "ScrollContainerProps": { "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx": { "filePath": "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx", @@ -24287,40 +25087,6 @@ "value": "export interface CloseButtonProps {\n titleHidden?: boolean;\n onClick(): void;\n}" } }, - "FooterProps": { - "polaris-react/src/components/Modal/components/Footer/Footer.tsx": { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", - "name": "FooterProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", - "syntaxKind": "PropertySignature", - "name": "primaryAction", - "value": "ComplexAction", - "description": "Primary action", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", - "syntaxKind": "PropertySignature", - "name": "secondaryActions", - "value": "ComplexAction[]", - "description": "Collection of secondary actions", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to display inside modal", - "isOptional": true - } - ], - "value": "export interface FooterProps {\n /** Primary action */\n primaryAction?: ComplexAction;\n /** Collection of secondary actions */\n secondaryActions?: ComplexAction[];\n /** The content to display inside modal */\n children?: React.ReactNode;\n}" - } - }, "DialogProps": { "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx": { "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", @@ -24418,6 +25184,40 @@ "value": "export interface DialogProps {\n labelledBy?: string;\n instant?: boolean;\n children?: React.ReactNode;\n limitHeight?: boolean;\n large?: boolean;\n small?: boolean;\n onClose(): void;\n onEntered?(): void;\n onExited?(): void;\n in?: boolean;\n fullScreen?: boolean;\n}" } }, + "FooterProps": { + "polaris-react/src/components/Modal/components/Footer/Footer.tsx": { + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "name": "FooterProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "syntaxKind": "PropertySignature", + "name": "primaryAction", + "value": "ComplexAction", + "description": "Primary action", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "syntaxKind": "PropertySignature", + "name": "secondaryActions", + "value": "ComplexAction[]", + "description": "Collection of secondary actions", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The content to display inside modal", + "isOptional": true + } + ], + "value": "export interface FooterProps {\n /** Primary action */\n primaryAction?: ComplexAction;\n /** Collection of secondary actions */\n secondaryActions?: ComplexAction[];\n /** The content to display inside modal */\n children?: React.ReactNode;\n}" + } + }, "ItemURLDetails": { "polaris-react/src/components/Navigation/components/Item/Item.tsx": { "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", @@ -24702,23 +25502,73 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", + "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "any", + "description": "Source of the icon", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", + "syntaxKind": "PropertySignature", + "name": "helpText", + "value": "React.ReactNode", + "description": "Text content to render in a tooltip", + "isOptional": true + } + ], + "value": "interface PrimaryAction\n extends DestructableAction,\n DisableableAction,\n LoadableAction,\n IconableAction,\n TooltipAction {\n /** Provides extra visual weight and identifies the primary action in a set of buttons */\n primary?: boolean;\n}" + } + }, + "PaneProps": { + "polaris-react/src/components/Popover/components/Pane/Pane.tsx": { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "name": "PaneProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "fixed", + "value": "boolean", + "description": "Fix the pane to the top of the popover", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "sectioned", + "value": "boolean", + "description": "Automatically wrap children in padded sections", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The pane content", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "Source of the icon", + "name": "height", + "value": "string", + "description": "Sets a fixed height and max-height on the Scrollable", "isOptional": true }, { - "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", - "syntaxKind": "PropertySignature", - "name": "helpText", - "value": "React.ReactNode", - "description": "Text content to render in a tooltip", + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "MethodSignature", + "name": "onScrolledToBottom", + "value": "() => void", + "description": "Callback when the bottom of the popover is reached by mouse or keyboard", "isOptional": true } ], - "value": "interface PrimaryAction\n extends DestructableAction,\n DisableableAction,\n LoadableAction,\n IconableAction,\n TooltipAction {\n /** Provides extra visual weight and identifies the primary action in a set of buttons */\n primary?: boolean;\n}" + "value": "export interface PaneProps {\n /** Fix the pane to the top of the popover */\n fixed?: boolean;\n /** Automatically wrap children in padded sections */\n sectioned?: boolean;\n /** The pane content */\n children?: React.ReactNode;\n /** Sets a fixed height and max-height on the Scrollable */\n height?: string;\n /** Callback when the bottom of the popover is reached by mouse or keyboard */\n onScrolledToBottom?(): void;\n}" } }, "PopoverCloseSource": { @@ -24902,56 +25752,6 @@ "value": "export interface PopoverOverlayProps {\n children?: React.ReactNode;\n fullWidth?: boolean;\n fullHeight?: boolean;\n fluidContent?: boolean;\n preferredPosition?: PositionedOverlayProps['preferredPosition'];\n preferredAlignment?: PositionedOverlayProps['preferredAlignment'];\n active: boolean;\n id: string;\n zIndexOverride?: number;\n activator: HTMLElement;\n preferInputActivator?: PositionedOverlayProps['preferInputActivator'];\n sectioned?: boolean;\n fixed?: boolean;\n hideOnPrint?: boolean;\n onClose(source: PopoverCloseSource): void;\n autofocusTarget?: PopoverAutofocusTarget;\n preventCloseOnChildOverlayClick?: boolean;\n}" } }, - "PaneProps": { - "polaris-react/src/components/Popover/components/Pane/Pane.tsx": { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "name": "PaneProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "fixed", - "value": "boolean", - "description": "Fix the pane to the top of the popover", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "sectioned", - "value": "boolean", - "description": "Automatically wrap children in padded sections", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The pane content", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "height", - "value": "string", - "description": "Sets a fixed height and max-height on the Scrollable", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "MethodSignature", - "name": "onScrolledToBottom", - "value": "() => void", - "description": "Callback when the bottom of the popover is reached by mouse or keyboard", - "isOptional": true - } - ], - "value": "export interface PaneProps {\n /** Fix the pane to the top of the popover */\n fixed?: boolean;\n /** Automatically wrap children in padded sections */\n sectioned?: boolean;\n /** The pane content */\n children?: React.ReactNode;\n /** Sets a fixed height and max-height on the Scrollable */\n height?: string;\n /** Callback when the bottom of the popover is reached by mouse or keyboard */\n onScrolledToBottom?(): void;\n}" - } - }, "PolarisContainerProps": { "polaris-react/src/components/PortalsManager/components/PortalsContainer/PortalsContainer.tsx": { "filePath": "polaris-react/src/components/PortalsManager/components/PortalsContainer/PortalsContainer.tsx", @@ -24961,56 +25761,56 @@ "value": "export interface PolarisContainerProps {}" } }, - "DualThumbProps": { - "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx": { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "name": "DualThumbProps", + "SingleThumbProps": { + "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx": { + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "name": "SingleThumbProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "value", - "value": "DualValue", + "value": "number", "description": "Initial value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "id", "value": "string", "description": "ID for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "min", "value": "number", "description": "Minimum possible value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "max", "value": "number", "description": "Maximum possible value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "step", "value": "number", "description": "Increment value for range input changes" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "label", "value": "ReactNode", "description": "Label for the range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "labelAction", "value": "Action", @@ -25018,7 +25818,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "labelHidden", "value": "boolean", @@ -25026,7 +25826,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "output", "value": "boolean", @@ -25034,7 +25834,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "helpText", "value": "ReactNode", @@ -25042,7 +25842,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "error", "value": "any", @@ -25050,7 +25850,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", @@ -25058,7 +25858,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "prefix", "value": "ReactNode", @@ -25066,7 +25866,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "suffix", "value": "ReactNode", @@ -25074,14 +25874,14 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "MethodSignature", "name": "onChange", "value": "(value: RangeSliderValue, id: string) => void", "description": "Callback when the range input is changed" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "MethodSignature", "name": "onFocus", "value": "() => void", @@ -25089,7 +25889,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "MethodSignature", "name": "onBlur", "value": "() => void", @@ -25097,94 +25897,59 @@ "isOptional": true } ], - "value": "export interface DualThumbProps extends RangeSliderProps {\n value: DualValue;\n id: string;\n min: number;\n max: number;\n step: number;\n}" + "value": "export interface SingleThumbProps extends RangeSliderProps {\n value: number;\n id: string;\n min: number;\n max: number;\n step: number;\n}" } }, - "KeyHandlers": { + "DualThumbProps": { "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx": { "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "name": "KeyHandlers", + "name": "DualThumbProps", "description": "", "members": [ { "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "name": "[key: string]", - "value": "() => void" - } - ], - "value": "interface KeyHandlers {\n [key: string]: () => void;\n}" - } - }, - "Control": { - "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx": { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "syntaxKind": "EnumDeclaration", - "name": "Control", - "value": "enum Control {\n Lower,\n Upper,\n}", - "members": [ - { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "name": "Lower", - "value": 0 - }, - { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "name": "Upper", - "value": 1 - } - ] - } - }, - "SingleThumbProps": { - "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx": { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", - "name": "SingleThumbProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "value", - "value": "number", + "value": "DualValue", "description": "Initial value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "id", "value": "string", "description": "ID for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "min", "value": "number", "description": "Minimum possible value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "max", "value": "number", "description": "Maximum possible value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "step", "value": "number", "description": "Increment value for range input changes" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "label", "value": "ReactNode", "description": "Label for the range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "labelAction", "value": "Action", @@ -25192,7 +25957,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "labelHidden", "value": "boolean", @@ -25200,7 +25965,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "output", "value": "boolean", @@ -25208,7 +25973,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "helpText", "value": "ReactNode", @@ -25216,7 +25981,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "error", "value": "any", @@ -25224,54 +25989,129 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Disable input", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "ReactNode", + "description": "Element to display before the input", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "syntaxKind": "PropertySignature", + "name": "suffix", + "value": "ReactNode", + "description": "Element to display after the input", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "syntaxKind": "MethodSignature", + "name": "onChange", + "value": "(value: RangeSliderValue, id: string) => void", + "description": "Callback when the range input is changed" + }, + { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "syntaxKind": "MethodSignature", + "name": "onFocus", + "value": "() => void", + "description": "Callback when range input is focused", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "syntaxKind": "MethodSignature", + "name": "onBlur", + "value": "() => void", + "description": "Callback when focus is removed", + "isOptional": true + } + ], + "value": "export interface DualThumbProps extends RangeSliderProps {\n value: DualValue;\n id: string;\n min: number;\n max: number;\n step: number;\n}" + } + }, + "KeyHandlers": { + "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx": { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "name": "KeyHandlers", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "name": "[key: string]", + "value": "() => void" + } + ], + "value": "interface KeyHandlers {\n [key: string]: () => void;\n}" + } + }, + "Control": { + "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx": { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "syntaxKind": "EnumDeclaration", + "name": "Control", + "value": "enum Control {\n Lower,\n Upper,\n}", + "members": [ + { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "name": "Lower", + "value": 0 + }, + { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "name": "Upper", + "value": 1 + } + ] + } + }, + "PanelProps": { + "polaris-react/src/components/Tabs/components/Panel/Panel.tsx": { + "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", + "name": "PanelProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", + "name": "hidden", "value": "boolean", - "description": "Disable input", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", "syntaxKind": "PropertySignature", - "name": "prefix", - "value": "ReactNode", - "description": "Element to display before the input", - "isOptional": true + "name": "id", + "value": "string", + "description": "" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", "syntaxKind": "PropertySignature", - "name": "suffix", - "value": "ReactNode", - "description": "Element to display after the input", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", - "syntaxKind": "MethodSignature", - "name": "onChange", - "value": "(value: RangeSliderValue, id: string) => void", - "description": "Callback when the range input is changed" - }, - { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", - "syntaxKind": "MethodSignature", - "name": "onFocus", - "value": "() => void", - "description": "Callback when range input is focused", - "isOptional": true + "name": "tabID", + "value": "string", + "description": "" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", - "syntaxKind": "MethodSignature", - "name": "onBlur", - "value": "() => void", - "description": "Callback when focus is removed", + "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true } ], - "value": "export interface SingleThumbProps extends RangeSliderProps {\n value: number;\n id: string;\n min: number;\n max: number;\n step: number;\n}" + "value": "export interface PanelProps {\n hidden?: boolean;\n id: string;\n tabID: string;\n children?: React.ReactNode;\n}" } }, "TabProps": { @@ -25363,87 +26203,6 @@ "value": "export interface TabProps {\n id: string;\n focused?: boolean;\n siblingTabHasFocus?: boolean;\n selected?: boolean;\n panelID?: string;\n children?: React.ReactNode;\n url?: string;\n measuring?: boolean;\n accessibilityLabel?: string;\n onClick?(id: string): void;\n}" } }, - "PanelProps": { - "polaris-react/src/components/Tabs/components/Panel/Panel.tsx": { - "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", - "name": "PanelProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", - "syntaxKind": "PropertySignature", - "name": "hidden", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", - "syntaxKind": "PropertySignature", - "name": "tabID", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "export interface PanelProps {\n hidden?: boolean;\n id: string;\n tabID: string;\n children?: React.ReactNode;\n}" - } - }, - "ResizerProps": { - "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx": { - "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", - "name": "ResizerProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", - "syntaxKind": "PropertySignature", - "name": "contents", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", - "syntaxKind": "PropertySignature", - "name": "currentHeight", - "value": "number", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", - "syntaxKind": "PropertySignature", - "name": "minimumLines", - "value": "number", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", - "syntaxKind": "MethodSignature", - "name": "onHeightChange", - "value": "(height: number) => void", - "description": "" - } - ], - "value": "export interface ResizerProps {\n contents?: string;\n currentHeight?: number | null;\n minimumLines?: number;\n onHeightChange(height: number): void;\n}" - } - }, "TabMeasurements": { "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx": { "filePath": "polaris-react/src/components/Tabs/components/TabMeasurer/TabMeasurer.tsx", @@ -25606,6 +26365,47 @@ "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}" } }, + "ResizerProps": { + "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx": { + "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", + "name": "ResizerProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", + "syntaxKind": "PropertySignature", + "name": "contents", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", + "syntaxKind": "PropertySignature", + "name": "currentHeight", + "value": "number", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", + "syntaxKind": "PropertySignature", + "name": "minimumLines", + "value": "number", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", + "syntaxKind": "MethodSignature", + "name": "onHeightChange", + "value": "(height: number) => void", + "description": "" + } + ], + "value": "export interface ResizerProps {\n contents?: string;\n currentHeight?: number | null;\n minimumLines?: number;\n onHeightChange(height: number): void;\n}" + } + }, "MenuProps": { "polaris-react/src/components/TopBar/components/Menu/Menu.tsx": { "filePath": "polaris-react/src/components/TopBar/components/Menu/Menu.tsx", @@ -25897,39 +26697,6 @@ "value": "export interface DiscardConfirmationModalProps {\n open: boolean;\n onDiscard(): void;\n onCancel(): void;\n}" } }, - "SecondaryProps": { - "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", - "name": "SecondaryProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", - "syntaxKind": "PropertySignature", - "name": "expanded", - "value": "boolean", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "", - "isOptional": true - } - ], - "value": "interface SecondaryProps {\n expanded: boolean;\n children?: React.ReactNode;\n id?: string;\n}" - } - }, "TitleProps": { "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx": { "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", @@ -25972,6 +26739,39 @@ "value": "export interface TitleProps {\n /** Page title, in large type */\n title?: string;\n /** Page subtitle, in regular type*/\n subtitle?: string;\n /** Important and non-interactive status information shown immediately after the title. */\n titleMetadata?: React.ReactNode;\n /** Removes spacing between title and subtitle */\n compactTitle?: boolean;\n}" } }, + "SecondaryProps": { + "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "name": "SecondaryProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "syntaxKind": "PropertySignature", + "name": "expanded", + "value": "boolean", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "interface SecondaryProps {\n expanded: boolean;\n children?: React.ReactNode;\n id?: string;\n}" + } + }, "MessageProps": { "polaris-react/src/components/TopBar/components/Menu/components/Message/Message.tsx": { "filePath": "polaris-react/src/components/TopBar/components/Menu/components/Message/Message.tsx", From af3d8cce8ab1b67780ece7cda5c4dea85e9ca453 Mon Sep 17 00:00:00 2001 From: Lo Kim Date: Mon, 26 Sep 2022 05:20:34 -1000 Subject: [PATCH 12/25] [Layout foundations] Add alpha pages in style guide for Box, Inline, Columns, Stack, and Tile (#7261) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Resolves #7256. We are planning on shipping the `layout-foundations-prototype` page and need pages in the style guide that clearly designates the layout components are still in alpha. Adds alpha pages and examples for Box, Inline, Columns, AlphaStack, and Tile.
AlphaStack alpha page AlphaStack alpha page
Box alpha page Box alpha page
Columns alpha page Columns alpha page
Inline alpha page Inline alpha page
Tile alpha page Tile alpha page
🖥 [Local development instructions](https://github.com/Shopify/polaris/blob/main/README.md#local-development) 🗒 [General tophatting guidelines](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md) 📄 [Changelog guidelines](https://github.com/Shopify/polaris/blob/main/.github/CONTRIBUTING.md#changelog) In your terminal: ```script // in `polaris` root directory $ yarn && yarn build $ cd polaris.shopify.com $ yarn && yarn dev ``` - [ ] Tested on [mobile](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md#cross-browser-testing) - [ ] Tested on [multiple browsers](https://help.shopify.com/en/manual/shopify-admin/supported-browsers) - [ ] Tested for [accessibility](https://github.com/Shopify/polaris/blob/main/documentation/Accessibility%20testing.md) - [ ] Updated the component's `README.md` with documentation changes - [x] [Tophatted documentation](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting%20documentation.md) changes in the style guide --- .changeset/green-cougars-sneeze.md | 5 + .../{Stack.scss => AlphaStack.scss} | 6 +- .../src/components/AlphaStack/AlphaStack.tsx | 4 +- .../src/components/Inline/Inline.tsx | 2 +- .../content/components/alpha-card/index.md | 2 +- .../content/components/alpha-stack/index.md | 21 + .../content/components/box/index.md | 31 + .../content/components/columns/index.md | 17 + .../content/components/inline/index.md | 21 + .../content/components/tile/index.md | 15 + .../pages/examples/alpha-card-subdued.tsx | 18 +- .../pages/examples/alpha-stack-default.tsx | 21 + .../pages/examples/alpha-stack-with-align.tsx | 66 + .../examples/alpha-stack-with-spacing.tsx | 66 + .../pages/examples/box-with-background.tsx | 33 + .../pages/examples/box-with-border-radius.tsx | 47 + .../pages/examples/box-with-border.tsx | 68 + .../pages/examples/box-with-margin.tsx | 53 + .../pages/examples/box-with-padding.tsx | 34 + .../pages/examples/columns-default.tsx | 21 + .../columns-with-free-and-fixed-widths.tsx | 24 + .../examples/columns-with-varying-gap.tsx | 21 + .../pages/examples/inline-default.tsx | 21 + .../pages/examples/inline-with-align-y.tsx | 76 + .../pages/examples/inline-with-align.tsx | 60 + .../pages/examples/tile-with-columns.tsx | 34 + .../pages/examples/tile-with-spacing.tsx | 34 + .../public/images/components/alpha-stack.png | Bin 0 -> 25923 bytes .../public/images/components/box.png | Bin 0 -> 25923 bytes .../public/images/components/columns.png | Bin 0 -> 25923 bytes .../public/images/components/inline.png | Bin 0 -> 25923 bytes .../public/images/components/tile.png | Bin 0 -> 25923 bytes polaris.shopify.com/src/data/props.json | 1967 +++++++++-------- 33 files changed, 1853 insertions(+), 935 deletions(-) create mode 100644 .changeset/green-cougars-sneeze.md rename polaris-react/src/components/AlphaStack/{Stack.scss => AlphaStack.scss} (70%) create mode 100644 polaris.shopify.com/content/components/alpha-stack/index.md create mode 100644 polaris.shopify.com/content/components/box/index.md create mode 100644 polaris.shopify.com/content/components/columns/index.md create mode 100644 polaris.shopify.com/content/components/inline/index.md create mode 100644 polaris.shopify.com/content/components/tile/index.md create mode 100644 polaris.shopify.com/pages/examples/alpha-stack-default.tsx create mode 100644 polaris.shopify.com/pages/examples/alpha-stack-with-align.tsx create mode 100644 polaris.shopify.com/pages/examples/alpha-stack-with-spacing.tsx create mode 100644 polaris.shopify.com/pages/examples/box-with-background.tsx create mode 100644 polaris.shopify.com/pages/examples/box-with-border-radius.tsx create mode 100644 polaris.shopify.com/pages/examples/box-with-border.tsx create mode 100644 polaris.shopify.com/pages/examples/box-with-margin.tsx create mode 100644 polaris.shopify.com/pages/examples/box-with-padding.tsx create mode 100644 polaris.shopify.com/pages/examples/columns-default.tsx create mode 100644 polaris.shopify.com/pages/examples/columns-with-free-and-fixed-widths.tsx create mode 100644 polaris.shopify.com/pages/examples/columns-with-varying-gap.tsx create mode 100644 polaris.shopify.com/pages/examples/inline-default.tsx create mode 100644 polaris.shopify.com/pages/examples/inline-with-align-y.tsx create mode 100644 polaris.shopify.com/pages/examples/inline-with-align.tsx create mode 100644 polaris.shopify.com/pages/examples/tile-with-columns.tsx create mode 100644 polaris.shopify.com/pages/examples/tile-with-spacing.tsx create mode 100644 polaris.shopify.com/public/images/components/alpha-stack.png create mode 100644 polaris.shopify.com/public/images/components/box.png create mode 100644 polaris.shopify.com/public/images/components/columns.png create mode 100644 polaris.shopify.com/public/images/components/inline.png create mode 100644 polaris.shopify.com/public/images/components/tile.png diff --git a/.changeset/green-cougars-sneeze.md b/.changeset/green-cougars-sneeze.md new file mode 100644 index 00000000000..12fe733a7aa --- /dev/null +++ b/.changeset/green-cougars-sneeze.md @@ -0,0 +1,5 @@ +--- +'polaris.shopify.com': minor +--- + +Added alpha pages for `AlphaStack`, `Box`, `Columns`, `Inline`, and `Tile` components. Updated `StatusBanner` to capitalize status value. diff --git a/polaris-react/src/components/AlphaStack/Stack.scss b/polaris-react/src/components/AlphaStack/AlphaStack.scss similarity index 70% rename from polaris-react/src/components/AlphaStack/Stack.scss rename to polaris-react/src/components/AlphaStack/AlphaStack.scss index 9860659b2c7..445951993b9 100644 --- a/polaris-react/src/components/AlphaStack/Stack.scss +++ b/polaris-react/src/components/AlphaStack/AlphaStack.scss @@ -1,6 +1,10 @@ -.Stack { +.AlphaStack { display: flex; flex-direction: column; align-items: var(--pc-stack-align); gap: var(--pc-stack-spacing); + + > * { + max-width: 100%; + } } diff --git a/polaris-react/src/components/AlphaStack/AlphaStack.tsx b/polaris-react/src/components/AlphaStack/AlphaStack.tsx index fcd6e84fd33..03798f09082 100644 --- a/polaris-react/src/components/AlphaStack/AlphaStack.tsx +++ b/polaris-react/src/components/AlphaStack/AlphaStack.tsx @@ -3,7 +3,7 @@ import type {spacing} from '@shopify/polaris-tokens'; import {classNames} from '../../utilities/css'; -import styles from './Stack.scss'; +import styles from './AlphaStack.scss'; type SpacingTokenGroup = typeof spacing; type SpacingTokenName = keyof SpacingTokenGroup; @@ -27,7 +27,7 @@ export const AlphaStack = ({ spacing = '4', align = 'start', }: AlphaStackProps) => { - const className = classNames(styles.Stack); + const className = classNames(styles.AlphaStack); const style = { '--pc-stack-align': align ? `${align}` : '', diff --git a/polaris-react/src/components/Inline/Inline.tsx b/polaris-react/src/components/Inline/Inline.tsx index b3e5263374c..1278239ee08 100644 --- a/polaris-react/src/components/Inline/Inline.tsx +++ b/polaris-react/src/components/Inline/Inline.tsx @@ -42,7 +42,7 @@ export const Inline = function Inline({ }: InlineProps) { const style = { '--pc-inline-align': align, - '--pc-inline-align-y': alignY, + '--pc-inline-align-y': alignY ? AlignY[alignY] : undefined, '--pc-inline-wrap': wrap ? 'wrap' : 'nowrap', '--pc-inline-spacing': `var(--p-space-${spacing})`, } as React.CSSProperties; diff --git a/polaris.shopify.com/content/components/alpha-card/index.md b/polaris.shopify.com/content/components/alpha-card/index.md index 8d037624da0..1f1d642accf 100644 --- a/polaris.shopify.com/content/components/alpha-card/index.md +++ b/polaris.shopify.com/content/components/alpha-card/index.md @@ -1,5 +1,5 @@ --- -title: Alpha Card +title: Alpha card description: Cards are used to group similar concepts and tasks together to make Shopify easier for merchants to scan, read, and get things done. category: Structure keywords: diff --git a/polaris.shopify.com/content/components/alpha-stack/index.md b/polaris.shopify.com/content/components/alpha-stack/index.md new file mode 100644 index 00000000000..bc738f1f0d7 --- /dev/null +++ b/polaris.shopify.com/content/components/alpha-stack/index.md @@ -0,0 +1,21 @@ +--- +title: Alpha stack +description: Use to lay out a vertical pile of elements sitting on top of each other. A stack is made of flexible items that wrap each of the stack’s children. Options allow different spacing and alignments. +category: Structure +keywords: + - layout +status: + value: Alpha + message: This component is in development. There could be breaking changes made to it in a non-major release of Polaris. Please use with caution. +examples: + - fileName: alpha-stack-default.tsx + title: Default + - fileName: alpha-stack-with-align.tsx + title: Horizontal alignment + description: >- + Horizontal alignment for children can be set with the align property. + - fileName: alpha-stack-with-spacing.tsx + title: Vertical spacing + description: >- + Vertical spacing for children can be set with the spacing property. Spacing options are provided using our spacing tokens. +--- diff --git a/polaris.shopify.com/content/components/box/index.md b/polaris.shopify.com/content/components/box/index.md new file mode 100644 index 00000000000..33137e97a20 --- /dev/null +++ b/polaris.shopify.com/content/components/box/index.md @@ -0,0 +1,31 @@ +--- +title: Box +description: Box is the most primitive layout component. Box has a set of padding options. Use it to render an individual item. Box can be used in components such as Toast, ContextualSaveBar, and Banner. +category: Structure +keywords: + - layout +status: + value: Alpha + message: This component is in development. There could be breaking changes made to it in a non-major release of Polaris. Please use with caution. +examples: + - fileName: box-with-padding.tsx + title: Padding + description: >- + Spacing inside Box can be set with the padding properties. Padding options are provided using our spacing tokens. There are 5 different padding properties: padding, paddingLeft, paddingRight, paddingTop, and paddingBottom. + - fileName: box-with-margin.tsx + title: Margin + description: >- + Spacing outside Box can be set with the margin properties. Padding options are provided using our spacing tokens. There are 5 different margin properties: margin, marginLeft, marginRight, marginTop, and marginBottom. + - fileName: box-with-border-radius.tsx + title: Border radius + description: >- + Border radius can be set with the border radius properties. Border radius options are provided using our shape tokens. There are 5 different padding properties: borderRadius, borderRadiusLeft, borderRadiusRight, borderRadiusTop, and borderRadiusBottom. + - fileName: box-with-background.tsx + title: Background + description: >- + Background color for Box can be set with the background prop. Background color options are provided using our color tokens that relate to background, surface, backdrop, and overlay. + - fileName: box-with-border.tsx + title: Border + description: >- + Border color for Box can be set with the border prop. Border color options are provided using our shape tokens. +--- diff --git a/polaris.shopify.com/content/components/columns/index.md b/polaris.shopify.com/content/components/columns/index.md new file mode 100644 index 00000000000..56e731d25b6 --- /dev/null +++ b/polaris.shopify.com/content/components/columns/index.md @@ -0,0 +1,17 @@ +--- +title: Columns +description: Use to lay out a vertical row of components with equal spacing between and wrapping onto multiple lines. +category: Structure +keywords: + - layout +status: + value: Alpha + message: This component is in development. There could be breaking changes made to it in a non-major release of Polaris. Please use with caution. +examples: + - fileName: columns-default.tsx + title: Default + - fileName: columns-with-varying-gap.tsx + title: With varying gap + - fileName: columns-with-free-and-fixed-widths.tsx + title: With free and fixed widths +--- diff --git a/polaris.shopify.com/content/components/inline/index.md b/polaris.shopify.com/content/components/inline/index.md new file mode 100644 index 00000000000..2dec172971d --- /dev/null +++ b/polaris.shopify.com/content/components/inline/index.md @@ -0,0 +1,21 @@ +--- +title: Inline +description: Use to lay out a horizontal row of components with equal spacing between and wrapping onto multiple lines. Options provide control of the wrapping, spacing, and relative size of the items in the inline. +category: Structure +keywords: + - layout +status: + value: Alpha + message: This component is in development. There could be breaking changes made to it in a non-major release of Polaris. Please use with caution. +examples: + - fileName: inline-default.tsx + title: Default + - fileName: inline-with-align.tsx + title: Horizontal alignment + description: >- + Horizontal alignment for children can be set with the align property. + - fileName: inline-with-align-y.tsx + title: Vertical alignment + description: >- + Vertical alignment for children can be set with the alignY property. +--- diff --git a/polaris.shopify.com/content/components/tile/index.md b/polaris.shopify.com/content/components/tile/index.md new file mode 100644 index 00000000000..4b085db097d --- /dev/null +++ b/polaris.shopify.com/content/components/tile/index.md @@ -0,0 +1,15 @@ +--- +title: Tile +description: Create complex layouts based on [CSS Grid](https://developer.mozilla.org/en-US/docs/Web/CSS/grid). +category: Structure +keywords: + - layout +status: + value: Alpha + message: This component is in development. There could be breaking changes made to it in a non-major release of Polaris. Please use with caution. +examples: + - fileName: tile-with-spacing.tsx + title: With spacing + - fileName: tile-with-columns.tsx + title: With columns +--- diff --git a/polaris.shopify.com/pages/examples/alpha-card-subdued.tsx b/polaris.shopify.com/pages/examples/alpha-card-subdued.tsx index d29384c3292..c165a537c1e 100644 --- a/polaris.shopify.com/pages/examples/alpha-card-subdued.tsx +++ b/polaris.shopify.com/pages/examples/alpha-card-subdued.tsx @@ -3,14 +3,16 @@ import React from 'react'; import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; function AlphaCardExample() { - return - - - Online store dashboard - -

View a summary of your online store’s performance.

- -; + return ( + + + + Online store dashboard + +

View a summary of your online store’s performance.

+ + + ); } export default withPolarisExample(AlphaCardExample); diff --git a/polaris.shopify.com/pages/examples/alpha-stack-default.tsx b/polaris.shopify.com/pages/examples/alpha-stack-default.tsx new file mode 100644 index 00000000000..65ca284e8c4 --- /dev/null +++ b/polaris.shopify.com/pages/examples/alpha-stack-default.tsx @@ -0,0 +1,21 @@ +import React from 'react'; +import {AlphaStack, Badge, Text} from '@shopify/polaris'; + +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function AlphaStackExample() { + return ( +
+ + + AlphaStack + + One + Two + Three + +
+ ); +} + +export default withPolarisExample(AlphaStackExample); diff --git a/polaris.shopify.com/pages/examples/alpha-stack-with-align.tsx b/polaris.shopify.com/pages/examples/alpha-stack-with-align.tsx new file mode 100644 index 00000000000..eafbc585f81 --- /dev/null +++ b/polaris.shopify.com/pages/examples/alpha-stack-with-align.tsx @@ -0,0 +1,66 @@ +import React from 'react'; +import {AlphaStack, Badge, Box, Inline, Text} from '@shopify/polaris'; + +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function AlphaStackWithAlignExample() { + return ( +
+ + + with align start + + + + + + AlphaStack + + + One + Two + Three + + + +
+ + + with align center + + + + + + AlphaStack + + + One + Two + Three + + + +
+ + + with align end + + + + + + AlphaStack + + + One + Two + Three + + + +
+ ); +} + +export default withPolarisExample(AlphaStackWithAlignExample); diff --git a/polaris.shopify.com/pages/examples/alpha-stack-with-spacing.tsx b/polaris.shopify.com/pages/examples/alpha-stack-with-spacing.tsx new file mode 100644 index 00000000000..626e178ee8a --- /dev/null +++ b/polaris.shopify.com/pages/examples/alpha-stack-with-spacing.tsx @@ -0,0 +1,66 @@ +import React from 'react'; +import {AlphaStack, Badge, Box, Inline, Text} from '@shopify/polaris'; + +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function AlphaStackWithSpacingExample() { + return ( +
+ + + with spacing 0 + + + + + + AlphaStack + + + One + Two + Three + + + +
+ + + with spacing 4 + + + + + + AlphaStack + + + One + Two + Three + + + +
+ + + with spacing 10 + + + + + + AlphaStack + + + One + Two + Three + + + +
+ ); +} + +export default withPolarisExample(AlphaStackWithSpacingExample); diff --git a/polaris.shopify.com/pages/examples/box-with-background.tsx b/polaris.shopify.com/pages/examples/box-with-background.tsx new file mode 100644 index 00000000000..0469223e3a7 --- /dev/null +++ b/polaris.shopify.com/pages/examples/box-with-background.tsx @@ -0,0 +1,33 @@ +import React from 'react'; +import {Box, Stack, Text} from '@shopify/polaris'; + +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function BoxWithBackgroundExample() { + return ( + + + + Box with background + + + + + Box with background surface + + + + + Box with background overlay + + + + + Box with background backdrop + + + + ); +} + +export default withPolarisExample(BoxWithBackgroundExample); diff --git a/polaris.shopify.com/pages/examples/box-with-border-radius.tsx b/polaris.shopify.com/pages/examples/box-with-border-radius.tsx new file mode 100644 index 00000000000..d4760021067 --- /dev/null +++ b/polaris.shopify.com/pages/examples/box-with-border-radius.tsx @@ -0,0 +1,47 @@ +import React from 'react'; +import {Box, Stack, Text} from '@shopify/polaris'; + +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function BoxWithBorderRadiusExample() { + return ( + + + + Box with uniform border radius + + + + + Box with bottom border radius + + + + + Box with border radius base + + + + ); +} + +export default withPolarisExample(BoxWithBorderRadiusExample); diff --git a/polaris.shopify.com/pages/examples/box-with-border.tsx b/polaris.shopify.com/pages/examples/box-with-border.tsx new file mode 100644 index 00000000000..5dd7f80326c --- /dev/null +++ b/polaris.shopify.com/pages/examples/box-with-border.tsx @@ -0,0 +1,68 @@ +import React from 'react'; +import {Box, Stack, Text} from '@shopify/polaris'; + +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function BoxWithBorderExample() { + return ( + + + + Box with border base + + + + + Box with border divider + + + + + Box with border dark + + + + + Box with border transparent + + + + + Box with border divider on dark + + + + ); +} + +export default withPolarisExample(BoxWithBorderExample); diff --git a/polaris.shopify.com/pages/examples/box-with-margin.tsx b/polaris.shopify.com/pages/examples/box-with-margin.tsx new file mode 100644 index 00000000000..5012a304216 --- /dev/null +++ b/polaris.shopify.com/pages/examples/box-with-margin.tsx @@ -0,0 +1,53 @@ +import React from 'react'; +import {Box, Stack, Text} from '@shopify/polaris'; + +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function BoxWithPaddingExample() { + return ( + <> +
+ + + Box with uniform margin + + +
+
+ + + Box with top margin overwritten + + +
+
+ + + Box with left margin only + + +
+ + ); +} + +export default withPolarisExample(BoxWithPaddingExample); diff --git a/polaris.shopify.com/pages/examples/box-with-padding.tsx b/polaris.shopify.com/pages/examples/box-with-padding.tsx new file mode 100644 index 00000000000..736adcbdb77 --- /dev/null +++ b/polaris.shopify.com/pages/examples/box-with-padding.tsx @@ -0,0 +1,34 @@ +import React from 'react'; +import {Box, Stack, Text} from '@shopify/polaris'; + +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function BoxWithPaddingExample() { + return ( + + + + Box with uniform padding + + + + + Box with left padding overwritten + + + + + Box with top padding only + + + + ); +} + +export default withPolarisExample(BoxWithPaddingExample); diff --git a/polaris.shopify.com/pages/examples/columns-default.tsx b/polaris.shopify.com/pages/examples/columns-default.tsx new file mode 100644 index 00000000000..bc5e23154b0 --- /dev/null +++ b/polaris.shopify.com/pages/examples/columns-default.tsx @@ -0,0 +1,21 @@ +import React from 'react'; +import {Columns} from '@shopify/polaris'; + +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function ColumnsExample() { + return ( +
+ +
Column one
+
Column two
+
Column three
+
Column four
+
Column five
+
Column six
+ +
+ ); +} + +export default withPolarisExample(ColumnsExample); diff --git a/polaris.shopify.com/pages/examples/columns-with-free-and-fixed-widths.tsx b/polaris.shopify.com/pages/examples/columns-with-free-and-fixed-widths.tsx new file mode 100644 index 00000000000..c142fcf966c --- /dev/null +++ b/polaris.shopify.com/pages/examples/columns-with-free-and-fixed-widths.tsx @@ -0,0 +1,24 @@ +import React from 'react'; +import {Columns} from '@shopify/polaris'; + +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function ColumnsWithFreeAndFixedWidthsExample() { + return ( +
+ +
Column one
+
Column two
+
Column three
+
Column four
+
Column five
+
Column six
+ +
+ ); +} + +export default withPolarisExample(ColumnsWithFreeAndFixedWidthsExample); diff --git a/polaris.shopify.com/pages/examples/columns-with-varying-gap.tsx b/polaris.shopify.com/pages/examples/columns-with-varying-gap.tsx new file mode 100644 index 00000000000..9dcf2359934 --- /dev/null +++ b/polaris.shopify.com/pages/examples/columns-with-varying-gap.tsx @@ -0,0 +1,21 @@ +import React from 'react'; +import {Columns} from '@shopify/polaris'; + +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function ColumnsWithVaryingGapExample() { + return ( +
+ +
Column one
+
Column two
+
Column three
+ +
+ ); +} + +export default withPolarisExample(ColumnsWithVaryingGapExample); diff --git a/polaris.shopify.com/pages/examples/inline-default.tsx b/polaris.shopify.com/pages/examples/inline-default.tsx new file mode 100644 index 00000000000..22eb5fe24e9 --- /dev/null +++ b/polaris.shopify.com/pages/examples/inline-default.tsx @@ -0,0 +1,21 @@ +import React from 'react'; +import {Badge, Inline, Text} from '@shopify/polaris'; + +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function InlineExample() { + return ( +
+ + + Inline + + One + Two + Three + +
+ ); +} + +export default withPolarisExample(InlineExample); diff --git a/polaris.shopify.com/pages/examples/inline-with-align-y.tsx b/polaris.shopify.com/pages/examples/inline-with-align-y.tsx new file mode 100644 index 00000000000..098c7258fee --- /dev/null +++ b/polaris.shopify.com/pages/examples/inline-with-align-y.tsx @@ -0,0 +1,76 @@ +import React from 'react'; +import {Badge, Box, Inline, Text} from '@shopify/polaris'; + +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function InlineWithAlignYExample() { + return ( +
+ + + with alignY top + + + + + + Inline + + One + Two + Three + + +
+ + + with alignY center + + + + + + Inline + + One + Two + Three + + +
+ + + with alignY bottom + + + + + + Inline + + One + Two + Three + + +
+ + + with alignY baseline + + + + + + Inline + + One + Two + Three + + +
+ ); +} + +export default withPolarisExample(InlineWithAlignYExample); diff --git a/polaris.shopify.com/pages/examples/inline-with-align.tsx b/polaris.shopify.com/pages/examples/inline-with-align.tsx new file mode 100644 index 00000000000..5d1c10cfe3f --- /dev/null +++ b/polaris.shopify.com/pages/examples/inline-with-align.tsx @@ -0,0 +1,60 @@ +import React from 'react'; +import {Badge, Box, Inline, Text} from '@shopify/polaris'; + +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function InlineWithAlignExample() { + return ( +
+ + + with align start + + + + + + Inline + + One + Two + Three + + +
+ + + with align center + + + + + + Inline + + One + Two + Three + + +
+ + + with align end + + + + + + Inline + + One + Two + Three + + +
+ ); +} + +export default withPolarisExample(InlineWithAlignExample); diff --git a/polaris.shopify.com/pages/examples/tile-with-columns.tsx b/polaris.shopify.com/pages/examples/tile-with-columns.tsx new file mode 100644 index 00000000000..1e20107bbce --- /dev/null +++ b/polaris.shopify.com/pages/examples/tile-with-columns.tsx @@ -0,0 +1,34 @@ +import React from 'react'; +import {Tile, Text} from '@shopify/polaris'; + +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +const styles = { + background: 'var(--p-surface)', + border: 'var(--p-border-base)', + borderRadius: 'var(--p-border-radius-2)', + padding: 'var(--p-space-4)', +}; + +const children = Array.from(Array(8)).map((ele, index) => ( +
+ + Sales + + + View a summary of your online store’s sales. + +
+)); + +function TileWithColumnsExample() { + return ( +
+ + {children} + +
+ ); +} + +export default withPolarisExample(TileWithColumnsExample); diff --git a/polaris.shopify.com/pages/examples/tile-with-spacing.tsx b/polaris.shopify.com/pages/examples/tile-with-spacing.tsx new file mode 100644 index 00000000000..0bdbe0094bd --- /dev/null +++ b/polaris.shopify.com/pages/examples/tile-with-spacing.tsx @@ -0,0 +1,34 @@ +import React from 'react'; +import {Tile, Text} from '@shopify/polaris'; + +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +const styles = { + background: 'var(--p-surface)', + border: 'var(--p-border-base)', + borderRadius: 'var(--p-border-radius-2)', + padding: 'var(--p-space-4)', +}; + +const children = Array.from(Array(2)).map((ele, index) => ( +
+ + Sales + + + View a summary of your online store’s sales. + +
+)); + +function TileWithSpacingExample() { + return ( +
+ + {children} + +
+ ); +} + +export default withPolarisExample(TileWithSpacingExample); diff --git a/polaris.shopify.com/public/images/components/alpha-stack.png b/polaris.shopify.com/public/images/components/alpha-stack.png new file mode 100644 index 0000000000000000000000000000000000000000..3b80b1e06f08a11ae65310b6c4a1cda161c303b5 GIT binary patch literal 25923 zcmeFZXH-+$_C6dDRKQACDblMTDAGYn0O>6hrANRciuB$@PzeYkRi#Lirc{wm0BO<@ z5l}*q7HT4d7E1D8n{)4PjQ8{V^*Y8m#*Cf4*P3gVXFhYz9c^Twb%yQ|9SjCLb6Z=( z1O_`H2!kDuJaqzm)8ji+0{)_P*S7M4!MJ6i|Bk^^B<;bM$Gl9m)L^9p>`UMu)Gn&} zsxVkZJpF+K4GeZ~{I-Uwng6j>47~;8KR<6yKX`SW=K-2RIT`wi=Zedsgx|Aehll5G z`6?l9m%4ru`%%GPWai|Jt==KeE^KcT&VpOQVDA%N{^tYtAL^rThLYT=jy~Mikv(?w z;Rb*D(ciGQ3xSs<90|ym#brZ*6Eh41(Gi>Dh0JNqeN7|b#dvip>t!^052z(DyrqZutJl;ANq>RY|= zhpRRhSXo(#MvfoPMyG1adU$)^n*=~oR~I18mhZAEDp{E-D%uUQOuYxp{+a3A^S#)(a91GLNVFV!qLevT3z_io8Hu&tM?d zkZwwtYI+w&0}FTJ1}N74dueIu0x~_N;_i%vR9wM1;mW^hf3~tUA12SS%Lnd% z`HlI#0xrFH3IMsZkB_T(Hfs1eW;d;Ag|}U}J2GE68cpyg7(^o$n@PzvRpE|dVd&$q z@FGSapli2XTwI8b8}--l|FA73b=Q4*xbXTVT0sVo8MK%|*g7rATQ{$;5&vB^VaBslc|F)FGxR2XO{usJmS_ll8F{Cxt80J*1{2VNR=FsJ!j+-P40;EhQ&Urlc|-7Z zF5(4)Dx;a@<>FbK)TPzguK0n=;BxrU<=-U}8nC1$rZj9*(Ae7Qs`rZ66OD*yYNi8Q zdBG`k7#7^q3=$_BVw*ZWGt*aH*Eo#W|IRJQ)iqQwfRj}H^5x5bE=^8hZ=8o;m57#lqj%qZ6cqBor$E|7Dn^e8xOYU)A5wynWDSmb7mb8hSJpRdmY{DBig9v$-A#Kc5Z zAn^;nVPRq9Zkv^427@^dIngBS)TExHp{B1fJ11uf`e#wvcem*DyLYR~U2&3si zR~by^BsESY!uaVckHPF8LN=nApwOWbMxI3IrfSsF-eFoc)i$X0losW~#!VV0DC`jH zYrcG`N4&lwg!?wmZB&1Tf$Gc!?E~$BPq7M@9a(jK4d>*K!NMgWy#?x z64Uy}LFQSgm?0j|RrM@w_A1`JjOOBa~Mj%E)d~(ksF2b|y_H z8|gfF%v&7KgA?cETt!6GL>c@KJ%II}xpn$-hYfHHAz`jCx`#ZMg0i1y$bklat<8 z^PloWk%YCiN9qg4V_=v~bVh^CgO6%vX24NlUpmKuo$URB90;TTv_NpEkd8fvAN zT~8yEvcA7VtdPHIr`su*!Ah+W)8n6`7;oOHQGeX?W5Kx6hDiYVq81{1`7Mx6>K!~f z`8cfn#&=<(iu3h$wv8fEJ1V--*B6RL3k$qO=kWWI+eV+KBof5mMOs;%ZjR+m4;2`@ z)v@u{I#G@_MX4O9Eol+jO|-5Jqe}8vqOm%ca`64_UkqpOjj6-!H?2vwq|8qsKupHR z$EW(%w3nGZ^R{@&ns6L;3-ST?b8@a^P!UCZ^n)chm?rXvm!-EG=!;WCRd7M`uJm%x zXoD(|jtKt3l2bOZzEm*#(~y;%NR9A@8wUot6p+|*ewsWS$RK}W33cf+QF~faQsO3b zQ6-6xK#=~-Ud7&kSWVfrwRJ6xhUe$zcLW`W!3>X#!+JD>v>z0Nsqfa#NwHzFLx*M% zatc#auJ@MR6>A@%K44aB?VW`Kq2LC$Tu^s!q#JRj+pthITdjfJn{F%1GX zOgJ2lcqLn{?FIN@mfYv`%R~%=mX;{?>UvWwRf(*O8(pa}4CYS@nbXq-(Z%%fySb&& zgf%?gmw-h-W*E3fZJJ^(@qOtPWqWQe?;-78+3M;4xX&Qx5*J0sn(+&D&he0MTB3z<;*8i7^cP+)Gg z@iiD%02ZWsBs|0gy@!3M^^11uV<0~FsiU&H6#30`y8pi3kwDAXurl`!hUK4o;3@X= zQS3xBavjT&X9j77_UvFy(GhJ@y3vS-=THQ38nQaB?brp#6@TCFtc-T z^m84IyQ$(drgU|I%esFQgX}#84|6&O#1woB4$9UD1V5mZY@4$D!Lo94OCaczN!2W^ z8n&jkcRRl05Gk`}6>Qd!hY>xJkE!uzgW=Kdv)EqCtXRds>(iVlrc!k1p*)uNwN^wl zcg)10Yvt*~9nY5!nIcWq;}@u4;hBIZ3vZod5gQ+sUJsTt=TZq>^`+B1IM9(7+F+AP z8^>Tc8ZX})Z4{O@XGVhUP0Jk#bD{aYSDOt{!Y?>j5vyMDv2t!7)8HrXY`du6TFnDl zR`Q>~=3_9+pmQ`)1KeFqpDI_gwLK`Ss}KL#J~c;jUh=6I@UKG+L}#pN3)9ZekQI8!RB$#G-tK*ayJtU?M^d<-pdL1_7ZP6X~#LTHs!UVTP zKc|Q18by(#^LMPg&!XK-0et|5HC}I7_*F>iT z*ZFvwuZ{3BE1==xM;hMkp9a@zKP9+4XDRT0d}<2+!7<3SWM4MOAR_uwowfPr6n2wOz-9h$LNNT@7Fa%yXi{zvB)WNxI&)r!8S z(N@|#!NoOJ?)_%g4KUbWg^|nh^spA4!rJ{ivXbe!xw!$d?j9b))t}L5Y*Wbo7bF{V zhLAkuaaz&aVC#_s(M!78?(XhG)vpQsX>30=Rb@~Ez_;A_Tc!j&%(^|U-9%PVF{w)aBac@O5j=Q z1?4Q2Fi!6zLwq~M({m>7fd5a(f4Ba1NUnm(z&X1Wz+#!t4Gj(W-c$)XEP#FK5bOH$ z$5@$N!|&g}OOu1kBDq1%0BNVCdO<+}!1ai+U;X|1e!jjx0l&7Q4>_l6vG?A71ku|E zN(?N;#l`E1MB-WS6FcaK0==OTffiLpj&!XpIlX5kKNTHpF)m-pYHGVTBlQi&nclXu#87%_t=g*&tp9{|lZCrZhf3-xc z>%p+Q;|l{e7;N`K7?B!ge~mfHAcJvG#;m6GcWy4o`}PYcK~yM^3YFfm)zws7S7cU= zgM?##(9Z~*lG&s_VSt2_Q&Az5mX$R;cbqbGv9EK&6L;d{ShY$_*^~(d!WiPQo z<)<&h!ucV;10Lh&Kra|d*x2xVMKcbPLJXOn>iJXZi&c~lzdBZ{&s=Ey_!jL0j-p)S zKM!J(Cy2qx`9PBc#x$xkGBWUsi-kc&HIK2rzwh3)sgC{F<2sKMDP=x#LH~N{DR5v{ zmu*$|3ce#eJv~jPY+h4sxkf~HTfX<}>f$FHnocOa9(!=|+aSXF$UWb=02yE!N)3nY zls_~}fm=wlOihk2DhKbD8;$9bfBO-pk_i&suKKrH;}MZ&kbeI6Hx&juZP8pkLIq+m zrM?H`kZ=1b1JRM}qtH1|lvU7iu0lJH-hBrtpfIfyeuV;j>?DSf(p}LlTkzl{z}>)VEUtz*r`)sX z^)CqO{Z28yFw7$I~k#;of3pDmu(wk#k1>qhc6;5%KEvTm>v8aK)6ZSe3219FG$ z1NAgwMrKGgyVz_sFc&vyRptc-MJmjX+`ir(vAQ~Ai92Luo^6K2{GR{F{r6zTW2O=^ za)|YDzVb>+SFzVCYHDQcOq5cB3Co16f#|BLDmRY#YKcpI4_T}WfUp_<-A^U5<$l4~ zx6J6}5IQ2w_;GLX#vgzFIFKS%*~=7v>UUIE$OTCh?>qtSwCqUI)*ZX=->s~;Wt<+S zef4T_ch{c*zNq+|J5x8#%BSGl4@9g|$ypRIP`@Jsb*p;+H=se228ZV2JTZ|CY{2xF z=qsE_)0GD7aD~CXphz1Vw1ZDaXmZlI)v~~+{xbRCcg=>R`NiBDom8vXi;k+k1Ia$W zR6M-AfR?{>f^ZFl{_WkF;p?b;bno=uUVTGt?V<>jC_@Tk<|MZbDa}7GLO4v#s>R6t zVtl}sQ;ybD`apQwruE^WuxV!;Gw~L9KhADp4Vf7t5S3 zg0$&qY4>v+KOFX>o-+yx3iA84?kwmQV9|Dkf72C+=&(7t?RWyEW=!YWdT1+dugUv& zdhp?|Pg1=A*;|^ES?FN57=J4$&<}Q^ZT`6P_4YWn*Q!vRI)2zj+t7YYA!@wak&cxk5iBYZd4$Q zU>WfYZ<(uQ=py1+GUIOPT#%z7J@@8UB;N_0s?)6#lyU6Wv|KPbX2HVYy z%e|Fh4x!4-vB!Qxh0AM4sjdDdd>S6JKA}*dkl;S^=XUqd$@7L`Q}Kq5@}aD!ws;FN zPp}G4Jytw%>0LZpnTFYhF~#9H>>3Mn?)`b)4fkb@>*A;77{vP;I5`_`ZX8^HCTz!Q zL)E`IcX)sZU%%0)T?6M_nhPL~hYXu^G)E)YeQ01Uo<~B^Ym0`Gl?!8IV;G>g7LPd9 zHe0`n#h$*rnu%~}yxSN(gbt1kDW1xavI~&GG19Csq z#P(r#-dNmEl5%8iP_S7a{&^M+E3M#yYKPeAMJ@PNkhtw(h}hQ?z^y@wdjEsts(xD( zQz$?Vq5DDmhv$~Q?2cma*FLA$T>QFuDD*-3qyKe!+AmzkV{p`uX@9V+E#AJip$P?X z-gOy}#k{>OdE+{sH6uBU2m*QYt3Vdz$$oMT^?9Pwg?Qu}`{KQU4C?#XdWtnKt>{K~ z_3I%=qKD*;Df7O-_a+BOEs>B1A2P%Lu>D*fxKn$MC(MAZfh6+6o_Ujge7}WfuZ3sK zK&>wL(;_Sod89OZfUx|Do(9Vopcw;v%UQOu_4W0t&Rn1u=WT1?=V370e|j;$uF;ml zL8cBl$@fKK`_+-Gom-O~zrk@cg8zT+1l-g;H>=}7eyi^mxmx_)oX4ie z0Gjc8T=skF*INn931D$z?LcVPc6N3!TL5T<_>5wvrhLOFYh{_&q-g~z!+3fth~tx! ztH7G?L;hcf|5feVs0#s;Sd0(3Qcj<^KbJLm6^oV2Dm$cX4`MbA!?1o~1L!HN6)gGu zGC@#m#$rb#5ffSouN)sgHZ%eovWFC1OzcT}$NW4vP>k3sd$use6DJJ0E?3R0 zFLZVW*R4~iPaC#Hk;C3m$b#s{56_)DM+rV`I48Y#4Y}=l&M@NT{z0&B=6n|sOW6&| zB+L9*d5XedY+_cA!Gxd!{xpI??VexzyjYU9Y-{=1vuEo8e25EE02rY;WdEn+$4JHr zXDO$rPayylel@xG8mb0 z?m&?JN@{}1(%BwM;p|Dua_T>XHNv2R2=#p!Ofl8g8U_m$f{({O>_KM4R2*hLW3rdw z{Q6ubfG=scm17p*vivU5*>q|~bm|T-vdr^9bWW+UuI|lACakV~!U}JED63{fL#SV; z{8GFrXPtSahQc{y7C==T89?3#$SHmgpHUlY>yH@6mC!oxi05l-Ym~_I@yFV|2qy;B z{z?c6+9U^4y!HPEXDNq>DEVDC5N-Y8g;DXfm`iBkQ9*}U&ovo%9`cFxNIk+Zfm^3xk{rl4tpcJrA*^*WF`?O+%UXk3#iI^jsT0L=P2>EzBggIb>yE zaIir{cwu3{%ht_mDyF%F=Sj!b>ZLya!bp~qy>p+v`9K;xh+h5xgF)1Dxif=Ko;pu< zdoiXiBLWx9H-co7#4@fwZ8|^d$$s6SaM|rJQs|;!Uif}s@@&S2^4#Hl4;)4DW112J z+klpOe{<;_8B?mZL#yeknuZnjlQ2sp(2{WJ1gECds#`OTEP8WYCC+~4i+vk2lBkR< zbnqM2gpzydi5FyJZab(PgC|ql&Q`Nxr6$*G}H|W3O24K_36r4`T=1Z z-2qw8IYdE5^c4;AR`VbAkqk|tzLcDpPj)TVc7aT7r*ddWNJ|K;ChYeWgfnh9zYfY%xfed7}D8tS)Q;8vHFG#qzm*&RF24 zep^=01*?m?@QhfxV#N3#``D9P)x@78X8y?B(aSkC`8rOBJm@S=pOyr2<%6FxaPTOuydmr7y7Q!+z}KSP^%WBVr^L2iluGwc zqfxDU*Ps(OIMo7os}E3BK%$GcUkATq?%i+XB6JbFzqI=>zG<{4~ zS&T0lHCcEpFb-4LVZ+OHE6Pu7JE{}CuJ{qpZIS2MOJxUbD_wZT^f;dzMxcV5L{}M# zU+w%Q;s%Kx2x4jOvEw{2*fU<>X)PJ*-pOGYOdE6M{K$ey{`yze%`_E4?p{lO!Gw5z zO3)4Gg6w156$&HiI|&Dyk!>O;p)1Hz|^JlJVtHBoVXU! zT6w1}yLjfIZ2=8>Z9WZmP`G?TR!NEDo}4fI)X#XGyX`xw9sOeOyPIDY#U}N-bbR~v z?Z9ghP*L@uY?K0dGW#|Y4Sm&Mk(dY9zX<1=dCF`X`5oW}ZM_TB<1FwSrH$|832-OX zn^9(+poDjWi{31oE6l7eukOL7+1AV=Nopn+5s7J2K=l`e&Pj|?#gnTe&Bo)u(ZKrCt5OUAM9hpPHUrC(0w(6E5# zetp(x%V_2-1Lv&!xmRI`?7=y+I15hR#wCdZlKmg3IHT9MhOzOJ7cGC;6nQhMiJD<4 z>3$t6chqcbj@9Ot1&fYogN3Kq)mBbBe0kZg>{njAPwvod#q<#CL}dL$HRY8oBHk$C zUB(`=bmD5`CiI6-@p-tu_&4n*#9rKB?g>WW2Or$`!vM)oE0<9cc2V`c|63Ensnx(x(x27}m_FLLx$8x!m6vt6X|O3BnF zTvPXAX`=*Kcw!jyF__*hRD#uVU}&iA7k5(r_X>AF5=w}DD3@E%PAc}$WB#KtAN0DR zwoB*|5g8y+-08ZNJI>-$LCu>HD){GaGZa_kD0&xNBdw+qy_KAPj96xsfVh;-X#opQ zm>)QRYNhBn?tMN002b^Dc;E-9VS_`P#j-PZ_MEy9o)&d-yCVrZJQ!6(Z^d;TA>5>E zS$^;dz;fCQR$q4>YcoCUE?`gfeufZF4lA|(T96v?P3Z&znf*cq(`v1+SeH`=ZS|)jS;Y+u3;JEJ615Ak-(2*RT{qsC))kWLHZJZj zjT8icV9;^{N-f!L;}`mC6MlYihPTx`f1W6jRM1kdon7M>;4!?0&ar&gFkM3TrcPbO zhOt+uYM)q}r9>V;nky3M7Xxg<9zN_tJ0}e;tX9PC-+xpQphp;87NO+R@ z^Rxw9lb)iic>@NR;T!BY8i_-|9v_rhl%|{9zh?&i-lSIWtLl zLi*J!$JmVH=tM7GT=%zcw=KBKcIw7#2M8$l9Ky{znsS00lj#1qyUM(xnhy^Rs8H4f z(`L*@G}MlD3tFq3tG z81cva%LZYR_ij|gGT4+exd@n)Fc`{t$GRe3`p z%Zao;#9;K9F76m?R{|VgON;m=F|>iCbkw&#H@lw|;wq*-GXD5y6pZ4250%qYd_V1) zrS`Gykpjb~aqfXdim8KHDl&FwDWVfG6&9asxH)98pz^7LEbrAk%MBu9Nqwj_kDvX-$4&-1EYoIQtxz;GmmatiM zL7r4y9B~hiAIR82u4oAyx+RS!%^iO8%4}OKV%jgk{}@~$O$1o1lkcUEyrX@2{<4np zN~NJ-e75qA=h?HQ3Bb&ULHX^8S2I72;D4C7L4s1g;inT;Ry<9~#YgwpFedv=qRmlL zrk4^o8A8fsqSob;bL&FA;}BQv>}m!hybbeW91Cv=jP(QBT>(UIC{GefxwxT@A!X!P zM@0M7>h1+0u5S^i6gfDO)IvvvvL{<@r6ZQBzaM+uwk(AuW#B?Vcgvn^vGrqw?gy_p zr8CwWMATTStK*`vmT6LH%1&3;Q=01mk1I7eVc~xuR*Eiv+Om3jJ7|fW%`+WvP|Oad zyP|SzvSK%;*tGNoTEIk%68;SDkUG z1^?n6x3qLu+Ri<%vNrPDm)?5`!8ZkJInZZt$b*Sa|WS+BP&OSJ5tRVt798B)4e$gPUP;uQzxOZ)2VC0RT*vTpPke4q)jtW5<=ql4VzlRkkmG28swZSrA|ADq%+I~;phyyJ>Q zB7c-d?;qPq*Sl>yn?|IFHVBH$HQw!lkE5%anv~87iSQd0PwF2B3IiPgOH##k1aUUV zYU6D~IH`u|#g4!Y7nMQ&sF{j%C9BHDo{dXgV&`#dKmAEj z`C>;k3JHwyh;Xnp@@c){_osn(Z|s9-FoO;|JG(csuDR|_yy6{J8D8{MB%>)Ub*%SZ zHOA_`<;3uf_C;k_xQ`%&5pUu1KBaGEsqLh7;GIC(c9KKsOQQvnrDRakmPzTEWP>1s zCaBGfd*UyXwu5NhMH)Ub#3I&;0J{qT=U1^_#g~ezq(yJi31mKA9X7Cft+;?$5l$+d zO?$I^>u-LiZ78SdCD)riw28%+)Ged z;<|akZG1YH7oh_*K@?(+BYR6QV~M?hh?K7AoJf;2wX0!OC7G z$TN2oG0B$T7i=s(;VAJK=>!i=WZaFnD6vk?Aa4H^FNZ!G){-k()y%Cq!(f5Zkm8oP zo0_FbyFGd= zdXwcFKANQy|Mo=%{f4PjRKwWa491AQO9<}449LAg#7ekD?bS3A+J)Bl4M~jrgcWI+ z?aITc$?0^1-<0jKG*|yk_nmgO288*9n`+uWAAu>&Kr50+3YZ0q+LxLdg$DDr48fOlxG9lulAm@Dn3=%dpdP!wYRoi6=DOZv z-(JBdg;(Fc5N4Vwa2BDN$sS0^SX(32>3>2E+C%Zr@!%>eY&uGWuARl<91>JB8iO1` z{^L|r`FWTTs+sALQ*f2Jw;{wXlio=ZoJN>U&l)Y**>u6kOk`cwv z*toF1>_Wc8C{>UaUcwu%KX&f2U!5J2w{E;f=f+LzSG=viXb;E~sMtQ8T&&r%nCagn z>AY^iEX!Ka(D3_HLq|8$1 z`uh6be2`!%D@m4=z07UaCx@$=@nLW@kGfr|0t>%%B!J>eYfKlJlf+?}5>dY@QmC<5 ztPEk?U!>Q6EMOtTc0Y|inmC1x|J-LQyY5MP_-Xm=cv{GUp~D4*|8(3onnXk&K79(B zy<9*sNApYLEzQZ;i;IxY-meCI4xdUY?Do@g$2-}azVvy%G!Ok!O7uAiGlIGU%EOy5 zm`Z$ftY1&b{g>2-&{F~16z%_rSyv<^W8YI)NPA9%6CQQ zszO(7fVPxq9Nh%;8-G{(2Nl=(<-iv8vPMP*Gj6iWUKIp-kjn4MfaZg>&ex?;!qhKh zs=O$rh11PFo*@gyPBzC?Vd2^T##<^6#E!f0w@s#=W zjVWvkl@*AGXdaj-tCy7Z`Mf1)30tynYzceOPhV+G%ZVE$sL+8D+mTw( zjC%HOEa0R4ckmdUxQuVEJ+7Bc<&nj7Q*yWsD`VqTgVdI^?D3?$7(NF#pKBG>)zV?0 zH?R=G6+$=6E=cocc8Z4@w!(+m-Zjfw%V{b5J;KI~&%ajKz@o#@CVu|7YIZKJRG->L zO{(x>4ngAK4bT8ShCuu!Z?E00!F!%A_S1{>0HN^fzt9rb4*XsN_a;rP@Y>z`YsEt8 z<001enKQ_F+0v?n<9SSI(>}YX@SJl3#SICz#hzK+BZJSvjQ z>U{h%gnSJ4Q3}Fx6_Xd5s;WlLaOdhuEeK!#JEm_N1ix^T&_5D^M71Mmx+k4fwojF= zx@eyqlsd@-^;94U!)bnB`=&XW2nDzYT9 zd}w2(rrZh#n_f=rS3GFA3xj=tNdIfEVjo=$e6u`1ir4{kNagT#Q^Y8L2* zWTL%5q~(AN@kCO{iDWo|3pA`ws3&-+m5jp^#>|)vRw<6pf)^+jn2Ic%wbi7p258#m z;u;+MDm-;&N`gP@duD8-A7acz`FLpc-5k%)BgM89(nAF~xr>boe7HYM^}ZlZL_zSz z-m3TxBK+V@Gh3!OYSN)m=R32Bq^)4CPpHgHVP$w$-LC1y>cp`m;x*pHPFtx%vrOH3 z{*B2G40?0c4PxxQTMh0~xO=0HtB95N%MJV@Uvsj)xqPMpHS|Z2|GnhDzr8kn48Cc@ zG@&IKRiVaQ+*x~Y|HAf;)QO_Xpd8O^=czLCL7tfbc1CjE1w^@p2kf&?oBw<2!R z%hqnxGL}- zXkRB>ds&fY2KVf2K$hpK2;Gl5qC(iuADSI=q`3rKN`!Ao2+dNGHg{-ou9qi!aU5Kw zbXjh%V>~9)>oB0GX$@DeFk(Xa=y$PxI7`1jtCDflR5lmx*)A-F~MwbUGJo-uSA{~ zvPVS0#`ElOpt70b-aSDXp zG$l^wGL^3BI=>2Bqk$^9|EGD)VXb}e1LV6<0fKSIK1V>m#G2(ViBp0zf#2Gqy)`oi z)v{Cer93n71<1BI011qtW7HhNB5dTaWWT)-CR#z07nyrDs|fl~qP$(bd#&A-kifuS z2<;)s{QN=m>)B*2^hs`l`ankL^V`kaxQDie6m3;y+@@Cp%?G}+qRMwmf0_5`_hy^# z<8DRdH)a;0&jnPVOHTBMsCOP|bV$oT=^|B|mE4 zycFe3LHpt~r?MjHn2+5?by)p<$3N8TY<2v3YT;>GFQq2m$UB+}8LY7>%U{cdd$y9U z6pm&l7TioN4>}FAPyV!x21OqMad;(QJ!7Tz1h_kJgIPEX6LPZYK!KUp%~OlQ^GA1H z=mQh-Zd~b~fQ`(1Sk>g3vcW(v2=5hFXP05bZ*LW}odKnu)g#)KzM;rJPOv z6fqM}nvoKdA0~hcjCdhYHJB3I9LpTBP_+fdHgu~fpcZZe`2&F~@NcmP-)zQ^Yy90A z{Z{E235IpVz&@V9&hKX9qL!zvNtttOc1%}E&K`hluD9}xGxPqn${gi@Jn@pW+AW@=C3k+#T^OrjYd9%V@ zH(J}rInf!JvcNb4snBnt!2cZ&l2dr2V7ETekQTg)d`aBM83HGqY-Tx2Ja@4e;cphB*-B%Z?|srn*< z+MBlVN_I3gBh{_{Ruzm;4=xHOy`On#-W|$TH=Sy=9*}qHU7Hu(8GVx|mGG^eBNW zfQuL;tQZuSYfzt1fqoRm4T1)}nT4kl$ z@PMg5XMz4Rm!Ih-&97h^zQRSVVX+4_?s+4o7nu|J(aan2Rb4ah*KNanQjxX+XApk+ zn|s$DUSQ76V9?&o5Fnj?+cy58V1tyn;#p8`3d$}wq2yGTr=!MObTfnARG47_kDtuW z&_cZrh=T^pxX?GQ2wh&fu}@a-cGaoT9uEh5MI?9w~43kDjc zMXC6&X(t(~kjeSK0wxXbJsdG5J^Xh6^V12}s=FY($U&BzqK)>KiR$$>)_e3>C#=91 zUun>)^h77ql_~~Tcxmaz9K$p_rLh_1F4Sr;)g{(tZqG3_K?<-cOeKo_X*crhH;eV{ zk=~kg=iy)=9n#+T@I8BrcWFqcODDz&bmE@w!Y+V^7@<5t-6xCng6U*tkJ_&SlgZTv z#Xa~hTG20ImGn8Dc_XhFc=E>I&DwHzOh@W$D=1^9on8~%=zPL&y8NBf!(?bB?tT|Gftcr5s6(t7Fu^Q#lIVPpb3Tk^|?6@ zhP`9jobYLeI~wpb23mO*%vkH-`~lRdQM}nZ{XE61&hhieme|3su+xHj`9BYl#aR~( zx1QL?J$D7B?E{&%`K>S+4=Pk~g1Y)QuN6Nt4b;ZnsxF__=IBW)%!41gDSt!B2X!T{ z#1pBRNY{%}?Q=Z!j7xTeaT}o9q)ma#^ArF3+c4Q`V|VoHD?C}Qq+s10W{?uh$G`ji zdkHH7xHRBRl0I;noaXkca$yM(rDZBkL27CG96nrSE=zPg09ApB>Y+V$-Exz<_MnS= zN!l)mm|@T{9^17B7APvv(a2<|5_(YUi!^#RC9~eNtWa-gXgDTrbm`8#WPkP6xY~6lsIE#WTYFTE z!1ROY61Np-4o^w8h*R&W{q!?KE}<=?c?Z#IkW#dy9<8_v-ALu=MsLJA^|OhdEGCo8 zQwU`mVRr!`Z3h+IFEy7iKACF%DM*Vb<$yC_3SrSdqw!pT%0{!9_5~#l?W_33!L2vA zkdP21!d~}4EP|fVi=9#X6Rzd|@&_ ztMs|Zgv)Rsy0zHy*$&T`9VhK6g4<)Jzl6haxg{&|jD64T=mC5Oh5-n`$_pfurx^N0(ZdJd0S z3b3skU{L0J(H*}Z?wCAZ>%?we&v%Cq2_}GkK{kKD8}&UlxF-X*BYJaV$jc-M7`xuOSiUL|ow z@JZybKDgge^FNo)lO522Ot!3PTQ(K`xSgAQlk;m#fV*VSLE&N`$hogT-uAf$NtmRd0>M2WHk^J0GhcdMwc-0KV`WZV-~0=3MYcMbvt%%75HS5piz<4*>wKH^UpqO23I2+Ps_R_XJYCS% zgM)IRzYm3noL5cjg+;V*e_d$>ltT~3*O9dJPzNGc3H);BO^|mBfqVg0_8K@CW?E5d z=C8f?3u66eu*F?+;8H$cP6a;i4bVeQ9w7+ilrQUh`sQ>E=#qZHzdP*I-=MWg^EKr3<(A%@q@_py10K_^4 zywT?0hEx3JrnmAQEn644RdwfQgb%=YpNBz^MuMjKPA{(z3@GcSK{|6|>+fHCDgF* z+28Nx64VexT+pwPR-jbXI1Ri10i(yw=P&+N0P!EJ9R5`&SmVeh6GMZ^NH&hLSD*;GJ&^M0`-wjB&kqeCBgnGf~z z!hatg9+Jwo96AmXxCT*m+cwwu-z`O^DeZafXsLp_aFC<%Qo6Q(>Md~OcaG%Lx7Od^ zmT_7*??d=Ldx-t|jlS+3!&}4g5%nRb#k?)A<)zo$jn6nAawUNaeUq&_E1BXuOuUH; zg%5$T4hg6P_5RJfh|(zBlok1UNW$)Z#Olb<48CG^CUo21-+yts&eKic{O?~=+#Ms5#-spFdGVjU!GaoSR-TOW zRb?SY*ECM8i!PnIb0fX5RsfjG5$}D&3+h`I@gm*bx4QEEBuj|VFyYJY{yMHLW}bK> zxEtxkqPU5Xe;2Q+5jx1UeM8Z&aiVOJ4v3B|8d`vWNnROSf|>EFPp{Rs$~5)nrLii{ zm}##rsCLeJ_;<$>T{|_UtJm3X9<1+9@xNGX;M|*bNT_hQilFu(5=TrP0@XPhyNpJa zMw9VdPV3$QJ7v#|=kZ&hcVV%TZ3yJnZ{uw)-QkM6dTDR|;Bqc62&P*{1D4SZ5l-VJ z^|dl(D}bC*P*7MA$!E*T@#2Xm6&6|TCcx$hT^^<(Y#Sj$Cd{vcxu`c)vf|;(UA*(S zc#hLmc8jHDr9G*yaO0)Rb%{Iv!_x#`-$&5i?n8XqEk@8JUvkGj4yXkFfq7cl;`k_tc);VLEk-3o6^ASm-3C8 z3lV1pXLfgMy|Jnhk)XXbO8&y${NQ0O7yl2HW(t-yu(Tuh(?+nTp2dW3tF-a(C{V8> z-LQ8*bXn#^RfVr`k#f|*V7T{b*ZIH z%X@}LN{*sgTvcFmyx^Z=UlxOM`sqhA2D*eABcUU2Mf82PD{$xW`wGhHrH!U@V61^( z)i_x(wXC4PCO>qrUEX_Q^QMeU16+Tp5pw*I&213N>pUEvH227TT&R!t35+wJmbAcSU+umLIZLr~noBw&2fQcyO6!e5KZ9CWslsxDC0%*U*+# z5tA>QN&y}1ZE#Q3xB4f2rI&c{;a+vgm$)E-W{dSbXh`P&F3mv4?F%%ghR{u@8Vf6& zU|{(?F8zuislg`IZX4$WkZr&()@ zYLz{Po$-NY7G?!<5=SrWdKxHnO7LgMJwpivW~r&7z?wGj{)hMUl~qU{Y_3VlEf>}< zdBPk2;+aczBVf?!mim!ssuwXE!pii5WKj&271{dH3mEq^I%Uw^c8rFS;CgTPeWx0* z!#f)_0YHwX74|hbi}epc;pyZ>m!w0+aGONLy$gss}Ko#!XlD z31|x5z`$U^&Q6pNq!zcV=7%Bxh2~KCV(k9u$gll7KO`bA_yrY1DB)9JeP;P8W9Lyq zIM2Rl@eb=;we#3BB}Nr6Blv0Z4x|aZWao2WNqBmETPSb(Za#Y!H4`-Yv%vjT_e`~= zLT-9GJ$k#-60GQ`<1M^Zk!e!t@y8K@(>ZltBeRCa##PWAy}gPJ^YD-iGwXHz{rmUI zZZ*o)DZv9IyMGyuwm~#9TD;MT3;1qT4yp(UfYh^|GocgRqQ|`N9K_L#54vyz`Si9Q zOw`Icc*5l8AoTs_h`o3ig3M>cQ^eJ5>h8&;aTev&^%++qRlvS z$4{TcfoN{jUVwxl04Z5JH=+qv{#x)+o+Sl3m=d~ls^yS1${&G-N(URq{Jh0(#cSma|$CK0pZxyh~KX?N% zE7)umjcXNXw8}X_|NI>Hw(66xmLX_>@7fF0`n7F+F#!xC7#Onw<9O&huMY13KmF7@ z_+ui<^=Rhc>h2gPGzWd?2HnJ#oemZf`n=%;)Np!D8Zj)z3CJE)_?tz%euU(K!?W!;5&q92>u5i7==3AOwy-h}l)((RwO) zdU;htoz+wVI>~*!L9n&{Ikh~1Ga9qQ;;)M8>Wn}%0VCYvYi8i>Rp0W`=P9ptn8KU5 z(+X*oQUQ}4VPFQnQ$fjQ<~i~@!O{rw8yRUIE3TxJ7hSx+1qknm;|2`MkC#4JuH68# z2=9h;6;aG6w_3KXn4GnF1%-g#jR2^zX>V#8U3$4i-jNN=F%F^!K@iIURTNe|2YBl> z1ZG)r@3Z-rRwfwKN{Lb7yzkX;503qPLy;0o?Ujj(x@4fI%m;kvk zPvV!cuJQ59TJ#V2HPC2rs*6Xvh4PlYza|<0MIs~6lAiI~n!k0?*6Lw9&;SyIaH{#r zS>oeXw=GmHEfe^6g~dNb2eI$FNT`lV5!lkC}7eC;JG?Oqy9*J(vtWZSO`3e%%ytr@mwLoe~{qNR>t)>6vfgirCxKi%&g8v62Es!KA4c<$V}fvU$_IM1gu z;B}0^XX;njBCqzEG;mToS9=&Dw84F+G0)k7+qQ472I@^D*wSEKa6bq__?>90oCOb( zd=4M;QA1AplT8;k$y56KNQNIv&OG}wE=(8$@b0F@Qn=K3+R#WS-p{!-A$Tv=bxOiH zIHPt#RKT_GI1P-kO=;vsvQkweR`#Y(S`c$v%%k)#R@6w<-6f}UaJygJJO#JhzjFQy z5(!zM*?wAEYh@0xZH1zRmB}{#VFb&#ar1_JM$HmJy?c|6Q1sJH!fsfiyPYHk(0aI@ z_!V&mU7B2n9))^9U&o2DSdo2nw5M_763ykOc0VlS%QgSz-0B8 z3vE-abrB4C`Hqufmzxb6m%j)+;=YxWLxnVvD} ziMIy{jc!5QYYp|6ifSq=Z$Ij+fi0jYQa40ow++>0snqYkKzr5IWm$6TaMmU#BC#6c z9Hp9-Up($Qh*PS-oTOT1w93n`d3M6p&`fUrw;rcZe<;X!KH(CTYF;I)=9<62iIt3D zILRI~7y7l^CGBlxVq{-ig}rXpv0Wqf;ScoJc)q#2+kwXDfSfn!rhgcmls;qP%|$Z! zn^x7n#7eno);&sF75ijGb=!Ho!I%{T*!e7XZ+wIVITkbeSyRj-SaFYgszqLGFJSgR zQKrJi$q#5JIouLDJ`cYmai@+5$}V2qv?18*Y><9tYBbxR}W(O;fkW*Z4bXP&aw zvk+Mj8@0j9cPuUjYz9^!^(;{ft^!q52y$%&SnT zhDKq2FUM+ibak)2cSu@dgANAY(Oi>WQCpiOlcpdIQVxK;1cC8AtD+o=90QocOI&E) zJM@>?2sV(ZGIca8Vk5e-eEOIs&m8+~I6FSVrxpEb6Rq@N@A@h;%L?D z+M0@}==)en`uPVxD$f{b%XqQyw9Vn_ODk^mq!}RJc6I#SSQL1yfNAg7X>rH*Ug~mc zuDPYs03i@G^}yG@h;D>!5$Ac7noXl^b4r-MHvet~pov80Ygj9*<7O2XQ!|sWDxhc7 zniK>fDFb<4@)E6_91^l9$E&BBjgyl|bs_BRiD?3zx(~%0(2>^^7oX1r3{{FkP6KC~ z75Q%Gqp4nAUQjfqMJm5Ax|W`=$!5>Ym=Ax8Aq#o1pl(X(4)SbH`~I*2&vI-a?fN&p zd5vCSQPLF|)FPYhDpL-J0D_JQftM;FhfL}9(f&OD?(%ILEM(GfEg;#AwR3x6G*o143S z&qL(}Lz8qhWPbWjv^oa5V|N=CSLyvtt{&xx#kJO1f@wQ$E}*(>`nVcta_TVi5iS~g zLR}fdhDqr*K-{3&2|NuHNs@!oNhmp#Y5Tl+PU9?03_jYr7mp!*=JWYGYT!9#WF%)@ zIw(g_CkZKqlQ+)m>FFJ-p9#oV3NEmPQOxh9lHh~3vfi*u&)j1Nxo&4dA)f0ekUH6x z)?8xk%bfR%Ksh^$ z2atgw4gLLF>z`Pki*>s|w#51#S;q@7gLUj&KS#g}*3VRMH2&Y51OA4CD(?MV%U2*L PyI}(!2W3G<7sLMt+b+FP literal 0 HcmV?d00001 diff --git a/polaris.shopify.com/public/images/components/box.png b/polaris.shopify.com/public/images/components/box.png new file mode 100644 index 0000000000000000000000000000000000000000..3b80b1e06f08a11ae65310b6c4a1cda161c303b5 GIT binary patch literal 25923 zcmeFZXH-+$_C6dDRKQACDblMTDAGYn0O>6hrANRciuB$@PzeYkRi#Lirc{wm0BO<@ z5l}*q7HT4d7E1D8n{)4PjQ8{V^*Y8m#*Cf4*P3gVXFhYz9c^Twb%yQ|9SjCLb6Z=( z1O_`H2!kDuJaqzm)8ji+0{)_P*S7M4!MJ6i|Bk^^B<;bM$Gl9m)L^9p>`UMu)Gn&} zsxVkZJpF+K4GeZ~{I-Uwng6j>47~;8KR<6yKX`SW=K-2RIT`wi=Zedsgx|Aehll5G z`6?l9m%4ru`%%GPWai|Jt==KeE^KcT&VpOQVDA%N{^tYtAL^rThLYT=jy~Mikv(?w z;Rb*D(ciGQ3xSs<90|ym#brZ*6Eh41(Gi>Dh0JNqeN7|b#dvip>t!^052z(DyrqZutJl;ANq>RY|= zhpRRhSXo(#MvfoPMyG1adU$)^n*=~oR~I18mhZAEDp{E-D%uUQOuYxp{+a3A^S#)(a91GLNVFV!qLevT3z_io8Hu&tM?d zkZwwtYI+w&0}FTJ1}N74dueIu0x~_N;_i%vR9wM1;mW^hf3~tUA12SS%Lnd% z`HlI#0xrFH3IMsZkB_T(Hfs1eW;d;Ag|}U}J2GE68cpyg7(^o$n@PzvRpE|dVd&$q z@FGSapli2XTwI8b8}--l|FA73b=Q4*xbXTVT0sVo8MK%|*g7rATQ{$;5&vB^VaBslc|F)FGxR2XO{usJmS_ll8F{Cxt80J*1{2VNR=FsJ!j+-P40;EhQ&Urlc|-7Z zF5(4)Dx;a@<>FbK)TPzguK0n=;BxrU<=-U}8nC1$rZj9*(Ae7Qs`rZ66OD*yYNi8Q zdBG`k7#7^q3=$_BVw*ZWGt*aH*Eo#W|IRJQ)iqQwfRj}H^5x5bE=^8hZ=8o;m57#lqj%qZ6cqBor$E|7Dn^e8xOYU)A5wynWDSmb7mb8hSJpRdmY{DBig9v$-A#Kc5Z zAn^;nVPRq9Zkv^427@^dIngBS)TExHp{B1fJ11uf`e#wvcem*DyLYR~U2&3si zR~by^BsESY!uaVckHPF8LN=nApwOWbMxI3IrfSsF-eFoc)i$X0losW~#!VV0DC`jH zYrcG`N4&lwg!?wmZB&1Tf$Gc!?E~$BPq7M@9a(jK4d>*K!NMgWy#?x z64Uy}LFQSgm?0j|RrM@w_A1`JjOOBa~Mj%E)d~(ksF2b|y_H z8|gfF%v&7KgA?cETt!6GL>c@KJ%II}xpn$-hYfHHAz`jCx`#ZMg0i1y$bklat<8 z^PloWk%YCiN9qg4V_=v~bVh^CgO6%vX24NlUpmKuo$URB90;TTv_NpEkd8fvAN zT~8yEvcA7VtdPHIr`su*!Ah+W)8n6`7;oOHQGeX?W5Kx6hDiYVq81{1`7Mx6>K!~f z`8cfn#&=<(iu3h$wv8fEJ1V--*B6RL3k$qO=kWWI+eV+KBof5mMOs;%ZjR+m4;2`@ z)v@u{I#G@_MX4O9Eol+jO|-5Jqe}8vqOm%ca`64_UkqpOjj6-!H?2vwq|8qsKupHR z$EW(%w3nGZ^R{@&ns6L;3-ST?b8@a^P!UCZ^n)chm?rXvm!-EG=!;WCRd7M`uJm%x zXoD(|jtKt3l2bOZzEm*#(~y;%NR9A@8wUot6p+|*ewsWS$RK}W33cf+QF~faQsO3b zQ6-6xK#=~-Ud7&kSWVfrwRJ6xhUe$zcLW`W!3>X#!+JD>v>z0Nsqfa#NwHzFLx*M% zatc#auJ@MR6>A@%K44aB?VW`Kq2LC$Tu^s!q#JRj+pthITdjfJn{F%1GX zOgJ2lcqLn{?FIN@mfYv`%R~%=mX;{?>UvWwRf(*O8(pa}4CYS@nbXq-(Z%%fySb&& zgf%?gmw-h-W*E3fZJJ^(@qOtPWqWQe?;-78+3M;4xX&Qx5*J0sn(+&D&he0MTB3z<;*8i7^cP+)Gg z@iiD%02ZWsBs|0gy@!3M^^11uV<0~FsiU&H6#30`y8pi3kwDAXurl`!hUK4o;3@X= zQS3xBavjT&X9j77_UvFy(GhJ@y3vS-=THQ38nQaB?brp#6@TCFtc-T z^m84IyQ$(drgU|I%esFQgX}#84|6&O#1woB4$9UD1V5mZY@4$D!Lo94OCaczN!2W^ z8n&jkcRRl05Gk`}6>Qd!hY>xJkE!uzgW=Kdv)EqCtXRds>(iVlrc!k1p*)uNwN^wl zcg)10Yvt*~9nY5!nIcWq;}@u4;hBIZ3vZod5gQ+sUJsTt=TZq>^`+B1IM9(7+F+AP z8^>Tc8ZX})Z4{O@XGVhUP0Jk#bD{aYSDOt{!Y?>j5vyMDv2t!7)8HrXY`du6TFnDl zR`Q>~=3_9+pmQ`)1KeFqpDI_gwLK`Ss}KL#J~c;jUh=6I@UKG+L}#pN3)9ZekQI8!RB$#G-tK*ayJtU?M^d<-pdL1_7ZP6X~#LTHs!UVTP zKc|Q18by(#^LMPg&!XK-0et|5HC}I7_*F>iT z*ZFvwuZ{3BE1==xM;hMkp9a@zKP9+4XDRT0d}<2+!7<3SWM4MOAR_uwowfPr6n2wOz-9h$LNNT@7Fa%yXi{zvB)WNxI&)r!8S z(N@|#!NoOJ?)_%g4KUbWg^|nh^spA4!rJ{ivXbe!xw!$d?j9b))t}L5Y*Wbo7bF{V zhLAkuaaz&aVC#_s(M!78?(XhG)vpQsX>30=Rb@~Ez_;A_Tc!j&%(^|U-9%PVF{w)aBac@O5j=Q z1?4Q2Fi!6zLwq~M({m>7fd5a(f4Ba1NUnm(z&X1Wz+#!t4Gj(W-c$)XEP#FK5bOH$ z$5@$N!|&g}OOu1kBDq1%0BNVCdO<+}!1ai+U;X|1e!jjx0l&7Q4>_l6vG?A71ku|E zN(?N;#l`E1MB-WS6FcaK0==OTffiLpj&!XpIlX5kKNTHpF)m-pYHGVTBlQi&nclXu#87%_t=g*&tp9{|lZCrZhf3-xc z>%p+Q;|l{e7;N`K7?B!ge~mfHAcJvG#;m6GcWy4o`}PYcK~yM^3YFfm)zws7S7cU= zgM?##(9Z~*lG&s_VSt2_Q&Az5mX$R;cbqbGv9EK&6L;d{ShY$_*^~(d!WiPQo z<)<&h!ucV;10Lh&Kra|d*x2xVMKcbPLJXOn>iJXZi&c~lzdBZ{&s=Ey_!jL0j-p)S zKM!J(Cy2qx`9PBc#x$xkGBWUsi-kc&HIK2rzwh3)sgC{F<2sKMDP=x#LH~N{DR5v{ zmu*$|3ce#eJv~jPY+h4sxkf~HTfX<}>f$FHnocOa9(!=|+aSXF$UWb=02yE!N)3nY zls_~}fm=wlOihk2DhKbD8;$9bfBO-pk_i&suKKrH;}MZ&kbeI6Hx&juZP8pkLIq+m zrM?H`kZ=1b1JRM}qtH1|lvU7iu0lJH-hBrtpfIfyeuV;j>?DSf(p}LlTkzl{z}>)VEUtz*r`)sX z^)CqO{Z28yFw7$I~k#;of3pDmu(wk#k1>qhc6;5%KEvTm>v8aK)6ZSe3219FG$ z1NAgwMrKGgyVz_sFc&vyRptc-MJmjX+`ir(vAQ~Ai92Luo^6K2{GR{F{r6zTW2O=^ za)|YDzVb>+SFzVCYHDQcOq5cB3Co16f#|BLDmRY#YKcpI4_T}WfUp_<-A^U5<$l4~ zx6J6}5IQ2w_;GLX#vgzFIFKS%*~=7v>UUIE$OTCh?>qtSwCqUI)*ZX=->s~;Wt<+S zef4T_ch{c*zNq+|J5x8#%BSGl4@9g|$ypRIP`@Jsb*p;+H=se228ZV2JTZ|CY{2xF z=qsE_)0GD7aD~CXphz1Vw1ZDaXmZlI)v~~+{xbRCcg=>R`NiBDom8vXi;k+k1Ia$W zR6M-AfR?{>f^ZFl{_WkF;p?b;bno=uUVTGt?V<>jC_@Tk<|MZbDa}7GLO4v#s>R6t zVtl}sQ;ybD`apQwruE^WuxV!;Gw~L9KhADp4Vf7t5S3 zg0$&qY4>v+KOFX>o-+yx3iA84?kwmQV9|Dkf72C+=&(7t?RWyEW=!YWdT1+dugUv& zdhp?|Pg1=A*;|^ES?FN57=J4$&<}Q^ZT`6P_4YWn*Q!vRI)2zj+t7YYA!@wak&cxk5iBYZd4$Q zU>WfYZ<(uQ=py1+GUIOPT#%z7J@@8UB;N_0s?)6#lyU6Wv|KPbX2HVYy z%e|Fh4x!4-vB!Qxh0AM4sjdDdd>S6JKA}*dkl;S^=XUqd$@7L`Q}Kq5@}aD!ws;FN zPp}G4Jytw%>0LZpnTFYhF~#9H>>3Mn?)`b)4fkb@>*A;77{vP;I5`_`ZX8^HCTz!Q zL)E`IcX)sZU%%0)T?6M_nhPL~hYXu^G)E)YeQ01Uo<~B^Ym0`Gl?!8IV;G>g7LPd9 zHe0`n#h$*rnu%~}yxSN(gbt1kDW1xavI~&GG19Csq z#P(r#-dNmEl5%8iP_S7a{&^M+E3M#yYKPeAMJ@PNkhtw(h}hQ?z^y@wdjEsts(xD( zQz$?Vq5DDmhv$~Q?2cma*FLA$T>QFuDD*-3qyKe!+AmzkV{p`uX@9V+E#AJip$P?X z-gOy}#k{>OdE+{sH6uBU2m*QYt3Vdz$$oMT^?9Pwg?Qu}`{KQU4C?#XdWtnKt>{K~ z_3I%=qKD*;Df7O-_a+BOEs>B1A2P%Lu>D*fxKn$MC(MAZfh6+6o_Ujge7}WfuZ3sK zK&>wL(;_Sod89OZfUx|Do(9Vopcw;v%UQOu_4W0t&Rn1u=WT1?=V370e|j;$uF;ml zL8cBl$@fKK`_+-Gom-O~zrk@cg8zT+1l-g;H>=}7eyi^mxmx_)oX4ie z0Gjc8T=skF*INn931D$z?LcVPc6N3!TL5T<_>5wvrhLOFYh{_&q-g~z!+3fth~tx! ztH7G?L;hcf|5feVs0#s;Sd0(3Qcj<^KbJLm6^oV2Dm$cX4`MbA!?1o~1L!HN6)gGu zGC@#m#$rb#5ffSouN)sgHZ%eovWFC1OzcT}$NW4vP>k3sd$use6DJJ0E?3R0 zFLZVW*R4~iPaC#Hk;C3m$b#s{56_)DM+rV`I48Y#4Y}=l&M@NT{z0&B=6n|sOW6&| zB+L9*d5XedY+_cA!Gxd!{xpI??VexzyjYU9Y-{=1vuEo8e25EE02rY;WdEn+$4JHr zXDO$rPayylel@xG8mb0 z?m&?JN@{}1(%BwM;p|Dua_T>XHNv2R2=#p!Ofl8g8U_m$f{({O>_KM4R2*hLW3rdw z{Q6ubfG=scm17p*vivU5*>q|~bm|T-vdr^9bWW+UuI|lACakV~!U}JED63{fL#SV; z{8GFrXPtSahQc{y7C==T89?3#$SHmgpHUlY>yH@6mC!oxi05l-Ym~_I@yFV|2qy;B z{z?c6+9U^4y!HPEXDNq>DEVDC5N-Y8g;DXfm`iBkQ9*}U&ovo%9`cFxNIk+Zfm^3xk{rl4tpcJrA*^*WF`?O+%UXk3#iI^jsT0L=P2>EzBggIb>yE zaIir{cwu3{%ht_mDyF%F=Sj!b>ZLya!bp~qy>p+v`9K;xh+h5xgF)1Dxif=Ko;pu< zdoiXiBLWx9H-co7#4@fwZ8|^d$$s6SaM|rJQs|;!Uif}s@@&S2^4#Hl4;)4DW112J z+klpOe{<;_8B?mZL#yeknuZnjlQ2sp(2{WJ1gECds#`OTEP8WYCC+~4i+vk2lBkR< zbnqM2gpzydi5FyJZab(PgC|ql&Q`Nxr6$*G}H|W3O24K_36r4`T=1Z z-2qw8IYdE5^c4;AR`VbAkqk|tzLcDpPj)TVc7aT7r*ddWNJ|K;ChYeWgfnh9zYfY%xfed7}D8tS)Q;8vHFG#qzm*&RF24 zep^=01*?m?@QhfxV#N3#``D9P)x@78X8y?B(aSkC`8rOBJm@S=pOyr2<%6FxaPTOuydmr7y7Q!+z}KSP^%WBVr^L2iluGwc zqfxDU*Ps(OIMo7os}E3BK%$GcUkATq?%i+XB6JbFzqI=>zG<{4~ zS&T0lHCcEpFb-4LVZ+OHE6Pu7JE{}CuJ{qpZIS2MOJxUbD_wZT^f;dzMxcV5L{}M# zU+w%Q;s%Kx2x4jOvEw{2*fU<>X)PJ*-pOGYOdE6M{K$ey{`yze%`_E4?p{lO!Gw5z zO3)4Gg6w156$&HiI|&Dyk!>O;p)1Hz|^JlJVtHBoVXU! zT6w1}yLjfIZ2=8>Z9WZmP`G?TR!NEDo}4fI)X#XGyX`xw9sOeOyPIDY#U}N-bbR~v z?Z9ghP*L@uY?K0dGW#|Y4Sm&Mk(dY9zX<1=dCF`X`5oW}ZM_TB<1FwSrH$|832-OX zn^9(+poDjWi{31oE6l7eukOL7+1AV=Nopn+5s7J2K=l`e&Pj|?#gnTe&Bo)u(ZKrCt5OUAM9hpPHUrC(0w(6E5# zetp(x%V_2-1Lv&!xmRI`?7=y+I15hR#wCdZlKmg3IHT9MhOzOJ7cGC;6nQhMiJD<4 z>3$t6chqcbj@9Ot1&fYogN3Kq)mBbBe0kZg>{njAPwvod#q<#CL}dL$HRY8oBHk$C zUB(`=bmD5`CiI6-@p-tu_&4n*#9rKB?g>WW2Or$`!vM)oE0<9cc2V`c|63Ensnx(x(x27}m_FLLx$8x!m6vt6X|O3BnF zTvPXAX`=*Kcw!jyF__*hRD#uVU}&iA7k5(r_X>AF5=w}DD3@E%PAc}$WB#KtAN0DR zwoB*|5g8y+-08ZNJI>-$LCu>HD){GaGZa_kD0&xNBdw+qy_KAPj96xsfVh;-X#opQ zm>)QRYNhBn?tMN002b^Dc;E-9VS_`P#j-PZ_MEy9o)&d-yCVrZJQ!6(Z^d;TA>5>E zS$^;dz;fCQR$q4>YcoCUE?`gfeufZF4lA|(T96v?P3Z&znf*cq(`v1+SeH`=ZS|)jS;Y+u3;JEJ615Ak-(2*RT{qsC))kWLHZJZj zjT8icV9;^{N-f!L;}`mC6MlYihPTx`f1W6jRM1kdon7M>;4!?0&ar&gFkM3TrcPbO zhOt+uYM)q}r9>V;nky3M7Xxg<9zN_tJ0}e;tX9PC-+xpQphp;87NO+R@ z^Rxw9lb)iic>@NR;T!BY8i_-|9v_rhl%|{9zh?&i-lSIWtLl zLi*J!$JmVH=tM7GT=%zcw=KBKcIw7#2M8$l9Ky{znsS00lj#1qyUM(xnhy^Rs8H4f z(`L*@G}MlD3tFq3tG z81cva%LZYR_ij|gGT4+exd@n)Fc`{t$GRe3`p z%Zao;#9;K9F76m?R{|VgON;m=F|>iCbkw&#H@lw|;wq*-GXD5y6pZ4250%qYd_V1) zrS`Gykpjb~aqfXdim8KHDl&FwDWVfG6&9asxH)98pz^7LEbrAk%MBu9Nqwj_kDvX-$4&-1EYoIQtxz;GmmatiM zL7r4y9B~hiAIR82u4oAyx+RS!%^iO8%4}OKV%jgk{}@~$O$1o1lkcUEyrX@2{<4np zN~NJ-e75qA=h?HQ3Bb&ULHX^8S2I72;D4C7L4s1g;inT;Ry<9~#YgwpFedv=qRmlL zrk4^o8A8fsqSob;bL&FA;}BQv>}m!hybbeW91Cv=jP(QBT>(UIC{GefxwxT@A!X!P zM@0M7>h1+0u5S^i6gfDO)IvvvvL{<@r6ZQBzaM+uwk(AuW#B?Vcgvn^vGrqw?gy_p zr8CwWMATTStK*`vmT6LH%1&3;Q=01mk1I7eVc~xuR*Eiv+Om3jJ7|fW%`+WvP|Oad zyP|SzvSK%;*tGNoTEIk%68;SDkUG z1^?n6x3qLu+Ri<%vNrPDm)?5`!8ZkJInZZt$b*Sa|WS+BP&OSJ5tRVt798B)4e$gPUP;uQzxOZ)2VC0RT*vTpPke4q)jtW5<=ql4VzlRkkmG28swZSrA|ADq%+I~;phyyJ>Q zB7c-d?;qPq*Sl>yn?|IFHVBH$HQw!lkE5%anv~87iSQd0PwF2B3IiPgOH##k1aUUV zYU6D~IH`u|#g4!Y7nMQ&sF{j%C9BHDo{dXgV&`#dKmAEj z`C>;k3JHwyh;Xnp@@c){_osn(Z|s9-FoO;|JG(csuDR|_yy6{J8D8{MB%>)Ub*%SZ zHOA_`<;3uf_C;k_xQ`%&5pUu1KBaGEsqLh7;GIC(c9KKsOQQvnrDRakmPzTEWP>1s zCaBGfd*UyXwu5NhMH)Ub#3I&;0J{qT=U1^_#g~ezq(yJi31mKA9X7Cft+;?$5l$+d zO?$I^>u-LiZ78SdCD)riw28%+)Ged z;<|akZG1YH7oh_*K@?(+BYR6QV~M?hh?K7AoJf;2wX0!OC7G z$TN2oG0B$T7i=s(;VAJK=>!i=WZaFnD6vk?Aa4H^FNZ!G){-k()y%Cq!(f5Zkm8oP zo0_FbyFGd= zdXwcFKANQy|Mo=%{f4PjRKwWa491AQO9<}449LAg#7ekD?bS3A+J)Bl4M~jrgcWI+ z?aITc$?0^1-<0jKG*|yk_nmgO288*9n`+uWAAu>&Kr50+3YZ0q+LxLdg$DDr48fOlxG9lulAm@Dn3=%dpdP!wYRoi6=DOZv z-(JBdg;(Fc5N4Vwa2BDN$sS0^SX(32>3>2E+C%Zr@!%>eY&uGWuARl<91>JB8iO1` z{^L|r`FWTTs+sALQ*f2Jw;{wXlio=ZoJN>U&l)Y**>u6kOk`cwv z*toF1>_Wc8C{>UaUcwu%KX&f2U!5J2w{E;f=f+LzSG=viXb;E~sMtQ8T&&r%nCagn z>AY^iEX!Ka(D3_HLq|8$1 z`uh6be2`!%D@m4=z07UaCx@$=@nLW@kGfr|0t>%%B!J>eYfKlJlf+?}5>dY@QmC<5 ztPEk?U!>Q6EMOtTc0Y|inmC1x|J-LQyY5MP_-Xm=cv{GUp~D4*|8(3onnXk&K79(B zy<9*sNApYLEzQZ;i;IxY-meCI4xdUY?Do@g$2-}azVvy%G!Ok!O7uAiGlIGU%EOy5 zm`Z$ftY1&b{g>2-&{F~16z%_rSyv<^W8YI)NPA9%6CQQ zszO(7fVPxq9Nh%;8-G{(2Nl=(<-iv8vPMP*Gj6iWUKIp-kjn4MfaZg>&ex?;!qhKh zs=O$rh11PFo*@gyPBzC?Vd2^T##<^6#E!f0w@s#=W zjVWvkl@*AGXdaj-tCy7Z`Mf1)30tynYzceOPhV+G%ZVE$sL+8D+mTw( zjC%HOEa0R4ckmdUxQuVEJ+7Bc<&nj7Q*yWsD`VqTgVdI^?D3?$7(NF#pKBG>)zV?0 zH?R=G6+$=6E=cocc8Z4@w!(+m-Zjfw%V{b5J;KI~&%ajKz@o#@CVu|7YIZKJRG->L zO{(x>4ngAK4bT8ShCuu!Z?E00!F!%A_S1{>0HN^fzt9rb4*XsN_a;rP@Y>z`YsEt8 z<001enKQ_F+0v?n<9SSI(>}YX@SJl3#SICz#hzK+BZJSvjQ z>U{h%gnSJ4Q3}Fx6_Xd5s;WlLaOdhuEeK!#JEm_N1ix^T&_5D^M71Mmx+k4fwojF= zx@eyqlsd@-^;94U!)bnB`=&XW2nDzYT9 zd}w2(rrZh#n_f=rS3GFA3xj=tNdIfEVjo=$e6u`1ir4{kNagT#Q^Y8L2* zWTL%5q~(AN@kCO{iDWo|3pA`ws3&-+m5jp^#>|)vRw<6pf)^+jn2Ic%wbi7p258#m z;u;+MDm-;&N`gP@duD8-A7acz`FLpc-5k%)BgM89(nAF~xr>boe7HYM^}ZlZL_zSz z-m3TxBK+V@Gh3!OYSN)m=R32Bq^)4CPpHgHVP$w$-LC1y>cp`m;x*pHPFtx%vrOH3 z{*B2G40?0c4PxxQTMh0~xO=0HtB95N%MJV@Uvsj)xqPMpHS|Z2|GnhDzr8kn48Cc@ zG@&IKRiVaQ+*x~Y|HAf;)QO_Xpd8O^=czLCL7tfbc1CjE1w^@p2kf&?oBw<2!R z%hqnxGL}- zXkRB>ds&fY2KVf2K$hpK2;Gl5qC(iuADSI=q`3rKN`!Ao2+dNGHg{-ou9qi!aU5Kw zbXjh%V>~9)>oB0GX$@DeFk(Xa=y$PxI7`1jtCDflR5lmx*)A-F~MwbUGJo-uSA{~ zvPVS0#`ElOpt70b-aSDXp zG$l^wGL^3BI=>2Bqk$^9|EGD)VXb}e1LV6<0fKSIK1V>m#G2(ViBp0zf#2Gqy)`oi z)v{Cer93n71<1BI011qtW7HhNB5dTaWWT)-CR#z07nyrDs|fl~qP$(bd#&A-kifuS z2<;)s{QN=m>)B*2^hs`l`ankL^V`kaxQDie6m3;y+@@Cp%?G}+qRMwmf0_5`_hy^# z<8DRdH)a;0&jnPVOHTBMsCOP|bV$oT=^|B|mE4 zycFe3LHpt~r?MjHn2+5?by)p<$3N8TY<2v3YT;>GFQq2m$UB+}8LY7>%U{cdd$y9U z6pm&l7TioN4>}FAPyV!x21OqMad;(QJ!7Tz1h_kJgIPEX6LPZYK!KUp%~OlQ^GA1H z=mQh-Zd~b~fQ`(1Sk>g3vcW(v2=5hFXP05bZ*LW}odKnu)g#)KzM;rJPOv z6fqM}nvoKdA0~hcjCdhYHJB3I9LpTBP_+fdHgu~fpcZZe`2&F~@NcmP-)zQ^Yy90A z{Z{E235IpVz&@V9&hKX9qL!zvNtttOc1%}E&K`hluD9}xGxPqn${gi@Jn@pW+AW@=C3k+#T^OrjYd9%V@ zH(J}rInf!JvcNb4snBnt!2cZ&l2dr2V7ETekQTg)d`aBM83HGqY-Tx2Ja@4e;cphB*-B%Z?|srn*< z+MBlVN_I3gBh{_{Ruzm;4=xHOy`On#-W|$TH=Sy=9*}qHU7Hu(8GVx|mGG^eBNW zfQuL;tQZuSYfzt1fqoRm4T1)}nT4kl$ z@PMg5XMz4Rm!Ih-&97h^zQRSVVX+4_?s+4o7nu|J(aan2Rb4ah*KNanQjxX+XApk+ zn|s$DUSQ76V9?&o5Fnj?+cy58V1tyn;#p8`3d$}wq2yGTr=!MObTfnARG47_kDtuW z&_cZrh=T^pxX?GQ2wh&fu}@a-cGaoT9uEh5MI?9w~43kDjc zMXC6&X(t(~kjeSK0wxXbJsdG5J^Xh6^V12}s=FY($U&BzqK)>KiR$$>)_e3>C#=91 zUun>)^h77ql_~~Tcxmaz9K$p_rLh_1F4Sr;)g{(tZqG3_K?<-cOeKo_X*crhH;eV{ zk=~kg=iy)=9n#+T@I8BrcWFqcODDz&bmE@w!Y+V^7@<5t-6xCng6U*tkJ_&SlgZTv z#Xa~hTG20ImGn8Dc_XhFc=E>I&DwHzOh@W$D=1^9on8~%=zPL&y8NBf!(?bB?tT|Gftcr5s6(t7Fu^Q#lIVPpb3Tk^|?6@ zhP`9jobYLeI~wpb23mO*%vkH-`~lRdQM}nZ{XE61&hhieme|3su+xHj`9BYl#aR~( zx1QL?J$D7B?E{&%`K>S+4=Pk~g1Y)QuN6Nt4b;ZnsxF__=IBW)%!41gDSt!B2X!T{ z#1pBRNY{%}?Q=Z!j7xTeaT}o9q)ma#^ArF3+c4Q`V|VoHD?C}Qq+s10W{?uh$G`ji zdkHH7xHRBRl0I;noaXkca$yM(rDZBkL27CG96nrSE=zPg09ApB>Y+V$-Exz<_MnS= zN!l)mm|@T{9^17B7APvv(a2<|5_(YUi!^#RC9~eNtWa-gXgDTrbm`8#WPkP6xY~6lsIE#WTYFTE z!1ROY61Np-4o^w8h*R&W{q!?KE}<=?c?Z#IkW#dy9<8_v-ALu=MsLJA^|OhdEGCo8 zQwU`mVRr!`Z3h+IFEy7iKACF%DM*Vb<$yC_3SrSdqw!pT%0{!9_5~#l?W_33!L2vA zkdP21!d~}4EP|fVi=9#X6Rzd|@&_ ztMs|Zgv)Rsy0zHy*$&T`9VhK6g4<)Jzl6haxg{&|jD64T=mC5Oh5-n`$_pfurx^N0(ZdJd0S z3b3skU{L0J(H*}Z?wCAZ>%?we&v%Cq2_}GkK{kKD8}&UlxF-X*BYJaV$jc-M7`xuOSiUL|ow z@JZybKDgge^FNo)lO522Ot!3PTQ(K`xSgAQlk;m#fV*VSLE&N`$hogT-uAf$NtmRd0>M2WHk^J0GhcdMwc-0KV`WZV-~0=3MYcMbvt%%75HS5piz<4*>wKH^UpqO23I2+Ps_R_XJYCS% zgM)IRzYm3noL5cjg+;V*e_d$>ltT~3*O9dJPzNGc3H);BO^|mBfqVg0_8K@CW?E5d z=C8f?3u66eu*F?+;8H$cP6a;i4bVeQ9w7+ilrQUh`sQ>E=#qZHzdP*I-=MWg^EKr3<(A%@q@_py10K_^4 zywT?0hEx3JrnmAQEn644RdwfQgb%=YpNBz^MuMjKPA{(z3@GcSK{|6|>+fHCDgF* z+28Nx64VexT+pwPR-jbXI1Ri10i(yw=P&+N0P!EJ9R5`&SmVeh6GMZ^NH&hLSD*;GJ&^M0`-wjB&kqeCBgnGf~z z!hatg9+Jwo96AmXxCT*m+cwwu-z`O^DeZafXsLp_aFC<%Qo6Q(>Md~OcaG%Lx7Od^ zmT_7*??d=Ldx-t|jlS+3!&}4g5%nRb#k?)A<)zo$jn6nAawUNaeUq&_E1BXuOuUH; zg%5$T4hg6P_5RJfh|(zBlok1UNW$)Z#Olb<48CG^CUo21-+yts&eKic{O?~=+#Ms5#-spFdGVjU!GaoSR-TOW zRb?SY*ECM8i!PnIb0fX5RsfjG5$}D&3+h`I@gm*bx4QEEBuj|VFyYJY{yMHLW}bK> zxEtxkqPU5Xe;2Q+5jx1UeM8Z&aiVOJ4v3B|8d`vWNnROSf|>EFPp{Rs$~5)nrLii{ zm}##rsCLeJ_;<$>T{|_UtJm3X9<1+9@xNGX;M|*bNT_hQilFu(5=TrP0@XPhyNpJa zMw9VdPV3$QJ7v#|=kZ&hcVV%TZ3yJnZ{uw)-QkM6dTDR|;Bqc62&P*{1D4SZ5l-VJ z^|dl(D}bC*P*7MA$!E*T@#2Xm6&6|TCcx$hT^^<(Y#Sj$Cd{vcxu`c)vf|;(UA*(S zc#hLmc8jHDr9G*yaO0)Rb%{Iv!_x#`-$&5i?n8XqEk@8JUvkGj4yXkFfq7cl;`k_tc);VLEk-3o6^ASm-3C8 z3lV1pXLfgMy|Jnhk)XXbO8&y${NQ0O7yl2HW(t-yu(Tuh(?+nTp2dW3tF-a(C{V8> z-LQ8*bXn#^RfVr`k#f|*V7T{b*ZIH z%X@}LN{*sgTvcFmyx^Z=UlxOM`sqhA2D*eABcUU2Mf82PD{$xW`wGhHrH!U@V61^( z)i_x(wXC4PCO>qrUEX_Q^QMeU16+Tp5pw*I&213N>pUEvH227TT&R!t35+wJmbAcSU+umLIZLr~noBw&2fQcyO6!e5KZ9CWslsxDC0%*U*+# z5tA>QN&y}1ZE#Q3xB4f2rI&c{;a+vgm$)E-W{dSbXh`P&F3mv4?F%%ghR{u@8Vf6& zU|{(?F8zuislg`IZX4$WkZr&()@ zYLz{Po$-NY7G?!<5=SrWdKxHnO7LgMJwpivW~r&7z?wGj{)hMUl~qU{Y_3VlEf>}< zdBPk2;+aczBVf?!mim!ssuwXE!pii5WKj&271{dH3mEq^I%Uw^c8rFS;CgTPeWx0* z!#f)_0YHwX74|hbi}epc;pyZ>m!w0+aGONLy$gss}Ko#!XlD z31|x5z`$U^&Q6pNq!zcV=7%Bxh2~KCV(k9u$gll7KO`bA_yrY1DB)9JeP;P8W9Lyq zIM2Rl@eb=;we#3BB}Nr6Blv0Z4x|aZWao2WNqBmETPSb(Za#Y!H4`-Yv%vjT_e`~= zLT-9GJ$k#-60GQ`<1M^Zk!e!t@y8K@(>ZltBeRCa##PWAy}gPJ^YD-iGwXHz{rmUI zZZ*o)DZv9IyMGyuwm~#9TD;MT3;1qT4yp(UfYh^|GocgRqQ|`N9K_L#54vyz`Si9Q zOw`Icc*5l8AoTs_h`o3ig3M>cQ^eJ5>h8&;aTev&^%++qRlvS z$4{TcfoN{jUVwxl04Z5JH=+qv{#x)+o+Sl3m=d~ls^yS1${&G-N(URq{Jh0(#cSma|$CK0pZxyh~KX?N% zE7)umjcXNXw8}X_|NI>Hw(66xmLX_>@7fF0`n7F+F#!xC7#Onw<9O&huMY13KmF7@ z_+ui<^=Rhc>h2gPGzWd?2HnJ#oemZf`n=%;)Np!D8Zj)z3CJE)_?tz%euU(K!?W!;5&q92>u5i7==3AOwy-h}l)((RwO) zdU;htoz+wVI>~*!L9n&{Ikh~1Ga9qQ;;)M8>Wn}%0VCYvYi8i>Rp0W`=P9ptn8KU5 z(+X*oQUQ}4VPFQnQ$fjQ<~i~@!O{rw8yRUIE3TxJ7hSx+1qknm;|2`MkC#4JuH68# z2=9h;6;aG6w_3KXn4GnF1%-g#jR2^zX>V#8U3$4i-jNN=F%F^!K@iIURTNe|2YBl> z1ZG)r@3Z-rRwfwKN{Lb7yzkX;503qPLy;0o?Ujj(x@4fI%m;kvk zPvV!cuJQ59TJ#V2HPC2rs*6Xvh4PlYza|<0MIs~6lAiI~n!k0?*6Lw9&;SyIaH{#r zS>oeXw=GmHEfe^6g~dNb2eI$FNT`lV5!lkC}7eC;JG?Oqy9*J(vtWZSO`3e%%ytr@mwLoe~{qNR>t)>6vfgirCxKi%&g8v62Es!KA4c<$V}fvU$_IM1gu z;B}0^XX;njBCqzEG;mToS9=&Dw84F+G0)k7+qQ472I@^D*wSEKa6bq__?>90oCOb( zd=4M;QA1AplT8;k$y56KNQNIv&OG}wE=(8$@b0F@Qn=K3+R#WS-p{!-A$Tv=bxOiH zIHPt#RKT_GI1P-kO=;vsvQkweR`#Y(S`c$v%%k)#R@6w<-6f}UaJygJJO#JhzjFQy z5(!zM*?wAEYh@0xZH1zRmB}{#VFb&#ar1_JM$HmJy?c|6Q1sJH!fsfiyPYHk(0aI@ z_!V&mU7B2n9))^9U&o2DSdo2nw5M_763ykOc0VlS%QgSz-0B8 z3vE-abrB4C`Hqufmzxb6m%j)+;=YxWLxnVvD} ziMIy{jc!5QYYp|6ifSq=Z$Ij+fi0jYQa40ow++>0snqYkKzr5IWm$6TaMmU#BC#6c z9Hp9-Up($Qh*PS-oTOT1w93n`d3M6p&`fUrw;rcZe<;X!KH(CTYF;I)=9<62iIt3D zILRI~7y7l^CGBlxVq{-ig}rXpv0Wqf;ScoJc)q#2+kwXDfSfn!rhgcmls;qP%|$Z! zn^x7n#7eno);&sF75ijGb=!Ho!I%{T*!e7XZ+wIVITkbeSyRj-SaFYgszqLGFJSgR zQKrJi$q#5JIouLDJ`cYmai@+5$}V2qv?18*Y><9tYBbxR}W(O;fkW*Z4bXP&aw zvk+Mj8@0j9cPuUjYz9^!^(;{ft^!q52y$%&SnT zhDKq2FUM+ibak)2cSu@dgANAY(Oi>WQCpiOlcpdIQVxK;1cC8AtD+o=90QocOI&E) zJM@>?2sV(ZGIca8Vk5e-eEOIs&m8+~I6FSVrxpEb6Rq@N@A@h;%L?D z+M0@}==)en`uPVxD$f{b%XqQyw9Vn_ODk^mq!}RJc6I#SSQL1yfNAg7X>rH*Ug~mc zuDPYs03i@G^}yG@h;D>!5$Ac7noXl^b4r-MHvet~pov80Ygj9*<7O2XQ!|sWDxhc7 zniK>fDFb<4@)E6_91^l9$E&BBjgyl|bs_BRiD?3zx(~%0(2>^^7oX1r3{{FkP6KC~ z75Q%Gqp4nAUQjfqMJm5Ax|W`=$!5>Ym=Ax8Aq#o1pl(X(4)SbH`~I*2&vI-a?fN&p zd5vCSQPLF|)FPYhDpL-J0D_JQftM;FhfL}9(f&OD?(%ILEM(GfEg;#AwR3x6G*o143S z&qL(}Lz8qhWPbWjv^oa5V|N=CSLyvtt{&xx#kJO1f@wQ$E}*(>`nVcta_TVi5iS~g zLR}fdhDqr*K-{3&2|NuHNs@!oNhmp#Y5Tl+PU9?03_jYr7mp!*=JWYGYT!9#WF%)@ zIw(g_CkZKqlQ+)m>FFJ-p9#oV3NEmPQOxh9lHh~3vfi*u&)j1Nxo&4dA)f0ekUH6x z)?8xk%bfR%Ksh^$ z2atgw4gLLF>z`Pki*>s|w#51#S;q@7gLUj&KS#g}*3VRMH2&Y51OA4CD(?MV%U2*L PyI}(!2W3G<7sLMt+b+FP literal 0 HcmV?d00001 diff --git a/polaris.shopify.com/public/images/components/columns.png b/polaris.shopify.com/public/images/components/columns.png new file mode 100644 index 0000000000000000000000000000000000000000..3b80b1e06f08a11ae65310b6c4a1cda161c303b5 GIT binary patch literal 25923 zcmeFZXH-+$_C6dDRKQACDblMTDAGYn0O>6hrANRciuB$@PzeYkRi#Lirc{wm0BO<@ z5l}*q7HT4d7E1D8n{)4PjQ8{V^*Y8m#*Cf4*P3gVXFhYz9c^Twb%yQ|9SjCLb6Z=( z1O_`H2!kDuJaqzm)8ji+0{)_P*S7M4!MJ6i|Bk^^B<;bM$Gl9m)L^9p>`UMu)Gn&} zsxVkZJpF+K4GeZ~{I-Uwng6j>47~;8KR<6yKX`SW=K-2RIT`wi=Zedsgx|Aehll5G z`6?l9m%4ru`%%GPWai|Jt==KeE^KcT&VpOQVDA%N{^tYtAL^rThLYT=jy~Mikv(?w z;Rb*D(ciGQ3xSs<90|ym#brZ*6Eh41(Gi>Dh0JNqeN7|b#dvip>t!^052z(DyrqZutJl;ANq>RY|= zhpRRhSXo(#MvfoPMyG1adU$)^n*=~oR~I18mhZAEDp{E-D%uUQOuYxp{+a3A^S#)(a91GLNVFV!qLevT3z_io8Hu&tM?d zkZwwtYI+w&0}FTJ1}N74dueIu0x~_N;_i%vR9wM1;mW^hf3~tUA12SS%Lnd% z`HlI#0xrFH3IMsZkB_T(Hfs1eW;d;Ag|}U}J2GE68cpyg7(^o$n@PzvRpE|dVd&$q z@FGSapli2XTwI8b8}--l|FA73b=Q4*xbXTVT0sVo8MK%|*g7rATQ{$;5&vB^VaBslc|F)FGxR2XO{usJmS_ll8F{Cxt80J*1{2VNR=FsJ!j+-P40;EhQ&Urlc|-7Z zF5(4)Dx;a@<>FbK)TPzguK0n=;BxrU<=-U}8nC1$rZj9*(Ae7Qs`rZ66OD*yYNi8Q zdBG`k7#7^q3=$_BVw*ZWGt*aH*Eo#W|IRJQ)iqQwfRj}H^5x5bE=^8hZ=8o;m57#lqj%qZ6cqBor$E|7Dn^e8xOYU)A5wynWDSmb7mb8hSJpRdmY{DBig9v$-A#Kc5Z zAn^;nVPRq9Zkv^427@^dIngBS)TExHp{B1fJ11uf`e#wvcem*DyLYR~U2&3si zR~by^BsESY!uaVckHPF8LN=nApwOWbMxI3IrfSsF-eFoc)i$X0losW~#!VV0DC`jH zYrcG`N4&lwg!?wmZB&1Tf$Gc!?E~$BPq7M@9a(jK4d>*K!NMgWy#?x z64Uy}LFQSgm?0j|RrM@w_A1`JjOOBa~Mj%E)d~(ksF2b|y_H z8|gfF%v&7KgA?cETt!6GL>c@KJ%II}xpn$-hYfHHAz`jCx`#ZMg0i1y$bklat<8 z^PloWk%YCiN9qg4V_=v~bVh^CgO6%vX24NlUpmKuo$URB90;TTv_NpEkd8fvAN zT~8yEvcA7VtdPHIr`su*!Ah+W)8n6`7;oOHQGeX?W5Kx6hDiYVq81{1`7Mx6>K!~f z`8cfn#&=<(iu3h$wv8fEJ1V--*B6RL3k$qO=kWWI+eV+KBof5mMOs;%ZjR+m4;2`@ z)v@u{I#G@_MX4O9Eol+jO|-5Jqe}8vqOm%ca`64_UkqpOjj6-!H?2vwq|8qsKupHR z$EW(%w3nGZ^R{@&ns6L;3-ST?b8@a^P!UCZ^n)chm?rXvm!-EG=!;WCRd7M`uJm%x zXoD(|jtKt3l2bOZzEm*#(~y;%NR9A@8wUot6p+|*ewsWS$RK}W33cf+QF~faQsO3b zQ6-6xK#=~-Ud7&kSWVfrwRJ6xhUe$zcLW`W!3>X#!+JD>v>z0Nsqfa#NwHzFLx*M% zatc#auJ@MR6>A@%K44aB?VW`Kq2LC$Tu^s!q#JRj+pthITdjfJn{F%1GX zOgJ2lcqLn{?FIN@mfYv`%R~%=mX;{?>UvWwRf(*O8(pa}4CYS@nbXq-(Z%%fySb&& zgf%?gmw-h-W*E3fZJJ^(@qOtPWqWQe?;-78+3M;4xX&Qx5*J0sn(+&D&he0MTB3z<;*8i7^cP+)Gg z@iiD%02ZWsBs|0gy@!3M^^11uV<0~FsiU&H6#30`y8pi3kwDAXurl`!hUK4o;3@X= zQS3xBavjT&X9j77_UvFy(GhJ@y3vS-=THQ38nQaB?brp#6@TCFtc-T z^m84IyQ$(drgU|I%esFQgX}#84|6&O#1woB4$9UD1V5mZY@4$D!Lo94OCaczN!2W^ z8n&jkcRRl05Gk`}6>Qd!hY>xJkE!uzgW=Kdv)EqCtXRds>(iVlrc!k1p*)uNwN^wl zcg)10Yvt*~9nY5!nIcWq;}@u4;hBIZ3vZod5gQ+sUJsTt=TZq>^`+B1IM9(7+F+AP z8^>Tc8ZX})Z4{O@XGVhUP0Jk#bD{aYSDOt{!Y?>j5vyMDv2t!7)8HrXY`du6TFnDl zR`Q>~=3_9+pmQ`)1KeFqpDI_gwLK`Ss}KL#J~c;jUh=6I@UKG+L}#pN3)9ZekQI8!RB$#G-tK*ayJtU?M^d<-pdL1_7ZP6X~#LTHs!UVTP zKc|Q18by(#^LMPg&!XK-0et|5HC}I7_*F>iT z*ZFvwuZ{3BE1==xM;hMkp9a@zKP9+4XDRT0d}<2+!7<3SWM4MOAR_uwowfPr6n2wOz-9h$LNNT@7Fa%yXi{zvB)WNxI&)r!8S z(N@|#!NoOJ?)_%g4KUbWg^|nh^spA4!rJ{ivXbe!xw!$d?j9b))t}L5Y*Wbo7bF{V zhLAkuaaz&aVC#_s(M!78?(XhG)vpQsX>30=Rb@~Ez_;A_Tc!j&%(^|U-9%PVF{w)aBac@O5j=Q z1?4Q2Fi!6zLwq~M({m>7fd5a(f4Ba1NUnm(z&X1Wz+#!t4Gj(W-c$)XEP#FK5bOH$ z$5@$N!|&g}OOu1kBDq1%0BNVCdO<+}!1ai+U;X|1e!jjx0l&7Q4>_l6vG?A71ku|E zN(?N;#l`E1MB-WS6FcaK0==OTffiLpj&!XpIlX5kKNTHpF)m-pYHGVTBlQi&nclXu#87%_t=g*&tp9{|lZCrZhf3-xc z>%p+Q;|l{e7;N`K7?B!ge~mfHAcJvG#;m6GcWy4o`}PYcK~yM^3YFfm)zws7S7cU= zgM?##(9Z~*lG&s_VSt2_Q&Az5mX$R;cbqbGv9EK&6L;d{ShY$_*^~(d!WiPQo z<)<&h!ucV;10Lh&Kra|d*x2xVMKcbPLJXOn>iJXZi&c~lzdBZ{&s=Ey_!jL0j-p)S zKM!J(Cy2qx`9PBc#x$xkGBWUsi-kc&HIK2rzwh3)sgC{F<2sKMDP=x#LH~N{DR5v{ zmu*$|3ce#eJv~jPY+h4sxkf~HTfX<}>f$FHnocOa9(!=|+aSXF$UWb=02yE!N)3nY zls_~}fm=wlOihk2DhKbD8;$9bfBO-pk_i&suKKrH;}MZ&kbeI6Hx&juZP8pkLIq+m zrM?H`kZ=1b1JRM}qtH1|lvU7iu0lJH-hBrtpfIfyeuV;j>?DSf(p}LlTkzl{z}>)VEUtz*r`)sX z^)CqO{Z28yFw7$I~k#;of3pDmu(wk#k1>qhc6;5%KEvTm>v8aK)6ZSe3219FG$ z1NAgwMrKGgyVz_sFc&vyRptc-MJmjX+`ir(vAQ~Ai92Luo^6K2{GR{F{r6zTW2O=^ za)|YDzVb>+SFzVCYHDQcOq5cB3Co16f#|BLDmRY#YKcpI4_T}WfUp_<-A^U5<$l4~ zx6J6}5IQ2w_;GLX#vgzFIFKS%*~=7v>UUIE$OTCh?>qtSwCqUI)*ZX=->s~;Wt<+S zef4T_ch{c*zNq+|J5x8#%BSGl4@9g|$ypRIP`@Jsb*p;+H=se228ZV2JTZ|CY{2xF z=qsE_)0GD7aD~CXphz1Vw1ZDaXmZlI)v~~+{xbRCcg=>R`NiBDom8vXi;k+k1Ia$W zR6M-AfR?{>f^ZFl{_WkF;p?b;bno=uUVTGt?V<>jC_@Tk<|MZbDa}7GLO4v#s>R6t zVtl}sQ;ybD`apQwruE^WuxV!;Gw~L9KhADp4Vf7t5S3 zg0$&qY4>v+KOFX>o-+yx3iA84?kwmQV9|Dkf72C+=&(7t?RWyEW=!YWdT1+dugUv& zdhp?|Pg1=A*;|^ES?FN57=J4$&<}Q^ZT`6P_4YWn*Q!vRI)2zj+t7YYA!@wak&cxk5iBYZd4$Q zU>WfYZ<(uQ=py1+GUIOPT#%z7J@@8UB;N_0s?)6#lyU6Wv|KPbX2HVYy z%e|Fh4x!4-vB!Qxh0AM4sjdDdd>S6JKA}*dkl;S^=XUqd$@7L`Q}Kq5@}aD!ws;FN zPp}G4Jytw%>0LZpnTFYhF~#9H>>3Mn?)`b)4fkb@>*A;77{vP;I5`_`ZX8^HCTz!Q zL)E`IcX)sZU%%0)T?6M_nhPL~hYXu^G)E)YeQ01Uo<~B^Ym0`Gl?!8IV;G>g7LPd9 zHe0`n#h$*rnu%~}yxSN(gbt1kDW1xavI~&GG19Csq z#P(r#-dNmEl5%8iP_S7a{&^M+E3M#yYKPeAMJ@PNkhtw(h}hQ?z^y@wdjEsts(xD( zQz$?Vq5DDmhv$~Q?2cma*FLA$T>QFuDD*-3qyKe!+AmzkV{p`uX@9V+E#AJip$P?X z-gOy}#k{>OdE+{sH6uBU2m*QYt3Vdz$$oMT^?9Pwg?Qu}`{KQU4C?#XdWtnKt>{K~ z_3I%=qKD*;Df7O-_a+BOEs>B1A2P%Lu>D*fxKn$MC(MAZfh6+6o_Ujge7}WfuZ3sK zK&>wL(;_Sod89OZfUx|Do(9Vopcw;v%UQOu_4W0t&Rn1u=WT1?=V370e|j;$uF;ml zL8cBl$@fKK`_+-Gom-O~zrk@cg8zT+1l-g;H>=}7eyi^mxmx_)oX4ie z0Gjc8T=skF*INn931D$z?LcVPc6N3!TL5T<_>5wvrhLOFYh{_&q-g~z!+3fth~tx! ztH7G?L;hcf|5feVs0#s;Sd0(3Qcj<^KbJLm6^oV2Dm$cX4`MbA!?1o~1L!HN6)gGu zGC@#m#$rb#5ffSouN)sgHZ%eovWFC1OzcT}$NW4vP>k3sd$use6DJJ0E?3R0 zFLZVW*R4~iPaC#Hk;C3m$b#s{56_)DM+rV`I48Y#4Y}=l&M@NT{z0&B=6n|sOW6&| zB+L9*d5XedY+_cA!Gxd!{xpI??VexzyjYU9Y-{=1vuEo8e25EE02rY;WdEn+$4JHr zXDO$rPayylel@xG8mb0 z?m&?JN@{}1(%BwM;p|Dua_T>XHNv2R2=#p!Ofl8g8U_m$f{({O>_KM4R2*hLW3rdw z{Q6ubfG=scm17p*vivU5*>q|~bm|T-vdr^9bWW+UuI|lACakV~!U}JED63{fL#SV; z{8GFrXPtSahQc{y7C==T89?3#$SHmgpHUlY>yH@6mC!oxi05l-Ym~_I@yFV|2qy;B z{z?c6+9U^4y!HPEXDNq>DEVDC5N-Y8g;DXfm`iBkQ9*}U&ovo%9`cFxNIk+Zfm^3xk{rl4tpcJrA*^*WF`?O+%UXk3#iI^jsT0L=P2>EzBggIb>yE zaIir{cwu3{%ht_mDyF%F=Sj!b>ZLya!bp~qy>p+v`9K;xh+h5xgF)1Dxif=Ko;pu< zdoiXiBLWx9H-co7#4@fwZ8|^d$$s6SaM|rJQs|;!Uif}s@@&S2^4#Hl4;)4DW112J z+klpOe{<;_8B?mZL#yeknuZnjlQ2sp(2{WJ1gECds#`OTEP8WYCC+~4i+vk2lBkR< zbnqM2gpzydi5FyJZab(PgC|ql&Q`Nxr6$*G}H|W3O24K_36r4`T=1Z z-2qw8IYdE5^c4;AR`VbAkqk|tzLcDpPj)TVc7aT7r*ddWNJ|K;ChYeWgfnh9zYfY%xfed7}D8tS)Q;8vHFG#qzm*&RF24 zep^=01*?m?@QhfxV#N3#``D9P)x@78X8y?B(aSkC`8rOBJm@S=pOyr2<%6FxaPTOuydmr7y7Q!+z}KSP^%WBVr^L2iluGwc zqfxDU*Ps(OIMo7os}E3BK%$GcUkATq?%i+XB6JbFzqI=>zG<{4~ zS&T0lHCcEpFb-4LVZ+OHE6Pu7JE{}CuJ{qpZIS2MOJxUbD_wZT^f;dzMxcV5L{}M# zU+w%Q;s%Kx2x4jOvEw{2*fU<>X)PJ*-pOGYOdE6M{K$ey{`yze%`_E4?p{lO!Gw5z zO3)4Gg6w156$&HiI|&Dyk!>O;p)1Hz|^JlJVtHBoVXU! zT6w1}yLjfIZ2=8>Z9WZmP`G?TR!NEDo}4fI)X#XGyX`xw9sOeOyPIDY#U}N-bbR~v z?Z9ghP*L@uY?K0dGW#|Y4Sm&Mk(dY9zX<1=dCF`X`5oW}ZM_TB<1FwSrH$|832-OX zn^9(+poDjWi{31oE6l7eukOL7+1AV=Nopn+5s7J2K=l`e&Pj|?#gnTe&Bo)u(ZKrCt5OUAM9hpPHUrC(0w(6E5# zetp(x%V_2-1Lv&!xmRI`?7=y+I15hR#wCdZlKmg3IHT9MhOzOJ7cGC;6nQhMiJD<4 z>3$t6chqcbj@9Ot1&fYogN3Kq)mBbBe0kZg>{njAPwvod#q<#CL}dL$HRY8oBHk$C zUB(`=bmD5`CiI6-@p-tu_&4n*#9rKB?g>WW2Or$`!vM)oE0<9cc2V`c|63Ensnx(x(x27}m_FLLx$8x!m6vt6X|O3BnF zTvPXAX`=*Kcw!jyF__*hRD#uVU}&iA7k5(r_X>AF5=w}DD3@E%PAc}$WB#KtAN0DR zwoB*|5g8y+-08ZNJI>-$LCu>HD){GaGZa_kD0&xNBdw+qy_KAPj96xsfVh;-X#opQ zm>)QRYNhBn?tMN002b^Dc;E-9VS_`P#j-PZ_MEy9o)&d-yCVrZJQ!6(Z^d;TA>5>E zS$^;dz;fCQR$q4>YcoCUE?`gfeufZF4lA|(T96v?P3Z&znf*cq(`v1+SeH`=ZS|)jS;Y+u3;JEJ615Ak-(2*RT{qsC))kWLHZJZj zjT8icV9;^{N-f!L;}`mC6MlYihPTx`f1W6jRM1kdon7M>;4!?0&ar&gFkM3TrcPbO zhOt+uYM)q}r9>V;nky3M7Xxg<9zN_tJ0}e;tX9PC-+xpQphp;87NO+R@ z^Rxw9lb)iic>@NR;T!BY8i_-|9v_rhl%|{9zh?&i-lSIWtLl zLi*J!$JmVH=tM7GT=%zcw=KBKcIw7#2M8$l9Ky{znsS00lj#1qyUM(xnhy^Rs8H4f z(`L*@G}MlD3tFq3tG z81cva%LZYR_ij|gGT4+exd@n)Fc`{t$GRe3`p z%Zao;#9;K9F76m?R{|VgON;m=F|>iCbkw&#H@lw|;wq*-GXD5y6pZ4250%qYd_V1) zrS`Gykpjb~aqfXdim8KHDl&FwDWVfG6&9asxH)98pz^7LEbrAk%MBu9Nqwj_kDvX-$4&-1EYoIQtxz;GmmatiM zL7r4y9B~hiAIR82u4oAyx+RS!%^iO8%4}OKV%jgk{}@~$O$1o1lkcUEyrX@2{<4np zN~NJ-e75qA=h?HQ3Bb&ULHX^8S2I72;D4C7L4s1g;inT;Ry<9~#YgwpFedv=qRmlL zrk4^o8A8fsqSob;bL&FA;}BQv>}m!hybbeW91Cv=jP(QBT>(UIC{GefxwxT@A!X!P zM@0M7>h1+0u5S^i6gfDO)IvvvvL{<@r6ZQBzaM+uwk(AuW#B?Vcgvn^vGrqw?gy_p zr8CwWMATTStK*`vmT6LH%1&3;Q=01mk1I7eVc~xuR*Eiv+Om3jJ7|fW%`+WvP|Oad zyP|SzvSK%;*tGNoTEIk%68;SDkUG z1^?n6x3qLu+Ri<%vNrPDm)?5`!8ZkJInZZt$b*Sa|WS+BP&OSJ5tRVt798B)4e$gPUP;uQzxOZ)2VC0RT*vTpPke4q)jtW5<=ql4VzlRkkmG28swZSrA|ADq%+I~;phyyJ>Q zB7c-d?;qPq*Sl>yn?|IFHVBH$HQw!lkE5%anv~87iSQd0PwF2B3IiPgOH##k1aUUV zYU6D~IH`u|#g4!Y7nMQ&sF{j%C9BHDo{dXgV&`#dKmAEj z`C>;k3JHwyh;Xnp@@c){_osn(Z|s9-FoO;|JG(csuDR|_yy6{J8D8{MB%>)Ub*%SZ zHOA_`<;3uf_C;k_xQ`%&5pUu1KBaGEsqLh7;GIC(c9KKsOQQvnrDRakmPzTEWP>1s zCaBGfd*UyXwu5NhMH)Ub#3I&;0J{qT=U1^_#g~ezq(yJi31mKA9X7Cft+;?$5l$+d zO?$I^>u-LiZ78SdCD)riw28%+)Ged z;<|akZG1YH7oh_*K@?(+BYR6QV~M?hh?K7AoJf;2wX0!OC7G z$TN2oG0B$T7i=s(;VAJK=>!i=WZaFnD6vk?Aa4H^FNZ!G){-k()y%Cq!(f5Zkm8oP zo0_FbyFGd= zdXwcFKANQy|Mo=%{f4PjRKwWa491AQO9<}449LAg#7ekD?bS3A+J)Bl4M~jrgcWI+ z?aITc$?0^1-<0jKG*|yk_nmgO288*9n`+uWAAu>&Kr50+3YZ0q+LxLdg$DDr48fOlxG9lulAm@Dn3=%dpdP!wYRoi6=DOZv z-(JBdg;(Fc5N4Vwa2BDN$sS0^SX(32>3>2E+C%Zr@!%>eY&uGWuARl<91>JB8iO1` z{^L|r`FWTTs+sALQ*f2Jw;{wXlio=ZoJN>U&l)Y**>u6kOk`cwv z*toF1>_Wc8C{>UaUcwu%KX&f2U!5J2w{E;f=f+LzSG=viXb;E~sMtQ8T&&r%nCagn z>AY^iEX!Ka(D3_HLq|8$1 z`uh6be2`!%D@m4=z07UaCx@$=@nLW@kGfr|0t>%%B!J>eYfKlJlf+?}5>dY@QmC<5 ztPEk?U!>Q6EMOtTc0Y|inmC1x|J-LQyY5MP_-Xm=cv{GUp~D4*|8(3onnXk&K79(B zy<9*sNApYLEzQZ;i;IxY-meCI4xdUY?Do@g$2-}azVvy%G!Ok!O7uAiGlIGU%EOy5 zm`Z$ftY1&b{g>2-&{F~16z%_rSyv<^W8YI)NPA9%6CQQ zszO(7fVPxq9Nh%;8-G{(2Nl=(<-iv8vPMP*Gj6iWUKIp-kjn4MfaZg>&ex?;!qhKh zs=O$rh11PFo*@gyPBzC?Vd2^T##<^6#E!f0w@s#=W zjVWvkl@*AGXdaj-tCy7Z`Mf1)30tynYzceOPhV+G%ZVE$sL+8D+mTw( zjC%HOEa0R4ckmdUxQuVEJ+7Bc<&nj7Q*yWsD`VqTgVdI^?D3?$7(NF#pKBG>)zV?0 zH?R=G6+$=6E=cocc8Z4@w!(+m-Zjfw%V{b5J;KI~&%ajKz@o#@CVu|7YIZKJRG->L zO{(x>4ngAK4bT8ShCuu!Z?E00!F!%A_S1{>0HN^fzt9rb4*XsN_a;rP@Y>z`YsEt8 z<001enKQ_F+0v?n<9SSI(>}YX@SJl3#SICz#hzK+BZJSvjQ z>U{h%gnSJ4Q3}Fx6_Xd5s;WlLaOdhuEeK!#JEm_N1ix^T&_5D^M71Mmx+k4fwojF= zx@eyqlsd@-^;94U!)bnB`=&XW2nDzYT9 zd}w2(rrZh#n_f=rS3GFA3xj=tNdIfEVjo=$e6u`1ir4{kNagT#Q^Y8L2* zWTL%5q~(AN@kCO{iDWo|3pA`ws3&-+m5jp^#>|)vRw<6pf)^+jn2Ic%wbi7p258#m z;u;+MDm-;&N`gP@duD8-A7acz`FLpc-5k%)BgM89(nAF~xr>boe7HYM^}ZlZL_zSz z-m3TxBK+V@Gh3!OYSN)m=R32Bq^)4CPpHgHVP$w$-LC1y>cp`m;x*pHPFtx%vrOH3 z{*B2G40?0c4PxxQTMh0~xO=0HtB95N%MJV@Uvsj)xqPMpHS|Z2|GnhDzr8kn48Cc@ zG@&IKRiVaQ+*x~Y|HAf;)QO_Xpd8O^=czLCL7tfbc1CjE1w^@p2kf&?oBw<2!R z%hqnxGL}- zXkRB>ds&fY2KVf2K$hpK2;Gl5qC(iuADSI=q`3rKN`!Ao2+dNGHg{-ou9qi!aU5Kw zbXjh%V>~9)>oB0GX$@DeFk(Xa=y$PxI7`1jtCDflR5lmx*)A-F~MwbUGJo-uSA{~ zvPVS0#`ElOpt70b-aSDXp zG$l^wGL^3BI=>2Bqk$^9|EGD)VXb}e1LV6<0fKSIK1V>m#G2(ViBp0zf#2Gqy)`oi z)v{Cer93n71<1BI011qtW7HhNB5dTaWWT)-CR#z07nyrDs|fl~qP$(bd#&A-kifuS z2<;)s{QN=m>)B*2^hs`l`ankL^V`kaxQDie6m3;y+@@Cp%?G}+qRMwmf0_5`_hy^# z<8DRdH)a;0&jnPVOHTBMsCOP|bV$oT=^|B|mE4 zycFe3LHpt~r?MjHn2+5?by)p<$3N8TY<2v3YT;>GFQq2m$UB+}8LY7>%U{cdd$y9U z6pm&l7TioN4>}FAPyV!x21OqMad;(QJ!7Tz1h_kJgIPEX6LPZYK!KUp%~OlQ^GA1H z=mQh-Zd~b~fQ`(1Sk>g3vcW(v2=5hFXP05bZ*LW}odKnu)g#)KzM;rJPOv z6fqM}nvoKdA0~hcjCdhYHJB3I9LpTBP_+fdHgu~fpcZZe`2&F~@NcmP-)zQ^Yy90A z{Z{E235IpVz&@V9&hKX9qL!zvNtttOc1%}E&K`hluD9}xGxPqn${gi@Jn@pW+AW@=C3k+#T^OrjYd9%V@ zH(J}rInf!JvcNb4snBnt!2cZ&l2dr2V7ETekQTg)d`aBM83HGqY-Tx2Ja@4e;cphB*-B%Z?|srn*< z+MBlVN_I3gBh{_{Ruzm;4=xHOy`On#-W|$TH=Sy=9*}qHU7Hu(8GVx|mGG^eBNW zfQuL;tQZuSYfzt1fqoRm4T1)}nT4kl$ z@PMg5XMz4Rm!Ih-&97h^zQRSVVX+4_?s+4o7nu|J(aan2Rb4ah*KNanQjxX+XApk+ zn|s$DUSQ76V9?&o5Fnj?+cy58V1tyn;#p8`3d$}wq2yGTr=!MObTfnARG47_kDtuW z&_cZrh=T^pxX?GQ2wh&fu}@a-cGaoT9uEh5MI?9w~43kDjc zMXC6&X(t(~kjeSK0wxXbJsdG5J^Xh6^V12}s=FY($U&BzqK)>KiR$$>)_e3>C#=91 zUun>)^h77ql_~~Tcxmaz9K$p_rLh_1F4Sr;)g{(tZqG3_K?<-cOeKo_X*crhH;eV{ zk=~kg=iy)=9n#+T@I8BrcWFqcODDz&bmE@w!Y+V^7@<5t-6xCng6U*tkJ_&SlgZTv z#Xa~hTG20ImGn8Dc_XhFc=E>I&DwHzOh@W$D=1^9on8~%=zPL&y8NBf!(?bB?tT|Gftcr5s6(t7Fu^Q#lIVPpb3Tk^|?6@ zhP`9jobYLeI~wpb23mO*%vkH-`~lRdQM}nZ{XE61&hhieme|3su+xHj`9BYl#aR~( zx1QL?J$D7B?E{&%`K>S+4=Pk~g1Y)QuN6Nt4b;ZnsxF__=IBW)%!41gDSt!B2X!T{ z#1pBRNY{%}?Q=Z!j7xTeaT}o9q)ma#^ArF3+c4Q`V|VoHD?C}Qq+s10W{?uh$G`ji zdkHH7xHRBRl0I;noaXkca$yM(rDZBkL27CG96nrSE=zPg09ApB>Y+V$-Exz<_MnS= zN!l)mm|@T{9^17B7APvv(a2<|5_(YUi!^#RC9~eNtWa-gXgDTrbm`8#WPkP6xY~6lsIE#WTYFTE z!1ROY61Np-4o^w8h*R&W{q!?KE}<=?c?Z#IkW#dy9<8_v-ALu=MsLJA^|OhdEGCo8 zQwU`mVRr!`Z3h+IFEy7iKACF%DM*Vb<$yC_3SrSdqw!pT%0{!9_5~#l?W_33!L2vA zkdP21!d~}4EP|fVi=9#X6Rzd|@&_ ztMs|Zgv)Rsy0zHy*$&T`9VhK6g4<)Jzl6haxg{&|jD64T=mC5Oh5-n`$_pfurx^N0(ZdJd0S z3b3skU{L0J(H*}Z?wCAZ>%?we&v%Cq2_}GkK{kKD8}&UlxF-X*BYJaV$jc-M7`xuOSiUL|ow z@JZybKDgge^FNo)lO522Ot!3PTQ(K`xSgAQlk;m#fV*VSLE&N`$hogT-uAf$NtmRd0>M2WHk^J0GhcdMwc-0KV`WZV-~0=3MYcMbvt%%75HS5piz<4*>wKH^UpqO23I2+Ps_R_XJYCS% zgM)IRzYm3noL5cjg+;V*e_d$>ltT~3*O9dJPzNGc3H);BO^|mBfqVg0_8K@CW?E5d z=C8f?3u66eu*F?+;8H$cP6a;i4bVeQ9w7+ilrQUh`sQ>E=#qZHzdP*I-=MWg^EKr3<(A%@q@_py10K_^4 zywT?0hEx3JrnmAQEn644RdwfQgb%=YpNBz^MuMjKPA{(z3@GcSK{|6|>+fHCDgF* z+28Nx64VexT+pwPR-jbXI1Ri10i(yw=P&+N0P!EJ9R5`&SmVeh6GMZ^NH&hLSD*;GJ&^M0`-wjB&kqeCBgnGf~z z!hatg9+Jwo96AmXxCT*m+cwwu-z`O^DeZafXsLp_aFC<%Qo6Q(>Md~OcaG%Lx7Od^ zmT_7*??d=Ldx-t|jlS+3!&}4g5%nRb#k?)A<)zo$jn6nAawUNaeUq&_E1BXuOuUH; zg%5$T4hg6P_5RJfh|(zBlok1UNW$)Z#Olb<48CG^CUo21-+yts&eKic{O?~=+#Ms5#-spFdGVjU!GaoSR-TOW zRb?SY*ECM8i!PnIb0fX5RsfjG5$}D&3+h`I@gm*bx4QEEBuj|VFyYJY{yMHLW}bK> zxEtxkqPU5Xe;2Q+5jx1UeM8Z&aiVOJ4v3B|8d`vWNnROSf|>EFPp{Rs$~5)nrLii{ zm}##rsCLeJ_;<$>T{|_UtJm3X9<1+9@xNGX;M|*bNT_hQilFu(5=TrP0@XPhyNpJa zMw9VdPV3$QJ7v#|=kZ&hcVV%TZ3yJnZ{uw)-QkM6dTDR|;Bqc62&P*{1D4SZ5l-VJ z^|dl(D}bC*P*7MA$!E*T@#2Xm6&6|TCcx$hT^^<(Y#Sj$Cd{vcxu`c)vf|;(UA*(S zc#hLmc8jHDr9G*yaO0)Rb%{Iv!_x#`-$&5i?n8XqEk@8JUvkGj4yXkFfq7cl;`k_tc);VLEk-3o6^ASm-3C8 z3lV1pXLfgMy|Jnhk)XXbO8&y${NQ0O7yl2HW(t-yu(Tuh(?+nTp2dW3tF-a(C{V8> z-LQ8*bXn#^RfVr`k#f|*V7T{b*ZIH z%X@}LN{*sgTvcFmyx^Z=UlxOM`sqhA2D*eABcUU2Mf82PD{$xW`wGhHrH!U@V61^( z)i_x(wXC4PCO>qrUEX_Q^QMeU16+Tp5pw*I&213N>pUEvH227TT&R!t35+wJmbAcSU+umLIZLr~noBw&2fQcyO6!e5KZ9CWslsxDC0%*U*+# z5tA>QN&y}1ZE#Q3xB4f2rI&c{;a+vgm$)E-W{dSbXh`P&F3mv4?F%%ghR{u@8Vf6& zU|{(?F8zuislg`IZX4$WkZr&()@ zYLz{Po$-NY7G?!<5=SrWdKxHnO7LgMJwpivW~r&7z?wGj{)hMUl~qU{Y_3VlEf>}< zdBPk2;+aczBVf?!mim!ssuwXE!pii5WKj&271{dH3mEq^I%Uw^c8rFS;CgTPeWx0* z!#f)_0YHwX74|hbi}epc;pyZ>m!w0+aGONLy$gss}Ko#!XlD z31|x5z`$U^&Q6pNq!zcV=7%Bxh2~KCV(k9u$gll7KO`bA_yrY1DB)9JeP;P8W9Lyq zIM2Rl@eb=;we#3BB}Nr6Blv0Z4x|aZWao2WNqBmETPSb(Za#Y!H4`-Yv%vjT_e`~= zLT-9GJ$k#-60GQ`<1M^Zk!e!t@y8K@(>ZltBeRCa##PWAy}gPJ^YD-iGwXHz{rmUI zZZ*o)DZv9IyMGyuwm~#9TD;MT3;1qT4yp(UfYh^|GocgRqQ|`N9K_L#54vyz`Si9Q zOw`Icc*5l8AoTs_h`o3ig3M>cQ^eJ5>h8&;aTev&^%++qRlvS z$4{TcfoN{jUVwxl04Z5JH=+qv{#x)+o+Sl3m=d~ls^yS1${&G-N(URq{Jh0(#cSma|$CK0pZxyh~KX?N% zE7)umjcXNXw8}X_|NI>Hw(66xmLX_>@7fF0`n7F+F#!xC7#Onw<9O&huMY13KmF7@ z_+ui<^=Rhc>h2gPGzWd?2HnJ#oemZf`n=%;)Np!D8Zj)z3CJE)_?tz%euU(K!?W!;5&q92>u5i7==3AOwy-h}l)((RwO) zdU;htoz+wVI>~*!L9n&{Ikh~1Ga9qQ;;)M8>Wn}%0VCYvYi8i>Rp0W`=P9ptn8KU5 z(+X*oQUQ}4VPFQnQ$fjQ<~i~@!O{rw8yRUIE3TxJ7hSx+1qknm;|2`MkC#4JuH68# z2=9h;6;aG6w_3KXn4GnF1%-g#jR2^zX>V#8U3$4i-jNN=F%F^!K@iIURTNe|2YBl> z1ZG)r@3Z-rRwfwKN{Lb7yzkX;503qPLy;0o?Ujj(x@4fI%m;kvk zPvV!cuJQ59TJ#V2HPC2rs*6Xvh4PlYza|<0MIs~6lAiI~n!k0?*6Lw9&;SyIaH{#r zS>oeXw=GmHEfe^6g~dNb2eI$FNT`lV5!lkC}7eC;JG?Oqy9*J(vtWZSO`3e%%ytr@mwLoe~{qNR>t)>6vfgirCxKi%&g8v62Es!KA4c<$V}fvU$_IM1gu z;B}0^XX;njBCqzEG;mToS9=&Dw84F+G0)k7+qQ472I@^D*wSEKa6bq__?>90oCOb( zd=4M;QA1AplT8;k$y56KNQNIv&OG}wE=(8$@b0F@Qn=K3+R#WS-p{!-A$Tv=bxOiH zIHPt#RKT_GI1P-kO=;vsvQkweR`#Y(S`c$v%%k)#R@6w<-6f}UaJygJJO#JhzjFQy z5(!zM*?wAEYh@0xZH1zRmB}{#VFb&#ar1_JM$HmJy?c|6Q1sJH!fsfiyPYHk(0aI@ z_!V&mU7B2n9))^9U&o2DSdo2nw5M_763ykOc0VlS%QgSz-0B8 z3vE-abrB4C`Hqufmzxb6m%j)+;=YxWLxnVvD} ziMIy{jc!5QYYp|6ifSq=Z$Ij+fi0jYQa40ow++>0snqYkKzr5IWm$6TaMmU#BC#6c z9Hp9-Up($Qh*PS-oTOT1w93n`d3M6p&`fUrw;rcZe<;X!KH(CTYF;I)=9<62iIt3D zILRI~7y7l^CGBlxVq{-ig}rXpv0Wqf;ScoJc)q#2+kwXDfSfn!rhgcmls;qP%|$Z! zn^x7n#7eno);&sF75ijGb=!Ho!I%{T*!e7XZ+wIVITkbeSyRj-SaFYgszqLGFJSgR zQKrJi$q#5JIouLDJ`cYmai@+5$}V2qv?18*Y><9tYBbxR}W(O;fkW*Z4bXP&aw zvk+Mj8@0j9cPuUjYz9^!^(;{ft^!q52y$%&SnT zhDKq2FUM+ibak)2cSu@dgANAY(Oi>WQCpiOlcpdIQVxK;1cC8AtD+o=90QocOI&E) zJM@>?2sV(ZGIca8Vk5e-eEOIs&m8+~I6FSVrxpEb6Rq@N@A@h;%L?D z+M0@}==)en`uPVxD$f{b%XqQyw9Vn_ODk^mq!}RJc6I#SSQL1yfNAg7X>rH*Ug~mc zuDPYs03i@G^}yG@h;D>!5$Ac7noXl^b4r-MHvet~pov80Ygj9*<7O2XQ!|sWDxhc7 zniK>fDFb<4@)E6_91^l9$E&BBjgyl|bs_BRiD?3zx(~%0(2>^^7oX1r3{{FkP6KC~ z75Q%Gqp4nAUQjfqMJm5Ax|W`=$!5>Ym=Ax8Aq#o1pl(X(4)SbH`~I*2&vI-a?fN&p zd5vCSQPLF|)FPYhDpL-J0D_JQftM;FhfL}9(f&OD?(%ILEM(GfEg;#AwR3x6G*o143S z&qL(}Lz8qhWPbWjv^oa5V|N=CSLyvtt{&xx#kJO1f@wQ$E}*(>`nVcta_TVi5iS~g zLR}fdhDqr*K-{3&2|NuHNs@!oNhmp#Y5Tl+PU9?03_jYr7mp!*=JWYGYT!9#WF%)@ zIw(g_CkZKqlQ+)m>FFJ-p9#oV3NEmPQOxh9lHh~3vfi*u&)j1Nxo&4dA)f0ekUH6x z)?8xk%bfR%Ksh^$ z2atgw4gLLF>z`Pki*>s|w#51#S;q@7gLUj&KS#g}*3VRMH2&Y51OA4CD(?MV%U2*L PyI}(!2W3G<7sLMt+b+FP literal 0 HcmV?d00001 diff --git a/polaris.shopify.com/public/images/components/inline.png b/polaris.shopify.com/public/images/components/inline.png new file mode 100644 index 0000000000000000000000000000000000000000..3b80b1e06f08a11ae65310b6c4a1cda161c303b5 GIT binary patch literal 25923 zcmeFZXH-+$_C6dDRKQACDblMTDAGYn0O>6hrANRciuB$@PzeYkRi#Lirc{wm0BO<@ z5l}*q7HT4d7E1D8n{)4PjQ8{V^*Y8m#*Cf4*P3gVXFhYz9c^Twb%yQ|9SjCLb6Z=( z1O_`H2!kDuJaqzm)8ji+0{)_P*S7M4!MJ6i|Bk^^B<;bM$Gl9m)L^9p>`UMu)Gn&} zsxVkZJpF+K4GeZ~{I-Uwng6j>47~;8KR<6yKX`SW=K-2RIT`wi=Zedsgx|Aehll5G z`6?l9m%4ru`%%GPWai|Jt==KeE^KcT&VpOQVDA%N{^tYtAL^rThLYT=jy~Mikv(?w z;Rb*D(ciGQ3xSs<90|ym#brZ*6Eh41(Gi>Dh0JNqeN7|b#dvip>t!^052z(DyrqZutJl;ANq>RY|= zhpRRhSXo(#MvfoPMyG1adU$)^n*=~oR~I18mhZAEDp{E-D%uUQOuYxp{+a3A^S#)(a91GLNVFV!qLevT3z_io8Hu&tM?d zkZwwtYI+w&0}FTJ1}N74dueIu0x~_N;_i%vR9wM1;mW^hf3~tUA12SS%Lnd% z`HlI#0xrFH3IMsZkB_T(Hfs1eW;d;Ag|}U}J2GE68cpyg7(^o$n@PzvRpE|dVd&$q z@FGSapli2XTwI8b8}--l|FA73b=Q4*xbXTVT0sVo8MK%|*g7rATQ{$;5&vB^VaBslc|F)FGxR2XO{usJmS_ll8F{Cxt80J*1{2VNR=FsJ!j+-P40;EhQ&Urlc|-7Z zF5(4)Dx;a@<>FbK)TPzguK0n=;BxrU<=-U}8nC1$rZj9*(Ae7Qs`rZ66OD*yYNi8Q zdBG`k7#7^q3=$_BVw*ZWGt*aH*Eo#W|IRJQ)iqQwfRj}H^5x5bE=^8hZ=8o;m57#lqj%qZ6cqBor$E|7Dn^e8xOYU)A5wynWDSmb7mb8hSJpRdmY{DBig9v$-A#Kc5Z zAn^;nVPRq9Zkv^427@^dIngBS)TExHp{B1fJ11uf`e#wvcem*DyLYR~U2&3si zR~by^BsESY!uaVckHPF8LN=nApwOWbMxI3IrfSsF-eFoc)i$X0losW~#!VV0DC`jH zYrcG`N4&lwg!?wmZB&1Tf$Gc!?E~$BPq7M@9a(jK4d>*K!NMgWy#?x z64Uy}LFQSgm?0j|RrM@w_A1`JjOOBa~Mj%E)d~(ksF2b|y_H z8|gfF%v&7KgA?cETt!6GL>c@KJ%II}xpn$-hYfHHAz`jCx`#ZMg0i1y$bklat<8 z^PloWk%YCiN9qg4V_=v~bVh^CgO6%vX24NlUpmKuo$URB90;TTv_NpEkd8fvAN zT~8yEvcA7VtdPHIr`su*!Ah+W)8n6`7;oOHQGeX?W5Kx6hDiYVq81{1`7Mx6>K!~f z`8cfn#&=<(iu3h$wv8fEJ1V--*B6RL3k$qO=kWWI+eV+KBof5mMOs;%ZjR+m4;2`@ z)v@u{I#G@_MX4O9Eol+jO|-5Jqe}8vqOm%ca`64_UkqpOjj6-!H?2vwq|8qsKupHR z$EW(%w3nGZ^R{@&ns6L;3-ST?b8@a^P!UCZ^n)chm?rXvm!-EG=!;WCRd7M`uJm%x zXoD(|jtKt3l2bOZzEm*#(~y;%NR9A@8wUot6p+|*ewsWS$RK}W33cf+QF~faQsO3b zQ6-6xK#=~-Ud7&kSWVfrwRJ6xhUe$zcLW`W!3>X#!+JD>v>z0Nsqfa#NwHzFLx*M% zatc#auJ@MR6>A@%K44aB?VW`Kq2LC$Tu^s!q#JRj+pthITdjfJn{F%1GX zOgJ2lcqLn{?FIN@mfYv`%R~%=mX;{?>UvWwRf(*O8(pa}4CYS@nbXq-(Z%%fySb&& zgf%?gmw-h-W*E3fZJJ^(@qOtPWqWQe?;-78+3M;4xX&Qx5*J0sn(+&D&he0MTB3z<;*8i7^cP+)Gg z@iiD%02ZWsBs|0gy@!3M^^11uV<0~FsiU&H6#30`y8pi3kwDAXurl`!hUK4o;3@X= zQS3xBavjT&X9j77_UvFy(GhJ@y3vS-=THQ38nQaB?brp#6@TCFtc-T z^m84IyQ$(drgU|I%esFQgX}#84|6&O#1woB4$9UD1V5mZY@4$D!Lo94OCaczN!2W^ z8n&jkcRRl05Gk`}6>Qd!hY>xJkE!uzgW=Kdv)EqCtXRds>(iVlrc!k1p*)uNwN^wl zcg)10Yvt*~9nY5!nIcWq;}@u4;hBIZ3vZod5gQ+sUJsTt=TZq>^`+B1IM9(7+F+AP z8^>Tc8ZX})Z4{O@XGVhUP0Jk#bD{aYSDOt{!Y?>j5vyMDv2t!7)8HrXY`du6TFnDl zR`Q>~=3_9+pmQ`)1KeFqpDI_gwLK`Ss}KL#J~c;jUh=6I@UKG+L}#pN3)9ZekQI8!RB$#G-tK*ayJtU?M^d<-pdL1_7ZP6X~#LTHs!UVTP zKc|Q18by(#^LMPg&!XK-0et|5HC}I7_*F>iT z*ZFvwuZ{3BE1==xM;hMkp9a@zKP9+4XDRT0d}<2+!7<3SWM4MOAR_uwowfPr6n2wOz-9h$LNNT@7Fa%yXi{zvB)WNxI&)r!8S z(N@|#!NoOJ?)_%g4KUbWg^|nh^spA4!rJ{ivXbe!xw!$d?j9b))t}L5Y*Wbo7bF{V zhLAkuaaz&aVC#_s(M!78?(XhG)vpQsX>30=Rb@~Ez_;A_Tc!j&%(^|U-9%PVF{w)aBac@O5j=Q z1?4Q2Fi!6zLwq~M({m>7fd5a(f4Ba1NUnm(z&X1Wz+#!t4Gj(W-c$)XEP#FK5bOH$ z$5@$N!|&g}OOu1kBDq1%0BNVCdO<+}!1ai+U;X|1e!jjx0l&7Q4>_l6vG?A71ku|E zN(?N;#l`E1MB-WS6FcaK0==OTffiLpj&!XpIlX5kKNTHpF)m-pYHGVTBlQi&nclXu#87%_t=g*&tp9{|lZCrZhf3-xc z>%p+Q;|l{e7;N`K7?B!ge~mfHAcJvG#;m6GcWy4o`}PYcK~yM^3YFfm)zws7S7cU= zgM?##(9Z~*lG&s_VSt2_Q&Az5mX$R;cbqbGv9EK&6L;d{ShY$_*^~(d!WiPQo z<)<&h!ucV;10Lh&Kra|d*x2xVMKcbPLJXOn>iJXZi&c~lzdBZ{&s=Ey_!jL0j-p)S zKM!J(Cy2qx`9PBc#x$xkGBWUsi-kc&HIK2rzwh3)sgC{F<2sKMDP=x#LH~N{DR5v{ zmu*$|3ce#eJv~jPY+h4sxkf~HTfX<}>f$FHnocOa9(!=|+aSXF$UWb=02yE!N)3nY zls_~}fm=wlOihk2DhKbD8;$9bfBO-pk_i&suKKrH;}MZ&kbeI6Hx&juZP8pkLIq+m zrM?H`kZ=1b1JRM}qtH1|lvU7iu0lJH-hBrtpfIfyeuV;j>?DSf(p}LlTkzl{z}>)VEUtz*r`)sX z^)CqO{Z28yFw7$I~k#;of3pDmu(wk#k1>qhc6;5%KEvTm>v8aK)6ZSe3219FG$ z1NAgwMrKGgyVz_sFc&vyRptc-MJmjX+`ir(vAQ~Ai92Luo^6K2{GR{F{r6zTW2O=^ za)|YDzVb>+SFzVCYHDQcOq5cB3Co16f#|BLDmRY#YKcpI4_T}WfUp_<-A^U5<$l4~ zx6J6}5IQ2w_;GLX#vgzFIFKS%*~=7v>UUIE$OTCh?>qtSwCqUI)*ZX=->s~;Wt<+S zef4T_ch{c*zNq+|J5x8#%BSGl4@9g|$ypRIP`@Jsb*p;+H=se228ZV2JTZ|CY{2xF z=qsE_)0GD7aD~CXphz1Vw1ZDaXmZlI)v~~+{xbRCcg=>R`NiBDom8vXi;k+k1Ia$W zR6M-AfR?{>f^ZFl{_WkF;p?b;bno=uUVTGt?V<>jC_@Tk<|MZbDa}7GLO4v#s>R6t zVtl}sQ;ybD`apQwruE^WuxV!;Gw~L9KhADp4Vf7t5S3 zg0$&qY4>v+KOFX>o-+yx3iA84?kwmQV9|Dkf72C+=&(7t?RWyEW=!YWdT1+dugUv& zdhp?|Pg1=A*;|^ES?FN57=J4$&<}Q^ZT`6P_4YWn*Q!vRI)2zj+t7YYA!@wak&cxk5iBYZd4$Q zU>WfYZ<(uQ=py1+GUIOPT#%z7J@@8UB;N_0s?)6#lyU6Wv|KPbX2HVYy z%e|Fh4x!4-vB!Qxh0AM4sjdDdd>S6JKA}*dkl;S^=XUqd$@7L`Q}Kq5@}aD!ws;FN zPp}G4Jytw%>0LZpnTFYhF~#9H>>3Mn?)`b)4fkb@>*A;77{vP;I5`_`ZX8^HCTz!Q zL)E`IcX)sZU%%0)T?6M_nhPL~hYXu^G)E)YeQ01Uo<~B^Ym0`Gl?!8IV;G>g7LPd9 zHe0`n#h$*rnu%~}yxSN(gbt1kDW1xavI~&GG19Csq z#P(r#-dNmEl5%8iP_S7a{&^M+E3M#yYKPeAMJ@PNkhtw(h}hQ?z^y@wdjEsts(xD( zQz$?Vq5DDmhv$~Q?2cma*FLA$T>QFuDD*-3qyKe!+AmzkV{p`uX@9V+E#AJip$P?X z-gOy}#k{>OdE+{sH6uBU2m*QYt3Vdz$$oMT^?9Pwg?Qu}`{KQU4C?#XdWtnKt>{K~ z_3I%=qKD*;Df7O-_a+BOEs>B1A2P%Lu>D*fxKn$MC(MAZfh6+6o_Ujge7}WfuZ3sK zK&>wL(;_Sod89OZfUx|Do(9Vopcw;v%UQOu_4W0t&Rn1u=WT1?=V370e|j;$uF;ml zL8cBl$@fKK`_+-Gom-O~zrk@cg8zT+1l-g;H>=}7eyi^mxmx_)oX4ie z0Gjc8T=skF*INn931D$z?LcVPc6N3!TL5T<_>5wvrhLOFYh{_&q-g~z!+3fth~tx! ztH7G?L;hcf|5feVs0#s;Sd0(3Qcj<^KbJLm6^oV2Dm$cX4`MbA!?1o~1L!HN6)gGu zGC@#m#$rb#5ffSouN)sgHZ%eovWFC1OzcT}$NW4vP>k3sd$use6DJJ0E?3R0 zFLZVW*R4~iPaC#Hk;C3m$b#s{56_)DM+rV`I48Y#4Y}=l&M@NT{z0&B=6n|sOW6&| zB+L9*d5XedY+_cA!Gxd!{xpI??VexzyjYU9Y-{=1vuEo8e25EE02rY;WdEn+$4JHr zXDO$rPayylel@xG8mb0 z?m&?JN@{}1(%BwM;p|Dua_T>XHNv2R2=#p!Ofl8g8U_m$f{({O>_KM4R2*hLW3rdw z{Q6ubfG=scm17p*vivU5*>q|~bm|T-vdr^9bWW+UuI|lACakV~!U}JED63{fL#SV; z{8GFrXPtSahQc{y7C==T89?3#$SHmgpHUlY>yH@6mC!oxi05l-Ym~_I@yFV|2qy;B z{z?c6+9U^4y!HPEXDNq>DEVDC5N-Y8g;DXfm`iBkQ9*}U&ovo%9`cFxNIk+Zfm^3xk{rl4tpcJrA*^*WF`?O+%UXk3#iI^jsT0L=P2>EzBggIb>yE zaIir{cwu3{%ht_mDyF%F=Sj!b>ZLya!bp~qy>p+v`9K;xh+h5xgF)1Dxif=Ko;pu< zdoiXiBLWx9H-co7#4@fwZ8|^d$$s6SaM|rJQs|;!Uif}s@@&S2^4#Hl4;)4DW112J z+klpOe{<;_8B?mZL#yeknuZnjlQ2sp(2{WJ1gECds#`OTEP8WYCC+~4i+vk2lBkR< zbnqM2gpzydi5FyJZab(PgC|ql&Q`Nxr6$*G}H|W3O24K_36r4`T=1Z z-2qw8IYdE5^c4;AR`VbAkqk|tzLcDpPj)TVc7aT7r*ddWNJ|K;ChYeWgfnh9zYfY%xfed7}D8tS)Q;8vHFG#qzm*&RF24 zep^=01*?m?@QhfxV#N3#``D9P)x@78X8y?B(aSkC`8rOBJm@S=pOyr2<%6FxaPTOuydmr7y7Q!+z}KSP^%WBVr^L2iluGwc zqfxDU*Ps(OIMo7os}E3BK%$GcUkATq?%i+XB6JbFzqI=>zG<{4~ zS&T0lHCcEpFb-4LVZ+OHE6Pu7JE{}CuJ{qpZIS2MOJxUbD_wZT^f;dzMxcV5L{}M# zU+w%Q;s%Kx2x4jOvEw{2*fU<>X)PJ*-pOGYOdE6M{K$ey{`yze%`_E4?p{lO!Gw5z zO3)4Gg6w156$&HiI|&Dyk!>O;p)1Hz|^JlJVtHBoVXU! zT6w1}yLjfIZ2=8>Z9WZmP`G?TR!NEDo}4fI)X#XGyX`xw9sOeOyPIDY#U}N-bbR~v z?Z9ghP*L@uY?K0dGW#|Y4Sm&Mk(dY9zX<1=dCF`X`5oW}ZM_TB<1FwSrH$|832-OX zn^9(+poDjWi{31oE6l7eukOL7+1AV=Nopn+5s7J2K=l`e&Pj|?#gnTe&Bo)u(ZKrCt5OUAM9hpPHUrC(0w(6E5# zetp(x%V_2-1Lv&!xmRI`?7=y+I15hR#wCdZlKmg3IHT9MhOzOJ7cGC;6nQhMiJD<4 z>3$t6chqcbj@9Ot1&fYogN3Kq)mBbBe0kZg>{njAPwvod#q<#CL}dL$HRY8oBHk$C zUB(`=bmD5`CiI6-@p-tu_&4n*#9rKB?g>WW2Or$`!vM)oE0<9cc2V`c|63Ensnx(x(x27}m_FLLx$8x!m6vt6X|O3BnF zTvPXAX`=*Kcw!jyF__*hRD#uVU}&iA7k5(r_X>AF5=w}DD3@E%PAc}$WB#KtAN0DR zwoB*|5g8y+-08ZNJI>-$LCu>HD){GaGZa_kD0&xNBdw+qy_KAPj96xsfVh;-X#opQ zm>)QRYNhBn?tMN002b^Dc;E-9VS_`P#j-PZ_MEy9o)&d-yCVrZJQ!6(Z^d;TA>5>E zS$^;dz;fCQR$q4>YcoCUE?`gfeufZF4lA|(T96v?P3Z&znf*cq(`v1+SeH`=ZS|)jS;Y+u3;JEJ615Ak-(2*RT{qsC))kWLHZJZj zjT8icV9;^{N-f!L;}`mC6MlYihPTx`f1W6jRM1kdon7M>;4!?0&ar&gFkM3TrcPbO zhOt+uYM)q}r9>V;nky3M7Xxg<9zN_tJ0}e;tX9PC-+xpQphp;87NO+R@ z^Rxw9lb)iic>@NR;T!BY8i_-|9v_rhl%|{9zh?&i-lSIWtLl zLi*J!$JmVH=tM7GT=%zcw=KBKcIw7#2M8$l9Ky{znsS00lj#1qyUM(xnhy^Rs8H4f z(`L*@G}MlD3tFq3tG z81cva%LZYR_ij|gGT4+exd@n)Fc`{t$GRe3`p z%Zao;#9;K9F76m?R{|VgON;m=F|>iCbkw&#H@lw|;wq*-GXD5y6pZ4250%qYd_V1) zrS`Gykpjb~aqfXdim8KHDl&FwDWVfG6&9asxH)98pz^7LEbrAk%MBu9Nqwj_kDvX-$4&-1EYoIQtxz;GmmatiM zL7r4y9B~hiAIR82u4oAyx+RS!%^iO8%4}OKV%jgk{}@~$O$1o1lkcUEyrX@2{<4np zN~NJ-e75qA=h?HQ3Bb&ULHX^8S2I72;D4C7L4s1g;inT;Ry<9~#YgwpFedv=qRmlL zrk4^o8A8fsqSob;bL&FA;}BQv>}m!hybbeW91Cv=jP(QBT>(UIC{GefxwxT@A!X!P zM@0M7>h1+0u5S^i6gfDO)IvvvvL{<@r6ZQBzaM+uwk(AuW#B?Vcgvn^vGrqw?gy_p zr8CwWMATTStK*`vmT6LH%1&3;Q=01mk1I7eVc~xuR*Eiv+Om3jJ7|fW%`+WvP|Oad zyP|SzvSK%;*tGNoTEIk%68;SDkUG z1^?n6x3qLu+Ri<%vNrPDm)?5`!8ZkJInZZt$b*Sa|WS+BP&OSJ5tRVt798B)4e$gPUP;uQzxOZ)2VC0RT*vTpPke4q)jtW5<=ql4VzlRkkmG28swZSrA|ADq%+I~;phyyJ>Q zB7c-d?;qPq*Sl>yn?|IFHVBH$HQw!lkE5%anv~87iSQd0PwF2B3IiPgOH##k1aUUV zYU6D~IH`u|#g4!Y7nMQ&sF{j%C9BHDo{dXgV&`#dKmAEj z`C>;k3JHwyh;Xnp@@c){_osn(Z|s9-FoO;|JG(csuDR|_yy6{J8D8{MB%>)Ub*%SZ zHOA_`<;3uf_C;k_xQ`%&5pUu1KBaGEsqLh7;GIC(c9KKsOQQvnrDRakmPzTEWP>1s zCaBGfd*UyXwu5NhMH)Ub#3I&;0J{qT=U1^_#g~ezq(yJi31mKA9X7Cft+;?$5l$+d zO?$I^>u-LiZ78SdCD)riw28%+)Ged z;<|akZG1YH7oh_*K@?(+BYR6QV~M?hh?K7AoJf;2wX0!OC7G z$TN2oG0B$T7i=s(;VAJK=>!i=WZaFnD6vk?Aa4H^FNZ!G){-k()y%Cq!(f5Zkm8oP zo0_FbyFGd= zdXwcFKANQy|Mo=%{f4PjRKwWa491AQO9<}449LAg#7ekD?bS3A+J)Bl4M~jrgcWI+ z?aITc$?0^1-<0jKG*|yk_nmgO288*9n`+uWAAu>&Kr50+3YZ0q+LxLdg$DDr48fOlxG9lulAm@Dn3=%dpdP!wYRoi6=DOZv z-(JBdg;(Fc5N4Vwa2BDN$sS0^SX(32>3>2E+C%Zr@!%>eY&uGWuARl<91>JB8iO1` z{^L|r`FWTTs+sALQ*f2Jw;{wXlio=ZoJN>U&l)Y**>u6kOk`cwv z*toF1>_Wc8C{>UaUcwu%KX&f2U!5J2w{E;f=f+LzSG=viXb;E~sMtQ8T&&r%nCagn z>AY^iEX!Ka(D3_HLq|8$1 z`uh6be2`!%D@m4=z07UaCx@$=@nLW@kGfr|0t>%%B!J>eYfKlJlf+?}5>dY@QmC<5 ztPEk?U!>Q6EMOtTc0Y|inmC1x|J-LQyY5MP_-Xm=cv{GUp~D4*|8(3onnXk&K79(B zy<9*sNApYLEzQZ;i;IxY-meCI4xdUY?Do@g$2-}azVvy%G!Ok!O7uAiGlIGU%EOy5 zm`Z$ftY1&b{g>2-&{F~16z%_rSyv<^W8YI)NPA9%6CQQ zszO(7fVPxq9Nh%;8-G{(2Nl=(<-iv8vPMP*Gj6iWUKIp-kjn4MfaZg>&ex?;!qhKh zs=O$rh11PFo*@gyPBzC?Vd2^T##<^6#E!f0w@s#=W zjVWvkl@*AGXdaj-tCy7Z`Mf1)30tynYzceOPhV+G%ZVE$sL+8D+mTw( zjC%HOEa0R4ckmdUxQuVEJ+7Bc<&nj7Q*yWsD`VqTgVdI^?D3?$7(NF#pKBG>)zV?0 zH?R=G6+$=6E=cocc8Z4@w!(+m-Zjfw%V{b5J;KI~&%ajKz@o#@CVu|7YIZKJRG->L zO{(x>4ngAK4bT8ShCuu!Z?E00!F!%A_S1{>0HN^fzt9rb4*XsN_a;rP@Y>z`YsEt8 z<001enKQ_F+0v?n<9SSI(>}YX@SJl3#SICz#hzK+BZJSvjQ z>U{h%gnSJ4Q3}Fx6_Xd5s;WlLaOdhuEeK!#JEm_N1ix^T&_5D^M71Mmx+k4fwojF= zx@eyqlsd@-^;94U!)bnB`=&XW2nDzYT9 zd}w2(rrZh#n_f=rS3GFA3xj=tNdIfEVjo=$e6u`1ir4{kNagT#Q^Y8L2* zWTL%5q~(AN@kCO{iDWo|3pA`ws3&-+m5jp^#>|)vRw<6pf)^+jn2Ic%wbi7p258#m z;u;+MDm-;&N`gP@duD8-A7acz`FLpc-5k%)BgM89(nAF~xr>boe7HYM^}ZlZL_zSz z-m3TxBK+V@Gh3!OYSN)m=R32Bq^)4CPpHgHVP$w$-LC1y>cp`m;x*pHPFtx%vrOH3 z{*B2G40?0c4PxxQTMh0~xO=0HtB95N%MJV@Uvsj)xqPMpHS|Z2|GnhDzr8kn48Cc@ zG@&IKRiVaQ+*x~Y|HAf;)QO_Xpd8O^=czLCL7tfbc1CjE1w^@p2kf&?oBw<2!R z%hqnxGL}- zXkRB>ds&fY2KVf2K$hpK2;Gl5qC(iuADSI=q`3rKN`!Ao2+dNGHg{-ou9qi!aU5Kw zbXjh%V>~9)>oB0GX$@DeFk(Xa=y$PxI7`1jtCDflR5lmx*)A-F~MwbUGJo-uSA{~ zvPVS0#`ElOpt70b-aSDXp zG$l^wGL^3BI=>2Bqk$^9|EGD)VXb}e1LV6<0fKSIK1V>m#G2(ViBp0zf#2Gqy)`oi z)v{Cer93n71<1BI011qtW7HhNB5dTaWWT)-CR#z07nyrDs|fl~qP$(bd#&A-kifuS z2<;)s{QN=m>)B*2^hs`l`ankL^V`kaxQDie6m3;y+@@Cp%?G}+qRMwmf0_5`_hy^# z<8DRdH)a;0&jnPVOHTBMsCOP|bV$oT=^|B|mE4 zycFe3LHpt~r?MjHn2+5?by)p<$3N8TY<2v3YT;>GFQq2m$UB+}8LY7>%U{cdd$y9U z6pm&l7TioN4>}FAPyV!x21OqMad;(QJ!7Tz1h_kJgIPEX6LPZYK!KUp%~OlQ^GA1H z=mQh-Zd~b~fQ`(1Sk>g3vcW(v2=5hFXP05bZ*LW}odKnu)g#)KzM;rJPOv z6fqM}nvoKdA0~hcjCdhYHJB3I9LpTBP_+fdHgu~fpcZZe`2&F~@NcmP-)zQ^Yy90A z{Z{E235IpVz&@V9&hKX9qL!zvNtttOc1%}E&K`hluD9}xGxPqn${gi@Jn@pW+AW@=C3k+#T^OrjYd9%V@ zH(J}rInf!JvcNb4snBnt!2cZ&l2dr2V7ETekQTg)d`aBM83HGqY-Tx2Ja@4e;cphB*-B%Z?|srn*< z+MBlVN_I3gBh{_{Ruzm;4=xHOy`On#-W|$TH=Sy=9*}qHU7Hu(8GVx|mGG^eBNW zfQuL;tQZuSYfzt1fqoRm4T1)}nT4kl$ z@PMg5XMz4Rm!Ih-&97h^zQRSVVX+4_?s+4o7nu|J(aan2Rb4ah*KNanQjxX+XApk+ zn|s$DUSQ76V9?&o5Fnj?+cy58V1tyn;#p8`3d$}wq2yGTr=!MObTfnARG47_kDtuW z&_cZrh=T^pxX?GQ2wh&fu}@a-cGaoT9uEh5MI?9w~43kDjc zMXC6&X(t(~kjeSK0wxXbJsdG5J^Xh6^V12}s=FY($U&BzqK)>KiR$$>)_e3>C#=91 zUun>)^h77ql_~~Tcxmaz9K$p_rLh_1F4Sr;)g{(tZqG3_K?<-cOeKo_X*crhH;eV{ zk=~kg=iy)=9n#+T@I8BrcWFqcODDz&bmE@w!Y+V^7@<5t-6xCng6U*tkJ_&SlgZTv z#Xa~hTG20ImGn8Dc_XhFc=E>I&DwHzOh@W$D=1^9on8~%=zPL&y8NBf!(?bB?tT|Gftcr5s6(t7Fu^Q#lIVPpb3Tk^|?6@ zhP`9jobYLeI~wpb23mO*%vkH-`~lRdQM}nZ{XE61&hhieme|3su+xHj`9BYl#aR~( zx1QL?J$D7B?E{&%`K>S+4=Pk~g1Y)QuN6Nt4b;ZnsxF__=IBW)%!41gDSt!B2X!T{ z#1pBRNY{%}?Q=Z!j7xTeaT}o9q)ma#^ArF3+c4Q`V|VoHD?C}Qq+s10W{?uh$G`ji zdkHH7xHRBRl0I;noaXkca$yM(rDZBkL27CG96nrSE=zPg09ApB>Y+V$-Exz<_MnS= zN!l)mm|@T{9^17B7APvv(a2<|5_(YUi!^#RC9~eNtWa-gXgDTrbm`8#WPkP6xY~6lsIE#WTYFTE z!1ROY61Np-4o^w8h*R&W{q!?KE}<=?c?Z#IkW#dy9<8_v-ALu=MsLJA^|OhdEGCo8 zQwU`mVRr!`Z3h+IFEy7iKACF%DM*Vb<$yC_3SrSdqw!pT%0{!9_5~#l?W_33!L2vA zkdP21!d~}4EP|fVi=9#X6Rzd|@&_ ztMs|Zgv)Rsy0zHy*$&T`9VhK6g4<)Jzl6haxg{&|jD64T=mC5Oh5-n`$_pfurx^N0(ZdJd0S z3b3skU{L0J(H*}Z?wCAZ>%?we&v%Cq2_}GkK{kKD8}&UlxF-X*BYJaV$jc-M7`xuOSiUL|ow z@JZybKDgge^FNo)lO522Ot!3PTQ(K`xSgAQlk;m#fV*VSLE&N`$hogT-uAf$NtmRd0>M2WHk^J0GhcdMwc-0KV`WZV-~0=3MYcMbvt%%75HS5piz<4*>wKH^UpqO23I2+Ps_R_XJYCS% zgM)IRzYm3noL5cjg+;V*e_d$>ltT~3*O9dJPzNGc3H);BO^|mBfqVg0_8K@CW?E5d z=C8f?3u66eu*F?+;8H$cP6a;i4bVeQ9w7+ilrQUh`sQ>E=#qZHzdP*I-=MWg^EKr3<(A%@q@_py10K_^4 zywT?0hEx3JrnmAQEn644RdwfQgb%=YpNBz^MuMjKPA{(z3@GcSK{|6|>+fHCDgF* z+28Nx64VexT+pwPR-jbXI1Ri10i(yw=P&+N0P!EJ9R5`&SmVeh6GMZ^NH&hLSD*;GJ&^M0`-wjB&kqeCBgnGf~z z!hatg9+Jwo96AmXxCT*m+cwwu-z`O^DeZafXsLp_aFC<%Qo6Q(>Md~OcaG%Lx7Od^ zmT_7*??d=Ldx-t|jlS+3!&}4g5%nRb#k?)A<)zo$jn6nAawUNaeUq&_E1BXuOuUH; zg%5$T4hg6P_5RJfh|(zBlok1UNW$)Z#Olb<48CG^CUo21-+yts&eKic{O?~=+#Ms5#-spFdGVjU!GaoSR-TOW zRb?SY*ECM8i!PnIb0fX5RsfjG5$}D&3+h`I@gm*bx4QEEBuj|VFyYJY{yMHLW}bK> zxEtxkqPU5Xe;2Q+5jx1UeM8Z&aiVOJ4v3B|8d`vWNnROSf|>EFPp{Rs$~5)nrLii{ zm}##rsCLeJ_;<$>T{|_UtJm3X9<1+9@xNGX;M|*bNT_hQilFu(5=TrP0@XPhyNpJa zMw9VdPV3$QJ7v#|=kZ&hcVV%TZ3yJnZ{uw)-QkM6dTDR|;Bqc62&P*{1D4SZ5l-VJ z^|dl(D}bC*P*7MA$!E*T@#2Xm6&6|TCcx$hT^^<(Y#Sj$Cd{vcxu`c)vf|;(UA*(S zc#hLmc8jHDr9G*yaO0)Rb%{Iv!_x#`-$&5i?n8XqEk@8JUvkGj4yXkFfq7cl;`k_tc);VLEk-3o6^ASm-3C8 z3lV1pXLfgMy|Jnhk)XXbO8&y${NQ0O7yl2HW(t-yu(Tuh(?+nTp2dW3tF-a(C{V8> z-LQ8*bXn#^RfVr`k#f|*V7T{b*ZIH z%X@}LN{*sgTvcFmyx^Z=UlxOM`sqhA2D*eABcUU2Mf82PD{$xW`wGhHrH!U@V61^( z)i_x(wXC4PCO>qrUEX_Q^QMeU16+Tp5pw*I&213N>pUEvH227TT&R!t35+wJmbAcSU+umLIZLr~noBw&2fQcyO6!e5KZ9CWslsxDC0%*U*+# z5tA>QN&y}1ZE#Q3xB4f2rI&c{;a+vgm$)E-W{dSbXh`P&F3mv4?F%%ghR{u@8Vf6& zU|{(?F8zuislg`IZX4$WkZr&()@ zYLz{Po$-NY7G?!<5=SrWdKxHnO7LgMJwpivW~r&7z?wGj{)hMUl~qU{Y_3VlEf>}< zdBPk2;+aczBVf?!mim!ssuwXE!pii5WKj&271{dH3mEq^I%Uw^c8rFS;CgTPeWx0* z!#f)_0YHwX74|hbi}epc;pyZ>m!w0+aGONLy$gss}Ko#!XlD z31|x5z`$U^&Q6pNq!zcV=7%Bxh2~KCV(k9u$gll7KO`bA_yrY1DB)9JeP;P8W9Lyq zIM2Rl@eb=;we#3BB}Nr6Blv0Z4x|aZWao2WNqBmETPSb(Za#Y!H4`-Yv%vjT_e`~= zLT-9GJ$k#-60GQ`<1M^Zk!e!t@y8K@(>ZltBeRCa##PWAy}gPJ^YD-iGwXHz{rmUI zZZ*o)DZv9IyMGyuwm~#9TD;MT3;1qT4yp(UfYh^|GocgRqQ|`N9K_L#54vyz`Si9Q zOw`Icc*5l8AoTs_h`o3ig3M>cQ^eJ5>h8&;aTev&^%++qRlvS z$4{TcfoN{jUVwxl04Z5JH=+qv{#x)+o+Sl3m=d~ls^yS1${&G-N(URq{Jh0(#cSma|$CK0pZxyh~KX?N% zE7)umjcXNXw8}X_|NI>Hw(66xmLX_>@7fF0`n7F+F#!xC7#Onw<9O&huMY13KmF7@ z_+ui<^=Rhc>h2gPGzWd?2HnJ#oemZf`n=%;)Np!D8Zj)z3CJE)_?tz%euU(K!?W!;5&q92>u5i7==3AOwy-h}l)((RwO) zdU;htoz+wVI>~*!L9n&{Ikh~1Ga9qQ;;)M8>Wn}%0VCYvYi8i>Rp0W`=P9ptn8KU5 z(+X*oQUQ}4VPFQnQ$fjQ<~i~@!O{rw8yRUIE3TxJ7hSx+1qknm;|2`MkC#4JuH68# z2=9h;6;aG6w_3KXn4GnF1%-g#jR2^zX>V#8U3$4i-jNN=F%F^!K@iIURTNe|2YBl> z1ZG)r@3Z-rRwfwKN{Lb7yzkX;503qPLy;0o?Ujj(x@4fI%m;kvk zPvV!cuJQ59TJ#V2HPC2rs*6Xvh4PlYza|<0MIs~6lAiI~n!k0?*6Lw9&;SyIaH{#r zS>oeXw=GmHEfe^6g~dNb2eI$FNT`lV5!lkC}7eC;JG?Oqy9*J(vtWZSO`3e%%ytr@mwLoe~{qNR>t)>6vfgirCxKi%&g8v62Es!KA4c<$V}fvU$_IM1gu z;B}0^XX;njBCqzEG;mToS9=&Dw84F+G0)k7+qQ472I@^D*wSEKa6bq__?>90oCOb( zd=4M;QA1AplT8;k$y56KNQNIv&OG}wE=(8$@b0F@Qn=K3+R#WS-p{!-A$Tv=bxOiH zIHPt#RKT_GI1P-kO=;vsvQkweR`#Y(S`c$v%%k)#R@6w<-6f}UaJygJJO#JhzjFQy z5(!zM*?wAEYh@0xZH1zRmB}{#VFb&#ar1_JM$HmJy?c|6Q1sJH!fsfiyPYHk(0aI@ z_!V&mU7B2n9))^9U&o2DSdo2nw5M_763ykOc0VlS%QgSz-0B8 z3vE-abrB4C`Hqufmzxb6m%j)+;=YxWLxnVvD} ziMIy{jc!5QYYp|6ifSq=Z$Ij+fi0jYQa40ow++>0snqYkKzr5IWm$6TaMmU#BC#6c z9Hp9-Up($Qh*PS-oTOT1w93n`d3M6p&`fUrw;rcZe<;X!KH(CTYF;I)=9<62iIt3D zILRI~7y7l^CGBlxVq{-ig}rXpv0Wqf;ScoJc)q#2+kwXDfSfn!rhgcmls;qP%|$Z! zn^x7n#7eno);&sF75ijGb=!Ho!I%{T*!e7XZ+wIVITkbeSyRj-SaFYgszqLGFJSgR zQKrJi$q#5JIouLDJ`cYmai@+5$}V2qv?18*Y><9tYBbxR}W(O;fkW*Z4bXP&aw zvk+Mj8@0j9cPuUjYz9^!^(;{ft^!q52y$%&SnT zhDKq2FUM+ibak)2cSu@dgANAY(Oi>WQCpiOlcpdIQVxK;1cC8AtD+o=90QocOI&E) zJM@>?2sV(ZGIca8Vk5e-eEOIs&m8+~I6FSVrxpEb6Rq@N@A@h;%L?D z+M0@}==)en`uPVxD$f{b%XqQyw9Vn_ODk^mq!}RJc6I#SSQL1yfNAg7X>rH*Ug~mc zuDPYs03i@G^}yG@h;D>!5$Ac7noXl^b4r-MHvet~pov80Ygj9*<7O2XQ!|sWDxhc7 zniK>fDFb<4@)E6_91^l9$E&BBjgyl|bs_BRiD?3zx(~%0(2>^^7oX1r3{{FkP6KC~ z75Q%Gqp4nAUQjfqMJm5Ax|W`=$!5>Ym=Ax8Aq#o1pl(X(4)SbH`~I*2&vI-a?fN&p zd5vCSQPLF|)FPYhDpL-J0D_JQftM;FhfL}9(f&OD?(%ILEM(GfEg;#AwR3x6G*o143S z&qL(}Lz8qhWPbWjv^oa5V|N=CSLyvtt{&xx#kJO1f@wQ$E}*(>`nVcta_TVi5iS~g zLR}fdhDqr*K-{3&2|NuHNs@!oNhmp#Y5Tl+PU9?03_jYr7mp!*=JWYGYT!9#WF%)@ zIw(g_CkZKqlQ+)m>FFJ-p9#oV3NEmPQOxh9lHh~3vfi*u&)j1Nxo&4dA)f0ekUH6x z)?8xk%bfR%Ksh^$ z2atgw4gLLF>z`Pki*>s|w#51#S;q@7gLUj&KS#g}*3VRMH2&Y51OA4CD(?MV%U2*L PyI}(!2W3G<7sLMt+b+FP literal 0 HcmV?d00001 diff --git a/polaris.shopify.com/public/images/components/tile.png b/polaris.shopify.com/public/images/components/tile.png new file mode 100644 index 0000000000000000000000000000000000000000..3b80b1e06f08a11ae65310b6c4a1cda161c303b5 GIT binary patch literal 25923 zcmeFZXH-+$_C6dDRKQACDblMTDAGYn0O>6hrANRciuB$@PzeYkRi#Lirc{wm0BO<@ z5l}*q7HT4d7E1D8n{)4PjQ8{V^*Y8m#*Cf4*P3gVXFhYz9c^Twb%yQ|9SjCLb6Z=( z1O_`H2!kDuJaqzm)8ji+0{)_P*S7M4!MJ6i|Bk^^B<;bM$Gl9m)L^9p>`UMu)Gn&} zsxVkZJpF+K4GeZ~{I-Uwng6j>47~;8KR<6yKX`SW=K-2RIT`wi=Zedsgx|Aehll5G z`6?l9m%4ru`%%GPWai|Jt==KeE^KcT&VpOQVDA%N{^tYtAL^rThLYT=jy~Mikv(?w z;Rb*D(ciGQ3xSs<90|ym#brZ*6Eh41(Gi>Dh0JNqeN7|b#dvip>t!^052z(DyrqZutJl;ANq>RY|= zhpRRhSXo(#MvfoPMyG1adU$)^n*=~oR~I18mhZAEDp{E-D%uUQOuYxp{+a3A^S#)(a91GLNVFV!qLevT3z_io8Hu&tM?d zkZwwtYI+w&0}FTJ1}N74dueIu0x~_N;_i%vR9wM1;mW^hf3~tUA12SS%Lnd% z`HlI#0xrFH3IMsZkB_T(Hfs1eW;d;Ag|}U}J2GE68cpyg7(^o$n@PzvRpE|dVd&$q z@FGSapli2XTwI8b8}--l|FA73b=Q4*xbXTVT0sVo8MK%|*g7rATQ{$;5&vB^VaBslc|F)FGxR2XO{usJmS_ll8F{Cxt80J*1{2VNR=FsJ!j+-P40;EhQ&Urlc|-7Z zF5(4)Dx;a@<>FbK)TPzguK0n=;BxrU<=-U}8nC1$rZj9*(Ae7Qs`rZ66OD*yYNi8Q zdBG`k7#7^q3=$_BVw*ZWGt*aH*Eo#W|IRJQ)iqQwfRj}H^5x5bE=^8hZ=8o;m57#lqj%qZ6cqBor$E|7Dn^e8xOYU)A5wynWDSmb7mb8hSJpRdmY{DBig9v$-A#Kc5Z zAn^;nVPRq9Zkv^427@^dIngBS)TExHp{B1fJ11uf`e#wvcem*DyLYR~U2&3si zR~by^BsESY!uaVckHPF8LN=nApwOWbMxI3IrfSsF-eFoc)i$X0losW~#!VV0DC`jH zYrcG`N4&lwg!?wmZB&1Tf$Gc!?E~$BPq7M@9a(jK4d>*K!NMgWy#?x z64Uy}LFQSgm?0j|RrM@w_A1`JjOOBa~Mj%E)d~(ksF2b|y_H z8|gfF%v&7KgA?cETt!6GL>c@KJ%II}xpn$-hYfHHAz`jCx`#ZMg0i1y$bklat<8 z^PloWk%YCiN9qg4V_=v~bVh^CgO6%vX24NlUpmKuo$URB90;TTv_NpEkd8fvAN zT~8yEvcA7VtdPHIr`su*!Ah+W)8n6`7;oOHQGeX?W5Kx6hDiYVq81{1`7Mx6>K!~f z`8cfn#&=<(iu3h$wv8fEJ1V--*B6RL3k$qO=kWWI+eV+KBof5mMOs;%ZjR+m4;2`@ z)v@u{I#G@_MX4O9Eol+jO|-5Jqe}8vqOm%ca`64_UkqpOjj6-!H?2vwq|8qsKupHR z$EW(%w3nGZ^R{@&ns6L;3-ST?b8@a^P!UCZ^n)chm?rXvm!-EG=!;WCRd7M`uJm%x zXoD(|jtKt3l2bOZzEm*#(~y;%NR9A@8wUot6p+|*ewsWS$RK}W33cf+QF~faQsO3b zQ6-6xK#=~-Ud7&kSWVfrwRJ6xhUe$zcLW`W!3>X#!+JD>v>z0Nsqfa#NwHzFLx*M% zatc#auJ@MR6>A@%K44aB?VW`Kq2LC$Tu^s!q#JRj+pthITdjfJn{F%1GX zOgJ2lcqLn{?FIN@mfYv`%R~%=mX;{?>UvWwRf(*O8(pa}4CYS@nbXq-(Z%%fySb&& zgf%?gmw-h-W*E3fZJJ^(@qOtPWqWQe?;-78+3M;4xX&Qx5*J0sn(+&D&he0MTB3z<;*8i7^cP+)Gg z@iiD%02ZWsBs|0gy@!3M^^11uV<0~FsiU&H6#30`y8pi3kwDAXurl`!hUK4o;3@X= zQS3xBavjT&X9j77_UvFy(GhJ@y3vS-=THQ38nQaB?brp#6@TCFtc-T z^m84IyQ$(drgU|I%esFQgX}#84|6&O#1woB4$9UD1V5mZY@4$D!Lo94OCaczN!2W^ z8n&jkcRRl05Gk`}6>Qd!hY>xJkE!uzgW=Kdv)EqCtXRds>(iVlrc!k1p*)uNwN^wl zcg)10Yvt*~9nY5!nIcWq;}@u4;hBIZ3vZod5gQ+sUJsTt=TZq>^`+B1IM9(7+F+AP z8^>Tc8ZX})Z4{O@XGVhUP0Jk#bD{aYSDOt{!Y?>j5vyMDv2t!7)8HrXY`du6TFnDl zR`Q>~=3_9+pmQ`)1KeFqpDI_gwLK`Ss}KL#J~c;jUh=6I@UKG+L}#pN3)9ZekQI8!RB$#G-tK*ayJtU?M^d<-pdL1_7ZP6X~#LTHs!UVTP zKc|Q18by(#^LMPg&!XK-0et|5HC}I7_*F>iT z*ZFvwuZ{3BE1==xM;hMkp9a@zKP9+4XDRT0d}<2+!7<3SWM4MOAR_uwowfPr6n2wOz-9h$LNNT@7Fa%yXi{zvB)WNxI&)r!8S z(N@|#!NoOJ?)_%g4KUbWg^|nh^spA4!rJ{ivXbe!xw!$d?j9b))t}L5Y*Wbo7bF{V zhLAkuaaz&aVC#_s(M!78?(XhG)vpQsX>30=Rb@~Ez_;A_Tc!j&%(^|U-9%PVF{w)aBac@O5j=Q z1?4Q2Fi!6zLwq~M({m>7fd5a(f4Ba1NUnm(z&X1Wz+#!t4Gj(W-c$)XEP#FK5bOH$ z$5@$N!|&g}OOu1kBDq1%0BNVCdO<+}!1ai+U;X|1e!jjx0l&7Q4>_l6vG?A71ku|E zN(?N;#l`E1MB-WS6FcaK0==OTffiLpj&!XpIlX5kKNTHpF)m-pYHGVTBlQi&nclXu#87%_t=g*&tp9{|lZCrZhf3-xc z>%p+Q;|l{e7;N`K7?B!ge~mfHAcJvG#;m6GcWy4o`}PYcK~yM^3YFfm)zws7S7cU= zgM?##(9Z~*lG&s_VSt2_Q&Az5mX$R;cbqbGv9EK&6L;d{ShY$_*^~(d!WiPQo z<)<&h!ucV;10Lh&Kra|d*x2xVMKcbPLJXOn>iJXZi&c~lzdBZ{&s=Ey_!jL0j-p)S zKM!J(Cy2qx`9PBc#x$xkGBWUsi-kc&HIK2rzwh3)sgC{F<2sKMDP=x#LH~N{DR5v{ zmu*$|3ce#eJv~jPY+h4sxkf~HTfX<}>f$FHnocOa9(!=|+aSXF$UWb=02yE!N)3nY zls_~}fm=wlOihk2DhKbD8;$9bfBO-pk_i&suKKrH;}MZ&kbeI6Hx&juZP8pkLIq+m zrM?H`kZ=1b1JRM}qtH1|lvU7iu0lJH-hBrtpfIfyeuV;j>?DSf(p}LlTkzl{z}>)VEUtz*r`)sX z^)CqO{Z28yFw7$I~k#;of3pDmu(wk#k1>qhc6;5%KEvTm>v8aK)6ZSe3219FG$ z1NAgwMrKGgyVz_sFc&vyRptc-MJmjX+`ir(vAQ~Ai92Luo^6K2{GR{F{r6zTW2O=^ za)|YDzVb>+SFzVCYHDQcOq5cB3Co16f#|BLDmRY#YKcpI4_T}WfUp_<-A^U5<$l4~ zx6J6}5IQ2w_;GLX#vgzFIFKS%*~=7v>UUIE$OTCh?>qtSwCqUI)*ZX=->s~;Wt<+S zef4T_ch{c*zNq+|J5x8#%BSGl4@9g|$ypRIP`@Jsb*p;+H=se228ZV2JTZ|CY{2xF z=qsE_)0GD7aD~CXphz1Vw1ZDaXmZlI)v~~+{xbRCcg=>R`NiBDom8vXi;k+k1Ia$W zR6M-AfR?{>f^ZFl{_WkF;p?b;bno=uUVTGt?V<>jC_@Tk<|MZbDa}7GLO4v#s>R6t zVtl}sQ;ybD`apQwruE^WuxV!;Gw~L9KhADp4Vf7t5S3 zg0$&qY4>v+KOFX>o-+yx3iA84?kwmQV9|Dkf72C+=&(7t?RWyEW=!YWdT1+dugUv& zdhp?|Pg1=A*;|^ES?FN57=J4$&<}Q^ZT`6P_4YWn*Q!vRI)2zj+t7YYA!@wak&cxk5iBYZd4$Q zU>WfYZ<(uQ=py1+GUIOPT#%z7J@@8UB;N_0s?)6#lyU6Wv|KPbX2HVYy z%e|Fh4x!4-vB!Qxh0AM4sjdDdd>S6JKA}*dkl;S^=XUqd$@7L`Q}Kq5@}aD!ws;FN zPp}G4Jytw%>0LZpnTFYhF~#9H>>3Mn?)`b)4fkb@>*A;77{vP;I5`_`ZX8^HCTz!Q zL)E`IcX)sZU%%0)T?6M_nhPL~hYXu^G)E)YeQ01Uo<~B^Ym0`Gl?!8IV;G>g7LPd9 zHe0`n#h$*rnu%~}yxSN(gbt1kDW1xavI~&GG19Csq z#P(r#-dNmEl5%8iP_S7a{&^M+E3M#yYKPeAMJ@PNkhtw(h}hQ?z^y@wdjEsts(xD( zQz$?Vq5DDmhv$~Q?2cma*FLA$T>QFuDD*-3qyKe!+AmzkV{p`uX@9V+E#AJip$P?X z-gOy}#k{>OdE+{sH6uBU2m*QYt3Vdz$$oMT^?9Pwg?Qu}`{KQU4C?#XdWtnKt>{K~ z_3I%=qKD*;Df7O-_a+BOEs>B1A2P%Lu>D*fxKn$MC(MAZfh6+6o_Ujge7}WfuZ3sK zK&>wL(;_Sod89OZfUx|Do(9Vopcw;v%UQOu_4W0t&Rn1u=WT1?=V370e|j;$uF;ml zL8cBl$@fKK`_+-Gom-O~zrk@cg8zT+1l-g;H>=}7eyi^mxmx_)oX4ie z0Gjc8T=skF*INn931D$z?LcVPc6N3!TL5T<_>5wvrhLOFYh{_&q-g~z!+3fth~tx! ztH7G?L;hcf|5feVs0#s;Sd0(3Qcj<^KbJLm6^oV2Dm$cX4`MbA!?1o~1L!HN6)gGu zGC@#m#$rb#5ffSouN)sgHZ%eovWFC1OzcT}$NW4vP>k3sd$use6DJJ0E?3R0 zFLZVW*R4~iPaC#Hk;C3m$b#s{56_)DM+rV`I48Y#4Y}=l&M@NT{z0&B=6n|sOW6&| zB+L9*d5XedY+_cA!Gxd!{xpI??VexzyjYU9Y-{=1vuEo8e25EE02rY;WdEn+$4JHr zXDO$rPayylel@xG8mb0 z?m&?JN@{}1(%BwM;p|Dua_T>XHNv2R2=#p!Ofl8g8U_m$f{({O>_KM4R2*hLW3rdw z{Q6ubfG=scm17p*vivU5*>q|~bm|T-vdr^9bWW+UuI|lACakV~!U}JED63{fL#SV; z{8GFrXPtSahQc{y7C==T89?3#$SHmgpHUlY>yH@6mC!oxi05l-Ym~_I@yFV|2qy;B z{z?c6+9U^4y!HPEXDNq>DEVDC5N-Y8g;DXfm`iBkQ9*}U&ovo%9`cFxNIk+Zfm^3xk{rl4tpcJrA*^*WF`?O+%UXk3#iI^jsT0L=P2>EzBggIb>yE zaIir{cwu3{%ht_mDyF%F=Sj!b>ZLya!bp~qy>p+v`9K;xh+h5xgF)1Dxif=Ko;pu< zdoiXiBLWx9H-co7#4@fwZ8|^d$$s6SaM|rJQs|;!Uif}s@@&S2^4#Hl4;)4DW112J z+klpOe{<;_8B?mZL#yeknuZnjlQ2sp(2{WJ1gECds#`OTEP8WYCC+~4i+vk2lBkR< zbnqM2gpzydi5FyJZab(PgC|ql&Q`Nxr6$*G}H|W3O24K_36r4`T=1Z z-2qw8IYdE5^c4;AR`VbAkqk|tzLcDpPj)TVc7aT7r*ddWNJ|K;ChYeWgfnh9zYfY%xfed7}D8tS)Q;8vHFG#qzm*&RF24 zep^=01*?m?@QhfxV#N3#``D9P)x@78X8y?B(aSkC`8rOBJm@S=pOyr2<%6FxaPTOuydmr7y7Q!+z}KSP^%WBVr^L2iluGwc zqfxDU*Ps(OIMo7os}E3BK%$GcUkATq?%i+XB6JbFzqI=>zG<{4~ zS&T0lHCcEpFb-4LVZ+OHE6Pu7JE{}CuJ{qpZIS2MOJxUbD_wZT^f;dzMxcV5L{}M# zU+w%Q;s%Kx2x4jOvEw{2*fU<>X)PJ*-pOGYOdE6M{K$ey{`yze%`_E4?p{lO!Gw5z zO3)4Gg6w156$&HiI|&Dyk!>O;p)1Hz|^JlJVtHBoVXU! zT6w1}yLjfIZ2=8>Z9WZmP`G?TR!NEDo}4fI)X#XGyX`xw9sOeOyPIDY#U}N-bbR~v z?Z9ghP*L@uY?K0dGW#|Y4Sm&Mk(dY9zX<1=dCF`X`5oW}ZM_TB<1FwSrH$|832-OX zn^9(+poDjWi{31oE6l7eukOL7+1AV=Nopn+5s7J2K=l`e&Pj|?#gnTe&Bo)u(ZKrCt5OUAM9hpPHUrC(0w(6E5# zetp(x%V_2-1Lv&!xmRI`?7=y+I15hR#wCdZlKmg3IHT9MhOzOJ7cGC;6nQhMiJD<4 z>3$t6chqcbj@9Ot1&fYogN3Kq)mBbBe0kZg>{njAPwvod#q<#CL}dL$HRY8oBHk$C zUB(`=bmD5`CiI6-@p-tu_&4n*#9rKB?g>WW2Or$`!vM)oE0<9cc2V`c|63Ensnx(x(x27}m_FLLx$8x!m6vt6X|O3BnF zTvPXAX`=*Kcw!jyF__*hRD#uVU}&iA7k5(r_X>AF5=w}DD3@E%PAc}$WB#KtAN0DR zwoB*|5g8y+-08ZNJI>-$LCu>HD){GaGZa_kD0&xNBdw+qy_KAPj96xsfVh;-X#opQ zm>)QRYNhBn?tMN002b^Dc;E-9VS_`P#j-PZ_MEy9o)&d-yCVrZJQ!6(Z^d;TA>5>E zS$^;dz;fCQR$q4>YcoCUE?`gfeufZF4lA|(T96v?P3Z&znf*cq(`v1+SeH`=ZS|)jS;Y+u3;JEJ615Ak-(2*RT{qsC))kWLHZJZj zjT8icV9;^{N-f!L;}`mC6MlYihPTx`f1W6jRM1kdon7M>;4!?0&ar&gFkM3TrcPbO zhOt+uYM)q}r9>V;nky3M7Xxg<9zN_tJ0}e;tX9PC-+xpQphp;87NO+R@ z^Rxw9lb)iic>@NR;T!BY8i_-|9v_rhl%|{9zh?&i-lSIWtLl zLi*J!$JmVH=tM7GT=%zcw=KBKcIw7#2M8$l9Ky{znsS00lj#1qyUM(xnhy^Rs8H4f z(`L*@G}MlD3tFq3tG z81cva%LZYR_ij|gGT4+exd@n)Fc`{t$GRe3`p z%Zao;#9;K9F76m?R{|VgON;m=F|>iCbkw&#H@lw|;wq*-GXD5y6pZ4250%qYd_V1) zrS`Gykpjb~aqfXdim8KHDl&FwDWVfG6&9asxH)98pz^7LEbrAk%MBu9Nqwj_kDvX-$4&-1EYoIQtxz;GmmatiM zL7r4y9B~hiAIR82u4oAyx+RS!%^iO8%4}OKV%jgk{}@~$O$1o1lkcUEyrX@2{<4np zN~NJ-e75qA=h?HQ3Bb&ULHX^8S2I72;D4C7L4s1g;inT;Ry<9~#YgwpFedv=qRmlL zrk4^o8A8fsqSob;bL&FA;}BQv>}m!hybbeW91Cv=jP(QBT>(UIC{GefxwxT@A!X!P zM@0M7>h1+0u5S^i6gfDO)IvvvvL{<@r6ZQBzaM+uwk(AuW#B?Vcgvn^vGrqw?gy_p zr8CwWMATTStK*`vmT6LH%1&3;Q=01mk1I7eVc~xuR*Eiv+Om3jJ7|fW%`+WvP|Oad zyP|SzvSK%;*tGNoTEIk%68;SDkUG z1^?n6x3qLu+Ri<%vNrPDm)?5`!8ZkJInZZt$b*Sa|WS+BP&OSJ5tRVt798B)4e$gPUP;uQzxOZ)2VC0RT*vTpPke4q)jtW5<=ql4VzlRkkmG28swZSrA|ADq%+I~;phyyJ>Q zB7c-d?;qPq*Sl>yn?|IFHVBH$HQw!lkE5%anv~87iSQd0PwF2B3IiPgOH##k1aUUV zYU6D~IH`u|#g4!Y7nMQ&sF{j%C9BHDo{dXgV&`#dKmAEj z`C>;k3JHwyh;Xnp@@c){_osn(Z|s9-FoO;|JG(csuDR|_yy6{J8D8{MB%>)Ub*%SZ zHOA_`<;3uf_C;k_xQ`%&5pUu1KBaGEsqLh7;GIC(c9KKsOQQvnrDRakmPzTEWP>1s zCaBGfd*UyXwu5NhMH)Ub#3I&;0J{qT=U1^_#g~ezq(yJi31mKA9X7Cft+;?$5l$+d zO?$I^>u-LiZ78SdCD)riw28%+)Ged z;<|akZG1YH7oh_*K@?(+BYR6QV~M?hh?K7AoJf;2wX0!OC7G z$TN2oG0B$T7i=s(;VAJK=>!i=WZaFnD6vk?Aa4H^FNZ!G){-k()y%Cq!(f5Zkm8oP zo0_FbyFGd= zdXwcFKANQy|Mo=%{f4PjRKwWa491AQO9<}449LAg#7ekD?bS3A+J)Bl4M~jrgcWI+ z?aITc$?0^1-<0jKG*|yk_nmgO288*9n`+uWAAu>&Kr50+3YZ0q+LxLdg$DDr48fOlxG9lulAm@Dn3=%dpdP!wYRoi6=DOZv z-(JBdg;(Fc5N4Vwa2BDN$sS0^SX(32>3>2E+C%Zr@!%>eY&uGWuARl<91>JB8iO1` z{^L|r`FWTTs+sALQ*f2Jw;{wXlio=ZoJN>U&l)Y**>u6kOk`cwv z*toF1>_Wc8C{>UaUcwu%KX&f2U!5J2w{E;f=f+LzSG=viXb;E~sMtQ8T&&r%nCagn z>AY^iEX!Ka(D3_HLq|8$1 z`uh6be2`!%D@m4=z07UaCx@$=@nLW@kGfr|0t>%%B!J>eYfKlJlf+?}5>dY@QmC<5 ztPEk?U!>Q6EMOtTc0Y|inmC1x|J-LQyY5MP_-Xm=cv{GUp~D4*|8(3onnXk&K79(B zy<9*sNApYLEzQZ;i;IxY-meCI4xdUY?Do@g$2-}azVvy%G!Ok!O7uAiGlIGU%EOy5 zm`Z$ftY1&b{g>2-&{F~16z%_rSyv<^W8YI)NPA9%6CQQ zszO(7fVPxq9Nh%;8-G{(2Nl=(<-iv8vPMP*Gj6iWUKIp-kjn4MfaZg>&ex?;!qhKh zs=O$rh11PFo*@gyPBzC?Vd2^T##<^6#E!f0w@s#=W zjVWvkl@*AGXdaj-tCy7Z`Mf1)30tynYzceOPhV+G%ZVE$sL+8D+mTw( zjC%HOEa0R4ckmdUxQuVEJ+7Bc<&nj7Q*yWsD`VqTgVdI^?D3?$7(NF#pKBG>)zV?0 zH?R=G6+$=6E=cocc8Z4@w!(+m-Zjfw%V{b5J;KI~&%ajKz@o#@CVu|7YIZKJRG->L zO{(x>4ngAK4bT8ShCuu!Z?E00!F!%A_S1{>0HN^fzt9rb4*XsN_a;rP@Y>z`YsEt8 z<001enKQ_F+0v?n<9SSI(>}YX@SJl3#SICz#hzK+BZJSvjQ z>U{h%gnSJ4Q3}Fx6_Xd5s;WlLaOdhuEeK!#JEm_N1ix^T&_5D^M71Mmx+k4fwojF= zx@eyqlsd@-^;94U!)bnB`=&XW2nDzYT9 zd}w2(rrZh#n_f=rS3GFA3xj=tNdIfEVjo=$e6u`1ir4{kNagT#Q^Y8L2* zWTL%5q~(AN@kCO{iDWo|3pA`ws3&-+m5jp^#>|)vRw<6pf)^+jn2Ic%wbi7p258#m z;u;+MDm-;&N`gP@duD8-A7acz`FLpc-5k%)BgM89(nAF~xr>boe7HYM^}ZlZL_zSz z-m3TxBK+V@Gh3!OYSN)m=R32Bq^)4CPpHgHVP$w$-LC1y>cp`m;x*pHPFtx%vrOH3 z{*B2G40?0c4PxxQTMh0~xO=0HtB95N%MJV@Uvsj)xqPMpHS|Z2|GnhDzr8kn48Cc@ zG@&IKRiVaQ+*x~Y|HAf;)QO_Xpd8O^=czLCL7tfbc1CjE1w^@p2kf&?oBw<2!R z%hqnxGL}- zXkRB>ds&fY2KVf2K$hpK2;Gl5qC(iuADSI=q`3rKN`!Ao2+dNGHg{-ou9qi!aU5Kw zbXjh%V>~9)>oB0GX$@DeFk(Xa=y$PxI7`1jtCDflR5lmx*)A-F~MwbUGJo-uSA{~ zvPVS0#`ElOpt70b-aSDXp zG$l^wGL^3BI=>2Bqk$^9|EGD)VXb}e1LV6<0fKSIK1V>m#G2(ViBp0zf#2Gqy)`oi z)v{Cer93n71<1BI011qtW7HhNB5dTaWWT)-CR#z07nyrDs|fl~qP$(bd#&A-kifuS z2<;)s{QN=m>)B*2^hs`l`ankL^V`kaxQDie6m3;y+@@Cp%?G}+qRMwmf0_5`_hy^# z<8DRdH)a;0&jnPVOHTBMsCOP|bV$oT=^|B|mE4 zycFe3LHpt~r?MjHn2+5?by)p<$3N8TY<2v3YT;>GFQq2m$UB+}8LY7>%U{cdd$y9U z6pm&l7TioN4>}FAPyV!x21OqMad;(QJ!7Tz1h_kJgIPEX6LPZYK!KUp%~OlQ^GA1H z=mQh-Zd~b~fQ`(1Sk>g3vcW(v2=5hFXP05bZ*LW}odKnu)g#)KzM;rJPOv z6fqM}nvoKdA0~hcjCdhYHJB3I9LpTBP_+fdHgu~fpcZZe`2&F~@NcmP-)zQ^Yy90A z{Z{E235IpVz&@V9&hKX9qL!zvNtttOc1%}E&K`hluD9}xGxPqn${gi@Jn@pW+AW@=C3k+#T^OrjYd9%V@ zH(J}rInf!JvcNb4snBnt!2cZ&l2dr2V7ETekQTg)d`aBM83HGqY-Tx2Ja@4e;cphB*-B%Z?|srn*< z+MBlVN_I3gBh{_{Ruzm;4=xHOy`On#-W|$TH=Sy=9*}qHU7Hu(8GVx|mGG^eBNW zfQuL;tQZuSYfzt1fqoRm4T1)}nT4kl$ z@PMg5XMz4Rm!Ih-&97h^zQRSVVX+4_?s+4o7nu|J(aan2Rb4ah*KNanQjxX+XApk+ zn|s$DUSQ76V9?&o5Fnj?+cy58V1tyn;#p8`3d$}wq2yGTr=!MObTfnARG47_kDtuW z&_cZrh=T^pxX?GQ2wh&fu}@a-cGaoT9uEh5MI?9w~43kDjc zMXC6&X(t(~kjeSK0wxXbJsdG5J^Xh6^V12}s=FY($U&BzqK)>KiR$$>)_e3>C#=91 zUun>)^h77ql_~~Tcxmaz9K$p_rLh_1F4Sr;)g{(tZqG3_K?<-cOeKo_X*crhH;eV{ zk=~kg=iy)=9n#+T@I8BrcWFqcODDz&bmE@w!Y+V^7@<5t-6xCng6U*tkJ_&SlgZTv z#Xa~hTG20ImGn8Dc_XhFc=E>I&DwHzOh@W$D=1^9on8~%=zPL&y8NBf!(?bB?tT|Gftcr5s6(t7Fu^Q#lIVPpb3Tk^|?6@ zhP`9jobYLeI~wpb23mO*%vkH-`~lRdQM}nZ{XE61&hhieme|3su+xHj`9BYl#aR~( zx1QL?J$D7B?E{&%`K>S+4=Pk~g1Y)QuN6Nt4b;ZnsxF__=IBW)%!41gDSt!B2X!T{ z#1pBRNY{%}?Q=Z!j7xTeaT}o9q)ma#^ArF3+c4Q`V|VoHD?C}Qq+s10W{?uh$G`ji zdkHH7xHRBRl0I;noaXkca$yM(rDZBkL27CG96nrSE=zPg09ApB>Y+V$-Exz<_MnS= zN!l)mm|@T{9^17B7APvv(a2<|5_(YUi!^#RC9~eNtWa-gXgDTrbm`8#WPkP6xY~6lsIE#WTYFTE z!1ROY61Np-4o^w8h*R&W{q!?KE}<=?c?Z#IkW#dy9<8_v-ALu=MsLJA^|OhdEGCo8 zQwU`mVRr!`Z3h+IFEy7iKACF%DM*Vb<$yC_3SrSdqw!pT%0{!9_5~#l?W_33!L2vA zkdP21!d~}4EP|fVi=9#X6Rzd|@&_ ztMs|Zgv)Rsy0zHy*$&T`9VhK6g4<)Jzl6haxg{&|jD64T=mC5Oh5-n`$_pfurx^N0(ZdJd0S z3b3skU{L0J(H*}Z?wCAZ>%?we&v%Cq2_}GkK{kKD8}&UlxF-X*BYJaV$jc-M7`xuOSiUL|ow z@JZybKDgge^FNo)lO522Ot!3PTQ(K`xSgAQlk;m#fV*VSLE&N`$hogT-uAf$NtmRd0>M2WHk^J0GhcdMwc-0KV`WZV-~0=3MYcMbvt%%75HS5piz<4*>wKH^UpqO23I2+Ps_R_XJYCS% zgM)IRzYm3noL5cjg+;V*e_d$>ltT~3*O9dJPzNGc3H);BO^|mBfqVg0_8K@CW?E5d z=C8f?3u66eu*F?+;8H$cP6a;i4bVeQ9w7+ilrQUh`sQ>E=#qZHzdP*I-=MWg^EKr3<(A%@q@_py10K_^4 zywT?0hEx3JrnmAQEn644RdwfQgb%=YpNBz^MuMjKPA{(z3@GcSK{|6|>+fHCDgF* z+28Nx64VexT+pwPR-jbXI1Ri10i(yw=P&+N0P!EJ9R5`&SmVeh6GMZ^NH&hLSD*;GJ&^M0`-wjB&kqeCBgnGf~z z!hatg9+Jwo96AmXxCT*m+cwwu-z`O^DeZafXsLp_aFC<%Qo6Q(>Md~OcaG%Lx7Od^ zmT_7*??d=Ldx-t|jlS+3!&}4g5%nRb#k?)A<)zo$jn6nAawUNaeUq&_E1BXuOuUH; zg%5$T4hg6P_5RJfh|(zBlok1UNW$)Z#Olb<48CG^CUo21-+yts&eKic{O?~=+#Ms5#-spFdGVjU!GaoSR-TOW zRb?SY*ECM8i!PnIb0fX5RsfjG5$}D&3+h`I@gm*bx4QEEBuj|VFyYJY{yMHLW}bK> zxEtxkqPU5Xe;2Q+5jx1UeM8Z&aiVOJ4v3B|8d`vWNnROSf|>EFPp{Rs$~5)nrLii{ zm}##rsCLeJ_;<$>T{|_UtJm3X9<1+9@xNGX;M|*bNT_hQilFu(5=TrP0@XPhyNpJa zMw9VdPV3$QJ7v#|=kZ&hcVV%TZ3yJnZ{uw)-QkM6dTDR|;Bqc62&P*{1D4SZ5l-VJ z^|dl(D}bC*P*7MA$!E*T@#2Xm6&6|TCcx$hT^^<(Y#Sj$Cd{vcxu`c)vf|;(UA*(S zc#hLmc8jHDr9G*yaO0)Rb%{Iv!_x#`-$&5i?n8XqEk@8JUvkGj4yXkFfq7cl;`k_tc);VLEk-3o6^ASm-3C8 z3lV1pXLfgMy|Jnhk)XXbO8&y${NQ0O7yl2HW(t-yu(Tuh(?+nTp2dW3tF-a(C{V8> z-LQ8*bXn#^RfVr`k#f|*V7T{b*ZIH z%X@}LN{*sgTvcFmyx^Z=UlxOM`sqhA2D*eABcUU2Mf82PD{$xW`wGhHrH!U@V61^( z)i_x(wXC4PCO>qrUEX_Q^QMeU16+Tp5pw*I&213N>pUEvH227TT&R!t35+wJmbAcSU+umLIZLr~noBw&2fQcyO6!e5KZ9CWslsxDC0%*U*+# z5tA>QN&y}1ZE#Q3xB4f2rI&c{;a+vgm$)E-W{dSbXh`P&F3mv4?F%%ghR{u@8Vf6& zU|{(?F8zuislg`IZX4$WkZr&()@ zYLz{Po$-NY7G?!<5=SrWdKxHnO7LgMJwpivW~r&7z?wGj{)hMUl~qU{Y_3VlEf>}< zdBPk2;+aczBVf?!mim!ssuwXE!pii5WKj&271{dH3mEq^I%Uw^c8rFS;CgTPeWx0* z!#f)_0YHwX74|hbi}epc;pyZ>m!w0+aGONLy$gss}Ko#!XlD z31|x5z`$U^&Q6pNq!zcV=7%Bxh2~KCV(k9u$gll7KO`bA_yrY1DB)9JeP;P8W9Lyq zIM2Rl@eb=;we#3BB}Nr6Blv0Z4x|aZWao2WNqBmETPSb(Za#Y!H4`-Yv%vjT_e`~= zLT-9GJ$k#-60GQ`<1M^Zk!e!t@y8K@(>ZltBeRCa##PWAy}gPJ^YD-iGwXHz{rmUI zZZ*o)DZv9IyMGyuwm~#9TD;MT3;1qT4yp(UfYh^|GocgRqQ|`N9K_L#54vyz`Si9Q zOw`Icc*5l8AoTs_h`o3ig3M>cQ^eJ5>h8&;aTev&^%++qRlvS z$4{TcfoN{jUVwxl04Z5JH=+qv{#x)+o+Sl3m=d~ls^yS1${&G-N(URq{Jh0(#cSma|$CK0pZxyh~KX?N% zE7)umjcXNXw8}X_|NI>Hw(66xmLX_>@7fF0`n7F+F#!xC7#Onw<9O&huMY13KmF7@ z_+ui<^=Rhc>h2gPGzWd?2HnJ#oemZf`n=%;)Np!D8Zj)z3CJE)_?tz%euU(K!?W!;5&q92>u5i7==3AOwy-h}l)((RwO) zdU;htoz+wVI>~*!L9n&{Ikh~1Ga9qQ;;)M8>Wn}%0VCYvYi8i>Rp0W`=P9ptn8KU5 z(+X*oQUQ}4VPFQnQ$fjQ<~i~@!O{rw8yRUIE3TxJ7hSx+1qknm;|2`MkC#4JuH68# z2=9h;6;aG6w_3KXn4GnF1%-g#jR2^zX>V#8U3$4i-jNN=F%F^!K@iIURTNe|2YBl> z1ZG)r@3Z-rRwfwKN{Lb7yzkX;503qPLy;0o?Ujj(x@4fI%m;kvk zPvV!cuJQ59TJ#V2HPC2rs*6Xvh4PlYza|<0MIs~6lAiI~n!k0?*6Lw9&;SyIaH{#r zS>oeXw=GmHEfe^6g~dNb2eI$FNT`lV5!lkC}7eC;JG?Oqy9*J(vtWZSO`3e%%ytr@mwLoe~{qNR>t)>6vfgirCxKi%&g8v62Es!KA4c<$V}fvU$_IM1gu z;B}0^XX;njBCqzEG;mToS9=&Dw84F+G0)k7+qQ472I@^D*wSEKa6bq__?>90oCOb( zd=4M;QA1AplT8;k$y56KNQNIv&OG}wE=(8$@b0F@Qn=K3+R#WS-p{!-A$Tv=bxOiH zIHPt#RKT_GI1P-kO=;vsvQkweR`#Y(S`c$v%%k)#R@6w<-6f}UaJygJJO#JhzjFQy z5(!zM*?wAEYh@0xZH1zRmB}{#VFb&#ar1_JM$HmJy?c|6Q1sJH!fsfiyPYHk(0aI@ z_!V&mU7B2n9))^9U&o2DSdo2nw5M_763ykOc0VlS%QgSz-0B8 z3vE-abrB4C`Hqufmzxb6m%j)+;=YxWLxnVvD} ziMIy{jc!5QYYp|6ifSq=Z$Ij+fi0jYQa40ow++>0snqYkKzr5IWm$6TaMmU#BC#6c z9Hp9-Up($Qh*PS-oTOT1w93n`d3M6p&`fUrw;rcZe<;X!KH(CTYF;I)=9<62iIt3D zILRI~7y7l^CGBlxVq{-ig}rXpv0Wqf;ScoJc)q#2+kwXDfSfn!rhgcmls;qP%|$Z! zn^x7n#7eno);&sF75ijGb=!Ho!I%{T*!e7XZ+wIVITkbeSyRj-SaFYgszqLGFJSgR zQKrJi$q#5JIouLDJ`cYmai@+5$}V2qv?18*Y><9tYBbxR}W(O;fkW*Z4bXP&aw zvk+Mj8@0j9cPuUjYz9^!^(;{ft^!q52y$%&SnT zhDKq2FUM+ibak)2cSu@dgANAY(Oi>WQCpiOlcpdIQVxK;1cC8AtD+o=90QocOI&E) zJM@>?2sV(ZGIca8Vk5e-eEOIs&m8+~I6FSVrxpEb6Rq@N@A@h;%L?D z+M0@}==)en`uPVxD$f{b%XqQyw9Vn_ODk^mq!}RJc6I#SSQL1yfNAg7X>rH*Ug~mc zuDPYs03i@G^}yG@h;D>!5$Ac7noXl^b4r-MHvet~pov80Ygj9*<7O2XQ!|sWDxhc7 zniK>fDFb<4@)E6_91^l9$E&BBjgyl|bs_BRiD?3zx(~%0(2>^^7oX1r3{{FkP6KC~ z75Q%Gqp4nAUQjfqMJm5Ax|W`=$!5>Ym=Ax8Aq#o1pl(X(4)SbH`~I*2&vI-a?fN&p zd5vCSQPLF|)FPYhDpL-J0D_JQftM;FhfL}9(f&OD?(%ILEM(GfEg;#AwR3x6G*o143S z&qL(}Lz8qhWPbWjv^oa5V|N=CSLyvtt{&xx#kJO1f@wQ$E}*(>`nVcta_TVi5iS~g zLR}fdhDqr*K-{3&2|NuHNs@!oNhmp#Y5Tl+PU9?03_jYr7mp!*=JWYGYT!9#WF%)@ zIw(g_CkZKqlQ+)m>FFJ-p9#oV3NEmPQOxh9lHh~3vfi*u&)j1Nxo&4dA)f0ekUH6x z)?8xk%bfR%Ksh^$ z2atgw4gLLF>z`Pki*>s|w#51#S;q@7gLUj&KS#g}*3VRMH2&Y51OA4CD(?MV%U2*L PyI}(!2W3G<7sLMt+b+FP literal 0 HcmV?d00001 diff --git a/polaris.shopify.com/src/data/props.json b/polaris.shopify.com/src/data/props.json index 69d62e960f3..27c27752d7e 100644 --- a/polaris.shopify.com/src/data/props.json +++ b/polaris.shopify.com/src/data/props.json @@ -7218,6 +7218,15 @@ "description": "" } }, + "PortalsContainerElement": { + "polaris-react/src/utilities/portals/types.ts": { + "filePath": "polaris-react/src/utilities/portals/types.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PortalsContainerElement", + "value": "HTMLDivElement | null", + "description": "" + } + }, "NavigableOption": { "polaris-react/src/utilities/listbox/types.ts": { "filePath": "polaris-react/src/utilities/listbox/types.ts", @@ -7296,15 +7305,6 @@ "value": "export interface ListboxContextType {\n onOptionSelect(option: NavigableOption): void;\n setLoading(label?: string): void;\n}" } }, - "PortalsContainerElement": { - "polaris-react/src/utilities/portals/types.ts": { - "filePath": "polaris-react/src/utilities/portals/types.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "PortalsContainerElement", - "value": "HTMLDivElement | null", - "description": "" - } - }, "ResourceListSelectedItems": { "polaris-react/src/utilities/resource-list/types.ts": { "filePath": "polaris-react/src/utilities/resource-list/types.ts", @@ -7713,91 +7713,6 @@ "description": "" } }, - "CardElevationTokensScale": { - "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "CardElevationTokensScale", - "value": "Extract<\n DepthTokenScale,\n 'card' | 'transparent'\n>", - "description": "" - } - }, - "CardBackgroundColorTokenScale": { - "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "CardBackgroundColorTokenScale", - "value": "Extract<\n BackgroundColorTokenScale,\n 'surface' | `surface-${string}`\n>", - "description": "" - } - }, - "Breakpoint": { - "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Breakpoint", - "value": "'xs' | 'sm' | 'md' | 'lg' | 'xl'", - "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": "backgroundColor", - "value": "CardBackgroundColorTokenScale", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "borderRadius", - "value": "\"base\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"large\" | \"half\"", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "elevation", - "value": "CardElevationTokensScale", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "padding", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "roundedAbove", - "value": "Breakpoint", - "description": "", - "isOptional": true - } - ], - "value": "export interface AlphaCardProps {\n /** Elements to display inside card */\n children?: React.ReactNode;\n backgroundColor?: CardBackgroundColorTokenScale;\n borderRadius?: BorderRadiusTokenScale;\n elevation?: CardElevationTokensScale;\n padding?: SpacingTokenScale;\n roundedAbove?: Breakpoint;\n}" - } - }, "Props": { "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx": { "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", @@ -8074,6 +7989,91 @@ "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}" } }, + "CardElevationTokensScale": { + "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "CardElevationTokensScale", + "value": "Extract<\n DepthTokenScale,\n 'card' | 'transparent'\n>", + "description": "" + } + }, + "CardBackgroundColorTokenScale": { + "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "CardBackgroundColorTokenScale", + "value": "Extract<\n BackgroundColorTokenScale,\n 'surface' | `surface-${string}`\n>", + "description": "" + } + }, + "Breakpoint": { + "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Breakpoint", + "value": "'xs' | 'sm' | 'md' | 'lg' | 'xl'", + "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": "backgroundColor", + "value": "CardBackgroundColorTokenScale", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "\"base\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"large\" | \"half\"", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "elevation", + "value": "CardElevationTokensScale", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", + "syntaxKind": "PropertySignature", + "name": "roundedAbove", + "value": "Breakpoint", + "description": "", + "isOptional": true + } + ], + "value": "export interface AlphaCardProps {\n /** Elements to display inside card */\n children?: React.ReactNode;\n backgroundColor?: CardBackgroundColorTokenScale;\n borderRadius?: BorderRadiusTokenScale;\n elevation?: CardElevationTokensScale;\n padding?: SpacingTokenScale;\n roundedAbove?: Breakpoint;\n}" + } + }, "ActionMenuProps": { "polaris-react/src/components/ActionMenu/ActionMenu.tsx": { "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", @@ -8155,6 +8155,13 @@ "value": "keyof SpacingTokenGroup", "description": "" }, + "polaris-react/src/components/Bleed/Bleed.tsx": { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "SpacingTokenName", + "value": "keyof typeof spacing", + "description": "" + }, "polaris-react/src/components/Box/Box.tsx": { "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "TypeAliasDeclaration", @@ -8185,6 +8192,42 @@ "value": "SpacingTokenName extends `space-${infer Scale}` ? Scale : never", "description": "" }, + "polaris-react/src/components/Bleed/Bleed.tsx": { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "name": "Spacing", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "syntaxKind": "PropertySignature", + "name": "bottom", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "syntaxKind": "PropertySignature", + "name": "left", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "syntaxKind": "PropertySignature", + "name": "right", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "syntaxKind": "PropertySignature", + "name": "top", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "" + } + ], + "value": "interface Spacing {\n bottom: SpacingTokenScale;\n left: SpacingTokenScale;\n right: SpacingTokenScale;\n top: SpacingTokenScale;\n}" + }, "polaris-react/src/components/Box/Box.tsx": { "filePath": "polaris-react/src/components/Box/Box.tsx", "name": "Spacing", @@ -8690,20 +8733,20 @@ ], "value": "interface State {\n disclosureWidth: number;\n tabWidths: number[];\n visibleTabs: number[];\n hiddenTabs: number[];\n containerWidth: number;\n showDisclosure: boolean;\n tabToFocus: number;\n}" }, - "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx": { - "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", + "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx": { + "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", "name": "State", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", "syntaxKind": "PropertySignature", "name": "sliderHeight", "value": "number", "description": "" }, { - "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", "syntaxKind": "PropertySignature", "name": "draggerHeight", "value": "number", @@ -8712,20 +8755,20 @@ ], "value": "interface State {\n sliderHeight: number;\n draggerHeight: number;\n}" }, - "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx": { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", + "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx": { + "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", "name": "State", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", "syntaxKind": "PropertySignature", "name": "sliderHeight", "value": "number", "description": "" }, { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", "syntaxKind": "PropertySignature", "name": "draggerHeight", "value": "number", @@ -9769,25 +9812,114 @@ "value": "export interface BannerHandles {\n focus(): void;\n}" } }, - "ColorsTokenGroup": { - "polaris-react/src/components/Box/Box.tsx": { - "filePath": "polaris-react/src/components/Box/Box.tsx", + "SpacingTokenScale": { + "polaris-react/src/components/Bleed/Bleed.tsx": { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "ColorsTokenGroup", - "value": "typeof colors", + "name": "SpacingTokenScale", + "value": "SpacingTokenName extends `space-${infer Scale}`\n ? Scale\n : never", "description": "" - } - }, - "ColorsTokenName": { + }, "polaris-react/src/components/Box/Box.tsx": { "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "ColorsTokenName", - "value": "keyof ColorsTokenGroup", + "name": "SpacingTokenScale", + "value": "SpacingTokenName extends `space-${infer Scale}`\n ? Scale\n : never", "description": "" } }, - "BackgroundColorTokenScale": { + "BleedProps": { + "polaris-react/src/components/Bleed/Bleed.tsx": { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "name": "BleedProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Elements to display inside tile" + }, + { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "syntaxKind": "PropertySignature", + "name": "spacing", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "syntaxKind": "PropertySignature", + "name": "horizontal", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "syntaxKind": "PropertySignature", + "name": "vertical", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "syntaxKind": "PropertySignature", + "name": "top", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "syntaxKind": "PropertySignature", + "name": "bottom", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "syntaxKind": "PropertySignature", + "name": "left", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "syntaxKind": "PropertySignature", + "name": "right", + "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "", + "isOptional": true + } + ], + "value": "export interface BleedProps {\n /** Elements to display inside tile */\n children: React.ReactNode;\n spacing?: SpacingTokenScale;\n horizontal?: SpacingTokenScale;\n vertical?: SpacingTokenScale;\n top?: SpacingTokenScale;\n bottom?: SpacingTokenScale;\n left?: SpacingTokenScale;\n right?: SpacingTokenScale;\n}" + } + }, + "ColorsTokenGroup": { + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ColorsTokenGroup", + "value": "typeof colors", + "description": "" + } + }, + "ColorsTokenName": { + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ColorsTokenName", + "value": "keyof ColorsTokenGroup", + "description": "" + } + }, + "BackgroundColorTokenScale": { "polaris-react/src/components/Box/Box.tsx": { "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "TypeAliasDeclaration", @@ -9953,15 +10085,6 @@ "value": "interface BorderRadius {\n bottomLeft: BorderRadiusTokenScale;\n bottomRight: BorderRadiusTokenScale;\n topLeft: BorderRadiusTokenScale;\n topRight: BorderRadiusTokenScale;\n}" } }, - "SpacingTokenScale": { - "polaris-react/src/components/Box/Box.tsx": { - "filePath": "polaris-react/src/components/Box/Box.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "SpacingTokenScale", - "value": "SpacingTokenName extends `space-${infer Scale}`\n ? Scale\n : never", - "description": "" - } - }, "BoxProps": { "polaris-react/src/components/Box/Box.tsx": { "filePath": "polaris-react/src/components/Box/Box.tsx", @@ -10785,6 +10908,56 @@ "description": "" } }, + "ButtonGroupProps": { + "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "name": "ButtonGroupProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "spacing", + "value": "Spacing", + "description": "Determines the space between button group items", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "segmented", + "value": "boolean", + "description": "Join buttons as segmented group", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "fullWidth", + "value": "boolean", + "description": "Buttons will stretch/shrink to occupy the full width", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "connectedTop", + "value": "boolean", + "description": "Remove top left and right border radius", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Button components", + "isOptional": true + } + ], + "value": "export interface ButtonGroupProps {\n /** Determines the space between button group items */\n spacing?: Spacing;\n /** Join buttons as segmented group */\n segmented?: boolean;\n /** Buttons will stretch/shrink to occupy the full width */\n fullWidth?: boolean;\n /** Remove top left and right border radius */\n connectedTop?: boolean;\n /** Button components */\n children?: React.ReactNode;\n}" + } + }, "CalloutCardProps": { "polaris-react/src/components/CalloutCard/CalloutCard.tsx": { "filePath": "polaris-react/src/components/CalloutCard/CalloutCard.tsx", @@ -10948,54 +11121,86 @@ "value": "export interface CardProps {\n /** Title content for the card */\n title?: React.ReactNode;\n /** Inner content of the card */\n children?: React.ReactNode;\n /** A less prominent card */\n subdued?: boolean;\n /** Auto wrap content in section */\n sectioned?: boolean;\n /** Card header actions */\n actions?: DisableableAction[];\n /** Primary action in the card footer */\n primaryFooterAction?: ComplexAction;\n /** Secondary actions in the card footer */\n secondaryFooterActions?: ComplexAction[];\n /** The content of the disclosure button rendered when there is more than one secondary footer action */\n secondaryFooterActionsDisclosureText?: string;\n /** Alignment of the footer actions on the card, defaults to right */\n footerActionAlignment?: 'right' | 'left';\n /** Allow the card to be hidden when printing */\n hideOnPrint?: boolean;\n}" } }, - "ButtonGroupProps": { - "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "name": "ButtonGroupProps", + "CheckableButtonProps": { + "polaris-react/src/components/CheckableButton/CheckableButton.tsx": { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "name": "CheckableButtonProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", "syntaxKind": "PropertySignature", - "name": "spacing", - "value": "Spacing", - "description": "Determines the space between button group items", + "name": "accessibilityLabel", + "value": "string", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", "syntaxKind": "PropertySignature", - "name": "segmented", + "name": "label", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "boolean | \"indeterminate\"", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "PropertySignature", + "name": "selectMode", "value": "boolean", - "description": "Join buttons as segmented group", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", "syntaxKind": "PropertySignature", - "name": "fullWidth", + "name": "smallScreen", "value": "boolean", - "description": "Buttons will stretch/shrink to occupy the full width", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", "syntaxKind": "PropertySignature", - "name": "connectedTop", + "name": "plain", "value": "boolean", - "description": "Remove top left and right border radius", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Button components", + "name": "measuring", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onToggleAll", + "value": "() => void", + "description": "", "isOptional": true } ], - "value": "export interface ButtonGroupProps {\n /** Determines the space between button group items */\n spacing?: Spacing;\n /** Join buttons as segmented group */\n segmented?: boolean;\n /** Buttons will stretch/shrink to occupy the full width */\n fullWidth?: boolean;\n /** Remove top left and right border radius */\n connectedTop?: boolean;\n /** Button components */\n children?: React.ReactNode;\n}" + "value": "export interface CheckableButtonProps {\n accessibilityLabel?: string;\n label?: string;\n selected?: boolean | 'indeterminate';\n selectMode?: boolean;\n smallScreen?: boolean;\n plain?: boolean;\n measuring?: boolean;\n disabled?: boolean;\n onToggleAll?(): void;\n}" } }, "CheckboxProps": { @@ -11421,126 +11626,44 @@ "value": "export interface ChoiceListProps {\n /** Label for list of choices */\n title: React.ReactNode;\n /** Collection of choices */\n choices: Choice[];\n /** Collection of selected choices */\n selected: string[];\n /** Name for form input */\n name?: string;\n /** Allow merchants to select multiple options at once */\n allowMultiple?: boolean;\n /** Toggles display of the title */\n titleHidden?: boolean;\n /** Display an error message */\n error?: Error;\n /** Disable all choices **/\n disabled?: boolean;\n /** Callback when the selected choices change */\n onChange?(selected: string[], name: string): void;\n}" } }, - "CheckableButtonProps": { - "polaris-react/src/components/CheckableButton/CheckableButton.tsx": { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "name": "CheckableButtonProps", + "Transition": { + "polaris-react/src/components/Collapsible/Collapsible.tsx": { + "filePath": "polaris-react/src/components/Collapsible/Collapsible.tsx", + "name": "Transition", "description": "", "members": [ { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "filePath": "polaris-react/src/components/Collapsible/Collapsible.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", + "name": "duration", "value": "string", - "description": "", + "description": "Assign a transition duration to the collapsible animation.", "isOptional": true }, { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "filePath": "polaris-react/src/components/Collapsible/Collapsible.tsx", "syntaxKind": "PropertySignature", - "name": "label", + "name": "timingFunction", "value": "string", - "description": "", + "description": "Assign a transition timing function to the collapsible animation", "isOptional": true - }, + } + ], + "value": "interface Transition {\n /** Assign a transition duration to the collapsible animation. */\n duration?: string;\n /** Assign a transition timing function to the collapsible animation */\n timingFunction?: string;\n}" + } + }, + "CollapsibleProps": { + "polaris-react/src/components/Collapsible/Collapsible.tsx": { + "filePath": "polaris-react/src/components/Collapsible/Collapsible.tsx", + "name": "CollapsibleProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", + "filePath": "polaris-react/src/components/Collapsible/Collapsible.tsx", "syntaxKind": "PropertySignature", - "name": "selected", - "value": "boolean | \"indeterminate\"", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "syntaxKind": "PropertySignature", - "name": "selectMode", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "syntaxKind": "PropertySignature", - "name": "smallScreen", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "syntaxKind": "PropertySignature", - "name": "plain", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "syntaxKind": "PropertySignature", - "name": "measuring", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/CheckableButton/CheckableButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onToggleAll", - "value": "() => void", - "description": "", - "isOptional": true - } - ], - "value": "export interface CheckableButtonProps {\n accessibilityLabel?: string;\n label?: string;\n selected?: boolean | 'indeterminate';\n selectMode?: boolean;\n smallScreen?: boolean;\n plain?: boolean;\n measuring?: boolean;\n disabled?: boolean;\n onToggleAll?(): void;\n}" - } - }, - "Transition": { - "polaris-react/src/components/Collapsible/Collapsible.tsx": { - "filePath": "polaris-react/src/components/Collapsible/Collapsible.tsx", - "name": "Transition", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Collapsible/Collapsible.tsx", - "syntaxKind": "PropertySignature", - "name": "duration", - "value": "string", - "description": "Assign a transition duration to the collapsible animation.", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Collapsible/Collapsible.tsx", - "syntaxKind": "PropertySignature", - "name": "timingFunction", - "value": "string", - "description": "Assign a transition timing function to the collapsible animation", - "isOptional": true - } - ], - "value": "interface Transition {\n /** Assign a transition duration to the collapsible animation. */\n duration?: string;\n /** Assign a transition timing function to the collapsible animation */\n timingFunction?: string;\n}" - } - }, - "CollapsibleProps": { - "polaris-react/src/components/Collapsible/Collapsible.tsx": { - "filePath": "polaris-react/src/components/Collapsible/Collapsible.tsx", - "name": "CollapsibleProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Collapsible/Collapsible.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "Assign a unique ID to the collapsible. For accessibility, pass this ID as the value of the triggering component’s aria-controls prop." + "name": "id", + "value": "string", + "description": "Assign a unique ID to the collapsible. For accessibility, pass this ID as the value of the triggering component’s aria-controls prop." }, { "filePath": "polaris-react/src/components/Collapsible/Collapsible.tsx", @@ -12179,103 +12302,6 @@ "value": "export interface DataTableProps {\n /** List of data types, which determines content alignment for each column. Data types are \"text,\" which aligns left, or \"numeric,\" which aligns right. */\n columnContentTypes: ColumnContentType[];\n /** List of column headings. */\n headings: React.ReactNode[];\n /** List of numeric column totals, highlighted in the table’s header below column headings. Use empty strings as placeholders for columns with no total. */\n totals?: TableData[];\n /** Custom totals row heading */\n totalsName?: {\n singular: React.ReactNode;\n plural: React.ReactNode;\n };\n /** Placement of totals row within table */\n showTotalsInFooter?: boolean;\n /** Lists of data points which map to table body rows. */\n rows: TableData[][];\n /** Hide column visibility and navigation buttons above the header when the table horizontally collapses to be scrollable.\n * @default false\n */\n hideScrollIndicator?: boolean;\n /** Truncate content in first column instead of wrapping.\n * @default true\n */\n truncate?: boolean;\n /** Vertical alignment of content in the cells.\n * @default 'top'\n */\n verticalAlign?: VerticalAlign;\n /** Content centered in the full width cell of the table footer row. */\n footerContent?: TableData;\n /** Table row has hover state. Defaults to true. */\n hoverable?: boolean;\n /** List of booleans, which maps to whether sorting is enabled or not for each column. Defaults to false for all columns. */\n sortable?: boolean[];\n /**\n * The direction to sort the table rows on first click or keypress of a sortable column heading. Defaults to ascending.\n * @default 'ascending'\n */\n defaultSortDirection?: SortDirection;\n /**\n * The index of the heading that the table rows are initially sorted by. Defaults to the first column.\n * @default 0\n */\n initialSortColumnIndex?: number;\n /** Callback fired on click or keypress of a sortable column heading. */\n onSort?(headingIndex: number, direction: SortDirection): void;\n /** Increased density */\n increasedTableDensity?: boolean;\n /** Add zebra striping to data rows */\n hasZebraStripingOnData?: boolean;\n /** Header becomes sticky and pins to top of table when scrolling */\n stickyHeader?: boolean;\n /** @deprecated Add a fixed first column on horizontal scroll. Use fixedFirstColumns={n} instead. */\n hasFixedFirstColumn?: boolean;\n /** Add fixed columns on horizontal scroll. */\n fixedFirstColumns?: number;\n /** Specify a min width for the first column if neccessary */\n firstColumnMinWidth?: string;\n}" } }, - "Item": { - "polaris-react/src/components/DescriptionList/DescriptionList.tsx": { - "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", - "name": "Item", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "term", - "value": "React.ReactNode", - "description": "Title of the item" - }, - { - "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "React.ReactNode", - "description": "Item content" - } - ], - "value": "interface Item {\n /** Title of the item */\n term: React.ReactNode;\n /** Item content */\n description: React.ReactNode;\n}" - }, - "polaris-react/src/components/ExceptionList/ExceptionList.tsx": { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", - "name": "Item", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "status", - "value": "\"critical\" | \"warning\"", - "description": "Set the color of the icon and title for the given item.", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "Icon displayed by the list item", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "Text displayed beside the icon", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "any", - "description": "Text displayed for the item", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "truncate", - "value": "boolean", - "description": "Should the description be truncated at end of line", - "isOptional": true - } - ], - "value": "interface Item {\n /** Set the color of the icon and title for the given item. */\n status?: 'critical' | 'warning';\n /** Icon displayed by the list item */\n icon?: IconProps['source'];\n /** Text displayed beside the icon */\n title?: string;\n /** Text displayed for the item */\n description?: Description;\n /** Should the description be truncated at end of line */\n truncate?: boolean;\n}" - } - }, - "DescriptionListProps": { - "polaris-react/src/components/DescriptionList/DescriptionList.tsx": { - "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", - "name": "DescriptionListProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "items", - "value": "Item[]", - "description": "Collection of items for list" - }, - { - "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "spacing", - "value": "\"tight\" | \"loose\"", - "description": "Determines the spacing between list items", - "isOptional": true - } - ], - "value": "export interface DescriptionListProps {\n /** Collection of items for list */\n items: Item[];\n /** Determines the spacing between list items */\n spacing?: 'tight' | 'loose';\n}" - } - }, "DatePickerProps": { "polaris-react/src/components/DatePicker/DatePicker.tsx": { "filePath": "polaris-react/src/components/DatePicker/DatePicker.tsx", @@ -12389,72 +12415,169 @@ "value": "export interface DatePickerProps {\n /** ID for the element */\n id?: string;\n /** The selected date or range of dates */\n selected?: Date | Range;\n /** The month to show, from 0 to 11. 0 is January, 1 is February ... 11 is December */\n month: number;\n /** The year to show */\n year: number;\n /** Allow a range of dates to be selected */\n allowRange?: boolean;\n /** Disable selecting dates before this. */\n disableDatesBefore?: Date;\n /** Disable selecting dates after this. */\n disableDatesAfter?: Date;\n /** Disable specific dates. */\n disableSpecificDates?: Date[];\n /** The selection can span multiple months */\n multiMonth?: boolean;\n /**\n * First day of week, from 0 to 6. 0 is Sunday, 1 is Monday ... 6 is Saturday\n * @default 0\n */\n weekStartsOn?: number;\n /** Visually hidden prefix text for selected days on single selection date pickers */\n dayAccessibilityLabelPrefix?: string;\n /** Callback when date is selected. */\n onChange?(date: Range): void;\n /** Callback when month is changed. */\n onMonthChange?(month: number, year: number): void;\n}" } }, - "DisplayTextProps": { - "polaris-react/src/components/DisplayText/DisplayText.tsx": { - "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", - "name": "DisplayTextProps", + "Item": { + "polaris-react/src/components/DescriptionList/DescriptionList.tsx": { + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", + "name": "Item", "description": "", "members": [ { - "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", - "syntaxKind": "PropertySignature", - "name": "element", - "value": "HeadingTagName", - "description": "Name of element to use for text", - "isOptional": true, - "defaultValue": "'p'" - }, - { - "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", "syntaxKind": "PropertySignature", - "name": "size", - "value": "Size", - "description": "Size of the text", - "isOptional": true, - "defaultValue": "'medium'" + "name": "term", + "value": "React.ReactNode", + "description": "Title of the item" }, { - "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", "syntaxKind": "PropertySignature", - "name": "children", + "name": "description", "value": "React.ReactNode", - "description": "Content to display", - "isOptional": true + "description": "Item content" } ], - "value": "export interface DisplayTextProps {\n /**\n * Name of element to use for text\n * @default 'p'\n */\n element?: HeadingTagName;\n /**\n * Size of the text\n * @default 'medium'\n */\n size?: Size;\n /** Content to display */\n children?: React.ReactNode;\n}" - } - }, - "DropZoneFileType": { - "polaris-react/src/components/DropZone/DropZone.tsx": { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "DropZoneFileType", - "value": "'file' | 'image' | 'video'", - "description": "" - } - }, - "DropZoneProps": { - "polaris-react/src/components/DropZone/DropZone.tsx": { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", - "name": "DropZoneProps", + "value": "interface Item {\n /** Title of the item */\n term: React.ReactNode;\n /** Item content */\n description: React.ReactNode;\n}" + }, + "polaris-react/src/components/ExceptionList/ExceptionList.tsx": { + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", + "name": "Item", "description": "", "members": [ { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", "syntaxKind": "PropertySignature", - "name": "label", - "value": "React.ReactNode", - "description": "Label for the file input", + "name": "status", + "value": "\"critical\" | \"warning\"", + "description": "Set the color of the icon and title for the given item.", "isOptional": true }, { - "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", "syntaxKind": "PropertySignature", - "name": "labelAction", - "value": "Action", - "description": "Adds an action to the label", - "isOptional": true + "name": "icon", + "value": "any", + "description": "Icon displayed by the list item", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "Text displayed beside the icon", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "any", + "description": "Text displayed for the item", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "truncate", + "value": "boolean", + "description": "Should the description be truncated at end of line", + "isOptional": true + } + ], + "value": "interface Item {\n /** Set the color of the icon and title for the given item. */\n status?: 'critical' | 'warning';\n /** Icon displayed by the list item */\n icon?: IconProps['source'];\n /** Text displayed beside the icon */\n title?: string;\n /** Text displayed for the item */\n description?: Description;\n /** Should the description be truncated at end of line */\n truncate?: boolean;\n}" + } + }, + "DescriptionListProps": { + "polaris-react/src/components/DescriptionList/DescriptionList.tsx": { + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", + "name": "DescriptionListProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "items", + "value": "Item[]", + "description": "Collection of items for list" + }, + { + "filePath": "polaris-react/src/components/DescriptionList/DescriptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "spacing", + "value": "\"tight\" | \"loose\"", + "description": "Determines the spacing between list items", + "isOptional": true + } + ], + "value": "export interface DescriptionListProps {\n /** Collection of items for list */\n items: Item[];\n /** Determines the spacing between list items */\n spacing?: 'tight' | 'loose';\n}" + } + }, + "DisplayTextProps": { + "polaris-react/src/components/DisplayText/DisplayText.tsx": { + "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", + "name": "DisplayTextProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", + "syntaxKind": "PropertySignature", + "name": "element", + "value": "HeadingTagName", + "description": "Name of element to use for text", + "isOptional": true, + "defaultValue": "'p'" + }, + { + "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "Size", + "description": "Size of the text", + "isOptional": true, + "defaultValue": "'medium'" + }, + { + "filePath": "polaris-react/src/components/DisplayText/DisplayText.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Content to display", + "isOptional": true + } + ], + "value": "export interface DisplayTextProps {\n /**\n * Name of element to use for text\n * @default 'p'\n */\n element?: HeadingTagName;\n /**\n * Size of the text\n * @default 'medium'\n */\n size?: Size;\n /** Content to display */\n children?: React.ReactNode;\n}" + } + }, + "DropZoneFileType": { + "polaris-react/src/components/DropZone/DropZone.tsx": { + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "DropZoneFileType", + "value": "'file' | 'image' | 'video'", + "description": "" + } + }, + "DropZoneProps": { + "polaris-react/src/components/DropZone/DropZone.tsx": { + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "name": "DropZoneProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "React.ReactNode", + "description": "Label for the file input", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", + "syntaxKind": "PropertySignature", + "name": "labelAction", + "value": "Action", + "description": "Adds an action to the label", + "isOptional": true }, { "filePath": "polaris-react/src/components/DropZone/DropZone.tsx", @@ -17723,6 +17846,33 @@ "description": "" } }, + "SubheadingProps": { + "polaris-react/src/components/Subheading/Subheading.tsx": { + "filePath": "polaris-react/src/components/Subheading/Subheading.tsx", + "name": "SubheadingProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Subheading/Subheading.tsx", + "syntaxKind": "PropertySignature", + "name": "element", + "value": "HeadingTagName", + "description": "The element name to use for the subheading", + "isOptional": true, + "defaultValue": "'h3'" + }, + { + "filePath": "polaris-react/src/components/Subheading/Subheading.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Text to display in subheading", + "isOptional": true + } + ], + "value": "export interface SubheadingProps {\n /**\n * The element name to use for the subheading\n * @default 'h3'\n */\n element?: HeadingTagName;\n /** Text to display in subheading */\n children?: React.ReactNode;\n}" + } + }, "TabsProps": { "polaris-react/src/components/Tabs/Tabs.tsx": { "filePath": "polaris-react/src/components/Tabs/Tabs.tsx", @@ -17779,33 +17929,6 @@ "value": "export interface TabsProps {\n /** Content to display in tabs */\n children?: React.ReactNode;\n /** Index of selected tab */\n selected: number;\n /** List of tabs */\n tabs: TabDescriptor[];\n /** Fit tabs to container */\n fitted?: boolean;\n /** Text to replace disclosures horizontal dots */\n disclosureText?: string;\n /** Callback when tab is selected */\n onSelect?(selectedTabIndex: number): void;\n}" } }, - "SubheadingProps": { - "polaris-react/src/components/Subheading/Subheading.tsx": { - "filePath": "polaris-react/src/components/Subheading/Subheading.tsx", - "name": "SubheadingProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Subheading/Subheading.tsx", - "syntaxKind": "PropertySignature", - "name": "element", - "value": "HeadingTagName", - "description": "The element name to use for the subheading", - "isOptional": true, - "defaultValue": "'h3'" - }, - { - "filePath": "polaris-react/src/components/Subheading/Subheading.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Text to display in subheading", - "isOptional": true - } - ], - "value": "export interface SubheadingProps {\n /**\n * The element name to use for the subheading\n * @default 'h3'\n */\n element?: HeadingTagName;\n /** Text to display in subheading */\n children?: React.ReactNode;\n}" - } - }, "TagProps": { "polaris-react/src/components/Tag/Tag.tsx": { "filePath": "polaris-react/src/components/Tag/Tag.tsx", @@ -22191,253 +22314,60 @@ "value": "interface ItemProps {\n children?: React.ReactNode;\n}" } }, - "MenuGroupProps": { - "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "name": "MenuGroupProps", + "SectionProps": { + "polaris-react/src/components/ActionList/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "name": "SectionProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Visually hidden menu description for screen readers", - "isOptional": true + "name": "section", + "value": "ActionListSection", + "description": "Section of action items" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "active", + "name": "hasMultipleSections", "value": "boolean", - "description": "Whether or not the menu is open", - "isOptional": true + "description": "Should there be multiple sections" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "(openActions: () => void) => void", - "description": "Callback when the menu is clicked", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "actionRole", + "value": "string", + "description": "Defines a specific role attribute for each action in the list", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "onOpen", - "value": "(title: string) => void", - "description": "Callback for opening the MenuGroup by title" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "onClose", - "value": "(title: string) => void", - "description": "Callback for closing the MenuGroup by title" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "getOffsetWidth", - "value": "(width: number) => void", - "description": "Callback for getting the offsetWidth of the MenuGroup", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any item is clicked or keypressed", "isOptional": true - }, + } + ], + "value": "export interface SectionProps {\n /** Section of action items */\n section: ActionListSection;\n /** Should there be multiple sections */\n hasMultipleSections: boolean;\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'option' | 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" + }, + "polaris-react/src/components/Layout/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "sections", - "value": "readonly ActionListSection[]", - "description": "Collection of sectioned action items", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "Menu group title" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "actions", - "value": "ActionListItemDescriptor[]", - "description": "List of actions" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "Icon to display", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "details", - "value": "React.ReactNode", - "description": "Action details", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables action button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "index", - "value": "number", - "description": "Zero-indexed numerical position. Overrides the group's order in the menu.", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any action takes place", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "badge", - "value": "{ status: \"new\"; content: string; }", - "description": "", - "isOptional": true - } - ], - "value": "export interface MenuGroupProps extends MenuGroupDescriptor {\n /** Visually hidden menu description for screen readers */\n accessibilityLabel?: string;\n /** Whether or not the menu is open */\n active?: boolean;\n /** Callback when the menu is clicked */\n onClick?(openActions: () => void): void;\n /** Callback for opening the MenuGroup by title */\n onOpen(title: string): void;\n /** Callback for closing the MenuGroup by title */\n onClose(title: string): void;\n /** Callback for getting the offsetWidth of the MenuGroup */\n getOffsetWidth?(width: number): void;\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n}" - } - }, - "MeasuredActions": { - "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "name": "MeasuredActions", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "syntaxKind": "PropertySignature", - "name": "showable", - "value": "MenuActionDescriptor[]", - "description": "" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "syntaxKind": "PropertySignature", - "name": "rolledUp", - "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", - "description": "" - } - ], - "value": "interface MeasuredActions {\n showable: MenuActionDescriptor[];\n rolledUp: (MenuActionDescriptor | MenuGroupDescriptor)[];\n}" - } - }, - "RollupActionsProps": { - "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "name": "RollupActionsProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Accessibilty label", - "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": "" - } - }, - "SectionProps": { - "polaris-react/src/components/ActionList/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "section", - "value": "ActionListSection", - "description": "Section of action items" - }, - { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "hasMultipleSections", - "value": "boolean", - "description": "Should there be multiple sections" - }, - { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "actionRole", - "value": "string", - "description": "Defines a specific role attribute for each action in the list", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any item is clicked or keypressed", - "isOptional": true - } - ], - "value": "export interface SectionProps {\n /** Section of action items */\n section: ActionListSection;\n /** Should there be multiple sections */\n hasMultipleSections: boolean;\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'option' | 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" - }, - "polaris-react/src/components/Layout/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", "name": "secondary", "value": "boolean", @@ -22622,38 +22552,188 @@ "value": "export interface SectionProps {\n children?: React.ReactNode;\n}" } }, - "PipProps": { - "polaris-react/src/components/Badge/components/Pip/Pip.tsx": { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", - "name": "PipProps", + "MeasuredActions": { + "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "name": "MeasuredActions", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", "syntaxKind": "PropertySignature", - "name": "status", - "value": "Status", - "description": "", + "name": "showable", + "value": "MenuActionDescriptor[]", + "description": "" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "syntaxKind": "PropertySignature", + "name": "rolledUp", + "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", + "description": "" + } + ], + "value": "interface MeasuredActions {\n showable: MenuActionDescriptor[];\n rolledUp: (MenuActionDescriptor | MenuGroupDescriptor)[];\n}" + } + }, + "MenuGroupProps": { + "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "name": "MenuGroupProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden menu description for screen readers", "isOptional": true }, { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "progress", - "value": "Progress", - "description": "", + "name": "active", + "value": "boolean", + "description": "Whether or not the menu is open", "isOptional": true }, { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "(openActions: () => void) => void", + "description": "Callback when the menu is clicked", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "onOpen", + "value": "(title: string) => void", + "description": "Callback for opening the MenuGroup by title" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "onClose", + "value": "(title: string) => void", + "description": "Callback for closing the MenuGroup by title" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "getOffsetWidth", + "value": "(width: number) => void", + "description": "Callback for getting the offsetWidth of the MenuGroup", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabelOverride", + "name": "sections", + "value": "readonly ActionListSection[]", + "description": "Collection of sectioned action items", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "title", "value": "string", + "description": "Menu group title" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "actions", + "value": "ActionListItemDescriptor[]", + "description": "List of actions" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "any", + "description": "Icon to display", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "details", + "value": "React.ReactNode", + "description": "Action details", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Disables action button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "index", + "value": "number", + "description": "Zero-indexed numerical position. Overrides the group's order in the menu.", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any action takes place", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "badge", + "value": "{ status: \"new\"; content: string; }", "description": "", "isOptional": true } ], - "value": "export interface PipProps {\n status?: Status;\n progress?: Progress;\n accessibilityLabelOverride?: string;\n}" + "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": { @@ -22999,37 +23079,80 @@ "description": "" }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "any", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "tooltip", + "value": "TooltipProps", + "description": "", + "isOptional": true + } + ], + "value": "interface SecondaryAction {\n url: string;\n accessibilityLabel: string;\n icon: IconProps['source'];\n onClick?(): void;\n tooltip?: TooltipProps;\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", + "name": "PipProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "" + "name": "status", + "value": "Status", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", + "name": "progress", + "value": "Progress", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", "syntaxKind": "PropertySignature", - "name": "tooltip", - "value": "TooltipProps", + "name": "accessibilityLabelOverride", + "value": "string", "description": "", "isOptional": true } ], - "value": "interface SecondaryAction {\n url: string;\n accessibilityLabel: string;\n icon: IconProps['source'];\n onClick?(): void;\n tooltip?: TooltipProps;\n}" + "value": "export interface PipProps {\n status?: Status;\n progress?: Progress;\n accessibilityLabelOverride?: string;\n}" } }, "MappedAction": { @@ -23301,40 +23424,6 @@ "value": "export interface BulkActionsMenuProps extends MenuGroupDescriptor {\n isNewBadgeInBadgeActions: boolean;\n}" } }, - "CardHeaderProps": { - "polaris-react/src/components/Card/components/Header/Header.tsx": { - "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", - "name": "CardHeaderProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", - "syntaxKind": "PropertySignature", - "name": "actions", - "value": "DisableableAction[]", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "export interface CardHeaderProps {\n title?: React.ReactNode;\n actions?: DisableableAction[];\n children?: React.ReactNode;\n}" - } - }, "CardSectionProps": { "polaris-react/src/components/Card/components/Section/Section.tsx": { "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", @@ -23401,14 +23490,30 @@ "value": "export interface CardSectionProps {\n title?: React.ReactNode;\n children?: React.ReactNode;\n subdued?: boolean;\n flush?: boolean;\n fullWidth?: boolean;\n /** Allow the card to be hidden when printing */\n hideOnPrint?: boolean;\n actions?: ComplexAction[];\n}" } }, - "CardSubsectionProps": { - "polaris-react/src/components/Card/components/Subsection/Subsection.tsx": { - "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", - "name": "CardSubsectionProps", + "CardHeaderProps": { + "polaris-react/src/components/Card/components/Header/Header.tsx": { + "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", + "name": "CardHeaderProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", + "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", + "syntaxKind": "PropertySignature", + "name": "actions", + "value": "DisableableAction[]", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", @@ -23416,31 +23521,25 @@ "isOptional": true } ], - "value": "export interface CardSubsectionProps {\n children?: React.ReactNode;\n}" + "value": "export interface CardHeaderProps {\n title?: React.ReactNode;\n actions?: DisableableAction[];\n children?: React.ReactNode;\n}" } }, - "HuePickerProps": { - "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx": { - "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", - "name": "HuePickerProps", + "CardSubsectionProps": { + "polaris-react/src/components/Card/components/Subsection/Subsection.tsx": { + "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", + "name": "CardSubsectionProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", + "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", "syntaxKind": "PropertySignature", - "name": "hue", - "value": "number", - "description": "" - }, - { - "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", - "syntaxKind": "MethodSignature", - "name": "onChange", - "value": "(hue: number) => void", - "description": "" + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true } ], - "value": "export interface HuePickerProps {\n hue: number;\n onChange(hue: number): void;\n}" + "value": "export interface CardSubsectionProps {\n children?: React.ReactNode;\n}" } }, "AlphaPickerProps": { @@ -23474,13 +23573,28 @@ "value": "export interface AlphaPickerProps {\n color: HSBColor;\n alpha: number;\n onChange(hue: number): void;\n}" } }, - "ItemPosition": { - "polaris-react/src/components/Connected/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "ItemPosition", - "value": "'left' | 'right' | 'primary'", - "description": "" + "HuePickerProps": { + "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx": { + "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", + "name": "HuePickerProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", + "syntaxKind": "PropertySignature", + "name": "hue", + "value": "number", + "description": "" + }, + { + "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", + "syntaxKind": "MethodSignature", + "name": "onChange", + "value": "(hue: number) => void", + "description": "" + } + ], + "value": "export interface HuePickerProps {\n hue: number;\n onChange(hue: number): void;\n}" } }, "Position": { @@ -23548,6 +23662,15 @@ "value": "export interface SlidableProps {\n draggerX?: number;\n draggerY?: number;\n onChange(position: Position): void;\n onDraggerHeight?(height: number): void;\n}" } }, + "ItemPosition": { + "polaris-react/src/components/Connected/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ItemPosition", + "value": "'left' | 'right' | 'primary'", + "description": "" + } + }, "CellProps": { "polaris-react/src/components/DataTable/components/Cell/Cell.tsx": { "filePath": "polaris-react/src/components/DataTable/components/Cell/Cell.tsx", @@ -24430,6 +24553,23 @@ "value": "export interface CSSAnimationProps {\n in: boolean;\n className: string;\n type: AnimationType;\n children?: React.ReactNode;\n}" } }, + "ToastManagerProps": { + "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx": { + "filePath": "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx", + "name": "ToastManagerProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx", + "syntaxKind": "PropertySignature", + "name": "toastMessages", + "value": "ToastPropsWithID[]", + "description": "" + } + ], + "value": "export interface ToastManagerProps {\n toastMessages: ToastPropsWithID[];\n}" + } + }, "Cell": { "polaris-react/src/components/Grid/components/Cell/Cell.tsx": { "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", @@ -24544,23 +24684,6 @@ "value": "export interface RowProps {\n children: React.ReactNode;\n id: string;\n selected?: boolean;\n position: number;\n subdued?: boolean;\n status?: RowStatus;\n disabled?: boolean;\n onNavigation?(id: string): void;\n onClick?(): void;\n}" } }, - "ToastManagerProps": { - "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx": { - "filePath": "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx", - "name": "ToastManagerProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx", - "syntaxKind": "PropertySignature", - "name": "toastMessages", - "value": "ToastPropsWithID[]", - "description": "" - } - ], - "value": "export interface ToastManagerProps {\n toastMessages: ToastPropsWithID[];\n}" - } - }, "ScrollContainerProps": { "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx": { "filePath": "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx", @@ -25761,56 +25884,56 @@ "value": "export interface PolarisContainerProps {}" } }, - "SingleThumbProps": { - "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx": { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", - "name": "SingleThumbProps", + "DualThumbProps": { + "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx": { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "name": "DualThumbProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "value", - "value": "number", + "value": "DualValue", "description": "Initial value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "id", "value": "string", "description": "ID for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "min", "value": "number", "description": "Minimum possible value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "max", "value": "number", "description": "Maximum possible value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "step", "value": "number", "description": "Increment value for range input changes" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "label", "value": "ReactNode", "description": "Label for the range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "labelAction", "value": "Action", @@ -25818,7 +25941,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "labelHidden", "value": "boolean", @@ -25826,7 +25949,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "output", "value": "boolean", @@ -25834,7 +25957,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "helpText", "value": "ReactNode", @@ -25842,7 +25965,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "error", "value": "any", @@ -25850,7 +25973,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", @@ -25858,7 +25981,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "prefix", "value": "ReactNode", @@ -25866,7 +25989,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "suffix", "value": "ReactNode", @@ -25874,14 +25997,14 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "MethodSignature", "name": "onChange", "value": "(value: RangeSliderValue, id: string) => void", "description": "Callback when the range input is changed" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "MethodSignature", "name": "onFocus", "value": "() => void", @@ -25889,67 +26012,102 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", - "syntaxKind": "MethodSignature", - "name": "onBlur", - "value": "() => void", - "description": "Callback when focus is removed", - "isOptional": true + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "syntaxKind": "MethodSignature", + "name": "onBlur", + "value": "() => void", + "description": "Callback when focus is removed", + "isOptional": true + } + ], + "value": "export interface DualThumbProps extends RangeSliderProps {\n value: DualValue;\n id: string;\n min: number;\n max: number;\n step: number;\n}" + } + }, + "KeyHandlers": { + "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx": { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "name": "KeyHandlers", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "name": "[key: string]", + "value": "() => void" } ], - "value": "export interface SingleThumbProps extends RangeSliderProps {\n value: number;\n id: string;\n min: number;\n max: number;\n step: number;\n}" + "value": "interface KeyHandlers {\n [key: string]: () => void;\n}" } }, - "DualThumbProps": { + "Control": { "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx": { "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "name": "DualThumbProps", - "description": "", + "syntaxKind": "EnumDeclaration", + "name": "Control", + "value": "enum Control {\n Lower,\n Upper,\n}", "members": [ { "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "name": "Lower", + "value": 0 + }, + { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "name": "Upper", + "value": 1 + } + ] + } + }, + "SingleThumbProps": { + "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx": { + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "name": "SingleThumbProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "value", - "value": "DualValue", + "value": "number", "description": "Initial value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "id", "value": "string", "description": "ID for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "min", "value": "number", "description": "Minimum possible value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "max", "value": "number", "description": "Maximum possible value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "step", "value": "number", "description": "Increment value for range input changes" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "label", "value": "ReactNode", "description": "Label for the range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "labelAction", "value": "Action", @@ -25957,7 +26115,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "labelHidden", "value": "boolean", @@ -25965,7 +26123,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "output", "value": "boolean", @@ -25973,7 +26131,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "helpText", "value": "ReactNode", @@ -25981,7 +26139,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "error", "value": "any", @@ -25989,7 +26147,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", @@ -25997,7 +26155,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "prefix", "value": "ReactNode", @@ -26005,7 +26163,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "suffix", "value": "ReactNode", @@ -26013,14 +26171,14 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "MethodSignature", "name": "onChange", "value": "(value: RangeSliderValue, id: string) => void", "description": "Callback when the range input is changed" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "MethodSignature", "name": "onFocus", "value": "() => void", @@ -26028,7 +26186,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "MethodSignature", "name": "onBlur", "value": "() => void", @@ -26036,42 +26194,7 @@ "isOptional": true } ], - "value": "export interface DualThumbProps extends RangeSliderProps {\n value: DualValue;\n id: string;\n min: number;\n max: number;\n step: number;\n}" - } - }, - "KeyHandlers": { - "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx": { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "name": "KeyHandlers", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "name": "[key: string]", - "value": "() => void" - } - ], - "value": "interface KeyHandlers {\n [key: string]: () => void;\n}" - } - }, - "Control": { - "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx": { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "syntaxKind": "EnumDeclaration", - "name": "Control", - "value": "enum Control {\n Lower,\n Upper,\n}", - "members": [ - { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "name": "Lower", - "value": 0 - }, - { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "name": "Upper", - "value": 1 - } - ] + "value": "export interface SingleThumbProps extends RangeSliderProps {\n value: number;\n id: string;\n min: number;\n max: number;\n step: number;\n}" } }, "PanelProps": { @@ -26286,6 +26409,47 @@ "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", + "name": "ResizerProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", + "syntaxKind": "PropertySignature", + "name": "contents", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", + "syntaxKind": "PropertySignature", + "name": "currentHeight", + "value": "number", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", + "syntaxKind": "PropertySignature", + "name": "minimumLines", + "value": "number", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", + "syntaxKind": "MethodSignature", + "name": "onHeightChange", + "value": "(height: number) => void", + "description": "" + } + ], + "value": "export interface ResizerProps {\n contents?: string;\n currentHeight?: number | null;\n minimumLines?: number;\n onHeightChange(height: number): void;\n}" + } + }, "HandleStepFn": { "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx": { "filePath": "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx", @@ -26365,47 +26529,6 @@ "value": "export interface TooltipOverlayProps {\n id: string;\n active: boolean;\n preventInteraction?: PositionedOverlayProps['preventInteraction'];\n preferredPosition?: PositionedOverlayProps['preferredPosition'];\n children?: React.ReactNode;\n activator: HTMLElement;\n accessibilityLabel?: string;\n onClose(): void;\n}" } }, - "ResizerProps": { - "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx": { - "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", - "name": "ResizerProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", - "syntaxKind": "PropertySignature", - "name": "contents", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", - "syntaxKind": "PropertySignature", - "name": "currentHeight", - "value": "number", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", - "syntaxKind": "PropertySignature", - "name": "minimumLines", - "value": "number", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", - "syntaxKind": "MethodSignature", - "name": "onHeightChange", - "value": "(height: number) => void", - "description": "" - } - ], - "value": "export interface ResizerProps {\n contents?: string;\n currentHeight?: number | null;\n minimumLines?: number;\n onHeightChange(height: number): void;\n}" - } - }, "MenuProps": { "polaris-react/src/components/TopBar/components/Menu/Menu.tsx": { "filePath": "polaris-react/src/components/TopBar/components/Menu/Menu.tsx", @@ -26666,6 +26789,39 @@ "value": "export interface UserMenuProps {\n /** An array of action objects that are rendered inside of a popover triggered by this menu */\n actions: {items: IconableAction[]}[];\n /** Accepts a message that facilitates direct, urgent communication with the merchant through the user menu */\n message?: MenuProps['message'];\n /** A string detailing the merchant’s full name to be displayed in the user menu */\n name: string;\n /** A string allowing further detail on the merchant’s name displayed in the user menu */\n detail?: string;\n /** A string that provides the accessibility labeling */\n accessibilityLabel?: string;\n /** The merchant’s initials, rendered in place of an avatar image when not provided */\n initials: AvatarProps['initials'];\n /** An avatar image representing the merchant */\n avatar?: AvatarProps['source'];\n /** A boolean property indicating whether the user menu is currently open */\n open: boolean;\n /** A callback function to handle opening and closing the user menu */\n onToggle(): void;\n}" } }, + "SecondaryProps": { + "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "name": "SecondaryProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "syntaxKind": "PropertySignature", + "name": "expanded", + "value": "boolean", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "interface SecondaryProps {\n expanded: boolean;\n children?: React.ReactNode;\n id?: string;\n}" + } + }, "DiscardConfirmationModalProps": { "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx": { "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", @@ -26739,39 +26895,6 @@ "value": "export interface TitleProps {\n /** Page title, in large type */\n title?: string;\n /** Page subtitle, in regular type*/\n subtitle?: string;\n /** Important and non-interactive status information shown immediately after the title. */\n titleMetadata?: React.ReactNode;\n /** Removes spacing between title and subtitle */\n compactTitle?: boolean;\n}" } }, - "SecondaryProps": { - "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", - "name": "SecondaryProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", - "syntaxKind": "PropertySignature", - "name": "expanded", - "value": "boolean", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "", - "isOptional": true - } - ], - "value": "interface SecondaryProps {\n expanded: boolean;\n children?: React.ReactNode;\n id?: string;\n}" - } - }, "MessageProps": { "polaris-react/src/components/TopBar/components/Menu/components/Message/Message.tsx": { "filePath": "polaris-react/src/components/TopBar/components/Menu/components/Message/Message.tsx", From e6c16f1d55c03e0a9d7b826b5fd666e61495b3e3 Mon Sep 17 00:00:00 2001 From: Chaz Dean <59836805+chazdean@users.noreply.github.com> Date: Mon, 26 Sep 2022 15:24:00 -0400 Subject: [PATCH 13/25] [Layout foundations] Add alpha `ContentBlock` component (#7255) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### WHY are these changes introduced? Fixes #6899 Fixes #7257 ### WHAT is this pull request doing? Adds a new alpha `ContentBlock` component ![Screen Shot 2022-09-23 at 3 25 51 PM](https://user-images.githubusercontent.com/59836805/192042716-feea6443-52b5-412d-84c8-a3bfef41a76f.png)
ContentBlock alpha page AlphaStack alpha page
### How to 🎩 🖥 [Local development instructions](https://github.com/Shopify/polaris/blob/main/README.md#local-development) 🗒 [General tophatting guidelines](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md) 📄 [Changelog guidelines](https://github.com/Shopify/polaris/blob/main/.github/CONTRIBUTING.md#changelog)
Copy-paste this code in playground/Playground.tsx: ```jsx import React from 'react'; import {Page, ContentBlock, Text, Box} from '../src'; export function Playground() { return ( medium
large
); } ```
### 🎩 checklist - [ ] Tested on [mobile](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md#cross-browser-testing) - [ ] Tested on [multiple browsers](https://help.shopify.com/en/manual/shopify-admin/supported-browsers) - [ ] Tested for [accessibility](https://github.com/Shopify/polaris/blob/main/documentation/Accessibility%20testing.md) - [ ] Updated the component's `README.md` with documentation changes - [ ] [Tophatted documentation](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting%20documentation.md) changes in the style guide Co-authored-by: Lo Kim --- .changeset/tall-socks-cover.md | 5 + .changeset/witty-months-compare.md | 5 + .../components/ContentBlock/ContentBlock.scss | 11 + .../ContentBlock/ContentBlock.stories.tsx | 31 + .../components/ContentBlock/ContentBlock.tsx | 20 + .../src/components/ContentBlock/index.ts | 1 + .../ContentBlock/tests/ContentBlock.test.tsx | 27 + polaris-react/src/index.ts | 3 + .../content/components/content-block/index.md | 15 + .../pages/examples/content-block-width.tsx | 28 + .../images/components/content-block.png | Bin 0 -> 25923 bytes polaris.shopify.com/src/data/props.json | 2228 +++++++++-------- 12 files changed, 1277 insertions(+), 1097 deletions(-) create mode 100644 .changeset/tall-socks-cover.md create mode 100644 .changeset/witty-months-compare.md create mode 100644 polaris-react/src/components/ContentBlock/ContentBlock.scss create mode 100644 polaris-react/src/components/ContentBlock/ContentBlock.stories.tsx create mode 100644 polaris-react/src/components/ContentBlock/ContentBlock.tsx create mode 100644 polaris-react/src/components/ContentBlock/index.ts create mode 100644 polaris-react/src/components/ContentBlock/tests/ContentBlock.test.tsx create mode 100644 polaris.shopify.com/content/components/content-block/index.md create mode 100644 polaris.shopify.com/pages/examples/content-block-width.tsx create mode 100644 polaris.shopify.com/public/images/components/content-block.png diff --git a/.changeset/tall-socks-cover.md b/.changeset/tall-socks-cover.md new file mode 100644 index 00000000000..b61375e795c --- /dev/null +++ b/.changeset/tall-socks-cover.md @@ -0,0 +1,5 @@ +--- +'@shopify/polaris': minor +--- + +Added alpha `ContentBlock` component diff --git a/.changeset/witty-months-compare.md b/.changeset/witty-months-compare.md new file mode 100644 index 00000000000..759e4d2bfd5 --- /dev/null +++ b/.changeset/witty-months-compare.md @@ -0,0 +1,5 @@ +--- +'polaris.shopify.com': minor +--- + +Added alpha page for `ContentBlock` diff --git a/polaris-react/src/components/ContentBlock/ContentBlock.scss b/polaris-react/src/components/ContentBlock/ContentBlock.scss new file mode 100644 index 00000000000..663f1eacfd4 --- /dev/null +++ b/polaris-react/src/components/ContentBlock/ContentBlock.scss @@ -0,0 +1,11 @@ +.ContentBlock { + margin: 0 auto; +} + +.md { + max-width: 41.375rem; +} + +.lg { + max-width: 62.375rem; +} diff --git a/polaris-react/src/components/ContentBlock/ContentBlock.stories.tsx b/polaris-react/src/components/ContentBlock/ContentBlock.stories.tsx new file mode 100644 index 00000000000..e0206bb4113 --- /dev/null +++ b/polaris-react/src/components/ContentBlock/ContentBlock.stories.tsx @@ -0,0 +1,31 @@ +import React from 'react'; +import type {ComponentMeta} from '@storybook/react'; +import {ContentBlock, Box, Text} from '@shopify/polaris'; + +export default { + component: ContentBlock, +} as ComponentMeta; + +export function Medium() { + return ( + + + + medium + + + + ); +} + +export function Large() { + return ( + + + + large + + + + ); +} diff --git a/polaris-react/src/components/ContentBlock/ContentBlock.tsx b/polaris-react/src/components/ContentBlock/ContentBlock.tsx new file mode 100644 index 00000000000..ce7eca5e49d --- /dev/null +++ b/polaris-react/src/components/ContentBlock/ContentBlock.tsx @@ -0,0 +1,20 @@ +import React from 'react'; + +import {classNames} from '../../utilities/css'; + +import styles from './ContentBlock.scss'; + +type Width = 'md' | 'lg'; + +export interface ContentBlockProps { + /** Elements to display inside container */ + children?: React.ReactNode; + /** Adjust maximum width of container */ + width: Width; +} + +export const ContentBlock = ({children, width}: ContentBlockProps) => { + const className = classNames(styles.ContentBlock, styles[width]); + + return
{children}
; +}; diff --git a/polaris-react/src/components/ContentBlock/index.ts b/polaris-react/src/components/ContentBlock/index.ts new file mode 100644 index 00000000000..f21b046db03 --- /dev/null +++ b/polaris-react/src/components/ContentBlock/index.ts @@ -0,0 +1 @@ +export * from './ContentBlock'; diff --git a/polaris-react/src/components/ContentBlock/tests/ContentBlock.test.tsx b/polaris-react/src/components/ContentBlock/tests/ContentBlock.test.tsx new file mode 100644 index 00000000000..f49ca8fcc66 --- /dev/null +++ b/polaris-react/src/components/ContentBlock/tests/ContentBlock.test.tsx @@ -0,0 +1,27 @@ +import React from 'react'; +import {mountWithApp} from 'tests/utilities'; + +import {ContentBlock} from '../ContentBlock'; + +const text = 'This is a stack'; +const children =

{text}

; + +describe('', () => { + it('renders children', () => { + const contentBlock = mountWithApp( + {children}, + ); + + expect(contentBlock).toContainReactComponent('p', {children: text}); + }); + + it('renders custom properties', () => { + const contentBlock = mountWithApp( + {children}, + ); + + expect(contentBlock).toContainReactComponent('div', { + className: expect.stringContaining('lg'), + }); + }); +}); diff --git a/polaris-react/src/index.ts b/polaris-react/src/index.ts index 2c9dca82e0d..b03e33759c2 100644 --- a/polaris-react/src/index.ts +++ b/polaris-react/src/index.ts @@ -128,6 +128,9 @@ export type {ComboboxProps} from './components/Combobox'; export {Connected} from './components/Connected'; export type {ConnectedProps} from './components/Connected'; +export {ContentBlock} from './components/ContentBlock'; +export type {ContentBlockProps} from './components/ContentBlock'; + export {ContextualSaveBar} from './components/ContextualSaveBar'; export type {ContextualSaveBarProps} from './components/ContextualSaveBar'; diff --git a/polaris.shopify.com/content/components/content-block/index.md b/polaris.shopify.com/content/components/content-block/index.md new file mode 100644 index 00000000000..aa644b9df88 --- /dev/null +++ b/polaris.shopify.com/content/components/content-block/index.md @@ -0,0 +1,15 @@ +--- +title: Content block +description: Used to create a container that centers and sets the maximum width of the content within. +category: Structure +keywords: + - layout +status: + value: Alpha + message: This component is in development. There could be breaking changes made to it in a non-major release of Polaris. Please use with caution. +examples: + - fileName: content-block-width.tsx + title: Width + description: >- + Used to set maximum width. +--- diff --git a/polaris.shopify.com/pages/examples/content-block-width.tsx b/polaris.shopify.com/pages/examples/content-block-width.tsx new file mode 100644 index 00000000000..9adfe6a64b6 --- /dev/null +++ b/polaris.shopify.com/pages/examples/content-block-width.tsx @@ -0,0 +1,28 @@ +import React from 'react'; +import {ContentBlock, Box, Text} from '@shopify/polaris'; + +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function ContentBlockWidthExample() { + return ( +
+ + + + medium + + + +
+ + + + large + + + +
+ ); +} + +export default withPolarisExample(ContentBlockWidthExample); diff --git a/polaris.shopify.com/public/images/components/content-block.png b/polaris.shopify.com/public/images/components/content-block.png new file mode 100644 index 0000000000000000000000000000000000000000..3b80b1e06f08a11ae65310b6c4a1cda161c303b5 GIT binary patch literal 25923 zcmeFZXH-+$_C6dDRKQACDblMTDAGYn0O>6hrANRciuB$@PzeYkRi#Lirc{wm0BO<@ z5l}*q7HT4d7E1D8n{)4PjQ8{V^*Y8m#*Cf4*P3gVXFhYz9c^Twb%yQ|9SjCLb6Z=( z1O_`H2!kDuJaqzm)8ji+0{)_P*S7M4!MJ6i|Bk^^B<;bM$Gl9m)L^9p>`UMu)Gn&} zsxVkZJpF+K4GeZ~{I-Uwng6j>47~;8KR<6yKX`SW=K-2RIT`wi=Zedsgx|Aehll5G z`6?l9m%4ru`%%GPWai|Jt==KeE^KcT&VpOQVDA%N{^tYtAL^rThLYT=jy~Mikv(?w z;Rb*D(ciGQ3xSs<90|ym#brZ*6Eh41(Gi>Dh0JNqeN7|b#dvip>t!^052z(DyrqZutJl;ANq>RY|= zhpRRhSXo(#MvfoPMyG1adU$)^n*=~oR~I18mhZAEDp{E-D%uUQOuYxp{+a3A^S#)(a91GLNVFV!qLevT3z_io8Hu&tM?d zkZwwtYI+w&0}FTJ1}N74dueIu0x~_N;_i%vR9wM1;mW^hf3~tUA12SS%Lnd% z`HlI#0xrFH3IMsZkB_T(Hfs1eW;d;Ag|}U}J2GE68cpyg7(^o$n@PzvRpE|dVd&$q z@FGSapli2XTwI8b8}--l|FA73b=Q4*xbXTVT0sVo8MK%|*g7rATQ{$;5&vB^VaBslc|F)FGxR2XO{usJmS_ll8F{Cxt80J*1{2VNR=FsJ!j+-P40;EhQ&Urlc|-7Z zF5(4)Dx;a@<>FbK)TPzguK0n=;BxrU<=-U}8nC1$rZj9*(Ae7Qs`rZ66OD*yYNi8Q zdBG`k7#7^q3=$_BVw*ZWGt*aH*Eo#W|IRJQ)iqQwfRj}H^5x5bE=^8hZ=8o;m57#lqj%qZ6cqBor$E|7Dn^e8xOYU)A5wynWDSmb7mb8hSJpRdmY{DBig9v$-A#Kc5Z zAn^;nVPRq9Zkv^427@^dIngBS)TExHp{B1fJ11uf`e#wvcem*DyLYR~U2&3si zR~by^BsESY!uaVckHPF8LN=nApwOWbMxI3IrfSsF-eFoc)i$X0losW~#!VV0DC`jH zYrcG`N4&lwg!?wmZB&1Tf$Gc!?E~$BPq7M@9a(jK4d>*K!NMgWy#?x z64Uy}LFQSgm?0j|RrM@w_A1`JjOOBa~Mj%E)d~(ksF2b|y_H z8|gfF%v&7KgA?cETt!6GL>c@KJ%II}xpn$-hYfHHAz`jCx`#ZMg0i1y$bklat<8 z^PloWk%YCiN9qg4V_=v~bVh^CgO6%vX24NlUpmKuo$URB90;TTv_NpEkd8fvAN zT~8yEvcA7VtdPHIr`su*!Ah+W)8n6`7;oOHQGeX?W5Kx6hDiYVq81{1`7Mx6>K!~f z`8cfn#&=<(iu3h$wv8fEJ1V--*B6RL3k$qO=kWWI+eV+KBof5mMOs;%ZjR+m4;2`@ z)v@u{I#G@_MX4O9Eol+jO|-5Jqe}8vqOm%ca`64_UkqpOjj6-!H?2vwq|8qsKupHR z$EW(%w3nGZ^R{@&ns6L;3-ST?b8@a^P!UCZ^n)chm?rXvm!-EG=!;WCRd7M`uJm%x zXoD(|jtKt3l2bOZzEm*#(~y;%NR9A@8wUot6p+|*ewsWS$RK}W33cf+QF~faQsO3b zQ6-6xK#=~-Ud7&kSWVfrwRJ6xhUe$zcLW`W!3>X#!+JD>v>z0Nsqfa#NwHzFLx*M% zatc#auJ@MR6>A@%K44aB?VW`Kq2LC$Tu^s!q#JRj+pthITdjfJn{F%1GX zOgJ2lcqLn{?FIN@mfYv`%R~%=mX;{?>UvWwRf(*O8(pa}4CYS@nbXq-(Z%%fySb&& zgf%?gmw-h-W*E3fZJJ^(@qOtPWqWQe?;-78+3M;4xX&Qx5*J0sn(+&D&he0MTB3z<;*8i7^cP+)Gg z@iiD%02ZWsBs|0gy@!3M^^11uV<0~FsiU&H6#30`y8pi3kwDAXurl`!hUK4o;3@X= zQS3xBavjT&X9j77_UvFy(GhJ@y3vS-=THQ38nQaB?brp#6@TCFtc-T z^m84IyQ$(drgU|I%esFQgX}#84|6&O#1woB4$9UD1V5mZY@4$D!Lo94OCaczN!2W^ z8n&jkcRRl05Gk`}6>Qd!hY>xJkE!uzgW=Kdv)EqCtXRds>(iVlrc!k1p*)uNwN^wl zcg)10Yvt*~9nY5!nIcWq;}@u4;hBIZ3vZod5gQ+sUJsTt=TZq>^`+B1IM9(7+F+AP z8^>Tc8ZX})Z4{O@XGVhUP0Jk#bD{aYSDOt{!Y?>j5vyMDv2t!7)8HrXY`du6TFnDl zR`Q>~=3_9+pmQ`)1KeFqpDI_gwLK`Ss}KL#J~c;jUh=6I@UKG+L}#pN3)9ZekQI8!RB$#G-tK*ayJtU?M^d<-pdL1_7ZP6X~#LTHs!UVTP zKc|Q18by(#^LMPg&!XK-0et|5HC}I7_*F>iT z*ZFvwuZ{3BE1==xM;hMkp9a@zKP9+4XDRT0d}<2+!7<3SWM4MOAR_uwowfPr6n2wOz-9h$LNNT@7Fa%yXi{zvB)WNxI&)r!8S z(N@|#!NoOJ?)_%g4KUbWg^|nh^spA4!rJ{ivXbe!xw!$d?j9b))t}L5Y*Wbo7bF{V zhLAkuaaz&aVC#_s(M!78?(XhG)vpQsX>30=Rb@~Ez_;A_Tc!j&%(^|U-9%PVF{w)aBac@O5j=Q z1?4Q2Fi!6zLwq~M({m>7fd5a(f4Ba1NUnm(z&X1Wz+#!t4Gj(W-c$)XEP#FK5bOH$ z$5@$N!|&g}OOu1kBDq1%0BNVCdO<+}!1ai+U;X|1e!jjx0l&7Q4>_l6vG?A71ku|E zN(?N;#l`E1MB-WS6FcaK0==OTffiLpj&!XpIlX5kKNTHpF)m-pYHGVTBlQi&nclXu#87%_t=g*&tp9{|lZCrZhf3-xc z>%p+Q;|l{e7;N`K7?B!ge~mfHAcJvG#;m6GcWy4o`}PYcK~yM^3YFfm)zws7S7cU= zgM?##(9Z~*lG&s_VSt2_Q&Az5mX$R;cbqbGv9EK&6L;d{ShY$_*^~(d!WiPQo z<)<&h!ucV;10Lh&Kra|d*x2xVMKcbPLJXOn>iJXZi&c~lzdBZ{&s=Ey_!jL0j-p)S zKM!J(Cy2qx`9PBc#x$xkGBWUsi-kc&HIK2rzwh3)sgC{F<2sKMDP=x#LH~N{DR5v{ zmu*$|3ce#eJv~jPY+h4sxkf~HTfX<}>f$FHnocOa9(!=|+aSXF$UWb=02yE!N)3nY zls_~}fm=wlOihk2DhKbD8;$9bfBO-pk_i&suKKrH;}MZ&kbeI6Hx&juZP8pkLIq+m zrM?H`kZ=1b1JRM}qtH1|lvU7iu0lJH-hBrtpfIfyeuV;j>?DSf(p}LlTkzl{z}>)VEUtz*r`)sX z^)CqO{Z28yFw7$I~k#;of3pDmu(wk#k1>qhc6;5%KEvTm>v8aK)6ZSe3219FG$ z1NAgwMrKGgyVz_sFc&vyRptc-MJmjX+`ir(vAQ~Ai92Luo^6K2{GR{F{r6zTW2O=^ za)|YDzVb>+SFzVCYHDQcOq5cB3Co16f#|BLDmRY#YKcpI4_T}WfUp_<-A^U5<$l4~ zx6J6}5IQ2w_;GLX#vgzFIFKS%*~=7v>UUIE$OTCh?>qtSwCqUI)*ZX=->s~;Wt<+S zef4T_ch{c*zNq+|J5x8#%BSGl4@9g|$ypRIP`@Jsb*p;+H=se228ZV2JTZ|CY{2xF z=qsE_)0GD7aD~CXphz1Vw1ZDaXmZlI)v~~+{xbRCcg=>R`NiBDom8vXi;k+k1Ia$W zR6M-AfR?{>f^ZFl{_WkF;p?b;bno=uUVTGt?V<>jC_@Tk<|MZbDa}7GLO4v#s>R6t zVtl}sQ;ybD`apQwruE^WuxV!;Gw~L9KhADp4Vf7t5S3 zg0$&qY4>v+KOFX>o-+yx3iA84?kwmQV9|Dkf72C+=&(7t?RWyEW=!YWdT1+dugUv& zdhp?|Pg1=A*;|^ES?FN57=J4$&<}Q^ZT`6P_4YWn*Q!vRI)2zj+t7YYA!@wak&cxk5iBYZd4$Q zU>WfYZ<(uQ=py1+GUIOPT#%z7J@@8UB;N_0s?)6#lyU6Wv|KPbX2HVYy z%e|Fh4x!4-vB!Qxh0AM4sjdDdd>S6JKA}*dkl;S^=XUqd$@7L`Q}Kq5@}aD!ws;FN zPp}G4Jytw%>0LZpnTFYhF~#9H>>3Mn?)`b)4fkb@>*A;77{vP;I5`_`ZX8^HCTz!Q zL)E`IcX)sZU%%0)T?6M_nhPL~hYXu^G)E)YeQ01Uo<~B^Ym0`Gl?!8IV;G>g7LPd9 zHe0`n#h$*rnu%~}yxSN(gbt1kDW1xavI~&GG19Csq z#P(r#-dNmEl5%8iP_S7a{&^M+E3M#yYKPeAMJ@PNkhtw(h}hQ?z^y@wdjEsts(xD( zQz$?Vq5DDmhv$~Q?2cma*FLA$T>QFuDD*-3qyKe!+AmzkV{p`uX@9V+E#AJip$P?X z-gOy}#k{>OdE+{sH6uBU2m*QYt3Vdz$$oMT^?9Pwg?Qu}`{KQU4C?#XdWtnKt>{K~ z_3I%=qKD*;Df7O-_a+BOEs>B1A2P%Lu>D*fxKn$MC(MAZfh6+6o_Ujge7}WfuZ3sK zK&>wL(;_Sod89OZfUx|Do(9Vopcw;v%UQOu_4W0t&Rn1u=WT1?=V370e|j;$uF;ml zL8cBl$@fKK`_+-Gom-O~zrk@cg8zT+1l-g;H>=}7eyi^mxmx_)oX4ie z0Gjc8T=skF*INn931D$z?LcVPc6N3!TL5T<_>5wvrhLOFYh{_&q-g~z!+3fth~tx! ztH7G?L;hcf|5feVs0#s;Sd0(3Qcj<^KbJLm6^oV2Dm$cX4`MbA!?1o~1L!HN6)gGu zGC@#m#$rb#5ffSouN)sgHZ%eovWFC1OzcT}$NW4vP>k3sd$use6DJJ0E?3R0 zFLZVW*R4~iPaC#Hk;C3m$b#s{56_)DM+rV`I48Y#4Y}=l&M@NT{z0&B=6n|sOW6&| zB+L9*d5XedY+_cA!Gxd!{xpI??VexzyjYU9Y-{=1vuEo8e25EE02rY;WdEn+$4JHr zXDO$rPayylel@xG8mb0 z?m&?JN@{}1(%BwM;p|Dua_T>XHNv2R2=#p!Ofl8g8U_m$f{({O>_KM4R2*hLW3rdw z{Q6ubfG=scm17p*vivU5*>q|~bm|T-vdr^9bWW+UuI|lACakV~!U}JED63{fL#SV; z{8GFrXPtSahQc{y7C==T89?3#$SHmgpHUlY>yH@6mC!oxi05l-Ym~_I@yFV|2qy;B z{z?c6+9U^4y!HPEXDNq>DEVDC5N-Y8g;DXfm`iBkQ9*}U&ovo%9`cFxNIk+Zfm^3xk{rl4tpcJrA*^*WF`?O+%UXk3#iI^jsT0L=P2>EzBggIb>yE zaIir{cwu3{%ht_mDyF%F=Sj!b>ZLya!bp~qy>p+v`9K;xh+h5xgF)1Dxif=Ko;pu< zdoiXiBLWx9H-co7#4@fwZ8|^d$$s6SaM|rJQs|;!Uif}s@@&S2^4#Hl4;)4DW112J z+klpOe{<;_8B?mZL#yeknuZnjlQ2sp(2{WJ1gECds#`OTEP8WYCC+~4i+vk2lBkR< zbnqM2gpzydi5FyJZab(PgC|ql&Q`Nxr6$*G}H|W3O24K_36r4`T=1Z z-2qw8IYdE5^c4;AR`VbAkqk|tzLcDpPj)TVc7aT7r*ddWNJ|K;ChYeWgfnh9zYfY%xfed7}D8tS)Q;8vHFG#qzm*&RF24 zep^=01*?m?@QhfxV#N3#``D9P)x@78X8y?B(aSkC`8rOBJm@S=pOyr2<%6FxaPTOuydmr7y7Q!+z}KSP^%WBVr^L2iluGwc zqfxDU*Ps(OIMo7os}E3BK%$GcUkATq?%i+XB6JbFzqI=>zG<{4~ zS&T0lHCcEpFb-4LVZ+OHE6Pu7JE{}CuJ{qpZIS2MOJxUbD_wZT^f;dzMxcV5L{}M# zU+w%Q;s%Kx2x4jOvEw{2*fU<>X)PJ*-pOGYOdE6M{K$ey{`yze%`_E4?p{lO!Gw5z zO3)4Gg6w156$&HiI|&Dyk!>O;p)1Hz|^JlJVtHBoVXU! zT6w1}yLjfIZ2=8>Z9WZmP`G?TR!NEDo}4fI)X#XGyX`xw9sOeOyPIDY#U}N-bbR~v z?Z9ghP*L@uY?K0dGW#|Y4Sm&Mk(dY9zX<1=dCF`X`5oW}ZM_TB<1FwSrH$|832-OX zn^9(+poDjWi{31oE6l7eukOL7+1AV=Nopn+5s7J2K=l`e&Pj|?#gnTe&Bo)u(ZKrCt5OUAM9hpPHUrC(0w(6E5# zetp(x%V_2-1Lv&!xmRI`?7=y+I15hR#wCdZlKmg3IHT9MhOzOJ7cGC;6nQhMiJD<4 z>3$t6chqcbj@9Ot1&fYogN3Kq)mBbBe0kZg>{njAPwvod#q<#CL}dL$HRY8oBHk$C zUB(`=bmD5`CiI6-@p-tu_&4n*#9rKB?g>WW2Or$`!vM)oE0<9cc2V`c|63Ensnx(x(x27}m_FLLx$8x!m6vt6X|O3BnF zTvPXAX`=*Kcw!jyF__*hRD#uVU}&iA7k5(r_X>AF5=w}DD3@E%PAc}$WB#KtAN0DR zwoB*|5g8y+-08ZNJI>-$LCu>HD){GaGZa_kD0&xNBdw+qy_KAPj96xsfVh;-X#opQ zm>)QRYNhBn?tMN002b^Dc;E-9VS_`P#j-PZ_MEy9o)&d-yCVrZJQ!6(Z^d;TA>5>E zS$^;dz;fCQR$q4>YcoCUE?`gfeufZF4lA|(T96v?P3Z&znf*cq(`v1+SeH`=ZS|)jS;Y+u3;JEJ615Ak-(2*RT{qsC))kWLHZJZj zjT8icV9;^{N-f!L;}`mC6MlYihPTx`f1W6jRM1kdon7M>;4!?0&ar&gFkM3TrcPbO zhOt+uYM)q}r9>V;nky3M7Xxg<9zN_tJ0}e;tX9PC-+xpQphp;87NO+R@ z^Rxw9lb)iic>@NR;T!BY8i_-|9v_rhl%|{9zh?&i-lSIWtLl zLi*J!$JmVH=tM7GT=%zcw=KBKcIw7#2M8$l9Ky{znsS00lj#1qyUM(xnhy^Rs8H4f z(`L*@G}MlD3tFq3tG z81cva%LZYR_ij|gGT4+exd@n)Fc`{t$GRe3`p z%Zao;#9;K9F76m?R{|VgON;m=F|>iCbkw&#H@lw|;wq*-GXD5y6pZ4250%qYd_V1) zrS`Gykpjb~aqfXdim8KHDl&FwDWVfG6&9asxH)98pz^7LEbrAk%MBu9Nqwj_kDvX-$4&-1EYoIQtxz;GmmatiM zL7r4y9B~hiAIR82u4oAyx+RS!%^iO8%4}OKV%jgk{}@~$O$1o1lkcUEyrX@2{<4np zN~NJ-e75qA=h?HQ3Bb&ULHX^8S2I72;D4C7L4s1g;inT;Ry<9~#YgwpFedv=qRmlL zrk4^o8A8fsqSob;bL&FA;}BQv>}m!hybbeW91Cv=jP(QBT>(UIC{GefxwxT@A!X!P zM@0M7>h1+0u5S^i6gfDO)IvvvvL{<@r6ZQBzaM+uwk(AuW#B?Vcgvn^vGrqw?gy_p zr8CwWMATTStK*`vmT6LH%1&3;Q=01mk1I7eVc~xuR*Eiv+Om3jJ7|fW%`+WvP|Oad zyP|SzvSK%;*tGNoTEIk%68;SDkUG z1^?n6x3qLu+Ri<%vNrPDm)?5`!8ZkJInZZt$b*Sa|WS+BP&OSJ5tRVt798B)4e$gPUP;uQzxOZ)2VC0RT*vTpPke4q)jtW5<=ql4VzlRkkmG28swZSrA|ADq%+I~;phyyJ>Q zB7c-d?;qPq*Sl>yn?|IFHVBH$HQw!lkE5%anv~87iSQd0PwF2B3IiPgOH##k1aUUV zYU6D~IH`u|#g4!Y7nMQ&sF{j%C9BHDo{dXgV&`#dKmAEj z`C>;k3JHwyh;Xnp@@c){_osn(Z|s9-FoO;|JG(csuDR|_yy6{J8D8{MB%>)Ub*%SZ zHOA_`<;3uf_C;k_xQ`%&5pUu1KBaGEsqLh7;GIC(c9KKsOQQvnrDRakmPzTEWP>1s zCaBGfd*UyXwu5NhMH)Ub#3I&;0J{qT=U1^_#g~ezq(yJi31mKA9X7Cft+;?$5l$+d zO?$I^>u-LiZ78SdCD)riw28%+)Ged z;<|akZG1YH7oh_*K@?(+BYR6QV~M?hh?K7AoJf;2wX0!OC7G z$TN2oG0B$T7i=s(;VAJK=>!i=WZaFnD6vk?Aa4H^FNZ!G){-k()y%Cq!(f5Zkm8oP zo0_FbyFGd= zdXwcFKANQy|Mo=%{f4PjRKwWa491AQO9<}449LAg#7ekD?bS3A+J)Bl4M~jrgcWI+ z?aITc$?0^1-<0jKG*|yk_nmgO288*9n`+uWAAu>&Kr50+3YZ0q+LxLdg$DDr48fOlxG9lulAm@Dn3=%dpdP!wYRoi6=DOZv z-(JBdg;(Fc5N4Vwa2BDN$sS0^SX(32>3>2E+C%Zr@!%>eY&uGWuARl<91>JB8iO1` z{^L|r`FWTTs+sALQ*f2Jw;{wXlio=ZoJN>U&l)Y**>u6kOk`cwv z*toF1>_Wc8C{>UaUcwu%KX&f2U!5J2w{E;f=f+LzSG=viXb;E~sMtQ8T&&r%nCagn z>AY^iEX!Ka(D3_HLq|8$1 z`uh6be2`!%D@m4=z07UaCx@$=@nLW@kGfr|0t>%%B!J>eYfKlJlf+?}5>dY@QmC<5 ztPEk?U!>Q6EMOtTc0Y|inmC1x|J-LQyY5MP_-Xm=cv{GUp~D4*|8(3onnXk&K79(B zy<9*sNApYLEzQZ;i;IxY-meCI4xdUY?Do@g$2-}azVvy%G!Ok!O7uAiGlIGU%EOy5 zm`Z$ftY1&b{g>2-&{F~16z%_rSyv<^W8YI)NPA9%6CQQ zszO(7fVPxq9Nh%;8-G{(2Nl=(<-iv8vPMP*Gj6iWUKIp-kjn4MfaZg>&ex?;!qhKh zs=O$rh11PFo*@gyPBzC?Vd2^T##<^6#E!f0w@s#=W zjVWvkl@*AGXdaj-tCy7Z`Mf1)30tynYzceOPhV+G%ZVE$sL+8D+mTw( zjC%HOEa0R4ckmdUxQuVEJ+7Bc<&nj7Q*yWsD`VqTgVdI^?D3?$7(NF#pKBG>)zV?0 zH?R=G6+$=6E=cocc8Z4@w!(+m-Zjfw%V{b5J;KI~&%ajKz@o#@CVu|7YIZKJRG->L zO{(x>4ngAK4bT8ShCuu!Z?E00!F!%A_S1{>0HN^fzt9rb4*XsN_a;rP@Y>z`YsEt8 z<001enKQ_F+0v?n<9SSI(>}YX@SJl3#SICz#hzK+BZJSvjQ z>U{h%gnSJ4Q3}Fx6_Xd5s;WlLaOdhuEeK!#JEm_N1ix^T&_5D^M71Mmx+k4fwojF= zx@eyqlsd@-^;94U!)bnB`=&XW2nDzYT9 zd}w2(rrZh#n_f=rS3GFA3xj=tNdIfEVjo=$e6u`1ir4{kNagT#Q^Y8L2* zWTL%5q~(AN@kCO{iDWo|3pA`ws3&-+m5jp^#>|)vRw<6pf)^+jn2Ic%wbi7p258#m z;u;+MDm-;&N`gP@duD8-A7acz`FLpc-5k%)BgM89(nAF~xr>boe7HYM^}ZlZL_zSz z-m3TxBK+V@Gh3!OYSN)m=R32Bq^)4CPpHgHVP$w$-LC1y>cp`m;x*pHPFtx%vrOH3 z{*B2G40?0c4PxxQTMh0~xO=0HtB95N%MJV@Uvsj)xqPMpHS|Z2|GnhDzr8kn48Cc@ zG@&IKRiVaQ+*x~Y|HAf;)QO_Xpd8O^=czLCL7tfbc1CjE1w^@p2kf&?oBw<2!R z%hqnxGL}- zXkRB>ds&fY2KVf2K$hpK2;Gl5qC(iuADSI=q`3rKN`!Ao2+dNGHg{-ou9qi!aU5Kw zbXjh%V>~9)>oB0GX$@DeFk(Xa=y$PxI7`1jtCDflR5lmx*)A-F~MwbUGJo-uSA{~ zvPVS0#`ElOpt70b-aSDXp zG$l^wGL^3BI=>2Bqk$^9|EGD)VXb}e1LV6<0fKSIK1V>m#G2(ViBp0zf#2Gqy)`oi z)v{Cer93n71<1BI011qtW7HhNB5dTaWWT)-CR#z07nyrDs|fl~qP$(bd#&A-kifuS z2<;)s{QN=m>)B*2^hs`l`ankL^V`kaxQDie6m3;y+@@Cp%?G}+qRMwmf0_5`_hy^# z<8DRdH)a;0&jnPVOHTBMsCOP|bV$oT=^|B|mE4 zycFe3LHpt~r?MjHn2+5?by)p<$3N8TY<2v3YT;>GFQq2m$UB+}8LY7>%U{cdd$y9U z6pm&l7TioN4>}FAPyV!x21OqMad;(QJ!7Tz1h_kJgIPEX6LPZYK!KUp%~OlQ^GA1H z=mQh-Zd~b~fQ`(1Sk>g3vcW(v2=5hFXP05bZ*LW}odKnu)g#)KzM;rJPOv z6fqM}nvoKdA0~hcjCdhYHJB3I9LpTBP_+fdHgu~fpcZZe`2&F~@NcmP-)zQ^Yy90A z{Z{E235IpVz&@V9&hKX9qL!zvNtttOc1%}E&K`hluD9}xGxPqn${gi@Jn@pW+AW@=C3k+#T^OrjYd9%V@ zH(J}rInf!JvcNb4snBnt!2cZ&l2dr2V7ETekQTg)d`aBM83HGqY-Tx2Ja@4e;cphB*-B%Z?|srn*< z+MBlVN_I3gBh{_{Ruzm;4=xHOy`On#-W|$TH=Sy=9*}qHU7Hu(8GVx|mGG^eBNW zfQuL;tQZuSYfzt1fqoRm4T1)}nT4kl$ z@PMg5XMz4Rm!Ih-&97h^zQRSVVX+4_?s+4o7nu|J(aan2Rb4ah*KNanQjxX+XApk+ zn|s$DUSQ76V9?&o5Fnj?+cy58V1tyn;#p8`3d$}wq2yGTr=!MObTfnARG47_kDtuW z&_cZrh=T^pxX?GQ2wh&fu}@a-cGaoT9uEh5MI?9w~43kDjc zMXC6&X(t(~kjeSK0wxXbJsdG5J^Xh6^V12}s=FY($U&BzqK)>KiR$$>)_e3>C#=91 zUun>)^h77ql_~~Tcxmaz9K$p_rLh_1F4Sr;)g{(tZqG3_K?<-cOeKo_X*crhH;eV{ zk=~kg=iy)=9n#+T@I8BrcWFqcODDz&bmE@w!Y+V^7@<5t-6xCng6U*tkJ_&SlgZTv z#Xa~hTG20ImGn8Dc_XhFc=E>I&DwHzOh@W$D=1^9on8~%=zPL&y8NBf!(?bB?tT|Gftcr5s6(t7Fu^Q#lIVPpb3Tk^|?6@ zhP`9jobYLeI~wpb23mO*%vkH-`~lRdQM}nZ{XE61&hhieme|3su+xHj`9BYl#aR~( zx1QL?J$D7B?E{&%`K>S+4=Pk~g1Y)QuN6Nt4b;ZnsxF__=IBW)%!41gDSt!B2X!T{ z#1pBRNY{%}?Q=Z!j7xTeaT}o9q)ma#^ArF3+c4Q`V|VoHD?C}Qq+s10W{?uh$G`ji zdkHH7xHRBRl0I;noaXkca$yM(rDZBkL27CG96nrSE=zPg09ApB>Y+V$-Exz<_MnS= zN!l)mm|@T{9^17B7APvv(a2<|5_(YUi!^#RC9~eNtWa-gXgDTrbm`8#WPkP6xY~6lsIE#WTYFTE z!1ROY61Np-4o^w8h*R&W{q!?KE}<=?c?Z#IkW#dy9<8_v-ALu=MsLJA^|OhdEGCo8 zQwU`mVRr!`Z3h+IFEy7iKACF%DM*Vb<$yC_3SrSdqw!pT%0{!9_5~#l?W_33!L2vA zkdP21!d~}4EP|fVi=9#X6Rzd|@&_ ztMs|Zgv)Rsy0zHy*$&T`9VhK6g4<)Jzl6haxg{&|jD64T=mC5Oh5-n`$_pfurx^N0(ZdJd0S z3b3skU{L0J(H*}Z?wCAZ>%?we&v%Cq2_}GkK{kKD8}&UlxF-X*BYJaV$jc-M7`xuOSiUL|ow z@JZybKDgge^FNo)lO522Ot!3PTQ(K`xSgAQlk;m#fV*VSLE&N`$hogT-uAf$NtmRd0>M2WHk^J0GhcdMwc-0KV`WZV-~0=3MYcMbvt%%75HS5piz<4*>wKH^UpqO23I2+Ps_R_XJYCS% zgM)IRzYm3noL5cjg+;V*e_d$>ltT~3*O9dJPzNGc3H);BO^|mBfqVg0_8K@CW?E5d z=C8f?3u66eu*F?+;8H$cP6a;i4bVeQ9w7+ilrQUh`sQ>E=#qZHzdP*I-=MWg^EKr3<(A%@q@_py10K_^4 zywT?0hEx3JrnmAQEn644RdwfQgb%=YpNBz^MuMjKPA{(z3@GcSK{|6|>+fHCDgF* z+28Nx64VexT+pwPR-jbXI1Ri10i(yw=P&+N0P!EJ9R5`&SmVeh6GMZ^NH&hLSD*;GJ&^M0`-wjB&kqeCBgnGf~z z!hatg9+Jwo96AmXxCT*m+cwwu-z`O^DeZafXsLp_aFC<%Qo6Q(>Md~OcaG%Lx7Od^ zmT_7*??d=Ldx-t|jlS+3!&}4g5%nRb#k?)A<)zo$jn6nAawUNaeUq&_E1BXuOuUH; zg%5$T4hg6P_5RJfh|(zBlok1UNW$)Z#Olb<48CG^CUo21-+yts&eKic{O?~=+#Ms5#-spFdGVjU!GaoSR-TOW zRb?SY*ECM8i!PnIb0fX5RsfjG5$}D&3+h`I@gm*bx4QEEBuj|VFyYJY{yMHLW}bK> zxEtxkqPU5Xe;2Q+5jx1UeM8Z&aiVOJ4v3B|8d`vWNnROSf|>EFPp{Rs$~5)nrLii{ zm}##rsCLeJ_;<$>T{|_UtJm3X9<1+9@xNGX;M|*bNT_hQilFu(5=TrP0@XPhyNpJa zMw9VdPV3$QJ7v#|=kZ&hcVV%TZ3yJnZ{uw)-QkM6dTDR|;Bqc62&P*{1D4SZ5l-VJ z^|dl(D}bC*P*7MA$!E*T@#2Xm6&6|TCcx$hT^^<(Y#Sj$Cd{vcxu`c)vf|;(UA*(S zc#hLmc8jHDr9G*yaO0)Rb%{Iv!_x#`-$&5i?n8XqEk@8JUvkGj4yXkFfq7cl;`k_tc);VLEk-3o6^ASm-3C8 z3lV1pXLfgMy|Jnhk)XXbO8&y${NQ0O7yl2HW(t-yu(Tuh(?+nTp2dW3tF-a(C{V8> z-LQ8*bXn#^RfVr`k#f|*V7T{b*ZIH z%X@}LN{*sgTvcFmyx^Z=UlxOM`sqhA2D*eABcUU2Mf82PD{$xW`wGhHrH!U@V61^( z)i_x(wXC4PCO>qrUEX_Q^QMeU16+Tp5pw*I&213N>pUEvH227TT&R!t35+wJmbAcSU+umLIZLr~noBw&2fQcyO6!e5KZ9CWslsxDC0%*U*+# z5tA>QN&y}1ZE#Q3xB4f2rI&c{;a+vgm$)E-W{dSbXh`P&F3mv4?F%%ghR{u@8Vf6& zU|{(?F8zuislg`IZX4$WkZr&()@ zYLz{Po$-NY7G?!<5=SrWdKxHnO7LgMJwpivW~r&7z?wGj{)hMUl~qU{Y_3VlEf>}< zdBPk2;+aczBVf?!mim!ssuwXE!pii5WKj&271{dH3mEq^I%Uw^c8rFS;CgTPeWx0* z!#f)_0YHwX74|hbi}epc;pyZ>m!w0+aGONLy$gss}Ko#!XlD z31|x5z`$U^&Q6pNq!zcV=7%Bxh2~KCV(k9u$gll7KO`bA_yrY1DB)9JeP;P8W9Lyq zIM2Rl@eb=;we#3BB}Nr6Blv0Z4x|aZWao2WNqBmETPSb(Za#Y!H4`-Yv%vjT_e`~= zLT-9GJ$k#-60GQ`<1M^Zk!e!t@y8K@(>ZltBeRCa##PWAy}gPJ^YD-iGwXHz{rmUI zZZ*o)DZv9IyMGyuwm~#9TD;MT3;1qT4yp(UfYh^|GocgRqQ|`N9K_L#54vyz`Si9Q zOw`Icc*5l8AoTs_h`o3ig3M>cQ^eJ5>h8&;aTev&^%++qRlvS z$4{TcfoN{jUVwxl04Z5JH=+qv{#x)+o+Sl3m=d~ls^yS1${&G-N(URq{Jh0(#cSma|$CK0pZxyh~KX?N% zE7)umjcXNXw8}X_|NI>Hw(66xmLX_>@7fF0`n7F+F#!xC7#Onw<9O&huMY13KmF7@ z_+ui<^=Rhc>h2gPGzWd?2HnJ#oemZf`n=%;)Np!D8Zj)z3CJE)_?tz%euU(K!?W!;5&q92>u5i7==3AOwy-h}l)((RwO) zdU;htoz+wVI>~*!L9n&{Ikh~1Ga9qQ;;)M8>Wn}%0VCYvYi8i>Rp0W`=P9ptn8KU5 z(+X*oQUQ}4VPFQnQ$fjQ<~i~@!O{rw8yRUIE3TxJ7hSx+1qknm;|2`MkC#4JuH68# z2=9h;6;aG6w_3KXn4GnF1%-g#jR2^zX>V#8U3$4i-jNN=F%F^!K@iIURTNe|2YBl> z1ZG)r@3Z-rRwfwKN{Lb7yzkX;503qPLy;0o?Ujj(x@4fI%m;kvk zPvV!cuJQ59TJ#V2HPC2rs*6Xvh4PlYza|<0MIs~6lAiI~n!k0?*6Lw9&;SyIaH{#r zS>oeXw=GmHEfe^6g~dNb2eI$FNT`lV5!lkC}7eC;JG?Oqy9*J(vtWZSO`3e%%ytr@mwLoe~{qNR>t)>6vfgirCxKi%&g8v62Es!KA4c<$V}fvU$_IM1gu z;B}0^XX;njBCqzEG;mToS9=&Dw84F+G0)k7+qQ472I@^D*wSEKa6bq__?>90oCOb( zd=4M;QA1AplT8;k$y56KNQNIv&OG}wE=(8$@b0F@Qn=K3+R#WS-p{!-A$Tv=bxOiH zIHPt#RKT_GI1P-kO=;vsvQkweR`#Y(S`c$v%%k)#R@6w<-6f}UaJygJJO#JhzjFQy z5(!zM*?wAEYh@0xZH1zRmB}{#VFb&#ar1_JM$HmJy?c|6Q1sJH!fsfiyPYHk(0aI@ z_!V&mU7B2n9))^9U&o2DSdo2nw5M_763ykOc0VlS%QgSz-0B8 z3vE-abrB4C`Hqufmzxb6m%j)+;=YxWLxnVvD} ziMIy{jc!5QYYp|6ifSq=Z$Ij+fi0jYQa40ow++>0snqYkKzr5IWm$6TaMmU#BC#6c z9Hp9-Up($Qh*PS-oTOT1w93n`d3M6p&`fUrw;rcZe<;X!KH(CTYF;I)=9<62iIt3D zILRI~7y7l^CGBlxVq{-ig}rXpv0Wqf;ScoJc)q#2+kwXDfSfn!rhgcmls;qP%|$Z! zn^x7n#7eno);&sF75ijGb=!Ho!I%{T*!e7XZ+wIVITkbeSyRj-SaFYgszqLGFJSgR zQKrJi$q#5JIouLDJ`cYmai@+5$}V2qv?18*Y><9tYBbxR}W(O;fkW*Z4bXP&aw zvk+Mj8@0j9cPuUjYz9^!^(;{ft^!q52y$%&SnT zhDKq2FUM+ibak)2cSu@dgANAY(Oi>WQCpiOlcpdIQVxK;1cC8AtD+o=90QocOI&E) zJM@>?2sV(ZGIca8Vk5e-eEOIs&m8+~I6FSVrxpEb6Rq@N@A@h;%L?D z+M0@}==)en`uPVxD$f{b%XqQyw9Vn_ODk^mq!}RJc6I#SSQL1yfNAg7X>rH*Ug~mc zuDPYs03i@G^}yG@h;D>!5$Ac7noXl^b4r-MHvet~pov80Ygj9*<7O2XQ!|sWDxhc7 zniK>fDFb<4@)E6_91^l9$E&BBjgyl|bs_BRiD?3zx(~%0(2>^^7oX1r3{{FkP6KC~ z75Q%Gqp4nAUQjfqMJm5Ax|W`=$!5>Ym=Ax8Aq#o1pl(X(4)SbH`~I*2&vI-a?fN&p zd5vCSQPLF|)FPYhDpL-J0D_JQftM;FhfL}9(f&OD?(%ILEM(GfEg;#AwR3x6G*o143S z&qL(}Lz8qhWPbWjv^oa5V|N=CSLyvtt{&xx#kJO1f@wQ$E}*(>`nVcta_TVi5iS~g zLR}fdhDqr*K-{3&2|NuHNs@!oNhmp#Y5Tl+PU9?03_jYr7mp!*=JWYGYT!9#WF%)@ zIw(g_CkZKqlQ+)m>FFJ-p9#oV3NEmPQOxh9lHh~3vfi*u&)j1Nxo&4dA)f0ekUH6x z)?8xk%bfR%Ksh^$ z2atgw4gLLF>z`Pki*>s|w#51#S;q@7gLUj&KS#g}*3VRMH2&Y51OA4CD(?MV%U2*L PyI}(!2W3G<7sLMt+b+FP literal 0 HcmV?d00001 diff --git a/polaris.shopify.com/src/data/props.json b/polaris.shopify.com/src/data/props.json index 27c27752d7e..91860668443 100644 --- a/polaris.shopify.com/src/data/props.json +++ b/polaris.shopify.com/src/data/props.json @@ -7218,15 +7218,6 @@ "description": "" } }, - "PortalsContainerElement": { - "polaris-react/src/utilities/portals/types.ts": { - "filePath": "polaris-react/src/utilities/portals/types.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "PortalsContainerElement", - "value": "HTMLDivElement | null", - "description": "" - } - }, "NavigableOption": { "polaris-react/src/utilities/listbox/types.ts": { "filePath": "polaris-react/src/utilities/listbox/types.ts", @@ -7305,6 +7296,15 @@ "value": "export interface ListboxContextType {\n onOptionSelect(option: NavigableOption): void;\n setLoading(label?: string): void;\n}" } }, + "PortalsContainerElement": { + "polaris-react/src/utilities/portals/types.ts": { + "filePath": "polaris-react/src/utilities/portals/types.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PortalsContainerElement", + "value": "HTMLDivElement | null", + "description": "" + } + }, "ResourceListSelectedItems": { "polaris-react/src/utilities/resource-list/types.ts": { "filePath": "polaris-react/src/utilities/resource-list/types.ts", @@ -7662,55 +7662,54 @@ "value": "export interface AccountConnectionProps {\n /** Content to display as title */\n title?: React.ReactNode;\n /** Content to display as additional details */\n details?: React.ReactNode;\n /** Content to display as terms of service */\n termsOfService?: React.ReactNode;\n /** The name of the service */\n accountName?: string;\n /** URL for the user’s avatar image */\n avatarUrl?: string;\n /** Set if the account is connected */\n connected?: boolean;\n /** Action for account connection */\n action?: Action;\n}" } }, - "ActionListProps": { - "polaris-react/src/components/ActionList/ActionList.tsx": { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "name": "ActionListProps", + "ActionMenuProps": { + "polaris-react/src/components/ActionMenu/ActionMenu.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "name": "ActionMenuProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", "syntaxKind": "PropertySignature", - "name": "items", - "value": "readonly ActionListItemDescriptor[]", - "description": "Collection of actions for list", + "name": "actions", + "value": "MenuActionDescriptor[]", + "description": "Collection of page-level secondary actions", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", "syntaxKind": "PropertySignature", - "name": "sections", - "value": "readonly ActionListSection[]", - "description": "Collection of sectioned action items", + "name": "groups", + "value": "MenuGroupDescriptor[]", + "description": "Collection of page-level action groups", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", "syntaxKind": "PropertySignature", - "name": "actionRole", - "value": "string", - "description": "Defines a specific role attribute for each action in the list", + "name": "rollup", + "value": "boolean", + "description": "Roll up all actions into a Popover > ActionList", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any item is clicked or keypressed", + "name": "rollupActionsLabel", + "value": "string", + "description": "Label for rolled up actions activator", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "MethodSignature", + "name": "onActionRollup", + "value": "(hasRolledUp: boolean) => void", + "description": "Callback that returns true when secondary actions are rolled up into action groups, and false when not", "isOptional": true } ], - "value": "export interface ActionListProps {\n /** Collection of actions for list */\n items?: readonly ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" - } - }, - "ActionListItemProps": { - "polaris-react/src/components/ActionList/ActionList.tsx": { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "ActionListItemProps", - "value": "ItemProps", - "description": "" + "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}" } }, "Props": { @@ -8074,54 +8073,55 @@ "value": "export interface AlphaCardProps {\n /** Elements to display inside card */\n children?: React.ReactNode;\n backgroundColor?: CardBackgroundColorTokenScale;\n borderRadius?: BorderRadiusTokenScale;\n elevation?: CardElevationTokensScale;\n padding?: SpacingTokenScale;\n roundedAbove?: Breakpoint;\n}" } }, - "ActionMenuProps": { - "polaris-react/src/components/ActionMenu/ActionMenu.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "name": "ActionMenuProps", + "ActionListProps": { + "polaris-react/src/components/ActionList/ActionList.tsx": { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "name": "ActionListProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "actions", - "value": "MenuActionDescriptor[]", - "description": "Collection of page-level secondary actions", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", "syntaxKind": "PropertySignature", - "name": "groups", - "value": "MenuGroupDescriptor[]", - "description": "Collection of page-level action groups", + "name": "items", + "value": "readonly ActionListItemDescriptor[]", + "description": "Collection of actions for list", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", "syntaxKind": "PropertySignature", - "name": "rollup", - "value": "boolean", - "description": "Roll up all actions into a Popover > ActionList", + "name": "sections", + "value": "readonly ActionListSection[]", + "description": "Collection of sectioned action items", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", "syntaxKind": "PropertySignature", - "name": "rollupActionsLabel", + "name": "actionRole", "value": "string", - "description": "Label for rolled up actions activator", + "description": "Defines a specific role attribute for each action in the list", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "MethodSignature", - "name": "onActionRollup", - "value": "(hasRolledUp: boolean) => void", - "description": "Callback that returns true when secondary actions are rolled up into action groups, and false when not", + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any item is clicked or keypressed", "isOptional": true } ], - "value": "export interface 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}" + "value": "export interface ActionListProps {\n /** Collection of actions for list */\n items?: readonly ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" + } + }, + "ActionListItemProps": { + "polaris-react/src/components/ActionList/ActionList.tsx": { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ActionListItemProps", + "value": "ItemProps", + "description": "" } }, "SpacingTokenGroup": { @@ -10551,6 +10551,56 @@ "description": "" } }, + "ButtonGroupProps": { + "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "name": "ButtonGroupProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "spacing", + "value": "Spacing", + "description": "Determines the space between button group items", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "segmented", + "value": "boolean", + "description": "Join buttons as segmented group", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "fullWidth", + "value": "boolean", + "description": "Buttons will stretch/shrink to occupy the full width", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "connectedTop", + "value": "boolean", + "description": "Remove top left and right border radius", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Button components", + "isOptional": true + } + ], + "value": "export interface ButtonGroupProps {\n /** Determines the space between button group items */\n spacing?: Spacing;\n /** Join buttons as segmented group */\n segmented?: boolean;\n /** Buttons will stretch/shrink to occupy the full width */\n fullWidth?: boolean;\n /** Remove top left and right border radius */\n connectedTop?: boolean;\n /** Button components */\n children?: React.ReactNode;\n}" + } + }, "ButtonProps": { "polaris-react/src/components/Button/Button.tsx": { "filePath": "polaris-react/src/components/Button/Button.tsx", @@ -10908,56 +10958,6 @@ "description": "" } }, - "ButtonGroupProps": { - "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "name": "ButtonGroupProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "spacing", - "value": "Spacing", - "description": "Determines the space between button group items", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "segmented", - "value": "boolean", - "description": "Join buttons as segmented group", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "fullWidth", - "value": "boolean", - "description": "Buttons will stretch/shrink to occupy the full width", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "connectedTop", - "value": "boolean", - "description": "Remove top left and right border radius", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Button components", - "isOptional": true - } - ], - "value": "export interface ButtonGroupProps {\n /** Determines the space between button group items */\n spacing?: Spacing;\n /** Join buttons as segmented group */\n segmented?: boolean;\n /** Buttons will stretch/shrink to occupy the full width */\n fullWidth?: boolean;\n /** Remove top left and right border radius */\n connectedTop?: boolean;\n /** Button components */\n children?: React.ReactNode;\n}" - } - }, "CalloutCardProps": { "polaris-react/src/components/CalloutCard/CalloutCard.tsx": { "filePath": "polaris-react/src/components/CalloutCard/CalloutCard.tsx", @@ -12094,6 +12094,40 @@ "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", + "syntaxKind": "TypeAliasDeclaration", + "name": "Width", + "value": "'medium' | 'large'", + "description": "" + } + }, + "ContentBlockProps": { + "polaris-react/src/components/ContentBlock/ContentBlock.tsx": { + "filePath": "polaris-react/src/components/ContentBlock/ContentBlock.tsx", + "name": "ContentBlockProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ContentBlock/ContentBlock.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Elements to display inside container", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ContentBlock/ContentBlock.tsx", + "syntaxKind": "PropertySignature", + "name": "width", + "value": "Width", + "description": "Adjust maximum width of container" + } + ], + "value": "export interface ContentBlockProps {\n /** Elements to display inside container */\n children?: React.ReactNode;\n /** Adjust maximum width of container */\n width: Width;\n}" + } + }, "TableRow": { "polaris-react/src/components/DataTable/DataTable.tsx": { "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", @@ -21974,1185 +22008,1142 @@ "value": "export interface PortalsManager {\n container: PortalsContainerElement;\n}" } }, - "ItemProps": { - "polaris-react/src/components/ActionList/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/ActionList/components/Item/Item.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "ItemProps", - "value": "ActionListItemDescriptor", - "description": "" - }, - "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx", - "name": "ItemProps", + "MeasuredActions": { + "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "name": "MeasuredActions", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", "syntaxKind": "PropertySignature", - "name": "button", - "value": "React.ReactElement", + "name": "showable", + "value": "MenuActionDescriptor[]", "description": "" - } - ], - "value": "export interface ItemProps {\n button: React.ReactElement;\n}" - }, - "polaris-react/src/components/Connected/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "position", - "value": "ItemPosition", - "description": "Position of the item" }, { - "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "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/FormLayout/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true + "name": "rolledUp", + "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", + "description": "" } ], - "value": "export interface ItemProps {\n children?: React.ReactNode;\n}" - }, - "polaris-react/src/components/List/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", - "name": "ItemProps", + "value": "interface MeasuredActions {\n showable: MenuActionDescriptor[];\n rolledUp: (MenuActionDescriptor | MenuGroupDescriptor)[];\n}" + } + }, + "MenuGroupProps": { + "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "name": "MenuGroupProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Content to display inside the item", + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden menu description for screen readers", "isOptional": true - } - ], - "value": "export interface ItemProps {\n /** Content to display inside the item */\n children?: React.ReactNode;\n}" - }, - "polaris-react/src/components/Navigation/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "", + "name": "active", + "value": "boolean", + "description": "Whether or not the menu is open", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "badge", - "value": "ReactNode", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "(openActions: () => void) => void", + "description": "Callback when the menu is clicked", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "" + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "onOpen", + "value": "(title: string) => void", + "description": "Callback for opening the MenuGroup by title" }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "", - "isOptional": true + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "onClose", + "value": "(title: string) => void", + "description": "Callback for closing the MenuGroup by title" }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "getOffsetWidth", + "value": "(width: number) => void", + "description": "Callback for getting the offsetWidth of the MenuGroup", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "selected", - "value": "boolean", - "description": "", + "name": "sections", + "value": "readonly ActionListSection[]", + "description": "Collection of sectioned action items", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "exactMatch", - "value": "boolean", - "description": "", - "isOptional": true + "name": "title", + "value": "string", + "description": "Menu group title" }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "new", - "value": "boolean", - "description": "", - "isOptional": true + "name": "actions", + "value": "ActionListItemDescriptor[]", + "description": "List of actions" }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "subNavigationItems", - "value": "SubNavigationItem[]", - "description": "", + "name": "icon", + "value": "any", + "description": "Icon to display", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "secondaryAction", - "value": "SecondaryAction", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onToggleExpandedState", - "value": "() => void", - "description": "", + "name": "details", + "value": "React.ReactNode", + "description": "Action details", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "expanded", + "name": "disabled", "value": "boolean", - "description": "", + "description": "Disables action button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "shouldResizeIcon", - "value": "boolean", - "description": "", + "name": "index", + "value": "number", + "description": "Zero-indexed numerical position. Overrides the group's order in the menu.", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any action takes place", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "matches", - "value": "boolean", + "name": "badge", + "value": "{ status: \"new\"; content: string; }", "description": "", "isOptional": true - }, + } + ], + "value": "export interface MenuGroupProps extends MenuGroupDescriptor {\n /** Visually hidden menu description for screen readers */\n accessibilityLabel?: string;\n /** Whether or not the menu is open */\n active?: boolean;\n /** Callback when the menu is clicked */\n onClick?(openActions: () => void): void;\n /** Callback for opening the MenuGroup by title */\n onOpen(title: string): void;\n /** Callback for closing the MenuGroup by title */\n onClose(title: string): void;\n /** Callback for getting the offsetWidth of the MenuGroup */\n getOffsetWidth?(width: number): void;\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n}" + } + }, + "RollupActionsProps": { + "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "name": "RollupActionsProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", "syntaxKind": "PropertySignature", - "name": "matchPaths", - "value": "string[]", - "description": "", + "name": "accessibilityLabel", + "value": "string", + "description": "Accessibilty label", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", "syntaxKind": "PropertySignature", - "name": "excludePaths", - "value": "string[]", - "description": "", + "name": "items", + "value": "ActionListItemDescriptor[]", + "description": "Collection of actions for the list", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", "syntaxKind": "PropertySignature", - "name": "external", - "value": "boolean", - "description": "", + "name": "sections", + "value": "ActionListSection[]", + "description": "Collection of sectioned action items", "isOptional": true } ], - "value": "export interface ItemProps extends ItemURLDetails {\n icon?: IconProps['source'];\n badge?: ReactNode;\n label: string;\n disabled?: boolean;\n accessibilityLabel?: string;\n selected?: boolean;\n exactMatch?: boolean;\n new?: boolean;\n subNavigationItems?: SubNavigationItem[];\n secondaryAction?: SecondaryAction;\n onClick?(): void;\n onToggleExpandedState?(): void;\n expanded?: boolean;\n shouldResizeIcon?: boolean;\n}" - }, - "polaris-react/src/components/Stack/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", - "name": "ItemProps", + "value": "export interface RollupActionsProps {\n /** Accessibilty label */\n accessibilityLabel?: string;\n /** Collection of actions for the list */\n items?: ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: ActionListSection[];\n}" + } + }, + "SecondaryAction": { + "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "name": "SecondaryAction", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", + "name": "helpText", "value": "React.ReactNode", - "description": "Elements to display inside item", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "fill", - "value": "boolean", - "description": "Fill the remaining horizontal space in the stack with the item", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onAction", + "value": "() => void", + "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}" - }, - "polaris-react/src/components/Tabs/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "" }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "focused", - "value": "boolean", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "panelID", - "value": "string", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "getOffsetWidth", + "value": "(width: number) => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", "name": "children", - "value": "React.ReactNode", - "description": "", + "value": "string | string[]", + "description": "The content to display inside the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "", + "name": "primary", + "value": "boolean", + "description": "Provides extra visual weight and identifies the primary action in a set of buttons", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "", + "name": "destructive", + "value": "boolean", + "description": "Indicates a dangerous or potentially negative action", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "", - "isOptional": true - } - ], - "value": "export interface ItemProps {\n id: string;\n focused: boolean;\n panelID?: string;\n children?: React.ReactNode;\n url?: string;\n accessibilityLabel?: string;\n onClick?(): void;\n}" - }, - "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "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": [ + "name": "size", + "value": "\"large\" | \"medium\" | \"slim\"", + "description": "Changes the size of the button, giving it more or less padding", + "isOptional": true, + "defaultValue": "'medium'" + }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "section", - "value": "ActionListSection", - "description": "Section of action items" + "name": "textAlign", + "value": "\"start\" | \"end\" | \"center\" | \"left\" | \"right\"", + "description": "Changes the inner text alignment of the button", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "hasMultipleSections", + "name": "outline", "value": "boolean", - "description": "Should there be multiple sections" + "description": "Gives the button a subtle alternative to the default button styling, appropriate for certain backdrops", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "actionRole", - "value": "string", - "description": "Defines a specific role attribute for each action in the list", + "name": "fullWidth", + "value": "boolean", + "description": "Allows the button to grow to the width of its container", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any item is clicked or keypressed", + "name": "disclosure", + "value": "boolean | \"up\" | \"down\" | \"select\"", + "description": "Displays the button with a disclosure icon. Defaults to `down` when set to true", "isOptional": true - } - ], - "value": "export interface SectionProps {\n /** Section of action items */\n section: ActionListSection;\n /** Should there be multiple sections */\n hasMultipleSections: boolean;\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'option' | 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" - }, - "polaris-react/src/components/Layout/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "name": "plain", + "value": "boolean", + "description": "Renders a button that looks like a link", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "secondary", + "name": "monochrome", "value": "boolean", - "description": "", + "description": "Makes `plain` and `outline` Button colors (text, borders, icons) the same as the current text color. Also adds an underline to `plain` Buttons", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "fullWidth", + "name": "removeUnderline", "value": "boolean", - "description": "", + "description": "Removes underline from button text (including on interaction) when `monochrome` and `plain` are true", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "oneHalf", - "value": "boolean", - "description": "", + "name": "icon", + "value": "any", + "description": "Icon to display to the left of the button content", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "oneThird", - "value": "boolean", - "description": "", + "name": "connectedDisclosure", + "value": "ConnectedDisclosure", + "description": "Disclosure button connected right of the button. Toggles a popover action list.", "isOptional": true - } - ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\n secondary?: boolean;\n fullWidth?: boolean;\n oneHalf?: boolean;\n oneThird?: boolean;\n}" - }, - "polaris-react/src/components/Listbox/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "divider", + "name": "dataPrimaryLink", "value": "boolean", - "description": "", + "description": "Indicates whether or not the button is the primary navigation link when rendered inside of an `IndexTable.Row`", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", - "description": "", + "name": "id", + "value": "string", + "description": "A unique identifier for the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "title", - "value": "ReactNode", - "description": "" - } - ], - "value": "interface SectionProps {\n divider?: boolean;\n children?: ReactNode;\n title: ReactNode;\n}" - }, - "polaris-react/src/components/Modal/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ + "name": "url", + "value": "string", + "description": "A destination to link to, rendered in the href attribute of a link", + "isOptional": true + }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "name": "external", + "value": "boolean", + "description": "Forces url to open in a new tab", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "flush", - "value": "boolean", - "description": "", + "name": "download", + "value": "string | boolean", + "description": "Tells the browser to download the url instead of opening it. Provides a hint for the downloaded filename if it is a string value", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "subdued", + "name": "submit", "value": "boolean", - "description": "", + "description": "Allows the button to submit a form", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "titleHidden", + "name": "disabled", "value": "boolean", - "description": "", + "description": "Disables the button, disallowing merchant interaction", "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", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "items", - "value": "ItemProps[]", - "description": "" + "name": "loading", + "value": "boolean", + "description": "Replaces button text with a spinner while a background action is being performed", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "", + "name": "pressed", + "value": "boolean", + "description": "Sets the button in a pressed state", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "title", + "name": "accessibilityLabel", "value": "string", - "description": "", + "description": "Visually hidden text for screen readers", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "fill", - "value": "boolean", - "description": "", + "name": "role", + "value": "string", + "description": "A valid WAI-ARIA role to define the semantic value of this element", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "rollup", - "value": "{ after: number; view: string; hide: string; activePath: string; }", - "description": "", + "name": "ariaControls", + "value": "string", + "description": "Id of the element the button controls", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "action", - "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", - "description": "", + "name": "ariaExpanded", + "value": "boolean", + "description": "Tells screen reader the controlled element is expanded", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "separator", - "value": "boolean", - "description": "", + "name": "ariaDescribedBy", + "value": "string", + "description": "Indicates the ID of the element that describes the button", "isOptional": true - } - ], - "value": "export interface SectionProps {\n items: ItemProps[];\n icon?: IconProps['source'];\n title?: string;\n fill?: boolean;\n rollup?: {\n after: number;\n view: string;\n hide: string;\n activePath: string;\n };\n action?: {\n icon: IconProps['source'];\n accessibilityLabel: string;\n onClick(): void;\n tooltip?: TooltipProps;\n };\n separator?: boolean;\n}" - }, - "polaris-react/src/components/Popover/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "name": "ariaChecked", + "value": "\"false\" | \"true\"", + "description": "Indicates the current checked state of the button when acting as a toggle or switch", "isOptional": true - } - ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\n}" - } - }, - "MeasuredActions": { - "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "name": "MeasuredActions", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "syntaxKind": "PropertySignature", - "name": "showable", - "value": "MenuActionDescriptor[]", - "description": "" + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "Callback when clicked", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "syntaxKind": "PropertySignature", - "name": "rolledUp", - "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", - "description": "" - } - ], - "value": "interface MeasuredActions {\n showable: MenuActionDescriptor[];\n rolledUp: (MenuActionDescriptor | MenuGroupDescriptor)[];\n}" - } - }, - "MenuGroupProps": { - "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "name": "MenuGroupProps", - "description": "", - "members": [ + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onFocus", + "value": "() => void", + "description": "Callback when button becomes focussed", + "isOptional": true + }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Visually hidden menu description for screen readers", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onBlur", + "value": "() => void", + "description": "Callback when focus leaves button", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "active", - "value": "boolean", - "description": "Whether or not the menu is open", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyPress", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keypress event is registered on the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "(openActions: () => void) => void", - "description": "Callback when the menu is clicked", + "name": "onKeyUp", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keyup event is registered on the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "MethodSignature", - "name": "onOpen", - "value": "(title: string) => void", - "description": "Callback for opening the MenuGroup by title" + "name": "onKeyDown", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keydown event is registered on the button", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "MethodSignature", - "name": "onClose", - "value": "(title: string) => void", - "description": "Callback for closing the MenuGroup by title" + "name": "onMouseEnter", + "value": "() => void", + "description": "Callback when mouse enter", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "MethodSignature", - "name": "getOffsetWidth", - "value": "(width: number) => void", - "description": "Callback for getting the offsetWidth of the MenuGroup", + "name": "onTouchStart", + "value": "() => void", + "description": "Callback when element is touched", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "sections", - "value": "readonly ActionListSection[]", - "description": "Collection of sectioned action items", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onPointerDown", + "value": "() => void", + "description": "Callback when pointerdown event is being triggered", "isOptional": true - }, + } + ], + "value": "interface SecondaryAction extends ButtonProps {\n helpText?: React.ReactNode;\n onAction?(): void;\n getOffsetWidth?(width: number): void;\n}" + }, + "polaris-react/src/components/Navigation/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "name": "SecondaryAction", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "title", + "name": "url", "value": "string", - "description": "Menu group title" + "description": "" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "actions", - "value": "ActionListItemDescriptor[]", - "description": "List of actions" + "name": "accessibilityLabel", + "value": "string", + "description": "" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", "name": "icon", "value": "any", - "description": "Icon to display", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "details", - "value": "React.ReactNode", - "description": "Action details", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables action button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "index", - "value": "number", - "description": "Zero-indexed numerical position. Overrides the group's order in the menu.", - "isOptional": true + "description": "" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", "value": "() => void", - "description": "Callback when any action takes place", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "badge", - "value": "{ status: \"new\"; content: string; }", + "name": "tooltip", + "value": "TooltipProps", "description": "", "isOptional": true } ], - "value": "export interface MenuGroupProps extends MenuGroupDescriptor {\n /** Visually hidden menu description for screen readers */\n accessibilityLabel?: string;\n /** Whether or not the menu is open */\n active?: boolean;\n /** Callback when the menu is clicked */\n onClick?(openActions: () => void): void;\n /** Callback for opening the MenuGroup by title */\n onOpen(title: string): void;\n /** Callback for closing the MenuGroup by title */\n onClose(title: string): void;\n /** Callback for getting the offsetWidth of the MenuGroup */\n getOffsetWidth?(width: number): void;\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n}" + "value": "interface SecondaryAction {\n url: string;\n accessibilityLabel: string;\n icon: IconProps['source'];\n onClick?(): void;\n tooltip?: TooltipProps;\n}" } }, - "RollupActionsProps": { - "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "name": "RollupActionsProps", + "ItemProps": { + "polaris-react/src/components/ActionList/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/ActionList/components/Item/Item.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ItemProps", + "value": "ActionListItemDescriptor", + "description": "" + }, + "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx", + "name": "ItemProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "filePath": "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Accessibilty label", - "isOptional": true - }, + "name": "button", + "value": "React.ReactElement", + "description": "" + } + ], + "value": "export interface ItemProps {\n button: React.ReactElement;\n}" + }, + "polaris-react/src/components/Connected/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "items", - "value": "ActionListItemDescriptor[]", - "description": "Collection of actions for the list", - "isOptional": true + "name": "position", + "value": "ItemPosition", + "description": "Position of the item" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "sections", - "value": "ActionListSection[]", - "description": "Collection of sectioned action items", + "name": "children", + "value": "React.ReactNode", + "description": "Item content", "isOptional": true } ], - "value": "export interface RollupActionsProps {\n /** Accessibilty label */\n accessibilityLabel?: string;\n /** Collection of actions for the list */\n items?: ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: ActionListSection[];\n}" - } - }, - "SecondaryAction": { - "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "name": "SecondaryAction", + "value": "export interface ItemProps {\n /** Position of the item */\n position: ItemPosition;\n /** Item content */\n children?: React.ReactNode;\n}" + }, + "polaris-react/src/components/FormLayout/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", + "name": "ItemProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "helpText", + "name": "children", "value": "React.ReactNode", "description": "", "isOptional": true - }, + } + ], + "value": "export interface ItemProps {\n children?: React.ReactNode;\n}" + }, + "polaris-react/src/components/List/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onAction", - "value": "() => void", + "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/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "getOffsetWidth", - "value": "(width: number) => void", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "badge", + "value": "ReactNode", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "string | string[]", - "description": "The content to display inside the button", - "isOptional": true + "name": "label", + "value": "string", + "description": "" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "primary", + "name": "disabled", "value": "boolean", - "description": "Provides extra visual weight and identifies the primary action in a set of buttons", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "destructive", - "value": "boolean", - "description": "Indicates a dangerous or potentially negative action", + "name": "accessibilityLabel", + "value": "string", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "size", - "value": "\"large\" | \"medium\" | \"slim\"", - "description": "Changes the size of the button, giving it more or less padding", - "isOptional": true, - "defaultValue": "'medium'" + "name": "selected", + "value": "boolean", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "textAlign", - "value": "\"start\" | \"end\" | \"center\" | \"left\" | \"right\"", - "description": "Changes the inner text alignment of the button", + "name": "exactMatch", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "outline", + "name": "new", "value": "boolean", - "description": "Gives the button a subtle alternative to the default button styling, appropriate for certain backdrops", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "fullWidth", - "value": "boolean", - "description": "Allows the button to grow to the width of its container", + "name": "subNavigationItems", + "value": "SubNavigationItem[]", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "disclosure", - "value": "boolean | \"up\" | \"down\" | \"select\"", - "description": "Displays the button with a disclosure icon. Defaults to `down` when set to true", + "name": "secondaryAction", + "value": "SecondaryAction", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "PropertySignature", - "name": "plain", - "value": "boolean", - "description": "Renders a button that looks like a link", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "PropertySignature", - "name": "monochrome", - "value": "boolean", - "description": "Makes `plain` and `outline` Button colors (text, borders, icons) the same as the current text color. Also adds an underline to `plain` Buttons", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "MethodSignature", + "name": "onToggleExpandedState", + "value": "() => void", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "removeUnderline", + "name": "expanded", "value": "boolean", - "description": "Removes underline from button text (including on interaction) when `monochrome` and `plain` are true", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "Icon to display to the left of the button content", + "name": "shouldResizeIcon", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "connectedDisclosure", - "value": "ConnectedDisclosure", - "description": "Disclosure button connected right of the button. Toggles a popover action list.", + "name": "url", + "value": "string", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "dataPrimaryLink", + "name": "matches", "value": "boolean", - "description": "Indicates whether or not the button is the primary navigation link when rendered inside of an `IndexTable.Row`", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the button", + "name": "matchPaths", + "value": "string[]", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "A destination to link to, rendered in the href attribute of a link", + "name": "excludePaths", + "value": "string[]", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", "name": "external", "value": "boolean", - "description": "Forces url to open in a new tab", + "description": "", "isOptional": true - }, + } + ], + "value": "export interface ItemProps extends ItemURLDetails {\n icon?: IconProps['source'];\n badge?: ReactNode;\n label: string;\n disabled?: boolean;\n accessibilityLabel?: string;\n selected?: boolean;\n exactMatch?: boolean;\n new?: boolean;\n subNavigationItems?: SubNavigationItem[];\n secondaryAction?: SecondaryAction;\n onClick?(): void;\n onToggleExpandedState?(): void;\n expanded?: boolean;\n shouldResizeIcon?: boolean;\n}" + }, + "polaris-react/src/components/Stack/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "download", - "value": "string | boolean", - "description": "Tells the browser to download the url instead of opening it. Provides a hint for the downloaded filename if it is a string value", + "name": "children", + "value": "React.ReactNode", + "description": "Elements to display inside item", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "submit", + "name": "fill", "value": "boolean", - "description": "Allows the button to submit a form", + "description": "Fill the remaining horizontal space in the stack with the item", "isOptional": true + } + ], + "value": "export interface ItemProps {\n /** Elements to display inside item */\n children?: React.ReactNode;\n /** Fill the remaining horizontal space in the stack with the item */\n fill?: boolean;\n /**\n * @default false\n */\n}" + }, + "polaris-react/src/components/Tabs/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", + "name": "focused", "value": "boolean", - "description": "Disables the button, disallowing merchant interaction", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "panelID", + "value": "string", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "loading", - "value": "boolean", - "description": "Replaces button text with a spinner while a background action is being performed", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "pressed", - "value": "boolean", - "description": "Sets the button in a pressed state", + "name": "url", + "value": "string", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "Visually hidden text for screen readers", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "", + "isOptional": true + } + ], + "value": "export interface ItemProps {\n id: string;\n focused: boolean;\n panelID?: string;\n children?: React.ReactNode;\n url?: string;\n accessibilityLabel?: string;\n onClick?(): void;\n}" + }, + "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "role", - "value": "string", - "description": "A valid WAI-ARIA role to define the semantic value of this element", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true + } + ], + "value": "interface ItemProps {\n children?: React.ReactNode;\n}" + } + }, + "SectionProps": { + "polaris-react/src/components/ActionList/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "section", + "value": "ActionListSection", + "description": "Section of action items" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "ariaControls", + "name": "hasMultipleSections", + "value": "boolean", + "description": "Should there be multiple sections" + }, + { + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "actionRole", "value": "string", - "description": "Id of the element the button controls", + "description": "Defines a specific role attribute for each action in the list", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "ariaExpanded", - "value": "boolean", - "description": "Tells screen reader the controlled element is expanded", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any item is clicked or keypressed", + "isOptional": true + } + ], + "value": "export interface SectionProps {\n /** Section of action items */\n section: ActionListSection;\n /** Should there be multiple sections */\n hasMultipleSections: boolean;\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'option' | 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" + }, + "polaris-react/src/components/Layout/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "ariaDescribedBy", - "value": "string", - "description": "Indicates the ID of the element that describes the button", + "name": "secondary", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "ariaChecked", - "value": "\"false\" | \"true\"", - "description": "Indicates the current checked state of the button when acting as a toggle or switch", + "name": "fullWidth", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "Callback when clicked", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "oneHalf", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onFocus", - "value": "() => void", - "description": "Callback when button becomes focussed", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "oneThird", + "value": "boolean", + "description": "", "isOptional": true - }, + } + ], + "value": "export interface SectionProps {\n children?: React.ReactNode;\n secondary?: boolean;\n fullWidth?: boolean;\n oneHalf?: boolean;\n oneThird?: boolean;\n}" + }, + "polaris-react/src/components/Listbox/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onBlur", - "value": "() => void", - "description": "Callback when focus leaves button", + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "divider", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyPress", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keypress event is registered on the button", + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyUp", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keyup event is registered on the button", - "isOptional": true - }, + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "ReactNode", + "description": "" + } + ], + "value": "interface SectionProps {\n divider?: boolean;\n children?: ReactNode;\n title: ReactNode;\n}" + }, + "polaris-react/src/components/Modal/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyDown", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keydown event is registered on the button", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onMouseEnter", - "value": "() => void", - "description": "Callback when mouse enter", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "flush", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onTouchStart", - "value": "() => void", - "description": "Callback when element is touched", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "subdued", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onPointerDown", - "value": "() => void", - "description": "Callback when pointerdown event is being triggered", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "titleHidden", + "value": "boolean", + "description": "", "isOptional": true } ], - "value": "interface SecondaryAction extends ButtonProps {\n helpText?: React.ReactNode;\n onAction?(): void;\n getOffsetWidth?(width: number): void;\n}" + "value": "export interface SectionProps {\n children?: React.ReactNode;\n flush?: boolean;\n subdued?: boolean;\n titleHidden?: boolean;\n}" }, - "polaris-react/src/components/Navigation/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "SecondaryAction", + "polaris-react/src/components/Navigation/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "name": "SectionProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", + "name": "items", + "value": "ItemProps[]", "description": "" }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", "name": "icon", "value": "any", - "description": "" + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "tooltip", - "value": "TooltipProps", + "name": "fill", + "value": "boolean", "description": "", "isOptional": true - } - ], - "value": "interface SecondaryAction {\n url: string;\n accessibilityLabel: string;\n icon: IconProps['source'];\n onClick?(): void;\n tooltip?: TooltipProps;\n}" - } - }, - "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", - "name": "PipProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "status", - "value": "Status", + "name": "rollup", + "value": "{ after: number; view: string; hide: string; activePath: string; }", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "progress", - "value": "Progress", + "name": "action", + "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabelOverride", - "value": "string", + "name": "separator", + "value": "boolean", "description": "", "isOptional": true } ], - "value": "export interface PipProps {\n status?: Status;\n progress?: Progress;\n accessibilityLabelOverride?: string;\n}" + "value": "export interface SectionProps {\n items: ItemProps[];\n icon?: IconProps['source'];\n title?: string;\n fill?: boolean;\n rollup?: {\n after: number;\n view: string;\n hide: string;\n activePath: string;\n };\n action?: {\n icon: IconProps['source'];\n accessibilityLabel: string;\n onClick(): void;\n tooltip?: TooltipProps;\n };\n separator?: boolean;\n}" + }, + "polaris-react/src/components/Popover/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "export interface SectionProps {\n children?: React.ReactNode;\n}" } }, "MappedAction": { @@ -23325,7 +23316,50 @@ "isOptional": true } ], - "value": "interface MappedAction extends ActionListItemDescriptor {\n wrapOverflow?: boolean;\n}" + "value": "interface MappedAction extends ActionListItemDescriptor {\n wrapOverflow?: boolean;\n}" + } + }, + "MappedOption": { + "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx": { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "MappedOption", + "value": "ArrayElement & {\n selected: boolean;\n singleSelection: boolean;\n}", + "description": "" + } + }, + "PipProps": { + "polaris-react/src/components/Badge/components/Pip/Pip.tsx": { + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "name": "PipProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "syntaxKind": "PropertySignature", + "name": "status", + "value": "Status", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "syntaxKind": "PropertySignature", + "name": "progress", + "value": "Progress", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabelOverride", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface PipProps {\n status?: Status;\n progress?: Progress;\n accessibilityLabelOverride?: string;\n}" } }, "BulkActionButtonProps": { @@ -23424,6 +23458,40 @@ "value": "export interface BulkActionsMenuProps extends MenuGroupDescriptor {\n isNewBadgeInBadgeActions: boolean;\n}" } }, + "CardHeaderProps": { + "polaris-react/src/components/Card/components/Header/Header.tsx": { + "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", + "name": "CardHeaderProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", + "syntaxKind": "PropertySignature", + "name": "actions", + "value": "DisableableAction[]", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "export interface CardHeaderProps {\n title?: React.ReactNode;\n actions?: DisableableAction[];\n children?: React.ReactNode;\n}" + } + }, "CardSectionProps": { "polaris-react/src/components/Card/components/Section/Section.tsx": { "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", @@ -23490,40 +23558,6 @@ "value": "export interface CardSectionProps {\n title?: React.ReactNode;\n children?: React.ReactNode;\n subdued?: boolean;\n flush?: boolean;\n fullWidth?: boolean;\n /** Allow the card to be hidden when printing */\n hideOnPrint?: boolean;\n actions?: ComplexAction[];\n}" } }, - "CardHeaderProps": { - "polaris-react/src/components/Card/components/Header/Header.tsx": { - "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", - "name": "CardHeaderProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", - "syntaxKind": "PropertySignature", - "name": "actions", - "value": "DisableableAction[]", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "export interface CardHeaderProps {\n title?: React.ReactNode;\n actions?: DisableableAction[];\n children?: React.ReactNode;\n}" - } - }, "CardSubsectionProps": { "polaris-react/src/components/Card/components/Subsection/Subsection.tsx": { "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", @@ -24225,6 +24259,32 @@ "value": "export interface MonthProps {\n focusedDate?: Date;\n selected?: Range;\n hoverDate?: Date;\n month: number;\n year: number;\n disableDatesBefore?: Date;\n disableDatesAfter?: Date;\n disableSpecificDates?: Date[];\n allowRange?: boolean;\n weekStartsOn: number;\n accessibilityLabelPrefixes: [string | undefined, string];\n onChange?(date: Range): void;\n onHover?(hoverEnd: Date): void;\n onFocus?(date: Date): void;\n}" } }, + "FileUploadProps": { + "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx": { + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "name": "FileUploadProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "syntaxKind": "PropertySignature", + "name": "actionTitle", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "syntaxKind": "PropertySignature", + "name": "actionHint", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface FileUploadProps {\n actionTitle?: string;\n actionHint?: string;\n}" + } + }, "WeekdayProps": { "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx": { "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", @@ -24256,32 +24316,6 @@ "value": "export interface WeekdayProps {\n label: string;\n title: string;\n current: boolean;\n}" } }, - "FileUploadProps": { - "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx": { - "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", - "name": "FileUploadProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", - "syntaxKind": "PropertySignature", - "name": "actionTitle", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", - "syntaxKind": "PropertySignature", - "name": "actionHint", - "value": "string", - "description": "", - "isOptional": true - } - ], - "value": "export interface FileUploadProps {\n actionTitle?: string;\n actionHint?: string;\n}" - } - }, "PopoverableAction": { "polaris-react/src/components/Filters/components/ConnectedFilterControl/ConnectedFilterControl.tsx": { "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/ConnectedFilterControl.tsx", @@ -24757,71 +24791,6 @@ "value": "export interface AnnotatedSectionProps {\n children?: React.ReactNode;\n title?: React.ReactNode;\n description?: React.ReactNode;\n id?: string;\n}" } }, - "ActionProps": { - "polaris-react/src/components/Listbox/components/Action/Action.tsx": { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", - "name": "ActionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "any", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", - "syntaxKind": "PropertySignature", - "name": "selected", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", - "syntaxKind": "PropertySignature", - "name": "divider", - "value": "boolean", - "description": "", - "isOptional": true - } - ], - "value": "interface ActionProps extends OptionProps {\n icon?: IconProps['source'];\n}" - } - }, "HeaderProps": { "polaris-react/src/components/Listbox/components/Header/Header.tsx": { "filePath": "polaris-react/src/components/Listbox/components/Header/Header.tsx", @@ -24986,7 +24955,72 @@ "isOptional": true } ], - "value": "export interface HeaderProps extends TitleProps {\n /** Visually hide the title */\n titleHidden?: boolean;\n /** Primary page-level action */\n primaryAction?: PrimaryAction | React.ReactNode;\n /** Page-level pagination */\n pagination?: PaginationProps;\n /** Collection of breadcrumbs */\n breadcrumbs?: BreadcrumbsProps['breadcrumbs'];\n /** Collection of secondary page-level actions */\n secondaryActions?: MenuActionDescriptor[] | React.ReactNode;\n /** Collection of page-level groups of secondary actions */\n actionGroups?: MenuGroupDescriptor[];\n /** @deprecated Additional navigation markup */\n additionalNavigation?: React.ReactNode;\n // Additional meta data\n additionalMetadata?: React.ReactNode | string;\n /** Callback that returns true when secondary actions are rolled up into action groups, and false when not */\n onActionRollup?(hasRolledUp: boolean): void;\n}" + "value": "export interface HeaderProps extends TitleProps {\n /** Visually hide the title */\n titleHidden?: boolean;\n /** Primary page-level action */\n primaryAction?: PrimaryAction | React.ReactNode;\n /** Page-level pagination */\n pagination?: PaginationProps;\n /** Collection of breadcrumbs */\n breadcrumbs?: BreadcrumbsProps['breadcrumbs'];\n /** Collection of secondary page-level actions */\n secondaryActions?: MenuActionDescriptor[] | React.ReactNode;\n /** Collection of page-level groups of secondary actions */\n actionGroups?: MenuGroupDescriptor[];\n /** @deprecated Additional navigation markup */\n additionalNavigation?: React.ReactNode;\n // Additional meta data\n additionalMetadata?: React.ReactNode | string;\n /** Callback that returns true when secondary actions are rolled up into action groups, and false when not */\n onActionRollup?(hasRolledUp: boolean): void;\n}" + } + }, + "ActionProps": { + "polaris-react/src/components/Listbox/components/Action/Action.tsx": { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "name": "ActionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "any", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "any", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "divider", + "value": "boolean", + "description": "", + "isOptional": true + } + ], + "value": "interface ActionProps extends OptionProps {\n icon?: IconProps['source'];\n}" } }, "OptionProps": { @@ -26237,95 +26271,6 @@ "value": "export interface PanelProps {\n hidden?: boolean;\n id: string;\n tabID: string;\n children?: React.ReactNode;\n}" } }, - "TabProps": { - "polaris-react/src/components/Tabs/components/Tab/Tab.tsx": { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", - "name": "TabProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", - "syntaxKind": "PropertySignature", - "name": "focused", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", - "syntaxKind": "PropertySignature", - "name": "siblingTabHasFocus", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", - "syntaxKind": "PropertySignature", - "name": "selected", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", - "syntaxKind": "PropertySignature", - "name": "panelID", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", - "syntaxKind": "PropertySignature", - "name": "measuring", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "(id: string) => void", - "description": "", - "isOptional": true - } - ], - "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", @@ -26450,13 +26395,93 @@ "value": "export interface ResizerProps {\n contents?: string;\n currentHeight?: number | null;\n minimumLines?: number;\n onHeightChange(height: number): void;\n}" } }, - "HandleStepFn": { - "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx": { - "filePath": "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "HandleStepFn", - "value": "(step: number) => void", - "description": "" + "TabProps": { + "polaris-react/src/components/Tabs/components/Tab/Tab.tsx": { + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "name": "TabProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "syntaxKind": "PropertySignature", + "name": "focused", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "syntaxKind": "PropertySignature", + "name": "siblingTabHasFocus", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "syntaxKind": "PropertySignature", + "name": "panelID", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "syntaxKind": "PropertySignature", + "name": "url", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "syntaxKind": "PropertySignature", + "name": "measuring", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "(id: string) => void", + "description": "", + "isOptional": true + } + ], + "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}" } }, "TooltipOverlayProps": { @@ -26529,6 +26554,15 @@ "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}" } }, + "HandleStepFn": { + "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx": { + "filePath": "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "HandleStepFn", + "value": "(step: number) => void", + "description": "" + } + }, "MenuProps": { "polaris-react/src/components/TopBar/components/Menu/Menu.tsx": { "filePath": "polaris-react/src/components/TopBar/components/Menu/Menu.tsx", @@ -26789,6 +26823,37 @@ "value": "export interface UserMenuProps {\n /** An array of action objects that are rendered inside of a popover triggered by this menu */\n actions: {items: IconableAction[]}[];\n /** Accepts a message that facilitates direct, urgent communication with the merchant through the user menu */\n message?: MenuProps['message'];\n /** A string detailing the merchant’s full name to be displayed in the user menu */\n name: string;\n /** A string allowing further detail on the merchant’s name displayed in the user menu */\n detail?: string;\n /** A string that provides the accessibility labeling */\n accessibilityLabel?: string;\n /** The merchant’s initials, rendered in place of an avatar image when not provided */\n initials: AvatarProps['initials'];\n /** An avatar image representing the merchant */\n avatar?: AvatarProps['source'];\n /** A boolean property indicating whether the user menu is currently open */\n open: boolean;\n /** A callback function to handle opening and closing the user menu */\n onToggle(): void;\n}" } }, + "DiscardConfirmationModalProps": { + "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx": { + "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", + "name": "DiscardConfirmationModalProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", + "syntaxKind": "PropertySignature", + "name": "open", + "value": "boolean", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", + "syntaxKind": "MethodSignature", + "name": "onDiscard", + "value": "() => void", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", + "syntaxKind": "MethodSignature", + "name": "onCancel", + "value": "() => void", + "description": "" + } + ], + "value": "export interface DiscardConfirmationModalProps {\n open: boolean;\n onDiscard(): void;\n onCancel(): void;\n}" + } + }, "SecondaryProps": { "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx": { "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", @@ -26822,37 +26887,6 @@ "value": "interface SecondaryProps {\n expanded: boolean;\n children?: React.ReactNode;\n id?: string;\n}" } }, - "DiscardConfirmationModalProps": { - "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx": { - "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", - "name": "DiscardConfirmationModalProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", - "syntaxKind": "PropertySignature", - "name": "open", - "value": "boolean", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", - "syntaxKind": "MethodSignature", - "name": "onDiscard", - "value": "() => void", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Frame/components/ContextualSaveBar/components/DiscardConfirmationModal/DiscardConfirmationModal.tsx", - "syntaxKind": "MethodSignature", - "name": "onCancel", - "value": "() => void", - "description": "" - } - ], - "value": "export interface DiscardConfirmationModalProps {\n open: boolean;\n onDiscard(): void;\n onCancel(): void;\n}" - } - }, "TitleProps": { "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx": { "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", From 79a70697da9e3effbec6a6de8acf5cf96080452e Mon Sep 17 00:00:00 2001 From: Chaz Dean <59836805+chazdean@users.noreply.github.com> Date: Mon, 26 Sep 2022 15:56:29 -0400 Subject: [PATCH 14/25] [Layout foundations] Add alpha page in style guide for `Bleed` (#7276) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### WHY are these changes introduced? Fixes #7258 ### WHAT is this pull request doing? Adds alpha page and examples for `Bleed` component
Bleed alpha page Bleed alpha page
### How to 🎩 🖥 [Local development instructions](https://github.com/Shopify/polaris/blob/main/README.md#local-development) 🗒 [General tophatting guidelines](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md) 📄 [Changelog guidelines](https://github.com/Shopify/polaris/blob/main/.github/CONTRIBUTING.md#changelog)
Copy-paste this code in playground/Playground.tsx: ```jsx import React from 'react'; import {Page} from '../src'; export function Playground() { return ( {/* Add the code you want to test in here */} ); } ```
### 🎩 checklist - [ ] Tested on [mobile](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md#cross-browser-testing) - [ ] Tested on [multiple browsers](https://help.shopify.com/en/manual/shopify-admin/supported-browsers) - [ ] Tested for [accessibility](https://github.com/Shopify/polaris/blob/main/documentation/Accessibility%20testing.md) - [ ] Updated the component's `README.md` with documentation changes - [ ] [Tophatted documentation](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting%20documentation.md) changes in the style guide Co-authored-by: Lo Kim --- .../content/components/bleed/index.md | 27 + .../pages/examples/bleed-all-directions.tsx | 31 + .../pages/examples/bleed-horizontal.tsx | 31 + .../examples/bleed-specific-direction.tsx | 62 ++ .../pages/examples/bleed-vertical.tsx | 31 + .../public/images/components/bleed.png | Bin 0 -> 25923 bytes polaris.shopify.com/src/data/props.json | 659 +++++++++++------- 7 files changed, 607 insertions(+), 234 deletions(-) create mode 100644 polaris.shopify.com/content/components/bleed/index.md create mode 100644 polaris.shopify.com/pages/examples/bleed-all-directions.tsx create mode 100644 polaris.shopify.com/pages/examples/bleed-horizontal.tsx create mode 100644 polaris.shopify.com/pages/examples/bleed-specific-direction.tsx create mode 100644 polaris.shopify.com/pages/examples/bleed-vertical.tsx create mode 100644 polaris.shopify.com/public/images/components/bleed.png diff --git a/polaris.shopify.com/content/components/bleed/index.md b/polaris.shopify.com/content/components/bleed/index.md new file mode 100644 index 00000000000..89e075862ca --- /dev/null +++ b/polaris.shopify.com/content/components/bleed/index.md @@ -0,0 +1,27 @@ +--- +title: Bleed +description: Used to create a container that applies negative margins to allow content to extend into the surrounding layout. +category: Structure +keywords: + - layout +status: + value: Alpha + message: This component is in development. There could be breaking changes made to it in a non-major release of Polaris. Please use with caution. +examples: + - fileName: bleed-vertical.tsx + title: Vertical + description: >- + Use to set bleed vertically. + - fileName: bleed-horizontal.tsx + title: Horizontal + description: >- + Use to set bleed horizontally. + - fileName: bleed-specific-direction.tsx + title: Specific direction + description: >- + Use to set bleed in a specific direction + - fileName: bleed-all-directions.tsx + title: All directions + description: >- + Use to set bleed in all directions +--- diff --git a/polaris.shopify.com/pages/examples/bleed-all-directions.tsx b/polaris.shopify.com/pages/examples/bleed-all-directions.tsx new file mode 100644 index 00000000000..cd8ffb17fb5 --- /dev/null +++ b/polaris.shopify.com/pages/examples/bleed-all-directions.tsx @@ -0,0 +1,31 @@ +import React from 'react'; +import {Bleed, Box, Text} from '@shopify/polaris'; + +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +const styles = { + background: 'var(--p-background-selected)', + borderRadius: 'var(--p-border-radius-05)', + border: '1px solid var(--p-surface-dark)', + padding: 'var(--p-space-4)', + height: 'var(--p-space-12)', + opacity: 0.7, +}; + +function BleedAllDirectionsExample() { + return ( +
+ + +
+ + All directions + +
+ + +
+ ); +} + +export default withPolarisExample(BleedAllDirectionsExample); diff --git a/polaris.shopify.com/pages/examples/bleed-horizontal.tsx b/polaris.shopify.com/pages/examples/bleed-horizontal.tsx new file mode 100644 index 00000000000..11b715095ae --- /dev/null +++ b/polaris.shopify.com/pages/examples/bleed-horizontal.tsx @@ -0,0 +1,31 @@ +import React from 'react'; +import {Bleed, Box, Text} from '@shopify/polaris'; + +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +const styles = { + background: 'var(--p-background-selected)', + borderRadius: 'var(--p-border-radius-05)', + border: '1px solid var(--p-surface-dark)', + padding: 'var(--p-space-4)', + height: 'var(--p-space-12)', + opacity: 0.7, +}; + +function BleedHorizontalExample() { + return ( +
+ + +
+ + horizontal + +
+ + +
+ ); +} + +export default withPolarisExample(BleedHorizontalExample); diff --git a/polaris.shopify.com/pages/examples/bleed-specific-direction.tsx b/polaris.shopify.com/pages/examples/bleed-specific-direction.tsx new file mode 100644 index 00000000000..cfb4ea396a0 --- /dev/null +++ b/polaris.shopify.com/pages/examples/bleed-specific-direction.tsx @@ -0,0 +1,62 @@ +import React from 'react'; +import {Bleed, Box, Text} from '@shopify/polaris'; + +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +const styles = { + background: 'var(--p-background-selected)', + borderRadius: 'var(--p-border-radius-05)', + border: '1px solid var(--p-surface-dark)', + padding: 'var(--p-space-4)', + height: 'var(--p-space-12)', + opacity: 0.7, +}; + +function BleedSpecificDirectionExample() { + return ( +
+ + +
+ + top + +
+ + +
+ + +
+ + right + +
+ + +
+ + +
+ + left + +
+ + +
+ + +
+ + bottom + +
+ + +
+
+ ); +} + +export default withPolarisExample(BleedSpecificDirectionExample); diff --git a/polaris.shopify.com/pages/examples/bleed-vertical.tsx b/polaris.shopify.com/pages/examples/bleed-vertical.tsx new file mode 100644 index 00000000000..7b1a858b069 --- /dev/null +++ b/polaris.shopify.com/pages/examples/bleed-vertical.tsx @@ -0,0 +1,31 @@ +import React from 'react'; +import {Bleed, Box, Text} from '@shopify/polaris'; + +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +const styles = { + background: 'var(--p-background-selected)', + borderRadius: 'var(--p-border-radius-05)', + border: '1px solid var(--p-surface-dark)', + padding: 'var(--p-space-4)', + height: 'var(--p-space-12)', + opacity: 0.7, +}; + +function BleedVerticalExample() { + return ( +
+ + +
+ + vertical + +
+ + +
+ ); +} + +export default withPolarisExample(BleedVerticalExample); diff --git a/polaris.shopify.com/public/images/components/bleed.png b/polaris.shopify.com/public/images/components/bleed.png new file mode 100644 index 0000000000000000000000000000000000000000..3b80b1e06f08a11ae65310b6c4a1cda161c303b5 GIT binary patch literal 25923 zcmeFZXH-+$_C6dDRKQACDblMTDAGYn0O>6hrANRciuB$@PzeYkRi#Lirc{wm0BO<@ z5l}*q7HT4d7E1D8n{)4PjQ8{V^*Y8m#*Cf4*P3gVXFhYz9c^Twb%yQ|9SjCLb6Z=( z1O_`H2!kDuJaqzm)8ji+0{)_P*S7M4!MJ6i|Bk^^B<;bM$Gl9m)L^9p>`UMu)Gn&} zsxVkZJpF+K4GeZ~{I-Uwng6j>47~;8KR<6yKX`SW=K-2RIT`wi=Zedsgx|Aehll5G z`6?l9m%4ru`%%GPWai|Jt==KeE^KcT&VpOQVDA%N{^tYtAL^rThLYT=jy~Mikv(?w z;Rb*D(ciGQ3xSs<90|ym#brZ*6Eh41(Gi>Dh0JNqeN7|b#dvip>t!^052z(DyrqZutJl;ANq>RY|= zhpRRhSXo(#MvfoPMyG1adU$)^n*=~oR~I18mhZAEDp{E-D%uUQOuYxp{+a3A^S#)(a91GLNVFV!qLevT3z_io8Hu&tM?d zkZwwtYI+w&0}FTJ1}N74dueIu0x~_N;_i%vR9wM1;mW^hf3~tUA12SS%Lnd% z`HlI#0xrFH3IMsZkB_T(Hfs1eW;d;Ag|}U}J2GE68cpyg7(^o$n@PzvRpE|dVd&$q z@FGSapli2XTwI8b8}--l|FA73b=Q4*xbXTVT0sVo8MK%|*g7rATQ{$;5&vB^VaBslc|F)FGxR2XO{usJmS_ll8F{Cxt80J*1{2VNR=FsJ!j+-P40;EhQ&Urlc|-7Z zF5(4)Dx;a@<>FbK)TPzguK0n=;BxrU<=-U}8nC1$rZj9*(Ae7Qs`rZ66OD*yYNi8Q zdBG`k7#7^q3=$_BVw*ZWGt*aH*Eo#W|IRJQ)iqQwfRj}H^5x5bE=^8hZ=8o;m57#lqj%qZ6cqBor$E|7Dn^e8xOYU)A5wynWDSmb7mb8hSJpRdmY{DBig9v$-A#Kc5Z zAn^;nVPRq9Zkv^427@^dIngBS)TExHp{B1fJ11uf`e#wvcem*DyLYR~U2&3si zR~by^BsESY!uaVckHPF8LN=nApwOWbMxI3IrfSsF-eFoc)i$X0losW~#!VV0DC`jH zYrcG`N4&lwg!?wmZB&1Tf$Gc!?E~$BPq7M@9a(jK4d>*K!NMgWy#?x z64Uy}LFQSgm?0j|RrM@w_A1`JjOOBa~Mj%E)d~(ksF2b|y_H z8|gfF%v&7KgA?cETt!6GL>c@KJ%II}xpn$-hYfHHAz`jCx`#ZMg0i1y$bklat<8 z^PloWk%YCiN9qg4V_=v~bVh^CgO6%vX24NlUpmKuo$URB90;TTv_NpEkd8fvAN zT~8yEvcA7VtdPHIr`su*!Ah+W)8n6`7;oOHQGeX?W5Kx6hDiYVq81{1`7Mx6>K!~f z`8cfn#&=<(iu3h$wv8fEJ1V--*B6RL3k$qO=kWWI+eV+KBof5mMOs;%ZjR+m4;2`@ z)v@u{I#G@_MX4O9Eol+jO|-5Jqe}8vqOm%ca`64_UkqpOjj6-!H?2vwq|8qsKupHR z$EW(%w3nGZ^R{@&ns6L;3-ST?b8@a^P!UCZ^n)chm?rXvm!-EG=!;WCRd7M`uJm%x zXoD(|jtKt3l2bOZzEm*#(~y;%NR9A@8wUot6p+|*ewsWS$RK}W33cf+QF~faQsO3b zQ6-6xK#=~-Ud7&kSWVfrwRJ6xhUe$zcLW`W!3>X#!+JD>v>z0Nsqfa#NwHzFLx*M% zatc#auJ@MR6>A@%K44aB?VW`Kq2LC$Tu^s!q#JRj+pthITdjfJn{F%1GX zOgJ2lcqLn{?FIN@mfYv`%R~%=mX;{?>UvWwRf(*O8(pa}4CYS@nbXq-(Z%%fySb&& zgf%?gmw-h-W*E3fZJJ^(@qOtPWqWQe?;-78+3M;4xX&Qx5*J0sn(+&D&he0MTB3z<;*8i7^cP+)Gg z@iiD%02ZWsBs|0gy@!3M^^11uV<0~FsiU&H6#30`y8pi3kwDAXurl`!hUK4o;3@X= zQS3xBavjT&X9j77_UvFy(GhJ@y3vS-=THQ38nQaB?brp#6@TCFtc-T z^m84IyQ$(drgU|I%esFQgX}#84|6&O#1woB4$9UD1V5mZY@4$D!Lo94OCaczN!2W^ z8n&jkcRRl05Gk`}6>Qd!hY>xJkE!uzgW=Kdv)EqCtXRds>(iVlrc!k1p*)uNwN^wl zcg)10Yvt*~9nY5!nIcWq;}@u4;hBIZ3vZod5gQ+sUJsTt=TZq>^`+B1IM9(7+F+AP z8^>Tc8ZX})Z4{O@XGVhUP0Jk#bD{aYSDOt{!Y?>j5vyMDv2t!7)8HrXY`du6TFnDl zR`Q>~=3_9+pmQ`)1KeFqpDI_gwLK`Ss}KL#J~c;jUh=6I@UKG+L}#pN3)9ZekQI8!RB$#G-tK*ayJtU?M^d<-pdL1_7ZP6X~#LTHs!UVTP zKc|Q18by(#^LMPg&!XK-0et|5HC}I7_*F>iT z*ZFvwuZ{3BE1==xM;hMkp9a@zKP9+4XDRT0d}<2+!7<3SWM4MOAR_uwowfPr6n2wOz-9h$LNNT@7Fa%yXi{zvB)WNxI&)r!8S z(N@|#!NoOJ?)_%g4KUbWg^|nh^spA4!rJ{ivXbe!xw!$d?j9b))t}L5Y*Wbo7bF{V zhLAkuaaz&aVC#_s(M!78?(XhG)vpQsX>30=Rb@~Ez_;A_Tc!j&%(^|U-9%PVF{w)aBac@O5j=Q z1?4Q2Fi!6zLwq~M({m>7fd5a(f4Ba1NUnm(z&X1Wz+#!t4Gj(W-c$)XEP#FK5bOH$ z$5@$N!|&g}OOu1kBDq1%0BNVCdO<+}!1ai+U;X|1e!jjx0l&7Q4>_l6vG?A71ku|E zN(?N;#l`E1MB-WS6FcaK0==OTffiLpj&!XpIlX5kKNTHpF)m-pYHGVTBlQi&nclXu#87%_t=g*&tp9{|lZCrZhf3-xc z>%p+Q;|l{e7;N`K7?B!ge~mfHAcJvG#;m6GcWy4o`}PYcK~yM^3YFfm)zws7S7cU= zgM?##(9Z~*lG&s_VSt2_Q&Az5mX$R;cbqbGv9EK&6L;d{ShY$_*^~(d!WiPQo z<)<&h!ucV;10Lh&Kra|d*x2xVMKcbPLJXOn>iJXZi&c~lzdBZ{&s=Ey_!jL0j-p)S zKM!J(Cy2qx`9PBc#x$xkGBWUsi-kc&HIK2rzwh3)sgC{F<2sKMDP=x#LH~N{DR5v{ zmu*$|3ce#eJv~jPY+h4sxkf~HTfX<}>f$FHnocOa9(!=|+aSXF$UWb=02yE!N)3nY zls_~}fm=wlOihk2DhKbD8;$9bfBO-pk_i&suKKrH;}MZ&kbeI6Hx&juZP8pkLIq+m zrM?H`kZ=1b1JRM}qtH1|lvU7iu0lJH-hBrtpfIfyeuV;j>?DSf(p}LlTkzl{z}>)VEUtz*r`)sX z^)CqO{Z28yFw7$I~k#;of3pDmu(wk#k1>qhc6;5%KEvTm>v8aK)6ZSe3219FG$ z1NAgwMrKGgyVz_sFc&vyRptc-MJmjX+`ir(vAQ~Ai92Luo^6K2{GR{F{r6zTW2O=^ za)|YDzVb>+SFzVCYHDQcOq5cB3Co16f#|BLDmRY#YKcpI4_T}WfUp_<-A^U5<$l4~ zx6J6}5IQ2w_;GLX#vgzFIFKS%*~=7v>UUIE$OTCh?>qtSwCqUI)*ZX=->s~;Wt<+S zef4T_ch{c*zNq+|J5x8#%BSGl4@9g|$ypRIP`@Jsb*p;+H=se228ZV2JTZ|CY{2xF z=qsE_)0GD7aD~CXphz1Vw1ZDaXmZlI)v~~+{xbRCcg=>R`NiBDom8vXi;k+k1Ia$W zR6M-AfR?{>f^ZFl{_WkF;p?b;bno=uUVTGt?V<>jC_@Tk<|MZbDa}7GLO4v#s>R6t zVtl}sQ;ybD`apQwruE^WuxV!;Gw~L9KhADp4Vf7t5S3 zg0$&qY4>v+KOFX>o-+yx3iA84?kwmQV9|Dkf72C+=&(7t?RWyEW=!YWdT1+dugUv& zdhp?|Pg1=A*;|^ES?FN57=J4$&<}Q^ZT`6P_4YWn*Q!vRI)2zj+t7YYA!@wak&cxk5iBYZd4$Q zU>WfYZ<(uQ=py1+GUIOPT#%z7J@@8UB;N_0s?)6#lyU6Wv|KPbX2HVYy z%e|Fh4x!4-vB!Qxh0AM4sjdDdd>S6JKA}*dkl;S^=XUqd$@7L`Q}Kq5@}aD!ws;FN zPp}G4Jytw%>0LZpnTFYhF~#9H>>3Mn?)`b)4fkb@>*A;77{vP;I5`_`ZX8^HCTz!Q zL)E`IcX)sZU%%0)T?6M_nhPL~hYXu^G)E)YeQ01Uo<~B^Ym0`Gl?!8IV;G>g7LPd9 zHe0`n#h$*rnu%~}yxSN(gbt1kDW1xavI~&GG19Csq z#P(r#-dNmEl5%8iP_S7a{&^M+E3M#yYKPeAMJ@PNkhtw(h}hQ?z^y@wdjEsts(xD( zQz$?Vq5DDmhv$~Q?2cma*FLA$T>QFuDD*-3qyKe!+AmzkV{p`uX@9V+E#AJip$P?X z-gOy}#k{>OdE+{sH6uBU2m*QYt3Vdz$$oMT^?9Pwg?Qu}`{KQU4C?#XdWtnKt>{K~ z_3I%=qKD*;Df7O-_a+BOEs>B1A2P%Lu>D*fxKn$MC(MAZfh6+6o_Ujge7}WfuZ3sK zK&>wL(;_Sod89OZfUx|Do(9Vopcw;v%UQOu_4W0t&Rn1u=WT1?=V370e|j;$uF;ml zL8cBl$@fKK`_+-Gom-O~zrk@cg8zT+1l-g;H>=}7eyi^mxmx_)oX4ie z0Gjc8T=skF*INn931D$z?LcVPc6N3!TL5T<_>5wvrhLOFYh{_&q-g~z!+3fth~tx! ztH7G?L;hcf|5feVs0#s;Sd0(3Qcj<^KbJLm6^oV2Dm$cX4`MbA!?1o~1L!HN6)gGu zGC@#m#$rb#5ffSouN)sgHZ%eovWFC1OzcT}$NW4vP>k3sd$use6DJJ0E?3R0 zFLZVW*R4~iPaC#Hk;C3m$b#s{56_)DM+rV`I48Y#4Y}=l&M@NT{z0&B=6n|sOW6&| zB+L9*d5XedY+_cA!Gxd!{xpI??VexzyjYU9Y-{=1vuEo8e25EE02rY;WdEn+$4JHr zXDO$rPayylel@xG8mb0 z?m&?JN@{}1(%BwM;p|Dua_T>XHNv2R2=#p!Ofl8g8U_m$f{({O>_KM4R2*hLW3rdw z{Q6ubfG=scm17p*vivU5*>q|~bm|T-vdr^9bWW+UuI|lACakV~!U}JED63{fL#SV; z{8GFrXPtSahQc{y7C==T89?3#$SHmgpHUlY>yH@6mC!oxi05l-Ym~_I@yFV|2qy;B z{z?c6+9U^4y!HPEXDNq>DEVDC5N-Y8g;DXfm`iBkQ9*}U&ovo%9`cFxNIk+Zfm^3xk{rl4tpcJrA*^*WF`?O+%UXk3#iI^jsT0L=P2>EzBggIb>yE zaIir{cwu3{%ht_mDyF%F=Sj!b>ZLya!bp~qy>p+v`9K;xh+h5xgF)1Dxif=Ko;pu< zdoiXiBLWx9H-co7#4@fwZ8|^d$$s6SaM|rJQs|;!Uif}s@@&S2^4#Hl4;)4DW112J z+klpOe{<;_8B?mZL#yeknuZnjlQ2sp(2{WJ1gECds#`OTEP8WYCC+~4i+vk2lBkR< zbnqM2gpzydi5FyJZab(PgC|ql&Q`Nxr6$*G}H|W3O24K_36r4`T=1Z z-2qw8IYdE5^c4;AR`VbAkqk|tzLcDpPj)TVc7aT7r*ddWNJ|K;ChYeWgfnh9zYfY%xfed7}D8tS)Q;8vHFG#qzm*&RF24 zep^=01*?m?@QhfxV#N3#``D9P)x@78X8y?B(aSkC`8rOBJm@S=pOyr2<%6FxaPTOuydmr7y7Q!+z}KSP^%WBVr^L2iluGwc zqfxDU*Ps(OIMo7os}E3BK%$GcUkATq?%i+XB6JbFzqI=>zG<{4~ zS&T0lHCcEpFb-4LVZ+OHE6Pu7JE{}CuJ{qpZIS2MOJxUbD_wZT^f;dzMxcV5L{}M# zU+w%Q;s%Kx2x4jOvEw{2*fU<>X)PJ*-pOGYOdE6M{K$ey{`yze%`_E4?p{lO!Gw5z zO3)4Gg6w156$&HiI|&Dyk!>O;p)1Hz|^JlJVtHBoVXU! zT6w1}yLjfIZ2=8>Z9WZmP`G?TR!NEDo}4fI)X#XGyX`xw9sOeOyPIDY#U}N-bbR~v z?Z9ghP*L@uY?K0dGW#|Y4Sm&Mk(dY9zX<1=dCF`X`5oW}ZM_TB<1FwSrH$|832-OX zn^9(+poDjWi{31oE6l7eukOL7+1AV=Nopn+5s7J2K=l`e&Pj|?#gnTe&Bo)u(ZKrCt5OUAM9hpPHUrC(0w(6E5# zetp(x%V_2-1Lv&!xmRI`?7=y+I15hR#wCdZlKmg3IHT9MhOzOJ7cGC;6nQhMiJD<4 z>3$t6chqcbj@9Ot1&fYogN3Kq)mBbBe0kZg>{njAPwvod#q<#CL}dL$HRY8oBHk$C zUB(`=bmD5`CiI6-@p-tu_&4n*#9rKB?g>WW2Or$`!vM)oE0<9cc2V`c|63Ensnx(x(x27}m_FLLx$8x!m6vt6X|O3BnF zTvPXAX`=*Kcw!jyF__*hRD#uVU}&iA7k5(r_X>AF5=w}DD3@E%PAc}$WB#KtAN0DR zwoB*|5g8y+-08ZNJI>-$LCu>HD){GaGZa_kD0&xNBdw+qy_KAPj96xsfVh;-X#opQ zm>)QRYNhBn?tMN002b^Dc;E-9VS_`P#j-PZ_MEy9o)&d-yCVrZJQ!6(Z^d;TA>5>E zS$^;dz;fCQR$q4>YcoCUE?`gfeufZF4lA|(T96v?P3Z&znf*cq(`v1+SeH`=ZS|)jS;Y+u3;JEJ615Ak-(2*RT{qsC))kWLHZJZj zjT8icV9;^{N-f!L;}`mC6MlYihPTx`f1W6jRM1kdon7M>;4!?0&ar&gFkM3TrcPbO zhOt+uYM)q}r9>V;nky3M7Xxg<9zN_tJ0}e;tX9PC-+xpQphp;87NO+R@ z^Rxw9lb)iic>@NR;T!BY8i_-|9v_rhl%|{9zh?&i-lSIWtLl zLi*J!$JmVH=tM7GT=%zcw=KBKcIw7#2M8$l9Ky{znsS00lj#1qyUM(xnhy^Rs8H4f z(`L*@G}MlD3tFq3tG z81cva%LZYR_ij|gGT4+exd@n)Fc`{t$GRe3`p z%Zao;#9;K9F76m?R{|VgON;m=F|>iCbkw&#H@lw|;wq*-GXD5y6pZ4250%qYd_V1) zrS`Gykpjb~aqfXdim8KHDl&FwDWVfG6&9asxH)98pz^7LEbrAk%MBu9Nqwj_kDvX-$4&-1EYoIQtxz;GmmatiM zL7r4y9B~hiAIR82u4oAyx+RS!%^iO8%4}OKV%jgk{}@~$O$1o1lkcUEyrX@2{<4np zN~NJ-e75qA=h?HQ3Bb&ULHX^8S2I72;D4C7L4s1g;inT;Ry<9~#YgwpFedv=qRmlL zrk4^o8A8fsqSob;bL&FA;}BQv>}m!hybbeW91Cv=jP(QBT>(UIC{GefxwxT@A!X!P zM@0M7>h1+0u5S^i6gfDO)IvvvvL{<@r6ZQBzaM+uwk(AuW#B?Vcgvn^vGrqw?gy_p zr8CwWMATTStK*`vmT6LH%1&3;Q=01mk1I7eVc~xuR*Eiv+Om3jJ7|fW%`+WvP|Oad zyP|SzvSK%;*tGNoTEIk%68;SDkUG z1^?n6x3qLu+Ri<%vNrPDm)?5`!8ZkJInZZt$b*Sa|WS+BP&OSJ5tRVt798B)4e$gPUP;uQzxOZ)2VC0RT*vTpPke4q)jtW5<=ql4VzlRkkmG28swZSrA|ADq%+I~;phyyJ>Q zB7c-d?;qPq*Sl>yn?|IFHVBH$HQw!lkE5%anv~87iSQd0PwF2B3IiPgOH##k1aUUV zYU6D~IH`u|#g4!Y7nMQ&sF{j%C9BHDo{dXgV&`#dKmAEj z`C>;k3JHwyh;Xnp@@c){_osn(Z|s9-FoO;|JG(csuDR|_yy6{J8D8{MB%>)Ub*%SZ zHOA_`<;3uf_C;k_xQ`%&5pUu1KBaGEsqLh7;GIC(c9KKsOQQvnrDRakmPzTEWP>1s zCaBGfd*UyXwu5NhMH)Ub#3I&;0J{qT=U1^_#g~ezq(yJi31mKA9X7Cft+;?$5l$+d zO?$I^>u-LiZ78SdCD)riw28%+)Ged z;<|akZG1YH7oh_*K@?(+BYR6QV~M?hh?K7AoJf;2wX0!OC7G z$TN2oG0B$T7i=s(;VAJK=>!i=WZaFnD6vk?Aa4H^FNZ!G){-k()y%Cq!(f5Zkm8oP zo0_FbyFGd= zdXwcFKANQy|Mo=%{f4PjRKwWa491AQO9<}449LAg#7ekD?bS3A+J)Bl4M~jrgcWI+ z?aITc$?0^1-<0jKG*|yk_nmgO288*9n`+uWAAu>&Kr50+3YZ0q+LxLdg$DDr48fOlxG9lulAm@Dn3=%dpdP!wYRoi6=DOZv z-(JBdg;(Fc5N4Vwa2BDN$sS0^SX(32>3>2E+C%Zr@!%>eY&uGWuARl<91>JB8iO1` z{^L|r`FWTTs+sALQ*f2Jw;{wXlio=ZoJN>U&l)Y**>u6kOk`cwv z*toF1>_Wc8C{>UaUcwu%KX&f2U!5J2w{E;f=f+LzSG=viXb;E~sMtQ8T&&r%nCagn z>AY^iEX!Ka(D3_HLq|8$1 z`uh6be2`!%D@m4=z07UaCx@$=@nLW@kGfr|0t>%%B!J>eYfKlJlf+?}5>dY@QmC<5 ztPEk?U!>Q6EMOtTc0Y|inmC1x|J-LQyY5MP_-Xm=cv{GUp~D4*|8(3onnXk&K79(B zy<9*sNApYLEzQZ;i;IxY-meCI4xdUY?Do@g$2-}azVvy%G!Ok!O7uAiGlIGU%EOy5 zm`Z$ftY1&b{g>2-&{F~16z%_rSyv<^W8YI)NPA9%6CQQ zszO(7fVPxq9Nh%;8-G{(2Nl=(<-iv8vPMP*Gj6iWUKIp-kjn4MfaZg>&ex?;!qhKh zs=O$rh11PFo*@gyPBzC?Vd2^T##<^6#E!f0w@s#=W zjVWvkl@*AGXdaj-tCy7Z`Mf1)30tynYzceOPhV+G%ZVE$sL+8D+mTw( zjC%HOEa0R4ckmdUxQuVEJ+7Bc<&nj7Q*yWsD`VqTgVdI^?D3?$7(NF#pKBG>)zV?0 zH?R=G6+$=6E=cocc8Z4@w!(+m-Zjfw%V{b5J;KI~&%ajKz@o#@CVu|7YIZKJRG->L zO{(x>4ngAK4bT8ShCuu!Z?E00!F!%A_S1{>0HN^fzt9rb4*XsN_a;rP@Y>z`YsEt8 z<001enKQ_F+0v?n<9SSI(>}YX@SJl3#SICz#hzK+BZJSvjQ z>U{h%gnSJ4Q3}Fx6_Xd5s;WlLaOdhuEeK!#JEm_N1ix^T&_5D^M71Mmx+k4fwojF= zx@eyqlsd@-^;94U!)bnB`=&XW2nDzYT9 zd}w2(rrZh#n_f=rS3GFA3xj=tNdIfEVjo=$e6u`1ir4{kNagT#Q^Y8L2* zWTL%5q~(AN@kCO{iDWo|3pA`ws3&-+m5jp^#>|)vRw<6pf)^+jn2Ic%wbi7p258#m z;u;+MDm-;&N`gP@duD8-A7acz`FLpc-5k%)BgM89(nAF~xr>boe7HYM^}ZlZL_zSz z-m3TxBK+V@Gh3!OYSN)m=R32Bq^)4CPpHgHVP$w$-LC1y>cp`m;x*pHPFtx%vrOH3 z{*B2G40?0c4PxxQTMh0~xO=0HtB95N%MJV@Uvsj)xqPMpHS|Z2|GnhDzr8kn48Cc@ zG@&IKRiVaQ+*x~Y|HAf;)QO_Xpd8O^=czLCL7tfbc1CjE1w^@p2kf&?oBw<2!R z%hqnxGL}- zXkRB>ds&fY2KVf2K$hpK2;Gl5qC(iuADSI=q`3rKN`!Ao2+dNGHg{-ou9qi!aU5Kw zbXjh%V>~9)>oB0GX$@DeFk(Xa=y$PxI7`1jtCDflR5lmx*)A-F~MwbUGJo-uSA{~ zvPVS0#`ElOpt70b-aSDXp zG$l^wGL^3BI=>2Bqk$^9|EGD)VXb}e1LV6<0fKSIK1V>m#G2(ViBp0zf#2Gqy)`oi z)v{Cer93n71<1BI011qtW7HhNB5dTaWWT)-CR#z07nyrDs|fl~qP$(bd#&A-kifuS z2<;)s{QN=m>)B*2^hs`l`ankL^V`kaxQDie6m3;y+@@Cp%?G}+qRMwmf0_5`_hy^# z<8DRdH)a;0&jnPVOHTBMsCOP|bV$oT=^|B|mE4 zycFe3LHpt~r?MjHn2+5?by)p<$3N8TY<2v3YT;>GFQq2m$UB+}8LY7>%U{cdd$y9U z6pm&l7TioN4>}FAPyV!x21OqMad;(QJ!7Tz1h_kJgIPEX6LPZYK!KUp%~OlQ^GA1H z=mQh-Zd~b~fQ`(1Sk>g3vcW(v2=5hFXP05bZ*LW}odKnu)g#)KzM;rJPOv z6fqM}nvoKdA0~hcjCdhYHJB3I9LpTBP_+fdHgu~fpcZZe`2&F~@NcmP-)zQ^Yy90A z{Z{E235IpVz&@V9&hKX9qL!zvNtttOc1%}E&K`hluD9}xGxPqn${gi@Jn@pW+AW@=C3k+#T^OrjYd9%V@ zH(J}rInf!JvcNb4snBnt!2cZ&l2dr2V7ETekQTg)d`aBM83HGqY-Tx2Ja@4e;cphB*-B%Z?|srn*< z+MBlVN_I3gBh{_{Ruzm;4=xHOy`On#-W|$TH=Sy=9*}qHU7Hu(8GVx|mGG^eBNW zfQuL;tQZuSYfzt1fqoRm4T1)}nT4kl$ z@PMg5XMz4Rm!Ih-&97h^zQRSVVX+4_?s+4o7nu|J(aan2Rb4ah*KNanQjxX+XApk+ zn|s$DUSQ76V9?&o5Fnj?+cy58V1tyn;#p8`3d$}wq2yGTr=!MObTfnARG47_kDtuW z&_cZrh=T^pxX?GQ2wh&fu}@a-cGaoT9uEh5MI?9w~43kDjc zMXC6&X(t(~kjeSK0wxXbJsdG5J^Xh6^V12}s=FY($U&BzqK)>KiR$$>)_e3>C#=91 zUun>)^h77ql_~~Tcxmaz9K$p_rLh_1F4Sr;)g{(tZqG3_K?<-cOeKo_X*crhH;eV{ zk=~kg=iy)=9n#+T@I8BrcWFqcODDz&bmE@w!Y+V^7@<5t-6xCng6U*tkJ_&SlgZTv z#Xa~hTG20ImGn8Dc_XhFc=E>I&DwHzOh@W$D=1^9on8~%=zPL&y8NBf!(?bB?tT|Gftcr5s6(t7Fu^Q#lIVPpb3Tk^|?6@ zhP`9jobYLeI~wpb23mO*%vkH-`~lRdQM}nZ{XE61&hhieme|3su+xHj`9BYl#aR~( zx1QL?J$D7B?E{&%`K>S+4=Pk~g1Y)QuN6Nt4b;ZnsxF__=IBW)%!41gDSt!B2X!T{ z#1pBRNY{%}?Q=Z!j7xTeaT}o9q)ma#^ArF3+c4Q`V|VoHD?C}Qq+s10W{?uh$G`ji zdkHH7xHRBRl0I;noaXkca$yM(rDZBkL27CG96nrSE=zPg09ApB>Y+V$-Exz<_MnS= zN!l)mm|@T{9^17B7APvv(a2<|5_(YUi!^#RC9~eNtWa-gXgDTrbm`8#WPkP6xY~6lsIE#WTYFTE z!1ROY61Np-4o^w8h*R&W{q!?KE}<=?c?Z#IkW#dy9<8_v-ALu=MsLJA^|OhdEGCo8 zQwU`mVRr!`Z3h+IFEy7iKACF%DM*Vb<$yC_3SrSdqw!pT%0{!9_5~#l?W_33!L2vA zkdP21!d~}4EP|fVi=9#X6Rzd|@&_ ztMs|Zgv)Rsy0zHy*$&T`9VhK6g4<)Jzl6haxg{&|jD64T=mC5Oh5-n`$_pfurx^N0(ZdJd0S z3b3skU{L0J(H*}Z?wCAZ>%?we&v%Cq2_}GkK{kKD8}&UlxF-X*BYJaV$jc-M7`xuOSiUL|ow z@JZybKDgge^FNo)lO522Ot!3PTQ(K`xSgAQlk;m#fV*VSLE&N`$hogT-uAf$NtmRd0>M2WHk^J0GhcdMwc-0KV`WZV-~0=3MYcMbvt%%75HS5piz<4*>wKH^UpqO23I2+Ps_R_XJYCS% zgM)IRzYm3noL5cjg+;V*e_d$>ltT~3*O9dJPzNGc3H);BO^|mBfqVg0_8K@CW?E5d z=C8f?3u66eu*F?+;8H$cP6a;i4bVeQ9w7+ilrQUh`sQ>E=#qZHzdP*I-=MWg^EKr3<(A%@q@_py10K_^4 zywT?0hEx3JrnmAQEn644RdwfQgb%=YpNBz^MuMjKPA{(z3@GcSK{|6|>+fHCDgF* z+28Nx64VexT+pwPR-jbXI1Ri10i(yw=P&+N0P!EJ9R5`&SmVeh6GMZ^NH&hLSD*;GJ&^M0`-wjB&kqeCBgnGf~z z!hatg9+Jwo96AmXxCT*m+cwwu-z`O^DeZafXsLp_aFC<%Qo6Q(>Md~OcaG%Lx7Od^ zmT_7*??d=Ldx-t|jlS+3!&}4g5%nRb#k?)A<)zo$jn6nAawUNaeUq&_E1BXuOuUH; zg%5$T4hg6P_5RJfh|(zBlok1UNW$)Z#Olb<48CG^CUo21-+yts&eKic{O?~=+#Ms5#-spFdGVjU!GaoSR-TOW zRb?SY*ECM8i!PnIb0fX5RsfjG5$}D&3+h`I@gm*bx4QEEBuj|VFyYJY{yMHLW}bK> zxEtxkqPU5Xe;2Q+5jx1UeM8Z&aiVOJ4v3B|8d`vWNnROSf|>EFPp{Rs$~5)nrLii{ zm}##rsCLeJ_;<$>T{|_UtJm3X9<1+9@xNGX;M|*bNT_hQilFu(5=TrP0@XPhyNpJa zMw9VdPV3$QJ7v#|=kZ&hcVV%TZ3yJnZ{uw)-QkM6dTDR|;Bqc62&P*{1D4SZ5l-VJ z^|dl(D}bC*P*7MA$!E*T@#2Xm6&6|TCcx$hT^^<(Y#Sj$Cd{vcxu`c)vf|;(UA*(S zc#hLmc8jHDr9G*yaO0)Rb%{Iv!_x#`-$&5i?n8XqEk@8JUvkGj4yXkFfq7cl;`k_tc);VLEk-3o6^ASm-3C8 z3lV1pXLfgMy|Jnhk)XXbO8&y${NQ0O7yl2HW(t-yu(Tuh(?+nTp2dW3tF-a(C{V8> z-LQ8*bXn#^RfVr`k#f|*V7T{b*ZIH z%X@}LN{*sgTvcFmyx^Z=UlxOM`sqhA2D*eABcUU2Mf82PD{$xW`wGhHrH!U@V61^( z)i_x(wXC4PCO>qrUEX_Q^QMeU16+Tp5pw*I&213N>pUEvH227TT&R!t35+wJmbAcSU+umLIZLr~noBw&2fQcyO6!e5KZ9CWslsxDC0%*U*+# z5tA>QN&y}1ZE#Q3xB4f2rI&c{;a+vgm$)E-W{dSbXh`P&F3mv4?F%%ghR{u@8Vf6& zU|{(?F8zuislg`IZX4$WkZr&()@ zYLz{Po$-NY7G?!<5=SrWdKxHnO7LgMJwpivW~r&7z?wGj{)hMUl~qU{Y_3VlEf>}< zdBPk2;+aczBVf?!mim!ssuwXE!pii5WKj&271{dH3mEq^I%Uw^c8rFS;CgTPeWx0* z!#f)_0YHwX74|hbi}epc;pyZ>m!w0+aGONLy$gss}Ko#!XlD z31|x5z`$U^&Q6pNq!zcV=7%Bxh2~KCV(k9u$gll7KO`bA_yrY1DB)9JeP;P8W9Lyq zIM2Rl@eb=;we#3BB}Nr6Blv0Z4x|aZWao2WNqBmETPSb(Za#Y!H4`-Yv%vjT_e`~= zLT-9GJ$k#-60GQ`<1M^Zk!e!t@y8K@(>ZltBeRCa##PWAy}gPJ^YD-iGwXHz{rmUI zZZ*o)DZv9IyMGyuwm~#9TD;MT3;1qT4yp(UfYh^|GocgRqQ|`N9K_L#54vyz`Si9Q zOw`Icc*5l8AoTs_h`o3ig3M>cQ^eJ5>h8&;aTev&^%++qRlvS z$4{TcfoN{jUVwxl04Z5JH=+qv{#x)+o+Sl3m=d~ls^yS1${&G-N(URq{Jh0(#cSma|$CK0pZxyh~KX?N% zE7)umjcXNXw8}X_|NI>Hw(66xmLX_>@7fF0`n7F+F#!xC7#Onw<9O&huMY13KmF7@ z_+ui<^=Rhc>h2gPGzWd?2HnJ#oemZf`n=%;)Np!D8Zj)z3CJE)_?tz%euU(K!?W!;5&q92>u5i7==3AOwy-h}l)((RwO) zdU;htoz+wVI>~*!L9n&{Ikh~1Ga9qQ;;)M8>Wn}%0VCYvYi8i>Rp0W`=P9ptn8KU5 z(+X*oQUQ}4VPFQnQ$fjQ<~i~@!O{rw8yRUIE3TxJ7hSx+1qknm;|2`MkC#4JuH68# z2=9h;6;aG6w_3KXn4GnF1%-g#jR2^zX>V#8U3$4i-jNN=F%F^!K@iIURTNe|2YBl> z1ZG)r@3Z-rRwfwKN{Lb7yzkX;503qPLy;0o?Ujj(x@4fI%m;kvk zPvV!cuJQ59TJ#V2HPC2rs*6Xvh4PlYza|<0MIs~6lAiI~n!k0?*6Lw9&;SyIaH{#r zS>oeXw=GmHEfe^6g~dNb2eI$FNT`lV5!lkC}7eC;JG?Oqy9*J(vtWZSO`3e%%ytr@mwLoe~{qNR>t)>6vfgirCxKi%&g8v62Es!KA4c<$V}fvU$_IM1gu z;B}0^XX;njBCqzEG;mToS9=&Dw84F+G0)k7+qQ472I@^D*wSEKa6bq__?>90oCOb( zd=4M;QA1AplT8;k$y56KNQNIv&OG}wE=(8$@b0F@Qn=K3+R#WS-p{!-A$Tv=bxOiH zIHPt#RKT_GI1P-kO=;vsvQkweR`#Y(S`c$v%%k)#R@6w<-6f}UaJygJJO#JhzjFQy z5(!zM*?wAEYh@0xZH1zRmB}{#VFb&#ar1_JM$HmJy?c|6Q1sJH!fsfiyPYHk(0aI@ z_!V&mU7B2n9))^9U&o2DSdo2nw5M_763ykOc0VlS%QgSz-0B8 z3vE-abrB4C`Hqufmzxb6m%j)+;=YxWLxnVvD} ziMIy{jc!5QYYp|6ifSq=Z$Ij+fi0jYQa40ow++>0snqYkKzr5IWm$6TaMmU#BC#6c z9Hp9-Up($Qh*PS-oTOT1w93n`d3M6p&`fUrw;rcZe<;X!KH(CTYF;I)=9<62iIt3D zILRI~7y7l^CGBlxVq{-ig}rXpv0Wqf;ScoJc)q#2+kwXDfSfn!rhgcmls;qP%|$Z! zn^x7n#7eno);&sF75ijGb=!Ho!I%{T*!e7XZ+wIVITkbeSyRj-SaFYgszqLGFJSgR zQKrJi$q#5JIouLDJ`cYmai@+5$}V2qv?18*Y><9tYBbxR}W(O;fkW*Z4bXP&aw zvk+Mj8@0j9cPuUjYz9^!^(;{ft^!q52y$%&SnT zhDKq2FUM+ibak)2cSu@dgANAY(Oi>WQCpiOlcpdIQVxK;1cC8AtD+o=90QocOI&E) zJM@>?2sV(ZGIca8Vk5e-eEOIs&m8+~I6FSVrxpEb6Rq@N@A@h;%L?D z+M0@}==)en`uPVxD$f{b%XqQyw9Vn_ODk^mq!}RJc6I#SSQL1yfNAg7X>rH*Ug~mc zuDPYs03i@G^}yG@h;D>!5$Ac7noXl^b4r-MHvet~pov80Ygj9*<7O2XQ!|sWDxhc7 zniK>fDFb<4@)E6_91^l9$E&BBjgyl|bs_BRiD?3zx(~%0(2>^^7oX1r3{{FkP6KC~ z75Q%Gqp4nAUQjfqMJm5Ax|W`=$!5>Ym=Ax8Aq#o1pl(X(4)SbH`~I*2&vI-a?fN&p zd5vCSQPLF|)FPYhDpL-J0D_JQftM;FhfL}9(f&OD?(%ILEM(GfEg;#AwR3x6G*o143S z&qL(}Lz8qhWPbWjv^oa5V|N=CSLyvtt{&xx#kJO1f@wQ$E}*(>`nVcta_TVi5iS~g zLR}fdhDqr*K-{3&2|NuHNs@!oNhmp#Y5Tl+PU9?03_jYr7mp!*=JWYGYT!9#WF%)@ zIw(g_CkZKqlQ+)m>FFJ-p9#oV3NEmPQOxh9lHh~3vfi*u&)j1Nxo&4dA)f0ekUH6x z)?8xk%bfR%Ksh^$ z2atgw4gLLF>z`Pki*>s|w#51#S;q@7gLUj&KS#g}*3VRMH2&Y51OA4CD(?MV%U2*L PyI}(!2W3G<7sLMt+b+FP literal 0 HcmV?d00001 diff --git a/polaris.shopify.com/src/data/props.json b/polaris.shopify.com/src/data/props.json index 91860668443..341dd860c45 100644 --- a/polaris.shopify.com/src/data/props.json +++ b/polaris.shopify.com/src/data/props.json @@ -10958,6 +10958,56 @@ "description": "" } }, + "ButtonGroupProps": { + "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "name": "ButtonGroupProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "spacing", + "value": "Spacing", + "description": "Determines the space between button group items", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "segmented", + "value": "boolean", + "description": "Join buttons as segmented group", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "fullWidth", + "value": "boolean", + "description": "Buttons will stretch/shrink to occupy the full width", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "connectedTop", + "value": "boolean", + "description": "Remove top left and right border radius", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Button components", + "isOptional": true + } + ], + "value": "export interface ButtonGroupProps {\n /** Determines the space between button group items */\n spacing?: Spacing;\n /** Join buttons as segmented group */\n segmented?: boolean;\n /** Buttons will stretch/shrink to occupy the full width */\n fullWidth?: boolean;\n /** Remove top left and right border radius */\n connectedTop?: boolean;\n /** Button components */\n children?: React.ReactNode;\n}" + } + }, "CalloutCardProps": { "polaris-react/src/components/CalloutCard/CalloutCard.tsx": { "filePath": "polaris-react/src/components/CalloutCard/CalloutCard.tsx", @@ -23026,46 +23076,6 @@ ], "value": "interface SectionProps {\n divider?: boolean;\n children?: ReactNode;\n title: ReactNode;\n}" }, - "polaris-react/src/components/Modal/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "flush", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "subdued", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "titleHidden", - "value": "boolean", - "description": "", - "isOptional": true - } - ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\n flush?: boolean;\n subdued?: boolean;\n titleHidden?: boolean;\n}" - }, "polaris-react/src/components/Navigation/components/Section/Section.tsx": { "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "name": "SectionProps", @@ -23129,6 +23139,46 @@ ], "value": "export interface SectionProps {\n items: ItemProps[];\n icon?: IconProps['source'];\n title?: string;\n fill?: boolean;\n rollup?: {\n after: number;\n view: string;\n hide: string;\n activePath: string;\n };\n action?: {\n icon: IconProps['source'];\n accessibilityLabel: string;\n onClick(): void;\n tooltip?: TooltipProps;\n };\n separator?: boolean;\n}" }, + "polaris-react/src/components/Modal/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "flush", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "subdued", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "titleHidden", + "value": "boolean", + "description": "", + "isOptional": true + } + ], + "value": "export interface SectionProps {\n children?: React.ReactNode;\n flush?: boolean;\n subdued?: boolean;\n titleHidden?: boolean;\n}" + }, "polaris-react/src/components/Popover/components/Section/Section.tsx": { "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", "name": "SectionProps", @@ -24613,21 +24663,21 @@ "description": "" } }, - "CheckboxWrapperProps": { - "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx": { - "filePath": "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx", - "name": "CheckboxWrapperProps", + "ToastManagerProps": { + "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx": { + "filePath": "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx", + "name": "ToastManagerProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx", + "filePath": "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", + "name": "toastMessages", + "value": "ToastPropsWithID[]", "description": "" } ], - "value": "interface CheckboxWrapperProps {\n children: ReactNode;\n}" + "value": "export interface ToastManagerProps {\n toastMessages: ToastPropsWithID[];\n}" } }, "RowStatus": { @@ -24718,6 +24768,23 @@ "value": "export interface RowProps {\n children: React.ReactNode;\n id: string;\n selected?: boolean;\n position: number;\n subdued?: boolean;\n status?: RowStatus;\n disabled?: boolean;\n onNavigation?(id: string): void;\n onClick?(): void;\n}" } }, + "CheckboxWrapperProps": { + "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx": { + "filePath": "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx", + "name": "CheckboxWrapperProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ReactNode", + "description": "" + } + ], + "value": "interface CheckboxWrapperProps {\n children: ReactNode;\n}" + } + }, "ScrollContainerProps": { "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx": { "filePath": "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx", @@ -25219,341 +25286,341 @@ "value": "export interface TextOptionProps {\n children: React.ReactNode;\n // Whether the option is selected\n selected?: boolean;\n // Whether the option is disabled\n disabled?: boolean;\n}" } }, - "CloseButtonProps": { - "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx": { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "name": "CloseButtonProps", + "ItemURLDetails": { + "polaris-react/src/components/Navigation/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "name": "ItemURLDetails", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "titleHidden", - "value": "boolean", + "name": "url", + "value": "string", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "" - } - ], - "value": "export interface CloseButtonProps {\n titleHidden?: boolean;\n onClick(): void;\n}" - } - }, - "DialogProps": { - "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx": { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", - "name": "DialogProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "labelledBy", - "value": "string", + "name": "matches", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "instant", + "name": "exactMatch", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", + "name": "matchPaths", + "value": "string[]", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "limitHeight", + "name": "excludePaths", + "value": "string[]", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "external", "value": "boolean", "description": "", "isOptional": true + } + ], + "value": "interface ItemURLDetails {\n url?: string;\n matches?: boolean;\n exactMatch?: boolean;\n matchPaths?: string[];\n excludePaths?: string[];\n external?: boolean;\n}" + } + }, + "SubNavigationItem": { + "polaris-react/src/components/Navigation/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "name": "SubNavigationItem", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "syntaxKind": "PropertySignature", + "name": "url", + "value": "string", + "description": "" }, { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "large", + "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/Modal/components/Dialog/Dialog.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "small", + "name": "new", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "MethodSignature", - "name": "onClose", - "value": "() => void", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", - "syntaxKind": "MethodSignature", - "name": "onEntered", - "value": "() => void", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", - "syntaxKind": "MethodSignature", - "name": "onExited", + "name": "onClick", "value": "() => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "in", + "name": "matches", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "fullScreen", + "name": "exactMatch", "value": "boolean", "description": "", "isOptional": true - } - ], - "value": "export interface DialogProps {\n labelledBy?: string;\n instant?: boolean;\n children?: React.ReactNode;\n limitHeight?: boolean;\n large?: boolean;\n small?: boolean;\n onClose(): void;\n onEntered?(): void;\n onExited?(): void;\n in?: boolean;\n fullScreen?: boolean;\n}" - } - }, - "FooterProps": { - "polaris-react/src/components/Modal/components/Footer/Footer.tsx": { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", - "name": "FooterProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "primaryAction", - "value": "ComplexAction", - "description": "Primary action", + "name": "matchPaths", + "value": "string[]", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "secondaryActions", - "value": "ComplexAction[]", - "description": "Collection of secondary actions", + "name": "excludePaths", + "value": "string[]", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to display inside modal", + "name": "external", + "value": "boolean", + "description": "", "isOptional": true } ], - "value": "export interface FooterProps {\n /** Primary action */\n primaryAction?: ComplexAction;\n /** Collection of secondary actions */\n secondaryActions?: ComplexAction[];\n /** The content to display inside modal */\n children?: React.ReactNode;\n}" + "value": "export interface SubNavigationItem extends ItemURLDetails {\n url: string;\n label: string;\n disabled?: boolean;\n new?: boolean;\n onClick?(): void;\n}" } }, - "ItemURLDetails": { + "MatchState": { "polaris-react/src/components/Navigation/components/Item/Item.tsx": { "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "ItemURLDetails", - "description": "", + "syntaxKind": "EnumDeclaration", + "name": "MatchState", + "value": "enum MatchState {\n MatchForced,\n MatchUrl,\n MatchPaths,\n Excluded,\n NoMatch,\n}", "members": [ { "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "", - "isOptional": true + "name": "MatchForced", + "value": 0 }, { "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "matches", - "value": "boolean", - "description": "", - "isOptional": true + "name": "MatchUrl", + "value": 1 }, { "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "exactMatch", - "value": "boolean", - "description": "", - "isOptional": true + "name": "MatchPaths", + "value": 2 }, { "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "matchPaths", - "value": "string[]", - "description": "", - "isOptional": true + "name": "Excluded", + "value": 3 }, { "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "excludePaths", - "value": "string[]", - "description": "", - "isOptional": true - }, + "name": "NoMatch", + "value": 4 + } + ] + } + }, + "CloseButtonProps": { + "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx": { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "name": "CloseButtonProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", "syntaxKind": "PropertySignature", - "name": "external", + "name": "titleHidden", "value": "boolean", "description": "", "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "" } ], - "value": "interface ItemURLDetails {\n url?: string;\n matches?: boolean;\n exactMatch?: boolean;\n matchPaths?: string[];\n excludePaths?: string[];\n external?: boolean;\n}" + "value": "export interface CloseButtonProps {\n titleHidden?: boolean;\n onClick(): void;\n}" } }, - "SubNavigationItem": { - "polaris-react/src/components/Navigation/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "SubNavigationItem", + "DialogProps": { + "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx": { + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "name": "DialogProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", "syntaxKind": "PropertySignature", - "name": "url", + "name": "labelledBy", "value": "string", - "description": "" + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "" + "name": "instant", + "value": "boolean", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", + "name": "children", + "value": "React.ReactNode", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", "syntaxKind": "PropertySignature", - "name": "new", + "name": "limitHeight", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "syntaxKind": "PropertySignature", + "name": "large", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", "syntaxKind": "PropertySignature", - "name": "matches", + "name": "small", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "exactMatch", - "value": "boolean", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "syntaxKind": "MethodSignature", + "name": "onClose", + "value": "() => void", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "syntaxKind": "MethodSignature", + "name": "onEntered", + "value": "() => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "matchPaths", - "value": "string[]", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "syntaxKind": "MethodSignature", + "name": "onExited", + "value": "() => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", "syntaxKind": "PropertySignature", - "name": "excludePaths", - "value": "string[]", + "name": "in", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", "syntaxKind": "PropertySignature", - "name": "external", + "name": "fullScreen", "value": "boolean", "description": "", "isOptional": true } ], - "value": "export interface SubNavigationItem extends ItemURLDetails {\n url: string;\n label: string;\n disabled?: boolean;\n new?: boolean;\n onClick?(): void;\n}" + "value": "export interface DialogProps {\n labelledBy?: string;\n instant?: boolean;\n children?: React.ReactNode;\n limitHeight?: boolean;\n large?: boolean;\n small?: boolean;\n onClose(): void;\n onEntered?(): void;\n onExited?(): void;\n in?: boolean;\n fullScreen?: boolean;\n}" } }, - "MatchState": { - "polaris-react/src/components/Navigation/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "EnumDeclaration", - "name": "MatchState", - "value": "enum MatchState {\n MatchForced,\n MatchUrl,\n MatchPaths,\n Excluded,\n NoMatch,\n}", + "FooterProps": { + "polaris-react/src/components/Modal/components/Footer/Footer.tsx": { + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "name": "FooterProps", + "description": "", "members": [ { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "MatchForced", - "value": 0 - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "MatchUrl", - "value": 1 - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "MatchPaths", - "value": 2 + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "syntaxKind": "PropertySignature", + "name": "primaryAction", + "value": "ComplexAction", + "description": "Primary action", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "Excluded", - "value": 3 + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "syntaxKind": "PropertySignature", + "name": "secondaryActions", + "value": "ComplexAction[]", + "description": "Collection of secondary actions", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "NoMatch", - "value": 4 + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The content to display inside modal", + "isOptional": true } - ] + ], + "value": "export interface FooterProps {\n /** Primary action */\n primaryAction?: ComplexAction;\n /** Collection of secondary actions */\n secondaryActions?: ComplexAction[];\n /** The content to display inside modal */\n children?: React.ReactNode;\n}" } }, "PrimaryAction": { @@ -26484,6 +26551,139 @@ "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", + "name": "ResizerProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", + "syntaxKind": "PropertySignature", + "name": "contents", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", + "syntaxKind": "PropertySignature", + "name": "currentHeight", + "value": "number", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", + "syntaxKind": "PropertySignature", + "name": "minimumLines", + "value": "number", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", + "syntaxKind": "MethodSignature", + "name": "onHeightChange", + "value": "(height: number) => void", + "description": "" + } + ], + "value": "export interface ResizerProps {\n contents?: string;\n currentHeight?: number | null;\n minimumLines?: number;\n onHeightChange(height: number): void;\n}" + } + }, + "HandleStepFn": { + "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx": { + "filePath": "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "HandleStepFn", + "value": "(step: number) => void", + "description": "" + } + }, "TooltipOverlayProps": { "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx": { "filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx", @@ -26554,15 +26754,6 @@ "value": "export interface TooltipOverlayProps {\n id: string;\n active: boolean;\n preventInteraction?: PositionedOverlayProps['preventInteraction'];\n preferredPosition?: PositionedOverlayProps['preferredPosition'];\n children?: React.ReactNode;\n activator: HTMLElement;\n accessibilityLabel?: string;\n onClose(): void;\n}" } }, - "HandleStepFn": { - "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx": { - "filePath": "polaris-react/src/components/TextField/components/Spinner/Spinner.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "HandleStepFn", - "value": "(step: number) => void", - "description": "" - } - }, "MenuProps": { "polaris-react/src/components/TopBar/components/Menu/Menu.tsx": { "filePath": "polaris-react/src/components/TopBar/components/Menu/Menu.tsx", From 7288b9d041886002ac465480250256c7b2230c3f Mon Sep 17 00:00:00 2001 From: aveline Date: Wed, 28 Sep 2022 09:11:28 -0700 Subject: [PATCH 15/25] Update `AlphaCard` border radius to a boolean (#7287) ### WHY are these changes introduced? Based on conversation around `Card` https://github.com/Shopify/polaris/discussions/7195#discussioncomment-3737800 ### WHAT is this pull request doing? Border radius on the `AlphaCard` component is now a boolean so a card can either have no border radius or a border radius of `2` from the border radius token scale. No change to the responsive border radius behaviour, a card can switch from no border radius to border radius of `2` at a breakpoint that's passed in as a prop. --- .changeset/fast-candles-approve.md | 6 ++++++ .../components/AlphaCard/AlphaCard.stories.tsx | 4 ++-- .../src/components/AlphaCard/AlphaCard.tsx | 15 +++++++-------- .../content/components/alpha-card/index.md | 8 ++++---- ...s.tsx => alpha-card-without-border-radius.tsx} | 2 +- 5 files changed, 20 insertions(+), 15 deletions(-) create mode 100644 .changeset/fast-candles-approve.md rename polaris.shopify.com/pages/examples/{alpha-card-border-radius.tsx => alpha-card-without-border-radius.tsx} (95%) diff --git a/.changeset/fast-candles-approve.md b/.changeset/fast-candles-approve.md new file mode 100644 index 00000000000..e79f2d049a7 --- /dev/null +++ b/.changeset/fast-candles-approve.md @@ -0,0 +1,6 @@ +--- +'@shopify/polaris': patch +'polaris.shopify.com': patch +--- + +Updated `AlphaCard` border radius to a boolean diff --git a/polaris-react/src/components/AlphaCard/AlphaCard.stories.tsx b/polaris-react/src/components/AlphaCard/AlphaCard.stories.tsx index e9c0533022a..0c85ff5d39d 100644 --- a/polaris-react/src/components/AlphaCard/AlphaCard.stories.tsx +++ b/polaris-react/src/components/AlphaCard/AlphaCard.stories.tsx @@ -32,9 +32,9 @@ export function BackgroundSubdued() { ); } -export function BorderRadius() { +export function WithoutBorderRadius() { return ( - + Online store dashboard diff --git a/polaris-react/src/components/AlphaCard/AlphaCard.tsx b/polaris-react/src/components/AlphaCard/AlphaCard.tsx index 814feefbb09..9459390efe4 100644 --- a/polaris-react/src/components/AlphaCard/AlphaCard.tsx +++ b/polaris-react/src/components/AlphaCard/AlphaCard.tsx @@ -17,7 +17,7 @@ type CardElevationTokensScale = Extract< type CardBackgroundColorTokenScale = Extract< BackgroundColorTokenScale, - 'surface' | `surface-${string}` + 'surface' | 'surface-subdued' >; type Breakpoint = 'xs' | 'sm' | 'md' | 'lg' | 'xl'; @@ -26,28 +26,27 @@ export interface AlphaCardProps { /** Elements to display inside card */ children?: React.ReactNode; backgroundColor?: CardBackgroundColorTokenScale; - borderRadius?: BorderRadiusTokenScale; + hasBorderRadius?: boolean; elevation?: CardElevationTokensScale; padding?: SpacingTokenScale; roundedAbove?: Breakpoint; } -const defaultBorderRadius = '2'; - export const AlphaCard = ({ children, backgroundColor = 'surface', - borderRadius: borderRadiusProp = defaultBorderRadius, + hasBorderRadius: hasBorderRadiusProp = true, elevation = 'card', padding = '5', roundedAbove, }: AlphaCardProps) => { const breakpoints = useBreakpoints(); + const defaultBorderRadius = '2' as BorderRadiusTokenScale; - let borderRadius = !roundedAbove ? borderRadiusProp : null; + let hasBorderRadius = !roundedAbove && hasBorderRadiusProp; if (roundedAbove && breakpoints[`${roundedAbove}Up`]) { - borderRadius = borderRadiusProp; + hasBorderRadius = true; } return ( @@ -55,7 +54,7 @@ export const AlphaCard = ({ background={backgroundColor} padding={padding} shadow={elevation} - {...(borderRadius && {borderRadius})} + {...(hasBorderRadius && {borderRadius: defaultBorderRadius})} > {children} diff --git a/polaris.shopify.com/content/components/alpha-card/index.md b/polaris.shopify.com/content/components/alpha-card/index.md index 1f1d642accf..464020eaa2d 100644 --- a/polaris.shopify.com/content/components/alpha-card/index.md +++ b/polaris.shopify.com/content/components/alpha-card/index.md @@ -29,10 +29,10 @@ examples: - fileName: alpha-card-subdued.tsx title: With subdued for secondary content description: Use for content that you want to deprioritize. Subdued cards don’t stand out as much as cards with white backgrounds so don’t use them for information or actions that are critical to merchants. - - fileName: alpha-card-border-radius.tsx - title: Border radius - description: Border radius can be adjusted when cards are nested, or added after a certain breakpoint. + - fileName: alpha-card-without-border-radius.tsx + title: Without border radius + description: Border radius can be toggled off, or added after a certain breakpoint. - fileName: alpha-card-flat.tsx title: Elevation - description: Border radius can be adjusted when cards are nested, or added after a certain breakpoint. + description: Elevation can be set to flat --- diff --git a/polaris.shopify.com/pages/examples/alpha-card-border-radius.tsx b/polaris.shopify.com/pages/examples/alpha-card-without-border-radius.tsx similarity index 95% rename from polaris.shopify.com/pages/examples/alpha-card-border-radius.tsx rename to polaris.shopify.com/pages/examples/alpha-card-without-border-radius.tsx index f8177ad5349..cd731241ad2 100644 --- a/polaris.shopify.com/pages/examples/alpha-card-border-radius.tsx +++ b/polaris.shopify.com/pages/examples/alpha-card-without-border-radius.tsx @@ -5,7 +5,7 @@ import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; function AlphaCardExample() { return ( - + Online store dashboard From 6188a0bcc572cbf2597afb0702234ec63b2159c0 Mon Sep 17 00:00:00 2001 From: Lo Kim Date: Thu, 29 Sep 2022 11:29:01 -0400 Subject: [PATCH 16/25] [Layout foundations] Refactor `Box` and update `Toast` to use `Box` (#7279) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### WHY are these changes introduced? Resolves #7134. [Storybook URL](https://5d559397bae39100201eedc1-bongofonfc.chromatic.com/?path=/story/all-components-toast--default). An earlier [prototype](https://github.com/Shopify/polaris/pull/7096) explored adding `className` support to the `Box` component and keeping it as an internal component. This prototype explores keeping `Box` external without the `className` prop and replacing custom divs in `Toast` with the `Box` component. Even if we don't update `Toast` yet, there are some commits in this PR I'd like to keep that cleans up some of the types and prop descriptions in the `Box` component. ### WHAT is this pull request doing? - Cleans up types and updates prop descriptions in `Box` - Adds `color` and `maxWidth` support to `Box` - Updates `Toast` to use `Box` where custom `div` are being used
Toast original Toast original
Toast refactored with Box Toast refactored with Box
### How to 🎩 🖥 [Local development instructions](https://github.com/Shopify/polaris/blob/main/README.md#local-development) 🗒 [General tophatting guidelines](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md) 📄 [Changelog guidelines](https://github.com/Shopify/polaris/blob/main/.github/CONTRIBUTING.md#changelog)
Copy-paste this code in playground/Playground.tsx: ```jsx import React, {useState, useCallback} from 'react'; import {Page, Frame, Toast, Button} from '../src'; export function Playground() { const [active, setActive] = useState(false); const toggleActive = useCallback(() => setActive((active) => !active), []); const toastMarkup = active ? ( ) : null; return ( {toastMarkup} ); } ```
### 🎩 checklist - [ ] Tested on [mobile](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md#cross-browser-testing) - [ ] Tested on [multiple browsers](https://help.shopify.com/en/manual/shopify-admin/supported-browsers) - [ ] Tested for [accessibility](https://github.com/Shopify/polaris/blob/main/documentation/Accessibility%20testing.md) - [ ] Updated the component's `README.md` with documentation changes - [ ] [Tophatted documentation](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting%20documentation.md) changes in the style guide Co-authored-by: Kyle Durand --- polaris-react/src/components/Box/Box.scss | 4 ++ polaris-react/src/components/Box/Box.tsx | 80 ++++++++++++----------- 2 files changed, 46 insertions(+), 38 deletions(-) diff --git a/polaris-react/src/components/Box/Box.scss b/polaris-react/src/components/Box/Box.scss index 56d8ad77a91..90bfeff869f 100644 --- a/polaris-react/src/components/Box/Box.scss +++ b/polaris-react/src/components/Box/Box.scss @@ -10,10 +10,12 @@ --pc-box-border-left: initial; --pc-box-border-right: initial; --pc-box-border-top: initial; + --pc-box-color: initial; --pc-box-margin-bottom: initial; --pc-box-margin-left: initial; --pc-box-margin-right: initial; --pc-box-margin-top: initial; + --pc-box-max-width: initial; --pc-box-padding-bottom: initial; --pc-box-padding-left: initial; --pc-box-padding-right: initial; @@ -28,10 +30,12 @@ border-left: var(--pc-box-border-left); border-right: var(--pc-box-border-right); border-top: var(--pc-box-border-top); + color: var(--pc-box-color); margin-bottom: var(--pc-box-margin-bottom); margin-left: var(--pc-box-margin-left); margin-right: var(--pc-box-margin-right); margin-top: var(--pc-box-margin-top); + max-width: var(--pc-box-max-width); padding-bottom: var(--pc-box-padding-bottom); padding-left: var(--pc-box-padding-left); padding-right: var(--pc-box-padding-right); diff --git a/polaris-react/src/components/Box/Box.tsx b/polaris-react/src/components/Box/Box.tsx index 904e301400a..a5924547689 100644 --- a/polaris-react/src/components/Box/Box.tsx +++ b/polaris-react/src/components/Box/Box.tsx @@ -5,8 +5,7 @@ import {classNames, sanitizeCustomProperties} from '../../utilities/css'; import styles from './Box.scss'; -type ColorsTokenGroup = typeof colors; -type ColorsTokenName = keyof ColorsTokenGroup; +type ColorsTokenName = keyof typeof colors; export type BackgroundColorTokenScale = Extract< ColorsTokenName, | 'background' @@ -15,23 +14,20 @@ export type BackgroundColorTokenScale = Extract< | `surface-${string}` | 'backdrop' | 'overlay' + | `action-${string}` >; +type ColorTokenScale = Extract; -type DepthTokenGroup = typeof depth; -type DepthTokenName = keyof DepthTokenGroup; +type DepthTokenName = keyof typeof depth; type ShadowsTokenName = Exclude; - export type DepthTokenScale = ShadowsTokenName extends `shadow-${infer Scale}` ? Scale : never; -type ShapeTokenGroup = typeof shape; -type ShapeTokenName = keyof ShapeTokenGroup; - +type ShapeTokenName = keyof typeof shape; type BorderShapeTokenScale = ShapeTokenName extends `border-${infer Scale}` ? Scale : never; - type BorderTokenScale = Exclude< BorderShapeTokenScale, `radius-${string}` | `width-${string}` @@ -58,10 +54,7 @@ interface BorderRadius { topRight: BorderRadiusTokenScale; } -type SpacingTokenGroup = typeof spacing; -type SpacingTokenName = keyof SpacingTokenGroup; - -// TODO: Bring this logic into tokens +type SpacingTokenName = keyof typeof spacing; export type SpacingTokenScale = SpacingTokenName extends `space-${infer Scale}` ? Scale : never; @@ -73,53 +66,60 @@ interface Spacing { top: SpacingTokenScale; } +type Element = 'div' | 'span'; + export interface BoxProps { - as?: 'div' | 'span'; - /** Background color of the Box */ + /** HTML Element type */ + as?: Element; + /** Background color */ background?: BackgroundColorTokenScale; - /** Border styling of the Box */ + /** Border style */ border?: BorderTokenScale; - /** Bottom border styling of the Box */ + /** Bottom border style */ borderBottom?: BorderTokenScale; - /** Left border styling of the Box */ + /** Left border style */ borderLeft?: BorderTokenScale; - /** Right border styling of the Box */ + /** Right border style */ borderRight?: BorderTokenScale; - /** Top border styling of the Box */ + /** Top border style */ borderTop?: BorderTokenScale; - /** Border radius of the Box */ + /** Border radius */ borderRadius?: BorderRadiusTokenScale; - /** Bottom left border radius of the Box */ + /** Bottom left border radius */ borderRadiusBottomLeft?: BorderRadiusTokenScale; - /** Bottom right border radius of the Box */ + /** Bottom right border radius */ borderRadiusBottomRight?: BorderRadiusTokenScale; - /** Top left border radius of the Box */ + /** Top left border radius */ borderRadiusTopLeft?: BorderRadiusTokenScale; - /** Top right border radius of the Box */ + /** Top right border radius */ borderRadiusTopRight?: BorderRadiusTokenScale; - /** Inner content of the Box */ + /** Inner content */ children: ReactNode; - /** Spacing outside of the Box */ + /** Color of children */ + color?: ColorTokenScale; + /** Spacing outside of container */ margin?: SpacingTokenScale; - /** Bottom spacing outside of the Box */ + /** Bottom spacing outside of container */ marginBottom?: SpacingTokenScale; - /** Left side spacing outside of the Box */ + /** Left spacing outside of container */ marginLeft?: SpacingTokenScale; - /** Right side spacing outside of the Box */ + /** Right spacing outside of container */ marginRight?: SpacingTokenScale; - /** Top spacing outside of the Box */ + /** Top spacing outside of container */ marginTop?: SpacingTokenScale; - /** Spacing inside of the Box */ + /** Maximum width of container */ + maxWidth?: string; + /** Spacing around children */ padding?: SpacingTokenScale; - /** Bottom spacing inside of the Box */ + /** Bottom spacing around children */ paddingBottom?: SpacingTokenScale; - /** Left side spacing inside of the Box */ + /** Left spacing around children */ paddingLeft?: SpacingTokenScale; - /** Right side spacing inside of the Box */ + /** Right spacing around children */ paddingRight?: SpacingTokenScale; - /** Top spacing inside of the Box */ + /** Top spacing around children */ paddingTop?: SpacingTokenScale; - /** Shadow on the Box */ + /** Shadow */ shadow?: DepthTokenScale; } @@ -139,11 +139,13 @@ export const Box = forwardRef( borderRadiusTopLeft, borderRadiusTopRight, children, + color, margin, marginBottom, marginLeft, marginRight, marginTop, + maxWidth, padding, paddingBottom, paddingLeft, @@ -221,6 +223,7 @@ export const Box = forwardRef( '--pc-box-border-radius-top-right': `var(--p-border-radius-${borderRadiuses.topRight})`, } : undefined), + ...(color ? {'--pc-box-color': `var(--p-${color})`} : undefined), ...(margins.bottom ? {'--pc-box-margin-bottom': `var(--p-space-${margins.bottom})`} : undefined), @@ -233,6 +236,7 @@ export const Box = forwardRef( ...(margins.top ? {'--pc-box-margin-top': `var(--p-space-${margins.top})`} : undefined), + ...(maxWidth ? {'--pc-box-max-width': `${maxWidth}px`} : undefined), ...(paddings.bottom ? {'--pc-box-padding-bottom': `var(--p-space-${paddings.bottom})`} : undefined), @@ -256,8 +260,8 @@ export const Box = forwardRef( as, { className, - style: sanitizeCustomProperties(style), ref, + style: sanitizeCustomProperties(style), }, children, ); From a4a28a7b0070a2f75505e58f004e842c6ef390e3 Mon Sep 17 00:00:00 2001 From: Chaz Dean <59836805+chazdean@users.noreply.github.com> Date: Thu, 29 Sep 2022 14:39:09 -0400 Subject: [PATCH 17/25] [Layout foundations] Add breakpoint configuration to `Tile` component (#7286) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### WHY are these changes introduced? Fixes #7285 ### WHAT is this pull request doing? Adds ability for `Tile` to use breakpoints
Tile breakpoints example Description of what the gif shows
### How to 🎩 🖥 [Local development instructions](https://github.com/Shopify/polaris/blob/main/README.md#local-development) 🗒 [General tophatting guidelines](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md) 📄 [Changelog guidelines](https://github.com/Shopify/polaris/blob/main/.github/CONTRIBUTING.md#changelog)
Copy-paste this code in playground/Playground.tsx: ```jsx import React from 'react'; import {Page, Tile, Text} from '../src'; const styles = { background: 'var(--p-surface)', border: 'var(--p-border-base)', borderRadius: 'var(--p-border-radius-2)', padding: 'var(--p-space-4)', }; export function Playground() { const children = Array.from(Array(10)).map((ele, index) => (
Sales View a summary of your online store’s sales.
)); return ( {children} ); } ```
### 🎩 checklist - [ ] Tested on [mobile](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md#cross-browser-testing) - [ ] Tested on [multiple browsers](https://help.shopify.com/en/manual/shopify-admin/supported-browsers) - [ ] Tested for [accessibility](https://github.com/Shopify/polaris/blob/main/documentation/Accessibility%20testing.md) - [ ] Updated the component's `README.md` with documentation changes - [ ] [Tophatted documentation](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting%20documentation.md) changes in the style guide --- polaris-react/src/components/Tile/Tile.scss | 34 +- .../src/components/Tile/Tile.stories.tsx | 6 +- polaris-react/src/components/Tile/Tile.tsx | 54 +- .../src/components/Tile/tests/Tile.test.tsx | 9 +- .../pages/examples/tile-with-columns.tsx | 2 +- .../pages/examples/tile-with-spacing.tsx | 2 +- polaris.shopify.com/src/data/props.json | 1422 ++++++++--------- 7 files changed, 696 insertions(+), 833 deletions(-) diff --git a/polaris-react/src/components/Tile/Tile.scss b/polaris-react/src/components/Tile/Tile.scss index 79834ff3cd6..e3733733328 100644 --- a/polaris-react/src/components/Tile/Tile.scss +++ b/polaris-react/src/components/Tile/Tile.scss @@ -1,7 +1,37 @@ @import '../../styles/common'; .Tile { + --pc-tile-xs: 6; + --pc-tile-sm: var(--pc-tile-xs); + --pc-tile-md: var(--pc-tile-sm); + --pc-tile-lg: var(--pc-tile-md); + --pc-tile-xl: var(--pc-tile-lg); + --pc-tile-gap-xs: var(--p-space-4); + --pc-tile-gap-sm: var(--pc-tile-gap-xs); + --pc-tile-gap-md: var(--pc-tile-gap-sm); + --pc-tile-gap-lg: var(--pc-tile-gap-md); + --pc-tile-gap-xl: var(--pc-tile-gap-lg); display: grid; - grid-template-columns: var(--pc-tile-column-number); - gap: var(--pc-tile-spacing); + gap: var(--pc-tile-gap-xs); + grid-template-columns: var(--pc-tile-xs); + + @media #{$p-breakpoints-sm-up} { + gap: var(--pc-tile-gap-sm); + grid-template-columns: var(--pc-tile-sm); + } + + @media #{$p-breakpoints-md-up} { + gap: var(--pc-tile-gap-md); + grid-template-columns: var(--pc-tile-md); + } + + @media #{$p-breakpoints-lg-up} { + gap: var(--pc-tile-gap-lg); + grid-template-columns: var(--pc-tile-lg); + } + + @media #{$p-breakpoints-xl-up} { + gap: var(--pc-tile-gap-xl); + grid-template-columns: var(--pc-tile-xl); + } } diff --git a/polaris-react/src/components/Tile/Tile.stories.tsx b/polaris-react/src/components/Tile/Tile.stories.tsx index dafd70f235a..e15b7e8cacc 100644 --- a/polaris-react/src/components/Tile/Tile.stories.tsx +++ b/polaris-react/src/components/Tile/Tile.stories.tsx @@ -26,7 +26,7 @@ const children = Array.from(Array(4)).map((ele, index) => ( export function Default() { return ( - + {children} ); @@ -34,7 +34,7 @@ export function Default() { export function LargeSpacing() { return ( - + {children} ); @@ -53,7 +53,7 @@ export function ManyColumns() { )); return ( - + {children} ); diff --git a/polaris-react/src/components/Tile/Tile.tsx b/polaris-react/src/components/Tile/Tile.tsx index 880307c7e57..f89fda93ba0 100644 --- a/polaris-react/src/components/Tile/Tile.tsx +++ b/polaris-react/src/components/Tile/Tile.tsx @@ -1,40 +1,40 @@ import React from 'react'; -import type {spacing} from '@shopify/polaris-tokens'; +import type { + BreakpointsAlias, + SpacingSpaceScale, +} from '@shopify/polaris-tokens'; import styles from './Tile.scss'; -type SpacingTokenName = keyof typeof spacing; - -// TODO: Bring this logic into tokens -type Spacing = SpacingTokenName extends `space-${infer Scale}` ? Scale : never; - -type Columns = - | '1' - | '2' - | '3' - | '4' - | '5' - | '6' - | '7' - | '8' - | '9' - | '10' - | '11' - | '12'; +type Columns = { + [Breakpoint in BreakpointsAlias]?: number | string; +}; + +type Gap = { + [Breakpoint in BreakpointsAlias]?: SpacingSpaceScale; +}; export interface TileProps { /** Elements to display inside tile */ children: React.ReactNode; /** Adjust spacing between elements */ - spacing: Spacing; + gap?: Gap; /** Adjust number of columns */ - columns: Columns; + columns?: Columns; } -export const Tile = ({children, spacing, columns}: TileProps) => { +export const Tile = ({children, gap, columns}: TileProps) => { const style = { - '--pc-tile-column-number': `repeat(${columns}, 1fr)`, - '--pc-tile-spacing': `var(--p-space-${spacing})`, + '--pc-tile-gap-xs': gap?.xs ? `var(--p-space-${gap?.xs})` : undefined, + '--pc-tile-gap-sm': gap?.sm ? `var(--p-space-${gap?.sm})` : undefined, + '--pc-tile-gap-md': gap?.md ? `var(--p-space-${gap?.md})` : undefined, + '--pc-tile-gap-lg': gap?.lg ? `var(--p-space-${gap?.lg})` : undefined, + '--pc-tile-gap-xl': gap?.xl ? `var(--p-space-${gap?.xl})` : undefined, + '--pc-tile-xs': formatColumns(columns?.xs), + '--pc-tile-sm': formatColumns(columns?.sm), + '--pc-tile-md': formatColumns(columns?.md), + '--pc-tile-lg': formatColumns(columns?.lg), + '--pc-tile-xl': formatColumns(columns?.xl), } as React.CSSProperties; return ( @@ -43,3 +43,9 @@ export const Tile = ({children, spacing, columns}: TileProps) => {
); }; + +function formatColumns(columns?: number | string) { + if (!columns) return undefined; + + return typeof columns === 'number' ? `repeat(${columns}, 1fr)` : columns; +} diff --git a/polaris-react/src/components/Tile/tests/Tile.test.tsx b/polaris-react/src/components/Tile/tests/Tile.test.tsx index 464c6c9fc67..354bf060309 100644 --- a/polaris-react/src/components/Tile/tests/Tile.test.tsx +++ b/polaris-react/src/components/Tile/tests/Tile.test.tsx @@ -8,7 +8,7 @@ const Children = () =>

This is a tile

; describe('', () => { it('renders children', () => { const tile = mountWithApp( - + , ); @@ -18,15 +18,16 @@ describe('', () => { it('uses custom properties when passed in', () => { const tile = mountWithApp( - + , ); expect(tile).toContainReactComponent('div', { style: { - '--pc-tile-column-number': 'repeat(2, 1fr)', - '--pc-tile-spacing': 'var(--p-space-1)', + '--pc-tile-xs': 'repeat(2, 1fr)', + '--pc-tile-lg': 'repeat(2, 1fr)', + '--pc-tile-gap-xs': 'var(--p-space-2)', } as React.CSSProperties, }); }); diff --git a/polaris.shopify.com/pages/examples/tile-with-columns.tsx b/polaris.shopify.com/pages/examples/tile-with-columns.tsx index 1e20107bbce..d9f9c0cf33d 100644 --- a/polaris.shopify.com/pages/examples/tile-with-columns.tsx +++ b/polaris.shopify.com/pages/examples/tile-with-columns.tsx @@ -24,7 +24,7 @@ const children = Array.from(Array(8)).map((ele, index) => ( function TileWithColumnsExample() { return (
- + {children}
diff --git a/polaris.shopify.com/pages/examples/tile-with-spacing.tsx b/polaris.shopify.com/pages/examples/tile-with-spacing.tsx index 0bdbe0094bd..7e07142eee3 100644 --- a/polaris.shopify.com/pages/examples/tile-with-spacing.tsx +++ b/polaris.shopify.com/pages/examples/tile-with-spacing.tsx @@ -24,7 +24,7 @@ const children = Array.from(Array(2)).map((ele, index) => ( function TileWithSpacingExample() { return (
- + {children}
diff --git a/polaris.shopify.com/src/data/props.json b/polaris.shopify.com/src/data/props.json index 341dd860c45..bd41bb92529 100644 --- a/polaris.shopify.com/src/data/props.json +++ b/polaris.shopify.com/src/data/props.json @@ -8291,13 +8291,6 @@ "name": "Spacing", "value": "'tight' | 'loose'", "description": "" - }, - "polaris-react/src/components/Tile/Tile.tsx": { - "filePath": "polaris-react/src/components/Tile/Tile.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", - "value": "SpacingTokenName extends `space-${infer Scale}` ? Scale : never", - "description": "" } }, "Align": { @@ -10551,56 +10544,6 @@ "description": "" } }, - "ButtonGroupProps": { - "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "name": "ButtonGroupProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "spacing", - "value": "Spacing", - "description": "Determines the space between button group items", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "segmented", - "value": "boolean", - "description": "Join buttons as segmented group", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "fullWidth", - "value": "boolean", - "description": "Buttons will stretch/shrink to occupy the full width", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "connectedTop", - "value": "boolean", - "description": "Remove top left and right border radius", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Button components", - "isOptional": true - } - ], - "value": "export interface ButtonGroupProps {\n /** Determines the space between button group items */\n spacing?: Spacing;\n /** Join buttons as segmented group */\n segmented?: boolean;\n /** Buttons will stretch/shrink to occupy the full width */\n fullWidth?: boolean;\n /** Remove top left and right border radius */\n connectedTop?: boolean;\n /** Button components */\n children?: React.ReactNode;\n}" - } - }, "ButtonProps": { "polaris-react/src/components/Button/Button.tsx": { "filePath": "polaris-react/src/components/Button/Button.tsx", @@ -11890,6 +11833,13 @@ "value": "'xs' | 'sm' | 'md' | 'lg' | 'xl'", "description": "" }, + "polaris-react/src/components/Tile/Tile.tsx": { + "filePath": "polaris-react/src/components/Tile/Tile.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Breakpoints", + "value": "'xs' | 'sm' | 'md' | 'lg' | 'xl'", + "description": "" + }, "polaris-react/src/components/Grid/components/Cell/Cell.tsx": { "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", "syntaxKind": "TypeAliasDeclaration", @@ -11914,6 +11864,13 @@ "name": "SpacingScale", "value": "SpacingName extends `space-${infer Scale}` ? Scale : never", "description": "" + }, + "polaris-react/src/components/Tile/Tile.tsx": { + "filePath": "polaris-react/src/components/Tile/Tile.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "SpacingScale", + "value": "SpacingTokenName extends `space-${infer Scale}`\n ? Scale\n : never", + "description": "" } }, "Columns": { @@ -11935,7 +11892,7 @@ "filePath": "polaris-react/src/components/Tile/Tile.tsx", "syntaxKind": "TypeAliasDeclaration", "name": "Columns", - "value": "'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12'", + "value": "{\n [Breakpoint in Breakpoints]?: number | string;\n}", "description": "" }, "polaris-react/src/components/Grid/components/Cell/Cell.tsx": { @@ -12001,6 +11958,13 @@ "name": "Gap", "value": "{\n [Breakpoint in Breakpoints]?: string;\n}", "description": "" + }, + "polaris-react/src/components/Tile/Tile.tsx": { + "filePath": "polaris-react/src/components/Tile/Tile.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Gap", + "value": "{\n [Breakpoint in Breakpoints]?: SpacingScale;\n}", + "description": "" } }, "ColumnsProps": { @@ -12149,7 +12113,7 @@ "filePath": "polaris-react/src/components/ContentBlock/ContentBlock.tsx", "syntaxKind": "TypeAliasDeclaration", "name": "Width", - "value": "'medium' | 'large'", + "value": "'md' | 'lg'", "description": "" } }, @@ -18398,24 +18362,27 @@ "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", - "description": "Elements to display inside tile" + "description": "Elements to display inside tile", + "isOptional": true }, { "filePath": "polaris-react/src/components/Tile/Tile.tsx", "syntaxKind": "PropertySignature", - "name": "spacing", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "Adjust spacing between elements" + "name": "gap", + "value": "Gap", + "description": "Adjust spacing between elements", + "isOptional": true }, { "filePath": "polaris-react/src/components/Tile/Tile.tsx", "syntaxKind": "PropertySignature", "name": "columns", "value": "Columns", - "description": "Adjust number of columns" + "description": "Adjust number of columns", + "isOptional": true } ], - "value": "export interface TileProps {\n /** Elements to display inside tile */\n children: React.ReactNode;\n /** Adjust spacing between elements */\n spacing: Spacing;\n /** Adjust number of columns */\n columns: Columns;\n}" + "value": "export interface TileProps {\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": { @@ -22958,424 +22925,415 @@ "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", + "MappedAction": { + "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx": { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "name": "MappedAction", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "section", - "value": "ActionListSection", - "description": "Section of action items" - }, - { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "hasMultipleSections", + "name": "wrapOverflow", "value": "boolean", - "description": "Should there be multiple sections" + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "actionRole", + "name": "accessibilityLabel", "value": "string", - "description": "Defines a specific role attribute for each action in the list", + "description": "Visually hidden text for screen readers", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any item is clicked or keypressed", - "isOptional": true - } - ], - "value": "export interface SectionProps {\n /** Section of action items */\n section: ActionListSection;\n /** Should there be multiple sections */\n hasMultipleSections: boolean;\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'option' | 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" - }, - "polaris-react/src/components/Layout/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ + "name": "badge", + "value": "{ status: \"new\"; content: string; }", + "description": "", + "isOptional": true, + "deprecationMessage": "Badge component" + }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", + "name": "helpText", "value": "React.ReactNode", - "description": "", + "description": "Additional hint text to display with item", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "secondary", - "value": "boolean", + "name": "icon", + "value": "any", "description": "", - "isOptional": true + "isOptional": true, + "deprecationMessage": "Source of the icon" }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "fullWidth", - "value": "boolean", + "name": "image", + "value": "string", "description": "", + "isOptional": true, + "deprecationMessage": "Image source" + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "React.ReactNode", + "description": "Prefix source", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "oneHalf", - "value": "boolean", - "description": "", + "name": "suffix", + "value": "React.ReactNode", + "description": "Suffix source", "isOptional": true }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "oneThird", + "name": "ellipsis", "value": "boolean", - "description": "", + "description": "Add an ellipsis suffix to action content", "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/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "divider", + "name": "active", "value": "boolean", - "description": "", + "description": "Whether the action is active or not", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", - "description": "", + "name": "role", + "value": "string", + "description": "Defines a role for the action", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "title", - "value": "ReactNode", - "description": "" - } - ], - "value": "interface SectionProps {\n divider?: boolean;\n children?: ReactNode;\n title: ReactNode;\n}" - }, - "polaris-react/src/components/Navigation/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ + "name": "disabled", + "value": "boolean", + "description": "Whether or not the action is disabled", + "isOptional": true + }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "items", - "value": "ItemProps[]", - "description": "" + "name": "id", + "value": "string", + "description": "A unique identifier for the action", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "", + "name": "content", + "value": "string", + "description": "Content the action displays", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "title", + "name": "url", "value": "string", - "description": "", + "description": "A destination to link to, rendered in the action", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "fill", + "name": "external", "value": "boolean", - "description": "", + "description": "Forces url to open in a new tab", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "rollup", - "value": "{ after: number; view: string; hide: string; activePath: string; }", - "description": "", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onAction", + "value": "() => void", + "description": "Callback when an action takes place", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "action", - "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", - "description": "", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onMouseEnter", + "value": "() => void", + "description": "Callback when mouse enter", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onTouchStart", + "value": "() => void", + "description": "Callback when element is touched", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "separator", + "name": "destructive", "value": "boolean", - "description": "", + "description": "Destructive action", "isOptional": true } ], - "value": "export interface SectionProps {\n items: ItemProps[];\n icon?: IconProps['source'];\n title?: string;\n fill?: boolean;\n rollup?: {\n after: number;\n view: string;\n hide: string;\n activePath: string;\n };\n action?: {\n icon: IconProps['source'];\n accessibilityLabel: string;\n onClick(): void;\n tooltip?: TooltipProps;\n };\n separator?: boolean;\n}" - }, - "polaris-react/src/components/Modal/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "value": "interface MappedAction extends ActionListItemDescriptor {\n wrapOverflow?: boolean;\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/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true + "name": "section", + "value": "ActionListSection", + "description": "Section of action items" }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "flush", + "name": "hasMultipleSections", "value": "boolean", - "description": "", - "isOptional": true + "description": "Should there be multiple sections" }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "subdued", - "value": "boolean", - "description": "", + "name": "actionRole", + "value": "string", + "description": "Defines a specific role attribute for each action in the list", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "titleHidden", - "value": "boolean", - "description": "", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any item is clicked or keypressed", "isOptional": true } ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\n flush?: boolean;\n subdued?: boolean;\n titleHidden?: boolean;\n}" + "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/Popover/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", + "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/Popover/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", "description": "", "isOptional": true - } - ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\n}" - } - }, - "MappedAction": { - "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx": { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "name": "MappedAction", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "wrapOverflow", + "name": "secondary", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Visually hidden text for screen readers", + "name": "fullWidth", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "badge", - "value": "{ status: \"new\"; content: string; }", + "name": "oneHalf", + "value": "boolean", "description": "", - "isOptional": true, - "deprecationMessage": "Badge component" + "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "helpText", - "value": "React.ReactNode", - "description": "Additional hint text to display with item", + "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/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", + "name": "divider", + "value": "boolean", "description": "", - "isOptional": true, - "deprecationMessage": "Source of the icon" + "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "image", - "value": "string", + "name": "children", + "value": "ReactNode", "description": "", - "isOptional": true, - "deprecationMessage": "Image source" + "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "prefix", - "value": "React.ReactNode", - "description": "Prefix source", - "isOptional": true - }, + "name": "title", + "value": "ReactNode", + "description": "" + } + ], + "value": "interface SectionProps {\n divider?: boolean;\n children?: ReactNode;\n title: ReactNode;\n}" + }, + "polaris-react/src/components/Modal/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "suffix", + "name": "children", "value": "React.ReactNode", - "description": "Suffix source", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "ellipsis", + "name": "flush", "value": "boolean", - "description": "Add an ellipsis suffix to action content", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "active", + "name": "subdued", "value": "boolean", - "description": "Whether the action is active or not", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "role", - "value": "string", - "description": "Defines a role for the action", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", + "name": "titleHidden", "value": "boolean", - "description": "Whether or not the action is disabled", + "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/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the action", - "isOptional": true + "name": "items", + "value": "ItemProps[]", + "description": "" }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "content", - "value": "string", - "description": "Content the action displays", + "name": "icon", + "value": "any", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "url", + "name": "title", "value": "string", - "description": "A destination to link to, rendered in the action", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "external", + "name": "fill", "value": "boolean", - "description": "Forces url to open in a new tab", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onAction", - "value": "() => void", - "description": "Callback when an action takes place", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "rollup", + "value": "{ after: number; view: string; hide: string; activePath: string; }", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onMouseEnter", - "value": "() => void", - "description": "Callback when mouse enter", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "action", + "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onTouchStart", - "value": "() => void", - "description": "Callback when element is touched", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "separator", + "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}" + }, + "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/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "destructive", - "value": "boolean", - "description": "Destructive action", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true } ], - "value": "interface MappedAction extends ActionListItemDescriptor {\n wrapOverflow?: boolean;\n}" - } - }, - "MappedOption": { - "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx": { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "MappedOption", - "value": "ArrayElement & {\n selected: boolean;\n singleSelection: boolean;\n}", - "description": "" + "value": "export interface SectionProps {\n children?: React.ReactNode;\n}" } }, "PipProps": { @@ -23412,15 +23370,6 @@ "value": "export interface PipProps {\n status?: Status;\n progress?: Progress;\n accessibilityLabelOverride?: string;\n}" } }, - "BulkActionButtonProps": { - "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx": { - "filePath": "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "BulkActionButtonProps", - "value": "{\n disclosure?: boolean;\n indicator?: boolean;\n handleMeasurement?(width: number): void;\n} & DisableableAction", - "description": "" - } - }, "BulkActionsMenuProps": { "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx": { "filePath": "polaris-react/src/components/BulkActions/components/BulkActionMenu/BulkActionMenu.tsx", @@ -23508,6 +23457,24 @@ "value": "export interface BulkActionsMenuProps extends MenuGroupDescriptor {\n isNewBadgeInBadgeActions: boolean;\n}" } }, + "BulkActionButtonProps": { + "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx": { + "filePath": "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "BulkActionButtonProps", + "value": "{\n disclosure?: boolean;\n indicator?: boolean;\n handleMeasurement?(width: number): void;\n} & DisableableAction", + "description": "" + } + }, + "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": "" + } + }, "CardHeaderProps": { "polaris-react/src/components/Card/components/Header/Header.tsx": { "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", @@ -24309,32 +24276,6 @@ "value": "export interface MonthProps {\n focusedDate?: Date;\n selected?: Range;\n hoverDate?: Date;\n month: number;\n year: number;\n disableDatesBefore?: Date;\n disableDatesAfter?: Date;\n disableSpecificDates?: Date[];\n allowRange?: boolean;\n weekStartsOn: number;\n accessibilityLabelPrefixes: [string | undefined, string];\n onChange?(date: Range): void;\n onHover?(hoverEnd: Date): void;\n onFocus?(date: Date): void;\n}" } }, - "FileUploadProps": { - "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx": { - "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", - "name": "FileUploadProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", - "syntaxKind": "PropertySignature", - "name": "actionTitle", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", - "syntaxKind": "PropertySignature", - "name": "actionHint", - "value": "string", - "description": "", - "isOptional": true - } - ], - "value": "export interface FileUploadProps {\n actionTitle?: string;\n actionHint?: string;\n}" - } - }, "WeekdayProps": { "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx": { "filePath": "polaris-react/src/components/DatePicker/components/Weekday/Weekday.tsx", @@ -24366,6 +24307,32 @@ "value": "export interface WeekdayProps {\n label: string;\n title: string;\n current: boolean;\n}" } }, + "FileUploadProps": { + "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx": { + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "name": "FileUploadProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "syntaxKind": "PropertySignature", + "name": "actionTitle", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/DropZone/components/FileUpload/FileUpload.tsx", + "syntaxKind": "PropertySignature", + "name": "actionHint", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface FileUploadProps {\n actionTitle?: string;\n actionHint?: string;\n}" + } + }, "PopoverableAction": { "polaris-react/src/components/Filters/components/ConnectedFilterControl/ConnectedFilterControl.tsx": { "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/ConnectedFilterControl.tsx", @@ -24663,21 +24630,21 @@ "description": "" } }, - "ToastManagerProps": { - "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx": { - "filePath": "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx", - "name": "ToastManagerProps", + "CheckboxWrapperProps": { + "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx": { + "filePath": "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx", + "name": "CheckboxWrapperProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Frame/components/ToastManager/ToastManager.tsx", + "filePath": "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx", "syntaxKind": "PropertySignature", - "name": "toastMessages", - "value": "ToastPropsWithID[]", + "name": "children", + "value": "ReactNode", "description": "" } ], - "value": "export interface ToastManagerProps {\n toastMessages: ToastPropsWithID[];\n}" + "value": "interface CheckboxWrapperProps {\n children: ReactNode;\n}" } }, "RowStatus": { @@ -24768,23 +24735,6 @@ "value": "export interface RowProps {\n children: React.ReactNode;\n id: string;\n selected?: boolean;\n position: number;\n subdued?: boolean;\n status?: RowStatus;\n disabled?: boolean;\n onNavigation?(id: string): void;\n onClick?(): void;\n}" } }, - "CheckboxWrapperProps": { - "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx": { - "filePath": "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx", - "name": "CheckboxWrapperProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/IndexTable/components/Checkbox/Checkbox.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", - "description": "" - } - ], - "value": "interface CheckboxWrapperProps {\n children: ReactNode;\n}" - } - }, "ScrollContainerProps": { "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx": { "filePath": "polaris-react/src/components/IndexTable/components/ScrollContainer/ScrollContainer.tsx", @@ -24858,6 +24808,71 @@ "value": "export interface AnnotatedSectionProps {\n children?: React.ReactNode;\n title?: React.ReactNode;\n description?: React.ReactNode;\n id?: string;\n}" } }, + "ActionProps": { + "polaris-react/src/components/Listbox/components/Action/Action.tsx": { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "name": "ActionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "any", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "any", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "syntaxKind": "PropertySignature", + "name": "divider", + "value": "boolean", + "description": "", + "isOptional": true + } + ], + "value": "interface ActionProps extends OptionProps {\n icon?: IconProps['source'];\n}" + } + }, "HeaderProps": { "polaris-react/src/components/Listbox/components/Header/Header.tsx": { "filePath": "polaris-react/src/components/Listbox/components/Header/Header.tsx", @@ -25025,29 +25040,21 @@ "value": "export interface HeaderProps extends TitleProps {\n /** Visually hide the title */\n titleHidden?: boolean;\n /** Primary page-level action */\n primaryAction?: PrimaryAction | React.ReactNode;\n /** Page-level pagination */\n pagination?: PaginationProps;\n /** Collection of breadcrumbs */\n breadcrumbs?: BreadcrumbsProps['breadcrumbs'];\n /** Collection of secondary page-level actions */\n secondaryActions?: MenuActionDescriptor[] | React.ReactNode;\n /** Collection of page-level groups of secondary actions */\n actionGroups?: MenuGroupDescriptor[];\n /** @deprecated Additional navigation markup */\n additionalNavigation?: React.ReactNode;\n // Additional meta data\n additionalMetadata?: React.ReactNode | string;\n /** Callback that returns true when secondary actions are rolled up into action groups, and false when not */\n onActionRollup?(hasRolledUp: boolean): void;\n}" } }, - "ActionProps": { - "polaris-react/src/components/Listbox/components/Action/Action.tsx": { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", - "name": "ActionProps", + "OptionProps": { + "polaris-react/src/components/Listbox/components/Option/Option.tsx": { + "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", + "name": "OptionProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", "syntaxKind": "PropertySignature", "name": "value", "value": "string", "description": "" }, { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", @@ -25055,7 +25062,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "any", @@ -25063,7 +25070,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", "syntaxKind": "PropertySignature", "name": "selected", "value": "boolean", @@ -25071,7 +25078,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", @@ -25079,7 +25086,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Action/Action.tsx", + "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", "syntaxKind": "PropertySignature", "name": "divider", "value": "boolean", @@ -25087,203 +25094,302 @@ "isOptional": true } ], - "value": "interface ActionProps extends OptionProps {\n icon?: IconProps['source'];\n}" - } - }, - "OptionProps": { - "polaris-react/src/components/Listbox/components/Option/Option.tsx": { - "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", + "value": "export interface OptionProps {\n // Unique item value\n value: string;\n // Visually hidden text for screen readers\n accessibilityLabel?: string;\n // Children. When a string, children are rendered in a styled TextOption\n children?: string | React.ReactNode;\n // Option is selected\n selected?: boolean;\n // Option is disabled\n disabled?: boolean;\n // Adds a border-bottom to the Option\n divider?: boolean;\n}" + }, + "polaris-react/src/components/OptionList/components/Option/Option.tsx": { + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", "name": "OptionProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", "syntaxKind": "PropertySignature", - "name": "value", + "name": "id", "value": "string", "description": "" }, { - "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", + "name": "label", + "value": "React.ReactNode", + "description": "" + }, + { + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "syntaxKind": "PropertySignature", + "name": "value", "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "syntaxKind": "PropertySignature", + "name": "section", + "value": "number", + "description": "" + }, + { + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "syntaxKind": "PropertySignature", + "name": "index", + "value": "number", + "description": "" + }, + { + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "syntaxKind": "PropertySignature", + "name": "media", + "value": "React.ReactElement", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "any", + "name": "disabled", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", "syntaxKind": "PropertySignature", - "name": "selected", + "name": "active", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", + "name": "select", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Option/Option.tsx", + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", "syntaxKind": "PropertySignature", - "name": "divider", + "name": "allowMultiple", "value": "boolean", "description": "", "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "syntaxKind": "PropertySignature", + "name": "verticalAlign", + "value": "Alignment", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "(section: number, option: number) => void", + "description": "" } ], - "value": "export interface OptionProps {\n // Unique item value\n value: string;\n // Visually hidden text for screen readers\n accessibilityLabel?: string;\n // Children. When a string, children are rendered in a styled TextOption\n children?: string | React.ReactNode;\n // Option is selected\n selected?: boolean;\n // Option is disabled\n disabled?: boolean;\n // Adds a border-bottom to the Option\n divider?: boolean;\n}" - }, - "polaris-react/src/components/OptionList/components/Option/Option.tsx": { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", - "name": "OptionProps", + "value": "export interface OptionProps {\n id: string;\n label: React.ReactNode;\n value: string;\n section: number;\n index: number;\n media?: React.ReactElement;\n disabled?: boolean;\n active?: boolean;\n select?: boolean;\n allowMultiple?: boolean;\n verticalAlign?: Alignment;\n role?: string;\n onClick(section: number, option: number): void;\n}" + } + }, + "TextOptionProps": { + "polaris-react/src/components/Listbox/components/TextOption/TextOption.tsx": { + "filePath": "polaris-react/src/components/Listbox/components/TextOption/TextOption.tsx", + "name": "TextOptionProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "filePath": "polaris-react/src/components/Listbox/components/TextOption/TextOption.tsx", "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", + "name": "children", + "value": "React.ReactNode", "description": "" }, { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "React.ReactNode", + "filePath": "polaris-react/src/components/Listbox/components/TextOption/TextOption.tsx", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/TextOption/TextOption.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "", + "isOptional": true + } + ], + "value": "export interface TextOptionProps {\n children: React.ReactNode;\n // Whether the option is selected\n selected?: boolean;\n // Whether the option is disabled\n disabled?: boolean;\n}" + } + }, + "CloseButtonProps": { + "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx": { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "name": "CloseButtonProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "syntaxKind": "PropertySignature", + "name": "titleHidden", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", "description": "" - }, + } + ], + "value": "export interface CloseButtonProps {\n titleHidden?: boolean;\n onClick(): void;\n}" + } + }, + "DialogProps": { + "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx": { + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "name": "DialogProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", "syntaxKind": "PropertySignature", - "name": "value", + "name": "labelledBy", "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", - "syntaxKind": "PropertySignature", - "name": "section", - "value": "number", - "description": "" + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", "syntaxKind": "PropertySignature", - "name": "index", - "value": "number", - "description": "" + "name": "instant", + "value": "boolean", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", "syntaxKind": "PropertySignature", - "name": "media", - "value": "React.ReactElement", + "name": "children", + "value": "React.ReactNode", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", + "name": "limitHeight", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", "syntaxKind": "PropertySignature", - "name": "active", + "name": "large", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", "syntaxKind": "PropertySignature", - "name": "select", + "name": "small", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", - "syntaxKind": "PropertySignature", - "name": "allowMultiple", - "value": "boolean", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "syntaxKind": "MethodSignature", + "name": "onClose", + "value": "() => void", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "syntaxKind": "MethodSignature", + "name": "onEntered", + "value": "() => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", - "syntaxKind": "PropertySignature", - "name": "verticalAlign", - "value": "Alignment", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "syntaxKind": "MethodSignature", + "name": "onExited", + "value": "() => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", "syntaxKind": "PropertySignature", - "name": "role", - "value": "string", + "name": "in", + "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "(section: number, option: number) => void", - "description": "" + "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", + "syntaxKind": "PropertySignature", + "name": "fullScreen", + "value": "boolean", + "description": "", + "isOptional": true } ], - "value": "export interface OptionProps {\n id: string;\n label: React.ReactNode;\n value: string;\n section: number;\n index: number;\n media?: React.ReactElement;\n disabled?: boolean;\n active?: boolean;\n select?: boolean;\n allowMultiple?: boolean;\n verticalAlign?: Alignment;\n role?: string;\n onClick(section: number, option: number): void;\n}" + "value": "export interface DialogProps {\n labelledBy?: string;\n instant?: boolean;\n children?: React.ReactNode;\n limitHeight?: boolean;\n large?: boolean;\n small?: boolean;\n onClose(): void;\n onEntered?(): void;\n onExited?(): void;\n in?: boolean;\n fullScreen?: boolean;\n}" } }, - "TextOptionProps": { - "polaris-react/src/components/Listbox/components/TextOption/TextOption.tsx": { - "filePath": "polaris-react/src/components/Listbox/components/TextOption/TextOption.tsx", - "name": "TextOptionProps", + "FooterProps": { + "polaris-react/src/components/Modal/components/Footer/Footer.tsx": { + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "name": "FooterProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Listbox/components/TextOption/TextOption.tsx", + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "" + "name": "primaryAction", + "value": "ComplexAction", + "description": "Primary action", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/TextOption/TextOption.tsx", + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", "syntaxKind": "PropertySignature", - "name": "selected", - "value": "boolean", - "description": "", + "name": "secondaryActions", + "value": "ComplexAction[]", + "description": "Collection of secondary actions", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/TextOption/TextOption.tsx", + "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "", + "name": "children", + "value": "React.ReactNode", + "description": "The content to display inside modal", "isOptional": true } ], - "value": "export interface TextOptionProps {\n children: React.ReactNode;\n // Whether the option is selected\n selected?: boolean;\n // Whether the option is disabled\n disabled?: boolean;\n}" + "value": "export interface FooterProps {\n /** Primary action */\n primaryAction?: ComplexAction;\n /** Collection of secondary actions */\n secondaryActions?: ComplexAction[];\n /** The content to display inside modal */\n children?: React.ReactNode;\n}" } }, "ItemURLDetails": { @@ -25442,185 +25548,79 @@ { "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "name": "MatchForced", - "value": 0 - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "MatchUrl", - "value": 1 - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "MatchPaths", - "value": 2 - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "Excluded", - "value": 3 - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "NoMatch", - "value": 4 - } - ] - } - }, - "CloseButtonProps": { - "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx": { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "name": "CloseButtonProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "syntaxKind": "PropertySignature", - "name": "titleHidden", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "" - } - ], - "value": "export interface CloseButtonProps {\n titleHidden?: boolean;\n onClick(): void;\n}" - } - }, - "DialogProps": { - "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx": { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", - "name": "DialogProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", - "syntaxKind": "PropertySignature", - "name": "labelledBy", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", - "syntaxKind": "PropertySignature", - "name": "instant", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", - "syntaxKind": "PropertySignature", - "name": "limitHeight", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", - "syntaxKind": "PropertySignature", - "name": "large", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", - "syntaxKind": "PropertySignature", - "name": "small", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", - "syntaxKind": "MethodSignature", - "name": "onClose", - "value": "() => void", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", - "syntaxKind": "MethodSignature", - "name": "onEntered", - "value": "() => void", - "description": "", - "isOptional": true + "value": 0 }, { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", - "syntaxKind": "MethodSignature", - "name": "onExited", - "value": "() => void", - "description": "", - "isOptional": true + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "name": "MatchUrl", + "value": 1 }, { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", - "syntaxKind": "PropertySignature", - "name": "in", - "value": "boolean", - "description": "", - "isOptional": true + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "name": "MatchPaths", + "value": 2 }, { - "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", - "syntaxKind": "PropertySignature", - "name": "fullScreen", - "value": "boolean", - "description": "", - "isOptional": true + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "name": "Excluded", + "value": 3 + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "name": "NoMatch", + "value": 4 } - ], - "value": "export interface DialogProps {\n labelledBy?: string;\n instant?: boolean;\n children?: React.ReactNode;\n limitHeight?: boolean;\n large?: boolean;\n small?: boolean;\n onClose(): void;\n onEntered?(): void;\n onExited?(): void;\n in?: boolean;\n fullScreen?: boolean;\n}" + ] } }, - "FooterProps": { - "polaris-react/src/components/Modal/components/Footer/Footer.tsx": { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", - "name": "FooterProps", + "PaneProps": { + "polaris-react/src/components/Popover/components/Pane/Pane.tsx": { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "name": "PaneProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", "syntaxKind": "PropertySignature", - "name": "primaryAction", - "value": "ComplexAction", - "description": "Primary action", + "name": "fixed", + "value": "boolean", + "description": "Fix the pane to the top of the popover", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", "syntaxKind": "PropertySignature", - "name": "secondaryActions", - "value": "ComplexAction[]", - "description": "Collection of secondary actions", + "name": "sectioned", + "value": "boolean", + "description": "Automatically wrap children in padded sections", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Footer/Footer.tsx", + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", - "description": "The content to display inside modal", + "description": "The pane content", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "height", + "value": "string", + "description": "Sets a fixed height and max-height on the Scrollable", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "MethodSignature", + "name": "onScrolledToBottom", + "value": "() => void", + "description": "Callback when the bottom of the popover is reached by mouse or keyboard", "isOptional": true } ], - "value": "export interface FooterProps {\n /** Primary action */\n primaryAction?: ComplexAction;\n /** Collection of secondary actions */\n secondaryActions?: ComplexAction[];\n /** The content to display inside modal */\n children?: React.ReactNode;\n}" + "value": "export interface PaneProps {\n /** Fix the pane to the top of the popover */\n fixed?: boolean;\n /** Automatically wrap children in padded sections */\n sectioned?: boolean;\n /** The pane content */\n children?: React.ReactNode;\n /** Sets a fixed height and max-height on the Scrollable */\n height?: string;\n /** Callback when the bottom of the popover is reached by mouse or keyboard */\n onScrolledToBottom?(): void;\n}" } }, "PrimaryAction": { @@ -25745,56 +25745,6 @@ "value": "interface PrimaryAction\n extends DestructableAction,\n DisableableAction,\n LoadableAction,\n IconableAction,\n TooltipAction {\n /** Provides extra visual weight and identifies the primary action in a set of buttons */\n primary?: boolean;\n}" } }, - "PaneProps": { - "polaris-react/src/components/Popover/components/Pane/Pane.tsx": { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "name": "PaneProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "fixed", - "value": "boolean", - "description": "Fix the pane to the top of the popover", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "sectioned", - "value": "boolean", - "description": "Automatically wrap children in padded sections", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The pane content", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "height", - "value": "string", - "description": "Sets a fixed height and max-height on the Scrollable", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "MethodSignature", - "name": "onScrolledToBottom", - "value": "() => void", - "description": "Callback when the bottom of the popover is reached by mouse or keyboard", - "isOptional": true - } - ], - "value": "export interface PaneProps {\n /** Fix the pane to the top of the popover */\n fixed?: boolean;\n /** Automatically wrap children in padded sections */\n sectioned?: boolean;\n /** The pane content */\n children?: React.ReactNode;\n /** Sets a fixed height and max-height on the Scrollable */\n height?: string;\n /** Callback when the bottom of the popover is reached by mouse or keyboard */\n onScrolledToBottom?(): void;\n}" - } - }, "PopoverCloseSource": { "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx": { "filePath": "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx", @@ -26338,130 +26288,6 @@ "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": "" - } - ], - "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", - "name": "ResizerProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", - "syntaxKind": "PropertySignature", - "name": "contents", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", - "syntaxKind": "PropertySignature", - "name": "currentHeight", - "value": "number", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", - "syntaxKind": "PropertySignature", - "name": "minimumLines", - "value": "number", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/TextField/components/Resizer/Resizer.tsx", - "syntaxKind": "MethodSignature", - "name": "onHeightChange", - "value": "(height: number) => void", - "description": "" - } - ], - "value": "export interface ResizerProps {\n contents?: string;\n currentHeight?: number | null;\n minimumLines?: number;\n onHeightChange(height: number): void;\n}" - } - }, "TabProps": { "polaris-react/src/components/Tabs/components/Tab/Tab.tsx": { "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", @@ -27166,4 +26992,4 @@ "value": "export interface MessageProps {\n title: string;\n description: string;\n action: {onClick(): void; content: string};\n link: {to: string; content: string};\n badge?: {content: string; status: BadgeProps['status']};\n}" } } -} +} \ No newline at end of file From 3292df6548faade400fbe95c02db49d741df11b2 Mon Sep 17 00:00:00 2001 From: aveline Date: Thu, 29 Sep 2022 12:11:30 -0700 Subject: [PATCH 18/25] [Layout foundations] Refactor token types (#7296) ### WHY are these changes introduced? Fixes #7277 ### WHAT is this pull request doing? Pulls in token scales from `polaris-tokens` instead of adhoc creating them and duplicating the effort in various component files --- .changeset/three-games-cough.md | 7 +++ .../src/components/AlphaCard/AlphaCard.tsx | 28 +++++----- .../src/components/AlphaStack/AlphaStack.tsx | 10 +--- polaris-react/src/components/Bleed/Bleed.tsx | 31 +++++------ polaris-react/src/components/Box/Box.tsx | 54 ++++++++----------- .../src/components/Columns/Columns.tsx | 13 +++-- .../src/components/Inline/Inline.tsx | 10 +--- polaris-tokens/src/index.ts | 6 ++- polaris-tokens/src/token-groups/depth.ts | 8 +++ 9 files changed, 78 insertions(+), 89 deletions(-) create mode 100644 .changeset/three-games-cough.md diff --git a/.changeset/three-games-cough.md b/.changeset/three-games-cough.md new file mode 100644 index 00000000000..e814e7a026a --- /dev/null +++ b/.changeset/three-games-cough.md @@ -0,0 +1,7 @@ +--- +'@shopify/polaris': patch +'@shopify/polaris-tokens': minor +--- + +Refactored token types in primitive Layout components +Exposed `DepthShadowAlias` type diff --git a/polaris-react/src/components/AlphaCard/AlphaCard.tsx b/polaris-react/src/components/AlphaCard/AlphaCard.tsx index 9459390efe4..d8ba6b3d0ef 100644 --- a/polaris-react/src/components/AlphaCard/AlphaCard.tsx +++ b/polaris-react/src/components/AlphaCard/AlphaCard.tsx @@ -1,35 +1,33 @@ +import type { + BreakpointsAlias, + ColorsTokenName, + DepthShadowAlias, + ShapeBorderRadiusScale, + SpacingSpaceScale, +} from '@shopify/polaris-tokens'; import React from 'react'; import {useBreakpoints} from '../../utilities/breakpoints'; -// These should come from polaris-tokens eventually, see #7164 -import { - BackgroundColorTokenScale, - BorderRadiusTokenScale, - Box, - DepthTokenScale, - SpacingTokenScale, -} from '../Box'; +import {Box} from '../Box'; type CardElevationTokensScale = Extract< - DepthTokenScale, + DepthShadowAlias, 'card' | 'transparent' >; type CardBackgroundColorTokenScale = Extract< - BackgroundColorTokenScale, + ColorsTokenName, 'surface' | 'surface-subdued' >; -type Breakpoint = 'xs' | 'sm' | 'md' | 'lg' | 'xl'; - export interface AlphaCardProps { /** Elements to display inside card */ children?: React.ReactNode; backgroundColor?: CardBackgroundColorTokenScale; hasBorderRadius?: boolean; elevation?: CardElevationTokensScale; - padding?: SpacingTokenScale; - roundedAbove?: Breakpoint; + padding?: SpacingSpaceScale; + roundedAbove?: BreakpointsAlias; } export const AlphaCard = ({ @@ -41,7 +39,7 @@ export const AlphaCard = ({ roundedAbove, }: AlphaCardProps) => { const breakpoints = useBreakpoints(); - const defaultBorderRadius = '2' as BorderRadiusTokenScale; + const defaultBorderRadius = '2' as ShapeBorderRadiusScale; let hasBorderRadius = !roundedAbove && hasBorderRadiusProp; diff --git a/polaris-react/src/components/AlphaStack/AlphaStack.tsx b/polaris-react/src/components/AlphaStack/AlphaStack.tsx index 03798f09082..66b48beaf7d 100644 --- a/polaris-react/src/components/AlphaStack/AlphaStack.tsx +++ b/polaris-react/src/components/AlphaStack/AlphaStack.tsx @@ -1,23 +1,17 @@ import React from 'react'; -import type {spacing} from '@shopify/polaris-tokens'; +import type {SpacingSpaceScale} from '@shopify/polaris-tokens'; import {classNames} from '../../utilities/css'; import styles from './AlphaStack.scss'; -type SpacingTokenGroup = typeof spacing; -type SpacingTokenName = keyof SpacingTokenGroup; - -// TODO: Bring this logic into tokens -type Spacing = SpacingTokenName extends `space-${infer Scale}` ? Scale : never; - type Align = 'start' | 'end' | 'center'; export interface AlphaStackProps { /** Elements to display inside stack */ children?: React.ReactNode; /** Adjust spacing between elements */ - spacing?: Spacing; + spacing?: SpacingSpaceScale; /** Adjust vertical alignment of elements */ align?: Align; } diff --git a/polaris-react/src/components/Bleed/Bleed.tsx b/polaris-react/src/components/Bleed/Bleed.tsx index 4745cca36d4..e9c54e278fa 100644 --- a/polaris-react/src/components/Bleed/Bleed.tsx +++ b/polaris-react/src/components/Bleed/Bleed.tsx @@ -1,34 +1,27 @@ import React from 'react'; -import type {spacing} from '@shopify/polaris-tokens'; +import type {SpacingSpaceScale} from '@shopify/polaris-tokens'; import {sanitizeCustomProperties} from '../../utilities/css'; import styles from './Bleed.scss'; -type SpacingTokenName = keyof typeof spacing; - -// TODO: Bring this logic into tokens -type SpacingTokenScale = SpacingTokenName extends `space-${infer Scale}` - ? Scale - : never; - interface Spacing { - bottom: SpacingTokenScale; - left: SpacingTokenScale; - right: SpacingTokenScale; - top: SpacingTokenScale; + bottom: SpacingSpaceScale; + left: SpacingSpaceScale; + right: SpacingSpaceScale; + top: SpacingSpaceScale; } export interface BleedProps { /** Elements to display inside tile */ children: React.ReactNode; - spacing?: SpacingTokenScale; - horizontal?: SpacingTokenScale; - vertical?: SpacingTokenScale; - top?: SpacingTokenScale; - bottom?: SpacingTokenScale; - left?: SpacingTokenScale; - right?: SpacingTokenScale; + spacing?: SpacingSpaceScale; + horizontal?: SpacingSpaceScale; + vertical?: SpacingSpaceScale; + top?: SpacingSpaceScale; + bottom?: SpacingSpaceScale; + left?: SpacingSpaceScale; + right?: SpacingSpaceScale; } export const Bleed = ({ diff --git a/polaris-react/src/components/Box/Box.tsx b/polaris-react/src/components/Box/Box.tsx index a5924547689..ed47a048d5b 100644 --- a/polaris-react/src/components/Box/Box.tsx +++ b/polaris-react/src/components/Box/Box.tsx @@ -1,12 +1,16 @@ import React, {createElement, forwardRef, ReactNode} from 'react'; -import type {colors, depth, shape, spacing} from '@shopify/polaris-tokens'; +import type { + ColorsTokenName, + DepthShadowAlias, + ShapeTokenName, + SpacingSpaceScale, +} from '@shopify/polaris-tokens'; import {classNames, sanitizeCustomProperties} from '../../utilities/css'; import styles from './Box.scss'; -type ColorsTokenName = keyof typeof colors; -export type BackgroundColorTokenScale = Extract< +type BackgroundColorTokenScale = Extract< ColorsTokenName, | 'background' | `background-${string}` @@ -18,13 +22,6 @@ export type BackgroundColorTokenScale = Extract< >; type ColorTokenScale = Extract; -type DepthTokenName = keyof typeof depth; -type ShadowsTokenName = Exclude; -export type DepthTokenScale = ShadowsTokenName extends `shadow-${infer Scale}` - ? Scale - : never; - -type ShapeTokenName = keyof typeof shape; type BorderShapeTokenScale = ShapeTokenName extends `border-${infer Scale}` ? Scale : never; @@ -40,7 +37,7 @@ interface Border { top: BorderTokenScale; } -export type BorderRadiusTokenScale = Extract< +type BorderRadiusTokenScale = Extract< BorderShapeTokenScale, `radius-${string}` > extends `radius-${infer Scale}` @@ -54,16 +51,11 @@ interface BorderRadius { topRight: BorderRadiusTokenScale; } -type SpacingTokenName = keyof typeof spacing; -export type SpacingTokenScale = SpacingTokenName extends `space-${infer Scale}` - ? Scale - : never; - interface Spacing { - bottom: SpacingTokenScale; - left: SpacingTokenScale; - right: SpacingTokenScale; - top: SpacingTokenScale; + bottom: SpacingSpaceScale; + left: SpacingSpaceScale; + right: SpacingSpaceScale; + top: SpacingSpaceScale; } type Element = 'div' | 'span'; @@ -98,29 +90,29 @@ export interface BoxProps { /** Color of children */ color?: ColorTokenScale; /** Spacing outside of container */ - margin?: SpacingTokenScale; + margin?: SpacingSpaceScale; /** Bottom spacing outside of container */ - marginBottom?: SpacingTokenScale; + marginBottom?: SpacingSpaceScale; /** Left spacing outside of container */ - marginLeft?: SpacingTokenScale; + marginLeft?: SpacingSpaceScale; /** Right spacing outside of container */ - marginRight?: SpacingTokenScale; + marginRight?: SpacingSpaceScale; /** Top spacing outside of container */ - marginTop?: SpacingTokenScale; + marginTop?: SpacingSpaceScale; /** Maximum width of container */ maxWidth?: string; /** Spacing around children */ - padding?: SpacingTokenScale; + padding?: SpacingSpaceScale; /** Bottom spacing around children */ - paddingBottom?: SpacingTokenScale; + paddingBottom?: SpacingSpaceScale; /** Left spacing around children */ - paddingLeft?: SpacingTokenScale; + paddingLeft?: SpacingSpaceScale; /** Right spacing around children */ - paddingRight?: SpacingTokenScale; + paddingRight?: SpacingSpaceScale; /** Top spacing around children */ - paddingTop?: SpacingTokenScale; + paddingTop?: SpacingSpaceScale; /** Shadow */ - shadow?: DepthTokenScale; + shadow?: DepthShadowAlias; } export const Box = forwardRef( diff --git a/polaris-react/src/components/Columns/Columns.tsx b/polaris-react/src/components/Columns/Columns.tsx index 0f1660287a9..2696d58560b 100644 --- a/polaris-react/src/components/Columns/Columns.tsx +++ b/polaris-react/src/components/Columns/Columns.tsx @@ -1,20 +1,19 @@ import React from 'react'; -import type {spacing} from '@shopify/polaris-tokens'; +import type { + BreakpointsAlias, + SpacingSpaceScale, +} from '@shopify/polaris-tokens'; import {sanitizeCustomProperties} from '../../utilities/css'; import styles from './Columns.scss'; -type Breakpoints = 'xs' | 'sm' | 'md' | 'lg' | 'xl'; -type SpacingName = keyof typeof spacing; -type SpacingScale = SpacingName extends `space-${infer Scale}` ? Scale : never; - type Columns = { - [Breakpoint in Breakpoints]?: number | string; + [Breakpoint in BreakpointsAlias]?: number | string; }; type Gap = { - [Breakpoint in Breakpoints]?: SpacingScale; + [Breakpoint in BreakpointsAlias]?: SpacingSpaceScale; }; export interface ColumnsProps { diff --git a/polaris-react/src/components/Inline/Inline.tsx b/polaris-react/src/components/Inline/Inline.tsx index 1278239ee08..9afc139403f 100644 --- a/polaris-react/src/components/Inline/Inline.tsx +++ b/polaris-react/src/components/Inline/Inline.tsx @@ -1,16 +1,10 @@ import React from 'react'; -import type {spacing} from '@shopify/polaris-tokens'; +import type {SpacingSpaceScale} from '@shopify/polaris-tokens'; import {elementChildren} from '../../utilities/components'; import styles from './Inline.scss'; -type SpacingTokenGroup = typeof spacing; -type SpacingTokenName = keyof SpacingTokenGroup; - -// TODO: Bring this logic into tokens -type Spacing = SpacingTokenName extends `space-${infer Scale}` ? Scale : never; - const AlignY = { top: 'start', center: 'center', @@ -26,7 +20,7 @@ export interface InlineProps { /** Wrap stack elements to additional rows as needed on small screens (Defaults to true) */ wrap?: boolean; /** Adjust spacing between elements */ - spacing?: Spacing; + spacing?: SpacingSpaceScale; /** Adjust vertical alignment of elements */ alignY?: keyof typeof AlignY; /** Adjust horizontal alignment of elements */ diff --git a/polaris-tokens/src/index.ts b/polaris-tokens/src/index.ts index cfbe36769cb..769bc580bc3 100644 --- a/polaris-tokens/src/index.ts +++ b/polaris-tokens/src/index.ts @@ -15,7 +15,11 @@ export type { export type {ColorsTokenGroup, ColorsTokenName} from './token-groups/colors'; -export type {DepthTokenGroup, DepthTokenName} from './token-groups/depth'; +export type { + DepthTokenGroup, + DepthTokenName, + DepthShadowAlias, +} from './token-groups/depth'; export type { FontTokenGroup, diff --git a/polaris-tokens/src/token-groups/depth.ts b/polaris-tokens/src/token-groups/depth.ts index e30dcf204e6..3b8a9ef2486 100644 --- a/polaris-tokens/src/token-groups/depth.ts +++ b/polaris-tokens/src/token-groups/depth.ts @@ -44,3 +44,11 @@ export const depth = { export type DepthTokenGroup = TokenGroup; export type DepthTokenName = keyof DepthTokenGroup; + +// temporary until shadows prefix is removed +type ShadowsTokenName = Exclude; + +// e.g. "transparent" | "faint" | "base" | "deep" | ... +export type DepthShadowAlias = ShadowsTokenName extends `shadow-${infer Scale}` + ? Scale + : never; From ea250a96abf3b096ba2c65a95963e1172b0fbb24 Mon Sep 17 00:00:00 2001 From: aveline Date: Fri, 30 Sep 2022 10:02:56 -0700 Subject: [PATCH 19/25] Add `fullWidth` prop for `AlphaStack` (#7309) Co-authored-by: Lo Kim --- .changeset/stale-penguins-love.md | 6 ++++++ .../src/components/AlphaStack/AlphaStack.scss | 6 ++++++ .../AlphaStack/AlphaStack.stories.tsx | 11 ++++++++++ .../src/components/AlphaStack/AlphaStack.tsx | 14 +++++++++---- .../content/components/alpha-stack/index.md | 4 ++++ .../alpha-stack-with-full-width-children.tsx | 21 +++++++++++++++++++ 6 files changed, 58 insertions(+), 4 deletions(-) create mode 100644 .changeset/stale-penguins-love.md create mode 100644 polaris.shopify.com/pages/examples/alpha-stack-with-full-width-children.tsx diff --git a/.changeset/stale-penguins-love.md b/.changeset/stale-penguins-love.md new file mode 100644 index 00000000000..ccaac470d58 --- /dev/null +++ b/.changeset/stale-penguins-love.md @@ -0,0 +1,6 @@ +--- +'@shopify/polaris': minor +'polaris.shopify.com': patch +--- + +Added `fullWidth` prop to `AlphaStack` and updated styleguide docs diff --git a/polaris-react/src/components/AlphaStack/AlphaStack.scss b/polaris-react/src/components/AlphaStack/AlphaStack.scss index 445951993b9..8b4f8c402c6 100644 --- a/polaris-react/src/components/AlphaStack/AlphaStack.scss +++ b/polaris-react/src/components/AlphaStack/AlphaStack.scss @@ -8,3 +8,9 @@ max-width: 100%; } } + +.fullWidth { + > * { + width: 100%; + } +} diff --git a/polaris-react/src/components/AlphaStack/AlphaStack.stories.tsx b/polaris-react/src/components/AlphaStack/AlphaStack.stories.tsx index 8758d651d8a..8f6d165f38c 100644 --- a/polaris-react/src/components/AlphaStack/AlphaStack.stories.tsx +++ b/polaris-react/src/components/AlphaStack/AlphaStack.stories.tsx @@ -49,3 +49,14 @@ export function AlignEnd() { ); } + +export function FullWidthChildren() { + return ( + + Paid + Processing + Fulfilled + Completed + + ); +} diff --git a/polaris-react/src/components/AlphaStack/AlphaStack.tsx b/polaris-react/src/components/AlphaStack/AlphaStack.tsx index 66b48beaf7d..e5993204929 100644 --- a/polaris-react/src/components/AlphaStack/AlphaStack.tsx +++ b/polaris-react/src/components/AlphaStack/AlphaStack.tsx @@ -10,18 +10,24 @@ type Align = 'start' | 'end' | 'center'; export interface AlphaStackProps { /** Elements to display inside stack */ children?: React.ReactNode; - /** Adjust spacing between elements */ - spacing?: SpacingSpaceScale; /** Adjust vertical alignment of elements */ align?: Align; + /** Toggle elements to be full width */ + fullWidth?: boolean; + /** Adjust spacing between elements */ + spacing?: SpacingSpaceScale; } export const AlphaStack = ({ children, - spacing = '4', align = 'start', + fullWidth, + spacing = '4', }: AlphaStackProps) => { - const className = classNames(styles.AlphaStack); + const className = classNames( + styles.AlphaStack, + fullWidth && styles.fullWidth, + ); const style = { '--pc-stack-align': align ? `${align}` : '', diff --git a/polaris.shopify.com/content/components/alpha-stack/index.md b/polaris.shopify.com/content/components/alpha-stack/index.md index bc738f1f0d7..da6eb3997f7 100644 --- a/polaris.shopify.com/content/components/alpha-stack/index.md +++ b/polaris.shopify.com/content/components/alpha-stack/index.md @@ -18,4 +18,8 @@ examples: title: Vertical spacing description: >- Vertical spacing for children can be set with the spacing property. Spacing options are provided using our spacing tokens. + - fileName: alpha-stack-with-full-width-children.tsx + title: Full width children + description: >- + Set children to full width --- diff --git a/polaris.shopify.com/pages/examples/alpha-stack-with-full-width-children.tsx b/polaris.shopify.com/pages/examples/alpha-stack-with-full-width-children.tsx new file mode 100644 index 00000000000..428fc3f7928 --- /dev/null +++ b/polaris.shopify.com/pages/examples/alpha-stack-with-full-width-children.tsx @@ -0,0 +1,21 @@ +import React from 'react'; +import {AlphaStack, Badge, Text} from '@shopify/polaris'; + +import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; + +function AlphaStackWithFullWidthChildrenExample() { + return ( +
+ + + AlphaStack + + One + Two + Three + +
+ ); +} + +export default withPolarisExample(AlphaStackWithFullWidthChildrenExample); From e84a772c0b85b814837b8399188051dbd995c44f Mon Sep 17 00:00:00 2001 From: aveline Date: Fri, 30 Sep 2022 14:07:32 -0700 Subject: [PATCH 20/25] Alpha card props (#7314) ### WHY are these changes introduced? Rename `AlphaCard` background prop for consistency --- .changeset/fuzzy-trainers-allow.md | 6 + .../AlphaCard/AlphaCard.stories.tsx | 2 +- .../src/components/AlphaCard/AlphaCard.tsx | 6 +- .../pages/examples/alpha-card-subdued.tsx | 2 +- polaris.shopify.com/src/data/props.json | 4672 ++++++++--------- 5 files changed, 2311 insertions(+), 2377 deletions(-) create mode 100644 .changeset/fuzzy-trainers-allow.md diff --git a/.changeset/fuzzy-trainers-allow.md b/.changeset/fuzzy-trainers-allow.md new file mode 100644 index 00000000000..4f6e4ef5d19 --- /dev/null +++ b/.changeset/fuzzy-trainers-allow.md @@ -0,0 +1,6 @@ +--- +'@shopify/polaris': patch +'polaris.shopify.com': patch +--- + +Renamed `background` prop on `AlphaCard` for consistency diff --git a/polaris-react/src/components/AlphaCard/AlphaCard.stories.tsx b/polaris-react/src/components/AlphaCard/AlphaCard.stories.tsx index 0c85ff5d39d..562c4778dfd 100644 --- a/polaris-react/src/components/AlphaCard/AlphaCard.stories.tsx +++ b/polaris-react/src/components/AlphaCard/AlphaCard.stories.tsx @@ -21,7 +21,7 @@ export function Default() { export function BackgroundSubdued() { return ( - + Online store dashboard diff --git a/polaris-react/src/components/AlphaCard/AlphaCard.tsx b/polaris-react/src/components/AlphaCard/AlphaCard.tsx index d8ba6b3d0ef..d632ff46362 100644 --- a/polaris-react/src/components/AlphaCard/AlphaCard.tsx +++ b/polaris-react/src/components/AlphaCard/AlphaCard.tsx @@ -23,7 +23,7 @@ type CardBackgroundColorTokenScale = Extract< export interface AlphaCardProps { /** Elements to display inside card */ children?: React.ReactNode; - backgroundColor?: CardBackgroundColorTokenScale; + background?: CardBackgroundColorTokenScale; hasBorderRadius?: boolean; elevation?: CardElevationTokensScale; padding?: SpacingSpaceScale; @@ -32,7 +32,7 @@ export interface AlphaCardProps { export const AlphaCard = ({ children, - backgroundColor = 'surface', + background = 'surface', hasBorderRadius: hasBorderRadiusProp = true, elevation = 'card', padding = '5', @@ -49,7 +49,7 @@ export const AlphaCard = ({ return ( + Online store dashboard diff --git a/polaris.shopify.com/src/data/props.json b/polaris.shopify.com/src/data/props.json index bd41bb92529..756e4dd503b 100644 --- a/polaris.shopify.com/src/data/props.json +++ b/polaris.shopify.com/src/data/props.json @@ -3782,30 +3782,6 @@ "value": "interface MappedActionContextType {\n role?: string;\n url?: string;\n external?: boolean;\n onAction?(): void;\n destructive?: boolean;\n}" } }, - "FeaturesConfig": { - "polaris-react/src/utilities/features/types.ts": { - "filePath": "polaris-react/src/utilities/features/types.ts", - "name": "FeaturesConfig", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/utilities/features/types.ts", - "name": "[key: string]", - "value": "boolean" - } - ], - "value": "export interface FeaturesConfig {\n [key: string]: boolean;\n}" - } - }, - "Features": { - "polaris-react/src/utilities/features/types.ts": { - "filePath": "polaris-react/src/utilities/features/types.ts", - "name": "Features", - "description": "", - "members": [], - "value": "export interface Features {}" - } - }, "IdGenerator": { "polaris-react/src/utilities/unique-id/unique-id-factory.ts": { "filePath": "polaris-react/src/utilities/unique-id/unique-id-factory.ts", @@ -3841,6 +3817,30 @@ "value": "interface Options {\n trapping: boolean;\n}" } }, + "FeaturesConfig": { + "polaris-react/src/utilities/features/types.ts": { + "filePath": "polaris-react/src/utilities/features/types.ts", + "name": "FeaturesConfig", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/utilities/features/types.ts", + "name": "[key: string]", + "value": "boolean" + } + ], + "value": "export interface FeaturesConfig {\n [key: string]: boolean;\n}" + } + }, + "Features": { + "polaris-react/src/utilities/features/types.ts": { + "filePath": "polaris-react/src/utilities/features/types.ts", + "name": "Features", + "description": "", + "members": [], + "value": "export interface Features {}" + } + }, "Logo": { "polaris-react/src/utilities/frame/types.ts": { "filePath": "polaris-react/src/utilities/frame/types.ts", @@ -7218,6 +7218,15 @@ "description": "" } }, + "PortalsContainerElement": { + "polaris-react/src/utilities/portals/types.ts": { + "filePath": "polaris-react/src/utilities/portals/types.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PortalsContainerElement", + "value": "HTMLDivElement | null", + "description": "" + } + }, "NavigableOption": { "polaris-react/src/utilities/listbox/types.ts": { "filePath": "polaris-react/src/utilities/listbox/types.ts", @@ -7296,15 +7305,6 @@ "value": "export interface ListboxContextType {\n onOptionSelect(option: NavigableOption): void;\n setLoading(label?: string): void;\n}" } }, - "PortalsContainerElement": { - "polaris-react/src/utilities/portals/types.ts": { - "filePath": "polaris-react/src/utilities/portals/types.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "PortalsContainerElement", - "value": "HTMLDivElement | null", - "description": "" - } - }, "ResourceListSelectedItems": { "polaris-react/src/utilities/resource-list/types.ts": { "filePath": "polaris-react/src/utilities/resource-list/types.ts", @@ -7662,56 +7662,6 @@ "value": "export interface AccountConnectionProps {\n /** Content to display as title */\n title?: React.ReactNode;\n /** Content to display as additional details */\n details?: React.ReactNode;\n /** Content to display as terms of service */\n termsOfService?: React.ReactNode;\n /** The name of the service */\n accountName?: string;\n /** URL for the user’s avatar image */\n avatarUrl?: string;\n /** Set if the account is connected */\n connected?: boolean;\n /** Action for account connection */\n action?: Action;\n}" } }, - "ActionMenuProps": { - "polaris-react/src/components/ActionMenu/ActionMenu.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "name": "ActionMenuProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "actions", - "value": "MenuActionDescriptor[]", - "description": "Collection of page-level secondary actions", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "groups", - "value": "MenuGroupDescriptor[]", - "description": "Collection of page-level action groups", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "rollup", - "value": "boolean", - "description": "Roll up all actions into a Popover > ActionList", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "rollupActionsLabel", - "value": "string", - "description": "Label for rolled up actions activator", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "MethodSignature", - "name": "onActionRollup", - "value": "(hasRolledUp: boolean) => void", - "description": "Callback that returns true when secondary actions are rolled up into action groups, and false when not", - "isOptional": true - } - ], - "value": "export interface ActionMenuProps {\n /** Collection of page-level secondary actions */\n actions?: MenuActionDescriptor[];\n /** Collection of page-level action groups */\n groups?: MenuGroupDescriptor[];\n /** Roll up all actions into a Popover > ActionList */\n rollup?: boolean;\n /** Label for rolled up actions activator */\n rollupActionsLabel?: string;\n /** Callback that returns true when secondary actions are rolled up into action groups, and false when not */\n onActionRollup?(hasRolledUp: boolean): void;\n}" - } - }, "Props": { "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx": { "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", @@ -7988,12 +7938,62 @@ "value": "interface Props {\n /** Callback when the search is dismissed */\n onDismiss?(): void;\n /** Determines whether the overlay should be visible */\n visible: boolean;\n}" } }, + "ActionMenuProps": { + "polaris-react/src/components/ActionMenu/ActionMenu.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "name": "ActionMenuProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "actions", + "value": "MenuActionDescriptor[]", + "description": "Collection of page-level secondary actions", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "groups", + "value": "MenuGroupDescriptor[]", + "description": "Collection of page-level action groups", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "rollup", + "value": "boolean", + "description": "Roll up all actions into a Popover > ActionList", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "rollupActionsLabel", + "value": "string", + "description": "Label for rolled up actions activator", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "MethodSignature", + "name": "onActionRollup", + "value": "(hasRolledUp: boolean) => void", + "description": "Callback that returns true when secondary actions are rolled up into action groups, and false when not", + "isOptional": true + } + ], + "value": "export interface ActionMenuProps {\n /** Collection of page-level secondary actions */\n actions?: MenuActionDescriptor[];\n /** Collection of page-level action groups */\n groups?: MenuGroupDescriptor[];\n /** Roll up all actions into a Popover > ActionList */\n rollup?: boolean;\n /** Label for rolled up actions activator */\n rollupActionsLabel?: string;\n /** Callback that returns true when secondary actions are rolled up into action groups, and false when not */\n onActionRollup?(hasRolledUp: boolean): void;\n}" + } + }, "CardElevationTokensScale": { "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", "syntaxKind": "TypeAliasDeclaration", "name": "CardElevationTokensScale", - "value": "Extract<\n DepthTokenScale,\n 'card' | 'transparent'\n>", + "value": "Extract<\n DepthShadowAlias,\n 'card' | 'transparent'\n>", "description": "" } }, @@ -8002,16 +8002,7 @@ "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", "syntaxKind": "TypeAliasDeclaration", "name": "CardBackgroundColorTokenScale", - "value": "Extract<\n BackgroundColorTokenScale,\n 'surface' | `surface-${string}`\n>", - "description": "" - } - }, - "Breakpoint": { - "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { - "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Breakpoint", - "value": "'xs' | 'sm' | 'md' | 'lg' | 'xl'", + "value": "Extract<\n ColorsTokenName,\n 'surface' | 'surface-subdued'\n>", "description": "" } }, @@ -8032,7 +8023,7 @@ { "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", "syntaxKind": "PropertySignature", - "name": "backgroundColor", + "name": "background", "value": "CardBackgroundColorTokenScale", "description": "", "isOptional": true @@ -8040,8 +8031,8 @@ { "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", "syntaxKind": "PropertySignature", - "name": "borderRadius", - "value": "\"base\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"large\" | \"half\"", + "name": "hasBorderRadius", + "value": "boolean", "description": "", "isOptional": true }, @@ -8057,7 +8048,7 @@ "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", "syntaxKind": "PropertySignature", "name": "padding", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", "description": "", "isOptional": true }, @@ -8065,12 +8056,12 @@ "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", "syntaxKind": "PropertySignature", "name": "roundedAbove", - "value": "Breakpoint", + "value": "\"xs\" | \"sm\" | \"md\" | \"lg\" | \"xl\"", "description": "", "isOptional": true } ], - "value": "export interface AlphaCardProps {\n /** Elements to display inside card */\n children?: React.ReactNode;\n backgroundColor?: CardBackgroundColorTokenScale;\n borderRadius?: BorderRadiusTokenScale;\n elevation?: CardElevationTokensScale;\n padding?: SpacingTokenScale;\n roundedAbove?: Breakpoint;\n}" + "value": "export interface AlphaCardProps {\n /** Elements to display inside card */\n children?: React.ReactNode;\n background?: CardBackgroundColorTokenScale;\n hasBorderRadius?: boolean;\n elevation?: CardElevationTokensScale;\n padding?: SpacingSpaceScale;\n roundedAbove?: BreakpointsAlias;\n}" } }, "ActionListProps": { @@ -8124,223 +8115,62 @@ "description": "" } }, - "SpacingTokenGroup": { - "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { - "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "SpacingTokenGroup", - "value": "typeof spacing", - "description": "" - }, - "polaris-react/src/components/Box/Box.tsx": { - "filePath": "polaris-react/src/components/Box/Box.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "SpacingTokenGroup", - "value": "typeof spacing", - "description": "" - }, - "polaris-react/src/components/Inline/Inline.tsx": { - "filePath": "polaris-react/src/components/Inline/Inline.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "SpacingTokenGroup", - "value": "typeof spacing", - "description": "" - } - }, - "SpacingTokenName": { + "Align": { "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "SpacingTokenName", - "value": "keyof SpacingTokenGroup", - "description": "" - }, - "polaris-react/src/components/Bleed/Bleed.tsx": { - "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "SpacingTokenName", - "value": "keyof typeof spacing", - "description": "" - }, - "polaris-react/src/components/Box/Box.tsx": { - "filePath": "polaris-react/src/components/Box/Box.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "SpacingTokenName", - "value": "keyof SpacingTokenGroup", + "name": "Align", + "value": "'start' | 'end' | 'center'", "description": "" }, "polaris-react/src/components/Inline/Inline.tsx": { "filePath": "polaris-react/src/components/Inline/Inline.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "SpacingTokenName", - "value": "keyof SpacingTokenGroup", - "description": "" - }, - "polaris-react/src/components/Tile/Tile.tsx": { - "filePath": "polaris-react/src/components/Tile/Tile.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "SpacingTokenName", - "value": "keyof typeof spacing", + "name": "Align", + "value": "'start' | 'center' | 'end'", "description": "" } }, - "Spacing": { + "AlphaStackProps": { "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", - "value": "SpacingTokenName extends `space-${infer Scale}` ? Scale : never", - "description": "" - }, - "polaris-react/src/components/Bleed/Bleed.tsx": { - "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", - "name": "Spacing", + "name": "AlphaStackProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", "syntaxKind": "PropertySignature", - "name": "bottom", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "" + "name": "children", + "value": "React.ReactNode", + "description": "Elements to display inside stack", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", "syntaxKind": "PropertySignature", - "name": "left", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "" + "name": "align", + "value": "Align", + "description": "Adjust vertical alignment of elements", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", "syntaxKind": "PropertySignature", - "name": "right", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "" + "name": "fullWidth", + "value": "boolean", + "description": "Toggle elements to be full width", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", "syntaxKind": "PropertySignature", - "name": "top", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "" + "name": "spacing", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Adjust spacing between elements", + "isOptional": true } ], - "value": "interface Spacing {\n bottom: SpacingTokenScale;\n left: SpacingTokenScale;\n right: SpacingTokenScale;\n top: SpacingTokenScale;\n}" - }, - "polaris-react/src/components/Box/Box.tsx": { - "filePath": "polaris-react/src/components/Box/Box.tsx", - "name": "Spacing", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Box/Box.tsx", - "syntaxKind": "PropertySignature", - "name": "bottom", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Box/Box.tsx", - "syntaxKind": "PropertySignature", - "name": "left", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Box/Box.tsx", - "syntaxKind": "PropertySignature", - "name": "right", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Box/Box.tsx", - "syntaxKind": "PropertySignature", - "name": "top", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "" - } - ], - "value": "interface Spacing {\n bottom: SpacingTokenScale;\n left: SpacingTokenScale;\n right: SpacingTokenScale;\n top: SpacingTokenScale;\n}" - }, - "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", - "value": "'extraTight' | 'tight' | 'loose'", - "description": "" - }, - "polaris-react/src/components/Inline/Inline.tsx": { - "filePath": "polaris-react/src/components/Inline/Inline.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", - "value": "SpacingTokenName extends `space-${infer Scale}` ? Scale : never", - "description": "" - }, - "polaris-react/src/components/Stack/Stack.tsx": { - "filePath": "polaris-react/src/components/Stack/Stack.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", - "value": "'extraTight' | 'tight' | 'baseTight' | 'loose' | 'extraLoose' | 'none'", - "description": "" - }, - "polaris-react/src/components/TextContainer/TextContainer.tsx": { - "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Spacing", - "value": "'tight' | 'loose'", - "description": "" - } - }, - "Align": { - "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { - "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Align", - "value": "'start' | 'end' | 'center'", - "description": "" - }, - "polaris-react/src/components/Inline/Inline.tsx": { - "filePath": "polaris-react/src/components/Inline/Inline.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Align", - "value": "'start' | 'center' | 'end'", - "description": "" - } - }, - "AlphaStackProps": { - "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { - "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", - "name": "AlphaStackProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Elements to display inside stack", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", - "syntaxKind": "PropertySignature", - "name": "spacing", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "Adjust spacing between elements", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", - "syntaxKind": "PropertySignature", - "name": "align", - "value": "Align", - "description": "Adjust vertical alignment of elements", - "isOptional": true - } - ], - "value": "export interface AlphaStackProps {\n /** Elements to display inside stack */\n children?: React.ReactNode;\n /** Adjust spacing between elements */\n spacing?: Spacing;\n /** Adjust vertical alignment of elements */\n align?: Align;\n}" + "value": "export interface AlphaStackProps {\n /** Elements to display inside stack */\n children?: React.ReactNode;\n /** Adjust vertical alignment of elements */\n align?: Align;\n /** Toggle elements to be full width */\n fullWidth?: boolean;\n /** Adjust spacing between elements */\n spacing?: SpacingSpaceScale;\n}" } }, "State": { @@ -9805,19 +9635,98 @@ "value": "export interface BannerHandles {\n focus(): void;\n}" } }, - "SpacingTokenScale": { + "Spacing": { "polaris-react/src/components/Bleed/Bleed.tsx": { "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "SpacingTokenScale", - "value": "SpacingTokenName extends `space-${infer Scale}`\n ? Scale\n : never", - "description": "" + "name": "Spacing", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "syntaxKind": "PropertySignature", + "name": "bottom", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "syntaxKind": "PropertySignature", + "name": "left", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "syntaxKind": "PropertySignature", + "name": "right", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", + "syntaxKind": "PropertySignature", + "name": "top", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "" + } + ], + "value": "interface Spacing {\n bottom: SpacingSpaceScale;\n left: SpacingSpaceScale;\n right: SpacingSpaceScale;\n top: SpacingSpaceScale;\n}" }, "polaris-react/src/components/Box/Box.tsx": { "filePath": "polaris-react/src/components/Box/Box.tsx", + "name": "Spacing", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "bottom", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "left", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "right", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "top", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "" + } + ], + "value": "interface Spacing {\n bottom: SpacingSpaceScale;\n left: SpacingSpaceScale;\n right: SpacingSpaceScale;\n top: SpacingSpaceScale;\n}" + }, + "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Spacing", + "value": "'extraTight' | 'tight' | 'loose'", + "description": "" + }, + "polaris-react/src/components/Stack/Stack.tsx": { + "filePath": "polaris-react/src/components/Stack/Stack.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Spacing", + "value": "'extraTight' | 'tight' | 'baseTight' | 'loose' | 'extraLoose' | 'none'", + "description": "" + }, + "polaris-react/src/components/TextContainer/TextContainer.tsx": { + "filePath": "polaris-react/src/components/TextContainer/TextContainer.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "SpacingTokenScale", - "value": "SpacingTokenName extends `space-${infer Scale}`\n ? Scale\n : never", + "name": "Spacing", + "value": "'tight' | 'loose'", "description": "" } }, @@ -9838,7 +9747,7 @@ "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", "syntaxKind": "PropertySignature", "name": "spacing", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", "description": "", "isOptional": true }, @@ -9846,7 +9755,7 @@ "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", "syntaxKind": "PropertySignature", "name": "horizontal", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", "description": "", "isOptional": true }, @@ -9854,7 +9763,7 @@ "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", "syntaxKind": "PropertySignature", "name": "vertical", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", "description": "", "isOptional": true }, @@ -9862,7 +9771,7 @@ "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", "syntaxKind": "PropertySignature", "name": "top", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", "description": "", "isOptional": true }, @@ -9870,7 +9779,7 @@ "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", "syntaxKind": "PropertySignature", "name": "bottom", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", "description": "", "isOptional": true }, @@ -9878,7 +9787,7 @@ "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", "syntaxKind": "PropertySignature", "name": "left", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", "description": "", "isOptional": true }, @@ -9886,30 +9795,12 @@ "filePath": "polaris-react/src/components/Bleed/Bleed.tsx", "syntaxKind": "PropertySignature", "name": "right", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", "description": "", "isOptional": true } ], - "value": "export interface BleedProps {\n /** Elements to display inside tile */\n children: React.ReactNode;\n spacing?: SpacingTokenScale;\n horizontal?: SpacingTokenScale;\n vertical?: SpacingTokenScale;\n top?: SpacingTokenScale;\n bottom?: SpacingTokenScale;\n left?: SpacingTokenScale;\n right?: SpacingTokenScale;\n}" - } - }, - "ColorsTokenGroup": { - "polaris-react/src/components/Box/Box.tsx": { - "filePath": "polaris-react/src/components/Box/Box.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "ColorsTokenGroup", - "value": "typeof colors", - "description": "" - } - }, - "ColorsTokenName": { - "polaris-react/src/components/Box/Box.tsx": { - "filePath": "polaris-react/src/components/Box/Box.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "ColorsTokenName", - "value": "keyof ColorsTokenGroup", - "description": "" + "value": "export interface BleedProps {\n /** Elements to display inside tile */\n children: React.ReactNode;\n spacing?: SpacingSpaceScale;\n horizontal?: SpacingSpaceScale;\n vertical?: SpacingSpaceScale;\n top?: SpacingSpaceScale;\n bottom?: SpacingSpaceScale;\n left?: SpacingSpaceScale;\n right?: SpacingSpaceScale;\n}" } }, "BackgroundColorTokenScale": { @@ -9917,61 +9808,16 @@ "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "TypeAliasDeclaration", "name": "BackgroundColorTokenScale", - "value": "Extract<\n ColorsTokenName,\n | 'background'\n | `background-${string}`\n | 'surface'\n | `surface-${string}`\n | 'backdrop'\n | 'overlay'\n>", - "description": "" - } - }, - "DepthTokenGroup": { - "polaris-react/src/components/Box/Box.tsx": { - "filePath": "polaris-react/src/components/Box/Box.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "DepthTokenGroup", - "value": "typeof depth", - "description": "" - } - }, - "DepthTokenName": { - "polaris-react/src/components/Box/Box.tsx": { - "filePath": "polaris-react/src/components/Box/Box.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "DepthTokenName", - "value": "keyof DepthTokenGroup", - "description": "" - } - }, - "ShadowsTokenName": { - "polaris-react/src/components/Box/Box.tsx": { - "filePath": "polaris-react/src/components/Box/Box.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShadowsTokenName", - "value": "Exclude", - "description": "" - } - }, - "DepthTokenScale": { - "polaris-react/src/components/Box/Box.tsx": { - "filePath": "polaris-react/src/components/Box/Box.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "DepthTokenScale", - "value": "ShadowsTokenName extends `shadow-${infer Scale}`\n ? Scale\n : never", - "description": "" - } - }, - "ShapeTokenGroup": { - "polaris-react/src/components/Box/Box.tsx": { - "filePath": "polaris-react/src/components/Box/Box.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "ShapeTokenGroup", - "value": "typeof shape", + "value": "Extract<\n ColorsTokenName,\n | 'background'\n | `background-${string}`\n | 'surface'\n | `surface-${string}`\n | 'backdrop'\n | 'overlay'\n | `action-${string}`\n>", "description": "" } }, - "ShapeTokenName": { + "ColorTokenScale": { "polaris-react/src/components/Box/Box.tsx": { "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "ShapeTokenName", - "value": "keyof ShapeTokenGroup", + "name": "ColorTokenScale", + "value": "Extract", "description": "" } }, @@ -10078,6 +9924,22 @@ "value": "interface BorderRadius {\n bottomLeft: BorderRadiusTokenScale;\n bottomRight: BorderRadiusTokenScale;\n topLeft: BorderRadiusTokenScale;\n topRight: BorderRadiusTokenScale;\n}" } }, + "Element": { + "polaris-react/src/components/Box/Box.tsx": { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Element", + "value": "'div' | 'span'", + "description": "" + }, + "polaris-react/src/components/Text/Text.tsx": { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Element", + "value": "'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'p' | 'span'", + "description": "" + } + }, "BoxProps": { "polaris-react/src/components/Box/Box.tsx": { "filePath": "polaris-react/src/components/Box/Box.tsx", @@ -10088,8 +9950,8 @@ "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "PropertySignature", "name": "as", - "value": "\"div\" | \"span\"", - "description": "", + "value": "Element", + "description": "HTML Element type", "isOptional": true }, { @@ -10097,7 +9959,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "BackgroundColorTokenScale", - "description": "Background color of the Box", + "description": "Background color", "isOptional": true }, { @@ -10105,7 +9967,7 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderTokenScale", - "description": "Border styling of the Box", + "description": "Border style", "isOptional": true }, { @@ -10113,7 +9975,7 @@ "syntaxKind": "PropertySignature", "name": "borderBottom", "value": "BorderTokenScale", - "description": "Bottom border styling of the Box", + "description": "Bottom border style", "isOptional": true }, { @@ -10121,7 +9983,7 @@ "syntaxKind": "PropertySignature", "name": "borderLeft", "value": "BorderTokenScale", - "description": "Left border styling of the Box", + "description": "Left border style", "isOptional": true }, { @@ -10129,7 +9991,7 @@ "syntaxKind": "PropertySignature", "name": "borderRight", "value": "BorderTokenScale", - "description": "Right border styling of the Box", + "description": "Right border style", "isOptional": true }, { @@ -10137,7 +9999,7 @@ "syntaxKind": "PropertySignature", "name": "borderTop", "value": "BorderTokenScale", - "description": "Top border styling of the Box", + "description": "Top border style", "isOptional": true }, { @@ -10145,7 +10007,7 @@ "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "\"base\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"large\" | \"half\"", - "description": "Border radius of the Box", + "description": "Border radius", "isOptional": true }, { @@ -10153,7 +10015,7 @@ "syntaxKind": "PropertySignature", "name": "borderRadiusBottomLeft", "value": "\"base\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"large\" | \"half\"", - "description": "Bottom left border radius of the Box", + "description": "Bottom left border radius", "isOptional": true }, { @@ -10161,7 +10023,7 @@ "syntaxKind": "PropertySignature", "name": "borderRadiusBottomRight", "value": "\"base\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"large\" | \"half\"", - "description": "Bottom right border radius of the Box", + "description": "Bottom right border radius", "isOptional": true }, { @@ -10169,7 +10031,7 @@ "syntaxKind": "PropertySignature", "name": "borderRadiusTopLeft", "value": "\"base\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"large\" | \"half\"", - "description": "Top left border radius of the Box", + "description": "Top left border radius", "isOptional": true }, { @@ -10177,7 +10039,7 @@ "syntaxKind": "PropertySignature", "name": "borderRadiusTopRight", "value": "\"base\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"large\" | \"half\"", - "description": "Top right border radius of the Box", + "description": "Top right border radius", "isOptional": true }, { @@ -10185,98 +10047,114 @@ "syntaxKind": "PropertySignature", "name": "children", "value": "ReactNode", - "description": "Inner content of the Box" + "description": "Inner content" + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "color", + "value": "ColorTokenScale", + "description": "Color of children", + "isOptional": true }, { "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "PropertySignature", "name": "margin", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "Spacing outside of the Box", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Spacing outside of container", "isOptional": true }, { "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "PropertySignature", "name": "marginBottom", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "Bottom spacing outside of the Box", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Bottom spacing outside of container", "isOptional": true }, { "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "PropertySignature", "name": "marginLeft", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "Left side spacing outside of the Box", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Left spacing outside of container", "isOptional": true }, { "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "PropertySignature", "name": "marginRight", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "Right side spacing outside of the Box", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Right spacing outside of container", "isOptional": true }, { "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "PropertySignature", "name": "marginTop", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "Top spacing outside of the Box", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Top spacing outside of container", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Box/Box.tsx", + "syntaxKind": "PropertySignature", + "name": "maxWidth", + "value": "string", + "description": "Maximum width of container", "isOptional": true }, { "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "PropertySignature", "name": "padding", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "Spacing inside of the Box", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Spacing around children", "isOptional": true }, { "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "PropertySignature", "name": "paddingBottom", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "Bottom spacing inside of the Box", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Bottom spacing around children", "isOptional": true }, { "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "PropertySignature", "name": "paddingLeft", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "Left side spacing inside of the Box", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Left spacing around children", "isOptional": true }, { "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "PropertySignature", "name": "paddingRight", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "Right side spacing inside of the Box", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Right spacing around children", "isOptional": true }, { "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "PropertySignature", "name": "paddingTop", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", - "description": "Top spacing inside of the Box", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "description": "Top spacing around children", "isOptional": true }, { "filePath": "polaris-react/src/components/Box/Box.tsx", "syntaxKind": "PropertySignature", "name": "shadow", - "value": "\"button\" | \"base\" | \"transparent\" | \"faint\" | \"deep\" | \"top-bar\" | \"card\" | \"popover\" | \"layer\" | \"modal\"", - "description": "Shadow on the Box", + "value": "\"button\" | \"transparent\" | \"faint\" | \"base\" | \"deep\" | \"top-bar\" | \"card\" | \"popover\" | \"layer\" | \"modal\"", + "description": "Shadow", "isOptional": true } ], - "value": "export interface BoxProps {\n as?: 'div' | 'span';\n /** Background color of the Box */\n background?: BackgroundColorTokenScale;\n /** Border styling of the Box */\n border?: BorderTokenScale;\n /** Bottom border styling of the Box */\n borderBottom?: BorderTokenScale;\n /** Left border styling of the Box */\n borderLeft?: BorderTokenScale;\n /** Right border styling of the Box */\n borderRight?: BorderTokenScale;\n /** Top border styling of the Box */\n borderTop?: BorderTokenScale;\n /** Border radius of the Box */\n borderRadius?: BorderRadiusTokenScale;\n /** Bottom left border radius of the Box */\n borderRadiusBottomLeft?: BorderRadiusTokenScale;\n /** Bottom right border radius of the Box */\n borderRadiusBottomRight?: BorderRadiusTokenScale;\n /** Top left border radius of the Box */\n borderRadiusTopLeft?: BorderRadiusTokenScale;\n /** Top right border radius of the Box */\n borderRadiusTopRight?: BorderRadiusTokenScale;\n /** Inner content of the Box */\n children: ReactNode;\n /** Spacing outside of the Box */\n margin?: SpacingTokenScale;\n /** Bottom spacing outside of the Box */\n marginBottom?: SpacingTokenScale;\n /** Left side spacing outside of the Box */\n marginLeft?: SpacingTokenScale;\n /** Right side spacing outside of the Box */\n marginRight?: SpacingTokenScale;\n /** Top spacing outside of the Box */\n marginTop?: SpacingTokenScale;\n /** Spacing inside of the Box */\n padding?: SpacingTokenScale;\n /** Bottom spacing inside of the Box */\n paddingBottom?: SpacingTokenScale;\n /** Left side spacing inside of the Box */\n paddingLeft?: SpacingTokenScale;\n /** Right side spacing inside of the Box */\n paddingRight?: SpacingTokenScale;\n /** Top spacing inside of the Box */\n paddingTop?: SpacingTokenScale;\n /** Shadow on the Box */\n shadow?: DepthTokenScale;\n}" + "value": "export interface BoxProps {\n /** HTML Element type */\n as?: Element;\n /** Background color */\n background?: BackgroundColorTokenScale;\n /** Border style */\n border?: BorderTokenScale;\n /** Bottom border style */\n borderBottom?: BorderTokenScale;\n /** Left border style */\n borderLeft?: BorderTokenScale;\n /** Right border style */\n borderRight?: BorderTokenScale;\n /** Top border style */\n borderTop?: BorderTokenScale;\n /** Border radius */\n borderRadius?: BorderRadiusTokenScale;\n /** Bottom left border radius */\n borderRadiusBottomLeft?: BorderRadiusTokenScale;\n /** Bottom right border radius */\n borderRadiusBottomRight?: BorderRadiusTokenScale;\n /** Top left border radius */\n borderRadiusTopLeft?: BorderRadiusTokenScale;\n /** Top right border radius */\n borderRadiusTopRight?: BorderRadiusTokenScale;\n /** Inner content */\n children: ReactNode;\n /** Color of children */\n color?: ColorTokenScale;\n /** Spacing outside of container */\n margin?: SpacingSpaceScale;\n /** Bottom spacing outside of container */\n marginBottom?: SpacingSpaceScale;\n /** Left spacing outside of container */\n marginLeft?: SpacingSpaceScale;\n /** Right spacing outside of container */\n marginRight?: SpacingSpaceScale;\n /** Top spacing outside of container */\n marginTop?: SpacingSpaceScale;\n /** Maximum width of container */\n maxWidth?: string;\n /** Spacing around children */\n padding?: SpacingSpaceScale;\n /** Bottom spacing around children */\n paddingBottom?: SpacingSpaceScale;\n /** Left spacing around children */\n paddingLeft?: SpacingSpaceScale;\n /** Right spacing around children */\n paddingRight?: SpacingSpaceScale;\n /** Top spacing around children */\n paddingTop?: SpacingSpaceScale;\n /** Shadow */\n shadow?: DepthShadowAlias;\n}" } }, "BreadcrumbsProps": { @@ -10578,7 +10456,7 @@ "filePath": "polaris-react/src/components/Button/Button.tsx", "syntaxKind": "PropertySignature", "name": "size", - "value": "\"large\" | \"medium\" | \"slim\"", + "value": "\"medium\" | \"large\" | \"slim\"", "description": "Changes the size of the button, giving it more or less padding", "isOptional": true, "defaultValue": "'medium'" @@ -10901,56 +10779,6 @@ "description": "" } }, - "ButtonGroupProps": { - "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "name": "ButtonGroupProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "spacing", - "value": "Spacing", - "description": "Determines the space between button group items", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "segmented", - "value": "boolean", - "description": "Join buttons as segmented group", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "fullWidth", - "value": "boolean", - "description": "Buttons will stretch/shrink to occupy the full width", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "connectedTop", - "value": "boolean", - "description": "Remove top left and right border radius", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Button components", - "isOptional": true - } - ], - "value": "export interface ButtonGroupProps {\n /** Determines the space between button group items */\n spacing?: Spacing;\n /** Join buttons as segmented group */\n segmented?: boolean;\n /** Buttons will stretch/shrink to occupy the full width */\n fullWidth?: boolean;\n /** Remove top left and right border radius */\n connectedTop?: boolean;\n /** Button components */\n children?: React.ReactNode;\n}" - } - }, "CalloutCardProps": { "polaris-react/src/components/CalloutCard/CalloutCard.tsx": { "filePath": "polaris-react/src/components/CalloutCard/CalloutCard.tsx", @@ -11006,6 +10834,56 @@ "value": "export interface CalloutCardProps {\n /** The content to display inside the callout card. */\n children?: React.ReactNode;\n /** The title of the card */\n title: string;\n /** URL to the card illustration */\n illustration: string;\n /** Primary action for the card */\n primaryAction: Action;\n /** Secondary action for the card */\n secondaryAction?: Action;\n /** Callback when banner is dismissed */\n onDismiss?(): void;\n}" } }, + "ButtonGroupProps": { + "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "name": "ButtonGroupProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "spacing", + "value": "Spacing", + "description": "Determines the space between button group items", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "segmented", + "value": "boolean", + "description": "Join buttons as segmented group", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "fullWidth", + "value": "boolean", + "description": "Buttons will stretch/shrink to occupy the full width", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "connectedTop", + "value": "boolean", + "description": "Remove top left and right border radius", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Button components", + "isOptional": true + } + ], + "value": "export interface ButtonGroupProps {\n /** Determines the space between button group items */\n spacing?: Spacing;\n /** Join buttons as segmented group */\n segmented?: boolean;\n /** Buttons will stretch/shrink to occupy the full width */\n fullWidth?: boolean;\n /** Remove top left and right border radius */\n connectedTop?: boolean;\n /** Button components */\n children?: React.ReactNode;\n}" + } + }, "CaptionProps": { "polaris-react/src/components/Caption/Caption.tsx": { "filePath": "polaris-react/src/components/Caption/Caption.tsx", @@ -11196,6 +11074,94 @@ "value": "export interface CheckableButtonProps {\n accessibilityLabel?: string;\n label?: string;\n selected?: boolean | 'indeterminate';\n selectMode?: boolean;\n smallScreen?: boolean;\n plain?: boolean;\n measuring?: boolean;\n disabled?: boolean;\n onToggleAll?(): void;\n}" } }, + "ChoiceProps": { + "polaris-react/src/components/Choice/Choice.tsx": { + "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "name": "ChoiceProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the choice" + }, + { + "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "React.ReactNode", + "description": "Label for the choice" + }, + { + "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the associated form control is disabled", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "any", + "description": "Display an error message", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "syntaxKind": "PropertySignature", + "name": "labelHidden", + "value": "boolean", + "description": "Visually hide the label", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Content to display inside the choice", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "syntaxKind": "PropertySignature", + "name": "helpText", + "value": "React.ReactNode", + "description": "Additional text to aide in use", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "Callback when clicked", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "syntaxKind": "MethodSignature", + "name": "onMouseOver", + "value": "() => void", + "description": "Callback when mouse over", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "syntaxKind": "MethodSignature", + "name": "onMouseOut", + "value": "() => void", + "description": "Callback when mouse out", + "isOptional": true + } + ], + "value": "export interface ChoiceProps {\n /** A unique identifier for the choice */\n id: string;\n /**\tLabel for the choice */\n label: React.ReactNode;\n /** Whether the associated form control is disabled */\n disabled?: boolean;\n /** Display an error message */\n error?: Error | boolean;\n /** Visually hide the label */\n labelHidden?: boolean;\n /** Content to display inside the choice */\n children?: React.ReactNode;\n /** Additional text to aide in use */\n helpText?: React.ReactNode;\n /** Callback when clicked */\n onClick?(): void;\n /** Callback when mouse over */\n onMouseOver?(): void;\n /** Callback when mouse out */\n onMouseOut?(): void;\n}" + } + }, "CheckboxProps": { "polaris-react/src/components/Checkbox/Checkbox.tsx": { "filePath": "polaris-react/src/components/Checkbox/Checkbox.tsx", @@ -11388,60 +11354,44 @@ "value": "export interface CheckboxProps {\n checked?: boolean;\n disabled?: boolean;\n active?: boolean;\n id?: string;\n name?: string;\n value?: string;\n role?: string;\n onChange(): void;\n}" } }, - "ChoiceProps": { - "polaris-react/src/components/Choice/Choice.tsx": { - "filePath": "polaris-react/src/components/Choice/Choice.tsx", - "name": "ChoiceProps", + "Choice": { + "polaris-react/src/components/ChoiceList/ChoiceList.tsx": { + "filePath": "polaris-react/src/components/ChoiceList/ChoiceList.tsx", + "name": "Choice", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "filePath": "polaris-react/src/components/ChoiceList/ChoiceList.tsx", "syntaxKind": "PropertySignature", - "name": "id", + "name": "value", "value": "string", - "description": "A unique identifier for the choice" + "description": "Value of the choice" }, { - "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "filePath": "polaris-react/src/components/ChoiceList/ChoiceList.tsx", "syntaxKind": "PropertySignature", "name": "label", "value": "React.ReactNode", "description": "Label for the choice" }, { - "filePath": "polaris-react/src/components/Choice/Choice.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Whether the associated form control is disabled", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "filePath": "polaris-react/src/components/ChoiceList/ChoiceList.tsx", "syntaxKind": "PropertySignature", - "name": "error", - "value": "any", - "description": "Display an error message", + "name": "id", + "value": "string", + "description": "A unique identifier for the choice", "isOptional": true }, { - "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "filePath": "polaris-react/src/components/ChoiceList/ChoiceList.tsx", "syntaxKind": "PropertySignature", - "name": "labelHidden", + "name": "disabled", "value": "boolean", - "description": "Visually hide the label", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Choice/Choice.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Content to display inside the choice", + "description": "Disable choice", "isOptional": true }, { - "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "filePath": "polaris-react/src/components/ChoiceList/ChoiceList.tsx", "syntaxKind": "PropertySignature", "name": "helpText", "value": "React.ReactNode", @@ -11449,91 +11399,19 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/Choice/Choice.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "Callback when clicked", + "filePath": "polaris-react/src/components/ChoiceList/ChoiceList.tsx", + "syntaxKind": "PropertySignature", + "name": "describedByError", + "value": "boolean", + "description": "Indicates that the choice is aria-describedBy the error message", "isOptional": true }, { - "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "filePath": "polaris-react/src/components/ChoiceList/ChoiceList.tsx", "syntaxKind": "MethodSignature", - "name": "onMouseOver", - "value": "() => void", - "description": "Callback when mouse over", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Choice/Choice.tsx", - "syntaxKind": "MethodSignature", - "name": "onMouseOut", - "value": "() => void", - "description": "Callback when mouse out", - "isOptional": true - } - ], - "value": "export interface ChoiceProps {\n /** A unique identifier for the choice */\n id: string;\n /**\tLabel for the choice */\n label: React.ReactNode;\n /** Whether the associated form control is disabled */\n disabled?: boolean;\n /** Display an error message */\n error?: Error | boolean;\n /** Visually hide the label */\n labelHidden?: boolean;\n /** Content to display inside the choice */\n children?: React.ReactNode;\n /** Additional text to aide in use */\n helpText?: React.ReactNode;\n /** Callback when clicked */\n onClick?(): void;\n /** Callback when mouse over */\n onMouseOver?(): void;\n /** Callback when mouse out */\n onMouseOut?(): void;\n}" - } - }, - "Choice": { - "polaris-react/src/components/ChoiceList/ChoiceList.tsx": { - "filePath": "polaris-react/src/components/ChoiceList/ChoiceList.tsx", - "name": "Choice", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ChoiceList/ChoiceList.tsx", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "Value of the choice" - }, - { - "filePath": "polaris-react/src/components/ChoiceList/ChoiceList.tsx", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "React.ReactNode", - "description": "Label for the choice" - }, - { - "filePath": "polaris-react/src/components/ChoiceList/ChoiceList.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the choice", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ChoiceList/ChoiceList.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disable choice", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ChoiceList/ChoiceList.tsx", - "syntaxKind": "PropertySignature", - "name": "helpText", - "value": "React.ReactNode", - "description": "Additional text to aide in use", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ChoiceList/ChoiceList.tsx", - "syntaxKind": "PropertySignature", - "name": "describedByError", - "value": "boolean", - "description": "Indicates that the choice is aria-describedBy the error message", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ChoiceList/ChoiceList.tsx", - "syntaxKind": "MethodSignature", - "name": "renderChildren", - "value": "(isSelected: boolean) => any", - "description": "Method to render children with a choice", + "name": "renderChildren", + "value": "(isSelected: boolean) => any", + "description": "Method to render children with a choice", "isOptional": true } ], @@ -11818,67 +11696,12 @@ "value": "export interface ColorPickerProps {\n /** ID for the element */\n id?: string;\n /** The currently selected color */\n color: Color;\n /** Allow user to select an alpha value */\n allowAlpha?: boolean;\n /** Allow HuePicker to take the full width */\n fullWidth?: boolean;\n /** Callback when color is selected */\n onChange(color: HSBAColor): void;\n}" } }, - "Breakpoints": { - "polaris-react/src/components/Columns/Columns.tsx": { - "filePath": "polaris-react/src/components/Columns/Columns.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Breakpoints", - "value": "'xs' | 'sm' | 'md' | 'lg' | 'xl'", - "description": "" - }, - "polaris-react/src/components/Grid/Grid.tsx": { - "filePath": "polaris-react/src/components/Grid/Grid.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Breakpoints", - "value": "'xs' | 'sm' | 'md' | 'lg' | 'xl'", - "description": "" - }, - "polaris-react/src/components/Tile/Tile.tsx": { - "filePath": "polaris-react/src/components/Tile/Tile.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Breakpoints", - "value": "'xs' | 'sm' | 'md' | 'lg' | 'xl'", - "description": "" - }, - "polaris-react/src/components/Grid/components/Cell/Cell.tsx": { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Breakpoints", - "value": "'xs' | 'sm' | 'md' | 'lg' | 'xl'", - "description": "" - } - }, - "SpacingName": { - "polaris-react/src/components/Columns/Columns.tsx": { - "filePath": "polaris-react/src/components/Columns/Columns.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "SpacingName", - "value": "keyof typeof spacing", - "description": "" - } - }, - "SpacingScale": { - "polaris-react/src/components/Columns/Columns.tsx": { - "filePath": "polaris-react/src/components/Columns/Columns.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "SpacingScale", - "value": "SpacingName extends `space-${infer Scale}` ? Scale : never", - "description": "" - }, - "polaris-react/src/components/Tile/Tile.tsx": { - "filePath": "polaris-react/src/components/Tile/Tile.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "SpacingScale", - "value": "SpacingTokenName extends `space-${infer Scale}`\n ? Scale\n : never", - "description": "" - } - }, "Columns": { "polaris-react/src/components/Columns/Columns.tsx": { "filePath": "polaris-react/src/components/Columns/Columns.tsx", "syntaxKind": "TypeAliasDeclaration", "name": "Columns", - "value": "{\n [Breakpoint in Breakpoints]?: number | string;\n}", + "value": "{\n [Breakpoint in BreakpointsAlias]?: number | string;\n}", "description": "" }, "polaris-react/src/components/Grid/Grid.tsx": { @@ -11892,7 +11715,7 @@ "filePath": "polaris-react/src/components/Tile/Tile.tsx", "syntaxKind": "TypeAliasDeclaration", "name": "Columns", - "value": "{\n [Breakpoint in Breakpoints]?: number | string;\n}", + "value": "{\n [Breakpoint in BreakpointsAlias]?: number | string;\n}", "description": "" }, "polaris-react/src/components/Grid/components/Cell/Cell.tsx": { @@ -11949,7 +11772,7 @@ "filePath": "polaris-react/src/components/Columns/Columns.tsx", "syntaxKind": "TypeAliasDeclaration", "name": "Gap", - "value": "{\n [Breakpoint in Breakpoints]?: SpacingScale;\n}", + "value": "{\n [Breakpoint in BreakpointsAlias]?: SpacingSpaceScale;\n}", "description": "" }, "polaris-react/src/components/Grid/Grid.tsx": { @@ -11963,7 +11786,7 @@ "filePath": "polaris-react/src/components/Tile/Tile.tsx", "syntaxKind": "TypeAliasDeclaration", "name": "Gap", - "value": "{\n [Breakpoint in Breakpoints]?: SpacingScale;\n}", + "value": "{\n [Breakpoint in BreakpointsAlias]?: SpacingSpaceScale;\n}", "description": "" } }, @@ -12001,6 +11824,40 @@ "value": "export interface ColumnsProps {\n gap?: Gap;\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", @@ -12074,40 +11931,6 @@ "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", @@ -12495,7 +12318,7 @@ "filePath": "polaris-react/src/components/ExceptionList/ExceptionList.tsx", "syntaxKind": "PropertySignature", "name": "status", - "value": "\"critical\" | \"warning\"", + "value": "\"warning\" | \"critical\"", "description": "Set the color of the icon and title for the given item.", "isOptional": true }, @@ -13423,6 +13246,33 @@ ] } }, + "Context": { + "polaris-react/src/components/FocusManager/FocusManager.tsx": { + "filePath": "polaris-react/src/components/FocusManager/FocusManager.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Context", + "value": "NonNullable>", + "description": "" + } + }, + "FooterHelpProps": { + "polaris-react/src/components/FooterHelp/FooterHelp.tsx": { + "filePath": "polaris-react/src/components/FooterHelp/FooterHelp.tsx", + "name": "FooterHelpProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/FooterHelp/FooterHelp.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The content to display inside the layout.", + "isOptional": true + } + ], + "value": "export interface FooterHelpProps {\n /** The content to display inside the layout. */\n children?: React.ReactNode;\n}" + } + }, "FocusProps": { "polaris-react/src/components/Focus/Focus.tsx": { "filePath": "polaris-react/src/components/Focus/Focus.tsx", @@ -13456,33 +13306,6 @@ "value": "export interface FocusProps {\n children?: React.ReactNode;\n disabled?: boolean;\n root: React.RefObject | HTMLElement | null;\n}" } }, - "Context": { - "polaris-react/src/components/FocusManager/FocusManager.tsx": { - "filePath": "polaris-react/src/components/FocusManager/FocusManager.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Context", - "value": "NonNullable>", - "description": "" - } - }, - "FooterHelpProps": { - "polaris-react/src/components/FooterHelp/FooterHelp.tsx": { - "filePath": "polaris-react/src/components/FooterHelp/FooterHelp.tsx", - "name": "FooterHelpProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/FooterHelp/FooterHelp.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to display inside the layout.", - "isOptional": true - } - ], - "value": "export interface FooterHelpProps {\n /** The content to display inside the layout. */\n children?: React.ReactNode;\n}" - } - }, "Enctype": { "polaris-react/src/components/Form/Form.tsx": { "filePath": "polaris-react/src/components/Form/Form.tsx", @@ -13716,29 +13539,20 @@ "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", + "syntaxKind": "TypeAliasDeclaration", + "name": "Breakpoints", + "value": "'xs' | 'sm' | 'md' | 'lg' | 'xl'", + "description": "" + }, + "polaris-react/src/components/Grid/components/Cell/Cell.tsx": { + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Breakpoints", + "value": "'xs' | 'sm' | 'md' | 'lg' | 'xl'", + "description": "" } }, "Areas": { @@ -13792,39 +13606,29 @@ "value": "export interface GridProps {\n /* Set grid-template-areas */\n areas?: Areas;\n /* Number of columns */\n columns?: Columns;\n /* Grid gap */\n gap?: Gap;\n children?: React.ReactNode;\n}" } }, - "HeadingProps": { - "polaris-react/src/components/Heading/Heading.tsx": { - "filePath": "polaris-react/src/components/Heading/Heading.tsx", - "name": "HeadingProps", + "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/Heading/Heading.tsx", + "filePath": "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx", "syntaxKind": "PropertySignature", - "name": "element", - "value": "HeadingTagName", - "description": "The element name to use for the heading", - "isOptional": true, - "defaultValue": "'h2'" + "name": "onAction", + "value": "() => void", + "description": "Callback when back button is clicked" }, { - "filePath": "polaris-react/src/components/Heading/Heading.tsx", + "filePath": "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", - "description": "The content to display inside the heading", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Heading/Heading.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the heading, used for reference in anchor links", + "description": "Render child elements", "isOptional": true } ], - "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}" + "value": "export interface FullscreenBarProps {\n /** Callback when back button is clicked */\n onAction: () => void;\n /** Render child elements */\n children?: React.ReactNode;\n}" } }, "IconProps": { @@ -13868,6 +13672,41 @@ "value": "export interface IconProps {\n /** The SVG contents to display in the icon (icons should fit in a 20 × 20 pixel viewBox) */\n source: IconSource;\n /** Set the color for the SVG fill */\n color?: Color;\n /** Show a backdrop behind the icon */\n backdrop?: boolean;\n /** Descriptive text to be read to screenreaders */\n accessibilityLabel?: string;\n}" } }, + "HeadingProps": { + "polaris-react/src/components/Heading/Heading.tsx": { + "filePath": "polaris-react/src/components/Heading/Heading.tsx", + "name": "HeadingProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Heading/Heading.tsx", + "syntaxKind": "PropertySignature", + "name": "element", + "value": "HeadingTagName", + "description": "The element name to use for the heading", + "isOptional": true, + "defaultValue": "'h2'" + }, + { + "filePath": "polaris-react/src/components/Heading/Heading.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The content to display inside the heading", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Heading/Heading.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the heading, used for reference in anchor links", + "isOptional": true + } + ], + "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}" + } + }, "SourceSet": { "polaris-react/src/components/Image/Image.tsx": { "filePath": "polaris-react/src/components/Image/Image.tsx", @@ -13958,10 +13797,44 @@ "value": "export interface ImageProps extends React.HTMLProps {\n alt: string;\n source: string;\n crossOrigin?: CrossOrigin;\n sourceSet?: SourceSet[];\n onLoad?(): void;\n onError?(): void;\n}" } }, - "IndexTableHeading": { + "IndexTableHeadingBase": { "polaris-react/src/components/IndexTable/IndexTable.tsx": { "filePath": "polaris-react/src/components/IndexTable/IndexTable.tsx", - "name": "IndexTableHeading", + "name": "IndexTableHeadingBase", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/IndexTable/IndexTable.tsx", + "syntaxKind": "PropertySignature", + "name": "flush", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/IndexTable/IndexTable.tsx", + "syntaxKind": "PropertySignature", + "name": "new", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/IndexTable/IndexTable.tsx", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "", + "isOptional": true + } + ], + "value": "interface IndexTableHeadingBase {\n flush?: boolean;\n new?: boolean;\n hidden?: boolean;\n}" + } + }, + "IndexTableHeadingTitleString": { + "polaris-react/src/components/IndexTable/IndexTable.tsx": { + "filePath": "polaris-react/src/components/IndexTable/IndexTable.tsx", + "name": "IndexTableHeadingTitleString", "description": "", "members": [ { @@ -13974,11 +13847,51 @@ { "filePath": "polaris-react/src/components/IndexTable/IndexTable.tsx", "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", + "name": "flush", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/IndexTable/IndexTable.tsx", + "syntaxKind": "PropertySignature", + "name": "new", + "value": "boolean", "description": "", "isOptional": true }, + { + "filePath": "polaris-react/src/components/IndexTable/IndexTable.tsx", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "", + "isOptional": true + } + ], + "value": "interface IndexTableHeadingTitleString extends IndexTableHeadingBase {\n title: string;\n}" + } + }, + "IndexTableHeadingTitleNode": { + "polaris-react/src/components/IndexTable/IndexTable.tsx": { + "filePath": "polaris-react/src/components/IndexTable/IndexTable.tsx", + "name": "IndexTableHeadingTitleNode", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/IndexTable/IndexTable.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "React.ReactNode", + "description": "" + }, + { + "filePath": "polaris-react/src/components/IndexTable/IndexTable.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "" + }, { "filePath": "polaris-react/src/components/IndexTable/IndexTable.tsx", "syntaxKind": "PropertySignature", @@ -14004,7 +13917,16 @@ "isOptional": true } ], - "value": "export interface IndexTableHeading {\n title: string;\n id?: string;\n flush?: boolean;\n new?: boolean;\n hidden?: boolean;\n}" + "value": "interface IndexTableHeadingTitleNode extends IndexTableHeadingBase {\n title: React.ReactNode;\n id: string;\n}" + } + }, + "IndexTableHeading": { + "polaris-react/src/components/IndexTable/IndexTable.tsx": { + "filePath": "polaris-react/src/components/IndexTable/IndexTable.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "IndexTableHeading", + "value": "IndexTableHeadingTitleString | IndexTableHeadingTitleNode", + "description": "" } }, "IndexTableSortDirection": { @@ -14339,24 +14261,6 @@ "value": "export interface IndexTableProps\n extends IndexTableBaseProps,\n IndexProviderProps {}" } }, - "IndicatorProps": { - "polaris-react/src/components/Indicator/Indicator.tsx": { - "filePath": "polaris-react/src/components/Indicator/Indicator.tsx", - "name": "IndicatorProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Indicator/Indicator.tsx", - "syntaxKind": "PropertySignature", - "name": "pulse", - "value": "boolean", - "description": "", - "isOptional": true - } - ], - "value": "export interface IndicatorProps {\n pulse?: boolean;\n}" - } - }, "InlineProps": { "polaris-react/src/components/Inline/Inline.tsx": { "filePath": "polaris-react/src/components/Inline/Inline.tsx", @@ -14383,7 +14287,7 @@ "filePath": "polaris-react/src/components/Inline/Inline.tsx", "syntaxKind": "PropertySignature", "name": "spacing", - "value": "\"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"0\" | \"025\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", + "value": "\"0\" | \"025\" | \"05\" | \"1\" | \"2\" | \"3\" | \"4\" | \"5\" | \"6\" | \"8\" | \"10\" | \"12\" | \"16\" | \"20\" | \"24\" | \"28\" | \"32\"", "description": "Adjust spacing between elements", "isOptional": true }, @@ -14404,24 +14308,25 @@ "isOptional": true } ], - "value": "export interface InlineProps {\n /** Elements to display inside stack */\n children?: React.ReactNode;\n /** Wrap stack elements to additional rows as needed on small screens (Defaults to true) */\n wrap?: boolean;\n /** Adjust spacing between elements */\n spacing?: Spacing;\n /** Adjust vertical alignment of elements */\n alignY?: keyof typeof AlignY;\n /** Adjust horizontal alignment of elements */\n align?: Align;\n}" + "value": "export interface InlineProps {\n /** Elements to display inside stack */\n children?: React.ReactNode;\n /** Wrap stack elements to additional rows as needed on small screens (Defaults to true) */\n wrap?: boolean;\n /** Adjust spacing between elements */\n spacing?: SpacingSpaceScale;\n /** Adjust vertical alignment of elements */\n alignY?: keyof typeof AlignY;\n /** Adjust horizontal alignment of elements */\n align?: Align;\n}" } }, - "InlineCodeProps": { - "polaris-react/src/components/InlineCode/InlineCode.tsx": { - "filePath": "polaris-react/src/components/InlineCode/InlineCode.tsx", - "name": "InlineCodeProps", + "IndicatorProps": { + "polaris-react/src/components/Indicator/Indicator.tsx": { + "filePath": "polaris-react/src/components/Indicator/Indicator.tsx", + "name": "IndicatorProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/InlineCode/InlineCode.tsx", + "filePath": "polaris-react/src/components/Indicator/Indicator.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", - "description": "The content to render inside the code block" + "name": "pulse", + "value": "boolean", + "description": "", + "isOptional": true } ], - "value": "export interface InlineCodeProps {\n /** The content to render inside the code block */\n children: ReactNode;\n}" + "value": "export interface IndicatorProps {\n pulse?: boolean;\n}" } }, "InlineErrorProps": { @@ -14448,6 +14353,23 @@ "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}" } }, + "InlineCodeProps": { + "polaris-react/src/components/InlineCode/InlineCode.tsx": { + "filePath": "polaris-react/src/components/InlineCode/InlineCode.tsx", + "name": "InlineCodeProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/InlineCode/InlineCode.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ReactNode", + "description": "The content to render inside the code block" + } + ], + "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", @@ -14466,6 +14388,23 @@ "value": "export interface KeyboardKeyProps {\n /** The content to display inside the key */\n children?: string;\n}" } }, + "KonamiCodeProps": { + "polaris-react/src/components/KonamiCode/KonamiCode.tsx": { + "filePath": "polaris-react/src/components/KonamiCode/KonamiCode.tsx", + "name": "KonamiCodeProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/KonamiCode/KonamiCode.tsx", + "syntaxKind": "MethodSignature", + "name": "handler", + "value": "(event: KeyboardEvent) => void", + "description": "" + } + ], + "value": "export interface KonamiCodeProps {\n handler(event: KeyboardEvent): void;\n}" + } + }, "KeypressListenerProps": { "polaris-react/src/components/KeypressListener/KeypressListener.tsx": { "filePath": "polaris-react/src/components/KeypressListener/KeypressListener.tsx", @@ -14484,23 +14423,6 @@ "description": "" } }, - "KonamiCodeProps": { - "polaris-react/src/components/KonamiCode/KonamiCode.tsx": { - "filePath": "polaris-react/src/components/KonamiCode/KonamiCode.tsx", - "name": "KonamiCodeProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/KonamiCode/KonamiCode.tsx", - "syntaxKind": "MethodSignature", - "name": "handler", - "value": "(event: KeyboardEvent) => void", - "description": "" - } - ], - "value": "export interface KonamiCodeProps {\n handler(event: KeyboardEvent): void;\n}" - } - }, "LabelProps": { "polaris-react/src/components/Label/Label.tsx": { "filePath": "polaris-react/src/components/Label/Label.tsx", @@ -14903,38 +14825,6 @@ "description": "" } }, - "LoadingProps": { - "polaris-react/src/components/Loading/Loading.tsx": { - "filePath": "polaris-react/src/components/Loading/Loading.tsx", - "name": "LoadingProps", - "description": "", - "members": [], - "value": "export interface LoadingProps {}" - }, - "polaris-react/src/components/Listbox/components/Loading/Loading.tsx": { - "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", - "name": "LoadingProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "" - } - ], - "value": "export interface LoadingProps {\n children?: React.ReactNode;\n accessibilityLabel: string;\n}" - } - }, "MediaCardProps": { "polaris-react/src/components/MediaCard/MediaCard.tsx": { "filePath": "polaris-react/src/components/MediaCard/MediaCard.tsx", @@ -15008,6 +14898,38 @@ "value": "interface MediaCardProps {\n /** The visual media to display in the card */\n children: React.ReactNode;\n /** Heading content */\n title: React.ReactNode;\n /** Body content */\n description: string;\n /** Main call to action, rendered as a basic button */\n primaryAction?: ComplexAction;\n /** Secondary call to action, rendered as a plain button */\n secondaryAction?: ComplexAction;\n /** Action list items to render in ellipsis popover */\n popoverActions?: ActionListItemDescriptor[];\n /** Whether or not card content should be laid out vertically\n * @default false\n */\n portrait?: boolean;\n /** Size of the visual media in the card\n * @default 'medium'\n */\n size?: Size;\n}" } }, + "LoadingProps": { + "polaris-react/src/components/Loading/Loading.tsx": { + "filePath": "polaris-react/src/components/Loading/Loading.tsx", + "name": "LoadingProps", + "description": "", + "members": [], + "value": "export interface LoadingProps {}" + }, + "polaris-react/src/components/Listbox/components/Loading/Loading.tsx": { + "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", + "name": "LoadingProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "" + } + ], + "value": "export interface LoadingProps {\n children?: React.ReactNode;\n accessibilityLabel: string;\n}" + } + }, "MessageIndicatorProps": { "polaris-react/src/components/MessageIndicator/MessageIndicator.tsx": { "filePath": "polaris-react/src/components/MessageIndicator/MessageIndicator.tsx", @@ -15392,18 +15314,18 @@ "value": "'leading' | 'trailing' | 'center' | 'fill' | 'baseline'", "description": "" }, - "polaris-react/src/components/Text/Text.tsx": { - "filePath": "polaris-react/src/components/Text/Text.tsx", + "polaris-react/src/components/TextField/TextField.tsx": { + "filePath": "polaris-react/src/components/TextField/TextField.tsx", "syntaxKind": "TypeAliasDeclaration", "name": "Alignment", - "value": "'start' | 'center' | 'end' | 'justify'", + "value": "'left' | 'center' | 'right'", "description": "" }, - "polaris-react/src/components/TextField/TextField.tsx": { - "filePath": "polaris-react/src/components/TextField/TextField.tsx", + "polaris-react/src/components/Text/Text.tsx": { + "filePath": "polaris-react/src/components/Text/Text.tsx", "syntaxKind": "TypeAliasDeclaration", "name": "Alignment", - "value": "'left' | 'center' | 'right'", + "value": "'start' | 'center' | 'end' | 'justify'", "description": "" }, "polaris-react/src/components/OptionList/components/Option/Option.tsx": { @@ -16147,6 +16069,31 @@ "value": "export interface PopoverPublicAPI {\n forceUpdatePosition(): void;\n}" } }, + "PortalsManagerProps": { + "polaris-react/src/components/PortalsManager/PortalsManager.tsx": { + "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", + "name": "PortalsManagerProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "" + }, + { + "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", + "syntaxKind": "PropertySignature", + "name": "container", + "value": "HTMLDivElement", + "description": "", + "isOptional": true + } + ], + "value": "export interface PortalsManagerProps {\n children: React.ReactNode;\n container?: PortalsContainerElement;\n}" + } + }, "PortalProps": { "polaris-react/src/components/Portal/Portal.tsx": { "filePath": "polaris-react/src/components/Portal/Portal.tsx", @@ -16181,31 +16128,6 @@ "value": "export interface PortalProps {\n children?: React.ReactNode;\n idPrefix?: string;\n onPortalCreated?(): void;\n}" } }, - "PortalsManagerProps": { - "polaris-react/src/components/PortalsManager/PortalsManager.tsx": { - "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", - "name": "PortalsManagerProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "" - }, - { - "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", - "syntaxKind": "PropertySignature", - "name": "container", - "value": "HTMLDivElement", - "description": "", - "isOptional": true - } - ], - "value": "export interface PortalsManagerProps {\n children: React.ReactNode;\n container?: PortalsContainerElement;\n}" - } - }, "Positioning": { "polaris-react/src/components/PositionedOverlay/PositionedOverlay.tsx": { "filePath": "polaris-react/src/components/PositionedOverlay/PositionedOverlay.tsx", @@ -17613,25 +17535,6 @@ "value": "export interface SheetProps {\n /** Whether or not the sheet is open */\n open: boolean;\n /** The child elements to render in the sheet */\n children: React.ReactNode;\n /** Callback when the backdrop is clicked or `ESC` is pressed */\n onClose(): void;\n /** Callback when the sheet has completed entering */\n onEntered?(): void;\n /** Callback when the sheet has started to exit */\n onExit?(): void;\n /** ARIA label for sheet */\n accessibilityLabel: string;\n /** The element or the RefObject that activates the Sheet */\n activator?: React.RefObject | React.ReactElement;\n}" } }, - "SkeletonBodyTextProps": { - "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx": { - "filePath": "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx", - "name": "SkeletonBodyTextProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "number", - "description": "Number of lines to display", - "isOptional": true, - "defaultValue": "3" - } - ], - "value": "export interface SkeletonBodyTextProps {\n /**\n * Number of lines to display\n * @default 3\n */\n lines?: number;\n}" - } - }, "SkeletonDisplayTextProps": { "polaris-react/src/components/SkeletonDisplayText/SkeletonDisplayText.tsx": { "filePath": "polaris-react/src/components/SkeletonDisplayText/SkeletonDisplayText.tsx", @@ -17651,6 +17554,25 @@ "value": "export interface SkeletonDisplayTextProps {\n /**\n * Size of the text\n * @default 'medium'\n */\n size?: Size;\n}" } }, + "SkeletonBodyTextProps": { + "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx": { + "filePath": "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx", + "name": "SkeletonBodyTextProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx", + "syntaxKind": "PropertySignature", + "name": "lines", + "value": "number", + "description": "Number of lines to display", + "isOptional": true, + "defaultValue": "3" + } + ], + "value": "export interface SkeletonBodyTextProps {\n /**\n * Number of lines to display\n * @default 3\n */\n lines?: number;\n}" + } + }, "SkeletonPageProps": { "polaris-react/src/components/SkeletonPage/SkeletonPage.tsx": { "filePath": "polaris-react/src/components/SkeletonPage/SkeletonPage.tsx", @@ -17986,183 +17908,85 @@ "description": "" } }, - "Element": { - "polaris-react/src/components/Text/Text.tsx": { - "filePath": "polaris-react/src/components/Text/Text.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Element", - "value": "'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'p' | 'span'", - "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}" } }, - "Variant": { - "polaris-react/src/components/Text/Text.tsx": { - "filePath": "polaris-react/src/components/Text/Text.tsx", + "InputMode": { + "polaris-react/src/components/TextField/TextField.tsx": { + "filePath": "polaris-react/src/components/TextField/TextField.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "Variant", - "value": "'headingXs' | 'headingSm' | 'headingMd' | 'headingLg' | 'headingXl' | 'heading2xl' | 'heading3xl' | 'heading4xl' | 'bodySm' | 'bodyMd' | 'bodyLg'", + "name": "InputMode", + "value": "'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url'", "description": "" } }, - "FontWeight": { - "polaris-react/src/components/Text/Text.tsx": { - "filePath": "polaris-react/src/components/Text/Text.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "FontWeight", - "value": "'regular' | 'medium' | 'semibold' | 'bold'", - "description": "" + "SelectSuggestion": { + "polaris-react/src/components/TextField/TextField.tsx": { + "filePath": "polaris-react/src/components/TextField/TextField.tsx", + "name": "SelectSuggestion", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/TextField/TextField.tsx", + "syntaxKind": "PropertySignature", + "name": "suggestion", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "interface SelectSuggestion {\n suggestion?: string;\n}" } }, - "TextProps": { - "polaris-react/src/components/Text/Text.tsx": { - "filePath": "polaris-react/src/components/Text/Text.tsx", - "name": "TextProps", + "SelectTextOnFocus": { + "polaris-react/src/components/TextField/TextField.tsx": { + "filePath": "polaris-react/src/components/TextField/TextField.tsx", + "name": "SelectTextOnFocus", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Text/Text.tsx", + "filePath": "polaris-react/src/components/TextField/TextField.tsx", "syntaxKind": "PropertySignature", - "name": "alignment", - "value": "Alignment", - "description": "Adjust horizontal alignment of text", + "name": "selectTextOnFocus", + "value": "true", + "description": "", "isOptional": true - }, + } + ], + "value": "interface SelectTextOnFocus {\n selectTextOnFocus?: true;\n}" + } + }, + "Readonly": { + "polaris-react/src/components/TextField/TextField.tsx": { + "filePath": "polaris-react/src/components/TextField/TextField.tsx", + "name": "Readonly", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/Text/Text.tsx", - "syntaxKind": "PropertySignature", - "name": "as", - "value": "Element", - "description": "The element type" - }, - { - "filePath": "polaris-react/src/components/Text/Text.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", - "description": "Text to display" - }, - { - "filePath": "polaris-react/src/components/Text/Text.tsx", - "syntaxKind": "PropertySignature", - "name": "color", - "value": "Color", - "description": "Adjust color of text", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Text/Text.tsx", - "syntaxKind": "PropertySignature", - "name": "fontWeight", - "value": "FontWeight", - "description": "Adjust weight of text", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Text/Text.tsx", - "syntaxKind": "PropertySignature", - "name": "truncate", - "value": "boolean", - "description": "Truncate text overflow with ellipsis", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Text/Text.tsx", - "syntaxKind": "PropertySignature", - "name": "variant", - "value": "Variant", - "description": "Typographic style of text" - }, - { - "filePath": "polaris-react/src/components/Text/Text.tsx", - "syntaxKind": "PropertySignature", - "name": "visuallyHidden", - "value": "boolean", - "description": "Visually hide the text", - "isOptional": true - } - ], - "value": "export interface TextProps {\n /** Adjust horizontal alignment of text */\n alignment?: Alignment;\n /** The element type */\n as: Element;\n /** Text to display */\n children: ReactNode;\n /** Adjust color of text */\n color?: Color;\n /** Adjust weight of text */\n fontWeight?: FontWeight;\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", - "syntaxKind": "TypeAliasDeclaration", - "name": "InputMode", - "value": "'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url'", - "description": "" - } - }, - "SelectSuggestion": { - "polaris-react/src/components/TextField/TextField.tsx": { - "filePath": "polaris-react/src/components/TextField/TextField.tsx", - "name": "SelectSuggestion", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/TextField/TextField.tsx", - "syntaxKind": "PropertySignature", - "name": "suggestion", - "value": "string", - "description": "", - "isOptional": true - } - ], - "value": "interface SelectSuggestion {\n suggestion?: string;\n}" - } - }, - "SelectTextOnFocus": { - "polaris-react/src/components/TextField/TextField.tsx": { - "filePath": "polaris-react/src/components/TextField/TextField.tsx", - "name": "SelectTextOnFocus", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/TextField/TextField.tsx", - "syntaxKind": "PropertySignature", - "name": "selectTextOnFocus", - "value": "true", - "description": "", - "isOptional": true - } - ], - "value": "interface SelectTextOnFocus {\n selectTextOnFocus?: true;\n}" - } - }, - "Readonly": { - "polaris-react/src/components/TextField/TextField.tsx": { - "filePath": "polaris-react/src/components/TextField/TextField.tsx", - "name": "Readonly", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/TextField/TextField.tsx", + "filePath": "polaris-react/src/components/TextField/TextField.tsx", "syntaxKind": "PropertySignature", "name": "readonly", "value": "true", @@ -18235,6 +18059,95 @@ "description": "" } }, + "Variant": { + "polaris-react/src/components/Text/Text.tsx": { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Variant", + "value": "'headingXs' | 'headingSm' | 'headingMd' | 'headingLg' | 'headingXl' | 'heading2xl' | 'heading3xl' | 'heading4xl' | 'bodySm' | 'bodyMd' | 'bodyLg'", + "description": "" + } + }, + "FontWeight": { + "polaris-react/src/components/Text/Text.tsx": { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "FontWeight", + "value": "'regular' | 'medium' | 'semibold' | 'bold'", + "description": "" + } + }, + "TextProps": { + "polaris-react/src/components/Text/Text.tsx": { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "name": "TextProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "syntaxKind": "PropertySignature", + "name": "alignment", + "value": "Alignment", + "description": "Adjust horizontal alignment of text", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "syntaxKind": "PropertySignature", + "name": "as", + "value": "Element", + "description": "The element type" + }, + { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ReactNode", + "description": "Text to display" + }, + { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "syntaxKind": "PropertySignature", + "name": "color", + "value": "Color", + "description": "Adjust color of text", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "syntaxKind": "PropertySignature", + "name": "fontWeight", + "value": "FontWeight", + "description": "Adjust weight of text", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "syntaxKind": "PropertySignature", + "name": "truncate", + "value": "boolean", + "description": "Truncate text overflow with ellipsis", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "syntaxKind": "PropertySignature", + "name": "variant", + "value": "Variant", + "description": "Typographic style of text" + }, + { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "syntaxKind": "PropertySignature", + "name": "visuallyHidden", + "value": "boolean", + "description": "Visually hide the text", + "isOptional": true + } + ], + "value": "export interface TextProps {\n /** Adjust horizontal alignment of text */\n alignment?: Alignment;\n /** The element type */\n as: Element;\n /** Text to display */\n children: ReactNode;\n /** Adjust color of text */\n color?: Color;\n /** Adjust weight of text */\n fontWeight?: FontWeight;\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}" + } + }, "Variation": { "polaris-react/src/components/TextStyle/TextStyle.tsx": { "filePath": "polaris-react/src/components/TextStyle/TextStyle.tsx", @@ -18362,8 +18275,7 @@ "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", - "description": "Elements to display inside tile", - "isOptional": true + "description": "Elements to display inside tile" }, { "filePath": "polaris-react/src/components/Tile/Tile.tsx", @@ -18382,7 +18294,7 @@ "isOptional": true } ], - "value": "export interface TileProps {\n /** Elements to display inside tile */\n children?: React.ReactNode;\n /** Adjust spacing between elements */\n gap?: Gap;\n /** Adjust number of columns */\n columns?: Columns;\n}" + "value": "export interface TileProps {\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": { @@ -18447,9 +18359,25 @@ "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}" + "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": { @@ -18550,40 +18478,14 @@ "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", + "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/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": "", - "isOptional": true - } - ], - "value": "export interface TrapFocusProps {\n trapping?: boolean;\n children?: React.ReactNode;\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", + "filePath": "polaris-react/src/components/Truncate/Truncate.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", @@ -18593,219 +18495,30 @@ "value": "export interface TruncateProps {\n children: React.ReactNode;\n}" } }, - "UnstyledButtonProps": { - "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx": { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "name": "UnstyledButtonProps", + "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/UnstyledButton/UnstyledButton.tsx", - "name": "[key: string]", - "value": "any" - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to display inside the button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "className", - "value": "string", - "description": "A custom class name to apply styles to button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "A destination to link to, rendered in the href attribute of a link", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "external", - "value": "boolean", - "description": "Forces url to open in a new tab", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "download", - "value": "string | boolean", - "description": "Tells the browser to download the url instead of opening it. Provides a hint for the downloaded filename if it is a string value", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "submit", - "value": "boolean", - "description": "Allows the button to submit a form", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the button, disallowing merchant interaction", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "loading", - "value": "boolean", - "description": "Replaces button text with a spinner while a background action is being performed", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "pressed", - "value": "boolean", - "description": "Sets the button in a pressed state", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Visually hidden text for screen readers", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "role", - "value": "string", - "description": "A valid WAI-ARIA role to define the semantic value of this element", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "ariaControls", - "value": "string", - "description": "Id of the element the button controls", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "filePath": "polaris-react/src/components/TrapFocus/TrapFocus.tsx", "syntaxKind": "PropertySignature", - "name": "ariaExpanded", + "name": "trapping", "value": "boolean", - "description": "Tells screen reader the controlled element is expanded", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "ariaDescribedBy", - "value": "string", - "description": "Indicates the ID of the element that describes the button", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "filePath": "polaris-react/src/components/TrapFocus/TrapFocus.tsx", "syntaxKind": "PropertySignature", - "name": "ariaChecked", - "value": "\"false\" | \"true\"", - "description": "Indicates the current checked state of the button when acting as a toggle or switch", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "Callback when clicked", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onFocus", - "value": "() => void", - "description": "Callback when button becomes focussed", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onBlur", - "value": "() => void", - "description": "Callback when focus leaves button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyPress", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keypress event is registered on the button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyUp", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keyup event is registered on the button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyDown", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keydown event is registered on the button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onMouseEnter", - "value": "() => void", - "description": "Callback when mouse enter", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onTouchStart", - "value": "() => void", - "description": "Callback when element is touched", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onPointerDown", - "value": "() => void", - "description": "Callback when pointerdown event is being triggered", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true } ], - "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}" + "value": "export interface TrapFocusProps {\n trapping?: boolean;\n children?: React.ReactNode;\n}" } }, "UnstyledLinkProps": { @@ -21725,27 +21438,242 @@ "value": "export interface UnstyledLinkProps extends LinkLikeComponentProps {}" } }, - "VideoThumbnailProps": { - "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx": { - "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", - "name": "VideoThumbnailProps", + "UnstyledButtonProps": { + "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx": { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "name": "UnstyledButtonProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", - "syntaxKind": "PropertySignature", - "name": "thumbnailUrl", - "value": "string", - "description": "URL source for thumbnail image." + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "name": "[key: string]", + "value": "any" }, { - "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", "syntaxKind": "PropertySignature", - "name": "videoLength", - "value": "number", - "description": "Length of video in seconds.", - "isOptional": true, - "defaultValue": "0" + "name": "children", + "value": "React.ReactNode", + "description": "The content to display inside the button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "A custom class name to apply styles to button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "url", + "value": "string", + "description": "A destination to link to, rendered in the href attribute of a link", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "external", + "value": "boolean", + "description": "Forces url to open in a new tab", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "download", + "value": "string | boolean", + "description": "Tells the browser to download the url instead of opening it. Provides a hint for the downloaded filename if it is a string value", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "submit", + "value": "boolean", + "description": "Allows the button to submit a form", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Disables the button, disallowing merchant interaction", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Replaces button text with a spinner while a background action is being performed", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "pressed", + "value": "boolean", + "description": "Sets the button in a pressed state", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden text for screen readers", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string", + "description": "A valid WAI-ARIA role to define the semantic value of this element", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "ariaControls", + "value": "string", + "description": "Id of the element the button controls", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "boolean", + "description": "Tells screen reader the controlled element is expanded", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedBy", + "value": "string", + "description": "Indicates the ID of the element that describes the button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "\"false\" | \"true\"", + "description": "Indicates the current checked state of the button when acting as a toggle or switch", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "Callback when clicked", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onFocus", + "value": "() => void", + "description": "Callback when button becomes focussed", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onBlur", + "value": "() => void", + "description": "Callback when focus leaves button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyPress", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keypress event is registered on the button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyUp", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keyup event is registered on the button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyDown", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keydown event is registered on the button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onMouseEnter", + "value": "() => void", + "description": "Callback when mouse enter", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onTouchStart", + "value": "() => void", + "description": "Callback when element is touched", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onPointerDown", + "value": "() => void", + "description": "Callback when pointerdown event is being triggered", + "isOptional": true + } + ], + "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}" + } + }, + "VideoThumbnailProps": { + "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx": { + "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", + "name": "VideoThumbnailProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", + "syntaxKind": "PropertySignature", + "name": "thumbnailUrl", + "value": "string", + "description": "URL source for thumbnail image." + }, + { + "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", + "syntaxKind": "PropertySignature", + "name": "videoLength", + "value": "number", + "description": "Length of video in seconds.", + "isOptional": true, + "defaultValue": "0" }, { "filePath": "polaris-react/src/components/VideoThumbnail/VideoThumbnail.tsx", @@ -22025,619 +21953,574 @@ "value": "export interface PortalsManager {\n container: PortalsContainerElement;\n}" } }, - "MeasuredActions": { - "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "name": "MeasuredActions", + "ItemProps": { + "polaris-react/src/components/ActionList/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/ActionList/components/Item/Item.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ItemProps", + "value": "ActionListItemDescriptor", + "description": "" + }, + "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx", + "name": "ItemProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", - "syntaxKind": "PropertySignature", - "name": "showable", - "value": "MenuActionDescriptor[]", - "description": "" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "filePath": "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "rolledUp", - "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", + "name": "button", + "value": "React.ReactElement", "description": "" } ], - "value": "interface MeasuredActions {\n showable: MenuActionDescriptor[];\n rolledUp: (MenuActionDescriptor | MenuGroupDescriptor)[];\n}" - } - }, - "MenuGroupProps": { - "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "name": "MenuGroupProps", + "value": "export interface ItemProps {\n button: React.ReactElement;\n}" + }, + "polaris-react/src/components/Connected/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", + "name": "ItemProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Visually hidden menu description for screen readers", - "isOptional": true + "name": "position", + "value": "ItemPosition", + "description": "Position of the item" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "active", - "value": "boolean", - "description": "Whether or not the menu is open", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "(openActions: () => void) => void", - "description": "Callback when the menu is clicked", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "onOpen", - "value": "(title: string) => void", - "description": "Callback for opening the MenuGroup by title" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "onClose", - "value": "(title: string) => void", - "description": "Callback for closing the MenuGroup by title" - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "MethodSignature", - "name": "getOffsetWidth", - "value": "(width: number) => void", - "description": "Callback for getting the offsetWidth of the MenuGroup", + "name": "children", + "value": "React.ReactNode", + "description": "Item content", "isOptional": true - }, + } + ], + "value": "export interface ItemProps {\n /** Position of the item */\n position: ItemPosition;\n /** Item content */\n children?: React.ReactNode;\n}" + }, + "polaris-react/src/components/FormLayout/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "sections", - "value": "readonly ActionListSection[]", - "description": "Collection of sectioned action items", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "Menu group title" - }, + } + ], + "value": "export interface ItemProps {\n children?: React.ReactNode;\n}" + }, + "polaris-react/src/components/List/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "actions", - "value": "ActionListItemDescriptor[]", - "description": "List of actions" - }, + "name": "children", + "value": "React.ReactNode", + "description": "Content to display inside the item", + "isOptional": true + } + ], + "value": "export interface ItemProps {\n /** Content to display inside the item */\n children?: React.ReactNode;\n}" + }, + "polaris-react/src/components/Navigation/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", "name": "icon", "value": "any", - "description": "Icon to display", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "details", - "value": "React.ReactNode", - "description": "Action details", + "name": "badge", + "value": "ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables action button", - "isOptional": true + "name": "label", + "value": "string", + "description": "" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "index", - "value": "number", - "description": "Zero-indexed numerical position. Overrides the group's order in the menu.", + "name": "disabled", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any action takes place", + "name": "accessibilityLabel", + "value": "string", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "badge", - "value": "{ status: \"new\"; content: string; }", + "name": "selected", + "value": "boolean", "description": "", "isOptional": true - } - ], - "value": "export interface MenuGroupProps extends MenuGroupDescriptor {\n /** Visually hidden menu description for screen readers */\n accessibilityLabel?: string;\n /** Whether or not the menu is open */\n active?: boolean;\n /** Callback when the menu is clicked */\n onClick?(openActions: () => void): void;\n /** Callback for opening the MenuGroup by title */\n onOpen(title: string): void;\n /** Callback for closing the MenuGroup by title */\n onClose(title: string): void;\n /** Callback for getting the offsetWidth of the MenuGroup */\n getOffsetWidth?(width: number): void;\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n}" - } - }, - "RollupActionsProps": { - "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", - "name": "RollupActionsProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Accessibilty label", + "name": "exactMatch", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "items", - "value": "ActionListItemDescriptor[]", - "description": "Collection of actions for the list", + "name": "new", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "sections", - "value": "ActionListSection[]", - "description": "Collection of sectioned action items", + "name": "subNavigationItems", + "value": "SubNavigationItem[]", + "description": "", "isOptional": true - } - ], - "value": "export interface RollupActionsProps {\n /** Accessibilty label */\n accessibilityLabel?: string;\n /** Collection of actions for the list */\n items?: ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: ActionListSection[];\n}" - } - }, - "SecondaryAction": { - "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "name": "SecondaryAction", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "helpText", - "value": "React.ReactNode", + "name": "secondaryAction", + "value": "SecondaryAction", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "MethodSignature", - "name": "onAction", + "name": "onClick", "value": "() => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "MethodSignature", - "name": "getOffsetWidth", - "value": "(width: number) => void", + "name": "onToggleExpandedState", + "value": "() => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "string | string[]", - "description": "The content to display inside the button", + "name": "expanded", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "primary", + "name": "shouldResizeIcon", "value": "boolean", - "description": "Provides extra visual weight and identifies the primary action in a set of buttons", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "destructive", - "value": "boolean", - "description": "Indicates a dangerous or potentially negative action", + "name": "url", + "value": "string", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "size", - "value": "\"large\" | \"medium\" | \"slim\"", - "description": "Changes the size of the button, giving it more or less padding", - "isOptional": true, - "defaultValue": "'medium'" + "name": "matches", + "value": "boolean", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "textAlign", - "value": "\"start\" | \"end\" | \"center\" | \"left\" | \"right\"", - "description": "Changes the inner text alignment of the button", + "name": "matchPaths", + "value": "string[]", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "outline", - "value": "boolean", - "description": "Gives the button a subtle alternative to the default button styling, appropriate for certain backdrops", + "name": "excludePaths", + "value": "string[]", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "fullWidth", + "name": "external", "value": "boolean", - "description": "Allows the button to grow to the width of its container", + "description": "", "isOptional": true - }, + } + ], + "value": "export interface ItemProps extends ItemURLDetails {\n icon?: IconProps['source'];\n badge?: ReactNode;\n label: string;\n disabled?: boolean;\n accessibilityLabel?: string;\n selected?: boolean;\n exactMatch?: boolean;\n new?: boolean;\n subNavigationItems?: SubNavigationItem[];\n secondaryAction?: SecondaryAction;\n onClick?(): void;\n onToggleExpandedState?(): void;\n expanded?: boolean;\n shouldResizeIcon?: boolean;\n}" + }, + "polaris-react/src/components/Stack/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "disclosure", - "value": "boolean | \"up\" | \"down\" | \"select\"", - "description": "Displays the button with a disclosure icon. Defaults to `down` when set to true", + "name": "children", + "value": "React.ReactNode", + "description": "Elements to display inside item", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "plain", + "name": "fill", "value": "boolean", - "description": "Renders a button that looks like a link", + "description": "Fill the remaining horizontal space in the stack with the item", "isOptional": true - }, + } + ], + "value": "export interface ItemProps {\n /** Elements to display inside item */\n children?: React.ReactNode;\n /** Fill the remaining horizontal space in the stack with the item */\n fill?: boolean;\n /**\n * @default false\n */\n}" + }, + "polaris-react/src/components/Tabs/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "monochrome", - "value": "boolean", - "description": "Makes `plain` and `outline` Button colors (text, borders, icons) the same as the current text color. Also adds an underline to `plain` Buttons", - "isOptional": true + "name": "id", + "value": "string", + "description": "" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "removeUnderline", + "name": "focused", "value": "boolean", - "description": "Removes underline from button text (including on interaction) when `monochrome` and `plain` are true", - "isOptional": true + "description": "" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "Icon to display to the left of the button content", + "name": "panelID", + "value": "string", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "connectedDisclosure", - "value": "ConnectedDisclosure", - "description": "Disclosure button connected right of the button. Toggles a popover action list.", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "dataPrimaryLink", - "value": "boolean", - "description": "Indicates whether or not the button is the primary navigation link when rendered inside of an `IndexTable.Row`", + "name": "url", + "value": "string", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "id", + "name": "accessibilityLabel", "value": "string", - "description": "A unique identifier for the button", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "", + "isOptional": true + } + ], + "value": "export interface ItemProps {\n id: string;\n focused: boolean;\n panelID?: string;\n children?: React.ReactNode;\n url?: string;\n accessibilityLabel?: string;\n onClick?(): void;\n}" + }, + "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", + "name": "ItemProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "A destination to link to, rendered in the href attribute of a link", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true + } + ], + "value": "interface ItemProps {\n children?: React.ReactNode;\n}" + } + }, + "SectionProps": { + "polaris-react/src/components/ActionList/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "section", + "value": "ActionListSection", + "description": "Section of action items" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "external", + "name": "hasMultipleSections", "value": "boolean", - "description": "Forces url to open in a new tab", - "isOptional": true + "description": "Should there be multiple sections" }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "download", - "value": "string | boolean", - "description": "Tells the browser to download the url instead of opening it. Provides a hint for the downloaded filename if it is a string value", + "name": "actionRole", + "value": "string", + "description": "Defines a specific role attribute for each action in the list", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "submit", - "value": "boolean", - "description": "Allows the button to submit a form", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any item is clicked or keypressed", "isOptional": true - }, + } + ], + "value": "export interface SectionProps {\n /** Section of action items */\n section: ActionListSection;\n /** Should there be multiple sections */\n hasMultipleSections: boolean;\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'option' | 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" + }, + "polaris-react/src/components/Layout/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the button, disallowing merchant interaction", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "loading", + "name": "secondary", "value": "boolean", - "description": "Replaces button text with a spinner while a background action is being performed", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "pressed", + "name": "fullWidth", "value": "boolean", - "description": "Sets the button in a pressed state", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Visually hidden text for screen readers", + "name": "oneHalf", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "role", - "value": "string", - "description": "A valid WAI-ARIA role to define the semantic value of this element", + "name": "oneThird", + "value": "boolean", + "description": "", "isOptional": true - }, + } + ], + "value": "export interface SectionProps {\n children?: React.ReactNode;\n secondary?: boolean;\n fullWidth?: boolean;\n oneHalf?: boolean;\n oneThird?: boolean;\n}" + }, + "polaris-react/src/components/Listbox/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "ariaControls", - "value": "string", - "description": "Id of the element the button controls", + "name": "divider", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "ariaExpanded", - "value": "boolean", - "description": "Tells screen reader the controlled element is expanded", + "name": "children", + "value": "ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "ariaDescribedBy", - "value": "string", - "description": "Indicates the ID of the element that describes the button", - "isOptional": true - }, + "name": "title", + "value": "ReactNode", + "description": "" + } + ], + "value": "interface SectionProps {\n divider?: boolean;\n children?: ReactNode;\n title: ReactNode;\n}" + }, + "polaris-react/src/components/Modal/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "name": "SectionProps", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "ariaChecked", - "value": "\"false\" | \"true\"", - "description": "Indicates the current checked state of the button when acting as a toggle or switch", + "name": "children", + "value": "React.ReactNode", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "Callback when clicked", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onFocus", - "value": "() => void", - "description": "Callback when button becomes focussed", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onBlur", - "value": "() => void", - "description": "Callback when focus leaves button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyPress", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keypress event is registered on the button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyUp", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keyup event is registered on the button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyDown", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keydown event is registered on the button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onMouseEnter", - "value": "() => void", - "description": "Callback when mouse enter", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "flush", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onTouchStart", - "value": "() => void", - "description": "Callback when element is touched", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "subdued", + "value": "boolean", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", - "syntaxKind": "MethodSignature", - "name": "onPointerDown", - "value": "() => void", - "description": "Callback when pointerdown event is being triggered", + "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "titleHidden", + "value": "boolean", + "description": "", "isOptional": true } ], - "value": "interface SecondaryAction extends ButtonProps {\n helpText?: React.ReactNode;\n onAction?(): void;\n getOffsetWidth?(width: number): void;\n}" + "value": "export interface SectionProps {\n children?: React.ReactNode;\n flush?: boolean;\n subdued?: boolean;\n titleHidden?: boolean;\n}" }, - "polaris-react/src/components/Navigation/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "SecondaryAction", + "polaris-react/src/components/Navigation/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "name": "SectionProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", + "name": "items", + "value": "ItemProps[]", "description": "" }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", "name": "icon", "value": "any", - "description": "" + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "tooltip", - "value": "TooltipProps", + "name": "fill", + "value": "boolean", "description": "", "isOptional": true - } - ], - "value": "interface SecondaryAction {\n url: string;\n accessibilityLabel: string;\n icon: IconProps['source'];\n onClick?(): void;\n tooltip?: TooltipProps;\n}" - } - }, - "ItemProps": { - "polaris-react/src/components/ActionList/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/ActionList/components/Item/Item.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "ItemProps", - "value": "ActionListItemDescriptor", - "description": "" - }, - "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/ButtonGroup/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "button", - "value": "React.ReactElement", - "description": "" - } - ], - "value": "export interface ItemProps {\n button: React.ReactElement;\n}" - }, - "polaris-react/src/components/Connected/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ + "name": "rollup", + "value": "{ after: number; view: string; hide: string; activePath: string; }", + "description": "", + "isOptional": true + }, { - "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "position", - "value": "ItemPosition", - "description": "Position of the item" + "name": "action", + "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Connected/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Item content", + "name": "separator", + "value": "boolean", + "description": "", "isOptional": true } ], - "value": "export interface ItemProps {\n /** Position of the item */\n position: ItemPosition;\n /** Item content */\n children?: React.ReactNode;\n}" + "value": "export interface SectionProps {\n items: ItemProps[];\n icon?: IconProps['source'];\n title?: string;\n fill?: boolean;\n rollup?: {\n after: number;\n view: string;\n hide: string;\n activePath: string;\n };\n action?: {\n icon: IconProps['source'];\n accessibilityLabel: string;\n onClick(): void;\n tooltip?: TooltipProps;\n };\n separator?: boolean;\n}" }, - "polaris-react/src/components/FormLayout/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", - "name": "ItemProps", + "polaris-react/src/components/Popover/components/Section/Section.tsx": { + "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", + "name": "SectionProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/FormLayout/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", @@ -22645,729 +22528,758 @@ "isOptional": true } ], - "value": "export interface ItemProps {\n children?: React.ReactNode;\n}" - }, - "polaris-react/src/components/List/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", - "name": "ItemProps", + "value": "export interface SectionProps {\n children?: React.ReactNode;\n}" + } + }, + "MeasuredActions": { + "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "name": "MeasuredActions", "description": "", "members": [ { - "filePath": "polaris-react/src/components/List/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Content to display inside the item", - "isOptional": true + "name": "showable", + "value": "MenuActionDescriptor[]", + "description": "" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/Actions/Actions.tsx", + "syntaxKind": "PropertySignature", + "name": "rolledUp", + "value": "(MenuActionDescriptor | MenuGroupDescriptor)[]", + "description": "" } ], - "value": "export interface ItemProps {\n /** Content to display inside the item */\n children?: React.ReactNode;\n}" - }, - "polaris-react/src/components/Navigation/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", - "name": "ItemProps", + "value": "interface MeasuredActions {\n showable: MenuActionDescriptor[];\n rolledUp: (MenuActionDescriptor | MenuGroupDescriptor)[];\n}" + } + }, + "MenuGroupProps": { + "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "name": "MenuGroupProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "", + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden menu description for screen readers", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "badge", - "value": "ReactNode", - "description": "", + "name": "active", + "value": "boolean", + "description": "Whether or not the menu is open", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "(openActions: () => void) => void", + "description": "Callback when the menu is clicked", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "onOpen", + "value": "(title: string) => void", + "description": "Callback for opening the MenuGroup by title" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "onClose", + "value": "(title: string) => void", + "description": "Callback for closing the MenuGroup by title" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "MethodSignature", + "name": "getOffsetWidth", + "value": "(width: number) => void", + "description": "Callback for getting the offsetWidth of the MenuGroup", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "label", + "name": "sections", + "value": "readonly ActionListSection[]", + "description": "Collection of sectioned action items", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "title", "value": "string", - "description": "" + "description": "Menu group title" }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "actions", + "value": "ActionListItemDescriptor[]", + "description": "List of actions" + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "any", + "description": "Icon to display", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "details", + "value": "React.ReactNode", + "description": "Action details", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "", + "description": "Disables action button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "", + "name": "index", + "value": "number", + "description": "Zero-indexed numerical position. Overrides the group's order in the menu.", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "selected", - "value": "boolean", - "description": "", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any action takes place", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/MenuGroup/MenuGroup.tsx", "syntaxKind": "PropertySignature", - "name": "exactMatch", - "value": "boolean", + "name": "badge", + "value": "{ status: \"new\"; content: string; }", "description": "", "isOptional": true + } + ], + "value": "export interface MenuGroupProps extends MenuGroupDescriptor {\n /** Visually hidden menu description for screen readers */\n accessibilityLabel?: string;\n /** Whether or not the menu is open */\n active?: boolean;\n /** Callback when the menu is clicked */\n onClick?(openActions: () => void): void;\n /** Callback for opening the MenuGroup by title */\n onOpen(title: string): void;\n /** Callback for closing the MenuGroup by title */\n onClose(title: string): void;\n /** Callback for getting the offsetWidth of the MenuGroup */\n getOffsetWidth?(width: number): void;\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n}" + } + }, + "RollupActionsProps": { + "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "name": "RollupActionsProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "Accessibilty label", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", "syntaxKind": "PropertySignature", - "name": "new", - "value": "boolean", - "description": "", + "name": "items", + "value": "ActionListItemDescriptor[]", + "description": "Collection of actions for the list", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/RollupActions/RollupActions.tsx", "syntaxKind": "PropertySignature", - "name": "subNavigationItems", - "value": "SubNavigationItem[]", - "description": "", + "name": "sections", + "value": "ActionListSection[]", + "description": "Collection of sectioned action items", "isOptional": true - }, + } + ], + "value": "export interface RollupActionsProps {\n /** Accessibilty label */\n accessibilityLabel?: string;\n /** Collection of actions for the list */\n items?: ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: ActionListSection[];\n}" + } + }, + "SecondaryAction": { + "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "name": "SecondaryAction", + "description": "", + "members": [ { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "secondaryAction", - "value": "SecondaryAction", + "name": "helpText", + "value": "React.ReactNode", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "MethodSignature", - "name": "onClick", + "name": "onAction", "value": "() => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "MethodSignature", - "name": "onToggleExpandedState", - "value": "() => void", + "name": "getOffsetWidth", + "value": "(width: number) => void", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "expanded", - "value": "boolean", - "description": "", + "name": "children", + "value": "string | string[]", + "description": "The content to display inside the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "shouldResizeIcon", + "name": "primary", "value": "boolean", - "description": "", + "description": "Provides extra visual weight and identifies the primary action in a set of buttons", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "", + "name": "destructive", + "value": "boolean", + "description": "Indicates a dangerous or potentially negative action", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "matches", - "value": "boolean", - "description": "", - "isOptional": true + "name": "size", + "value": "\"medium\" | \"large\" | \"slim\"", + "description": "Changes the size of the button, giving it more or less padding", + "isOptional": true, + "defaultValue": "'medium'" }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "matchPaths", - "value": "string[]", - "description": "", + "name": "textAlign", + "value": "\"start\" | \"end\" | \"center\" | \"left\" | \"right\"", + "description": "Changes the inner text alignment of the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "excludePaths", - "value": "string[]", - "description": "", + "name": "outline", + "value": "boolean", + "description": "Gives the button a subtle alternative to the default button styling, appropriate for certain backdrops", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "external", + "name": "fullWidth", "value": "boolean", - "description": "", + "description": "Allows the button to grow to the width of its container", "isOptional": true - } - ], - "value": "export interface ItemProps extends ItemURLDetails {\n icon?: IconProps['source'];\n badge?: ReactNode;\n label: string;\n disabled?: boolean;\n accessibilityLabel?: string;\n selected?: boolean;\n exactMatch?: boolean;\n new?: boolean;\n subNavigationItems?: SubNavigationItem[];\n secondaryAction?: SecondaryAction;\n onClick?(): void;\n onToggleExpandedState?(): void;\n expanded?: boolean;\n shouldResizeIcon?: boolean;\n}" - }, - "polaris-react/src/components/Stack/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Elements to display inside item", + "name": "disclosure", + "value": "boolean | \"up\" | \"down\" | \"select\"", + "description": "Displays the button with a disclosure icon. Defaults to `down` when set to true", "isOptional": true }, { - "filePath": "polaris-react/src/components/Stack/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "fill", + "name": "plain", "value": "boolean", - "description": "Fill the remaining horizontal space in the stack with the item", + "description": "Renders a button that looks like a link", "isOptional": true - } - ], - "value": "export interface ItemProps {\n /** Elements to display inside item */\n children?: React.ReactNode;\n /** Fill the remaining horizontal space in the stack with the item */\n fill?: boolean;\n /**\n * @default false\n */\n}" - }, - "polaris-react/src/components/Tabs/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "" }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "focused", + "name": "monochrome", "value": "boolean", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "panelID", - "value": "string", - "description": "", + "description": "Makes `plain` and `outline` Button colors (text, borders, icons) the same as the current text color. Also adds an underline to `plain` Buttons", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "name": "removeUnderline", + "value": "boolean", + "description": "Removes underline from button text (including on interaction) when `monochrome` and `plain` are true", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "", + "name": "icon", + "value": "any", + "description": "Icon to display to the left of the button content", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "", + "name": "connectedDisclosure", + "value": "ConnectedDisclosure", + "description": "Disclosure button connected right of the button. Toggles a popover action list.", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Item/Item.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "", - "isOptional": true - } - ], - "value": "export interface ItemProps {\n id: string;\n focused: boolean;\n panelID?: string;\n children?: React.ReactNode;\n url?: string;\n accessibilityLabel?: string;\n onClick?(): void;\n}" - }, - "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx": { - "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", - "name": "ItemProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Filters/components/ConnectedFilterControl/components/Item/Item.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "interface ItemProps {\n children?: React.ReactNode;\n}" - } - }, - "MappedAction": { - "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx": { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "name": "MappedAction", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "wrapOverflow", + "name": "dataPrimaryLink", "value": "boolean", - "description": "", + "description": "Indicates whether or not the button is the primary navigation link when rendered inside of an `IndexTable.Row`", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", + "name": "id", "value": "string", - "description": "Visually hidden text for screen readers", + "description": "A unique identifier for the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "badge", - "value": "{ status: \"new\"; content: string; }", - "description": "", - "isOptional": true, - "deprecationMessage": "Badge component" - }, - { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "helpText", - "value": "React.ReactNode", - "description": "Additional hint text to display with item", + "name": "url", + "value": "string", + "description": "A destination to link to, rendered in the href attribute of a link", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "", - "isOptional": true, - "deprecationMessage": "Source of the icon" + "name": "external", + "value": "boolean", + "description": "Forces url to open in a new tab", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "string", - "description": "", - "isOptional": true, - "deprecationMessage": "Image source" + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "PropertySignature", + "name": "download", + "value": "string | boolean", + "description": "Tells the browser to download the url instead of opening it. Provides a hint for the downloaded filename if it is a string value", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "prefix", - "value": "React.ReactNode", - "description": "Prefix source", + "name": "submit", + "value": "boolean", + "description": "Allows the button to submit a form", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "suffix", - "value": "React.ReactNode", - "description": "Suffix source", + "name": "disabled", + "value": "boolean", + "description": "Disables the button, disallowing merchant interaction", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "ellipsis", + "name": "loading", "value": "boolean", - "description": "Add an ellipsis suffix to action content", + "description": "Replaces button text with a spinner while a background action is being performed", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "active", + "name": "pressed", "value": "boolean", - "description": "Whether the action is active or not", + "description": "Sets the button in a pressed state", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "role", + "name": "accessibilityLabel", "value": "string", - "description": "Defines a role for the action", + "description": "Visually hidden text for screen readers", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Whether or not the action is disabled", + "name": "role", + "value": "string", + "description": "A valid WAI-ARIA role to define the semantic value of this element", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "id", + "name": "ariaControls", "value": "string", - "description": "A unique identifier for the action", + "description": "Id of the element the button controls", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "content", - "value": "string", - "description": "Content the action displays", + "name": "ariaExpanded", + "value": "boolean", + "description": "Tells screen reader the controlled element is expanded", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "url", + "name": "ariaDescribedBy", "value": "string", - "description": "A destination to link to, rendered in the action", + "description": "Indicates the ID of the element that describes the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "PropertySignature", - "name": "external", - "value": "boolean", - "description": "Forces url to open in a new tab", + "name": "ariaChecked", + "value": "\"false\" | \"true\"", + "description": "Indicates the current checked state of the button when acting as a toggle or switch", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "MethodSignature", - "name": "onAction", + "name": "onClick", "value": "() => void", - "description": "Callback when an action takes place", + "description": "Callback when clicked", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "MethodSignature", - "name": "onMouseEnter", + "name": "onFocus", "value": "() => void", - "description": "Callback when mouse enter", + "description": "Callback when button becomes focussed", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", "syntaxKind": "MethodSignature", - "name": "onTouchStart", + "name": "onBlur", "value": "() => void", - "description": "Callback when element is touched", + "description": "Callback when focus leaves button", "isOptional": true }, { - "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", - "syntaxKind": "PropertySignature", - "name": "destructive", - "value": "boolean", - "description": "Destructive action", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyPress", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keypress event is registered on the button", "isOptional": true - } - ], - "value": "interface MappedAction extends ActionListItemDescriptor {\n wrapOverflow?: boolean;\n}" - } - }, - "SectionProps": { - "polaris-react/src/components/ActionList/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "section", - "value": "ActionListSection", - "description": "Section of action items" + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyUp", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keyup event is registered on the button", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "hasMultipleSections", - "value": "boolean", - "description": "Should there be multiple sections" + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyDown", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keydown event is registered on the button", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "actionRole", - "value": "string", - "description": "Defines a specific role attribute for each action in the list", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onMouseEnter", + "value": "() => void", + "description": "Callback when mouse enter", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionList/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onTouchStart", "value": "() => void", - "description": "Callback when any item is clicked or keypressed", + "description": "Callback when element is touched", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onPointerDown", + "value": "() => void", + "description": "Callback when pointerdown event is being triggered", "isOptional": true } ], - "value": "export interface SectionProps {\n /** 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": "interface SecondaryAction extends ButtonProps {\n helpText?: React.ReactNode;\n onAction?(): void;\n getOffsetWidth?(width: number): void;\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/Navigation/components/Item/Item.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", + "name": "SecondaryAction", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true + "name": "url", + "value": "string", + "description": "" }, { - "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", - "description": "", - "isOptional": true + "name": "accessibilityLabel", + "value": "string", + "description": "" }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "fullWidth", - "value": "boolean", - "description": "", - "isOptional": true + "name": "icon", + "value": "any", + "description": "" }, { - "filePath": "polaris-react/src/components/Layout/components/Section/Section.tsx", - "syntaxKind": "PropertySignature", - "name": "oneHalf", - "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/Layout/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Navigation/components/Item/Item.tsx", "syntaxKind": "PropertySignature", - "name": "oneThird", - "value": "boolean", + "name": "tooltip", + "value": "TooltipProps", "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", + "value": "interface SecondaryAction {\n url: string;\n accessibilityLabel: string;\n icon: IconProps['source'];\n onClick?(): void;\n tooltip?: TooltipProps;\n}" + } + }, + "MappedAction": { + "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx": { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "name": "MappedAction", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "divider", + "name": "wrapOverflow", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", - "description": "", + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden text for screen readers", "isOptional": true }, { - "filePath": "polaris-react/src/components/Listbox/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "title", - "value": "ReactNode", - "description": "" - } - ], - "value": "interface SectionProps {\n divider?: boolean;\n children?: ReactNode;\n title: ReactNode;\n}" - }, - "polaris-react/src/components/Modal/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ + "name": "badge", + "value": "{ status: \"new\"; content: string; }", + "description": "", + "isOptional": true, + "deprecationMessage": "Badge component" + }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", + "name": "helpText", "value": "React.ReactNode", - "description": "", + "description": "Additional hint text to display with item", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "flush", - "value": "boolean", + "name": "icon", + "value": "any", "description": "", - "isOptional": true + "isOptional": true, + "deprecationMessage": "Source of the icon" }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "subdued", - "value": "boolean", + "name": "image", + "value": "string", "description": "", + "isOptional": true, + "deprecationMessage": "Image source" + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "React.ReactNode", + "description": "Prefix source", "isOptional": true }, { - "filePath": "polaris-react/src/components/Modal/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "titleHidden", - "value": "boolean", - "description": "", + "name": "suffix", + "value": "React.ReactNode", + "description": "Suffix source", "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", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "items", - "value": "ItemProps[]", - "description": "" + "name": "ellipsis", + "value": "boolean", + "description": "Add an ellipsis suffix to action content", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "icon", - "value": "any", - "description": "", + "name": "active", + "value": "boolean", + "description": "Whether the action is active or not", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "title", + "name": "role", "value": "string", - "description": "", + "description": "Defines a role for the action", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "fill", + "name": "disabled", "value": "boolean", - "description": "", + "description": "Whether or not the action is disabled", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "rollup", - "value": "{ after: number; view: string; hide: string; activePath: string; }", - "description": "", + "name": "id", + "value": "string", + "description": "A unique identifier for the action", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "action", - "value": "{ icon: any; accessibilityLabel: string; onClick(): void; tooltip?: TooltipProps; }", - "description": "", + "name": "content", + "value": "string", + "description": "Content the action displays", "isOptional": true }, { - "filePath": "polaris-react/src/components/Navigation/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "separator", - "value": "boolean", - "description": "", + "name": "url", + "value": "string", + "description": "A destination to link to, rendered in the action", "isOptional": true - } - ], - "value": "export interface SectionProps {\n items: ItemProps[];\n icon?: IconProps['source'];\n title?: string;\n fill?: boolean;\n rollup?: {\n after: number;\n view: string;\n hide: string;\n activePath: string;\n };\n action?: {\n icon: IconProps['source'];\n accessibilityLabel: string;\n onClick(): void;\n tooltip?: TooltipProps;\n };\n separator?: boolean;\n}" - }, - "polaris-react/src/components/Popover/components/Section/Section.tsx": { - "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", - "name": "SectionProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Popover/components/Section/Section.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "name": "external", + "value": "boolean", + "description": "Forces url to open in a new tab", "isOptional": true - } - ], - "value": "export interface SectionProps {\n children?: React.ReactNode;\n}" - } - }, - "PipProps": { - "polaris-react/src/components/Badge/components/Pip/Pip.tsx": { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", - "name": "PipProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", - "syntaxKind": "PropertySignature", - "name": "status", - "value": "Status", - "description": "", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onAction", + "value": "() => void", + "description": "Callback when an action takes place", "isOptional": true }, { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", - "syntaxKind": "PropertySignature", - "name": "progress", - "value": "Progress", - "description": "", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onMouseEnter", + "value": "() => void", + "description": "Callback when mouse enter", "isOptional": true }, { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", + "syntaxKind": "MethodSignature", + "name": "onTouchStart", + "value": "() => void", + "description": "Callback when element is touched", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedAction/MappedAction.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabelOverride", - "value": "string", - "description": "", + "name": "destructive", + "value": "boolean", + "description": "Destructive action", "isOptional": true } ], - "value": "export interface PipProps {\n status?: Status;\n progress?: Progress;\n accessibilityLabelOverride?: string;\n}" + "value": "interface MappedAction extends ActionListItemDescriptor {\n wrapOverflow?: boolean;\n}" + } + }, + "MappedOption": { + "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx": { + "filePath": "polaris-react/src/components/Autocomplete/components/MappedOption/MappedOption.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "MappedOption", + "value": "ArrayElement & {\n selected: boolean;\n singleSelection: boolean;\n}", + "description": "" + } + }, + "BulkActionButtonProps": { + "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx": { + "filePath": "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "BulkActionButtonProps", + "value": "{\n disclosure?: boolean;\n indicator?: boolean;\n handleMeasurement?(width: number): void;\n} & DisableableAction", + "description": "" } }, "BulkActionsMenuProps": { @@ -23457,22 +23369,38 @@ "value": "export interface BulkActionsMenuProps extends MenuGroupDescriptor {\n isNewBadgeInBadgeActions: boolean;\n}" } }, - "BulkActionButtonProps": { - "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx": { - "filePath": "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "BulkActionButtonProps", - "value": "{\n disclosure?: boolean;\n indicator?: boolean;\n handleMeasurement?(width: number): void;\n} & DisableableAction", - "description": "" - } - }, - "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", + "name": "PipProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "syntaxKind": "PropertySignature", + "name": "status", + "value": "Status", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "syntaxKind": "PropertySignature", + "name": "progress", + "value": "Progress", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabelOverride", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface PipProps {\n status?: Status;\n progress?: Progress;\n accessibilityLabelOverride?: string;\n}" } }, "CardHeaderProps": { @@ -23566,31 +23494,13 @@ { "filePath": "polaris-react/src/components/Card/components/Section/Section.tsx", "syntaxKind": "PropertySignature", - "name": "actions", - "value": "ComplexAction[]", - "description": "", - "isOptional": true - } - ], - "value": "export interface CardSectionProps {\n title?: React.ReactNode;\n children?: React.ReactNode;\n subdued?: boolean;\n flush?: boolean;\n fullWidth?: boolean;\n /** Allow the card to be hidden when printing */\n hideOnPrint?: boolean;\n actions?: ComplexAction[];\n}" - } - }, - "CardSubsectionProps": { - "polaris-react/src/components/Card/components/Subsection/Subsection.tsx": { - "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", - "name": "CardSubsectionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", + "name": "actions", + "value": "ComplexAction[]", "description": "", "isOptional": true } ], - "value": "export interface CardSubsectionProps {\n children?: React.ReactNode;\n}" + "value": "export interface CardSectionProps {\n title?: React.ReactNode;\n children?: React.ReactNode;\n subdued?: boolean;\n flush?: boolean;\n fullWidth?: boolean;\n /** Allow the card to be hidden when printing */\n hideOnPrint?: boolean;\n actions?: ComplexAction[];\n}" } }, "AlphaPickerProps": { @@ -23624,6 +23534,24 @@ "value": "export interface AlphaPickerProps {\n color: HSBColor;\n alpha: number;\n onChange(hue: number): void;\n}" } }, + "CardSubsectionProps": { + "polaris-react/src/components/Card/components/Subsection/Subsection.tsx": { + "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", + "name": "CardSubsectionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "export interface CardSubsectionProps {\n children?: React.ReactNode;\n}" + } + }, "HuePickerProps": { "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx": { "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", @@ -25203,6 +25131,31 @@ "value": "export interface OptionProps {\n id: string;\n label: React.ReactNode;\n value: string;\n section: number;\n index: number;\n media?: React.ReactElement;\n disabled?: boolean;\n active?: boolean;\n select?: boolean;\n allowMultiple?: boolean;\n verticalAlign?: Alignment;\n role?: string;\n onClick(section: number, option: number): void;\n}" } }, + "CloseButtonProps": { + "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx": { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "name": "CloseButtonProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "syntaxKind": "PropertySignature", + "name": "titleHidden", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "" + } + ], + "value": "export interface CloseButtonProps {\n titleHidden?: boolean;\n onClick(): void;\n}" + } + }, "TextOptionProps": { "polaris-react/src/components/Listbox/components/TextOption/TextOption.tsx": { "filePath": "polaris-react/src/components/Listbox/components/TextOption/TextOption.tsx", @@ -25236,31 +25189,6 @@ "value": "export interface TextOptionProps {\n children: React.ReactNode;\n // Whether the option is selected\n selected?: boolean;\n // Whether the option is disabled\n disabled?: boolean;\n}" } }, - "CloseButtonProps": { - "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx": { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "name": "CloseButtonProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "syntaxKind": "PropertySignature", - "name": "titleHidden", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "" - } - ], - "value": "export interface CloseButtonProps {\n titleHidden?: boolean;\n onClick(): void;\n}" - } - }, "DialogProps": { "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx": { "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", @@ -25573,56 +25501,6 @@ ] } }, - "PaneProps": { - "polaris-react/src/components/Popover/components/Pane/Pane.tsx": { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "name": "PaneProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "fixed", - "value": "boolean", - "description": "Fix the pane to the top of the popover", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "sectioned", - "value": "boolean", - "description": "Automatically wrap children in padded sections", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The pane content", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "height", - "value": "string", - "description": "Sets a fixed height and max-height on the Scrollable", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "MethodSignature", - "name": "onScrolledToBottom", - "value": "() => void", - "description": "Callback when the bottom of the popover is reached by mouse or keyboard", - "isOptional": true - } - ], - "value": "export interface PaneProps {\n /** Fix the pane to the top of the popover */\n fixed?: boolean;\n /** Automatically wrap children in padded sections */\n sectioned?: boolean;\n /** The pane content */\n children?: React.ReactNode;\n /** Sets a fixed height and max-height on the Scrollable */\n height?: string;\n /** Callback when the bottom of the popover is reached by mouse or keyboard */\n onScrolledToBottom?(): void;\n}" - } - }, "PrimaryAction": { "polaris-react/src/components/Page/components/Header/Header.tsx": { "filePath": "polaris-react/src/components/Page/components/Header/Header.tsx", @@ -25745,6 +25623,56 @@ "value": "interface PrimaryAction\n extends DestructableAction,\n DisableableAction,\n LoadableAction,\n IconableAction,\n TooltipAction {\n /** Provides extra visual weight and identifies the primary action in a set of buttons */\n primary?: boolean;\n}" } }, + "PaneProps": { + "polaris-react/src/components/Popover/components/Pane/Pane.tsx": { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "name": "PaneProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "fixed", + "value": "boolean", + "description": "Fix the pane to the top of the popover", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "sectioned", + "value": "boolean", + "description": "Automatically wrap children in padded sections", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The pane content", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "height", + "value": "string", + "description": "Sets a fixed height and max-height on the Scrollable", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "MethodSignature", + "name": "onScrolledToBottom", + "value": "() => void", + "description": "Callback when the bottom of the popover is reached by mouse or keyboard", + "isOptional": true + } + ], + "value": "export interface PaneProps {\n /** Fix the pane to the top of the popover */\n fixed?: boolean;\n /** Automatically wrap children in padded sections */\n sectioned?: boolean;\n /** The pane content */\n children?: React.ReactNode;\n /** Sets a fixed height and max-height on the Scrollable */\n height?: string;\n /** Callback when the bottom of the popover is reached by mouse or keyboard */\n onScrolledToBottom?(): void;\n}" + } + }, "PopoverCloseSource": { "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx": { "filePath": "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx", @@ -25935,56 +25863,56 @@ "value": "export interface PolarisContainerProps {}" } }, - "DualThumbProps": { - "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx": { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "name": "DualThumbProps", + "SingleThumbProps": { + "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx": { + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "name": "SingleThumbProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "value", - "value": "DualValue", + "value": "number", "description": "Initial value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "id", "value": "string", "description": "ID for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "min", "value": "number", "description": "Minimum possible value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "max", "value": "number", "description": "Maximum possible value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "step", "value": "number", "description": "Increment value for range input changes" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "label", "value": "ReactNode", "description": "Label for the range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "labelAction", "value": "Action", @@ -25992,7 +25920,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "labelHidden", "value": "boolean", @@ -26000,7 +25928,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "output", "value": "boolean", @@ -26008,7 +25936,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "helpText", "value": "ReactNode", @@ -26016,7 +25944,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "error", "value": "any", @@ -26024,7 +25952,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", @@ -26032,7 +25960,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "prefix", "value": "ReactNode", @@ -26040,7 +25968,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "PropertySignature", "name": "suffix", "value": "ReactNode", @@ -26048,14 +25976,14 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "MethodSignature", "name": "onChange", "value": "(value: RangeSliderValue, id: string) => void", "description": "Callback when the range input is changed" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", "syntaxKind": "MethodSignature", "name": "onFocus", "value": "() => void", @@ -26063,102 +25991,67 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "syntaxKind": "MethodSignature", - "name": "onBlur", - "value": "() => void", - "description": "Callback when focus is removed", - "isOptional": true - } - ], - "value": "export interface DualThumbProps extends RangeSliderProps {\n value: DualValue;\n id: string;\n min: number;\n max: number;\n step: number;\n}" - } - }, - "KeyHandlers": { - "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx": { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "name": "KeyHandlers", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "name": "[key: string]", - "value": "() => void" - } - ], - "value": "interface KeyHandlers {\n [key: string]: () => void;\n}" - } - }, - "Control": { - "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx": { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "syntaxKind": "EnumDeclaration", - "name": "Control", - "value": "enum Control {\n Lower,\n Upper,\n}", - "members": [ - { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "name": "Lower", - "value": 0 - }, - { - "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", - "name": "Upper", - "value": 1 + "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "syntaxKind": "MethodSignature", + "name": "onBlur", + "value": "() => void", + "description": "Callback when focus is removed", + "isOptional": true } - ] + ], + "value": "export interface SingleThumbProps extends RangeSliderProps {\n value: number;\n id: string;\n min: number;\n max: number;\n step: number;\n}" } }, - "SingleThumbProps": { - "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx": { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", - "name": "SingleThumbProps", + "DualThumbProps": { + "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx": { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "name": "DualThumbProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "value", - "value": "number", + "value": "DualValue", "description": "Initial value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "id", "value": "string", "description": "ID for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "min", "value": "number", "description": "Minimum possible value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "max", "value": "number", "description": "Maximum possible value for range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "step", "value": "number", "description": "Increment value for range input changes" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "label", "value": "ReactNode", "description": "Label for the range input" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "labelAction", "value": "Action", @@ -26166,7 +26059,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "labelHidden", "value": "boolean", @@ -26174,7 +26067,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "output", "value": "boolean", @@ -26182,7 +26075,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "helpText", "value": "ReactNode", @@ -26190,7 +26083,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "error", "value": "any", @@ -26198,7 +26091,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", @@ -26206,7 +26099,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "prefix", "value": "ReactNode", @@ -26214,7 +26107,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "PropertySignature", "name": "suffix", "value": "ReactNode", @@ -26222,14 +26115,14 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "MethodSignature", "name": "onChange", "value": "(value: RangeSliderValue, id: string) => void", "description": "Callback when the range input is changed" }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "MethodSignature", "name": "onFocus", "value": "() => void", @@ -26237,7 +26130,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/RangeSlider/components/SingleThumb/SingleThumb.tsx", + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", "syntaxKind": "MethodSignature", "name": "onBlur", "value": "() => void", @@ -26245,7 +26138,42 @@ "isOptional": true } ], - "value": "export interface SingleThumbProps extends RangeSliderProps {\n value: number;\n id: string;\n min: number;\n max: number;\n step: number;\n}" + "value": "export interface DualThumbProps extends RangeSliderProps {\n value: DualValue;\n id: string;\n min: number;\n max: number;\n step: number;\n}" + } + }, + "KeyHandlers": { + "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx": { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "name": "KeyHandlers", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "name": "[key: string]", + "value": "() => void" + } + ], + "value": "interface KeyHandlers {\n [key: string]: () => void;\n}" + } + }, + "Control": { + "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx": { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "syntaxKind": "EnumDeclaration", + "name": "Control", + "value": "enum Control {\n Lower,\n Upper,\n}", + "members": [ + { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "name": "Lower", + "value": 0 + }, + { + "filePath": "polaris-react/src/components/RangeSlider/components/DualThumb/DualThumb.tsx", + "name": "Upper", + "value": 1 + } + ] } }, "PanelProps": { @@ -26288,6 +26216,89 @@ "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": "" + } + ], + "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}" + } + }, "TabProps": { "polaris-react/src/components/Tabs/components/Tab/Tab.tsx": { "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", @@ -26377,89 +26388,6 @@ "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", From 6b8905276a6b22e402e159538c45f00d971340b0 Mon Sep 17 00:00:00 2001 From: aveline Date: Mon, 3 Oct 2022 10:15:07 -0700 Subject: [PATCH 21/25] [Layout foundations ] Rename `Tiles` (#7320) ### WHY are these changes introduced? Fixes #7316 --- .changeset/good-mugs-share.md | 6 + polaris-react/src/components/Tile/index.ts | 1 - .../{Tile/Tile.scss => Tiles/Tiles.scss} | 2 +- .../Tiles.stories.tsx} | 18 +- .../{Tile/Tile.tsx => Tiles/Tiles.tsx} | 8 +- polaris-react/src/components/Tiles/index.ts | 1 + .../tests/Tiles.test.tsx} | 12 +- polaris-react/src/index.ts | 4 +- .../content/components/tile/index.md | 6 +- ...ith-columns.tsx => tiles-with-columns.tsx} | 10 +- ...ith-spacing.tsx => tiles-with-spacing.tsx} | 10 +- polaris.shopify.com/src/data/props.json | 3524 ++++++++--------- 12 files changed, 1804 insertions(+), 1798 deletions(-) create mode 100644 .changeset/good-mugs-share.md delete mode 100644 polaris-react/src/components/Tile/index.ts rename polaris-react/src/components/{Tile/Tile.scss => Tiles/Tiles.scss} (99%) rename polaris-react/src/components/{Tile/Tile.stories.tsx => Tiles/Tiles.stories.tsx} (78%) rename polaris-react/src/components/{Tile/Tile.tsx => Tiles/Tiles.tsx} (88%) create mode 100644 polaris-react/src/components/Tiles/index.ts rename polaris-react/src/components/{Tile/tests/Tile.test.tsx => Tiles/tests/Tiles.test.tsx} (73%) rename polaris.shopify.com/pages/examples/{tile-with-columns.tsx => tiles-with-columns.tsx} (75%) rename polaris.shopify.com/pages/examples/{tile-with-spacing.tsx => tiles-with-spacing.tsx} (75%) diff --git a/.changeset/good-mugs-share.md b/.changeset/good-mugs-share.md new file mode 100644 index 00000000000..2563730b528 --- /dev/null +++ b/.changeset/good-mugs-share.md @@ -0,0 +1,6 @@ +--- +'@shopify/polaris': patch +'polaris.shopify.com': patch +--- + +Rename `Tiles` component diff --git a/polaris-react/src/components/Tile/index.ts b/polaris-react/src/components/Tile/index.ts deleted file mode 100644 index 90058956177..00000000000 --- a/polaris-react/src/components/Tile/index.ts +++ /dev/null @@ -1 +0,0 @@ -export * from './Tile'; diff --git a/polaris-react/src/components/Tile/Tile.scss b/polaris-react/src/components/Tiles/Tiles.scss similarity index 99% rename from polaris-react/src/components/Tile/Tile.scss rename to polaris-react/src/components/Tiles/Tiles.scss index e3733733328..62e5c25583f 100644 --- a/polaris-react/src/components/Tile/Tile.scss +++ b/polaris-react/src/components/Tiles/Tiles.scss @@ -1,6 +1,6 @@ @import '../../styles/common'; -.Tile { +.Tiles { --pc-tile-xs: 6; --pc-tile-sm: var(--pc-tile-xs); --pc-tile-md: var(--pc-tile-sm); diff --git a/polaris-react/src/components/Tile/Tile.stories.tsx b/polaris-react/src/components/Tiles/Tiles.stories.tsx similarity index 78% rename from polaris-react/src/components/Tile/Tile.stories.tsx rename to polaris-react/src/components/Tiles/Tiles.stories.tsx index e15b7e8cacc..8a0d20596e4 100644 --- a/polaris-react/src/components/Tile/Tile.stories.tsx +++ b/polaris-react/src/components/Tiles/Tiles.stories.tsx @@ -1,10 +1,10 @@ import React from 'react'; import type {ComponentMeta} from '@storybook/react'; -import {Box, Tile, Text} from '@shopify/polaris'; +import {Tiles, Text} from '@shopify/polaris'; export default { - component: Tile, -} as ComponentMeta; + component: Tiles, +} as ComponentMeta; const styles = { background: 'var(--p-surface)', @@ -26,17 +26,17 @@ const children = Array.from(Array(4)).map((ele, index) => ( export function Default() { return ( - + {children} - + ); } export function LargeSpacing() { return ( - + {children} - + ); } @@ -53,8 +53,8 @@ export function ManyColumns() { )); return ( - + {children} - + ); } diff --git a/polaris-react/src/components/Tile/Tile.tsx b/polaris-react/src/components/Tiles/Tiles.tsx similarity index 88% rename from polaris-react/src/components/Tile/Tile.tsx rename to polaris-react/src/components/Tiles/Tiles.tsx index f89fda93ba0..a8e9deb56ba 100644 --- a/polaris-react/src/components/Tile/Tile.tsx +++ b/polaris-react/src/components/Tiles/Tiles.tsx @@ -4,7 +4,7 @@ import type { SpacingSpaceScale, } from '@shopify/polaris-tokens'; -import styles from './Tile.scss'; +import styles from './Tiles.scss'; type Columns = { [Breakpoint in BreakpointsAlias]?: number | string; @@ -14,7 +14,7 @@ type Gap = { [Breakpoint in BreakpointsAlias]?: SpacingSpaceScale; }; -export interface TileProps { +export interface TilesProps { /** Elements to display inside tile */ children: React.ReactNode; /** Adjust spacing between elements */ @@ -23,7 +23,7 @@ export interface TileProps { columns?: Columns; } -export const Tile = ({children, gap, columns}: TileProps) => { +export const Tiles = ({children, gap, columns}: TilesProps) => { const style = { '--pc-tile-gap-xs': gap?.xs ? `var(--p-space-${gap?.xs})` : undefined, '--pc-tile-gap-sm': gap?.sm ? `var(--p-space-${gap?.sm})` : undefined, @@ -38,7 +38,7 @@ export const Tile = ({children, gap, columns}: TileProps) => { } as React.CSSProperties; return ( -
+
{children}
); diff --git a/polaris-react/src/components/Tiles/index.ts b/polaris-react/src/components/Tiles/index.ts new file mode 100644 index 00000000000..48fc86b6443 --- /dev/null +++ b/polaris-react/src/components/Tiles/index.ts @@ -0,0 +1 @@ +export * from './Tiles'; diff --git a/polaris-react/src/components/Tile/tests/Tile.test.tsx b/polaris-react/src/components/Tiles/tests/Tiles.test.tsx similarity index 73% rename from polaris-react/src/components/Tile/tests/Tile.test.tsx rename to polaris-react/src/components/Tiles/tests/Tiles.test.tsx index 354bf060309..c6298e40c3a 100644 --- a/polaris-react/src/components/Tile/tests/Tile.test.tsx +++ b/polaris-react/src/components/Tiles/tests/Tiles.test.tsx @@ -1,16 +1,16 @@ import React from 'react'; import {mountWithApp} from 'tests/utilities'; -import {Tile} from '../Tile'; +import {Tiles} from '../Tiles'; const Children = () =>

This is a tile

; -describe('', () => { +describe('', () => { it('renders children', () => { const tile = mountWithApp( - + - , + , ); expect(tile).toContainReactComponent(Children); @@ -18,9 +18,9 @@ describe('', () => { it('uses custom properties when passed in', () => { const tile = mountWithApp( - + - , + , ); expect(tile).toContainReactComponent('div', { diff --git a/polaris-react/src/index.ts b/polaris-react/src/index.ts index b03e33759c2..72be6034339 100644 --- a/polaris-react/src/index.ts +++ b/polaris-react/src/index.ts @@ -375,8 +375,8 @@ export type {TextStyleProps} from './components/TextStyle'; export {Thumbnail} from './components/Thumbnail'; export type {ThumbnailProps} from './components/Thumbnail'; -export {Tile} from './components/Tile'; -export type {TileProps} from './components/Tile'; +export {Tiles} from './components/Tiles'; +export type {TilesProps} from './components/Tiles'; export {Toast} from './components/Toast'; export type {ToastProps} from './components/Toast'; diff --git a/polaris.shopify.com/content/components/tile/index.md b/polaris.shopify.com/content/components/tile/index.md index 4b085db097d..4e2fd61dfa4 100644 --- a/polaris.shopify.com/content/components/tile/index.md +++ b/polaris.shopify.com/content/components/tile/index.md @@ -1,5 +1,5 @@ --- -title: Tile +title: Tiles description: Create complex layouts based on [CSS Grid](https://developer.mozilla.org/en-US/docs/Web/CSS/grid). category: Structure keywords: @@ -8,8 +8,8 @@ status: value: Alpha message: This component is in development. There could be breaking changes made to it in a non-major release of Polaris. Please use with caution. examples: - - fileName: tile-with-spacing.tsx + - fileName: tiles-with-spacing.tsx title: With spacing - - fileName: tile-with-columns.tsx + - fileName: tiles-with-columns.tsx title: With columns --- diff --git a/polaris.shopify.com/pages/examples/tile-with-columns.tsx b/polaris.shopify.com/pages/examples/tiles-with-columns.tsx similarity index 75% rename from polaris.shopify.com/pages/examples/tile-with-columns.tsx rename to polaris.shopify.com/pages/examples/tiles-with-columns.tsx index d9f9c0cf33d..006e5c67527 100644 --- a/polaris.shopify.com/pages/examples/tile-with-columns.tsx +++ b/polaris.shopify.com/pages/examples/tiles-with-columns.tsx @@ -1,5 +1,5 @@ import React from 'react'; -import {Tile, Text} from '@shopify/polaris'; +import {Tiles, Text} from '@shopify/polaris'; import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; @@ -21,14 +21,14 @@ const children = Array.from(Array(8)).map((ele, index) => (
)); -function TileWithColumnsExample() { +function TilesWithColumnsExample() { return (
- + {children} - +
); } -export default withPolarisExample(TileWithColumnsExample); +export default withPolarisExample(TilesWithColumnsExample); diff --git a/polaris.shopify.com/pages/examples/tile-with-spacing.tsx b/polaris.shopify.com/pages/examples/tiles-with-spacing.tsx similarity index 75% rename from polaris.shopify.com/pages/examples/tile-with-spacing.tsx rename to polaris.shopify.com/pages/examples/tiles-with-spacing.tsx index 7e07142eee3..07bd4d4ed28 100644 --- a/polaris.shopify.com/pages/examples/tile-with-spacing.tsx +++ b/polaris.shopify.com/pages/examples/tiles-with-spacing.tsx @@ -1,5 +1,5 @@ import React from 'react'; -import {Tile, Text} from '@shopify/polaris'; +import {Tiles, Text} from '@shopify/polaris'; import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; @@ -21,14 +21,14 @@ const children = Array.from(Array(2)).map((ele, index) => (
)); -function TileWithSpacingExample() { +function TilesWithSpacingExample() { return (
- + {children} - +
); } -export default withPolarisExample(TileWithSpacingExample); +export default withPolarisExample(TilesWithSpacingExample); diff --git a/polaris.shopify.com/src/data/props.json b/polaris.shopify.com/src/data/props.json index 756e4dd503b..7d6a6845f8d 100644 --- a/polaris.shopify.com/src/data/props.json +++ b/polaris.shopify.com/src/data/props.json @@ -3782,6 +3782,30 @@ "value": "interface MappedActionContextType {\n role?: string;\n url?: string;\n external?: boolean;\n onAction?(): void;\n destructive?: boolean;\n}" } }, + "FeaturesConfig": { + "polaris-react/src/utilities/features/types.ts": { + "filePath": "polaris-react/src/utilities/features/types.ts", + "name": "FeaturesConfig", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/utilities/features/types.ts", + "name": "[key: string]", + "value": "boolean" + } + ], + "value": "export interface FeaturesConfig {\n [key: string]: boolean;\n}" + } + }, + "Features": { + "polaris-react/src/utilities/features/types.ts": { + "filePath": "polaris-react/src/utilities/features/types.ts", + "name": "Features", + "description": "", + "members": [], + "value": "export interface Features {}" + } + }, "IdGenerator": { "polaris-react/src/utilities/unique-id/unique-id-factory.ts": { "filePath": "polaris-react/src/utilities/unique-id/unique-id-factory.ts", @@ -3817,30 +3841,6 @@ "value": "interface Options {\n trapping: boolean;\n}" } }, - "FeaturesConfig": { - "polaris-react/src/utilities/features/types.ts": { - "filePath": "polaris-react/src/utilities/features/types.ts", - "name": "FeaturesConfig", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/utilities/features/types.ts", - "name": "[key: string]", - "value": "boolean" - } - ], - "value": "export interface FeaturesConfig {\n [key: string]: boolean;\n}" - } - }, - "Features": { - "polaris-react/src/utilities/features/types.ts": { - "filePath": "polaris-react/src/utilities/features/types.ts", - "name": "Features", - "description": "", - "members": [], - "value": "export interface Features {}" - } - }, "Logo": { "polaris-react/src/utilities/frame/types.ts": { "filePath": "polaris-react/src/utilities/frame/types.ts", @@ -7218,15 +7218,6 @@ "description": "" } }, - "PortalsContainerElement": { - "polaris-react/src/utilities/portals/types.ts": { - "filePath": "polaris-react/src/utilities/portals/types.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "PortalsContainerElement", - "value": "HTMLDivElement | null", - "description": "" - } - }, "NavigableOption": { "polaris-react/src/utilities/listbox/types.ts": { "filePath": "polaris-react/src/utilities/listbox/types.ts", @@ -7305,6 +7296,15 @@ "value": "export interface ListboxContextType {\n onOptionSelect(option: NavigableOption): void;\n setLoading(label?: string): void;\n}" } }, + "PortalsContainerElement": { + "polaris-react/src/utilities/portals/types.ts": { + "filePath": "polaris-react/src/utilities/portals/types.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PortalsContainerElement", + "value": "HTMLDivElement | null", + "description": "" + } + }, "ResourceListSelectedItems": { "polaris-react/src/utilities/resource-list/types.ts": { "filePath": "polaris-react/src/utilities/resource-list/types.ts", @@ -7662,6 +7662,107 @@ "value": "export interface AccountConnectionProps {\n /** Content to display as title */\n title?: React.ReactNode;\n /** Content to display as additional details */\n details?: React.ReactNode;\n /** Content to display as terms of service */\n termsOfService?: React.ReactNode;\n /** The name of the service */\n accountName?: string;\n /** URL for the user’s avatar image */\n avatarUrl?: string;\n /** Set if the account is connected */\n connected?: boolean;\n /** Action for account connection */\n action?: Action;\n}" } }, + "ActionListProps": { + "polaris-react/src/components/ActionList/ActionList.tsx": { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "name": "ActionListProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "items", + "value": "readonly ActionListItemDescriptor[]", + "description": "Collection of actions for list", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "sections", + "value": "readonly ActionListSection[]", + "description": "Collection of sectioned action items", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "actionRole", + "value": "string", + "description": "Defines a specific role attribute for each action in the list", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "PropertySignature", + "name": "onActionAnyItem", + "value": "() => void", + "description": "Callback when any item is clicked or keypressed", + "isOptional": true + } + ], + "value": "export interface ActionListProps {\n /** Collection of actions for list */\n items?: readonly ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" + } + }, + "ActionListItemProps": { + "polaris-react/src/components/ActionList/ActionList.tsx": { + "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "ActionListItemProps", + "value": "ItemProps", + "description": "" + } + }, + "ActionMenuProps": { + "polaris-react/src/components/ActionMenu/ActionMenu.tsx": { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "name": "ActionMenuProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "actions", + "value": "MenuActionDescriptor[]", + "description": "Collection of page-level secondary actions", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "groups", + "value": "MenuGroupDescriptor[]", + "description": "Collection of page-level action groups", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "rollup", + "value": "boolean", + "description": "Roll up all actions into a Popover > ActionList", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "PropertySignature", + "name": "rollupActionsLabel", + "value": "string", + "description": "Label for rolled up actions activator", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", + "syntaxKind": "MethodSignature", + "name": "onActionRollup", + "value": "(hasRolledUp: boolean) => void", + "description": "Callback that returns true when secondary actions are rolled up into action groups, and false when not", + "isOptional": true + } + ], + "value": "export interface ActionMenuProps {\n /** Collection of page-level secondary actions */\n actions?: MenuActionDescriptor[];\n /** Collection of page-level action groups */\n groups?: MenuGroupDescriptor[];\n /** Roll up all actions into a Popover > ActionList */\n rollup?: boolean;\n /** Label for rolled up actions activator */\n rollupActionsLabel?: string;\n /** Callback that returns true when secondary actions are rolled up into action groups, and false when not */\n onActionRollup?(hasRolledUp: boolean): void;\n}" + } + }, "Props": { "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx": { "filePath": "polaris-react/src/components/AfterInitialMount/AfterInitialMount.tsx", @@ -7938,56 +8039,6 @@ "value": "interface Props {\n /** Callback when the search is dismissed */\n onDismiss?(): void;\n /** Determines whether the overlay should be visible */\n visible: boolean;\n}" } }, - "ActionMenuProps": { - "polaris-react/src/components/ActionMenu/ActionMenu.tsx": { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "name": "ActionMenuProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "actions", - "value": "MenuActionDescriptor[]", - "description": "Collection of page-level secondary actions", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "groups", - "value": "MenuGroupDescriptor[]", - "description": "Collection of page-level action groups", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "rollup", - "value": "boolean", - "description": "Roll up all actions into a Popover > ActionList", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "PropertySignature", - "name": "rollupActionsLabel", - "value": "string", - "description": "Label for rolled up actions activator", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionMenu/ActionMenu.tsx", - "syntaxKind": "MethodSignature", - "name": "onActionRollup", - "value": "(hasRolledUp: boolean) => void", - "description": "Callback that returns true when secondary actions are rolled up into action groups, and false when not", - "isOptional": true - } - ], - "value": "export interface ActionMenuProps {\n /** Collection of page-level secondary actions */\n actions?: MenuActionDescriptor[];\n /** Collection of page-level action groups */\n groups?: MenuGroupDescriptor[];\n /** Roll up all actions into a Popover > ActionList */\n rollup?: boolean;\n /** Label for rolled up actions activator */\n rollupActionsLabel?: string;\n /** Callback that returns true when secondary actions are rolled up into action groups, and false when not */\n onActionRollup?(hasRolledUp: boolean): void;\n}" - } - }, "CardElevationTokensScale": { "polaris-react/src/components/AlphaCard/AlphaCard.tsx": { "filePath": "polaris-react/src/components/AlphaCard/AlphaCard.tsx", @@ -8064,89 +8115,38 @@ "value": "export interface AlphaCardProps {\n /** Elements to display inside card */\n children?: React.ReactNode;\n background?: CardBackgroundColorTokenScale;\n hasBorderRadius?: boolean;\n elevation?: CardElevationTokensScale;\n padding?: SpacingSpaceScale;\n roundedAbove?: BreakpointsAlias;\n}" } }, - "ActionListProps": { - "polaris-react/src/components/ActionList/ActionList.tsx": { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "name": "ActionListProps", + "Align": { + "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { + "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Align", + "value": "'start' | 'end' | 'center'", + "description": "" + }, + "polaris-react/src/components/Inline/Inline.tsx": { + "filePath": "polaris-react/src/components/Inline/Inline.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Align", + "value": "'start' | 'center' | 'end'", + "description": "" + } + }, + "AlphaStackProps": { + "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { + "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", + "name": "AlphaStackProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", + "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", "syntaxKind": "PropertySignature", - "name": "items", - "value": "readonly ActionListItemDescriptor[]", - "description": "Collection of actions for list", + "name": "children", + "value": "React.ReactNode", + "description": "Elements to display inside stack", "isOptional": true }, { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "sections", - "value": "readonly ActionListSection[]", - "description": "Collection of sectioned action items", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "actionRole", - "value": "string", - "description": "Defines a specific role attribute for each action in the list", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "PropertySignature", - "name": "onActionAnyItem", - "value": "() => void", - "description": "Callback when any item is clicked or keypressed", - "isOptional": true - } - ], - "value": "export interface ActionListProps {\n /** Collection of actions for list */\n items?: readonly ActionListItemDescriptor[];\n /** Collection of sectioned action items */\n sections?: readonly ActionListSection[];\n /** Defines a specific role attribute for each action in the list */\n actionRole?: 'menuitem' | string;\n /** Callback when any item is clicked or keypressed */\n onActionAnyItem?: ActionListItemDescriptor['onAction'];\n}" - } - }, - "ActionListItemProps": { - "polaris-react/src/components/ActionList/ActionList.tsx": { - "filePath": "polaris-react/src/components/ActionList/ActionList.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "ActionListItemProps", - "value": "ItemProps", - "description": "" - } - }, - "Align": { - "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { - "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Align", - "value": "'start' | 'end' | 'center'", - "description": "" - }, - "polaris-react/src/components/Inline/Inline.tsx": { - "filePath": "polaris-react/src/components/Inline/Inline.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Align", - "value": "'start' | 'center' | 'end'", - "description": "" - } - }, - "AlphaStackProps": { - "polaris-react/src/components/AlphaStack/AlphaStack.tsx": { - "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", - "name": "AlphaStackProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Elements to display inside stack", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", + "filePath": "polaris-react/src/components/AlphaStack/AlphaStack.tsx", "syntaxKind": "PropertySignature", "name": "align", "value": "Align", @@ -8556,20 +8556,20 @@ ], "value": "interface State {\n disclosureWidth: number;\n tabWidths: number[];\n visibleTabs: number[];\n hiddenTabs: number[];\n containerWidth: number;\n showDisclosure: boolean;\n tabToFocus: number;\n}" }, - "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx": { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", + "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx": { + "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", "name": "State", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", "syntaxKind": "PropertySignature", "name": "sliderHeight", "value": "number", "description": "" }, { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", "syntaxKind": "PropertySignature", "name": "draggerHeight", "value": "number", @@ -8578,20 +8578,20 @@ ], "value": "interface State {\n sliderHeight: number;\n draggerHeight: number;\n}" }, - "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx": { - "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", + "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx": { + "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", "name": "State", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", "syntaxKind": "PropertySignature", "name": "sliderHeight", "value": "number", "description": "" }, { - "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", "syntaxKind": "PropertySignature", "name": "draggerHeight", "value": "number", @@ -10779,6 +10779,56 @@ "description": "" } }, + "ButtonGroupProps": { + "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "name": "ButtonGroupProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "spacing", + "value": "Spacing", + "description": "Determines the space between button group items", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "segmented", + "value": "boolean", + "description": "Join buttons as segmented group", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "fullWidth", + "value": "boolean", + "description": "Buttons will stretch/shrink to occupy the full width", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "connectedTop", + "value": "boolean", + "description": "Remove top left and right border radius", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Button components", + "isOptional": true + } + ], + "value": "export interface ButtonGroupProps {\n /** Determines the space between button group items */\n spacing?: Spacing;\n /** Join buttons as segmented group */\n segmented?: boolean;\n /** Buttons will stretch/shrink to occupy the full width */\n fullWidth?: boolean;\n /** Remove top left and right border radius */\n connectedTop?: boolean;\n /** Button components */\n children?: React.ReactNode;\n}" + } + }, "CalloutCardProps": { "polaris-react/src/components/CalloutCard/CalloutCard.tsx": { "filePath": "polaris-react/src/components/CalloutCard/CalloutCard.tsx", @@ -10834,56 +10884,6 @@ "value": "export interface CalloutCardProps {\n /** The content to display inside the callout card. */\n children?: React.ReactNode;\n /** The title of the card */\n title: string;\n /** URL to the card illustration */\n illustration: string;\n /** Primary action for the card */\n primaryAction: Action;\n /** Secondary action for the card */\n secondaryAction?: Action;\n /** Callback when banner is dismissed */\n onDismiss?(): void;\n}" } }, - "ButtonGroupProps": { - "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx": { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "name": "ButtonGroupProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "spacing", - "value": "Spacing", - "description": "Determines the space between button group items", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "segmented", - "value": "boolean", - "description": "Join buttons as segmented group", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "fullWidth", - "value": "boolean", - "description": "Buttons will stretch/shrink to occupy the full width", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "connectedTop", - "value": "boolean", - "description": "Remove top left and right border radius", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ButtonGroup/ButtonGroup.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Button components", - "isOptional": true - } - ], - "value": "export interface ButtonGroupProps {\n /** Determines the space between button group items */\n spacing?: Spacing;\n /** Join buttons as segmented group */\n segmented?: boolean;\n /** Buttons will stretch/shrink to occupy the full width */\n fullWidth?: boolean;\n /** Remove top left and right border radius */\n connectedTop?: boolean;\n /** Button components */\n children?: React.ReactNode;\n}" - } - }, "CaptionProps": { "polaris-react/src/components/Caption/Caption.tsx": { "filePath": "polaris-react/src/components/Caption/Caption.tsx", @@ -11074,44 +11074,37 @@ "value": "export interface CheckableButtonProps {\n accessibilityLabel?: string;\n label?: string;\n selected?: boolean | 'indeterminate';\n selectMode?: boolean;\n smallScreen?: boolean;\n plain?: boolean;\n measuring?: boolean;\n disabled?: boolean;\n onToggleAll?(): void;\n}" } }, - "ChoiceProps": { - "polaris-react/src/components/Choice/Choice.tsx": { - "filePath": "polaris-react/src/components/Choice/Choice.tsx", - "name": "ChoiceProps", + "CheckboxProps": { + "polaris-react/src/components/Checkbox/Checkbox.tsx": { + "filePath": "polaris-react/src/components/Checkbox/Checkbox.tsx", + "name": "CheckboxProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "filePath": "polaris-react/src/components/Checkbox/Checkbox.tsx", "syntaxKind": "PropertySignature", - "name": "id", + "name": "ariaControls", "value": "string", - "description": "A unique identifier for the choice" - }, - { - "filePath": "polaris-react/src/components/Choice/Choice.tsx", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "React.ReactNode", - "description": "Label for the choice" + "description": "Indicates the ID of the element that is controlled by the checkbox", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "filePath": "polaris-react/src/components/Checkbox/Checkbox.tsx", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Whether the associated form control is disabled", + "name": "ariaDescribedBy", + "value": "string", + "description": "Indicates the ID of the element that describes the checkbox", "isOptional": true }, { - "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "filePath": "polaris-react/src/components/Checkbox/Checkbox.tsx", "syntaxKind": "PropertySignature", - "name": "error", - "value": "any", - "description": "Display an error message", - "isOptional": true + "name": "label", + "value": "React.ReactNode", + "description": "Label for the checkbox" }, { - "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "filePath": "polaris-react/src/components/Checkbox/Checkbox.tsx", "syntaxKind": "PropertySignature", "name": "labelHidden", "value": "boolean", @@ -11119,15 +11112,15 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "filePath": "polaris-react/src/components/Checkbox/Checkbox.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Content to display inside the choice", + "name": "checked", + "value": "boolean | \"indeterminate\"", + "description": "Checkbox is selected. `indeterminate` shows a horizontal line in the checkbox", "isOptional": true }, { - "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "filePath": "polaris-react/src/components/Checkbox/Checkbox.tsx", "syntaxKind": "PropertySignature", "name": "helpText", "value": "React.ReactNode", @@ -11135,100 +11128,19 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/Choice/Choice.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "Callback when clicked", + "filePath": "polaris-react/src/components/Checkbox/Checkbox.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Disable input", "isOptional": true }, { - "filePath": "polaris-react/src/components/Choice/Choice.tsx", - "syntaxKind": "MethodSignature", - "name": "onMouseOver", - "value": "() => void", - "description": "Callback when mouse over", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Choice/Choice.tsx", - "syntaxKind": "MethodSignature", - "name": "onMouseOut", - "value": "() => void", - "description": "Callback when mouse out", - "isOptional": true - } - ], - "value": "export interface ChoiceProps {\n /** A unique identifier for the choice */\n id: string;\n /**\tLabel for the choice */\n label: React.ReactNode;\n /** Whether the associated form control is disabled */\n disabled?: boolean;\n /** Display an error message */\n error?: Error | boolean;\n /** Visually hide the label */\n labelHidden?: boolean;\n /** Content to display inside the choice */\n children?: React.ReactNode;\n /** Additional text to aide in use */\n helpText?: React.ReactNode;\n /** Callback when clicked */\n onClick?(): void;\n /** Callback when mouse over */\n onMouseOver?(): void;\n /** Callback when mouse out */\n onMouseOut?(): void;\n}" - } - }, - "CheckboxProps": { - "polaris-react/src/components/Checkbox/Checkbox.tsx": { - "filePath": "polaris-react/src/components/Checkbox/Checkbox.tsx", - "name": "CheckboxProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Checkbox/Checkbox.tsx", - "syntaxKind": "PropertySignature", - "name": "ariaControls", - "value": "string", - "description": "Indicates the ID of the element that is controlled by the checkbox", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Checkbox/Checkbox.tsx", - "syntaxKind": "PropertySignature", - "name": "ariaDescribedBy", - "value": "string", - "description": "Indicates the ID of the element that describes the checkbox", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Checkbox/Checkbox.tsx", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "React.ReactNode", - "description": "Label for the checkbox" - }, - { - "filePath": "polaris-react/src/components/Checkbox/Checkbox.tsx", - "syntaxKind": "PropertySignature", - "name": "labelHidden", - "value": "boolean", - "description": "Visually hide the label", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Checkbox/Checkbox.tsx", - "syntaxKind": "PropertySignature", - "name": "checked", - "value": "boolean | \"indeterminate\"", - "description": "Checkbox is selected. `indeterminate` shows a horizontal line in the checkbox", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Checkbox/Checkbox.tsx", - "syntaxKind": "PropertySignature", - "name": "helpText", - "value": "React.ReactNode", - "description": "Additional text to aide in use", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Checkbox/Checkbox.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disable input", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Checkbox/Checkbox.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "ID for form input", + "filePath": "polaris-react/src/components/Checkbox/Checkbox.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "ID for form input", "isOptional": true }, { @@ -11354,6 +11266,94 @@ "value": "export interface CheckboxProps {\n checked?: boolean;\n disabled?: boolean;\n active?: boolean;\n id?: string;\n name?: string;\n value?: string;\n role?: string;\n onChange(): void;\n}" } }, + "ChoiceProps": { + "polaris-react/src/components/Choice/Choice.tsx": { + "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "name": "ChoiceProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the choice" + }, + { + "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "React.ReactNode", + "description": "Label for the choice" + }, + { + "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the associated form control is disabled", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "any", + "description": "Display an error message", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "syntaxKind": "PropertySignature", + "name": "labelHidden", + "value": "boolean", + "description": "Visually hide the label", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Content to display inside the choice", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "syntaxKind": "PropertySignature", + "name": "helpText", + "value": "React.ReactNode", + "description": "Additional text to aide in use", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "Callback when clicked", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "syntaxKind": "MethodSignature", + "name": "onMouseOver", + "value": "() => void", + "description": "Callback when mouse over", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Choice/Choice.tsx", + "syntaxKind": "MethodSignature", + "name": "onMouseOut", + "value": "() => void", + "description": "Callback when mouse out", + "isOptional": true + } + ], + "value": "export interface ChoiceProps {\n /** A unique identifier for the choice */\n id: string;\n /**\tLabel for the choice */\n label: React.ReactNode;\n /** Whether the associated form control is disabled */\n disabled?: boolean;\n /** Display an error message */\n error?: Error | boolean;\n /** Visually hide the label */\n labelHidden?: boolean;\n /** Content to display inside the choice */\n children?: React.ReactNode;\n /** Additional text to aide in use */\n helpText?: React.ReactNode;\n /** Callback when clicked */\n onClick?(): void;\n /** Callback when mouse over */\n onMouseOver?(): void;\n /** Callback when mouse out */\n onMouseOut?(): void;\n}" + } + }, "Choice": { "polaris-react/src/components/ChoiceList/ChoiceList.tsx": { "filePath": "polaris-react/src/components/ChoiceList/ChoiceList.tsx", @@ -11588,202 +11588,94 @@ "description": "" } }, - "Color": { - "polaris-react/src/components/ColorPicker/ColorPicker.tsx": { - "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", - "name": "Color", + "Columns": { + "polaris-react/src/components/Columns/Columns.tsx": { + "filePath": "polaris-react/src/components/Columns/Columns.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Columns", + "value": "{\n [Breakpoint in BreakpointsAlias]?: number | string;\n}", + "description": "" + }, + "polaris-react/src/components/Grid/Grid.tsx": { + "filePath": "polaris-react/src/components/Grid/Grid.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Columns", + "value": "{\n [Breakpoint in Breakpoints]?: number;\n}", + "description": "" + }, + "polaris-react/src/components/Tiles/Tiles.tsx": { + "filePath": "polaris-react/src/components/Tiles/Tiles.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Columns", + "value": "{\n [Breakpoint in BreakpointsAlias]?: number | string;\n}", + "description": "" + }, + "polaris-react/src/components/Grid/components/Cell/Cell.tsx": { + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "name": "Columns", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", - "name": "alpha", - "value": "number", - "description": "Level of transparency", + "name": "xs", + "value": "2 | 1 | 3 | 4 | 5 | 6", + "description": "Number of columns the section should span on extra small screens", "isOptional": true }, { - "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", - "name": "brightness", - "value": "number", - "description": "Brightness of the color" + "name": "sm", + "value": "2 | 1 | 3 | 4 | 5 | 6", + "description": "Number of columns the section should span on small screens", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", - "name": "hue", - "value": "number", - "description": "The color" + "name": "md", + "value": "2 | 1 | 3 | 4 | 5 | 6", + "description": "Number of columns the section should span on medium screens", + "isOptional": true }, { - "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", "syntaxKind": "PropertySignature", - "name": "saturation", - "value": "number", - "description": "Saturation of the color" + "name": "lg", + "value": "2 | 1 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12", + "description": "Number of columns the section should span on large screens", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "xl", + "value": "2 | 1 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12", + "description": "Number of columns the section should span on extra large screens", + "isOptional": true } ], - "value": "interface Color extends HSBColor {\n /** Level of transparency */\n alpha?: HSBAColor['alpha'];\n}" - }, - "polaris-react/src/components/Icon/Icon.tsx": { - "filePath": "polaris-react/src/components/Icon/Icon.tsx", + "value": "interface Columns {\n /** Number of columns the section should span on extra small screens */\n xs?: 1 | 2 | 3 | 4 | 5 | 6;\n /** Number of columns the section should span on small screens */\n sm?: 1 | 2 | 3 | 4 | 5 | 6;\n /** Number of columns the section should span on medium screens */\n md?: 1 | 2 | 3 | 4 | 5 | 6;\n /** Number of columns the section should span on large screens */\n lg?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;\n /** Number of columns the section should span on extra large screens */\n xl?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;\n}" + } + }, + "Gap": { + "polaris-react/src/components/Columns/Columns.tsx": { + "filePath": "polaris-react/src/components/Columns/Columns.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "Color", - "value": "'base' | 'subdued' | 'critical' | 'interactive' | 'warning' | 'highlight' | 'success' | 'primary'", + "name": "Gap", + "value": "{\n [Breakpoint in BreakpointsAlias]?: SpacingSpaceScale;\n}", "description": "" }, - "polaris-react/src/components/ProgressBar/ProgressBar.tsx": { - "filePath": "polaris-react/src/components/ProgressBar/ProgressBar.tsx", + "polaris-react/src/components/Grid/Grid.tsx": { + "filePath": "polaris-react/src/components/Grid/Grid.tsx", "syntaxKind": "TypeAliasDeclaration", - "name": "Color", - "value": "'highlight' | 'primary' | 'success' | 'critical'", + "name": "Gap", + "value": "{\n [Breakpoint in Breakpoints]?: string;\n}", "description": "" }, - "polaris-react/src/components/Text/Text.tsx": { - "filePath": "polaris-react/src/components/Text/Text.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Color", - "value": "'success' | 'critical' | 'warning' | 'subdued'", - "description": "" - } - }, - "ColorPickerProps": { - "polaris-react/src/components/ColorPicker/ColorPicker.tsx": { - "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", - "name": "ColorPickerProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "ID for the element", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", - "syntaxKind": "PropertySignature", - "name": "color", - "value": "Color", - "description": "The currently selected color" - }, - { - "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", - "syntaxKind": "PropertySignature", - "name": "allowAlpha", - "value": "boolean", - "description": "Allow user to select an alpha value", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", - "syntaxKind": "PropertySignature", - "name": "fullWidth", - "value": "boolean", - "description": "Allow HuePicker to take the full width", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", - "syntaxKind": "MethodSignature", - "name": "onChange", - "value": "(color: HSBAColor) => void", - "description": "Callback when color is selected" - } - ], - "value": "export interface ColorPickerProps {\n /** ID for the element */\n id?: string;\n /** The currently selected color */\n color: Color;\n /** Allow user to select an alpha value */\n allowAlpha?: boolean;\n /** Allow HuePicker to take the full width */\n fullWidth?: boolean;\n /** Callback when color is selected */\n onChange(color: HSBAColor): void;\n}" - } - }, - "Columns": { - "polaris-react/src/components/Columns/Columns.tsx": { - "filePath": "polaris-react/src/components/Columns/Columns.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Columns", - "value": "{\n [Breakpoint in BreakpointsAlias]?: number | string;\n}", - "description": "" - }, - "polaris-react/src/components/Grid/Grid.tsx": { - "filePath": "polaris-react/src/components/Grid/Grid.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Columns", - "value": "{\n [Breakpoint in Breakpoints]?: number;\n}", - "description": "" - }, - "polaris-react/src/components/Tile/Tile.tsx": { - "filePath": "polaris-react/src/components/Tile/Tile.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Columns", - "value": "{\n [Breakpoint in BreakpointsAlias]?: number | string;\n}", - "description": "" - }, - "polaris-react/src/components/Grid/components/Cell/Cell.tsx": { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", - "name": "Columns", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "xs", - "value": "2 | 1 | 3 | 4 | 5 | 6", - "description": "Number of columns the section should span on extra small screens", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "sm", - "value": "2 | 1 | 3 | 4 | 5 | 6", - "description": "Number of columns the section should span on small screens", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "md", - "value": "2 | 1 | 3 | 4 | 5 | 6", - "description": "Number of columns the section should span on medium screens", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "lg", - "value": "2 | 1 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12", - "description": "Number of columns the section should span on large screens", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "xl", - "value": "2 | 1 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12", - "description": "Number of columns the section should span on extra large screens", - "isOptional": true - } - ], - "value": "interface Columns {\n /** Number of columns the section should span on extra small screens */\n xs?: 1 | 2 | 3 | 4 | 5 | 6;\n /** Number of columns the section should span on small screens */\n sm?: 1 | 2 | 3 | 4 | 5 | 6;\n /** Number of columns the section should span on medium screens */\n md?: 1 | 2 | 3 | 4 | 5 | 6;\n /** Number of columns the section should span on large screens */\n lg?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;\n /** Number of columns the section should span on extra large screens */\n xl?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;\n}" - } - }, - "Gap": { - "polaris-react/src/components/Columns/Columns.tsx": { - "filePath": "polaris-react/src/components/Columns/Columns.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Gap", - "value": "{\n [Breakpoint in BreakpointsAlias]?: SpacingSpaceScale;\n}", - "description": "" - }, - "polaris-react/src/components/Grid/Grid.tsx": { - "filePath": "polaris-react/src/components/Grid/Grid.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Gap", - "value": "{\n [Breakpoint in Breakpoints]?: string;\n}", - "description": "" - }, - "polaris-react/src/components/Tile/Tile.tsx": { - "filePath": "polaris-react/src/components/Tile/Tile.tsx", + "polaris-react/src/components/Tiles/Tiles.tsx": { + "filePath": "polaris-react/src/components/Tiles/Tiles.tsx", "syntaxKind": "TypeAliasDeclaration", "name": "Gap", "value": "{\n [Breakpoint in BreakpointsAlias]?: SpacingSpaceScale;\n}", @@ -11824,40 +11716,6 @@ "value": "export interface ColumnsProps {\n gap?: Gap;\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", @@ -11931,6 +11789,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", @@ -11965,6 +11857,114 @@ "value": "export interface ContentBlockProps {\n /** Elements to display inside container */\n children?: React.ReactNode;\n /** Adjust maximum width of container */\n width: Width;\n}" } }, + "Color": { + "polaris-react/src/components/ColorPicker/ColorPicker.tsx": { + "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", + "name": "Color", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", + "syntaxKind": "PropertySignature", + "name": "alpha", + "value": "number", + "description": "Level of transparency", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", + "syntaxKind": "PropertySignature", + "name": "brightness", + "value": "number", + "description": "Brightness of the color" + }, + { + "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", + "syntaxKind": "PropertySignature", + "name": "hue", + "value": "number", + "description": "The color" + }, + { + "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", + "syntaxKind": "PropertySignature", + "name": "saturation", + "value": "number", + "description": "Saturation of the color" + } + ], + "value": "interface Color extends HSBColor {\n /** Level of transparency */\n alpha?: HSBAColor['alpha'];\n}" + }, + "polaris-react/src/components/Icon/Icon.tsx": { + "filePath": "polaris-react/src/components/Icon/Icon.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Color", + "value": "'base' | 'subdued' | 'critical' | 'interactive' | 'warning' | 'highlight' | 'success' | 'primary'", + "description": "" + }, + "polaris-react/src/components/ProgressBar/ProgressBar.tsx": { + "filePath": "polaris-react/src/components/ProgressBar/ProgressBar.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Color", + "value": "'highlight' | 'primary' | 'success' | 'critical'", + "description": "" + }, + "polaris-react/src/components/Text/Text.tsx": { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Color", + "value": "'success' | 'critical' | 'warning' | 'subdued'", + "description": "" + } + }, + "ColorPickerProps": { + "polaris-react/src/components/ColorPicker/ColorPicker.tsx": { + "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", + "name": "ColorPickerProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "ID for the element", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", + "syntaxKind": "PropertySignature", + "name": "color", + "value": "Color", + "description": "The currently selected color" + }, + { + "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", + "syntaxKind": "PropertySignature", + "name": "allowAlpha", + "value": "boolean", + "description": "Allow user to select an alpha value", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", + "syntaxKind": "PropertySignature", + "name": "fullWidth", + "value": "boolean", + "description": "Allow HuePicker to take the full width", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ColorPicker/ColorPicker.tsx", + "syntaxKind": "MethodSignature", + "name": "onChange", + "value": "(color: HSBAColor) => void", + "description": "Callback when color is selected" + } + ], + "value": "export interface ColorPickerProps {\n /** ID for the element */\n id?: string;\n /** The currently selected color */\n color: Color;\n /** Allow user to select an alpha value */\n allowAlpha?: boolean;\n /** Allow HuePicker to take the full width */\n fullWidth?: boolean;\n /** Callback when color is selected */\n onChange(color: HSBAColor): void;\n}" + } + }, "TableRow": { "polaris-react/src/components/DataTable/DataTable.tsx": { "filePath": "polaris-react/src/components/DataTable/DataTable.tsx", @@ -12793,39 +12793,6 @@ "value": "interface DropZoneContextType {\n disabled: boolean;\n focused: boolean;\n measuring: boolean;\n allowMultiple: boolean;\n size: string;\n type: string;\n}" } }, - "EmptySearchResultProps": { - "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx": { - "filePath": "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx", - "name": "EmptySearchResultProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx", - "syntaxKind": "PropertySignature", - "name": "description", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx", - "syntaxKind": "PropertySignature", - "name": "withIllustration", - "value": "boolean", - "description": "", - "isOptional": true - } - ], - "value": "export interface EmptySearchResultProps {\n title: string;\n description?: string;\n withIllustration?: boolean;\n}" - } - }, "EmptyStateProps": { "polaris-react/src/components/EmptyState/EmptyState.tsx": { "filePath": "polaris-react/src/components/EmptyState/EmptyState.tsx", @@ -12907,6 +12874,39 @@ "value": "export interface EmptyStateProps {\n /** The empty state heading */\n heading?: string;\n /**\n * The path to the image to display.\n * The image should have ~40px of white space above when empty state is used within a card, modal, or navigation component\n */\n image: string;\n /** The path to the image to display on large screens */\n largeImage?: string;\n /** Whether or not to limit the image to the size of its container on large screens */\n imageContained?: boolean;\n /** Whether or not the content should span the full width of its container */\n fullWidth?: boolean;\n /** Elements to display inside empty state */\n children?: React.ReactNode;\n /** Primary action for empty state */\n action?: ComplexAction;\n /** Secondary action for empty state */\n secondaryAction?: ComplexAction;\n /** Secondary elements to display below empty state actions */\n footerContent?: React.ReactNode;\n}" } }, + "EmptySearchResultProps": { + "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx": { + "filePath": "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx", + "name": "EmptySearchResultProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/EmptySearchResult/EmptySearchResult.tsx", + "syntaxKind": "PropertySignature", + "name": "withIllustration", + "value": "boolean", + "description": "", + "isOptional": true + } + ], + "value": "export interface EmptySearchResultProps {\n title: string;\n description?: string;\n withIllustration?: boolean;\n}" + } + }, "BaseEventProps": { "polaris-react/src/components/EventListener/EventListener.tsx": { "filePath": "polaris-react/src/components/EventListener/EventListener.tsx", @@ -13246,33 +13246,6 @@ ] } }, - "Context": { - "polaris-react/src/components/FocusManager/FocusManager.tsx": { - "filePath": "polaris-react/src/components/FocusManager/FocusManager.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Context", - "value": "NonNullable>", - "description": "" - } - }, - "FooterHelpProps": { - "polaris-react/src/components/FooterHelp/FooterHelp.tsx": { - "filePath": "polaris-react/src/components/FooterHelp/FooterHelp.tsx", - "name": "FooterHelpProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/FooterHelp/FooterHelp.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to display inside the layout.", - "isOptional": true - } - ], - "value": "export interface FooterHelpProps {\n /** The content to display inside the layout. */\n children?: React.ReactNode;\n}" - } - }, "FocusProps": { "polaris-react/src/components/Focus/Focus.tsx": { "filePath": "polaris-react/src/components/Focus/Focus.tsx", @@ -13303,7 +13276,34 @@ "description": "" } ], - "value": "export interface FocusProps {\n children?: React.ReactNode;\n disabled?: boolean;\n root: React.RefObject | HTMLElement | null;\n}" + "value": "export interface FocusProps {\n children?: React.ReactNode;\n disabled?: boolean;\n root: React.RefObject | HTMLElement | null;\n}" + } + }, + "Context": { + "polaris-react/src/components/FocusManager/FocusManager.tsx": { + "filePath": "polaris-react/src/components/FocusManager/FocusManager.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Context", + "value": "NonNullable>", + "description": "" + } + }, + "FooterHelpProps": { + "polaris-react/src/components/FooterHelp/FooterHelp.tsx": { + "filePath": "polaris-react/src/components/FooterHelp/FooterHelp.tsx", + "name": "FooterHelpProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/FooterHelp/FooterHelp.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The content to display inside the layout.", + "isOptional": true + } + ], + "value": "export interface FooterHelpProps {\n /** The content to display inside the layout. */\n children?: React.ReactNode;\n}" } }, "Enctype": { @@ -13539,6 +13539,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", @@ -13606,29 +13631,39 @@ "value": "export interface GridProps {\n /* Set grid-template-areas */\n areas?: Areas;\n /* Number of columns */\n columns?: Columns;\n /* Grid gap */\n gap?: Gap;\n children?: React.ReactNode;\n}" } }, - "FullscreenBarProps": { - "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx": { - "filePath": "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx", - "name": "FullscreenBarProps", + "HeadingProps": { + "polaris-react/src/components/Heading/Heading.tsx": { + "filePath": "polaris-react/src/components/Heading/Heading.tsx", + "name": "HeadingProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx", + "filePath": "polaris-react/src/components/Heading/Heading.tsx", "syntaxKind": "PropertySignature", - "name": "onAction", - "value": "() => void", - "description": "Callback when back button is clicked" + "name": "element", + "value": "HeadingTagName", + "description": "The element name to use for the heading", + "isOptional": true, + "defaultValue": "'h2'" }, { - "filePath": "polaris-react/src/components/FullscreenBar/FullscreenBar.tsx", + "filePath": "polaris-react/src/components/Heading/Heading.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", - "description": "Render child elements", + "description": "The content to display inside the heading", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Heading/Heading.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the heading, used for reference in anchor links", "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}" + "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}" } }, "IconProps": { @@ -13672,41 +13707,6 @@ "value": "export interface IconProps {\n /** The SVG contents to display in the icon (icons should fit in a 20 × 20 pixel viewBox) */\n source: IconSource;\n /** Set the color for the SVG fill */\n color?: Color;\n /** Show a backdrop behind the icon */\n backdrop?: boolean;\n /** Descriptive text to be read to screenreaders */\n accessibilityLabel?: string;\n}" } }, - "HeadingProps": { - "polaris-react/src/components/Heading/Heading.tsx": { - "filePath": "polaris-react/src/components/Heading/Heading.tsx", - "name": "HeadingProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Heading/Heading.tsx", - "syntaxKind": "PropertySignature", - "name": "element", - "value": "HeadingTagName", - "description": "The element name to use for the heading", - "isOptional": true, - "defaultValue": "'h2'" - }, - { - "filePath": "polaris-react/src/components/Heading/Heading.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to display inside the heading", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Heading/Heading.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the heading, used for reference in anchor links", - "isOptional": true - } - ], - "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}" - } - }, "SourceSet": { "polaris-react/src/components/Image/Image.tsx": { "filePath": "polaris-react/src/components/Image/Image.tsx", @@ -14261,6 +14261,24 @@ "value": "export interface IndexTableProps\n extends IndexTableBaseProps,\n IndexProviderProps {}" } }, + "IndicatorProps": { + "polaris-react/src/components/Indicator/Indicator.tsx": { + "filePath": "polaris-react/src/components/Indicator/Indicator.tsx", + "name": "IndicatorProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Indicator/Indicator.tsx", + "syntaxKind": "PropertySignature", + "name": "pulse", + "value": "boolean", + "description": "", + "isOptional": true + } + ], + "value": "export interface IndicatorProps {\n pulse?: boolean;\n}" + } + }, "InlineProps": { "polaris-react/src/components/Inline/Inline.tsx": { "filePath": "polaris-react/src/components/Inline/Inline.tsx", @@ -14311,22 +14329,21 @@ "value": "export interface InlineProps {\n /** Elements to display inside stack */\n children?: React.ReactNode;\n /** Wrap stack elements to additional rows as needed on small screens (Defaults to true) */\n wrap?: boolean;\n /** Adjust spacing between elements */\n spacing?: SpacingSpaceScale;\n /** Adjust vertical alignment of elements */\n alignY?: keyof typeof AlignY;\n /** Adjust horizontal alignment of elements */\n align?: Align;\n}" } }, - "IndicatorProps": { - "polaris-react/src/components/Indicator/Indicator.tsx": { - "filePath": "polaris-react/src/components/Indicator/Indicator.tsx", - "name": "IndicatorProps", + "InlineCodeProps": { + "polaris-react/src/components/InlineCode/InlineCode.tsx": { + "filePath": "polaris-react/src/components/InlineCode/InlineCode.tsx", + "name": "InlineCodeProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Indicator/Indicator.tsx", + "filePath": "polaris-react/src/components/InlineCode/InlineCode.tsx", "syntaxKind": "PropertySignature", - "name": "pulse", - "value": "boolean", - "description": "", - "isOptional": true + "name": "children", + "value": "ReactNode", + "description": "The content to render inside the code block" } ], - "value": "export interface IndicatorProps {\n pulse?: boolean;\n}" + "value": "export interface InlineCodeProps {\n /** The content to render inside the code block */\n children: ReactNode;\n}" } }, "InlineErrorProps": { @@ -14353,21 +14370,22 @@ "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}" } }, - "InlineCodeProps": { - "polaris-react/src/components/InlineCode/InlineCode.tsx": { - "filePath": "polaris-react/src/components/InlineCode/InlineCode.tsx", - "name": "InlineCodeProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/InlineCode/InlineCode.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", - "description": "The content to render inside the code block" - } - ], - "value": "export interface InlineCodeProps {\n /** The content to render inside the code block */\n children: ReactNode;\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": "" } }, "KeyboardKeyProps": { @@ -14405,24 +14423,6 @@ "value": "export interface KonamiCodeProps {\n handler(event: KeyboardEvent): void;\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": "" - } - }, "LabelProps": { "polaris-react/src/components/Label/Label.tsx": { "filePath": "polaris-react/src/components/Label/Label.tsx", @@ -14825,6 +14825,38 @@ "description": "" } }, + "LoadingProps": { + "polaris-react/src/components/Loading/Loading.tsx": { + "filePath": "polaris-react/src/components/Loading/Loading.tsx", + "name": "LoadingProps", + "description": "", + "members": [], + "value": "export interface LoadingProps {}" + }, + "polaris-react/src/components/Listbox/components/Loading/Loading.tsx": { + "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", + "name": "LoadingProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "" + } + ], + "value": "export interface LoadingProps {\n children?: React.ReactNode;\n accessibilityLabel: string;\n}" + } + }, "MediaCardProps": { "polaris-react/src/components/MediaCard/MediaCard.tsx": { "filePath": "polaris-react/src/components/MediaCard/MediaCard.tsx", @@ -14880,54 +14912,22 @@ "filePath": "polaris-react/src/components/MediaCard/MediaCard.tsx", "syntaxKind": "PropertySignature", "name": "portrait", - "value": "boolean", - "description": "Whether or not card content should be laid out vertically", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "polaris-react/src/components/MediaCard/MediaCard.tsx", - "syntaxKind": "PropertySignature", - "name": "size", - "value": "Size", - "description": "Size of the visual media in the card", - "isOptional": true, - "defaultValue": "'medium'" - } - ], - "value": "interface MediaCardProps {\n /** The visual media to display in the card */\n children: React.ReactNode;\n /** Heading content */\n title: React.ReactNode;\n /** Body content */\n description: string;\n /** Main call to action, rendered as a basic button */\n primaryAction?: ComplexAction;\n /** Secondary call to action, rendered as a plain button */\n secondaryAction?: ComplexAction;\n /** Action list items to render in ellipsis popover */\n popoverActions?: ActionListItemDescriptor[];\n /** Whether or not card content should be laid out vertically\n * @default false\n */\n portrait?: boolean;\n /** Size of the visual media in the card\n * @default 'medium'\n */\n size?: Size;\n}" - } - }, - "LoadingProps": { - "polaris-react/src/components/Loading/Loading.tsx": { - "filePath": "polaris-react/src/components/Loading/Loading.tsx", - "name": "LoadingProps", - "description": "", - "members": [], - "value": "export interface LoadingProps {}" - }, - "polaris-react/src/components/Listbox/components/Loading/Loading.tsx": { - "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", - "name": "LoadingProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true + "value": "boolean", + "description": "Whether or not card content should be laid out vertically", + "isOptional": true, + "defaultValue": "false" }, { - "filePath": "polaris-react/src/components/Listbox/components/Loading/Loading.tsx", + "filePath": "polaris-react/src/components/MediaCard/MediaCard.tsx", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "" + "name": "size", + "value": "Size", + "description": "Size of the visual media in the card", + "isOptional": true, + "defaultValue": "'medium'" } ], - "value": "export interface LoadingProps {\n children?: React.ReactNode;\n accessibilityLabel: string;\n}" + "value": "interface MediaCardProps {\n /** The visual media to display in the card */\n children: React.ReactNode;\n /** Heading content */\n title: React.ReactNode;\n /** Body content */\n description: string;\n /** Main call to action, rendered as a basic button */\n primaryAction?: ComplexAction;\n /** Secondary call to action, rendered as a plain button */\n secondaryAction?: ComplexAction;\n /** Action list items to render in ellipsis popover */\n popoverActions?: ActionListItemDescriptor[];\n /** Whether or not card content should be laid out vertically\n * @default false\n */\n portrait?: boolean;\n /** Size of the visual media in the card\n * @default 'medium'\n */\n size?: Size;\n}" } }, "MessageIndicatorProps": { @@ -15292,138 +15292,6 @@ "value": "interface NavigationContextType {\n location: string;\n onNavigationDismiss?(): void;\n withinContentContainer?: boolean;\n}" } }, - "Alignment": { - "polaris-react/src/components/OptionList/OptionList.tsx": { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Alignment", - "value": "'top' | 'center' | 'bottom'", - "description": "" - }, - "polaris-react/src/components/ResourceItem/ResourceItem.tsx": { - "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Alignment", - "value": "'leading' | 'trailing' | 'center' | 'fill' | 'baseline'", - "description": "" - }, - "polaris-react/src/components/Stack/Stack.tsx": { - "filePath": "polaris-react/src/components/Stack/Stack.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Alignment", - "value": "'leading' | 'trailing' | 'center' | 'fill' | 'baseline'", - "description": "" - }, - "polaris-react/src/components/TextField/TextField.tsx": { - "filePath": "polaris-react/src/components/TextField/TextField.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Alignment", - "value": "'left' | 'center' | 'right'", - "description": "" - }, - "polaris-react/src/components/Text/Text.tsx": { - "filePath": "polaris-react/src/components/Text/Text.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Alignment", - "value": "'start' | 'center' | 'end' | 'justify'", - "description": "" - }, - "polaris-react/src/components/OptionList/components/Option/Option.tsx": { - "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Alignment", - "value": "'top' | 'center' | 'bottom'", - "description": "" - } - }, - "OptionListProps": { - "polaris-react/src/components/OptionList/OptionList.tsx": { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "name": "OptionListProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the option list", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "List title", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "options", - "value": "OptionDescriptor[]", - "description": "Collection of options to be listed", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "role", - "value": "string", - "description": "Defines a specific role attribute for the list itself", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "optionRole", - "value": "string", - "description": "Defines a specific role attribute for each option in the list", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "sections", - "value": "SectionDescriptor[]", - "description": "Sections containing a header and related options", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "selected", - "value": "string[]", - "description": "The selected options" - }, - { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "allowMultiple", - "value": "boolean", - "description": "Allow more than one option to be selected", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "PropertySignature", - "name": "verticalAlign", - "value": "Alignment", - "description": "Vertically align child content to the center, top, or bottom.", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", - "syntaxKind": "MethodSignature", - "name": "onChange", - "value": "(selected: string[]) => void", - "description": "Callback when selection is changed" - } - ], - "value": "export interface OptionListProps {\n /** A unique identifier for the option list */\n id?: string;\n /** List title */\n title?: string;\n /** Collection of options to be listed */\n options?: OptionDescriptor[];\n /** Defines a specific role attribute for the list itself */\n role?: 'listbox' | 'combobox' | string;\n /** Defines a specific role attribute for each option in the list */\n optionRole?: string;\n /** Sections containing a header and related options */\n sections?: SectionDescriptor[];\n /** The selected options */\n selected: string[];\n /** Allow more than one option to be selected */\n allowMultiple?: boolean;\n /** Vertically align child content to the center, top, or bottom. */\n verticalAlign?: Alignment;\n /** Callback when selection is changed */\n onChange(selected: string[]): void;\n}" - } - }, "PageProps": { "polaris-react/src/components/Page/Page.tsx": { "filePath": "polaris-react/src/components/Page/Page.tsx", @@ -16069,29 +15937,136 @@ "value": "export interface PopoverPublicAPI {\n forceUpdatePosition(): void;\n}" } }, - "PortalsManagerProps": { - "polaris-react/src/components/PortalsManager/PortalsManager.tsx": { - "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", - "name": "PortalsManagerProps", + "Alignment": { + "polaris-react/src/components/OptionList/OptionList.tsx": { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Alignment", + "value": "'top' | 'center' | 'bottom'", + "description": "" + }, + "polaris-react/src/components/ResourceItem/ResourceItem.tsx": { + "filePath": "polaris-react/src/components/ResourceItem/ResourceItem.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Alignment", + "value": "'leading' | 'trailing' | 'center' | 'fill' | 'baseline'", + "description": "" + }, + "polaris-react/src/components/Stack/Stack.tsx": { + "filePath": "polaris-react/src/components/Stack/Stack.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Alignment", + "value": "'leading' | 'trailing' | 'center' | 'fill' | 'baseline'", + "description": "" + }, + "polaris-react/src/components/Text/Text.tsx": { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Alignment", + "value": "'start' | 'center' | 'end' | 'justify'", + "description": "" + }, + "polaris-react/src/components/TextField/TextField.tsx": { + "filePath": "polaris-react/src/components/TextField/TextField.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Alignment", + "value": "'left' | 'center' | 'right'", + "description": "" + }, + "polaris-react/src/components/OptionList/components/Option/Option.tsx": { + "filePath": "polaris-react/src/components/OptionList/components/Option/Option.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Alignment", + "value": "'top' | 'center' | 'bottom'", + "description": "" + } + }, + "OptionListProps": { + "polaris-react/src/components/OptionList/OptionList.tsx": { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "name": "OptionListProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the option list", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "List title", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "options", + "value": "OptionDescriptor[]", + "description": "Collection of options to be listed", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string", + "description": "Defines a specific role attribute for the list itself", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "optionRole", + "value": "string", + "description": "Defines a specific role attribute for each option in the list", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "sections", + "value": "SectionDescriptor[]", + "description": "Sections containing a header and related options", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "string[]", + "description": "The selected options" + }, + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "" + "name": "allowMultiple", + "value": "boolean", + "description": "Allow more than one option to be selected", + "isOptional": true }, { - "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", "syntaxKind": "PropertySignature", - "name": "container", - "value": "HTMLDivElement", - "description": "", + "name": "verticalAlign", + "value": "Alignment", + "description": "Vertically align child content to the center, top, or bottom.", "isOptional": true + }, + { + "filePath": "polaris-react/src/components/OptionList/OptionList.tsx", + "syntaxKind": "MethodSignature", + "name": "onChange", + "value": "(selected: string[]) => void", + "description": "Callback when selection is changed" } ], - "value": "export interface PortalsManagerProps {\n children: React.ReactNode;\n container?: PortalsContainerElement;\n}" + "value": "export interface OptionListProps {\n /** A unique identifier for the option list */\n id?: string;\n /** List title */\n title?: string;\n /** Collection of options to be listed */\n options?: OptionDescriptor[];\n /** Defines a specific role attribute for the list itself */\n role?: 'listbox' | 'combobox' | string;\n /** Defines a specific role attribute for each option in the list */\n optionRole?: string;\n /** Sections containing a header and related options */\n sections?: SectionDescriptor[];\n /** The selected options */\n selected: string[];\n /** Allow more than one option to be selected */\n allowMultiple?: boolean;\n /** Vertically align child content to the center, top, or bottom. */\n verticalAlign?: Alignment;\n /** Callback when selection is changed */\n onChange(selected: string[]): void;\n}" } }, "PortalProps": { @@ -16128,6 +16103,31 @@ "value": "export interface PortalProps {\n children?: React.ReactNode;\n idPrefix?: string;\n onPortalCreated?(): void;\n}" } }, + "PortalsManagerProps": { + "polaris-react/src/components/PortalsManager/PortalsManager.tsx": { + "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", + "name": "PortalsManagerProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "" + }, + { + "filePath": "polaris-react/src/components/PortalsManager/PortalsManager.tsx", + "syntaxKind": "PropertySignature", + "name": "container", + "value": "HTMLDivElement", + "description": "", + "isOptional": true + } + ], + "value": "export interface PortalsManagerProps {\n children: React.ReactNode;\n container?: PortalsContainerElement;\n}" + } + }, "Positioning": { "polaris-react/src/components/PositionedOverlay/PositionedOverlay.tsx": { "filePath": "polaris-react/src/components/PositionedOverlay/PositionedOverlay.tsx", @@ -17131,6 +17131,66 @@ "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}" } }, + "SettingActionProps": { + "polaris-react/src/components/SettingAction/SettingAction.tsx": { + "filePath": "polaris-react/src/components/SettingAction/SettingAction.tsx", + "name": "SettingActionProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/SettingAction/SettingAction.tsx", + "syntaxKind": "PropertySignature", + "name": "action", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/SettingAction/SettingAction.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "export interface SettingActionProps {\n action?: React.ReactNode;\n children?: React.ReactNode;\n}" + } + }, + "SettingToggleProps": { + "polaris-react/src/components/SettingToggle/SettingToggle.tsx": { + "filePath": "polaris-react/src/components/SettingToggle/SettingToggle.tsx", + "name": "SettingToggleProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/SettingToggle/SettingToggle.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "Inner content of the card", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/SettingToggle/SettingToggle.tsx", + "syntaxKind": "PropertySignature", + "name": "action", + "value": "ComplexAction", + "description": "Card header actions", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/SettingToggle/SettingToggle.tsx", + "syntaxKind": "PropertySignature", + "name": "enabled", + "value": "boolean", + "description": "Sets toggle state to activated or deactivated", + "isOptional": true + } + ], + "value": "export interface SettingToggleProps {\n /** Inner content of the card */\n children?: React.ReactNode;\n /** Card header actions */\n action?: ComplexAction;\n /** Sets toggle state to activated or deactivated */\n enabled?: boolean;\n}" + } + }, "StrictOption": { "polaris-react/src/components/Select/Select.tsx": { "filePath": "polaris-react/src/components/Select/Select.tsx", @@ -17413,66 +17473,6 @@ "value": "export interface SelectProps {\n /** List of options or option groups to choose from */\n options?: (SelectOption | SelectGroup)[];\n /** Label for the select */\n label: React.ReactNode;\n /** Adds an action to the label */\n labelAction?: LabelledProps['action'];\n /** Visually hide the label */\n labelHidden?: boolean;\n /** Show the label to the left of the value, inside the control */\n labelInline?: boolean;\n /** Disable input */\n disabled?: boolean;\n /** Additional text to aide in use */\n helpText?: React.ReactNode;\n /** Example text to display as placeholder */\n placeholder?: string;\n /** ID for form input */\n id?: string;\n /** Name for form input */\n name?: string;\n /** Value for form input */\n value?: string;\n /** Display an error state */\n error?: Error | boolean;\n /** Callback when selection is changed */\n onChange?(selected: string, id: string): void;\n /** Callback when select is focused */\n onFocus?(): void;\n /** Callback when focus is removed */\n onBlur?(): void;\n /** Visual required indicator, add an asterisk to label */\n requiredIndicator?: boolean;\n}" } }, - "SettingActionProps": { - "polaris-react/src/components/SettingAction/SettingAction.tsx": { - "filePath": "polaris-react/src/components/SettingAction/SettingAction.tsx", - "name": "SettingActionProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/SettingAction/SettingAction.tsx", - "syntaxKind": "PropertySignature", - "name": "action", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/SettingAction/SettingAction.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "export interface SettingActionProps {\n action?: React.ReactNode;\n children?: React.ReactNode;\n}" - } - }, - "SettingToggleProps": { - "polaris-react/src/components/SettingToggle/SettingToggle.tsx": { - "filePath": "polaris-react/src/components/SettingToggle/SettingToggle.tsx", - "name": "SettingToggleProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/SettingToggle/SettingToggle.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "Inner content of the card", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/SettingToggle/SettingToggle.tsx", - "syntaxKind": "PropertySignature", - "name": "action", - "value": "ComplexAction", - "description": "Card header actions", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/SettingToggle/SettingToggle.tsx", - "syntaxKind": "PropertySignature", - "name": "enabled", - "value": "boolean", - "description": "Sets toggle state to activated or deactivated", - "isOptional": true - } - ], - "value": "export interface SettingToggleProps {\n /** Inner content of the card */\n children?: React.ReactNode;\n /** Card header actions */\n action?: ComplexAction;\n /** Sets toggle state to activated or deactivated */\n enabled?: boolean;\n}" - } - }, "SheetProps": { "polaris-react/src/components/Sheet/Sheet.tsx": { "filePath": "polaris-react/src/components/Sheet/Sheet.tsx", @@ -17535,6 +17535,25 @@ "value": "export interface SheetProps {\n /** Whether or not the sheet is open */\n open: boolean;\n /** The child elements to render in the sheet */\n children: React.ReactNode;\n /** Callback when the backdrop is clicked or `ESC` is pressed */\n onClose(): void;\n /** Callback when the sheet has completed entering */\n onEntered?(): void;\n /** Callback when the sheet has started to exit */\n onExit?(): void;\n /** ARIA label for sheet */\n accessibilityLabel: string;\n /** The element or the RefObject that activates the Sheet */\n activator?: React.RefObject | React.ReactElement;\n}" } }, + "SkeletonBodyTextProps": { + "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx": { + "filePath": "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx", + "name": "SkeletonBodyTextProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx", + "syntaxKind": "PropertySignature", + "name": "lines", + "value": "number", + "description": "Number of lines to display", + "isOptional": true, + "defaultValue": "3" + } + ], + "value": "export interface SkeletonBodyTextProps {\n /**\n * Number of lines to display\n * @default 3\n */\n lines?: number;\n}" + } + }, "SkeletonDisplayTextProps": { "polaris-react/src/components/SkeletonDisplayText/SkeletonDisplayText.tsx": { "filePath": "polaris-react/src/components/SkeletonDisplayText/SkeletonDisplayText.tsx", @@ -17554,23 +17573,41 @@ "value": "export interface SkeletonDisplayTextProps {\n /**\n * Size of the text\n * @default 'medium'\n */\n size?: Size;\n}" } }, - "SkeletonBodyTextProps": { - "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx": { - "filePath": "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx", - "name": "SkeletonBodyTextProps", + "SkeletonTabsProps": { + "polaris-react/src/components/SkeletonTabs/SkeletonTabs.tsx": { + "filePath": "polaris-react/src/components/SkeletonTabs/SkeletonTabs.tsx", + "name": "SkeletonTabsProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/SkeletonBodyText/SkeletonBodyText.tsx", + "filePath": "polaris-react/src/components/SkeletonTabs/SkeletonTabs.tsx", "syntaxKind": "PropertySignature", - "name": "lines", + "name": "count", "value": "number", - "description": "Number of lines to display", + "description": "", + "isOptional": true + } + ], + "value": "export interface SkeletonTabsProps {\n count?: number;\n}" + } + }, + "SkeletonThumbnailProps": { + "polaris-react/src/components/SkeletonThumbnail/SkeletonThumbnail.tsx": { + "filePath": "polaris-react/src/components/SkeletonThumbnail/SkeletonThumbnail.tsx", + "name": "SkeletonThumbnailProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/SkeletonThumbnail/SkeletonThumbnail.tsx", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "Size", + "description": "Size of the thumbnail", "isOptional": true, - "defaultValue": "3" + "defaultValue": "'medium'" } ], - "value": "export interface SkeletonBodyTextProps {\n /**\n * Number of lines to display\n * @default 3\n */\n lines?: number;\n}" + "value": "export interface SkeletonThumbnailProps {\n /**\n * Size of the thumbnail\n * @default 'medium'\n */\n size?: Size;\n}" } }, "SkeletonPageProps": { @@ -17612,60 +17649,23 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/SkeletonPage/SkeletonPage.tsx", - "syntaxKind": "PropertySignature", - "name": "breadcrumbs", - "value": "boolean", - "description": "Shows a skeleton over the breadcrumb", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/SkeletonPage/SkeletonPage.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The child elements to render in the skeleton page.", - "isOptional": true - } - ], - "value": "export interface SkeletonPageProps {\n /** Page title, in large type */\n title?: string;\n /** Remove the normal max-width on the page */\n fullWidth?: boolean;\n /** Decreases the maximum layout width. Intended for single-column layouts */\n narrowWidth?: boolean;\n /** Shows a skeleton over the primary action */\n primaryAction?: boolean;\n /** Shows a skeleton over the breadcrumb */\n breadcrumbs?: boolean;\n /** The child elements to render in the skeleton page. */\n children?: React.ReactNode;\n}" - } - }, - "SkeletonTabsProps": { - "polaris-react/src/components/SkeletonTabs/SkeletonTabs.tsx": { - "filePath": "polaris-react/src/components/SkeletonTabs/SkeletonTabs.tsx", - "name": "SkeletonTabsProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/SkeletonTabs/SkeletonTabs.tsx", - "syntaxKind": "PropertySignature", - "name": "count", - "value": "number", - "description": "", + "filePath": "polaris-react/src/components/SkeletonPage/SkeletonPage.tsx", + "syntaxKind": "PropertySignature", + "name": "breadcrumbs", + "value": "boolean", + "description": "Shows a skeleton over the breadcrumb", "isOptional": true - } - ], - "value": "export interface SkeletonTabsProps {\n count?: number;\n}" - } - }, - "SkeletonThumbnailProps": { - "polaris-react/src/components/SkeletonThumbnail/SkeletonThumbnail.tsx": { - "filePath": "polaris-react/src/components/SkeletonThumbnail/SkeletonThumbnail.tsx", - "name": "SkeletonThumbnailProps", - "description": "", - "members": [ + }, { - "filePath": "polaris-react/src/components/SkeletonThumbnail/SkeletonThumbnail.tsx", + "filePath": "polaris-react/src/components/SkeletonPage/SkeletonPage.tsx", "syntaxKind": "PropertySignature", - "name": "size", - "value": "Size", - "description": "Size of the thumbnail", - "isOptional": true, - "defaultValue": "'medium'" + "name": "children", + "value": "React.ReactNode", + "description": "The child elements to render in the skeleton page.", + "isOptional": true } ], - "value": "export interface SkeletonThumbnailProps {\n /**\n * Size of the thumbnail\n * @default 'medium'\n */\n size?: Size;\n}" + "value": "export interface SkeletonPageProps {\n /** Page title, in large type */\n title?: string;\n /** Remove the normal max-width on the page */\n fullWidth?: boolean;\n /** Decreases the maximum layout width. Intended for single-column layouts */\n narrowWidth?: boolean;\n /** Shows a skeleton over the primary action */\n primaryAction?: boolean;\n /** Shows a skeleton over the breadcrumb */\n breadcrumbs?: boolean;\n /** The child elements to render in the skeleton page. */\n children?: React.ReactNode;\n}" } }, "SpinnerProps": { @@ -17908,6 +17908,95 @@ "description": "" } }, + "Variant": { + "polaris-react/src/components/Text/Text.tsx": { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "Variant", + "value": "'headingXs' | 'headingSm' | 'headingMd' | 'headingLg' | 'headingXl' | 'heading2xl' | 'heading3xl' | 'heading4xl' | 'bodySm' | 'bodyMd' | 'bodyLg'", + "description": "" + } + }, + "FontWeight": { + "polaris-react/src/components/Text/Text.tsx": { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "FontWeight", + "value": "'regular' | 'medium' | 'semibold' | 'bold'", + "description": "" + } + }, + "TextProps": { + "polaris-react/src/components/Text/Text.tsx": { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "name": "TextProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "syntaxKind": "PropertySignature", + "name": "alignment", + "value": "Alignment", + "description": "Adjust horizontal alignment of text", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "syntaxKind": "PropertySignature", + "name": "as", + "value": "Element", + "description": "The element type" + }, + { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ReactNode", + "description": "Text to display" + }, + { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "syntaxKind": "PropertySignature", + "name": "color", + "value": "Color", + "description": "Adjust color of text", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "syntaxKind": "PropertySignature", + "name": "fontWeight", + "value": "FontWeight", + "description": "Adjust weight of text", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "syntaxKind": "PropertySignature", + "name": "truncate", + "value": "boolean", + "description": "Truncate text overflow with ellipsis", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "syntaxKind": "PropertySignature", + "name": "variant", + "value": "Variant", + "description": "Typographic style of text" + }, + { + "filePath": "polaris-react/src/components/Text/Text.tsx", + "syntaxKind": "PropertySignature", + "name": "visuallyHidden", + "value": "boolean", + "description": "Visually hide the text", + "isOptional": true + } + ], + "value": "export interface TextProps {\n /** Adjust horizontal alignment of text */\n alignment?: Alignment;\n /** The element type */\n as: Element;\n /** Text to display */\n children: ReactNode;\n /** Adjust color of text */\n color?: Color;\n /** Adjust weight of text */\n fontWeight?: FontWeight;\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", @@ -18005,147 +18094,58 @@ "members": [ { "filePath": "polaris-react/src/components/TextField/TextField.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "true", - "description": "", - "isOptional": true - } - ], - "value": "interface Disabled {\n disabled?: true;\n}" - } - }, - "Interactive": { - "polaris-react/src/components/TextField/TextField.tsx": { - "filePath": "polaris-react/src/components/TextField/TextField.tsx", - "name": "Interactive", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/TextField/TextField.tsx", - "syntaxKind": "MethodSignature", - "name": "onChange", - "value": "(value: string, id: string) => void", - "description": "" - } - ], - "value": "interface Interactive {\n onChange(value: string, id: string): void;\n}" - } - }, - "MutuallyExclusiveSelectionProps": { - "polaris-react/src/components/TextField/TextField.tsx": { - "filePath": "polaris-react/src/components/TextField/TextField.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "MutuallyExclusiveSelectionProps", - "value": "SelectSuggestion | SelectTextOnFocus", - "description": "" - } - }, - "MutuallyExclusiveInteractionProps": { - "polaris-react/src/components/TextField/TextField.tsx": { - "filePath": "polaris-react/src/components/TextField/TextField.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "MutuallyExclusiveInteractionProps", - "value": "Interactive | Readonly | Disabled", - "description": "" - } - }, - "TextFieldProps": { - "polaris-react/src/components/TextField/TextField.tsx": { - "filePath": "polaris-react/src/components/TextField/TextField.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "TextFieldProps", - "value": "NonMutuallyExclusiveProps & MutuallyExclusiveInteractionProps & MutuallyExclusiveSelectionProps", - "description": "" - } - }, - "Variant": { - "polaris-react/src/components/Text/Text.tsx": { - "filePath": "polaris-react/src/components/Text/Text.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "Variant", - "value": "'headingXs' | 'headingSm' | 'headingMd' | 'headingLg' | 'headingXl' | 'heading2xl' | 'heading3xl' | 'heading4xl' | 'bodySm' | 'bodyMd' | 'bodyLg'", - "description": "" - } - }, - "FontWeight": { - "polaris-react/src/components/Text/Text.tsx": { - "filePath": "polaris-react/src/components/Text/Text.tsx", - "syntaxKind": "TypeAliasDeclaration", - "name": "FontWeight", - "value": "'regular' | 'medium' | 'semibold' | 'bold'", - "description": "" - } - }, - "TextProps": { - "polaris-react/src/components/Text/Text.tsx": { - "filePath": "polaris-react/src/components/Text/Text.tsx", - "name": "TextProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Text/Text.tsx", - "syntaxKind": "PropertySignature", - "name": "alignment", - "value": "Alignment", - "description": "Adjust horizontal alignment of text", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Text/Text.tsx", - "syntaxKind": "PropertySignature", - "name": "as", - "value": "Element", - "description": "The element type" - }, - { - "filePath": "polaris-react/src/components/Text/Text.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "ReactNode", - "description": "Text to display" - }, - { - "filePath": "polaris-react/src/components/Text/Text.tsx", - "syntaxKind": "PropertySignature", - "name": "color", - "value": "Color", - "description": "Adjust color of text", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Text/Text.tsx", - "syntaxKind": "PropertySignature", - "name": "fontWeight", - "value": "FontWeight", - "description": "Adjust weight of text", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Text/Text.tsx", - "syntaxKind": "PropertySignature", - "name": "truncate", - "value": "boolean", - "description": "Truncate text overflow with ellipsis", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Text/Text.tsx", - "syntaxKind": "PropertySignature", - "name": "variant", - "value": "Variant", - "description": "Typographic style of text" - }, - { - "filePath": "polaris-react/src/components/Text/Text.tsx", - "syntaxKind": "PropertySignature", - "name": "visuallyHidden", - "value": "boolean", - "description": "Visually hide the text", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "true", + "description": "", "isOptional": true } ], - "value": "export interface TextProps {\n /** Adjust horizontal alignment of text */\n alignment?: Alignment;\n /** The element type */\n as: Element;\n /** Text to display */\n children: ReactNode;\n /** Adjust color of text */\n color?: Color;\n /** Adjust weight of text */\n fontWeight?: FontWeight;\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}" + "value": "interface Disabled {\n disabled?: true;\n}" + } + }, + "Interactive": { + "polaris-react/src/components/TextField/TextField.tsx": { + "filePath": "polaris-react/src/components/TextField/TextField.tsx", + "name": "Interactive", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/TextField/TextField.tsx", + "syntaxKind": "MethodSignature", + "name": "onChange", + "value": "(value: string, id: string) => void", + "description": "" + } + ], + "value": "interface Interactive {\n onChange(value: string, id: string): void;\n}" + } + }, + "MutuallyExclusiveSelectionProps": { + "polaris-react/src/components/TextField/TextField.tsx": { + "filePath": "polaris-react/src/components/TextField/TextField.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "MutuallyExclusiveSelectionProps", + "value": "SelectSuggestion | SelectTextOnFocus", + "description": "" + } + }, + "MutuallyExclusiveInteractionProps": { + "polaris-react/src/components/TextField/TextField.tsx": { + "filePath": "polaris-react/src/components/TextField/TextField.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "MutuallyExclusiveInteractionProps", + "value": "Interactive | Readonly | Disabled", + "description": "" + } + }, + "TextFieldProps": { + "polaris-react/src/components/TextField/TextField.tsx": { + "filePath": "polaris-react/src/components/TextField/TextField.tsx", + "syntaxKind": "TypeAliasDeclaration", + "name": "TextFieldProps", + "value": "NonMutuallyExclusiveProps & MutuallyExclusiveInteractionProps & MutuallyExclusiveSelectionProps", + "description": "" } }, "Variation": { @@ -18264,21 +18264,21 @@ "value": "export interface ThumbnailProps {\n /**\n * Size of thumbnail\n * @default 'medium'\n */\n size?: Size;\n /** URL for the image */\n source: string | React.FunctionComponent>;\n /** Alt text for the thumbnail image */\n alt: string;\n /** Transparent background */\n transparent?: boolean;\n}" } }, - "TileProps": { - "polaris-react/src/components/Tile/Tile.tsx": { - "filePath": "polaris-react/src/components/Tile/Tile.tsx", - "name": "TileProps", + "TilesProps": { + "polaris-react/src/components/Tiles/Tiles.tsx": { + "filePath": "polaris-react/src/components/Tiles/Tiles.tsx", + "name": "TilesProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Tile/Tile.tsx", + "filePath": "polaris-react/src/components/Tiles/Tiles.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", "description": "Elements to display inside tile" }, { - "filePath": "polaris-react/src/components/Tile/Tile.tsx", + "filePath": "polaris-react/src/components/Tiles/Tiles.tsx", "syntaxKind": "PropertySignature", "name": "gap", "value": "Gap", @@ -18286,7 +18286,7 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/Tile/Tile.tsx", + "filePath": "polaris-react/src/components/Tiles/Tiles.tsx", "syntaxKind": "PropertySignature", "name": "columns", "value": "Columns", @@ -18294,7 +18294,7 @@ "isOptional": true } ], - "value": "export interface TileProps {\n /** Elements to display inside tile */\n children: React.ReactNode;\n /** Adjust spacing between elements */\n gap?: Gap;\n /** Adjust number of columns */\n columns?: Columns;\n}" + "value": "export interface TilesProps {\n /** 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": { @@ -18478,6 +18478,32 @@ "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", + "description": "", + "members": [ + { + "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": "", + "isOptional": true + } + ], + "value": "export interface TrapFocusProps {\n trapping?: boolean;\n children?: React.ReactNode;\n}" + } + }, "TruncateProps": { "polaris-react/src/components/Truncate/Truncate.tsx": { "filePath": "polaris-react/src/components/Truncate/Truncate.tsx", @@ -18495,30 +18521,219 @@ "value": "export interface TruncateProps {\n children: React.ReactNode;\n}" } }, - "TrapFocusProps": { - "polaris-react/src/components/TrapFocus/TrapFocus.tsx": { - "filePath": "polaris-react/src/components/TrapFocus/TrapFocus.tsx", - "name": "TrapFocusProps", + "UnstyledButtonProps": { + "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx": { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "name": "UnstyledButtonProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/TrapFocus/TrapFocus.tsx", - "syntaxKind": "PropertySignature", - "name": "trapping", - "value": "boolean", - "description": "", + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "name": "[key: string]", + "value": "any" + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The content to display inside the button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "A custom class name to apply styles to button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "url", + "value": "string", + "description": "A destination to link to, rendered in the href attribute of a link", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "external", + "value": "boolean", + "description": "Forces url to open in a new tab", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "download", + "value": "string | boolean", + "description": "Tells the browser to download the url instead of opening it. Provides a hint for the downloaded filename if it is a string value", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "submit", + "value": "boolean", + "description": "Allows the button to submit a form", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Disables the button, disallowing merchant interaction", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Replaces button text with a spinner while a background action is being performed", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "pressed", + "value": "boolean", + "description": "Sets the button in a pressed state", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "Visually hidden text for screen readers", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string", + "description": "A valid WAI-ARIA role to define the semantic value of this element", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "ariaControls", + "value": "string", + "description": "Id of the element the button controls", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "boolean", + "description": "Tells screen reader the controlled element is expanded", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedBy", + "value": "string", + "description": "Indicates the ID of the element that describes the button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "\"false\" | \"true\"", + "description": "Indicates the current checked state of the button when acting as a toggle or switch", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "Callback when clicked", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onFocus", + "value": "() => void", + "description": "Callback when button becomes focussed", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onBlur", + "value": "() => void", + "description": "Callback when focus leaves button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyPress", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keypress event is registered on the button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyUp", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keyup event is registered on the button", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onKeyDown", + "value": "(event: React.KeyboardEvent) => void", + "description": "Callback when a keydown event is registered on the button", "isOptional": true }, { - "filePath": "polaris-react/src/components/TrapFocus/TrapFocus.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onMouseEnter", + "value": "() => void", + "description": "Callback when mouse enter", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onTouchStart", + "value": "() => void", + "description": "Callback when element is touched", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onPointerDown", + "value": "() => void", + "description": "Callback when pointerdown event is being triggered", "isOptional": true } ], - "value": "export interface TrapFocusProps {\n trapping?: boolean;\n children?: React.ReactNode;\n}" + "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}" } }, "UnstyledLinkProps": { @@ -21414,243 +21629,28 @@ "filePath": "polaris-react/src/components/UnstyledLink/UnstyledLink.tsx", "syntaxKind": "PropertySignature", "name": "onTransitionEndCapture", - "value": "TransitionEventHandler", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledLink/UnstyledLink.tsx", - "syntaxKind": "PropertySignature", - "name": "ref", - "value": "LegacyRef", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledLink/UnstyledLink.tsx", - "syntaxKind": "PropertySignature", - "name": "key", - "value": "Key", - "description": "", - "isOptional": true - } - ], - "value": "export interface UnstyledLinkProps extends LinkLikeComponentProps {}" - } - }, - "UnstyledButtonProps": { - "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx": { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "name": "UnstyledButtonProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "name": "[key: string]", - "value": "any" - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The content to display inside the button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "className", - "value": "string", - "description": "A custom class name to apply styles to button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "A destination to link to, rendered in the href attribute of a link", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "external", - "value": "boolean", - "description": "Forces url to open in a new tab", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "download", - "value": "string | boolean", - "description": "Tells the browser to download the url instead of opening it. Provides a hint for the downloaded filename if it is a string value", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "submit", - "value": "boolean", - "description": "Allows the button to submit a form", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the button, disallowing merchant interaction", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "loading", - "value": "boolean", - "description": "Replaces button text with a spinner while a background action is being performed", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "pressed", - "value": "boolean", - "description": "Sets the button in a pressed state", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "Visually hidden text for screen readers", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "role", - "value": "string", - "description": "A valid WAI-ARIA role to define the semantic value of this element", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "ariaControls", - "value": "string", - "description": "Id of the element the button controls", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "ariaExpanded", - "value": "boolean", - "description": "Tells screen reader the controlled element is expanded", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "ariaDescribedBy", - "value": "string", - "description": "Indicates the ID of the element that describes the button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "PropertySignature", - "name": "ariaChecked", - "value": "\"false\" | \"true\"", - "description": "Indicates the current checked state of the button when acting as a toggle or switch", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "Callback when clicked", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onFocus", - "value": "() => void", - "description": "Callback when button becomes focussed", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onBlur", - "value": "() => void", - "description": "Callback when focus leaves button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyPress", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keypress event is registered on the button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyUp", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keyup event is registered on the button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onKeyDown", - "value": "(event: React.KeyboardEvent) => void", - "description": "Callback when a keydown event is registered on the button", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onMouseEnter", - "value": "() => void", - "description": "Callback when mouse enter", + "value": "TransitionEventHandler", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onTouchStart", - "value": "() => void", - "description": "Callback when element is touched", + "filePath": "polaris-react/src/components/UnstyledLink/UnstyledLink.tsx", + "syntaxKind": "PropertySignature", + "name": "ref", + "value": "LegacyRef", + "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/UnstyledButton/UnstyledButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onPointerDown", - "value": "() => void", - "description": "Callback when pointerdown event is being triggered", + "filePath": "polaris-react/src/components/UnstyledLink/UnstyledLink.tsx", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "Key", + "description": "", "isOptional": true } ], - "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}" + "value": "export interface UnstyledLinkProps extends LinkLikeComponentProps {}" } }, "VideoThumbnailProps": { @@ -23273,6 +23273,40 @@ "description": "" } }, + "PipProps": { + "polaris-react/src/components/Badge/components/Pip/Pip.tsx": { + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "name": "PipProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "syntaxKind": "PropertySignature", + "name": "status", + "value": "Status", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "syntaxKind": "PropertySignature", + "name": "progress", + "value": "Progress", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabelOverride", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface PipProps {\n status?: Status;\n progress?: Progress;\n accessibilityLabelOverride?: string;\n}" + } + }, "BulkActionButtonProps": { "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx": { "filePath": "polaris-react/src/components/BulkActions/components/BulkActionButton/BulkActionButton.tsx", @@ -23369,40 +23403,6 @@ "value": "export interface BulkActionsMenuProps extends MenuGroupDescriptor {\n isNewBadgeInBadgeActions: boolean;\n}" } }, - "PipProps": { - "polaris-react/src/components/Badge/components/Pip/Pip.tsx": { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", - "name": "PipProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", - "syntaxKind": "PropertySignature", - "name": "status", - "value": "Status", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", - "syntaxKind": "PropertySignature", - "name": "progress", - "value": "Progress", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Badge/components/Pip/Pip.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabelOverride", - "value": "string", - "description": "", - "isOptional": true - } - ], - "value": "export interface PipProps {\n status?: Status;\n progress?: Progress;\n accessibilityLabelOverride?: string;\n}" - } - }, "CardHeaderProps": { "polaris-react/src/components/Card/components/Header/Header.tsx": { "filePath": "polaris-react/src/components/Card/components/Header/Header.tsx", @@ -23503,37 +23503,6 @@ "value": "export interface CardSectionProps {\n title?: React.ReactNode;\n children?: React.ReactNode;\n subdued?: boolean;\n flush?: boolean;\n fullWidth?: boolean;\n /** Allow the card to be hidden when printing */\n hideOnPrint?: boolean;\n actions?: ComplexAction[];\n}" } }, - "AlphaPickerProps": { - "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx": { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", - "name": "AlphaPickerProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", - "syntaxKind": "PropertySignature", - "name": "color", - "value": "HSBColor", - "description": "" - }, - { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", - "syntaxKind": "PropertySignature", - "name": "alpha", - "value": "number", - "description": "" - }, - { - "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", - "syntaxKind": "MethodSignature", - "name": "onChange", - "value": "(hue: number) => void", - "description": "" - } - ], - "value": "export interface AlphaPickerProps {\n color: HSBColor;\n alpha: number;\n onChange(hue: number): void;\n}" - } - }, "CardSubsectionProps": { "polaris-react/src/components/Card/components/Subsection/Subsection.tsx": { "filePath": "polaris-react/src/components/Card/components/Subsection/Subsection.tsx", @@ -23552,6 +23521,15 @@ "value": "export interface CardSubsectionProps {\n children?: React.ReactNode;\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": "" + } + }, "HuePickerProps": { "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx": { "filePath": "polaris-react/src/components/ColorPicker/components/HuePicker/HuePicker.tsx", @@ -23576,78 +23554,35 @@ "value": "export interface HuePickerProps {\n hue: number;\n onChange(hue: number): void;\n}" } }, - "Position": { - "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx": { - "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", - "name": "Position", + "AlphaPickerProps": { + "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx": { + "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", + "name": "AlphaPickerProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", "syntaxKind": "PropertySignature", - "name": "x", - "value": "number", + "name": "color", + "value": "HSBColor", "description": "" }, { - "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", "syntaxKind": "PropertySignature", - "name": "y", + "name": "alpha", "value": "number", "description": "" - } - ], - "value": "interface Position {\n x: number;\n y: number;\n}" - } - }, - "SlidableProps": { - "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx": { - "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", - "name": "SlidableProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", - "syntaxKind": "PropertySignature", - "name": "draggerX", - "value": "number", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", - "syntaxKind": "PropertySignature", - "name": "draggerY", - "value": "number", - "description": "", - "isOptional": true }, { - "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", + "filePath": "polaris-react/src/components/ColorPicker/components/AlphaPicker/AlphaPicker.tsx", "syntaxKind": "MethodSignature", "name": "onChange", - "value": "(position: Position) => void", + "value": "(hue: number) => void", "description": "" - }, - { - "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", - "syntaxKind": "MethodSignature", - "name": "onDraggerHeight", - "value": "(height: number) => void", - "description": "", - "isOptional": true } ], - "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": "" + "value": "export interface AlphaPickerProps {\n color: HSBColor;\n alpha: number;\n onChange(hue: number): void;\n}" } }, "CellProps": { @@ -23929,23 +23864,88 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/IndexTable/components/Cell/Cell.tsx", + "filePath": "polaris-react/src/components/IndexTable/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/IndexTable/components/Cell/Cell.tsx", + "syntaxKind": "PropertySignature", + "name": "flush", + "value": "boolean", + "description": "", + "isOptional": true + } + ], + "value": "export interface CellProps {\n children?: ReactNode;\n className?: string;\n flush?: boolean;\n}" + } + }, + "Position": { + "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx": { + "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", + "name": "Position", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", + "syntaxKind": "PropertySignature", + "name": "x", + "value": "number", + "description": "" + }, + { + "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", + "syntaxKind": "PropertySignature", + "name": "y", + "value": "number", + "description": "" + } + ], + "value": "interface Position {\n x: number;\n y: number;\n}" + } + }, + "SlidableProps": { + "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx": { + "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", + "name": "SlidableProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", + "syntaxKind": "PropertySignature", + "name": "draggerX", + "value": "number", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", "syntaxKind": "PropertySignature", - "name": "className", - "value": "string", + "name": "draggerY", + "value": "number", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/IndexTable/components/Cell/Cell.tsx", - "syntaxKind": "PropertySignature", - "name": "flush", - "value": "boolean", + "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", + "syntaxKind": "MethodSignature", + "name": "onChange", + "value": "(position: Position) => void", + "description": "" + }, + { + "filePath": "polaris-react/src/components/ColorPicker/components/Slidable/Slidable.tsx", + "syntaxKind": "MethodSignature", + "name": "onDraggerHeight", + "value": "(height: number) => void", "description": "", "isOptional": true } ], - "value": "export interface CellProps {\n children?: ReactNode;\n className?: string;\n flush?: boolean;\n}" + "value": "export interface SlidableProps {\n draggerX?: number;\n draggerY?: number;\n onChange(position: Position): void;\n onDraggerHeight?(height: number): void;\n}" } }, "DayProps": { @@ -24442,48 +24442,6 @@ "value": "interface ComputedProperty {\n [key: string]: number;\n}" } }, - "GroupProps": { - "polaris-react/src/components/FormLayout/components/Group/Group.tsx": { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "name": "GroupProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "syntaxKind": "PropertySignature", - "name": "condensed", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", - "syntaxKind": "PropertySignature", - "name": "helpText", - "value": "React.ReactNode", - "description": "", - "isOptional": true - } - ], - "value": "export interface GroupProps {\n children?: React.ReactNode;\n condensed?: boolean;\n title?: string;\n helpText?: React.ReactNode;\n}" - } - }, "AnimationType": { "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx": { "filePath": "polaris-react/src/components/Frame/components/CSSAnimation/CSSAnimation.tsx", @@ -24549,6 +24507,48 @@ "value": "export interface ToastManagerProps {\n toastMessages: ToastPropsWithID[];\n}" } }, + "GroupProps": { + "polaris-react/src/components/FormLayout/components/Group/Group.tsx": { + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "name": "GroupProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "syntaxKind": "PropertySignature", + "name": "condensed", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/FormLayout/components/Group/Group.tsx", + "syntaxKind": "PropertySignature", + "name": "helpText", + "value": "React.ReactNode", + "description": "", + "isOptional": true + } + ], + "value": "export interface GroupProps {\n children?: React.ReactNode;\n condensed?: boolean;\n title?: string;\n helpText?: React.ReactNode;\n}" + } + }, "Cell": { "polaris-react/src/components/Grid/components/Cell/Cell.tsx": { "filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx", @@ -25131,31 +25131,6 @@ "value": "export interface OptionProps {\n id: string;\n label: React.ReactNode;\n value: string;\n section: number;\n index: number;\n media?: React.ReactElement;\n disabled?: boolean;\n active?: boolean;\n select?: boolean;\n allowMultiple?: boolean;\n verticalAlign?: Alignment;\n role?: string;\n onClick(section: number, option: number): void;\n}" } }, - "CloseButtonProps": { - "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx": { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "name": "CloseButtonProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "syntaxKind": "PropertySignature", - "name": "titleHidden", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "() => void", - "description": "" - } - ], - "value": "export interface CloseButtonProps {\n titleHidden?: boolean;\n onClick(): void;\n}" - } - }, "TextOptionProps": { "polaris-react/src/components/Listbox/components/TextOption/TextOption.tsx": { "filePath": "polaris-react/src/components/Listbox/components/TextOption/TextOption.tsx", @@ -25189,6 +25164,31 @@ "value": "export interface TextOptionProps {\n children: React.ReactNode;\n // Whether the option is selected\n selected?: boolean;\n // Whether the option is disabled\n disabled?: boolean;\n}" } }, + "CloseButtonProps": { + "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx": { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "name": "CloseButtonProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "syntaxKind": "PropertySignature", + "name": "titleHidden", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Modal/components/CloseButton/CloseButton.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "() => void", + "description": "" + } + ], + "value": "export interface CloseButtonProps {\n titleHidden?: boolean;\n onClick(): void;\n}" + } + }, "DialogProps": { "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx": { "filePath": "polaris-react/src/components/Modal/components/Dialog/Dialog.tsx", @@ -25623,56 +25623,6 @@ "value": "interface PrimaryAction\n extends DestructableAction,\n DisableableAction,\n LoadableAction,\n IconableAction,\n TooltipAction {\n /** Provides extra visual weight and identifies the primary action in a set of buttons */\n primary?: boolean;\n}" } }, - "PaneProps": { - "polaris-react/src/components/Popover/components/Pane/Pane.tsx": { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "name": "PaneProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "fixed", - "value": "boolean", - "description": "Fix the pane to the top of the popover", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "sectioned", - "value": "boolean", - "description": "Automatically wrap children in padded sections", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "The pane content", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "PropertySignature", - "name": "height", - "value": "string", - "description": "Sets a fixed height and max-height on the Scrollable", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", - "syntaxKind": "MethodSignature", - "name": "onScrolledToBottom", - "value": "() => void", - "description": "Callback when the bottom of the popover is reached by mouse or keyboard", - "isOptional": true - } - ], - "value": "export interface PaneProps {\n /** Fix the pane to the top of the popover */\n fixed?: boolean;\n /** Automatically wrap children in padded sections */\n sectioned?: boolean;\n /** The pane content */\n children?: React.ReactNode;\n /** Sets a fixed height and max-height on the Scrollable */\n height?: string;\n /** Callback when the bottom of the popover is reached by mouse or keyboard */\n onScrolledToBottom?(): void;\n}" - } - }, "PopoverCloseSource": { "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx": { "filePath": "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx", @@ -25828,30 +25778,80 @@ "isOptional": true }, { - "filePath": "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx", - "syntaxKind": "MethodSignature", - "name": "onClose", - "value": "(source: PopoverCloseSource) => void", - "description": "" + "filePath": "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx", + "syntaxKind": "MethodSignature", + "name": "onClose", + "value": "(source: PopoverCloseSource) => void", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx", + "syntaxKind": "PropertySignature", + "name": "autofocusTarget", + "value": "PopoverAutofocusTarget", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx", + "syntaxKind": "PropertySignature", + "name": "preventCloseOnChildOverlayClick", + "value": "boolean", + "description": "", + "isOptional": true + } + ], + "value": "export interface PopoverOverlayProps {\n children?: React.ReactNode;\n fullWidth?: boolean;\n fullHeight?: boolean;\n fluidContent?: boolean;\n preferredPosition?: PositionedOverlayProps['preferredPosition'];\n preferredAlignment?: PositionedOverlayProps['preferredAlignment'];\n active: boolean;\n id: string;\n zIndexOverride?: number;\n activator: HTMLElement;\n preferInputActivator?: PositionedOverlayProps['preferInputActivator'];\n sectioned?: boolean;\n fixed?: boolean;\n hideOnPrint?: boolean;\n onClose(source: PopoverCloseSource): void;\n autofocusTarget?: PopoverAutofocusTarget;\n preventCloseOnChildOverlayClick?: boolean;\n}" + } + }, + "PaneProps": { + "polaris-react/src/components/Popover/components/Pane/Pane.tsx": { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "name": "PaneProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "fixed", + "value": "boolean", + "description": "Fix the pane to the top of the popover", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "sectioned", + "value": "boolean", + "description": "Automatically wrap children in padded sections", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "The pane content", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx", + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", "syntaxKind": "PropertySignature", - "name": "autofocusTarget", - "value": "PopoverAutofocusTarget", - "description": "", + "name": "height", + "value": "string", + "description": "Sets a fixed height and max-height on the Scrollable", "isOptional": true }, { - "filePath": "polaris-react/src/components/Popover/components/PopoverOverlay/PopoverOverlay.tsx", - "syntaxKind": "PropertySignature", - "name": "preventCloseOnChildOverlayClick", - "value": "boolean", - "description": "", + "filePath": "polaris-react/src/components/Popover/components/Pane/Pane.tsx", + "syntaxKind": "MethodSignature", + "name": "onScrolledToBottom", + "value": "() => void", + "description": "Callback when the bottom of the popover is reached by mouse or keyboard", "isOptional": true } ], - "value": "export interface PopoverOverlayProps {\n children?: React.ReactNode;\n fullWidth?: boolean;\n fullHeight?: boolean;\n fluidContent?: boolean;\n preferredPosition?: PositionedOverlayProps['preferredPosition'];\n preferredAlignment?: PositionedOverlayProps['preferredAlignment'];\n active: boolean;\n id: string;\n zIndexOverride?: number;\n activator: HTMLElement;\n preferInputActivator?: PositionedOverlayProps['preferInputActivator'];\n sectioned?: boolean;\n fixed?: boolean;\n hideOnPrint?: boolean;\n onClose(source: PopoverCloseSource): void;\n autofocusTarget?: PopoverAutofocusTarget;\n preventCloseOnChildOverlayClick?: boolean;\n}" + "value": "export interface PaneProps {\n /** Fix the pane to the top of the popover */\n fixed?: boolean;\n /** Automatically wrap children in padded sections */\n sectioned?: boolean;\n /** The pane content */\n children?: React.ReactNode;\n /** Sets a fixed height and max-height on the Scrollable */\n height?: string;\n /** Callback when the bottom of the popover is reached by mouse or keyboard */\n onScrolledToBottom?(): void;\n}" } }, "PolarisContainerProps": { @@ -26176,44 +26176,93 @@ ] } }, - "PanelProps": { - "polaris-react/src/components/Tabs/components/Panel/Panel.tsx": { - "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", - "name": "PanelProps", + "TabProps": { + "polaris-react/src/components/Tabs/components/Tab/Tab.tsx": { + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "name": "TabProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", "syntaxKind": "PropertySignature", - "name": "hidden", + "name": "id", + "value": "string", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "syntaxKind": "PropertySignature", + "name": "focused", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "" + "name": "siblingTabHasFocus", + "value": "boolean", + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", "syntaxKind": "PropertySignature", - "name": "tabID", + "name": "selected", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "syntaxKind": "PropertySignature", + "name": "panelID", "value": "string", - "description": "" + "description": "", + "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", "description": "", "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "syntaxKind": "PropertySignature", + "name": "url", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "syntaxKind": "PropertySignature", + "name": "measuring", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "syntaxKind": "MethodSignature", + "name": "onClick", + "value": "(id: string) => void", + "description": "", + "isOptional": true } ], - "value": "export interface PanelProps {\n hidden?: boolean;\n id: string;\n tabID: string;\n children?: React.ReactNode;\n}" + "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": { @@ -26299,93 +26348,44 @@ "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}" } }, - "TabProps": { - "polaris-react/src/components/Tabs/components/Tab/Tab.tsx": { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", - "name": "TabProps", + "PanelProps": { + "polaris-react/src/components/Tabs/components/Panel/Panel.tsx": { + "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", + "name": "PanelProps", "description": "", "members": [ { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", - "syntaxKind": "PropertySignature", - "name": "focused", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", "syntaxKind": "PropertySignature", - "name": "siblingTabHasFocus", + "name": "hidden", "value": "boolean", "description": "", "isOptional": true }, { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", "syntaxKind": "PropertySignature", - "name": "selected", - "value": "boolean", - "description": "", - "isOptional": true + "name": "id", + "value": "string", + "description": "" }, { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", "syntaxKind": "PropertySignature", - "name": "panelID", + "name": "tabID", "value": "string", - "description": "", - "isOptional": true + "description": "" }, { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", + "filePath": "polaris-react/src/components/Tabs/components/Panel/Panel.tsx", "syntaxKind": "PropertySignature", "name": "children", "value": "React.ReactNode", "description": "", "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", - "syntaxKind": "PropertySignature", - "name": "url", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", - "syntaxKind": "PropertySignature", - "name": "measuring", - "value": "boolean", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Tabs/components/Tab/Tab.tsx", - "syntaxKind": "MethodSignature", - "name": "onClick", - "value": "(id: string) => void", - "description": "", - "isOptional": true } ], - "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}" + "value": "export interface PanelProps {\n hidden?: boolean;\n id: string;\n tabID: string;\n children?: React.ReactNode;\n}" } }, "ResizerProps": { @@ -26799,39 +26799,6 @@ "value": "export interface DiscardConfirmationModalProps {\n open: boolean;\n onDiscard(): void;\n onCancel(): void;\n}" } }, - "SecondaryProps": { - "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx": { - "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", - "name": "SecondaryProps", - "description": "", - "members": [ - { - "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", - "syntaxKind": "PropertySignature", - "name": "expanded", - "value": "boolean", - "description": "" - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "React.ReactNode", - "description": "", - "isOptional": true - }, - { - "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "", - "isOptional": true - } - ], - "value": "interface SecondaryProps {\n expanded: boolean;\n children?: React.ReactNode;\n id?: string;\n}" - } - }, "TitleProps": { "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx": { "filePath": "polaris-react/src/components/Page/components/Header/components/Title/Title.tsx", @@ -26919,5 +26886,38 @@ ], "value": "export interface MessageProps {\n title: string;\n description: string;\n action: {onClick(): void; content: string};\n link: {to: string; content: string};\n badge?: {content: string; status: BadgeProps['status']};\n}" } + }, + "SecondaryProps": { + "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx": { + "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "name": "SecondaryProps", + "description": "", + "members": [ + { + "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "syntaxKind": "PropertySignature", + "name": "expanded", + "value": "boolean", + "description": "" + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "React.ReactNode", + "description": "", + "isOptional": true + }, + { + "filePath": "polaris-react/src/components/Navigation/components/Item/components/Secondary/Secondary.tsx", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "interface SecondaryProps {\n expanded: boolean;\n children?: React.ReactNode;\n id?: string;\n}" + } } } \ No newline at end of file From ae5401cc3ef4a2663e7d5ba549e109ac84455bfb Mon Sep 17 00:00:00 2001 From: aveline Date: Mon, 3 Oct 2022 10:51:35 -0700 Subject: [PATCH 22/25] Rename `AlphaCard` shadow prop (#7325) ### WHY are these changes introduced? Rename shadow prop for consistency with `Box` component --- .changeset/selfish-poets-lick.md | 6 ++++++ .../src/components/AlphaCard/AlphaCard.stories.tsx | 2 +- polaris-react/src/components/AlphaCard/AlphaCard.tsx | 11 ++++------- .../pages/examples/alpha-card-flat.tsx | 2 +- 4 files changed, 12 insertions(+), 9 deletions(-) create mode 100644 .changeset/selfish-poets-lick.md diff --git a/.changeset/selfish-poets-lick.md b/.changeset/selfish-poets-lick.md new file mode 100644 index 00000000000..54639f11916 --- /dev/null +++ b/.changeset/selfish-poets-lick.md @@ -0,0 +1,6 @@ +--- +'@shopify/polaris': patch +'polaris.shopify.com': patch +--- + +Renamed `AlphaCard` `shadow` prop diff --git a/polaris-react/src/components/AlphaCard/AlphaCard.stories.tsx b/polaris-react/src/components/AlphaCard/AlphaCard.stories.tsx index 562c4778dfd..fe520a0066c 100644 --- a/polaris-react/src/components/AlphaCard/AlphaCard.stories.tsx +++ b/polaris-react/src/components/AlphaCard/AlphaCard.stories.tsx @@ -60,7 +60,7 @@ export function BorderRadiusRoundedAbove() { export function Flat() { return ( - + Online store dashboard diff --git a/polaris-react/src/components/AlphaCard/AlphaCard.tsx b/polaris-react/src/components/AlphaCard/AlphaCard.tsx index d632ff46362..543c2f04a94 100644 --- a/polaris-react/src/components/AlphaCard/AlphaCard.tsx +++ b/polaris-react/src/components/AlphaCard/AlphaCard.tsx @@ -10,10 +10,7 @@ import React from 'react'; import {useBreakpoints} from '../../utilities/breakpoints'; import {Box} from '../Box'; -type CardElevationTokensScale = Extract< - DepthShadowAlias, - 'card' | 'transparent' ->; +type CardShadowTokensScale = Extract; type CardBackgroundColorTokenScale = Extract< ColorsTokenName, @@ -25,7 +22,7 @@ export interface AlphaCardProps { children?: React.ReactNode; background?: CardBackgroundColorTokenScale; hasBorderRadius?: boolean; - elevation?: CardElevationTokensScale; + shadow?: CardShadowTokensScale; padding?: SpacingSpaceScale; roundedAbove?: BreakpointsAlias; } @@ -34,7 +31,7 @@ export const AlphaCard = ({ children, background = 'surface', hasBorderRadius: hasBorderRadiusProp = true, - elevation = 'card', + shadow = 'card', padding = '5', roundedAbove, }: AlphaCardProps) => { @@ -51,7 +48,7 @@ export const AlphaCard = ({ {children} diff --git a/polaris.shopify.com/pages/examples/alpha-card-flat.tsx b/polaris.shopify.com/pages/examples/alpha-card-flat.tsx index 187e81b8eba..f238a025e3b 100644 --- a/polaris.shopify.com/pages/examples/alpha-card-flat.tsx +++ b/polaris.shopify.com/pages/examples/alpha-card-flat.tsx @@ -4,7 +4,7 @@ import {withPolarisExample} from '../../src/components/PolarisExampleWrapper'; function AlphaCardExample() { return ( - + Online store dashboard From 2fcdfa5a5315c6fdc6169474ced69243b90517bb Mon Sep 17 00:00:00 2001 From: aveline Date: Mon, 3 Oct 2022 13:50:32 -0700 Subject: [PATCH 23/25] Columns spacing (#7326) ### WHY are these changes introduced? Rename `gap` to `spacing` for consistency with other components --- .changeset/few-ghosts-carry.md | 6 +++++ .../src/components/Columns/Columns.scss | 20 +++++++------- .../components/Columns/Columns.stories.tsx | 10 +++---- .../src/components/Columns/Columns.tsx | 26 +++++++++++++------ .../components/Columns/tests/Columns.test.tsx | 6 +++-- .../content/components/columns/index.md | 4 +-- .../pages/examples/columns-default.tsx | 2 +- .../columns-with-free-and-fixed-widths.tsx | 2 +- ...p.tsx => columns-with-varying-spacing.tsx} | 2 +- 9 files changed, 48 insertions(+), 30 deletions(-) create mode 100644 .changeset/few-ghosts-carry.md rename polaris.shopify.com/pages/examples/{columns-with-varying-gap.tsx => columns-with-varying-spacing.tsx} (90%) diff --git a/.changeset/few-ghosts-carry.md b/.changeset/few-ghosts-carry.md new file mode 100644 index 00000000000..bf4a7ecb66e --- /dev/null +++ b/.changeset/few-ghosts-carry.md @@ -0,0 +1,6 @@ +--- +'@shopify/polaris': patch +'polaris.shopify.com': patch +--- + +Renamed `Columns` spacing diff --git a/polaris-react/src/components/Columns/Columns.scss b/polaris-react/src/components/Columns/Columns.scss index 25556b65338..574457e78e3 100644 --- a/polaris-react/src/components/Columns/Columns.scss +++ b/polaris-react/src/components/Columns/Columns.scss @@ -6,32 +6,32 @@ --pc-columns-md: var(--pc-columns-sm); --pc-columns-lg: var(--pc-columns-md); --pc-columns-xl: var(--pc-columns-lg); - --pc-columns-gap-xs: var(--p-space-4); - --pc-columns-gap-sm: var(--pc-columns-gap-xs); - --pc-columns-gap-md: var(--pc-columns-gap-sm); - --pc-columns-gap-lg: var(--pc-columns-gap-md); - --pc-columns-gap-xl: var(--pc-columns-gap-lg); + --pc-columns-space-xs: var(--p-space-4); + --pc-columns-space-sm: var(--pc-columns-space-xs); + --pc-columns-space-md: var(--pc-columns-space-sm); + --pc-columns-space-lg: var(--pc-columns-space-md); + --pc-columns-space-xl: var(--pc-columns-space-lg); display: grid; - gap: var(--pc-columns-gap-xs); + gap: var(--pc-columns-space-xs); grid-template-columns: var(--pc-columns-xs); @media #{$p-breakpoints-sm-up} { - gap: var(--pc-columns-gap-sm); + gap: var(--pc-columns-space-sm); grid-template-columns: var(--pc-columns-sm); } @media #{$p-breakpoints-md-up} { - gap: var(--pc-columns-gap-md); + gap: var(--pc-columns-space-md); grid-template-columns: var(--pc-columns-md); } @media #{$p-breakpoints-lg-up} { - gap: var(--pc-columns-gap-lg); + gap: var(--pc-columns-space-lg); grid-template-columns: var(--pc-columns-lg); } @media #{$p-breakpoints-xl-up} { - gap: var(--pc-columns-gap-xl); + gap: var(--pc-columns-space-xl); grid-template-columns: var(--pc-columns-xl); } } diff --git a/polaris-react/src/components/Columns/Columns.stories.tsx b/polaris-react/src/components/Columns/Columns.stories.tsx index 15a126ccc21..f0577f48630 100644 --- a/polaris-react/src/components/Columns/Columns.stories.tsx +++ b/polaris-react/src/components/Columns/Columns.stories.tsx @@ -10,7 +10,7 @@ export default { export function BasicColumns() { return ( - +
one
two
three
@@ -32,7 +32,7 @@ export function ColumnsWithTemplateColumns() { md: '1fr 3fr auto 1fr', lg: '1fr 4fr auto 2fr 3fr auto', }} - gap={{xs: '4'}} + spacing={{xs: '4'}} >
Column one
Column two
@@ -50,7 +50,7 @@ export function ColumnsWithMixedPropTypes() {
one
two
@@ -68,7 +68,7 @@ export function ColumnsWithVaryingGap() {
Column one
Column two
@@ -81,7 +81,7 @@ export function ColumnsWithVaryingGap() { export function ColumnsWithFreeAndFixedWidths() { return ( - +
Column one