@eds/notice
v5.0.4
Notice
Used to highlight pertinent information.Prop | Required | Description | Type |
---|---|---|---|
children | ✅ | The main description text for the notice. This accepts a react node, although we recommend that this should be a text | string | number | false | true | ReactElement<any, string | JSXElementConstructor<any>> | ReactPortal | { key?: string | number; ref?: null; props?: { children?: boolean | ReactChild | ReactPortal | StrictReactFragment; }; } | (boolean | ReactChild | ReactPortal | StrictReactFragment)[] |
title | — | An optional title to provide more context to the notice. | string |
tone | — | Different tone styles for the notice. Defaults to informative. | "positive" | "informative" | "caution" | "critical" |
actions | — | Actions for the user to take after reading the section message. | NoticeActionButton | NoticeActionButtonLink | [NoticeAction] | [NoticeAction, NoticeAction] |