Alert for Fender React UI Kit
Description
An Alert component is typically used to give the user information that isn't generally a call to action itself. It can be used for error states, success states or general warnings and updates of an application. Typically accompanied by an icon.
Installation and Usage
yarn install @fenderdigital/react-alert --save
import Alert from '@fenderdigital/react-alert';Props
-
children- resolves to a react node, use to pass in your content. -
color- the color to base the content on. The background will be a 90% transparency of the color you choose. -
icon- the icon name from our icon set. We should consider removing this as part of the component, and pass it in as children. -
iconSize- icon size from our type sizing scale. -
styles- configurable tachyon classes.
| propName | propType | defaultValue | isRequired |
|---|---|---|---|
| children | node | null | no |
| color | string | red | no |
| icon | string | alert | no |
| iconSize | string | f5 | no |
| styles | string | items-center f7 pv3 ph2 | no |
Development
Check the Monorepo README for development documentation.