Skip to content

Commit

Permalink
Feat(web-twig): Use Text Color Dictionary in Link component #DS-573
Browse files Browse the repository at this point in the history
  • Loading branch information
crishpeen committed Feb 16, 2023
1 parent ec29a37 commit a6ad9e2
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions packages/web-twig/src/Resources/components/Link/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,19 @@ Without lexer:

## API

| Prop name | Type | Default | Required | Description |
| -------------- | ---------------------------------- | --------- | -------- | ---------------------------------- |
| `class` | `string` | `null` | no | Custom CSS class |
| `color` | `primary`, `secondary`, `inverted` | `primary` | no | Color variant |
| `href` | `string` || yes | Link URL |
| `isDisabled` | `bool` | `false` | no | If true, Link is disabled |
| `isUnderlined` | `bool` | `false` | no | If true, Link is underlined |
| `onClick` | `string` | `null` | no | JS function to call on click |
| `target` | `string` | `null` | no | Link target |
| `title` | `string` | `null` | no | Optional title to display on hover |
| Prop name | Type | Default | Required | Description |
| -------------- | ----------------------------------------- | --------- | -------- | ---------------------------------- |
| `class` | `string` | `null` | no | Custom CSS class |
| `color` | [Text Color dictionary][dictionary-color] | `primary` | no | Color variant |
| `href` | `string` || yes | Link URL |
| `isDisabled` | `bool` | `false` | no | If true, Link is disabled |
| `isUnderlined` | `bool` | `false` | no | If true, Link is underlined |
| `onClick` | `string` | `null` | no | JS function to call on click |
| `target` | `string` | `null` | no | Link target |
| `title` | `string` | `null` | no | Optional title to display on hover |

You can add `id`, `data-*` or `aria-*` attributes to further extend component's
descriptiveness and accessibility.

[link]: https://github.com/lmc-eu/spirit-design-system/tree/main/packages/web-react/src/components/Link
[dictionary-color]: https://github.com/lmc-eu/spirit-design-system/tree/main/docs/DICTIONARIES.md#color

0 comments on commit a6ad9e2

Please sign in to comment.