Permalink
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
165 lines (100 sloc) 4.54 KB

@gov.au/callout

Use callout to notify and alert users of important snippets of information.

Contents


Install

yarn add @gov.au/callout
npm install @gov.au/callout --save-dev

⬆ back to top


Usage

⬆ back to top


React

Usage:

import { AUcallout, AUcalloutCalendar } from './callout.js';

<AUcallout title="Description for this callout">
  AUcallout content
</AUcallout>

<AUcalloutCalendar
  title="description for this callout"
  datetime="2017-01-01T00:00:00+00:00"
  time="Sunday 32 Jun"
  subline="Your next appointment is"
  name="Talk to boss"
/>

All props:

<AUcallout
  title="Description for this callout"        {/* The title is a must for screen readers */}
	level={ 2 }                                 {/* The tag level (<h1/> <h2/> etc), default: '1' */}
	srOnlyTitle={ false }                       {/* Title is visible to screen readers only */}
	attributeOptions                            {/* Any other attribute options */}
>
  Callout content
</AUcallout>

<AUcalloutCalendar
	title="description for this callout"        {/* The title is a must for screen readers */}
	level={ 2 }                                 {/* The tag level (<h1/> <h2/> etc), default: '1' */}
	srOnlyTitle={ true }                        {/* Title is visible to screen readers only */}
  datetime="2017-01-01T00:00:00+00:00"        {/* The date time string */}
  time="Sunday 32 Jun"                        {/* The same date but human readable */}
  subline="Your next appointment is"          {/* Your subline, optional */}
  name="Talk to boss"                         {/* The name of the event, optional */}
  dark={ false }                              {/* A dark variation of the component */}
/>

(πŸ’‘ additional props are spread onto the component)

For more details have a look at the usage example.

⬆ back to top


Dependency graph

callout
└─ core

⬆ back to top


Tests

The visual test: https://auds.service.gov.au/packages/callout/tests/site/

⬆ back to top


Release History

  • v3.0.1 - Removed uikit references
  • v3.0.0 - Replace aria-label with a title
  • v2.1.0 - Remove margin-bottom, increase margin-top for paragraphs following callout
  • v2.0.8 - Update dependencies
  • v2.0.7 - Removing web pack dev server, updating dependencies
  • v2.0.6 - Fixed build scripts for Windows
  • v2.0.5 - Replace node-sass with sass
  • v2.0.4 - Change npm run watch browser-sync location
  • v2.0.3 - Update dependencies
  • v2.0.2 - Change homepage link
  • v2.0.1 - Fix dependencies
  • v2.0.0 - Change to focus colour and border/muted color mix
  • v1.0.0 - Moved to AU namespace, added new color themes and spacing
  • v0.3.0 - Added pancake-react plugin, ES5 main file
  • v0.2.0 - Added react component
  • v0.1.1 - Fixed a11y contrast issue
  • v0.1.0 - πŸ’₯ Initial version

⬆ back to top


License

Copyright (c) Commonwealth of Australia. Licensed under MIT.

⬆ back to top

};