-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6674dda
commit b097948
Showing
194 changed files
with
1,636 additions
and
2,657 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,4 @@ | ||
| { | ||
| "interfaces": "Interfaces", | ||
| "action": "Action", | ||
| "alert": "Alert", | ||
| "bleed": "Bleed", | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,20 +6,43 @@ 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 | ||
|
|
||
| `null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> | ||
|
|
||
| **`Example`** | ||
|
|
||
| ```ts | ||
| ```tsx copy showLineNumbers filename="example.tsx | ||
| <Action>Label</Action> | ||
| ``` | ||
|
|
||
| import { | ||
| SandpackProvider, | ||
| SandpackLayout, | ||
| SandpackCodeEditor, | ||
| SandpackPreview, | ||
| } from '@codesandbox/sandpack-react' | ||
|
|
||
| <SandpackProvider | ||
| template="react" | ||
| customSetup={{ dependencies: { '@vtex/shoreline-components': '^0.21.0' } }} | ||
| files={{'/App.js': `import React from 'react' | ||
| import { Action } from '@vtex/shoreline-components' | ||
| export default function App() { return (<><Action>Label</Action></>)}`, | ||
| }} | ||
|
|
||
| > <SandpackLayout> | ||
|
|
||
| <SandpackCodeEditor /> | ||
| <SandpackPreview /> | ||
|
|
||
| </SandpackLayout> | ||
| </SandpackProvider> | ||
|
|
||
| #### Defined in | ||
|
|
||
| node_modules/.pnpm/@types[email protected]/node_modules/@types/react/ts5.0/index.d.ts:355 | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,23 +6,48 @@ 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 | ||
|
|
||
| `null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> | ||
|
|
||
| **`Example`** | ||
|
|
||
| ```ts | ||
| ```tsx copy showLineNumbers filename="example.tsx | ||
| <Alert onDismiss={() => {}}> | ||
| <Text>Message</Text> | ||
| <Action>Action</Action> | ||
| </Alert> | ||
| ``` | ||
|
|
||
| import { | ||
| SandpackProvider, | ||
| SandpackLayout, | ||
| SandpackCodeEditor, | ||
| SandpackPreview, | ||
| } from '@codesandbox/sandpack-react' | ||
|
|
||
| <SandpackProvider | ||
| template="react" | ||
| customSetup={{ dependencies: { '@vtex/shoreline-components': '^0.21.0' } }} | ||
| files={{'/App.js': `import React from 'react' | ||
| import { Alert } from '@vtex/shoreline-components' | ||
| import { Text } from '@vtex/shoreline-components' | ||
| import { Action } from '@vtex/shoreline-components' | ||
| export default function App() { return (<><Alert onDismiss={() => {}}> <Text>Message</Text> <Action>Action</Action></Alert></>)}`, | ||
| }} | ||
|
|
||
| > <SandpackLayout> | ||
|
|
||
| <SandpackCodeEditor /> | ||
| <SandpackPreview /> | ||
|
|
||
| </SandpackLayout> | ||
| </SandpackProvider> | ||
|
|
||
| #### Defined in | ||
|
|
||
| node_modules/.pnpm/@types[email protected]/node_modules/@types/react/ts5.0/index.d.ts:355 | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,20 +6,43 @@ 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 | ||
|
|
||
| `null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> | ||
|
|
||
| **`Example`** | ||
|
|
||
| ```ts | ||
| ```tsx copy showLineNumbers filename="example.tsx | ||
| <Button>Action label</Button> | ||
| ``` | ||
|
|
||
| import { | ||
| SandpackProvider, | ||
| SandpackLayout, | ||
| SandpackCodeEditor, | ||
| SandpackPreview, | ||
| } from '@codesandbox/sandpack-react' | ||
|
|
||
| <SandpackProvider | ||
| template="react" | ||
| customSetup={{ dependencies: { '@vtex/shoreline-components': '^0.21.0' } }} | ||
| files={{'/App.js': `import React from 'react' | ||
| import { Button } from '@vtex/shoreline-components' | ||
| export default function App() { return (<><Button>Action label</Button></>)}`, | ||
| }} | ||
|
|
||
| > <SandpackLayout> | ||
|
|
||
| <SandpackCodeEditor /> | ||
| <SandpackPreview /> | ||
|
|
||
| </SandpackLayout> | ||
| </SandpackProvider> | ||
|
|
||
| #### Defined in | ||
|
|
||
| node_modules/.pnpm/@types[email protected]/node_modules/@types/react/ts5.0/index.d.ts:355 | ||
Oops, something went wrong.