diff --git a/packages/oui-message/README.md b/packages/oui-message/README.md index 3a082ae9..40f1b7cc 100644 --- a/packages/oui-message/README.md +++ b/packages/oui-message/README.md @@ -4,28 +4,26 @@ ## Usage -### Information +### Basic ```html:preview Message -``` - -### Success - -```html:preview Message +Message +Message ``` -### Warning +**Note**: Messages of type `info` and `success` are dismissable by default. -```html:preview -Message -``` +### Dismissable -### Error +You can force the dismissable state by adding `dismissable` attribute. ```html:preview -Message +Message +Message +Message +Message ``` ### Accessibility @@ -39,5 +37,6 @@ | Attribute | Type | Binding | One-time binding | Values | Default | Description | ---- | ---- | ---- | ---- | ---- | ---- | ---- | `type` | string | @ | yes | `info`, `success`, `warning`, `error` | n/a | message type -| `aria-close-button-label` | function | @? | yes | n/a | n/a | accessibility label for close button +| `aria-close-button-label` | string | @? | yes | n/a | n/a | accessibility label for close button +| `dismissable` | boolean |
-