0.0.2 • Published 2 years ago
@universityofmaryland/alertbanner v0.0.2
\ element
Installation
yarn add @universityofmaryland/alertbannerBasic Usage
Import the Alert Banner in your js if you bundle using a transpiler with babel or typescript.
import '@universityofmaryland/alertbanner';HTML Usage
<!-- Simple -->
<umd-alert-banner storage-key="unique-id-0">
<!-- alert message or content -->
</umd-alert-banner>
<!-- With options -->
<umd-alert-banner
button="Close this specific alert"
padding="20px"
storage-key="unique-id-1"
type="warning"
max-width="1024px"
>
<!-- alert message or content -->
</umd-alert-banner>Attributes Breakdown
| Attribute | Required? | default value | type | Purpose |
|---|---|---|---|---|
storage-key | Yes | null | string | Alert elements require a unique key for use with localStorage and the component's dismiss functionality. The element will throw an error if the key is missing or not unique. |
button | - | "Close" | string | Override the close button accessible Text |
dismissable | - | true | boolean | Set to false to prevent users from dismissing/hiding an alert. |
padding | - | 0 | number + unit | Set padding to banner content with appropriate css units (ie: px) |
max-width | - | initial | number + unit | Set a max-width to banner content with appropriate css units (ie: px) |
type | - | null | string | Set a custom alert type or select a preset type with styling. Presets: 'primary', 'warning', 'danger' |
Functionality
localStorage
By default the element displays a "Close" X button that lets a user dismiss/hide the alert. Using the localStorage WebAPI that alert remains dismissed until the user clears their local cache, or the contents of the alert element differ compared to the reference saved to window.localStorage. A unique storage-key attribute is required on each element to allow this functionality to work.
Development
# Build once or build and watch for changes
yarn build
yarn start
# Remove index.js from /dist, and /examples directories
yarn cleanup
# Build index.js for distribution/production
yarn distLicense
Distributed under the MIT license. See LICENSE for details.