From b097948828f569b5aa7a96162a7a2e61d361d2dc Mon Sep 17 00:00:00 2001 From: marcelovicentegc Date: Thu, 23 Nov 2023 14:47:52 -0300 Subject: [PATCH] docs: generate sandbox --- package.json | 3 +- packages/components/src/button/button.tsx | 2 +- packages/next-docs/package.json | 1 + .../next-docs/pages/components/_meta.json | 1 - .../pages/components/action/code.mdx | 31 +- .../pages/components/action/props.mdx | 82 +++ .../next-docs/pages/components/alert/code.mdx | 33 +- .../pages/components/alert/props.mdx | 13 +- .../next-docs/pages/components/bleed/code.mdx | 6 +- .../pages/components/bleed/props.mdx | 23 +- .../pages/components/button/code.mdx | 31 +- .../pages/components/button/props.mdx | 22 +- .../pages/components/center-props/code.mdx | 7 - .../pages/components/center/code.mdx | 6 +- .../pages/components/center/props.mdx | 2 +- .../pages/components/checkbox-field/code.mdx | 31 +- .../pages/components/checkbox-field/props.mdx | 20 +- .../pages/components/checkbox-group/code.mdx | 6 +- .../pages/components/checkbox-group/props.mdx | 20 +- .../pages/components/checkbox/code.mdx | 31 +- .../pages/components/checkbox/props.mdx | 14 +- .../components/clickable-bubble/code.mdx | 33 +- .../components/clickable-bubble/props.mdx | 8 +- .../pages/components/clickable/code.mdx | 31 +- .../pages/components/clickable/props.mdx | 8 +- .../pages/components/combobox-item/code.mdx | 6 +- .../pages/components/combobox-item/props.mdx | 8 +- .../pages/components/combobox-list/code.mdx | 6 +- .../pages/components/combobox-list/props.mdx | 8 +- .../components/combobox-popover/code.mdx | 6 +- .../components/combobox-popover/props.mdx | 8 +- .../components/combobox-provider/code.mdx | 36 -- .../pages/components/combobox/code.mdx | 6 +- .../pages/components/combobox/props.mdx | 8 +- .../pages/components/composable/code.mdx | 34 +- .../pages/components/composable/props.mdx | 11 +- .../pages/components/compose/code.mdx | 31 +- .../pages/components/compose/props.mdx | 10 +- .../pages/components/container/code.mdx | 32 +- .../pages/components/container/props.mdx | 8 +- .../pages/components/content/code.mdx | 32 +- .../pages/components/content/props.mdx | 11 +- .../pages/components/field-label/code.mdx | 6 +- .../pages/components/field-label/props.mdx | 11 +- .../pages/components/field-message/code.mdx | 6 +- .../pages/components/field-message/props.mdx | 14 +- .../next-docs/pages/components/field/code.mdx | 6 +- .../pages/components/field/props.mdx | 8 +- .../components/filter-apply-props/code.mdx | 7 - .../pages/components/filter-apply/code.mdx | 31 +- .../pages/components/filter-apply/props.mdx | 2 +- .../components/filter-clear-props/code.mdx | 7 - .../pages/components/filter-clear/code.mdx | 31 +- .../pages/components/filter-clear/props.mdx | 2 +- .../components/filter-list-props/code.mdx | 7 - .../pages/components/filter-list/code.mdx | 34 +- .../pages/components/filter-list/props.mdx | 4 +- .../components/filter-option-props/code.mdx | 7 - .../pages/components/filter-option/code.mdx | 32 +- .../pages/components/filter-option/props.mdx | 4 +- .../pages/components/filter-popover/code.mdx | 32 +- .../pages/components/filter-popover/props.mdx | 11 +- .../pages/components/filter-provider/code.mdx | 35 +- .../components/filter-provider/props.mdx | 35 +- .../components/filter-trigger-props/code.mdx | 7 - .../pages/components/filter-trigger/code.mdx | 32 +- .../pages/components/filter-trigger/props.mdx | 2 +- .../components/filter-value-props/code.mdx | 7 - .../pages/components/filter-value/code.mdx | 6 +- .../pages/components/filter-value/props.mdx | 2 +- .../pages/components/filter/code.mdx | 32 +- .../pages/components/filter/props.mdx | 35 +- .../pages/components/flex-props/code.mdx | 7 - .../next-docs/pages/components/flex/code.mdx | 6 +- .../next-docs/pages/components/flex/props.mdx | 2 +- .../pages/components/grid-cell-props/code.mdx | 7 - .../pages/components/grid-cell/code.mdx | 6 +- .../pages/components/grid-cell/props.mdx | 2 +- .../pages/components/grid-props/code.mdx | 7 - .../next-docs/pages/components/grid/code.mdx | 6 +- .../next-docs/pages/components/grid/props.mdx | 2 +- .../pages/components/icon-button/code.mdx | 32 +- .../pages/components/icon-button/props.mdx | 25 +- .../pages/components/interfaces/code.mdx | 196 ------- .../pages/components/link-box/code.mdx | 31 +- .../pages/components/link-box/props.mdx | 16 +- .../next-docs/pages/components/link/code.mdx | 31 +- .../next-docs/pages/components/link/props.mdx | 8 +- .../pages/components/locale-provider/code.mdx | 33 +- .../components/locale-provider/props.mdx | 11 +- .../pages/components/menu-item/code.mdx | 6 +- .../pages/components/menu-item/props.mdx | 14 +- .../pages/components/menu-provider/code.mdx | 57 --- .../components/menu-separator-props/code.mdx | 7 - .../pages/components/menu-separator/code.mdx | 6 +- .../pages/components/menu-separator/props.mdx | 2 +- .../pages/components/menu-trigger/code.mdx | 6 +- .../next-docs/pages/components/menu/code.mdx | 6 +- .../next-docs/pages/components/menu/props.mdx | 8 +- .../components/modal-header-props/code.mdx | 7 - .../pages/components/modal-header/code.mdx | 6 +- .../pages/components/modal-header/props.mdx | 2 +- .../next-docs/pages/components/modal/code.mdx | 6 +- .../pages/components/modal/props.mdx | 19 +- .../pages/components/pagination/code.mdx | 31 +- .../pages/components/pagination/props.mdx | 23 +- .../pages/components/popover-dismiss/code.mdx | 33 +- .../components/popover-dismiss/props.mdx | 8 +- .../components/popover-provider/code.mdx | 32 -- .../pages/components/popover-trigger/code.mdx | 33 +- .../components/popover-trigger/props.mdx | 8 +- .../pages/components/popover/code.mdx | 33 +- .../pages/components/popover/props.mdx | 8 +- .../pages/components/radio-group/code.mdx | 6 +- .../pages/components/radio-group/props.mdx | 26 +- .../next-docs/pages/components/radio/code.mdx | 6 +- .../pages/components/radio/props.mdx | 11 +- .../pages/components/scroll-area/code.mdx | 31 +- .../pages/components/scroll-area/props.mdx | 11 +- .../pages/components/search/code.mdx | 6 +- .../pages/components/search/props.mdx | 11 +- .../pages/components/select-field/code.mdx | 31 +- .../pages/components/select-field/props.mdx | 23 +- .../pages/components/select-list/code.mdx | 6 +- .../pages/components/select-list/props.mdx | 11 +- .../components/select-option-check/code.mdx | 6 +- .../components/select-option-check/props.mdx | 8 +- .../pages/components/select-option/code.mdx | 6 +- .../pages/components/select-option/props.mdx | 14 +- .../pages/components/select-popover/code.mdx | 6 +- .../pages/components/select-popover/props.mdx | 8 +- .../pages/components/select-provider/code.mdx | 58 --- .../pages/components/select/code.mdx | 6 +- .../pages/components/select/props.mdx | 8 +- .../pages/components/simple-table/code.mdx | 31 +- .../pages/components/simple-table/props.mdx | 38 +- .../pages/components/skeleton/code.mdx | 6 +- .../pages/components/skeleton/props.mdx | 8 +- .../pages/components/spinner/code.mdx | 31 +- .../pages/components/spinner/props.mdx | 11 +- .../next-docs/pages/components/stack/code.mdx | 6 +- .../pages/components/stack/props.mdx | 17 +- .../pages/components/tab-list/code.mdx | 36 +- .../pages/components/tab-list/props.mdx | 8 +- .../pages/components/tab-panel/code.mdx | 36 +- .../pages/components/tab-panel/props.mdx | 11 +- .../pages/components/tab-provider/code.mdx | 36 -- .../pages/components/tab-provider/props.mdx | 482 ------------------ .../next-docs/pages/components/tab/code.mdx | 36 +- .../next-docs/pages/components/tab/props.mdx | 8 +- .../pages/components/table-body/code.mdx | 6 +- .../pages/components/table-body/props.mdx | 8 +- .../pages/components/table-cell/code.mdx | 6 +- .../pages/components/table-cell/props.mdx | 8 +- .../components/table-header-cell/code.mdx | 6 +- .../components/table-header-cell/props.mdx | 11 +- .../pages/components/table-header/code.mdx | 6 +- .../pages/components/table-header/props.mdx | 8 +- .../pages/components/table-row/code.mdx | 6 +- .../pages/components/table-row/props.mdx | 17 +- .../next-docs/pages/components/table/code.mdx | 6 +- .../pages/components/table/props.mdx | 20 +- .../next-docs/pages/components/tag/code.mdx | 6 +- .../next-docs/pages/components/tag/props.mdx | 14 +- .../pages/components/text-input/code.mdx | 6 +- .../pages/components/text-input/props.mdx | 28 +- .../pages/components/text-props/code.mdx | 47 -- .../next-docs/pages/components/text/code.mdx | 10 +- .../next-docs/pages/components/text/props.mdx | 10 +- .../pages/components/textarea/code.mdx | 6 +- .../pages/components/textarea/props.mdx | 17 +- .../components/textinput/best-practices.mdx | 90 ---- .../pages/components/tooltip-anchor/code.mdx | 32 +- .../pages/components/tooltip-anchor/props.mdx | 8 +- .../pages/components/tooltip-arrow/code.mdx | 33 +- .../pages/components/tooltip-arrow/props.mdx | 8 +- .../pages/components/tooltip-popover/code.mdx | 32 +- .../components/tooltip-popover/props.mdx | 11 +- .../components/tooltip-provider/code.mdx | 32 -- .../components/tooltip-provider/props.mdx | 374 -------------- .../pages/components/tooltip/code.mdx | 31 +- .../pages/components/tooltip/props.mdx | 8 +- .../pages/components/visually-hidden/code.mdx | 31 +- .../components/visually-hidden/props.mdx | 8 +- .../pages/hooks/use-filter-context/code.mdx | 2 +- .../next-docs/pages/hooks/use-locale/code.mdx | 2 +- .../pages/hooks/use-popover-context/code.mdx | 27 - .../pages/hooks/use-popover-store/code.mdx | 31 -- .../pages/hooks/use-radio-state/code.mdx | 2 +- .../pages/hooks/use-select-context/code.mdx | 27 - .../pages/hooks/use-select-store/code.mdx | 56 -- pnpm-lock.yaml | 14 + scripts/typedoc-to-nextra.js | 111 +++- typedoc.json | 1 + 194 files changed, 1636 insertions(+), 2657 deletions(-) create mode 100644 packages/next-docs/pages/components/action/props.mdx delete mode 100644 packages/next-docs/pages/components/center-props/code.mdx delete mode 100644 packages/next-docs/pages/components/combobox-provider/code.mdx delete mode 100644 packages/next-docs/pages/components/filter-apply-props/code.mdx delete mode 100644 packages/next-docs/pages/components/filter-clear-props/code.mdx delete mode 100644 packages/next-docs/pages/components/filter-list-props/code.mdx delete mode 100644 packages/next-docs/pages/components/filter-option-props/code.mdx delete mode 100644 packages/next-docs/pages/components/filter-trigger-props/code.mdx delete mode 100644 packages/next-docs/pages/components/filter-value-props/code.mdx delete mode 100644 packages/next-docs/pages/components/flex-props/code.mdx delete mode 100644 packages/next-docs/pages/components/grid-cell-props/code.mdx delete mode 100644 packages/next-docs/pages/components/grid-props/code.mdx delete mode 100644 packages/next-docs/pages/components/interfaces/code.mdx delete mode 100644 packages/next-docs/pages/components/menu-provider/code.mdx delete mode 100644 packages/next-docs/pages/components/menu-separator-props/code.mdx delete mode 100644 packages/next-docs/pages/components/modal-header-props/code.mdx delete mode 100644 packages/next-docs/pages/components/popover-provider/code.mdx delete mode 100644 packages/next-docs/pages/components/select-provider/code.mdx delete mode 100644 packages/next-docs/pages/components/tab-provider/code.mdx delete mode 100644 packages/next-docs/pages/components/tab-provider/props.mdx delete mode 100644 packages/next-docs/pages/components/text-props/code.mdx delete mode 100644 packages/next-docs/pages/components/textinput/best-practices.mdx delete mode 100644 packages/next-docs/pages/components/tooltip-provider/code.mdx delete mode 100644 packages/next-docs/pages/components/tooltip-provider/props.mdx delete mode 100644 packages/next-docs/pages/hooks/use-popover-context/code.mdx delete mode 100644 packages/next-docs/pages/hooks/use-popover-store/code.mdx delete mode 100644 packages/next-docs/pages/hooks/use-select-context/code.mdx delete mode 100644 packages/next-docs/pages/hooks/use-select-store/code.mdx diff --git a/package.json b/package.json index 8cc6a1ce93..3f08c2bb95 100644 --- a/package.json +++ b/package.json @@ -30,7 +30,7 @@ "build:storybook": "pnpm build && pnpm storybook build", "chromatic": "chromatic --exit-zero-on-changes --build-script-name=build:storybook", "docs": "npm --prefix packages/admin-ui-docs run start", - "generate-docs": "typedoc --plugin typedoc-plugin-markdown --hideBreadcrumbs && node scripts/typedoc-to-nextra.js", + "generate-docs": "typedoc --plugin typedoc-plugin-markdown --hideBreadcrumbs --hideInPageTOC --plugin typedoc-plugin-mdn-links && node scripts/typedoc-to-nextra.js", "next-docs": "npm --prefix packages/next-docs run dev", "build:docs": "npm --prefix packages/admin-ui-docs run build-docs", "build:next-docs": "npm --prefix packages/next-docs run build-docs", @@ -132,6 +132,7 @@ "turbo": "1.4.3", "typedoc": "^0.25.3", "typedoc-plugin-markdown": "^3.17.1", + "typedoc-plugin-mdn-links": "^3.1.4", "typescript": "4.9.5", "url-loader": "^4.1.0", "vite": "4.3.9", diff --git a/packages/components/src/button/button.tsx b/packages/components/src/button/button.tsx index 719c0e7121..b4fce0f2c8 100644 --- a/packages/components/src/button/button.tsx +++ b/packages/components/src/button/button.tsx @@ -70,7 +70,7 @@ export interface ButtonProps extends ComponentPropsWithoutRef<'button'> { children: ReactNode /** * Increase or decrease padding. - * @default normal + * @default 'normal' */ size?: 'normal' | 'large' /** diff --git a/packages/next-docs/package.json b/packages/next-docs/package.json index 6182d1c028..1fda7a8a45 100644 --- a/packages/next-docs/package.json +++ b/packages/next-docs/package.json @@ -13,6 +13,7 @@ "@vtex/shoreline-preset-admin": "workspace:*", "@vtex/shoreline-icons": "workspace:*", "@vtex/shoreline-utils": "workspace:*", + "@vtex/shoreline-components": "workspace:*", "next": "13.4.7", "nextra": "2.10.0", "nextra-theme-docs": "2.10.0", diff --git a/packages/next-docs/pages/components/_meta.json b/packages/next-docs/pages/components/_meta.json index 134ac23309..82d4f2d6a2 100644 --- a/packages/next-docs/pages/components/_meta.json +++ b/packages/next-docs/pages/components/_meta.json @@ -1,5 +1,4 @@ { - "interfaces": "Interfaces", "action": "Action", "alert": "Alert", "bleed": "Bleed", diff --git a/packages/next-docs/pages/components/action/code.mdx b/packages/next-docs/pages/components/action/code.mdx index fa1aad836d..fd8e69ca5f 100644 --- a/packages/next-docs/pages/components/action/code.mdx +++ b/packages/next-docs/pages/components/action/code.mdx @@ -6,9 +6,9 @@ Specific button used for contextual actions #### Parameters -| Name | Type | -| :------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `props` | `Omit`\<[`ButtonProps`](interfaces/ButtonProps.md), `"variant"`\> & \{ `iconOnly?`: `boolean` ; `label?`: `ReactNode` ; `vertical?`: `boolean` } & `RefAttributes`\<`HTMLButtonElement`\> | +| Name | Type | +| :------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`Omit`](https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys)\<[`ButtonProps`](interfaces/ButtonProps.md), `"variant"`\> & \{ `iconOnly?`: `boolean` ; `label?`: `ReactNode` ; `vertical?`: `boolean` } & `RefAttributes`\<[`HTMLButtonElement`](https://developer.mozilla.org/docs/Web/API/HTMLButtonElement)\> | #### Returns @@ -16,10 +16,33 @@ Specific button used for contextual actions **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx Label ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + +Label)}`, + }} + +> + + + + + + + #### Defined in node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355 diff --git a/packages/next-docs/pages/components/action/props.mdx b/packages/next-docs/pages/components/action/props.mdx new file mode 100644 index 0000000000..c98acaee10 --- /dev/null +++ b/packages/next-docs/pages/components/action/props.mdx @@ -0,0 +1,82 @@ +# shoreline + +## Interfaces + +- [AccessibleIconProps](interfaces/AccessibleIconProps.md) +- [AlertProps](interfaces/AlertProps.md) +- [BleedProps](interfaces/BleedProps.md) +- [ButtonProps](interfaces/ButtonProps.md) +- [CheckboxFieldProps](interfaces/CheckboxFieldProps.md) +- [CheckboxGroupProps](interfaces/CheckboxGroupProps.md) +- [CheckboxProps](interfaces/CheckboxProps.md) +- [ClickableBubbleProps](interfaces/ClickableBubbleProps.md) +- [ClickableProps](interfaces/ClickableProps.md) +- [ComboboxItemProps](interfaces/ComboboxItemProps.md) +- [ComboboxListProps](interfaces/ComboboxListProps.md) +- [ComboboxPopoverProps](interfaces/ComboboxPopoverProps.md) +- [ComboboxProps](interfaces/ComboboxProps.md) +- [ComposableProps](interfaces/ComposableProps.md) +- [ComposeProps](interfaces/ComposeProps.md) +- [ContainerProps](interfaces/ContainerProps.md) +- [ContentProps](interfaces/ContentProps.md) +- [FieldLabelProps](interfaces/FieldLabelProps.md) +- [FieldMessageProps](interfaces/FieldMessageProps.md) +- [FieldProps](interfaces/FieldProps.md) +- [FilterPopoverProps](interfaces/FilterPopoverProps.md) +- [FilterProps](interfaces/FilterProps.md) +- [FilterProviderProps](interfaces/FilterProviderProps.md) +- [GridCellShorthandProps](interfaces/GridCellShorthandProps.md) +- [GridShorthandProps](interfaces/GridShorthandProps.md) +- [IconButtonProps](interfaces/IconButtonProps.md) +- [LinkBoxProps](interfaces/LinkBoxProps.md) +- [LinkProps](interfaces/LinkProps.md) +- [LocaleProviderProps](interfaces/LocaleProviderProps.md) +- [MenuItemProps](interfaces/MenuItemProps.md) +- [MenuProps](interfaces/MenuProps.md) +- [ModalProps](interfaces/ModalProps.md) +- [PaginationProps](interfaces/PaginationProps.md) +- [PopoverDismissProps](interfaces/PopoverDismissProps.md) +- [PopoverProps](interfaces/PopoverProps.md) +- [PopoverTriggerProps](interfaces/PopoverTriggerProps.md) +- [RadioGroupProps](interfaces/RadioGroupProps.md) +- [RadioGroupState](interfaces/RadioGroupState.md) +- [RadioProps](interfaces/RadioProps.md) +- [ScrollAreaProps](interfaces/ScrollAreaProps.md) +- [SearchProps](interfaces/SearchProps.md) +- [SelectFieldProps](interfaces/SelectFieldProps.md) +- [SelectListProps](interfaces/SelectListProps.md) +- [SelectOptionCheckProps](interfaces/SelectOptionCheckProps.md) +- [SelectOptionProps](interfaces/SelectOptionProps.md) +- [SelectPopoverProps](interfaces/SelectPopoverProps.md) +- [SelectProps](interfaces/SelectProps.md) +- [SimpleTableProps](interfaces/SimpleTableProps.md) +- [SkeletonProps](interfaces/SkeletonProps.md) +- [SpinnerProps](interfaces/SpinnerProps.md) +- [StackProps](interfaces/StackProps.md) +- [TabListProps](interfaces/TabListProps.md) +- [TabPanelProps](interfaces/TabPanelProps.md) +- [TabProps](interfaces/TabProps.md) +- [TableBodyProps](interfaces/TableBodyProps.md) +- [TableCellProps](interfaces/TableCellProps.md) +- [TableHeaderCellProps](interfaces/TableHeaderCellProps.md) +- [TableHeaderProps](interfaces/TableHeaderProps.md) +- [TableProps](interfaces/TableProps.md) +- [TableRowProps](interfaces/TableRowProps.md) +- [TagProps](interfaces/TagProps.md) +- [TextInputProps](interfaces/TextInputProps.md) +- [TextareaProps](interfaces/TextareaProps.md) +- [TooltipAnchorProps](interfaces/TooltipAnchorProps.md) +- [TooltipArrowProps](interfaces/TooltipArrowProps.md) +- [TooltipPopoverProps](interfaces/TooltipPopoverProps.md) +- [TooltipProps](interfaces/TooltipProps.md) +- [VisuallyHiddenProps](interfaces/VisuallyHiddenProps.md) + +## Type Aliases + +### ActionProps + +Ƭ **ActionProps**: [`Omit`](https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys)\<[`ButtonProps`](interfaces/ButtonProps.md), `"variant"`\> & \{ `iconOnly?`: `boolean` ; `label?`: `ReactNode` ; `vertical?`: `boolean` } + +#### Defined in + +[packages/components/src/action/action.tsx:34](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/action/action.tsx#L34) diff --git a/packages/next-docs/pages/components/alert/code.mdx b/packages/next-docs/pages/components/alert/code.mdx index f58809b6de..95f8dc284b 100644 --- a/packages/next-docs/pages/components/alert/code.mdx +++ b/packages/next-docs/pages/components/alert/code.mdx @@ -6,9 +6,9 @@ Alert indicators allow users to view semantic messages that are prominent and ca #### Parameters -| Name | Type | -| :------ | :----------------------------------------------------------------------------- | -| `props` | [`AlertProps`](interfaces/AlertProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :-------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`AlertProps`](props.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns @@ -16,13 +16,38 @@ Alert indicators allow users to view semantic messages that are prominent and ca **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx {}}> Message Action ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + + {}}> Message Action)}`, +}} + +> + + + + + + + #### Defined in node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355 diff --git a/packages/next-docs/pages/components/alert/props.mdx b/packages/next-docs/pages/components/alert/props.mdx index a6e6c1ad57..ef2909b613 100644 --- a/packages/next-docs/pages/components/alert/props.mdx +++ b/packages/next-docs/pages/components/alert/props.mdx @@ -6,22 +6,15 @@ ↳ **`AlertProps`** -## Table of contents - -### Properties - -- [onDismiss](props.md#ondismiss) -- [variant](props.md#variant) - ## Properties ### onDismiss -• `Optional` **onDismiss**: `MouseEventHandler`\<`HTMLButtonElement`\> +• `Optional` **onDismiss**: `MouseEventHandler`\<[`HTMLButtonElement`](https://developer.mozilla.org/docs/Web/API/HTMLButtonElement)\> #### Defined in -[packages/components/src/alert/alert.tsx:74](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/alert/alert.tsx#L74) +[packages/components/src/alert/alert.tsx:74](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/alert/alert.tsx#L74) --- @@ -31,4 +24,4 @@ #### Defined in -[packages/components/src/alert/alert.tsx:73](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/alert/alert.tsx#L73) +[packages/components/src/alert/alert.tsx:73](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/alert/alert.tsx#L73) diff --git a/packages/next-docs/pages/components/bleed/code.mdx b/packages/next-docs/pages/components/bleed/code.mdx index a27bb03f11..6f1bf106da 100644 --- a/packages/next-docs/pages/components/bleed/code.mdx +++ b/packages/next-docs/pages/components/bleed/code.mdx @@ -6,9 +6,9 @@ #### Parameters -| Name | Type | -| :------ | :----------------------------------------------------------------------------- | -| `props` | [`BleedProps`](interfaces/BleedProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :-------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`BleedProps`](props.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/bleed/props.mdx b/packages/next-docs/pages/components/bleed/props.mdx index a85eb82cda..7bdb91b7c6 100644 --- a/packages/next-docs/pages/components/bleed/props.mdx +++ b/packages/next-docs/pages/components/bleed/props.mdx @@ -6,17 +6,6 @@ ↳ **`BleedProps`** -## Table of contents - -### Properties - -- [bottom](props.md#bottom) -- [horizontal](props.md#horizontal) -- [left](props.md#left) -- [right](props.md#right) -- [top](props.md#top) -- [vertical](props.md#vertical) - ## Properties ### bottom @@ -33,7 +22,7 @@ Bottom bleed #### Defined in -[packages/components/src/bleed/bleed.tsx:68](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/bleed/bleed.tsx#L68) +[packages/components/src/bleed/bleed.tsx:68](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/bleed/bleed.tsx#L68) --- @@ -51,7 +40,7 @@ Horizontal bleed #### Defined in -[packages/components/src/bleed/bleed.tsx:83](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/bleed/bleed.tsx#L83) +[packages/components/src/bleed/bleed.tsx:83](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/bleed/bleed.tsx#L83) --- @@ -69,7 +58,7 @@ Left bleed #### Defined in -[packages/components/src/bleed/bleed.tsx:73](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/bleed/bleed.tsx#L73) +[packages/components/src/bleed/bleed.tsx:73](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/bleed/bleed.tsx#L73) --- @@ -87,7 +76,7 @@ Right bleed #### Defined in -[packages/components/src/bleed/bleed.tsx:78](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/bleed/bleed.tsx#L78) +[packages/components/src/bleed/bleed.tsx:78](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/bleed/bleed.tsx#L78) --- @@ -105,7 +94,7 @@ Top bleed #### Defined in -[packages/components/src/bleed/bleed.tsx:63](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/bleed/bleed.tsx#L63) +[packages/components/src/bleed/bleed.tsx:63](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/bleed/bleed.tsx#L63) --- @@ -123,4 +112,4 @@ Vertical bleed #### Defined in -[packages/components/src/bleed/bleed.tsx:88](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/bleed/bleed.tsx#L88) +[packages/components/src/bleed/bleed.tsx:88](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/bleed/bleed.tsx#L88) diff --git a/packages/next-docs/pages/components/button/code.mdx b/packages/next-docs/pages/components/button/code.mdx index 6f5402ff37..288d6a504d 100644 --- a/packages/next-docs/pages/components/button/code.mdx +++ b/packages/next-docs/pages/components/button/code.mdx @@ -6,9 +6,9 @@ Buttons triggers allow users to identify and start the most important actions in #### Parameters -| Name | Type | -| :------ | :---------------------------------------------------------------------------------- | -| `props` | [`ButtonProps`](interfaces/ButtonProps.md) & `RefAttributes`\<`HTMLButtonElement`\> | +| Name | Type | +| :------ | :--------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`ButtonProps`](props.md) & `RefAttributes`\<[`HTMLButtonElement`](https://developer.mozilla.org/docs/Web/API/HTMLButtonElement)\> | #### Returns @@ -16,10 +16,33 @@ Buttons triggers allow users to identify and start the most important actions in **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + +)}`, + }} + +> + + + + + + + #### Defined in node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355 diff --git a/packages/next-docs/pages/components/button/props.mdx b/packages/next-docs/pages/components/button/props.mdx index e87ca41c6c..c203ac0dfd 100644 --- a/packages/next-docs/pages/components/button/props.mdx +++ b/packages/next-docs/pages/components/button/props.mdx @@ -8,16 +8,6 @@ ↳↳ [`IconButtonProps`](IconButtonProps.md) -## Table of contents - -### Properties - -- [asChild](props.md#aschild) -- [children](props.md#children) -- [loading](props.md#loading) -- [size](props.md#size) -- [variant](props.md#variant) - ## Properties ### asChild @@ -34,7 +24,7 @@ false; #### Defined in -[packages/components/src/button/button.tsx:95](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/button/button.tsx#L95) +[packages/components/src/button/button.tsx:95](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/button/button.tsx#L95) --- @@ -48,7 +38,7 @@ ComponentPropsWithoutRef.children #### Defined in -[packages/components/src/button/button.tsx:70](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/button/button.tsx#L70) +[packages/components/src/button/button.tsx:70](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/button/button.tsx#L70) --- @@ -66,7 +56,7 @@ false; #### Defined in -[packages/components/src/button/button.tsx:90](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/button/button.tsx#L90) +[packages/components/src/button/button.tsx:90](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/button/button.tsx#L90) --- @@ -79,12 +69,12 @@ Increase or decrease padding. **`Default`** ```ts -normal; +"normal"; ``` #### Defined in -[packages/components/src/button/button.tsx:75](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/button/button.tsx#L75) +[packages/components/src/button/button.tsx:75](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/button/button.tsx#L75) --- @@ -102,4 +92,4 @@ Change between color combinations. #### Defined in -[packages/components/src/button/button.tsx:80](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/button/button.tsx#L80) +[packages/components/src/button/button.tsx:80](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/button/button.tsx#L80) diff --git a/packages/next-docs/pages/components/center-props/code.mdx b/packages/next-docs/pages/components/center-props/code.mdx deleted file mode 100644 index 2a46b864d2..0000000000 --- a/packages/next-docs/pages/components/center-props/code.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### CenterProps - -Ƭ **CenterProps**: `ComponentPropsWithoutRef`\<`"div"`\> - -#### Defined in - -[packages/components/src/center/center.tsx:12](https://github.com/vtex/shoreline/blob/dd054909f/packages/components/src/center/center.tsx#L12) diff --git a/packages/next-docs/pages/components/center/code.mdx b/packages/next-docs/pages/components/center/code.mdx index fcb7a80e64..c6a5158940 100644 --- a/packages/next-docs/pages/components/center/code.mdx +++ b/packages/next-docs/pages/components/center/code.mdx @@ -6,9 +6,9 @@ #### Parameters -| Name | Type | -| :------ | :------------------------------------------------------------------------------------------------------------------------------------- | -| `props` | `Omit`\<`DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>, `HTMLDivElement`\>, `"ref"`\> & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`Omit`](https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys)\<`DetailedHTMLProps`\<`HTMLAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\>, [`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\>, `"ref"`\> & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/center/props.mdx b/packages/next-docs/pages/components/center/props.mdx index 4639415929..2448702bcd 100644 --- a/packages/next-docs/pages/components/center/props.mdx +++ b/packages/next-docs/pages/components/center/props.mdx @@ -4,4 +4,4 @@ #### Defined in -[packages/components/src/center/center.tsx:12](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/center/center.tsx#L12) +[packages/components/src/center/center.tsx:12](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/center/center.tsx#L12) diff --git a/packages/next-docs/pages/components/checkbox-field/code.mdx b/packages/next-docs/pages/components/checkbox-field/code.mdx index 27fa77986d..f9221ee827 100644 --- a/packages/next-docs/pages/components/checkbox-field/code.mdx +++ b/packages/next-docs/pages/components/checkbox-field/code.mdx @@ -6,9 +6,9 @@ Checkbox field with label and help message #### Parameters -| Name | Type | -| :------ | :--------------------------------------------------------------------------------------------- | -| `props` | [`CheckboxFieldProps`](interfaces/CheckboxFieldProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :---------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`CheckboxFieldProps`](props.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns @@ -16,10 +16,33 @@ Checkbox field with label and help message **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx Label ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + +Label)}`, + }} + +> + + + + + + + #### Defined in node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355 diff --git a/packages/next-docs/pages/components/checkbox-field/props.mdx b/packages/next-docs/pages/components/checkbox-field/props.mdx index d31f192b97..b8b6607592 100644 --- a/packages/next-docs/pages/components/checkbox-field/props.mdx +++ b/packages/next-docs/pages/components/checkbox-field/props.mdx @@ -6,16 +6,6 @@ ↳ **`CheckboxFieldProps`** -## Table of contents - -### Properties - -- [error](props.md#error) -- [errorText](props.md#errortext) -- [helpText](props.md#helptext) -- [indeterminate](props.md#indeterminate) -- [value](props.md#value) - ## Properties ### error @@ -32,7 +22,7 @@ false; #### Defined in -[packages/components/src/checkbox/checkbox-field.tsx:52](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/checkbox/checkbox-field.tsx#L52) +[packages/components/src/checkbox/checkbox-field.tsx:52](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/checkbox/checkbox-field.tsx#L52) --- @@ -44,7 +34,7 @@ Error message #### Defined in -[packages/components/src/checkbox/checkbox-field.tsx:56](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/checkbox/checkbox-field.tsx#L56) +[packages/components/src/checkbox/checkbox-field.tsx:56](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/checkbox/checkbox-field.tsx#L56) --- @@ -56,7 +46,7 @@ Help message #### Defined in -[packages/components/src/checkbox/checkbox-field.tsx:60](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/checkbox/checkbox-field.tsx#L60) +[packages/components/src/checkbox/checkbox-field.tsx:60](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/checkbox/checkbox-field.tsx#L60) --- @@ -70,7 +60,7 @@ AriaCheckboxProps.indeterminate #### Defined in -[packages/components/src/checkbox/use-aria-checkbox.ts:87](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/checkbox/use-aria-checkbox.ts#L87) +[packages/components/src/checkbox/use-aria-checkbox.ts:87](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/checkbox/use-aria-checkbox.ts#L87) --- @@ -84,4 +74,4 @@ AriaCheckboxProps.value #### Defined in -[packages/components/src/checkbox/use-aria-checkbox.ts:88](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/checkbox/use-aria-checkbox.ts#L88) +[packages/components/src/checkbox/use-aria-checkbox.ts:88](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/checkbox/use-aria-checkbox.ts#L88) diff --git a/packages/next-docs/pages/components/checkbox-group/code.mdx b/packages/next-docs/pages/components/checkbox-group/code.mdx index f2a0c5f6d3..a2be1f2370 100644 --- a/packages/next-docs/pages/components/checkbox-group/code.mdx +++ b/packages/next-docs/pages/components/checkbox-group/code.mdx @@ -6,9 +6,9 @@ #### Parameters -| Name | Type | -| :------ | :----------------------------------------------------------------------------------------------- | -| `props` | [`CheckboxGroupProps`](interfaces/CheckboxGroupProps.md) & `RefAttributes`\<`HTMLInputElement`\> | +| Name | Type | +| :------ | :-------------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`CheckboxGroupProps`](props.md) & `RefAttributes`\<[`HTMLInputElement`](https://developer.mozilla.org/docs/Web/API/HTMLInputElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/checkbox-group/props.mdx b/packages/next-docs/pages/components/checkbox-group/props.mdx index 53118c02d8..e8e4067a79 100644 --- a/packages/next-docs/pages/components/checkbox-group/props.mdx +++ b/packages/next-docs/pages/components/checkbox-group/props.mdx @@ -6,16 +6,6 @@ ↳ **`CheckboxGroupProps`** -## Table of contents - -### Properties - -- [direction](props.md#direction) -- [error](props.md#error) -- [errorText](props.md#errortext) -- [helpText](props.md#helptext) -- [label](props.md#label) - ## Properties ### direction @@ -24,7 +14,7 @@ #### Defined in -[packages/components/src/checkbox/checkbox-group.tsx:45](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/checkbox/checkbox-group.tsx#L45) +[packages/components/src/checkbox/checkbox-group.tsx:45](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/checkbox/checkbox-group.tsx#L45) --- @@ -34,7 +24,7 @@ #### Defined in -[packages/components/src/checkbox/checkbox-group.tsx:41](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/checkbox/checkbox-group.tsx#L41) +[packages/components/src/checkbox/checkbox-group.tsx:41](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/checkbox/checkbox-group.tsx#L41) --- @@ -44,7 +34,7 @@ #### Defined in -[packages/components/src/checkbox/checkbox-group.tsx:43](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/checkbox/checkbox-group.tsx#L43) +[packages/components/src/checkbox/checkbox-group.tsx:43](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/checkbox/checkbox-group.tsx#L43) --- @@ -54,7 +44,7 @@ #### Defined in -[packages/components/src/checkbox/checkbox-group.tsx:42](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/checkbox/checkbox-group.tsx#L42) +[packages/components/src/checkbox/checkbox-group.tsx:42](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/checkbox/checkbox-group.tsx#L42) --- @@ -64,4 +54,4 @@ #### Defined in -[packages/components/src/checkbox/checkbox-group.tsx:44](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/checkbox/checkbox-group.tsx#L44) +[packages/components/src/checkbox/checkbox-group.tsx:44](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/checkbox/checkbox-group.tsx#L44) diff --git a/packages/next-docs/pages/components/checkbox/code.mdx b/packages/next-docs/pages/components/checkbox/code.mdx index 6649293581..9aae0df91f 100644 --- a/packages/next-docs/pages/components/checkbox/code.mdx +++ b/packages/next-docs/pages/components/checkbox/code.mdx @@ -6,9 +6,9 @@ Checkbox controls allow users to make multiple independent choices in a form whe #### Parameters -| Name | Type | -| :------ | :----------------------------------------------------------------------------------- | -| `props` | [`CheckboxProps`](interfaces/CheckboxProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :----------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`CheckboxProps`](props.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns @@ -16,10 +16,33 @@ Checkbox controls allow users to make multiple independent choices in a form whe **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx Label ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + +Label)}`, + }} + +> + + + + + + + #### Defined in node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355 diff --git a/packages/next-docs/pages/components/checkbox/props.mdx b/packages/next-docs/pages/components/checkbox/props.mdx index 2ef7d80b11..ddca1c56d9 100644 --- a/packages/next-docs/pages/components/checkbox/props.mdx +++ b/packages/next-docs/pages/components/checkbox/props.mdx @@ -6,14 +6,6 @@ ↳ **`CheckboxProps`** -## Table of contents - -### Properties - -- [error](props.md#error) -- [indeterminate](props.md#indeterminate) -- [value](props.md#value) - ## Properties ### error @@ -30,7 +22,7 @@ false; #### Defined in -[packages/components/src/checkbox/checkbox.tsx:65](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/checkbox/checkbox.tsx#L65) +[packages/components/src/checkbox/checkbox.tsx:65](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/checkbox/checkbox.tsx#L65) --- @@ -44,7 +36,7 @@ AriaCheckboxProps.indeterminate #### Defined in -[packages/components/src/checkbox/use-aria-checkbox.ts:87](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/checkbox/use-aria-checkbox.ts#L87) +[packages/components/src/checkbox/use-aria-checkbox.ts:87](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/checkbox/use-aria-checkbox.ts#L87) --- @@ -58,4 +50,4 @@ AriaCheckboxProps.value #### Defined in -[packages/components/src/checkbox/use-aria-checkbox.ts:88](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/checkbox/use-aria-checkbox.ts#L88) +[packages/components/src/checkbox/use-aria-checkbox.ts:88](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/checkbox/use-aria-checkbox.ts#L88) diff --git a/packages/next-docs/pages/components/clickable-bubble/code.mdx b/packages/next-docs/pages/components/clickable-bubble/code.mdx index 26bfc8e865..f1bbc6b9df 100644 --- a/packages/next-docs/pages/components/clickable-bubble/code.mdx +++ b/packages/next-docs/pages/components/clickable-bubble/code.mdx @@ -6,9 +6,9 @@ Bubbles events to Clickable #### Parameters -| Name | Type | -| :------ | :------------------------------------------------------------------------------------------------- | -| `props` | [`ClickableBubbleProps`](interfaces/ClickableBubbleProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :------------------------------------------------------------------------------------------------------------------------------------ | +| `props` | [`ClickableBubbleProps`](props.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns @@ -16,7 +16,7 @@ Bubbles events to Clickable **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx

Clicking the text will bubble the Click event to Clickable

@@ -24,6 +24,31 @@ Bubbles events to Clickable
``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + +

Clicking the text will bubble the Click event to Clickable

)}`, + }} + +> + + + + + +
+ #### Defined in node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355 diff --git a/packages/next-docs/pages/components/clickable-bubble/props.mdx b/packages/next-docs/pages/components/clickable-bubble/props.mdx index 182a3de0f5..808871d890 100644 --- a/packages/next-docs/pages/components/clickable-bubble/props.mdx +++ b/packages/next-docs/pages/components/clickable-bubble/props.mdx @@ -1,11 +1,5 @@ # ClickableBubbleProps -## Table of contents - -### Properties - -- [children](props.md#children) - ## Properties ### children @@ -16,4 +10,4 @@ Children to bubble event #### Defined in -[packages/components/src/clickable/clickable-bubble.tsx:25](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/clickable/clickable-bubble.tsx#L25) +[packages/components/src/clickable/clickable-bubble.tsx:25](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/clickable/clickable-bubble.tsx#L25) diff --git a/packages/next-docs/pages/components/clickable/code.mdx b/packages/next-docs/pages/components/clickable/code.mdx index 6560af9c45..9c98f5d888 100644 --- a/packages/next-docs/pages/components/clickable/code.mdx +++ b/packages/next-docs/pages/components/clickable/code.mdx @@ -6,9 +6,9 @@ Represents clickable surfaces #### Parameters -| Name | Type | -| :------ | :------------------------------------------------------------------------------------- | -| `props` | [`ClickableProps`](interfaces/ClickableProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :------------------------------------------------------------------------------------------------------------------------------ | +| `props` | [`ClickableProps`](props.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns @@ -16,12 +16,35 @@ Represents clickable surfaces **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx Text ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + + Text )}`, + }} + +> + + + + + + + #### Defined in node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355 diff --git a/packages/next-docs/pages/components/clickable/props.mdx b/packages/next-docs/pages/components/clickable/props.mdx index 1f93c3ad56..b4c016886a 100644 --- a/packages/next-docs/pages/components/clickable/props.mdx +++ b/packages/next-docs/pages/components/clickable/props.mdx @@ -6,12 +6,6 @@ ↳ **`ClickableProps`** -## Table of contents - -### Properties - -- [asChild](props.md#aschild) - ## Properties ### asChild @@ -28,4 +22,4 @@ false; #### Defined in -[packages/components/src/clickable/clickable.tsx:52](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/clickable/clickable.tsx#L52) +[packages/components/src/clickable/clickable.tsx:52](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/clickable/clickable.tsx#L52) diff --git a/packages/next-docs/pages/components/combobox-item/code.mdx b/packages/next-docs/pages/components/combobox-item/code.mdx index 72ed12476d..8cfd550958 100644 --- a/packages/next-docs/pages/components/combobox-item/code.mdx +++ b/packages/next-docs/pages/components/combobox-item/code.mdx @@ -6,9 +6,9 @@ #### Parameters -| Name | Type | -| :------ | :------------------------------------------------------------------------------------------- | -| `props` | [`ComboboxItemProps`](interfaces/ComboboxItemProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :--------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`ComboboxItemProps`](props.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/combobox-item/props.mdx b/packages/next-docs/pages/components/combobox-item/props.mdx index 2efbf47b26..7e34240c69 100644 --- a/packages/next-docs/pages/components/combobox-item/props.mdx +++ b/packages/next-docs/pages/components/combobox-item/props.mdx @@ -8,12 +8,6 @@ ↳ **`ComboboxItemProps`** -## Table of contents - -### Properties - -- [asChild](props.md#aschild) - ## Properties ### asChild @@ -30,4 +24,4 @@ false; #### Defined in -[packages/components/src/combobox/combobox-item.tsx:32](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/combobox/combobox-item.tsx#L32) +[packages/components/src/combobox/combobox-item.tsx:32](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/combobox/combobox-item.tsx#L32) diff --git a/packages/next-docs/pages/components/combobox-list/code.mdx b/packages/next-docs/pages/components/combobox-list/code.mdx index 306a6937f5..268ff36af4 100644 --- a/packages/next-docs/pages/components/combobox-list/code.mdx +++ b/packages/next-docs/pages/components/combobox-list/code.mdx @@ -6,9 +6,9 @@ #### Parameters -| Name | Type | -| :------ | :------------------------------------------------------------------------------------------- | -| `props` | [`ComboboxListProps`](interfaces/ComboboxListProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :--------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`ComboboxListProps`](props.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/combobox-list/props.mdx b/packages/next-docs/pages/components/combobox-list/props.mdx index 8d172d8760..93ab53fbe4 100644 --- a/packages/next-docs/pages/components/combobox-list/props.mdx +++ b/packages/next-docs/pages/components/combobox-list/props.mdx @@ -6,12 +6,6 @@ ↳ **`ComboboxListProps`** -## Table of contents - -### Properties - -- [asChild](props.md#aschild) - ## Properties ### asChild @@ -28,4 +22,4 @@ false; #### Defined in -[packages/components/src/combobox/combobox-list.tsx:27](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/combobox/combobox-list.tsx#L27) +[packages/components/src/combobox/combobox-list.tsx:27](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/combobox/combobox-list.tsx#L27) diff --git a/packages/next-docs/pages/components/combobox-popover/code.mdx b/packages/next-docs/pages/components/combobox-popover/code.mdx index 84dff72f3d..cd2d7b0640 100644 --- a/packages/next-docs/pages/components/combobox-popover/code.mdx +++ b/packages/next-docs/pages/components/combobox-popover/code.mdx @@ -6,9 +6,9 @@ #### Parameters -| Name | Type | -| :------ | :------------------------------------------------------------------------------------------------- | -| `props` | [`ComboboxPopoverProps`](interfaces/ComboboxPopoverProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :------------------------------------------------------------------------------------------------------------------------------------ | +| `props` | [`ComboboxPopoverProps`](props.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/combobox-popover/props.mdx b/packages/next-docs/pages/components/combobox-popover/props.mdx index bd2c6c725b..95d99d8923 100644 --- a/packages/next-docs/pages/components/combobox-popover/props.mdx +++ b/packages/next-docs/pages/components/combobox-popover/props.mdx @@ -8,12 +8,6 @@ ↳ **`ComboboxPopoverProps`** -## Table of contents - -### Properties - -- [asChild](props.md#aschild) - ## Properties ### asChild @@ -30,4 +24,4 @@ false; #### Defined in -[packages/components/src/combobox/combobox-popover.tsx:32](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/combobox/combobox-popover.tsx#L32) +[packages/components/src/combobox/combobox-popover.tsx:32](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/combobox/combobox-popover.tsx#L32) diff --git a/packages/next-docs/pages/components/combobox-provider/code.mdx b/packages/next-docs/pages/components/combobox-provider/code.mdx deleted file mode 100644 index 6cf66fe787..0000000000 --- a/packages/next-docs/pages/components/combobox-provider/code.mdx +++ /dev/null @@ -1,36 +0,0 @@ -### ComboboxProvider - -▸ **ComboboxProvider**(`props?`): `JSX.Element` - -Provides a combobox store to Combobox components. - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `props?` | `ComboboxProviderProps` | - -#### Returns - -`JSX.Element` - -**`See`** - -https://ariakit.org/components/combobox - -**`Example`** - -```jsx - - - - - - - - -``` - -#### Defined in - -node_modules/.pnpm/@ariakit+react-core@0.3.5_react-dom@18.2.0_react@18.2.0/node_modules/@ariakit/react-core/cjs/combobox/combobox-provider.d.ts:18 diff --git a/packages/next-docs/pages/components/combobox/code.mdx b/packages/next-docs/pages/components/combobox/code.mdx index de248e6c1b..c9647b1ccd 100644 --- a/packages/next-docs/pages/components/combobox/code.mdx +++ b/packages/next-docs/pages/components/combobox/code.mdx @@ -6,9 +6,9 @@ #### Parameters -| Name | Type | -| :------ | :------------------------------------------------------------------------------------- | -| `props` | [`ComboboxProps`](interfaces/ComboboxProps.md) & `RefAttributes`\<`HTMLInputElement`\> | +| Name | Type | +| :------ | :--------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`ComboboxProps`](props.md) & `RefAttributes`\<[`HTMLInputElement`](https://developer.mozilla.org/docs/Web/API/HTMLInputElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/combobox/props.mdx b/packages/next-docs/pages/components/combobox/props.mdx index abce2290f6..b51a5fb3b9 100644 --- a/packages/next-docs/pages/components/combobox/props.mdx +++ b/packages/next-docs/pages/components/combobox/props.mdx @@ -8,12 +8,6 @@ ↳ **`ComboboxProps`** -## Table of contents - -### Properties - -- [asChild](props.md#aschild) - ## Properties ### asChild @@ -30,4 +24,4 @@ false; #### Defined in -[packages/components/src/combobox/combobox.tsx:32](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/combobox/combobox.tsx#L32) +[packages/components/src/combobox/combobox.tsx:32](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/combobox/combobox.tsx#L32) diff --git a/packages/next-docs/pages/components/composable/code.mdx b/packages/next-docs/pages/components/composable/code.mdx index 16b689112e..bc0288daa6 100644 --- a/packages/next-docs/pages/components/composable/code.mdx +++ b/packages/next-docs/pages/components/composable/code.mdx @@ -6,9 +6,9 @@ Defines a composable child inside of a Compose component #### Parameters -| Name | Type | -| :------ | :------------------------------------------------- | -| `props` | [`ComposableProps`](interfaces/ComposableProps.md) | +| Name | Type | +| :------ | :---------------------------- | +| `props` | [`ComposableProps`](props.md) | #### Returns @@ -16,7 +16,7 @@ Defines a composable child inside of a Compose component **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx function Button({ asChild, children, ...props }) { const Composition = asChild ? Compose : "button"; return ( @@ -27,6 +27,30 @@ function Button({ asChild, children, ...props }) { } ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + +function Button({ asChild, children, ...props }){ const Composition = asChild ? Compose : 'button' return ( Prefix {children} )})}`, + }} + +> + + + + + + + #### Defined in -[packages/components/src/compose/composable.tsx:17](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/compose/composable.tsx#L17) +[packages/components/src/compose/composable.tsx:17](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/compose/composable.tsx#L17) diff --git a/packages/next-docs/pages/components/composable/props.mdx b/packages/next-docs/pages/components/composable/props.mdx index 9ababa27cc..de55da3a27 100644 --- a/packages/next-docs/pages/components/composable/props.mdx +++ b/packages/next-docs/pages/components/composable/props.mdx @@ -1,12 +1,5 @@ # ComposableProps -## Table of contents - -### Properties - -- [children](props.md#children) -- [render](props.md#render) - ## Properties ### children @@ -15,7 +8,7 @@ #### Defined in -[packages/components/src/compose/composable.tsx:29](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/compose/composable.tsx#L29) +[packages/components/src/compose/composable.tsx:29](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/compose/composable.tsx#L29) --- @@ -25,4 +18,4 @@ #### Defined in -[packages/components/src/compose/composable.tsx:28](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/compose/composable.tsx#L28) +[packages/components/src/compose/composable.tsx:28](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/compose/composable.tsx#L28) diff --git a/packages/next-docs/pages/components/compose/code.mdx b/packages/next-docs/pages/components/compose/code.mdx index 416bacca6f..03dfef4eb4 100644 --- a/packages/next-docs/pages/components/compose/code.mdx +++ b/packages/next-docs/pages/components/compose/code.mdx @@ -7,9 +7,9 @@ Used to implement Shoreline composition #### Parameters -| Name | Type | -| :------ | :---------------------------------------------------------------------- | -| `props` | [`ComposeProps`](interfaces/ComposeProps.md) & `RefAttributes`\<`any`\> | +| Name | Type | +| :------ | :---------------------------------------------------- | +| `props` | [`ComposeProps`](props.md) & `RefAttributes`\<`any`\> | #### Returns @@ -17,13 +17,36 @@ Used to implement Shoreline composition **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx function Button({ asChild, ...props }) { const Composition = asChild ? Compose : "button"; return ; } ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + +function Button({ asChild, ...props }){ const Composition = asChild ? Compose : 'button' return })}`, + }} + +> + + + + + + + #### Defined in node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355 diff --git a/packages/next-docs/pages/components/compose/props.mdx b/packages/next-docs/pages/components/compose/props.mdx index df1de43fa0..0581fb90c5 100644 --- a/packages/next-docs/pages/components/compose/props.mdx +++ b/packages/next-docs/pages/components/compose/props.mdx @@ -2,16 +2,10 @@ ## Hierarchy -- `HTMLAttributes`\<`HTMLElement`\> +- `HTMLAttributes`\<[`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement)\> ↳ **`ComposeProps`** -## Table of contents - -### Properties - -- [children](props.md#children) - ## Properties ### children @@ -24,4 +18,4 @@ HTMLAttributes.children #### Defined in -[packages/components/src/compose/compose.tsx:33](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/compose/compose.tsx#L33) +[packages/components/src/compose/compose.tsx:33](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/compose/compose.tsx#L33) diff --git a/packages/next-docs/pages/components/container/code.mdx b/packages/next-docs/pages/components/container/code.mdx index d25565f315..d9211f4ce0 100644 --- a/packages/next-docs/pages/components/container/code.mdx +++ b/packages/next-docs/pages/components/container/code.mdx @@ -6,9 +6,9 @@ Wraps Content component to support Container Queries #### Parameters -| Name | Type | -| :------ | :------------------------------------------------------------------------------------- | -| `props` | [`ContainerProps`](interfaces/ContainerProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :------------------------------------------------------------------------------------------------------------------------------ | +| `props` | [`ContainerProps`](props.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns @@ -16,12 +16,36 @@ Wraps Content component to support Container Queries **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx ... ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + + ...)}`, + }} + +> + + + + + + + #### Defined in node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355 diff --git a/packages/next-docs/pages/components/container/props.mdx b/packages/next-docs/pages/components/container/props.mdx index aa3e8d7d05..3ec755515a 100644 --- a/packages/next-docs/pages/components/container/props.mdx +++ b/packages/next-docs/pages/components/container/props.mdx @@ -6,12 +6,6 @@ ↳ **`ContainerProps`** -## Table of contents - -### Properties - -- [as](props.md#as) - ## Properties ### as @@ -28,4 +22,4 @@ Select the rendered html tag #### Defined in -[packages/components/src/content/container.tsx:30](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/content/container.tsx#L30) +[packages/components/src/content/container.tsx:30](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/content/container.tsx#L30) diff --git a/packages/next-docs/pages/components/content/code.mdx b/packages/next-docs/pages/components/content/code.mdx index f6475c157b..bc5a37b6f5 100644 --- a/packages/next-docs/pages/components/content/code.mdx +++ b/packages/next-docs/pages/components/content/code.mdx @@ -6,9 +6,9 @@ Content containers allow merchants to easily scan information to understand its #### Parameters -| Name | Type | -| :------ | :--------------------------------------------------------------------------------- | -| `props` | [`ContentProps`](interfaces/ContentProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :---------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`ContentProps`](props.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns @@ -16,12 +16,36 @@ Content containers allow merchants to easily scan information to understand its **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx ... ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + + ...)}`, + }} + +> + + + + + + + #### Defined in node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355 diff --git a/packages/next-docs/pages/components/content/props.mdx b/packages/next-docs/pages/components/content/props.mdx index 42ea68aa49..06eed706bd 100644 --- a/packages/next-docs/pages/components/content/props.mdx +++ b/packages/next-docs/pages/components/content/props.mdx @@ -6,13 +6,6 @@ ↳ **`ContentProps`** -## Table of contents - -### Properties - -- [as](props.md#as) -- [narrow](props.md#narrow) - ## Properties ### as @@ -29,7 +22,7 @@ Select the rendered html tag #### Defined in -[packages/components/src/content/content.tsx:31](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/content/content.tsx#L31) +[packages/components/src/content/content.tsx:31](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/content/content.tsx#L31) --- @@ -47,4 +40,4 @@ false; #### Defined in -[packages/components/src/content/content.tsx:36](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/content/content.tsx#L36) +[packages/components/src/content/content.tsx:36](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/content/content.tsx#L36) diff --git a/packages/next-docs/pages/components/field-label/code.mdx b/packages/next-docs/pages/components/field-label/code.mdx index 19ffafbc04..f97c2d99f2 100644 --- a/packages/next-docs/pages/components/field-label/code.mdx +++ b/packages/next-docs/pages/components/field-label/code.mdx @@ -6,9 +6,9 @@ #### Parameters -| Name | Type | -| :------ | :----------------------------------------------------------------------------------------- | -| `props` | [`FieldLabelProps`](interfaces/FieldLabelProps.md) & `RefAttributes`\<`HTMLLabelElement`\> | +| Name | Type | +| :------ | :----------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`FieldLabelProps`](props.md) & `RefAttributes`\<[`HTMLLabelElement`](https://developer.mozilla.org/docs/Web/API/HTMLLabelElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/field-label/props.mdx b/packages/next-docs/pages/components/field-label/props.mdx index d21193aad0..b3286d6f64 100644 --- a/packages/next-docs/pages/components/field-label/props.mdx +++ b/packages/next-docs/pages/components/field-label/props.mdx @@ -6,13 +6,6 @@ ↳ **`FieldLabelProps`** -## Table of contents - -### Properties - -- [disabled](props.md#disabled) -- [optional](props.md#optional) - ## Properties ### disabled @@ -21,7 +14,7 @@ #### Defined in -[packages/components/src/field/field-label.tsx:30](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/field/field-label.tsx#L30) +[packages/components/src/field/field-label.tsx:30](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/field/field-label.tsx#L30) --- @@ -31,4 +24,4 @@ #### Defined in -[packages/components/src/field/field-label.tsx:31](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/field/field-label.tsx#L31) +[packages/components/src/field/field-label.tsx:31](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/field/field-label.tsx#L31) diff --git a/packages/next-docs/pages/components/field-message/code.mdx b/packages/next-docs/pages/components/field-message/code.mdx index 6be3ebf47d..d05d5c5271 100644 --- a/packages/next-docs/pages/components/field-message/code.mdx +++ b/packages/next-docs/pages/components/field-message/code.mdx @@ -6,9 +6,9 @@ #### Parameters -| Name | Type | -| :------ | :------------------------------------------------------------------------------------------- | -| `props` | [`FieldMessageProps`](interfaces/FieldMessageProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :--------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`FieldMessageProps`](props.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/field-message/props.mdx b/packages/next-docs/pages/components/field-message/props.mdx index eac4da5aca..8819c52034 100644 --- a/packages/next-docs/pages/components/field-message/props.mdx +++ b/packages/next-docs/pages/components/field-message/props.mdx @@ -6,14 +6,6 @@ ↳ **`FieldMessageProps`** -## Table of contents - -### Properties - -- [error](props.md#error) -- [errorText](props.md#errortext) -- [helpText](props.md#helptext) - ## Properties ### error @@ -30,7 +22,7 @@ false; #### Defined in -[packages/components/src/field/field-message.tsx:40](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/field/field-message.tsx#L40) +[packages/components/src/field/field-message.tsx:40](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/field/field-message.tsx#L40) --- @@ -42,7 +34,7 @@ Error text message #### Defined in -[packages/components/src/field/field-message.tsx:35](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/field/field-message.tsx#L35) +[packages/components/src/field/field-message.tsx:35](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/field/field-message.tsx#L35) --- @@ -54,4 +46,4 @@ Help text message #### Defined in -[packages/components/src/field/field-message.tsx:31](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/field/field-message.tsx#L31) +[packages/components/src/field/field-message.tsx:31](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/field/field-message.tsx#L31) diff --git a/packages/next-docs/pages/components/field/code.mdx b/packages/next-docs/pages/components/field/code.mdx index 79de7b90b4..435f963e7b 100644 --- a/packages/next-docs/pages/components/field/code.mdx +++ b/packages/next-docs/pages/components/field/code.mdx @@ -6,9 +6,9 @@ #### Parameters -| Name | Type | -| :------ | :----------------------------------------------------------------------------- | -| `props` | [`FieldProps`](interfaces/FieldProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :-------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`FieldProps`](props.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/field/props.mdx b/packages/next-docs/pages/components/field/props.mdx index 735fd41825..af38f6e308 100644 --- a/packages/next-docs/pages/components/field/props.mdx +++ b/packages/next-docs/pages/components/field/props.mdx @@ -6,12 +6,6 @@ ↳ **`FieldProps`** -## Table of contents - -### Properties - -- [variant](props.md#variant) - ## Properties ### variant @@ -20,4 +14,4 @@ #### Defined in -[packages/components/src/field/field.tsx:19](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/field/field.tsx#L19) +[packages/components/src/field/field.tsx:19](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/field/field.tsx#L19) diff --git a/packages/next-docs/pages/components/filter-apply-props/code.mdx b/packages/next-docs/pages/components/filter-apply-props/code.mdx deleted file mode 100644 index 7a292cfab6..0000000000 --- a/packages/next-docs/pages/components/filter-apply-props/code.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### FilterApplyProps - -Ƭ **FilterApplyProps**: [`PopoverDismissProps`](interfaces/PopoverDismissProps.md) - -#### Defined in - -[packages/components/src/filter/filter-apply.tsx:38](https://github.com/vtex/shoreline/blob/dd054909f/packages/components/src/filter/filter-apply.tsx#L38) diff --git a/packages/next-docs/pages/components/filter-apply/code.mdx b/packages/next-docs/pages/components/filter-apply/code.mdx index 6d09b471c4..b12a8d7d40 100644 --- a/packages/next-docs/pages/components/filter-apply/code.mdx +++ b/packages/next-docs/pages/components/filter-apply/code.mdx @@ -6,9 +6,9 @@ Action that applies the Filter value, and closes the popover #### Parameters -| Name | Type | -| :------ | :-------------------------------------------------------------------------------------------------- | -| `props` | [`PopoverDismissProps`](interfaces/PopoverDismissProps.md) & `RefAttributes`\<`HTMLButtonElement`\> | +| Name | Type | +| :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `props` | [`PopoverDismissProps`](interfaces/PopoverDismissProps.md) & `RefAttributes`\<[`HTMLButtonElement`](https://developer.mozilla.org/docs/Web/API/HTMLButtonElement)\> | #### Returns @@ -16,10 +16,33 @@ Action that applies the Filter value, and closes the popover **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx Apply ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + +Apply)}`, + }} + +> + + + + + + + #### Defined in node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355 diff --git a/packages/next-docs/pages/components/filter-apply/props.mdx b/packages/next-docs/pages/components/filter-apply/props.mdx index fd7986d357..eeee703b7d 100644 --- a/packages/next-docs/pages/components/filter-apply/props.mdx +++ b/packages/next-docs/pages/components/filter-apply/props.mdx @@ -4,4 +4,4 @@ #### Defined in -[packages/components/src/filter/filter-apply.tsx:38](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter-apply.tsx#L38) +[packages/components/src/filter/filter-apply.tsx:38](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter-apply.tsx#L38) diff --git a/packages/next-docs/pages/components/filter-clear-props/code.mdx b/packages/next-docs/pages/components/filter-clear-props/code.mdx deleted file mode 100644 index b0841e37ee..0000000000 --- a/packages/next-docs/pages/components/filter-clear-props/code.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### FilterClearProps - -Ƭ **FilterClearProps**: [`PopoverDismissProps`](interfaces/PopoverDismissProps.md) - -#### Defined in - -[packages/components/src/filter/filter-clear.tsx:37](https://github.com/vtex/shoreline/blob/dd054909f/packages/components/src/filter/filter-clear.tsx#L37) diff --git a/packages/next-docs/pages/components/filter-clear/code.mdx b/packages/next-docs/pages/components/filter-clear/code.mdx index 7fd681ef03..d6a73cc399 100644 --- a/packages/next-docs/pages/components/filter-clear/code.mdx +++ b/packages/next-docs/pages/components/filter-clear/code.mdx @@ -6,9 +6,9 @@ Action that clears both Filter value and UI Select value #### Parameters -| Name | Type | -| :------ | :-------------------------------------------------------------------------------------------------- | -| `props` | [`PopoverDismissProps`](interfaces/PopoverDismissProps.md) & `RefAttributes`\<`HTMLButtonElement`\> | +| Name | Type | +| :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `props` | [`PopoverDismissProps`](interfaces/PopoverDismissProps.md) & `RefAttributes`\<[`HTMLButtonElement`](https://developer.mozilla.org/docs/Web/API/HTMLButtonElement)\> | #### Returns @@ -16,10 +16,33 @@ Action that clears both Filter value and UI Select value **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx Clear ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + +Clear)}`, + }} + +> + + + + + + + #### Defined in node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355 diff --git a/packages/next-docs/pages/components/filter-clear/props.mdx b/packages/next-docs/pages/components/filter-clear/props.mdx index 9d4be35584..b947dda66e 100644 --- a/packages/next-docs/pages/components/filter-clear/props.mdx +++ b/packages/next-docs/pages/components/filter-clear/props.mdx @@ -4,4 +4,4 @@ #### Defined in -[packages/components/src/filter/filter-clear.tsx:37](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter-clear.tsx#L37) +[packages/components/src/filter/filter-clear.tsx:37](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter-clear.tsx#L37) diff --git a/packages/next-docs/pages/components/filter-list-props/code.mdx b/packages/next-docs/pages/components/filter-list-props/code.mdx deleted file mode 100644 index 56bf2f5e17..0000000000 --- a/packages/next-docs/pages/components/filter-list-props/code.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### FilterListProps - -Ƭ **FilterListProps**: `Omit`\<[`SelectListProps`](interfaces/SelectListProps.md), `"alwaysVisible"`\> - -#### Defined in - -[packages/components/src/filter/filter-list.tsx:37](https://github.com/vtex/shoreline/blob/dd054909f/packages/components/src/filter/filter-list.tsx#L37) diff --git a/packages/next-docs/pages/components/filter-list/code.mdx b/packages/next-docs/pages/components/filter-list/code.mdx index 3c3d720a63..a24620914d 100644 --- a/packages/next-docs/pages/components/filter-list/code.mdx +++ b/packages/next-docs/pages/components/filter-list/code.mdx @@ -6,9 +6,9 @@ Filter listbox #### Parameters -| Name | Type | -| :------ | :------------------------------------------------------------------------------------ | -| `props` | [`FilterListProps`](modules.md#filterlistprops) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :------------------------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`FilterListProps`](modules.md#filterlistprops) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns @@ -16,7 +16,7 @@ Filter listbox **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx @@ -26,6 +26,32 @@ Filter listbox ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + + Option )}`, + }} + +> + + + + + + + #### Defined in node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355 diff --git a/packages/next-docs/pages/components/filter-list/props.mdx b/packages/next-docs/pages/components/filter-list/props.mdx index 11c6e0da6c..fc7b7406de 100644 --- a/packages/next-docs/pages/components/filter-list/props.mdx +++ b/packages/next-docs/pages/components/filter-list/props.mdx @@ -1,7 +1,7 @@ ### FilterListProps -Ƭ **FilterListProps**: `Omit`\<[`SelectListProps`](interfaces/SelectListProps.md), `"alwaysVisible"`\> +Ƭ **FilterListProps**: [`Omit`](https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys)\<[`SelectListProps`](interfaces/SelectListProps.md), `"alwaysVisible"`\> #### Defined in -[packages/components/src/filter/filter-list.tsx:37](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter-list.tsx#L37) +[packages/components/src/filter/filter-list.tsx:37](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter-list.tsx#L37) diff --git a/packages/next-docs/pages/components/filter-option-props/code.mdx b/packages/next-docs/pages/components/filter-option-props/code.mdx deleted file mode 100644 index 6d585d9d13..0000000000 --- a/packages/next-docs/pages/components/filter-option-props/code.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### FilterOptionProps - -Ƭ **FilterOptionProps**: `Omit`\<[`SelectOptionProps`](interfaces/SelectOptionProps.md), `"hideOnClick"`\> - -#### Defined in - -[packages/components/src/filter/filter-option.tsx:51](https://github.com/vtex/shoreline/blob/dd054909f/packages/components/src/filter/filter-option.tsx#L51) diff --git a/packages/next-docs/pages/components/filter-option/code.mdx b/packages/next-docs/pages/components/filter-option/code.mdx index 9a33d76a32..f5fbfbe79e 100644 --- a/packages/next-docs/pages/components/filter-option/code.mdx +++ b/packages/next-docs/pages/components/filter-option/code.mdx @@ -6,9 +6,9 @@ Filter Option #### Parameters -| Name | Type | -| :------ | :---------------------------------------------------------------------------------------- | -| `props` | [`FilterOptionProps`](modules.md#filteroptionprops) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :----------------------------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`FilterOptionProps`](modules.md#filteroptionprops) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns @@ -16,12 +16,36 @@ Filter Option **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx Option ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + + Option)}`, + }} + +> + + + + + + + #### Defined in node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355 diff --git a/packages/next-docs/pages/components/filter-option/props.mdx b/packages/next-docs/pages/components/filter-option/props.mdx index aec543c799..0c21f816f9 100644 --- a/packages/next-docs/pages/components/filter-option/props.mdx +++ b/packages/next-docs/pages/components/filter-option/props.mdx @@ -1,7 +1,7 @@ ### FilterOptionProps -Ƭ **FilterOptionProps**: `Omit`\<[`SelectOptionProps`](interfaces/SelectOptionProps.md), `"hideOnClick"`\> +Ƭ **FilterOptionProps**: [`Omit`](https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys)\<[`SelectOptionProps`](interfaces/SelectOptionProps.md), `"hideOnClick"`\> #### Defined in -[packages/components/src/filter/filter-option.tsx:51](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter-option.tsx#L51) +[packages/components/src/filter/filter-option.tsx:51](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter-option.tsx#L51) diff --git a/packages/next-docs/pages/components/filter-popover/code.mdx b/packages/next-docs/pages/components/filter-popover/code.mdx index 26a093f88c..ec639cb129 100644 --- a/packages/next-docs/pages/components/filter-popover/code.mdx +++ b/packages/next-docs/pages/components/filter-popover/code.mdx @@ -6,9 +6,9 @@ Filter popover box #### Parameters -| Name | Type | -| :------ | :--------------------------------------------------------------------------------------------- | -| `props` | [`FilterPopoverProps`](interfaces/FilterPopoverProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :---------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`FilterPopoverProps`](props.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns @@ -16,12 +16,36 @@ Filter popover box **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx ... ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + + ... )}`, + }} + +> + + + + + + + #### Defined in node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355 diff --git a/packages/next-docs/pages/components/filter-popover/props.mdx b/packages/next-docs/pages/components/filter-popover/props.mdx index 944a8dbc86..9e93f65a4e 100644 --- a/packages/next-docs/pages/components/filter-popover/props.mdx +++ b/packages/next-docs/pages/components/filter-popover/props.mdx @@ -6,13 +6,6 @@ ↳ **`FilterPopoverProps`** -## Table of contents - -### Properties - -- [asChild](props.md#aschild) -- [messages](props.md#messages) - ## Properties ### asChild @@ -33,7 +26,7 @@ false; #### Defined in -[packages/components/src/popover/popover.tsx:39](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/popover/popover.tsx#L39) +[packages/components/src/popover/popover.tsx:39](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/popover/popover.tsx#L39) --- @@ -50,4 +43,4 @@ false; #### Defined in -[packages/components/src/filter/filter-popover.tsx:62](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter-popover.tsx#L62) +[packages/components/src/filter/filter-popover.tsx:62](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter-popover.tsx#L62) diff --git a/packages/next-docs/pages/components/filter-provider/code.mdx b/packages/next-docs/pages/components/filter-provider/code.mdx index d308162d16..aa9fa9d730 100644 --- a/packages/next-docs/pages/components/filter-provider/code.mdx +++ b/packages/next-docs/pages/components/filter-provider/code.mdx @@ -6,9 +6,9 @@ Provides context to Filter #### Parameters -| Name | Type | -| :------ | :--------------------------------------------------------- | -| `props` | [`FilterProviderProps`](interfaces/FilterProviderProps.md) | +| Name | Type | +| :------ | :-------------------------------- | +| `props` | [`FilterProviderProps`](props.md) | #### Returns @@ -16,13 +16,38 @@ Provides context to Filter **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx ... ... ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + + ... ...)}`, + }} + +> + + + + + + + #### Defined in -[packages/components/src/filter/filter-provider.tsx:17](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter-provider.tsx#L17) +[packages/components/src/filter/filter-provider.tsx:17](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter-provider.tsx#L17) diff --git a/packages/next-docs/pages/components/filter-provider/props.mdx b/packages/next-docs/pages/components/filter-provider/props.mdx index 45a501bcf3..4a94c0918a 100644 --- a/packages/next-docs/pages/components/filter-provider/props.mdx +++ b/packages/next-docs/pages/components/filter-provider/props.mdx @@ -1,20 +1,5 @@ # FilterProviderProps -## Table of contents - -### Properties - -- [children](props.md#children) -- [defaultOpen](props.md#defaultopen) -- [defaultSearchValue](props.md#defaultsearchvalue) -- [defaultValue](props.md#defaultvalue) -- [open](props.md#open) -- [searchValue](props.md#searchvalue) -- [setOpen](props.md#setopen) -- [setSearchValue](props.md#setsearchvalue) -- [setValue](props.md#setvalue) -- [value](props.md#value) - ## Properties ### children @@ -23,7 +8,7 @@ #### Defined in -[packages/components/src/filter/filter-provider.tsx:80](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter-provider.tsx#L80) +[packages/components/src/filter/filter-provider.tsx:80](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter-provider.tsx#L80) --- @@ -33,7 +18,7 @@ #### Defined in -[packages/components/src/filter/filter-provider.tsx:83](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter-provider.tsx#L83) +[packages/components/src/filter/filter-provider.tsx:83](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter-provider.tsx#L83) --- @@ -43,7 +28,7 @@ #### Defined in -[packages/components/src/filter/filter-provider.tsx:86](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter-provider.tsx#L86) +[packages/components/src/filter/filter-provider.tsx:86](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter-provider.tsx#L86) --- @@ -53,7 +38,7 @@ #### Defined in -[packages/components/src/filter/filter-provider.tsx:91](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter-provider.tsx#L91) +[packages/components/src/filter/filter-provider.tsx:91](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter-provider.tsx#L91) --- @@ -63,7 +48,7 @@ #### Defined in -[packages/components/src/filter/filter-provider.tsx:81](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter-provider.tsx#L81) +[packages/components/src/filter/filter-provider.tsx:81](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter-provider.tsx#L81) --- @@ -73,7 +58,7 @@ #### Defined in -[packages/components/src/filter/filter-provider.tsx:84](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter-provider.tsx#L84) +[packages/components/src/filter/filter-provider.tsx:84](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter-provider.tsx#L84) --- @@ -83,7 +68,7 @@ #### Defined in -[packages/components/src/filter/filter-provider.tsx:82](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter-provider.tsx#L82) +[packages/components/src/filter/filter-provider.tsx:82](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter-provider.tsx#L82) --- @@ -93,7 +78,7 @@ #### Defined in -[packages/components/src/filter/filter-provider.tsx:85](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter-provider.tsx#L85) +[packages/components/src/filter/filter-provider.tsx:85](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter-provider.tsx#L85) --- @@ -103,7 +88,7 @@ #### Defined in -[packages/components/src/filter/filter-provider.tsx:88](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter-provider.tsx#L88) +[packages/components/src/filter/filter-provider.tsx:88](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter-provider.tsx#L88) --- @@ -113,4 +98,4 @@ #### Defined in -[packages/components/src/filter/filter-provider.tsx:87](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter-provider.tsx#L87) +[packages/components/src/filter/filter-provider.tsx:87](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter-provider.tsx#L87) diff --git a/packages/next-docs/pages/components/filter-trigger-props/code.mdx b/packages/next-docs/pages/components/filter-trigger-props/code.mdx deleted file mode 100644 index 9a5e40685e..0000000000 --- a/packages/next-docs/pages/components/filter-trigger-props/code.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### FilterTriggerProps - -Ƭ **FilterTriggerProps**: [`PopoverTriggerProps`](interfaces/PopoverTriggerProps.md) - -#### Defined in - -[packages/components/src/filter/filter-trigger.tsx:29](https://github.com/vtex/shoreline/blob/dd054909f/packages/components/src/filter/filter-trigger.tsx#L29) diff --git a/packages/next-docs/pages/components/filter-trigger/code.mdx b/packages/next-docs/pages/components/filter-trigger/code.mdx index c9e74e15f7..f0254d0f03 100644 --- a/packages/next-docs/pages/components/filter-trigger/code.mdx +++ b/packages/next-docs/pages/components/filter-trigger/code.mdx @@ -6,9 +6,9 @@ Triggers the Filter Popover box, also displays the Filter applied value #### Parameters -| Name | Type | -| :------ | :-------------------------------------------------------------------------------------------------- | -| `props` | [`PopoverTriggerProps`](interfaces/PopoverTriggerProps.md) & `RefAttributes`\<`HTMLButtonElement`\> | +| Name | Type | +| :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `props` | [`PopoverTriggerProps`](interfaces/PopoverTriggerProps.md) & `RefAttributes`\<[`HTMLButtonElement`](https://developer.mozilla.org/docs/Web/API/HTMLButtonElement)\> | #### Returns @@ -16,12 +16,36 @@ Triggers the Filter Popover box, also displays the Filter applied value **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx Open ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + + Open)}`, + }} + +> + + + + + + + #### Defined in node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355 diff --git a/packages/next-docs/pages/components/filter-trigger/props.mdx b/packages/next-docs/pages/components/filter-trigger/props.mdx index 9030bc3e59..886f880bcb 100644 --- a/packages/next-docs/pages/components/filter-trigger/props.mdx +++ b/packages/next-docs/pages/components/filter-trigger/props.mdx @@ -4,4 +4,4 @@ #### Defined in -[packages/components/src/filter/filter-trigger.tsx:29](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter-trigger.tsx#L29) +[packages/components/src/filter/filter-trigger.tsx:29](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter-trigger.tsx#L29) diff --git a/packages/next-docs/pages/components/filter-value-props/code.mdx b/packages/next-docs/pages/components/filter-value-props/code.mdx deleted file mode 100644 index e8783223f6..0000000000 --- a/packages/next-docs/pages/components/filter-value-props/code.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### FilterValueProps - -Ƭ **FilterValueProps**: `ComponentPropsWithoutRef`\<`"span"`\> - -#### Defined in - -[packages/components/src/filter/filter-value.tsx:29](https://github.com/vtex/shoreline/blob/dd054909f/packages/components/src/filter/filter-value.tsx#L29) diff --git a/packages/next-docs/pages/components/filter-value/code.mdx b/packages/next-docs/pages/components/filter-value/code.mdx index 260ad9be3e..f763ba0d0e 100644 --- a/packages/next-docs/pages/components/filter-value/code.mdx +++ b/packages/next-docs/pages/components/filter-value/code.mdx @@ -6,9 +6,9 @@ Renders the Filter applied value #### Parameters -| Name | Type | -| :------ | :---------------------------------------------------------------------------------------------------------------------------------------- | -| `props` | `Omit`\<`DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLSpanElement`\>, `HTMLSpanElement`\>, `"ref"`\> & `RefAttributes`\<`HTMLSpanElement`\> | +| Name | Type | +| :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`Omit`](https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys)\<`DetailedHTMLProps`\<`HTMLAttributes`\<[`HTMLSpanElement`](https://developer.mozilla.org/docs/Web/API/HTMLSpanElement)\>, [`HTMLSpanElement`](https://developer.mozilla.org/docs/Web/API/HTMLSpanElement)\>, `"ref"`\> & `RefAttributes`\<[`HTMLSpanElement`](https://developer.mozilla.org/docs/Web/API/HTMLSpanElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/filter-value/props.mdx b/packages/next-docs/pages/components/filter-value/props.mdx index 740c93f294..60f72bb863 100644 --- a/packages/next-docs/pages/components/filter-value/props.mdx +++ b/packages/next-docs/pages/components/filter-value/props.mdx @@ -4,4 +4,4 @@ #### Defined in -[packages/components/src/filter/filter-value.tsx:29](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter-value.tsx#L29) +[packages/components/src/filter/filter-value.tsx:29](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter-value.tsx#L29) diff --git a/packages/next-docs/pages/components/filter/code.mdx b/packages/next-docs/pages/components/filter/code.mdx index 8d8c020fef..cae154960a 100644 --- a/packages/next-docs/pages/components/filter/code.mdx +++ b/packages/next-docs/pages/components/filter/code.mdx @@ -6,9 +6,9 @@ Filter component #### Parameters -| Name | Type | -| :------ | :------------------------------------------------------------------------------- | -| `props` | [`FilterProps`](interfaces/FilterProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :--------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`FilterProps`](props.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns @@ -16,12 +16,36 @@ Filter component **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx Option ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + + Option)}`, + }} + +> + + + + + + + #### Defined in node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355 diff --git a/packages/next-docs/pages/components/filter/props.mdx b/packages/next-docs/pages/components/filter/props.mdx index fb12ff34e1..4eb6bd4339 100644 --- a/packages/next-docs/pages/components/filter/props.mdx +++ b/packages/next-docs/pages/components/filter/props.mdx @@ -6,21 +6,6 @@ ↳ **`FilterProps`** -## Table of contents - -### Properties - -- [children](props.md#children) -- [className](props.md#classname) -- [defaultSearchValue](props.md#defaultsearchvalue) -- [defaultValue](props.md#defaultvalue) -- [label](props.md#label) -- [messages](props.md#messages) -- [searchValue](props.md#searchvalue) -- [setSearchValue](props.md#setsearchvalue) -- [setValue](props.md#setvalue) -- [value](props.md#value) - ## Properties ### children @@ -29,7 +14,7 @@ #### Defined in -[packages/components/src/filter/filter.tsx:67](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter.tsx#L67) +[packages/components/src/filter/filter.tsx:67](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter.tsx#L67) --- @@ -39,7 +24,7 @@ #### Defined in -[packages/components/src/filter/filter.tsx:68](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter.tsx#L68) +[packages/components/src/filter/filter.tsx:68](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter.tsx#L68) --- @@ -53,7 +38,7 @@ InheritedProps.defaultSearchValue #### Defined in -[packages/components/src/filter/filter-provider.tsx:86](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter-provider.tsx#L86) +[packages/components/src/filter/filter-provider.tsx:86](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter-provider.tsx#L86) --- @@ -67,7 +52,7 @@ InheritedProps.defaultValue #### Defined in -[packages/components/src/filter/filter-provider.tsx:91](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter-provider.tsx#L91) +[packages/components/src/filter/filter-provider.tsx:91](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter-provider.tsx#L91) --- @@ -77,7 +62,7 @@ InheritedProps.defaultValue #### Defined in -[packages/components/src/filter/filter.tsx:66](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter.tsx#L66) +[packages/components/src/filter/filter.tsx:66](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter.tsx#L66) --- @@ -98,7 +83,7 @@ InheritedProps.messages #### Defined in -[packages/components/src/filter/filter-popover.tsx:62](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter-popover.tsx#L62) +[packages/components/src/filter/filter-popover.tsx:62](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter-popover.tsx#L62) --- @@ -112,7 +97,7 @@ InheritedProps.searchValue #### Defined in -[packages/components/src/filter/filter-provider.tsx:84](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter-provider.tsx#L84) +[packages/components/src/filter/filter-provider.tsx:84](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter-provider.tsx#L84) --- @@ -126,7 +111,7 @@ InheritedProps.setSearchValue #### Defined in -[packages/components/src/filter/filter-provider.tsx:85](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter-provider.tsx#L85) +[packages/components/src/filter/filter-provider.tsx:85](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter-provider.tsx#L85) --- @@ -140,7 +125,7 @@ InheritedProps.setValue #### Defined in -[packages/components/src/filter/filter-provider.tsx:88](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter-provider.tsx#L88) +[packages/components/src/filter/filter-provider.tsx:88](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter-provider.tsx#L88) --- @@ -154,4 +139,4 @@ InheritedProps.value #### Defined in -[packages/components/src/filter/filter-provider.tsx:87](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/filter/filter-provider.tsx#L87) +[packages/components/src/filter/filter-provider.tsx:87](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/filter/filter-provider.tsx#L87) diff --git a/packages/next-docs/pages/components/flex-props/code.mdx b/packages/next-docs/pages/components/flex-props/code.mdx deleted file mode 100644 index a6e255baaf..0000000000 --- a/packages/next-docs/pages/components/flex-props/code.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### FlexProps - -Ƭ **FlexProps**: `ComponentPropsWithoutRef`\<`"div"`\> & `FlexShorthandProps` - -#### Defined in - -[packages/components/src/flex/flex.tsx:52](https://github.com/vtex/shoreline/blob/dd054909f/packages/components/src/flex/flex.tsx#L52) diff --git a/packages/next-docs/pages/components/flex/code.mdx b/packages/next-docs/pages/components/flex/code.mdx index 07eccb9636..d5e4bfbca6 100644 --- a/packages/next-docs/pages/components/flex/code.mdx +++ b/packages/next-docs/pages/components/flex/code.mdx @@ -6,9 +6,9 @@ #### Parameters -| Name | Type | -| :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `props` | `Omit`\<`DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>, `HTMLDivElement`\>, `"ref"`\> & `FlexShorthandProps` & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `props` | [`Omit`](https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys)\<`DetailedHTMLProps`\<`HTMLAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\>, [`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\>, `"ref"`\> & `FlexShorthandProps` & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/flex/props.mdx b/packages/next-docs/pages/components/flex/props.mdx index 6fb0db9ca9..7cc2f89c0b 100644 --- a/packages/next-docs/pages/components/flex/props.mdx +++ b/packages/next-docs/pages/components/flex/props.mdx @@ -4,4 +4,4 @@ #### Defined in -[packages/components/src/flex/flex.tsx:52](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/flex/flex.tsx#L52) +[packages/components/src/flex/flex.tsx:52](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/flex/flex.tsx#L52) diff --git a/packages/next-docs/pages/components/grid-cell-props/code.mdx b/packages/next-docs/pages/components/grid-cell-props/code.mdx deleted file mode 100644 index e8010e89ea..0000000000 --- a/packages/next-docs/pages/components/grid-cell-props/code.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### GridCellProps - -Ƭ **GridCellProps**: `ComponentPropsWithoutRef`\<`"div"`\> & [`GridCellShorthandProps`](interfaces/GridCellShorthandProps.md) - -#### Defined in - -[packages/components/src/grid/grid-cell.tsx:42](https://github.com/vtex/shoreline/blob/dd054909f/packages/components/src/grid/grid-cell.tsx#L42) diff --git a/packages/next-docs/pages/components/grid-cell/code.mdx b/packages/next-docs/pages/components/grid-cell/code.mdx index be91909c39..ff4fbf3fae 100644 --- a/packages/next-docs/pages/components/grid-cell/code.mdx +++ b/packages/next-docs/pages/components/grid-cell/code.mdx @@ -6,9 +6,9 @@ #### Parameters -| Name | Type | -| :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `props` | `Omit`\<`DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>, `HTMLDivElement`\>, `"ref"`\> & [`GridCellShorthandProps`](interfaces/GridCellShorthandProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`Omit`](https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys)\<`DetailedHTMLProps`\<`HTMLAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\>, [`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\>, `"ref"`\> & [`GridCellShorthandProps`](interfaces/GridCellShorthandProps.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/grid-cell/props.mdx b/packages/next-docs/pages/components/grid-cell/props.mdx index f6103cf8a3..cfc8b94273 100644 --- a/packages/next-docs/pages/components/grid-cell/props.mdx +++ b/packages/next-docs/pages/components/grid-cell/props.mdx @@ -4,4 +4,4 @@ #### Defined in -[packages/components/src/grid/grid-cell.tsx:42](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/grid/grid-cell.tsx#L42) +[packages/components/src/grid/grid-cell.tsx:42](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/grid/grid-cell.tsx#L42) diff --git a/packages/next-docs/pages/components/grid-props/code.mdx b/packages/next-docs/pages/components/grid-props/code.mdx deleted file mode 100644 index 986d8d1337..0000000000 --- a/packages/next-docs/pages/components/grid-props/code.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### GridProps - -Ƭ **GridProps**: `ComponentPropsWithoutRef`\<`"div"`\> & [`GridShorthandProps`](interfaces/GridShorthandProps.md) - -#### Defined in - -[packages/components/src/grid/grid.tsx:44](https://github.com/vtex/shoreline/blob/dd054909f/packages/components/src/grid/grid.tsx#L44) diff --git a/packages/next-docs/pages/components/grid/code.mdx b/packages/next-docs/pages/components/grid/code.mdx index 8352949dab..f44d61fb3f 100644 --- a/packages/next-docs/pages/components/grid/code.mdx +++ b/packages/next-docs/pages/components/grid/code.mdx @@ -6,9 +6,9 @@ #### Parameters -| Name | Type | -| :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `props` | `Omit`\<`DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>, `HTMLDivElement`\>, `"ref"`\> & [`GridShorthandProps`](interfaces/GridShorthandProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `props` | [`Omit`](https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys)\<`DetailedHTMLProps`\<`HTMLAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\>, [`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\>, `"ref"`\> & [`GridShorthandProps`](interfaces/GridShorthandProps.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/grid/props.mdx b/packages/next-docs/pages/components/grid/props.mdx index 37eb050cc8..39c5095b02 100644 --- a/packages/next-docs/pages/components/grid/props.mdx +++ b/packages/next-docs/pages/components/grid/props.mdx @@ -4,4 +4,4 @@ #### Defined in -[packages/components/src/grid/grid.tsx:44](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/grid/grid.tsx#L44) +[packages/components/src/grid/grid.tsx:44](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/grid/grid.tsx#L44) diff --git a/packages/next-docs/pages/components/icon-button/code.mdx b/packages/next-docs/pages/components/icon-button/code.mdx index 18d8bde31d..467c5ed3ac 100644 --- a/packages/next-docs/pages/components/icon-button/code.mdx +++ b/packages/next-docs/pages/components/icon-button/code.mdx @@ -6,9 +6,9 @@ A button designed specifically for usage with a single icon. #### Parameters -| Name | Type | -| :------ | :------------------------------------------------------------------------------------------ | -| `props` | [`IconButtonProps`](interfaces/IconButtonProps.md) & `RefAttributes`\<`HTMLButtonElement`\> | +| Name | Type | +| :------ | :------------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`IconButtonProps`](props.md) & `RefAttributes`\<[`HTMLButtonElement`](https://developer.mozilla.org/docs/Web/API/HTMLButtonElement)\> | #### Returns @@ -16,12 +16,36 @@ A button designed specifically for usage with a single icon. **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + + )}`, + }} + +> + + + + + + + #### Defined in node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355 diff --git a/packages/next-docs/pages/components/icon-button/props.mdx b/packages/next-docs/pages/components/icon-button/props.mdx index fe54d41028..bbf0acc03a 100644 --- a/packages/next-docs/pages/components/icon-button/props.mdx +++ b/packages/next-docs/pages/components/icon-button/props.mdx @@ -6,17 +6,6 @@ ↳ **`IconButtonProps`** -## Table of contents - -### Properties - -- [asChild](props.md#aschild) -- [children](props.md#children) -- [label](props.md#label) -- [loading](props.md#loading) -- [size](props.md#size) -- [variant](props.md#variant) - ## Properties ### asChild @@ -37,7 +26,7 @@ false; #### Defined in -[packages/components/src/button/button.tsx:95](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/button/button.tsx#L95) +[packages/components/src/button/button.tsx:95](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/button/button.tsx#L95) --- @@ -51,7 +40,7 @@ false; #### Defined in -[packages/components/src/button/button.tsx:70](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/button/button.tsx#L70) +[packages/components/src/button/button.tsx:70](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/button/button.tsx#L70) --- @@ -61,7 +50,7 @@ false; #### Defined in -[packages/components/src/icon-button/icon-button.tsx:33](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/icon-button/icon-button.tsx#L33) +[packages/components/src/icon-button/icon-button.tsx:33](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/icon-button/icon-button.tsx#L33) --- @@ -83,7 +72,7 @@ false; #### Defined in -[packages/components/src/button/button.tsx:90](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/button/button.tsx#L90) +[packages/components/src/button/button.tsx:90](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/button/button.tsx#L90) --- @@ -96,7 +85,7 @@ Increase or decrease padding. **`Default`** ```ts -normal; +"normal"; ``` #### Inherited from @@ -105,7 +94,7 @@ normal; #### Defined in -[packages/components/src/button/button.tsx:75](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/button/button.tsx#L75) +[packages/components/src/button/button.tsx:75](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/button/button.tsx#L75) --- @@ -127,4 +116,4 @@ Change between color combinations. #### Defined in -[packages/components/src/button/button.tsx:80](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/button/button.tsx#L80) +[packages/components/src/button/button.tsx:80](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/button/button.tsx#L80) diff --git a/packages/next-docs/pages/components/interfaces/code.mdx b/packages/next-docs/pages/components/interfaces/code.mdx deleted file mode 100644 index e07072c4b3..0000000000 --- a/packages/next-docs/pages/components/interfaces/code.mdx +++ /dev/null @@ -1,196 +0,0 @@ -# shoreline - -## Table of contents - -### Interfaces - -- [AccessibleIconProps](interfaces/AccessibleIconProps.md) -- [AlertProps](interfaces/AlertProps.md) -- [BleedProps](interfaces/BleedProps.md) -- [ButtonProps](interfaces/ButtonProps.md) -- [CheckboxFieldProps](interfaces/CheckboxFieldProps.md) -- [CheckboxGroupProps](interfaces/CheckboxGroupProps.md) -- [CheckboxProps](interfaces/CheckboxProps.md) -- [ClickableBubbleProps](interfaces/ClickableBubbleProps.md) -- [ClickableProps](interfaces/ClickableProps.md) -- [ComboboxItemProps](interfaces/ComboboxItemProps.md) -- [ComboboxListProps](interfaces/ComboboxListProps.md) -- [ComboboxPopoverProps](interfaces/ComboboxPopoverProps.md) -- [ComboboxProps](interfaces/ComboboxProps.md) -- [ComposableProps](interfaces/ComposableProps.md) -- [ComposeProps](interfaces/ComposeProps.md) -- [ContainerProps](interfaces/ContainerProps.md) -- [ContentProps](interfaces/ContentProps.md) -- [FieldLabelProps](interfaces/FieldLabelProps.md) -- [FieldMessageProps](interfaces/FieldMessageProps.md) -- [FieldProps](interfaces/FieldProps.md) -- [FilterPopoverProps](interfaces/FilterPopoverProps.md) -- [FilterProps](interfaces/FilterProps.md) -- [FilterProviderProps](interfaces/FilterProviderProps.md) -- [GridCellShorthandProps](interfaces/GridCellShorthandProps.md) -- [GridShorthandProps](interfaces/GridShorthandProps.md) -- [IconButtonProps](interfaces/IconButtonProps.md) -- [LinkBoxProps](interfaces/LinkBoxProps.md) -- [LinkProps](interfaces/LinkProps.md) -- [LocaleProviderProps](interfaces/LocaleProviderProps.md) -- [MenuItemProps](interfaces/MenuItemProps.md) -- [MenuProps](interfaces/MenuProps.md) -- [ModalProps](interfaces/ModalProps.md) -- [PaginationProps](interfaces/PaginationProps.md) -- [PopoverDismissProps](interfaces/PopoverDismissProps.md) -- [PopoverProps](interfaces/PopoverProps.md) -- [PopoverTriggerProps](interfaces/PopoverTriggerProps.md) -- [RadioGroupProps](interfaces/RadioGroupProps.md) -- [RadioGroupState](interfaces/RadioGroupState.md) -- [RadioProps](interfaces/RadioProps.md) -- [ScrollAreaProps](interfaces/ScrollAreaProps.md) -- [SearchProps](interfaces/SearchProps.md) -- [SelectFieldProps](interfaces/SelectFieldProps.md) -- [SelectListProps](interfaces/SelectListProps.md) -- [SelectOptionCheckProps](interfaces/SelectOptionCheckProps.md) -- [SelectOptionProps](interfaces/SelectOptionProps.md) -- [SelectPopoverProps](interfaces/SelectPopoverProps.md) -- [SelectProps](interfaces/SelectProps.md) -- [SimpleTableProps](interfaces/SimpleTableProps.md) -- [SkeletonProps](interfaces/SkeletonProps.md) -- [SpinnerProps](interfaces/SpinnerProps.md) -- [StackProps](interfaces/StackProps.md) -- [TabListProps](interfaces/TabListProps.md) -- [TabPanelProps](interfaces/TabPanelProps.md) -- [TabProps](interfaces/TabProps.md) -- [TableBodyProps](interfaces/TableBodyProps.md) -- [TableCellProps](interfaces/TableCellProps.md) -- [TableHeaderCellProps](interfaces/TableHeaderCellProps.md) -- [TableHeaderProps](interfaces/TableHeaderProps.md) -- [TableProps](interfaces/TableProps.md) -- [TableRowProps](interfaces/TableRowProps.md) -- [TagProps](interfaces/TagProps.md) -- [TextInputProps](interfaces/TextInputProps.md) -- [TextareaProps](interfaces/TextareaProps.md) -- [TooltipAnchorProps](interfaces/TooltipAnchorProps.md) -- [TooltipArrowProps](interfaces/TooltipArrowProps.md) -- [TooltipPopoverProps](interfaces/TooltipPopoverProps.md) -- [TooltipProps](interfaces/TooltipProps.md) -- [VisuallyHiddenProps](interfaces/VisuallyHiddenProps.md) - -### Type Aliases - -- [ActionProps](modules.md#actionprops) -- [CenterProps](modules.md#centerprops) -- [FilterApplyProps](modules.md#filterapplyprops) -- [FilterClearProps](modules.md#filterclearprops) -- [FilterListProps](modules.md#filterlistprops) -- [FilterOptionProps](modules.md#filteroptionprops) -- [FilterTriggerProps](modules.md#filtertriggerprops) -- [FilterValueProps](modules.md#filtervalueprops) -- [FlexProps](modules.md#flexprops) -- [GridCellProps](modules.md#gridcellprops) -- [GridProps](modules.md#gridprops) -- [MenuSeparatorProps](modules.md#menuseparatorprops) -- [ModalHeaderProps](modules.md#modalheaderprops) -- [TextProps](modules.md#textprops) - -### Variables - -- [FilterContext](modules.md#filtercontext) - -### Functions - -- [AccessibleIcon](modules.md#accessibleicon) -- [Action](modules.md#action) -- [Alert](modules.md#alert) -- [Bleed](modules.md#bleed) -- [Button](modules.md#button) -- [Center](modules.md#center) -- [Checkbox](modules.md#checkbox) -- [CheckboxField](modules.md#checkboxfield) -- [CheckboxGroup](modules.md#checkboxgroup) -- [Clickable](modules.md#clickable) -- [ClickableBubble](modules.md#clickablebubble) -- [Combobox](modules.md#combobox) -- [ComboboxItem](modules.md#comboboxitem) -- [ComboboxList](modules.md#comboboxlist) -- [ComboboxPopover](modules.md#comboboxpopover) -- [Composable](modules.md#composable) -- [Compose](modules.md#compose) -- [Container](modules.md#container) -- [Content](modules.md#content) -- [Field](modules.md#field) -- [FieldLabel](modules.md#fieldlabel) -- [FieldMessage](modules.md#fieldmessage) -- [Filter](modules.md#filter) -- [FilterApply](modules.md#filterapply) -- [FilterClear](modules.md#filterclear) -- [FilterList](modules.md#filterlist) -- [FilterOption](modules.md#filteroption) -- [FilterPopover](modules.md#filterpopover) -- [FilterProvider](modules.md#filterprovider) -- [FilterTrigger](modules.md#filtertrigger) -- [FilterValue](modules.md#filtervalue) -- [Flex](modules.md#flex) -- [Grid](modules.md#grid) -- [GridCell](modules.md#gridcell) -- [IconButton](modules.md#iconbutton) -- [Link](modules.md#link) -- [LinkBox](modules.md#linkbox) -- [LocaleProvider](modules.md#localeprovider) -- [Menu](modules.md#menu) -- [MenuItem](modules.md#menuitem) -- [MenuSeparator](modules.md#menuseparator) -- [MenuTrigger](modules.md#menutrigger) -- [Modal](modules.md#modal) -- [ModalHeader](modules.md#modalheader) -- [Pagination](modules.md#pagination) -- [Popover](modules.md#popover) -- [PopoverDismiss](modules.md#popoverdismiss) -- [PopoverTrigger](modules.md#popovertrigger) -- [Radio](modules.md#radio) -- [RadioGroup](modules.md#radiogroup) -- [ScrollArea](modules.md#scrollarea) -- [Search](modules.md#search) -- [Select](modules.md#select) -- [SelectField](modules.md#selectfield) -- [SelectList](modules.md#selectlist) -- [SelectOption](modules.md#selectoption) -- [SelectOptionCheck](modules.md#selectoptioncheck) -- [SelectPopover](modules.md#selectpopover) -- [SimpleTable](modules.md#simpletable) -- [Skeleton](modules.md#skeleton) -- [Spinner](modules.md#spinner) -- [Stack](modules.md#stack) -- [Tab](modules.md#tab) -- [TabList](modules.md#tablist) -- [TabPanel](modules.md#tabpanel) -- [Table](modules.md#table) -- [TableBody](modules.md#tablebody) -- [TableCell](modules.md#tablecell) -- [TableHeader](modules.md#tableheader) -- [TableHeaderCell](modules.md#tableheadercell) -- [TableRow](modules.md#tablerow) -- [Tag](modules.md#tag) -- [Text](modules.md#text) -- [TextInput](modules.md#textinput) -- [Textarea](modules.md#textarea) -- [Tooltip](modules.md#tooltip) -- [TooltipAnchor](modules.md#tooltipanchor) -- [TooltipArrow](modules.md#tooltiparrow) -- [TooltipPopover](modules.md#tooltippopover) -- [VisuallyHidden](modules.md#visuallyhidden) -- [createMessageHook](modules.md#createmessagehook) -- [get](modules.md#get) -- [getExpandedColumn](modules.md#getexpandedcolumn) -- [getSelectionColum](modules.md#getselectioncolum) -- [isComposable](modules.md#iscomposable) -- [useFilterContext](modules.md#usefiltercontext) -- [useLocale](modules.md#uselocale) -- [useRadioState](modules.md#useradiostate) - -## Type Aliases - -### ActionProps - -Ƭ **ActionProps**: `Omit`\<[`ButtonProps`](interfaces/ButtonProps.md), `"variant"`\> & \{ `iconOnly?`: `boolean` ; `label?`: `ReactNode` ; `vertical?`: `boolean` } - -#### Defined in - -[packages/components/src/action/action.tsx:34](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/action/action.tsx#L34) diff --git a/packages/next-docs/pages/components/link-box/code.mdx b/packages/next-docs/pages/components/link-box/code.mdx index 53a54c024c..dd53a4f648 100644 --- a/packages/next-docs/pages/components/link-box/code.mdx +++ b/packages/next-docs/pages/components/link-box/code.mdx @@ -6,9 +6,9 @@ A container that acts as a link. It allows text selection and stop its children #### Parameters -| Name | Type | -| :------ | :--------------------------------------------------------------------------------- | -| `props` | [`LinkBoxProps`](interfaces/LinkBoxProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :---------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`LinkBoxProps`](props.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns @@ -16,7 +16,7 @@ A container that acts as a link. It allows text selection and stop its children **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx
... @@ -25,6 +25,29 @@ A container that acts as a link. It allows text selection and stop its children ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + +
...
)}`, + }} + +> + + + + + +
+ #### Defined in packages/utils/dist/index.d.ts:183 diff --git a/packages/next-docs/pages/components/link-box/props.mdx b/packages/next-docs/pages/components/link-box/props.mdx index 29cf2f2ee4..cbf4abf6c2 100644 --- a/packages/next-docs/pages/components/link-box/props.mdx +++ b/packages/next-docs/pages/components/link-box/props.mdx @@ -2,18 +2,10 @@ ## Hierarchy -- `Omit`\<[`ClickableProps`](ClickableProps.md), `"onClick"`\> +- [`Omit`](https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys)\<[`ClickableProps`](ClickableProps.md), `"onClick"`\> ↳ **`LinkBoxProps`** -## Table of contents - -### Properties - -- [asChild](props.md#aschild) -- [href](props.md#href) -- [target](props.md#target) - ## Properties ### asChild @@ -34,7 +26,7 @@ Omit.asChild #### Defined in -[packages/components/src/clickable/clickable.tsx:52](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/clickable/clickable.tsx#L52) +[packages/components/src/clickable/clickable.tsx:52](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/clickable/clickable.tsx#L52) --- @@ -50,7 +42,7 @@ https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#href #### Defined in -[packages/components/src/link-box/link-box.tsx:43](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/link-box/link-box.tsx#L43) +[packages/components/src/link-box/link-box.tsx:43](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/link-box/link-box.tsx#L43) --- @@ -72,4 +64,4 @@ https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target #### Defined in -[packages/components/src/link-box/link-box.tsx:49](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/link-box/link-box.tsx#L49) +[packages/components/src/link-box/link-box.tsx:49](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/link-box/link-box.tsx#L49) diff --git a/packages/next-docs/pages/components/link/code.mdx b/packages/next-docs/pages/components/link/code.mdx index 51831d0826..cdb39ba2b0 100644 --- a/packages/next-docs/pages/components/link/code.mdx +++ b/packages/next-docs/pages/components/link/code.mdx @@ -6,9 +6,9 @@ Anchor component #### Parameters -| Name | Type | -| :------ | :------------------------------------------------------------------------------ | -| `props` | [`LinkProps`](interfaces/LinkProps.md) & `RefAttributes`\<`HTMLAnchorElement`\> | +| Name | Type | +| :------ | :------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`LinkProps`](props.md) & `RefAttributes`\<[`HTMLAnchorElement`](https://developer.mozilla.org/docs/Web/API/HTMLAnchorElement)\> | #### Returns @@ -16,10 +16,33 @@ Anchor component **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx Go to VTEX ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + +Go to VTEX)}`, + }} + +> + + + + + + + #### Defined in node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355 diff --git a/packages/next-docs/pages/components/link/props.mdx b/packages/next-docs/pages/components/link/props.mdx index 4ebf82f4de..a4d9350376 100644 --- a/packages/next-docs/pages/components/link/props.mdx +++ b/packages/next-docs/pages/components/link/props.mdx @@ -6,12 +6,6 @@ ↳ **`LinkProps`** -## Table of contents - -### Properties - -- [asChild](props.md#aschild) - ## Properties ### asChild @@ -28,4 +22,4 @@ false; #### Defined in -[packages/components/src/link/link.tsx:27](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/link/link.tsx#L27) +[packages/components/src/link/link.tsx:27](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/link/link.tsx#L27) diff --git a/packages/next-docs/pages/components/locale-provider/code.mdx b/packages/next-docs/pages/components/locale-provider/code.mdx index 61931a9d05..4d9ec99b7c 100644 --- a/packages/next-docs/pages/components/locale-provider/code.mdx +++ b/packages/next-docs/pages/components/locale-provider/code.mdx @@ -6,9 +6,9 @@ Provides the locale #### Parameters -| Name | Type | -| :------ | :--------------------------------------------------------- | -| `props` | [`LocaleProviderProps`](interfaces/LocaleProviderProps.md) | +| Name | Type | +| :------ | :-------------------------------- | +| `props` | [`LocaleProviderProps`](props.md) | #### Returns @@ -16,10 +16,33 @@ Provides the locale **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx ... ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + + ...)}`, + }} + +> + + + + + + + #### Defined in -[packages/components/src/locale/locale-provider.tsx:12](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/locale/locale-provider.tsx#L12) +[packages/components/src/locale/locale-provider.tsx:12](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/locale/locale-provider.tsx#L12) diff --git a/packages/next-docs/pages/components/locale-provider/props.mdx b/packages/next-docs/pages/components/locale-provider/props.mdx index 42776b2799..c87e8255aa 100644 --- a/packages/next-docs/pages/components/locale-provider/props.mdx +++ b/packages/next-docs/pages/components/locale-provider/props.mdx @@ -1,12 +1,5 @@ # LocaleProviderProps -## Table of contents - -### Properties - -- [children](props.md#children) -- [locale](props.md#locale) - ## Properties ### children @@ -15,7 +8,7 @@ #### Defined in -[packages/components/src/locale/locale-provider.tsx:26](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/locale/locale-provider.tsx#L26) +[packages/components/src/locale/locale-provider.tsx:26](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/locale/locale-provider.tsx#L26) --- @@ -31,4 +24,4 @@ https://www.ietf.org/rfc/bcp/bcp47.txt #### Defined in -[packages/components/src/locale/locale-provider.tsx:25](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/locale/locale-provider.tsx#L25) +[packages/components/src/locale/locale-provider.tsx:25](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/locale/locale-provider.tsx#L25) diff --git a/packages/next-docs/pages/components/menu-item/code.mdx b/packages/next-docs/pages/components/menu-item/code.mdx index a391a7a312..ae959da1fe 100644 --- a/packages/next-docs/pages/components/menu-item/code.mdx +++ b/packages/next-docs/pages/components/menu-item/code.mdx @@ -6,9 +6,9 @@ #### Parameters -| Name | Type | -| :------ | :----------------------------------------------------------------------------------- | -| `props` | [`MenuItemProps`](interfaces/MenuItemProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :----------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`MenuItemProps`](props.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/menu-item/props.mdx b/packages/next-docs/pages/components/menu-item/props.mdx index c91eb1edf0..9573c731e0 100644 --- a/packages/next-docs/pages/components/menu-item/props.mdx +++ b/packages/next-docs/pages/components/menu-item/props.mdx @@ -6,14 +6,6 @@ ↳ **`MenuItemProps`** -## Table of contents - -### Properties - -- [asChild](props.md#aschild) -- [critical](props.md#critical) -- [disabled](props.md#disabled) - ## Properties ### asChild @@ -30,7 +22,7 @@ false; #### Defined in -[packages/components/src/menu/menu-item.tsx:36](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/menu/menu-item.tsx#L36) +[packages/components/src/menu/menu-item.tsx:36](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/menu/menu-item.tsx#L36) --- @@ -48,7 +40,7 @@ false; #### Defined in -[packages/components/src/menu/menu-item.tsx:41](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/menu/menu-item.tsx#L41) +[packages/components/src/menu/menu-item.tsx:41](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/menu/menu-item.tsx#L41) --- @@ -66,4 +58,4 @@ false; #### Defined in -[packages/components/src/menu/menu-item.tsx:46](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/menu/menu-item.tsx#L46) +[packages/components/src/menu/menu-item.tsx:46](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/menu/menu-item.tsx#L46) diff --git a/packages/next-docs/pages/components/menu-provider/code.mdx b/packages/next-docs/pages/components/menu-provider/code.mdx deleted file mode 100644 index 7d7ea9bb58..0000000000 --- a/packages/next-docs/pages/components/menu-provider/code.mdx +++ /dev/null @@ -1,57 +0,0 @@ -### MenuProvider - -▸ **MenuProvider**\<`T`\>(`props`): `ReactElement` - -Provides a menu store to Menu components. - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------- | -| `T` | extends `MenuStoreValues` = `MenuStoreValues` | - -#### Parameters - -| Name | Type | -| :------ | :---------------------------------------------------------------------------- | -| `props` | `PickRequired`\<`MenuProviderProps`\<`T`\>, `"values"` \| `"defaultValues"`\> | - -#### Returns - -`ReactElement` - -**`See`** - -https://ariakit.org/components/menu - -**`Example`** - -```jsx - - Edit - - Undo - Redo - - -``` - -#### Defined in - -node_modules/.pnpm/@ariakit+react-core@0.3.5_react-dom@18.2.0_react@18.2.0/node_modules/@ariakit/react-core/cjs/menu/menu-provider.d.ts:19 - -▸ **MenuProvider**(`props?`): `ReactElement` - -#### Parameters - -| Name | Type | -| :------- | :--------------------------------------- | -| `props?` | `MenuProviderProps`\<`MenuStoreValues`\> | - -#### Returns - -`ReactElement` - -#### Defined in - -node_modules/.pnpm/@ariakit+react-core@0.3.5_react-dom@18.2.0_react@18.2.0/node_modules/@ariakit/react-core/cjs/menu/menu-provider.d.ts:20 diff --git a/packages/next-docs/pages/components/menu-separator-props/code.mdx b/packages/next-docs/pages/components/menu-separator-props/code.mdx deleted file mode 100644 index 01d2f9cd0b..0000000000 --- a/packages/next-docs/pages/components/menu-separator-props/code.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### MenuSeparatorProps - -Ƭ **MenuSeparatorProps**: `ComponentPropsWithoutRef`\<`"hr"`\> - -#### Defined in - -[packages/components/src/menu/menu-separator.tsx:11](https://github.com/vtex/shoreline/blob/dd054909f/packages/components/src/menu/menu-separator.tsx#L11) diff --git a/packages/next-docs/pages/components/menu-separator/code.mdx b/packages/next-docs/pages/components/menu-separator/code.mdx index 1e16bcc529..aaa99c64f1 100644 --- a/packages/next-docs/pages/components/menu-separator/code.mdx +++ b/packages/next-docs/pages/components/menu-separator/code.mdx @@ -6,9 +6,9 @@ #### Parameters -| Name | Type | -| :------ | :---------------------------------------------------------------------------------------------------------------------------------- | -| `props` | `Omit`\<`DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLHRElement`\>, `HTMLHRElement`\>, `"ref"`\> & `RefAttributes`\<`HTMLHRElement`\> | +| Name | Type | +| :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`Omit`](https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys)\<`DetailedHTMLProps`\<`HTMLAttributes`\<[`HTMLHRElement`](https://developer.mozilla.org/docs/Web/API/HTMLHRElement)\>, [`HTMLHRElement`](https://developer.mozilla.org/docs/Web/API/HTMLHRElement)\>, `"ref"`\> & `RefAttributes`\<[`HTMLHRElement`](https://developer.mozilla.org/docs/Web/API/HTMLHRElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/menu-separator/props.mdx b/packages/next-docs/pages/components/menu-separator/props.mdx index 926696fcf6..6d89885acc 100644 --- a/packages/next-docs/pages/components/menu-separator/props.mdx +++ b/packages/next-docs/pages/components/menu-separator/props.mdx @@ -4,4 +4,4 @@ #### Defined in -[packages/components/src/menu/menu-separator.tsx:11](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/menu/menu-separator.tsx#L11) +[packages/components/src/menu/menu-separator.tsx:11](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/menu/menu-separator.tsx#L11) diff --git a/packages/next-docs/pages/components/menu-trigger/code.mdx b/packages/next-docs/pages/components/menu-trigger/code.mdx index 377d3ebece..38b9a13ecc 100644 --- a/packages/next-docs/pages/components/menu-trigger/code.mdx +++ b/packages/next-docs/pages/components/menu-trigger/code.mdx @@ -6,9 +6,9 @@ #### Parameters -| Name | Type | -| :------ | :---------------------------------------------------------- | -| `props` | `MenuTriggerProps` & `RefAttributes`\<`HTMLButtonElement`\> | +| Name | Type | +| :------ | :-------------------------------------------------------------------------------------------------------------------------- | +| `props` | `MenuTriggerProps` & `RefAttributes`\<[`HTMLButtonElement`](https://developer.mozilla.org/docs/Web/API/HTMLButtonElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/menu/code.mdx b/packages/next-docs/pages/components/menu/code.mdx index 32cfbf62a3..34859aff7d 100644 --- a/packages/next-docs/pages/components/menu/code.mdx +++ b/packages/next-docs/pages/components/menu/code.mdx @@ -6,9 +6,9 @@ #### Parameters -| Name | Type | -| :------ | :--------------------------------------------------------------------------- | -| `props` | [`MenuProps`](interfaces/MenuProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`MenuProps`](props.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/menu/props.mdx b/packages/next-docs/pages/components/menu/props.mdx index e1989bb0fb..cdf0df53b0 100644 --- a/packages/next-docs/pages/components/menu/props.mdx +++ b/packages/next-docs/pages/components/menu/props.mdx @@ -6,12 +6,6 @@ ↳ **`MenuProps`** -## Table of contents - -### Properties - -- [asChild](props.md#aschild) - ## Properties ### asChild @@ -28,4 +22,4 @@ false; #### Defined in -[packages/components/src/menu/menu.tsx:30](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/menu/menu.tsx#L30) +[packages/components/src/menu/menu.tsx:30](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/menu/menu.tsx#L30) diff --git a/packages/next-docs/pages/components/modal-header-props/code.mdx b/packages/next-docs/pages/components/modal-header-props/code.mdx deleted file mode 100644 index 5783354246..0000000000 --- a/packages/next-docs/pages/components/modal-header-props/code.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### ModalHeaderProps - -Ƭ **ModalHeaderProps**: `ComponentPropsWithoutRef`\<`"div"`\> - -#### Defined in - -[packages/components/src/modal/modal-header.tsx:31](https://github.com/vtex/shoreline/blob/dd054909f/packages/components/src/modal/modal-header.tsx#L31) diff --git a/packages/next-docs/pages/components/modal-header/code.mdx b/packages/next-docs/pages/components/modal-header/code.mdx index 53a20e2c40..fdeeabf20b 100644 --- a/packages/next-docs/pages/components/modal-header/code.mdx +++ b/packages/next-docs/pages/components/modal-header/code.mdx @@ -6,9 +6,9 @@ #### Parameters -| Name | Type | -| :------ | :------------------------------------------------------------------------------------------------------------------------------------- | -| `props` | `Omit`\<`DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>, `HTMLDivElement`\>, `"ref"`\> & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`Omit`](https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys)\<`DetailedHTMLProps`\<`HTMLAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\>, [`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\>, `"ref"`\> & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/modal-header/props.mdx b/packages/next-docs/pages/components/modal-header/props.mdx index 29fc39ed01..6f3a024459 100644 --- a/packages/next-docs/pages/components/modal-header/props.mdx +++ b/packages/next-docs/pages/components/modal-header/props.mdx @@ -4,4 +4,4 @@ #### Defined in -[packages/components/src/modal/modal-header.tsx:31](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/modal/modal-header.tsx#L31) +[packages/components/src/modal/modal-header.tsx:31](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/modal/modal-header.tsx#L31) diff --git a/packages/next-docs/pages/components/modal/code.mdx b/packages/next-docs/pages/components/modal/code.mdx index bb12c5042e..d7d2822c9f 100644 --- a/packages/next-docs/pages/components/modal/code.mdx +++ b/packages/next-docs/pages/components/modal/code.mdx @@ -6,9 +6,9 @@ #### Parameters -| Name | Type | -| :------ | :----------------------------------------------------------------------------- | -| `props` | [`ModalProps`](interfaces/ModalProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :-------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`ModalProps`](props.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/modal/props.mdx b/packages/next-docs/pages/components/modal/props.mdx index 398af367e3..b4617e94a5 100644 --- a/packages/next-docs/pages/components/modal/props.mdx +++ b/packages/next-docs/pages/components/modal/props.mdx @@ -6,18 +6,11 @@ ↳ **`ModalProps`** -## Table of contents - -### Properties - -- [onClose](props.md#onclose) -- [open](props.md#open) - ## Properties ### onClose -• `Optional` **onClose**: (`event`: `Event`) => `void` +• `Optional` **onClose**: (`event`: [`Event`](https://developer.mozilla.org/docs/Web/API/Event)) => `void` #### Type declaration @@ -25,9 +18,9 @@ ##### Parameters -| Name | Type | -| :------ | :------ | -| `event` | `Event` | +| Name | Type | +| :------ | :---------------------------------------------------------- | +| `event` | [`Event`](https://developer.mozilla.org/docs/Web/API/Event) | ##### Returns @@ -35,7 +28,7 @@ #### Defined in -[packages/components/src/modal/modal.tsx:27](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/modal/modal.tsx#L27) +[packages/components/src/modal/modal.tsx:27](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/modal/modal.tsx#L27) --- @@ -45,4 +38,4 @@ #### Defined in -[packages/components/src/modal/modal.tsx:28](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/modal/modal.tsx#L28) +[packages/components/src/modal/modal.tsx:28](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/modal/modal.tsx#L28) diff --git a/packages/next-docs/pages/components/pagination/code.mdx b/packages/next-docs/pages/components/pagination/code.mdx index e6ef117a01..08f4d4fd5e 100644 --- a/packages/next-docs/pages/components/pagination/code.mdx +++ b/packages/next-docs/pages/components/pagination/code.mdx @@ -6,9 +6,9 @@ Pagination triggers allow merchants to view the size of a list and navigate betw #### Parameters -| Name | Type | -| :------ | :--------------------------------------------------------------------------------------- | -| `props` | [`PaginationProps`](interfaces/PaginationProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`PaginationProps`](props.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns @@ -16,7 +16,7 @@ Pagination triggers allow merchants to view the size of a list and navigate betw **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx {}} @@ -27,6 +27,29 @@ Pagination triggers allow merchants to view the size of a list and navigate betw /> ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + + {}} total={total} size={size} sizeOptions={[25, 50, 100]} onSizeChange={(size) => {}}/>)}`, +}} + +> + + + + + + + #### Defined in node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355 diff --git a/packages/next-docs/pages/components/pagination/props.mdx b/packages/next-docs/pages/components/pagination/props.mdx index b1a2d79567..aed5d65fd6 100644 --- a/packages/next-docs/pages/components/pagination/props.mdx +++ b/packages/next-docs/pages/components/pagination/props.mdx @@ -6,17 +6,6 @@ ↳ **`PaginationProps`** -## Table of contents - -### Properties - -- [onPageChange](props.md#onpagechange) -- [onSizeChange](props.md#onsizechange) -- [page](props.md#page) -- [size](props.md#size) -- [sizeOptions](props.md#sizeoptions) -- [total](props.md#total) - ## Properties ### onPageChange @@ -40,7 +29,7 @@ #### Defined in -[packages/components/src/pagination/pagination.tsx:114](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/pagination/pagination.tsx#L114) +[packages/components/src/pagination/pagination.tsx:114](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/pagination/pagination.tsx#L114) --- @@ -64,7 +53,7 @@ #### Defined in -[packages/components/src/pagination/pagination.tsx:115](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/pagination/pagination.tsx#L115) +[packages/components/src/pagination/pagination.tsx:115](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/pagination/pagination.tsx#L115) --- @@ -74,7 +63,7 @@ #### Defined in -[packages/components/src/pagination/pagination.tsx:118](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/pagination/pagination.tsx#L118) +[packages/components/src/pagination/pagination.tsx:118](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/pagination/pagination.tsx#L118) --- @@ -84,7 +73,7 @@ #### Defined in -[packages/components/src/pagination/pagination.tsx:117](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/pagination/pagination.tsx#L117) +[packages/components/src/pagination/pagination.tsx:117](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/pagination/pagination.tsx#L117) --- @@ -94,7 +83,7 @@ #### Defined in -[packages/components/src/pagination/pagination.tsx:116](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/pagination/pagination.tsx#L116) +[packages/components/src/pagination/pagination.tsx:116](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/pagination/pagination.tsx#L116) --- @@ -104,4 +93,4 @@ #### Defined in -[packages/components/src/pagination/pagination.tsx:119](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/pagination/pagination.tsx#L119) +[packages/components/src/pagination/pagination.tsx:119](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/pagination/pagination.tsx#L119) diff --git a/packages/next-docs/pages/components/popover-dismiss/code.mdx b/packages/next-docs/pages/components/popover-dismiss/code.mdx index 565b2d073a..3458c6f27b 100644 --- a/packages/next-docs/pages/components/popover-dismiss/code.mdx +++ b/packages/next-docs/pages/components/popover-dismiss/code.mdx @@ -6,9 +6,9 @@ Dismiss the Popover #### Parameters -| Name | Type | -| :------ | :-------------------------------------------------------------------------------------------------- | -| `props` | [`PopoverDismissProps`](interfaces/PopoverDismissProps.md) & `RefAttributes`\<`HTMLButtonElement`\> | +| Name | Type | +| :------ | :----------------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`PopoverDismissProps`](props.md) & `RefAttributes`\<[`HTMLButtonElement`](https://developer.mozilla.org/docs/Web/API/HTMLButtonElement)\> | #### Returns @@ -16,7 +16,7 @@ Dismiss the Popover **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx Dismiss @@ -24,6 +24,31 @@ Dismiss the Popover ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + + Dismiss )}`, + }} + +> + + + + + + + #### Defined in node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355 diff --git a/packages/next-docs/pages/components/popover-dismiss/props.mdx b/packages/next-docs/pages/components/popover-dismiss/props.mdx index 65d9a772ef..23c5145027 100644 --- a/packages/next-docs/pages/components/popover-dismiss/props.mdx +++ b/packages/next-docs/pages/components/popover-dismiss/props.mdx @@ -6,12 +6,6 @@ ↳ **`PopoverDismissProps`** -## Table of contents - -### Properties - -- [asChild](props.md#aschild) - ## Properties ### asChild @@ -28,4 +22,4 @@ false; #### Defined in -[packages/components/src/popover/popover-dismiss.tsx:38](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/popover/popover-dismiss.tsx#L38) +[packages/components/src/popover/popover-dismiss.tsx:38](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/popover/popover-dismiss.tsx#L38) diff --git a/packages/next-docs/pages/components/popover-provider/code.mdx b/packages/next-docs/pages/components/popover-provider/code.mdx deleted file mode 100644 index 4cf503abbe..0000000000 --- a/packages/next-docs/pages/components/popover-provider/code.mdx +++ /dev/null @@ -1,32 +0,0 @@ -### PopoverProvider - -▸ **PopoverProvider**(`props?`): `JSX.Element` - -Provides a popover store to Popover components. - -#### Parameters - -| Name | Type | -| :------- | :--------------------- | -| `props?` | `PopoverProviderProps` | - -#### Returns - -`JSX.Element` - -**`See`** - -https://ariakit.org/components/popover - -**`Example`** - -```jsx - - - - -``` - -#### Defined in - -node_modules/.pnpm/@ariakit+react-core@0.3.5_react-dom@18.2.0_react@18.2.0/node_modules/@ariakit/react-core/cjs/popover/popover-provider.d.ts:14 diff --git a/packages/next-docs/pages/components/popover-trigger/code.mdx b/packages/next-docs/pages/components/popover-trigger/code.mdx index df4da7677b..5a567aac07 100644 --- a/packages/next-docs/pages/components/popover-trigger/code.mdx +++ b/packages/next-docs/pages/components/popover-trigger/code.mdx @@ -6,9 +6,9 @@ Triggers popover containers #### Parameters -| Name | Type | -| :------ | :-------------------------------------------------------------------------------------------------- | -| `props` | [`PopoverTriggerProps`](interfaces/PopoverTriggerProps.md) & `RefAttributes`\<`HTMLButtonElement`\> | +| Name | Type | +| :------ | :----------------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`PopoverTriggerProps`](props.md) & `RefAttributes`\<[`HTMLButtonElement`](https://developer.mozilla.org/docs/Web/API/HTMLButtonElement)\> | #### Returns @@ -16,13 +16,38 @@ Triggers popover containers **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx Trigger Content ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + + Trigger Content )}`, + }} + +> + + + + + + + #### Defined in node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355 diff --git a/packages/next-docs/pages/components/popover-trigger/props.mdx b/packages/next-docs/pages/components/popover-trigger/props.mdx index d56891818e..0999074a45 100644 --- a/packages/next-docs/pages/components/popover-trigger/props.mdx +++ b/packages/next-docs/pages/components/popover-trigger/props.mdx @@ -6,12 +6,6 @@ ↳ **`PopoverTriggerProps`** -## Table of contents - -### Properties - -- [asChild](props.md#aschild) - ## Properties ### asChild @@ -28,4 +22,4 @@ false; #### Defined in -[packages/components/src/popover/popover-trigger.tsx:38](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/popover/popover-trigger.tsx#L38) +[packages/components/src/popover/popover-trigger.tsx:38](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/popover/popover-trigger.tsx#L38) diff --git a/packages/next-docs/pages/components/popover/code.mdx b/packages/next-docs/pages/components/popover/code.mdx index 34ff871180..8d4df1ae59 100644 --- a/packages/next-docs/pages/components/popover/code.mdx +++ b/packages/next-docs/pages/components/popover/code.mdx @@ -7,9 +7,9 @@ information of an item through an overlay. #### Parameters -| Name | Type | -| :------ | :--------------------------------------------------------------------------------- | -| `props` | [`PopoverProps`](interfaces/PopoverProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :---------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`PopoverProps`](props.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns @@ -17,13 +17,38 @@ information of an item through an overlay. **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx Trigger Content ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + + Trigger Content )}`, + }} + +> + + + + + + + #### Defined in node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355 diff --git a/packages/next-docs/pages/components/popover/props.mdx b/packages/next-docs/pages/components/popover/props.mdx index 19be4cf9bb..5a6acc0fcb 100644 --- a/packages/next-docs/pages/components/popover/props.mdx +++ b/packages/next-docs/pages/components/popover/props.mdx @@ -8,12 +8,6 @@ ↳↳ [`FilterPopoverProps`](FilterPopoverProps.md) -## Table of contents - -### Properties - -- [asChild](props.md#aschild) - ## Properties ### asChild @@ -30,4 +24,4 @@ false; #### Defined in -[packages/components/src/popover/popover.tsx:39](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/popover/popover.tsx#L39) +[packages/components/src/popover/popover.tsx:39](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/popover/popover.tsx#L39) diff --git a/packages/next-docs/pages/components/radio-group/code.mdx b/packages/next-docs/pages/components/radio-group/code.mdx index 2be05f75c5..d276eb124d 100644 --- a/packages/next-docs/pages/components/radio-group/code.mdx +++ b/packages/next-docs/pages/components/radio-group/code.mdx @@ -6,9 +6,9 @@ #### Parameters -| Name | Type | -| :------ | :----------------------------------------------------------------------------------------- | -| `props` | [`RadioGroupProps`](interfaces/RadioGroupProps.md) & `RefAttributes`\<`HTMLInputElement`\> | +| Name | Type | +| :------ | :----------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`RadioGroupProps`](props.md) & `RefAttributes`\<[`HTMLInputElement`](https://developer.mozilla.org/docs/Web/API/HTMLInputElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/radio-group/props.mdx b/packages/next-docs/pages/components/radio-group/props.mdx index 958ecc0482..009c5b51f5 100644 --- a/packages/next-docs/pages/components/radio-group/props.mdx +++ b/packages/next-docs/pages/components/radio-group/props.mdx @@ -6,18 +6,6 @@ ↳ **`RadioGroupProps`** -## Table of contents - -### Properties - -- [className](props.md#classname) -- [direction](props.md#direction) -- [error](props.md#error) -- [errorText](props.md#errortext) -- [helpText](props.md#helptext) -- [label](props.md#label) -- [state](props.md#state) - ## Properties ### className @@ -30,7 +18,7 @@ ComponentPropsWithoutRef.className #### Defined in -[packages/components/src/radio/radio-group.tsx:61](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/radio/radio-group.tsx#L61) +[packages/components/src/radio/radio-group.tsx:61](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/radio/radio-group.tsx#L61) --- @@ -40,7 +28,7 @@ ComponentPropsWithoutRef.className #### Defined in -[packages/components/src/radio/radio-group.tsx:66](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/radio/radio-group.tsx#L66) +[packages/components/src/radio/radio-group.tsx:66](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/radio/radio-group.tsx#L66) --- @@ -50,7 +38,7 @@ ComponentPropsWithoutRef.className #### Defined in -[packages/components/src/radio/radio-group.tsx:62](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/radio/radio-group.tsx#L62) +[packages/components/src/radio/radio-group.tsx:62](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/radio/radio-group.tsx#L62) --- @@ -60,7 +48,7 @@ ComponentPropsWithoutRef.className #### Defined in -[packages/components/src/radio/radio-group.tsx:64](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/radio/radio-group.tsx#L64) +[packages/components/src/radio/radio-group.tsx:64](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/radio/radio-group.tsx#L64) --- @@ -70,7 +58,7 @@ ComponentPropsWithoutRef.className #### Defined in -[packages/components/src/radio/radio-group.tsx:63](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/radio/radio-group.tsx#L63) +[packages/components/src/radio/radio-group.tsx:63](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/radio/radio-group.tsx#L63) --- @@ -80,7 +68,7 @@ ComponentPropsWithoutRef.className #### Defined in -[packages/components/src/radio/radio-group.tsx:65](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/radio/radio-group.tsx#L65) +[packages/components/src/radio/radio-group.tsx:65](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/radio/radio-group.tsx#L65) --- @@ -90,4 +78,4 @@ ComponentPropsWithoutRef.className #### Defined in -[packages/components/src/radio/radio-group.tsx:67](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/radio/radio-group.tsx#L67) +[packages/components/src/radio/radio-group.tsx:67](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/radio/radio-group.tsx#L67) diff --git a/packages/next-docs/pages/components/radio/code.mdx b/packages/next-docs/pages/components/radio/code.mdx index 399c48dd82..7ff2d866bb 100644 --- a/packages/next-docs/pages/components/radio/code.mdx +++ b/packages/next-docs/pages/components/radio/code.mdx @@ -6,9 +6,9 @@ #### Parameters -| Name | Type | -| :------ | :------------------------------------------------------------------------------- | -| `props` | [`RadioProps`](interfaces/RadioProps.md) & `RefAttributes`\<`HTMLInputElement`\> | +| Name | Type | +| :------ | :------------------------------------------------------------------------------------------------------------------------------ | +| `props` | [`RadioProps`](props.md) & `RefAttributes`\<[`HTMLInputElement`](https://developer.mozilla.org/docs/Web/API/HTMLInputElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/radio/props.mdx b/packages/next-docs/pages/components/radio/props.mdx index f4d0530fb9..516fa9c8ca 100644 --- a/packages/next-docs/pages/components/radio/props.mdx +++ b/packages/next-docs/pages/components/radio/props.mdx @@ -6,13 +6,6 @@ ↳ **`RadioProps`** -## Table of contents - -### Properties - -- [error](props.md#error) -- [value](props.md#value) - ## Properties ### error @@ -21,7 +14,7 @@ #### Defined in -[packages/components/src/radio/radio.tsx:43](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/radio/radio.tsx#L43) +[packages/components/src/radio/radio.tsx:43](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/radio/radio.tsx#L43) --- @@ -35,4 +28,4 @@ ComponentPropsWithoutRef.value #### Defined in -[packages/components/src/radio/radio.tsx:44](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/radio/radio.tsx#L44) +[packages/components/src/radio/radio.tsx:44](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/radio/radio.tsx#L44) diff --git a/packages/next-docs/pages/components/scroll-area/code.mdx b/packages/next-docs/pages/components/scroll-area/code.mdx index fc38ca96c0..e875cafdf4 100644 --- a/packages/next-docs/pages/components/scroll-area/code.mdx +++ b/packages/next-docs/pages/components/scroll-area/code.mdx @@ -6,9 +6,9 @@ Cross-browser scroll styling #### Parameters -| Name | Type | -| :------ | :--------------------------------------------------------------------------------------- | -| `props` | [`ScrollAreaProps`](interfaces/ScrollAreaProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`ScrollAreaProps`](props.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns @@ -16,10 +16,33 @@ Cross-browser scroll styling **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx Content ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + + Content)}`, + }} + +> + + + + + + + #### Defined in node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355 diff --git a/packages/next-docs/pages/components/scroll-area/props.mdx b/packages/next-docs/pages/components/scroll-area/props.mdx index 173b547ed6..170e746bd9 100644 --- a/packages/next-docs/pages/components/scroll-area/props.mdx +++ b/packages/next-docs/pages/components/scroll-area/props.mdx @@ -6,13 +6,6 @@ ↳ **`ScrollAreaProps`** -## Table of contents - -### Properties - -- [scrollHideDelay](props.md#scrollhidedelay) -- [type](props.md#type) - ## Properties ### scrollHideDelay @@ -29,7 +22,7 @@ Timeout (in ms) to hide the scrollbar #### Defined in -[packages/components/src/scroll-area/scroll-area.tsx:54](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/scroll-area/scroll-area.tsx#L54) +[packages/components/src/scroll-area/scroll-area.tsx:54](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/scroll-area/scroll-area.tsx#L54) --- @@ -47,4 +40,4 @@ Scroll type #### Defined in -[packages/components/src/scroll-area/scroll-area.tsx:49](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/scroll-area/scroll-area.tsx#L49) +[packages/components/src/scroll-area/scroll-area.tsx:49](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/scroll-area/scroll-area.tsx#L49) diff --git a/packages/next-docs/pages/components/search/code.mdx b/packages/next-docs/pages/components/search/code.mdx index 98614c60b3..13b3cca060 100644 --- a/packages/next-docs/pages/components/search/code.mdx +++ b/packages/next-docs/pages/components/search/code.mdx @@ -6,9 +6,9 @@ #### Parameters -| Name | Type | -| :------ | :--------------------------------------------------------------------------------- | -| `props` | [`SearchProps`](interfaces/SearchProps.md) & `RefAttributes`\<`HTMLInputElement`\> | +| Name | Type | +| :------ | :------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`SearchProps`](props.md) & `RefAttributes`\<[`HTMLInputElement`](https://developer.mozilla.org/docs/Web/API/HTMLInputElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/search/props.mdx b/packages/next-docs/pages/components/search/props.mdx index d12dee7159..c2cf825a89 100644 --- a/packages/next-docs/pages/components/search/props.mdx +++ b/packages/next-docs/pages/components/search/props.mdx @@ -6,13 +6,6 @@ ↳ **`SearchProps`** -## Table of contents - -### Properties - -- [loading](props.md#loading) -- [onClear](props.md#onclear) - ## Properties ### loading @@ -29,7 +22,7 @@ false; #### Defined in -[packages/components/src/search/search.tsx:70](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/search/search.tsx#L70) +[packages/components/src/search/search.tsx:70](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/search/search.tsx#L70) --- @@ -55,4 +48,4 @@ undefined; #### Defined in -[packages/components/src/search/search.tsx:75](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/search/search.tsx#L75) +[packages/components/src/search/search.tsx:75](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/search/search.tsx#L75) diff --git a/packages/next-docs/pages/components/select-field/code.mdx b/packages/next-docs/pages/components/select-field/code.mdx index 8b9018338d..741d795d36 100644 --- a/packages/next-docs/pages/components/select-field/code.mdx +++ b/packages/next-docs/pages/components/select-field/code.mdx @@ -7,9 +7,9 @@ that includes between five and seven values. #### Parameters -| Name | Type | -| :------ | :-------------------------------------------------------------------------------------------- | -| `props` | [`SelectFieldProps`](interfaces/SelectFieldProps.md) & `RefAttributes`\<`HTMLSelectElement`\> | +| Name | Type | +| :------ | :-------------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`SelectFieldProps`](props.md) & `RefAttributes`\<[`HTMLSelectElement`](https://developer.mozilla.org/docs/Web/API/HTMLSelectElement)\> | #### Returns @@ -17,7 +17,7 @@ that includes between five and seven values. **`Example`** -```ts +```tsx copy showLineNumbers filename="example.tsx @@ -25,6 +25,29 @@ that includes between five and seven values. ``` +import { +SandpackProvider, +SandpackLayout, +SandpackCodeEditor, +SandpackPreview, +} from '@codesandbox/sandpack-react' + + )}`, + }} + +> + + + + + + + #### Defined in node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355 diff --git a/packages/next-docs/pages/components/select-field/props.mdx b/packages/next-docs/pages/components/select-field/props.mdx index 7f4e926500..a7a81a9dc5 100644 --- a/packages/next-docs/pages/components/select-field/props.mdx +++ b/packages/next-docs/pages/components/select-field/props.mdx @@ -6,17 +6,6 @@ ↳ **`SelectFieldProps`** -## Table of contents - -### Properties - -- [disabled](props.md#disabled) -- [error](props.md#error) -- [errorText](props.md#errortext) -- [helpText](props.md#helptext) -- [label](props.md#label) -- [optional](props.md#optional) - ## Properties ### disabled @@ -29,7 +18,7 @@ ComponentPropsWithoutRef.disabled #### Defined in -[packages/components/src/select-field/select-field.tsx:82](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/select-field/select-field.tsx#L82) +[packages/components/src/select-field/select-field.tsx:82](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/select-field/select-field.tsx#L82) --- @@ -39,7 +28,7 @@ ComponentPropsWithoutRef.disabled #### Defined in -[packages/components/src/select-field/select-field.tsx:78](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/select-field/select-field.tsx#L78) +[packages/components/src/select-field/select-field.tsx:78](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/select-field/select-field.tsx#L78) --- @@ -49,7 +38,7 @@ ComponentPropsWithoutRef.disabled #### Defined in -[packages/components/src/select-field/select-field.tsx:80](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/select-field/select-field.tsx#L80) +[packages/components/src/select-field/select-field.tsx:80](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/select-field/select-field.tsx#L80) --- @@ -59,7 +48,7 @@ ComponentPropsWithoutRef.disabled #### Defined in -[packages/components/src/select-field/select-field.tsx:81](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/select-field/select-field.tsx#L81) +[packages/components/src/select-field/select-field.tsx:81](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/select-field/select-field.tsx#L81) --- @@ -69,7 +58,7 @@ ComponentPropsWithoutRef.disabled #### Defined in -[packages/components/src/select-field/select-field.tsx:79](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/select-field/select-field.tsx#L79) +[packages/components/src/select-field/select-field.tsx:79](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/select-field/select-field.tsx#L79) --- @@ -79,4 +68,4 @@ ComponentPropsWithoutRef.disabled #### Defined in -[packages/components/src/select-field/select-field.tsx:83](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/select-field/select-field.tsx#L83) +[packages/components/src/select-field/select-field.tsx:83](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/select-field/select-field.tsx#L83) diff --git a/packages/next-docs/pages/components/select-list/code.mdx b/packages/next-docs/pages/components/select-list/code.mdx index 3bb2169649..ac6cccd07e 100644 --- a/packages/next-docs/pages/components/select-list/code.mdx +++ b/packages/next-docs/pages/components/select-list/code.mdx @@ -4,9 +4,9 @@ #### Parameters -| Name | Type | -| :------ | :--------------------------------------------------------------------------------------- | -| `props` | [`SelectListProps`](interfaces/SelectListProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`SelectListProps`](props.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/select-list/props.mdx b/packages/next-docs/pages/components/select-list/props.mdx index 032bf543bb..6f6fdf9991 100644 --- a/packages/next-docs/pages/components/select-list/props.mdx +++ b/packages/next-docs/pages/components/select-list/props.mdx @@ -6,13 +6,6 @@ ↳ **`SelectListProps`** -## Table of contents - -### Properties - -- [alwaysVisible](props.md#alwaysvisible) -- [asChild](props.md#aschild) - ## Properties ### alwaysVisible @@ -27,7 +20,7 @@ false; #### Defined in -[packages/components/src/select/select-list.tsx:41](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/select/select-list.tsx#L41) +[packages/components/src/select/select-list.tsx:41](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/select/select-list.tsx#L41) --- @@ -45,4 +38,4 @@ false; #### Defined in -[packages/components/src/select/select-list.tsx:36](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/select/select-list.tsx#L36) +[packages/components/src/select/select-list.tsx:36](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/select/select-list.tsx#L36) diff --git a/packages/next-docs/pages/components/select-option-check/code.mdx b/packages/next-docs/pages/components/select-option-check/code.mdx index 01280c8f6b..bf3f28bbe2 100644 --- a/packages/next-docs/pages/components/select-option-check/code.mdx +++ b/packages/next-docs/pages/components/select-option-check/code.mdx @@ -6,9 +6,9 @@ #### Parameters -| Name | Type | -| :------ | :------------------------------------------------------------------------------------------------------ | -| `props` | [`SelectOptionCheckProps`](interfaces/SelectOptionCheckProps.md) & `RefAttributes`\<`HTMLSpanElement`\> | +| Name | Type | +| :------ | :---------------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`SelectOptionCheckProps`](props.md) & `RefAttributes`\<[`HTMLSpanElement`](https://developer.mozilla.org/docs/Web/API/HTMLSpanElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/select-option-check/props.mdx b/packages/next-docs/pages/components/select-option-check/props.mdx index 8e11b7b682..4bfb9a4530 100644 --- a/packages/next-docs/pages/components/select-option-check/props.mdx +++ b/packages/next-docs/pages/components/select-option-check/props.mdx @@ -1,11 +1,5 @@ # SelectOptionCheckProps -## Table of contents - -### Properties - -- [className](props.md#classname) - ## Properties ### className @@ -14,4 +8,4 @@ #### Defined in -[packages/components/src/select/select-option-check.tsx:17](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/select/select-option-check.tsx#L17) +[packages/components/src/select/select-option-check.tsx:17](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/select/select-option-check.tsx#L17) diff --git a/packages/next-docs/pages/components/select-option/code.mdx b/packages/next-docs/pages/components/select-option/code.mdx index 93fbb82dfe..d6ebf679c0 100644 --- a/packages/next-docs/pages/components/select-option/code.mdx +++ b/packages/next-docs/pages/components/select-option/code.mdx @@ -6,9 +6,9 @@ #### Parameters -| Name | Type | -| :------ | :------------------------------------------------------------------------------------------- | -| `props` | [`SelectOptionProps`](interfaces/SelectOptionProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :--------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`SelectOptionProps`](props.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/select-option/props.mdx b/packages/next-docs/pages/components/select-option/props.mdx index c5c1caf6e9..a275dfe772 100644 --- a/packages/next-docs/pages/components/select-option/props.mdx +++ b/packages/next-docs/pages/components/select-option/props.mdx @@ -6,14 +6,6 @@ ↳ **`SelectOptionProps`** -## Table of contents - -### Properties - -- [asChild](props.md#aschild) -- [hideOnClick](props.md#hideonclick) -- [value](props.md#value) - ## Properties ### asChild @@ -30,7 +22,7 @@ false; #### Defined in -[packages/components/src/select/select-option.tsx:30](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/select/select-option.tsx#L30) +[packages/components/src/select/select-option.tsx:30](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/select/select-option.tsx#L30) --- @@ -48,7 +40,7 @@ true; #### Defined in -[packages/components/src/select/select-option.tsx:39](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/select/select-option.tsx#L39) +[packages/components/src/select/select-option.tsx:39](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/select/select-option.tsx#L39) --- @@ -60,4 +52,4 @@ Option value #### Defined in -[packages/components/src/select/select-option.tsx:34](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/select/select-option.tsx#L34) +[packages/components/src/select/select-option.tsx:34](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/select/select-option.tsx#L34) diff --git a/packages/next-docs/pages/components/select-popover/code.mdx b/packages/next-docs/pages/components/select-popover/code.mdx index 584bd726bd..5dd6630032 100644 --- a/packages/next-docs/pages/components/select-popover/code.mdx +++ b/packages/next-docs/pages/components/select-popover/code.mdx @@ -6,9 +6,9 @@ #### Parameters -| Name | Type | -| :------ | :--------------------------------------------------------------------------------------------- | -| `props` | [`SelectPopoverProps`](interfaces/SelectPopoverProps.md) & `RefAttributes`\<`HTMLDivElement`\> | +| Name | Type | +| :------ | :---------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`SelectPopoverProps`](props.md) & `RefAttributes`\<[`HTMLDivElement`](https://developer.mozilla.org/docs/Web/API/HTMLDivElement)\> | #### Returns diff --git a/packages/next-docs/pages/components/select-popover/props.mdx b/packages/next-docs/pages/components/select-popover/props.mdx index 5eaef3e4a2..b792c04014 100644 --- a/packages/next-docs/pages/components/select-popover/props.mdx +++ b/packages/next-docs/pages/components/select-popover/props.mdx @@ -6,12 +6,6 @@ ↳ **`SelectPopoverProps`** -## Table of contents - -### Properties - -- [asChild](props.md#aschild) - ## Properties ### asChild @@ -28,4 +22,4 @@ false; #### Defined in -[packages/components/src/select/select-popover.tsx:27](https://github.com/vtex/shoreline/blob/9cdfd7505/packages/components/src/select/select-popover.tsx#L27) +[packages/components/src/select/select-popover.tsx:27](https://github.com/vtex/shoreline/blob/6674ddada/packages/components/src/select/select-popover.tsx#L27) diff --git a/packages/next-docs/pages/components/select-provider/code.mdx b/packages/next-docs/pages/components/select-provider/code.mdx deleted file mode 100644 index f03a549249..0000000000 --- a/packages/next-docs/pages/components/select-provider/code.mdx +++ /dev/null @@ -1,58 +0,0 @@ -### SelectProvider - -▸ **SelectProvider**\<`T`\>(`props`): `ReactElement` - -Provides a select store to Select components. - -#### Type parameters - -| Name | Type | -| :--- | :------------------------ | -| `T` | extends `Value` = `Value` | - -#### Parameters - -| Name | Type | -| :------ | :---------------------------------------------------------------------------- | -| `props` | `PickRequired`\<`SelectProviderProps`\<`T`\>, `"defaultValue"` \| `"value"`\> | - -#### Returns - -`ReactElement` - -**`See`** - -https://ariakit.org/components/select - -**`Example`** - -```jsx - - - - - - -``` - -#### Defined in - -node_modules/.pnpm/@ariakit+react-core@0.3.5_react-dom@18.2.0_react@18.2.0/node_modules/@ariakit/react-core/cjs/select/select-store.d.ts:31 - -▸ **useSelectStore**(`props?`): `SelectStore` - -#### Parameters - -| Name | Type | -| :------- | :---------------------------- | -| `props?` | `SelectStoreProps`\<`Value`\> | - -#### Returns - -`SelectStore` - -#### Defined in - -node_modules/.pnpm/@ariakit+react-core@0.3.5_react-dom@18.2.0_react@18.2.0/node_modules/@ariakit/react-core/cjs/select/select-store.d.ts:32 diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 042ef845b2..13fd23e982 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -266,6 +266,9 @@ importers: typedoc-plugin-markdown: specifier: ^3.17.1 version: 3.17.1(typedoc@0.25.3) + typedoc-plugin-mdn-links: + specifier: ^3.1.4 + version: 3.1.4(typedoc@0.25.3) typescript: specifier: 4.9.5 version: 4.9.5 @@ -746,6 +749,9 @@ importers: '@vtex/admin-ui': specifier: ^0.136.1 version: 0.136.1(react-dom@18.2.0)(react@18.2.0) + '@vtex/shoreline-components': + specifier: workspace:* + version: link:../components '@vtex/shoreline-icons': specifier: workspace:* version: link:../icons @@ -27604,6 +27610,14 @@ packages: typedoc: 0.25.3(typescript@4.9.5) dev: true + /typedoc-plugin-mdn-links@3.1.4(typedoc@0.25.3): + resolution: {integrity: sha512-uChw0fOIQQOyte+SBVPyeORAvxVmABycG28hIFJCagLHPW6ZxuvvDPcGvD4Wb2dJ8TW9y9pneYqQR+UW2/DhhA==} + peerDependencies: + typedoc: '>= 0.23.14 || 0.24.x || 0.25.x' + dependencies: + typedoc: 0.25.3(typescript@4.9.5) + dev: true + /typedoc@0.25.3(typescript@4.9.5): resolution: {integrity: sha512-Ow8Bo7uY1Lwy7GTmphRIMEo6IOZ+yYUyrc8n5KXIZg1svpqhZSWgni2ZrDhe+wLosFS8yswowUzljTAV/3jmWw==} engines: {node: '>= 16'} diff --git a/scripts/typedoc-to-nextra.js b/scripts/typedoc-to-nextra.js index c533e5a0dc..9440b14745 100644 --- a/scripts/typedoc-to-nextra.js +++ b/scripts/typedoc-to-nextra.js @@ -7,6 +7,99 @@ const prettierConfigPath = require.resolve('../.prettierrc') const prettierConfig = require(prettierConfigPath) const path = require('path') +const RESERVED_TYPEDOC_KEYWORDS = { + interfaces: 'Interfaces', + props: 'Props', + md: '.md', + tsxCodeBlockHeader: '```tsx copy showLineNumbers filename="example.tsx', + tsxCodeBlockEnd: '```', +} + +function exampleToSandpackTemplate(example) { + // Extract components from example + const components = example.match(/<([A-Z][a-zA-Z0-9]*)/g) + // Import components from @vtex/shoreline-components + const imports = components + .map((component) => { + const componentName = component.replace('<', '') + + return `import { ${componentName} } from '@vtex/shoreline-components'` + }) + .join('\n') + + console.log({ example }) + + // Removes markdown code block + const parsedExample = example + .replace(RESERVED_TYPEDOC_KEYWORDS.tsxCodeBlockHeader, '') + .replace(RESERVED_TYPEDOC_KEYWORDS.tsxCodeBlockEnd, '') + // Makes a one liner string + .replaceAll('\n', '') + + // Add example within export default + const exportedExample = `export default function App() { return (<>${parsedExample})}` + + const code = `import React from 'react'\n${imports}\n${exportedExample}` + + // Add imports and example to template + const template = + ` +import { + SandpackProvider, + SandpackLayout, + SandpackCodeEditor, + SandpackPreview, +} from '@codesandbox/sandpack-react' + + + + + + +` + + return template +} + +/** + * Add a Sandpack example to the docs based on a given `@example` block + * + * @param {string} file + * @returns + */ +function addSandpack(file) { + const exampleIndex = file.indexOf( + RESERVED_TYPEDOC_KEYWORDS.tsxCodeBlockHeader + ) + + const exampleEndIndex = file.indexOf( + `${RESERVED_TYPEDOC_KEYWORDS.tsxCodeBlockEnd}\n`, + exampleIndex + ) + + if (exampleIndex === -1 || exampleEndIndex === -1) { + return file + } + + const example = file.substring( + exampleIndex, + exampleEndIndex + RESERVED_TYPEDOC_KEYWORDS.tsxCodeBlockEnd.length + ) + + const template = exampleToSandpackTemplate(example) + + const newExample = `${example}\n\n${template}` + + return file.replace(example, newExample) +} + /** * Copy a folder recursively * @@ -69,7 +162,7 @@ function splitIntoMultipleFiles() { // since typedoc classifies type-declared type as type aliases under // the modules.md file, while it separates interface-declared types // under the interfaces folder - const isTypeAlias = methodName.includes('Props') + const isTypeAlias = methodName.includes(RESERVED_TYPEDOC_KEYWORDS.props) if (isHook && !isTypeAlias) { const kebabCaseName = methodName @@ -106,14 +199,25 @@ function splitIntoMultipleFiles() { const filePath = `${folderPath}/code.mdx` - fs.writeFileSync(filePath, method) + let parsedMethod = method + // Replace type annotations with the jsx syntax + .replaceAll('```ts', RESERVED_TYPEDOC_KEYWORDS.tsxCodeBlockHeader) + // Replace the link reference to the interface file with the props file + .replaceAll(`(interfaces/${methodName}Props.md)`, '(props.md)') + + parsedMethod = addSandpack(parsedMethod) + + fs.writeFileSync(filePath, parsedMethod) prettify(filePath) components.push(methodName) const correspondingInterface = interfacesFiles.find( - (i) => i.replace('.md', '').replace('Props', '') === methodName + (i) => + i + .replace(RESERVED_TYPEDOC_KEYWORDS.md, '') + .replace(RESERVED_TYPEDOC_KEYWORDS.props, '') === methodName ) if (correspondingInterface) { @@ -124,7 +228,6 @@ function splitIntoMultipleFiles() { const interfaceFilePath = `${folderPath}/props.mdx` - // TODO: Fix links between components and their props const parsedInterfaceFile = interfaceFile // Replace the interface name with the component name on the title .replace('Interface: ', '') diff --git a/typedoc.json b/typedoc.json index cd45701b6e..a934cdf98e 100644 --- a/typedoc.json +++ b/typedoc.json @@ -11,5 +11,6 @@ "excludeExternals": true, "externalPattern": ["**/node_modules/**"], "tsconfig": "packages/components/tsconfig.json", + "commentStyle": "all", "out": "__tmpDocs" }