Skip to content

Commit

Permalink
Style(web-react): Fix documentation links for Card and Footer
Browse files Browse the repository at this point in the history
  • Loading branch information
@literat
literat committed Dec 14, 2024
1 parent 95aa189 commit 35e2c01
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 11 deletions.
20 changes: 10 additions & 10 deletions packages/web-react/src/components/Card/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,11 @@ Card can be displayed with a border and a box shadow on hover.

### API

| Name | Type | Default | Required | Description |
| ------------- | --------------------------------------------------------------------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `direction` | [[Direction dictionary][dictionary-direction], `horizontal-reversed` \| `object`] | `vertical` | ✕ | Direction of the content inside Card component, use object to set responsive values, e.g. `{ mobile: 'horizontal', tablet: 'vertical', desktop: 'horizontal-reversed' }` |
| `elementType` | `ElementType` | `article` | ✕ | Type of element |
| `isBoxed` | `bool` | `false` | ✕ | Whether the Card have border |
| Name | Type | Default | Required | Description |
| ------------- | ---------------------------------------------------------------------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `direction` | \[[Direction dictionary][dictionary-direction], `horizontal-reversed` \| `object`] | `vertical` | ✕ | Direction of the content inside Card component, use object to set responsive values, e.g. `{ mobile: 'horizontal', tablet: 'vertical', desktop: 'horizontal-reversed' }` |
| `elementType` | `ElementType` | `article` | ✕ | Type of element |
| `isBoxed` | `bool` | `false` | ✕ | Whether the Card have border |

On top of the API options, the components accept [additional attributes][readme-additional-attributes].
If you need more control over the styling of a component, you can use [style props][readme-style-props]
Expand Down Expand Up @@ -220,11 +220,11 @@ horizontal (and reversed horizontal) Cards. But in all other contexts, the two p

### API

| Name | Type | Default | Required | Description |
| ---------------------- | -------------------------------------------- | ------- | -------- | ------------------------------------------- |
| `hasFilledHeightClass` | `bool` | `false` | ✕ | Whether the image fill the height of a Card |
| `isExpanded` | `bool` | `false` | ✕ | Whether the media has space around |
| `size` | [[Size dictionary][dictionary-size], `auto`] | `auto` | ✕ | Size of the image media |
| Name | Type | Default | Required | Description |
| ---------------------- | --------------------------------------------- | ------- | -------- | ------------------------------------------- |
| `hasFilledHeightClass` | `bool` | `false` | ✕ | Whether the image fill the height of a Card |
| `isExpanded` | `bool` | `false` | ✕ | Whether the media has space around |
| `size` | \[[Size dictionary][dictionary-size], `auto`] | `auto` | ✕ | Size of the image media |

On top of the API options, the components accept [additional attributes][readme-additional-attributes].
If you need more control over the styling of a component, you can use [style props][readme-style-props]
Expand Down
1 change: 0 additions & 1 deletion packages/web-react/src/components/Footer/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,5 @@ and [escape hatches][readme-escape-hatches].
[readme-additional-attributes]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#additional-attributes
[readme-escape-hatches]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#escape-hatches
[readme-style-props]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#style-props
[readme-style-props]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#style-props
[select]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Select/README.md
[stack]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Stack/README.md

0 comments on commit 35e2c01

Please sign in to comment.