Skip to content

Commit

Permalink
feat(button): add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dpellier committed Jul 29, 2024
1 parent 22b4931 commit 51b5ed6
Show file tree
Hide file tree
Showing 26 changed files with 479 additions and 1,132 deletions.

This file was deleted.

55 changes: 55 additions & 0 deletions packages/ods/src/components/button/documentation/spec.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<<<<<<< HEAD
## OdsButton
### Properties
| Property | Type | Required | Default value |
Expand All @@ -10,26 +11,80 @@
| size | `OdsButtonSize` | `true` | `ODS_BUTTON_SIZE.md` |
| type | `submit | reset | button` | `true` | `'button'` |
| variant | `OdsButtonVariant` | `true` | `ODS_BUTTON_VARIANT.default` |
=======
## Properties
### color

**color**: [`critical` | `primary`] = `ODS_BUTTON_COLOR.primary`


### icon

`Optional` **icon**: [`arrow-left` | `warning`]


### isDisabled

**isDisabled**: [_boolean_] = `false`


### isLoading

**isLoading**: [_boolean_] = `false`


### label

**label**: [_string_]


### size

**size**: [`sm` | `md`] = `ODS_BUTTON_SIZE.md`


### type

**type**: [`button` | `reset` | `submit`] = `'button'`


### variant

**variant**: [`default` | `outline` | `ghost`] = `ODS_BUTTON_VARIANT.default`
>>>>>>> c9958c558 (feat(button): add documentation)



<<<<<<< HEAD
### Enums
#### ODS_BUTTON_COLOR
=======
## Enums
### Enumeration: ODS_BUTTON_COLOR
>>>>>>> c9958c558 (feat(button): add documentation)
**critical** = `"critical"`

**primary** = `"primary"`


<<<<<<< HEAD
#### ODS_BUTTON_SIZE
=======
### Enumeration: ODS_BUTTON_SIZE
>>>>>>> c9958c558 (feat(button): add documentation)
**md** = `"md"`

**sm** = `"sm"`


<<<<<<< HEAD
#### ODS_BUTTON_VARIANT
=======
### Enumeration: ODS_BUTTON_VARIANT
>>>>>>> c9958c558 (feat(button): add documentation)
**default** = `"default"`

Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

Loading

0 comments on commit 51b5ed6

Please sign in to comment.