-
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.
docs: generate interfaces/props from components
- Loading branch information
1 parent
9b5214c
commit 9cdfd75
Showing
92 changed files
with
4,416 additions
and
358 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# AlertProps | ||
|
||
## Hierarchy | ||
|
||
- `ComponentPropsWithoutRef`\<`"div"`\> | ||
|
||
↳ **`AlertProps`** | ||
|
||
## Table of contents | ||
|
||
### Properties | ||
|
||
- [onDismiss](AlertProps.md#ondismiss) | ||
- [variant](AlertProps.md#variant) | ||
|
||
## Properties | ||
|
||
### onDismiss | ||
|
||
• `Optional` **onDismiss**: `MouseEventHandler`\<`HTMLButtonElement`\> | ||
|
||
#### Defined in | ||
|
||
[packages/components/src/alert/alert.tsx:74](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/alert/alert.tsx#L74) | ||
|
||
--- | ||
|
||
### variant | ||
|
||
• `Optional` **variant**: `AlertVariant` | ||
|
||
#### Defined in | ||
|
||
[packages/components/src/alert/alert.tsx:73](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/alert/alert.tsx#L73) |
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,126 @@ | ||
# BleedProps | ||
|
||
## Hierarchy | ||
|
||
- `ComponentPropsWithoutRef`\<`"div"`\> | ||
|
||
↳ **`BleedProps`** | ||
|
||
## Table of contents | ||
|
||
### Properties | ||
|
||
- [bottom](BleedProps.md#bottom) | ||
- [horizontal](BleedProps.md#horizontal) | ||
- [left](BleedProps.md#left) | ||
- [right](BleedProps.md#right) | ||
- [top](BleedProps.md#top) | ||
- [vertical](BleedProps.md#vertical) | ||
|
||
## Properties | ||
|
||
### bottom | ||
|
||
• `Optional` **bottom**: `string` \| `boolean` | ||
|
||
Bottom bleed | ||
|
||
**`Default`** | ||
|
||
```ts | ||
"$space-0"; | ||
``` | ||
|
||
#### Defined in | ||
|
||
[packages/components/src/bleed/bleed.tsx:68](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/bleed/bleed.tsx#L68) | ||
|
||
--- | ||
|
||
### horizontal | ||
|
||
• `Optional` **horizontal**: `string` \| `boolean` | ||
|
||
Horizontal bleed | ||
|
||
**`Default`** | ||
|
||
```ts | ||
"$space-0"; | ||
``` | ||
|
||
#### Defined in | ||
|
||
[packages/components/src/bleed/bleed.tsx:83](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/bleed/bleed.tsx#L83) | ||
|
||
--- | ||
|
||
### left | ||
|
||
• `Optional` **left**: `string` \| `boolean` | ||
|
||
Left bleed | ||
|
||
**`Default`** | ||
|
||
```ts | ||
"$space-0"; | ||
``` | ||
|
||
#### Defined in | ||
|
||
[packages/components/src/bleed/bleed.tsx:73](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/bleed/bleed.tsx#L73) | ||
|
||
--- | ||
|
||
### right | ||
|
||
• `Optional` **right**: `string` \| `boolean` | ||
|
||
Right bleed | ||
|
||
**`Default`** | ||
|
||
```ts | ||
"$space-0"; | ||
``` | ||
|
||
#### Defined in | ||
|
||
[packages/components/src/bleed/bleed.tsx:78](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/bleed/bleed.tsx#L78) | ||
|
||
--- | ||
|
||
### top | ||
|
||
• `Optional` **top**: `string` \| `boolean` | ||
|
||
Top bleed | ||
|
||
**`Default`** | ||
|
||
```ts | ||
"$space-0"; | ||
``` | ||
|
||
#### Defined in | ||
|
||
[packages/components/src/bleed/bleed.tsx:63](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/bleed/bleed.tsx#L63) | ||
|
||
--- | ||
|
||
### vertical | ||
|
||
• `Optional` **vertical**: `string` \| `boolean` | ||
|
||
Vertical bleed | ||
|
||
**`Default`** | ||
|
||
```ts | ||
"$space-0"; | ||
``` | ||
|
||
#### Defined in | ||
|
||
[packages/components/src/bleed/bleed.tsx:88](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/bleed/bleed.tsx#L88) |
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,105 @@ | ||
# ButtonProps | ||
|
||
## Hierarchy | ||
|
||
- `ComponentPropsWithoutRef`\<`"button"`\> | ||
|
||
↳ **`ButtonProps`** | ||
|
||
↳↳ [`IconButtonProps`](IconButtonProps.md) | ||
|
||
## Table of contents | ||
|
||
### Properties | ||
|
||
- [asChild](ButtonProps.md#aschild) | ||
- [children](ButtonProps.md#children) | ||
- [loading](ButtonProps.md#loading) | ||
- [size](ButtonProps.md#size) | ||
- [variant](ButtonProps.md#variant) | ||
|
||
## Properties | ||
|
||
### asChild | ||
|
||
• `Optional` **asChild**: `boolean` | ||
|
||
Merge button props with immediate child. | ||
|
||
**`Default`** | ||
|
||
```ts | ||
false; | ||
``` | ||
|
||
#### Defined in | ||
|
||
[packages/components/src/button/button.tsx:95](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/button/button.tsx#L95) | ||
|
||
--- | ||
|
||
### children | ||
|
||
• **children**: `ReactNode` | ||
|
||
#### Overrides | ||
|
||
ComponentPropsWithoutRef.children | ||
|
||
#### Defined in | ||
|
||
[packages/components/src/button/button.tsx:70](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/button/button.tsx#L70) | ||
|
||
--- | ||
|
||
### loading | ||
|
||
• `Optional` **loading**: `boolean` | ||
|
||
Disable the button and show a spinner. | ||
|
||
**`Default`** | ||
|
||
```ts | ||
false; | ||
``` | ||
|
||
#### Defined in | ||
|
||
[packages/components/src/button/button.tsx:90](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/button/button.tsx#L90) | ||
|
||
--- | ||
|
||
### size | ||
|
||
• `Optional` **size**: `"normal"` \| `"large"` | ||
|
||
Increase or decrease padding. | ||
|
||
**`Default`** | ||
|
||
```ts | ||
normal; | ||
``` | ||
|
||
#### Defined in | ||
|
||
[packages/components/src/button/button.tsx:75](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/button/button.tsx#L75) | ||
|
||
--- | ||
|
||
### variant | ||
|
||
• `Optional` **variant**: `"primary"` \| `"secondary"` \| `"tertiary"` \| `"critical"` \| `"criticalTertiary"` | ||
|
||
Change between color combinations. | ||
|
||
**`Default`** | ||
|
||
```ts | ||
"secondary"; | ||
``` | ||
|
||
#### Defined in | ||
|
||
[packages/components/src/button/button.tsx:80](https://github.com/vtex/shoreline/blob/9b5214c2f/packages/components/src/button/button.tsx#L80) |
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
Oops, something went wrong.