Page alerts

v3.0.0

Page alerts are used to notify users of important information or changes on a page, in a way that attracts the user's attention without interrupting the user's task. Typically they appear at the top of a page following a submit action.

Released

History
View changes
Install
npm i @gold.au/page-alerts
Tags
Requires
Contributors
  • Trevor Brennan avatar picture
  • Simon Pascal Klein avatar picture
  • Patrick De Young avatar picture
  • Julian Fleetwood avatar picture
  • Dominik Wilkowski avatar picture
  • Gary Broadbent avatar picture
  • Alex Page avatar picture

React Usage

import AUpageAlert from '@gold.au/page-alerts';

<AUpageAlert as='info'>
  Content of alert
</AUpageAlert>

Props

Prop name Type Description
as string One of four kinds: 'info', 'success', 'warning', 'error'
alt boolean An alternate variation of the component
dark boolean A dark variation of the component

All other props are spread into the component

Exports

Name Type Description
AUpageAlert default The page alerts component

node_modules import

import AUpageAlert from '@gold.au/page-alerts';

pancake import

import AUpageAlert from './page-alerts';

Feedback