@truecms/page-alerts

@truecms/page-alerts

Use page alerts to notify users of important information and state changes to the page.

Contents

• Install
• Usage
• Tests
• Release History
• License

Install

pnpm add @truecms/page-alerts

npm install @truecms/page-alerts

⬆ back to top

Usage

• React

⬆ back to top

React

Usage:

import AUpageAlert from './page-alerts.js';

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

All props:

<AUpageAlert
  as="info"         {/* One of four kinds: 'info', 'success', 'warning', 'error' */}
  alt={ false }     {/* An alternate variation of the component */}
  dark={ false }    {/* A dark variation of the component */}
>
  Content of alert
</AUpageAlert>

(💡 additional props are spread onto the component)

For more details have a look at the usage example.

⬆ back to top

Dependency graph

page-alerts
├─ body
│  └─ core
└─ core

⬆ back to top

Tests

⬆ back to top

Release History

• v3.0.0 - 7f941cd: Document stewardship responsibilities under the TrueCMS organisation, lock the Node 22 baseline into the governance docs, and ship bundle parity plus dry-run release safeguards so Drupal 11 users and npm consumers remain supported

• v2.1.4 - Update core package dependency to use the latest version

• v2.1.3 - Remove --save-dev flag from readme instructions

• v2.1.2 - Removed unused Fragment React import

• v2.1.1 - Removed uikit references

• v2.1.0 - Remove role alert as it interupts the screen reader

• 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 links

• 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 - Improved print styles

• v0.1.0 - 💥 Initial version

⬆ back to top

License

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

⬆ back to top

};