Skip to content

Commit

Permalink
update alert docs (#413)
Browse files Browse the repository at this point in the history
  • Loading branch information
robphoenix committed Jul 11, 2024
1 parent 3cc9a59 commit 70e2a18
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions packages/web-ui/src/Alert/Alert.docs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,15 @@ The `colorScheme` prop will change the Alert colours.
/>
```

For now, we have adopted a presentational naming convention here, rather than
associating semantics with the different colour schemes. This is only because
we're not ready yet to properly define these semantics within the the colour
system, across all components, and product applications.

However you can imply some familiar semantics, which could be considered as
`severity` or `tone`;
The `colorScheme` prop uses a presentational naming convention, rather than
attaching semantics to different colour schemes. We haven't yet defined
appropriate semantics within the colour system, which can then be applied
across components and product applications. We hope to do this in the future,
and expect to be able to add a semantic colour prop and relevant values to
components.

However, in the meantime, you can imply some familiar semantics, which could be
considered as `severity` or `tone`;

- `cyan` -> `information`
- `green` -> `success`
Expand Down

0 comments on commit 70e2a18

Please sign in to comment.