Skip to content

Latest commit

 

History

History
105 lines (66 loc) · 5.86 KB

README.md

File metadata and controls

105 lines (66 loc) · 5.86 KB
Raw

Interruption

<auro-dialog> and <auro-drawer> are HTML custom elements for displaying content to a user in both a dialog and modal-dialog format.

UI development browser support

For the most up to date information on UI development browser support

Install

Build Status See it on NPM! License

$ npm i @alaskaairux/auro-interruption

Installing as a direct, dev or peer dependency is up to the user installing the package. If you are unsure as to what type of dependency you should use, consider reading this stack overflow answer.

Design Token CSS Custom Property dependency

The use of any Auro custom element has a dependency on the Auro Design Tokens.

CSS Custom Property fallbacks

CSS custom properties are not supported in older browsers. For this, fallback properties are pre-generated and included with the npm.

Any update to the Auro Design Tokens will be immediately reflected with browsers that support CSS custom properties, legacy browsers will require updated components with pre-generated fallback properties.

Define dependency in project component

Defining the component dependency within each component that is using the <auro-dialog> or <auro-drawer> component.

import "@alaskaairux/auro-interruption/dist/auro-dialog";
import "@alaskaairux/auro-interruption/dist/auro-drawer";

Reference component in HTML

<auro-dialog id="demo1">
  <span slot="header">Modal</span>
  <span slot="content">Hello World!</span>
</auro-dialog>

<auro-drawer id="demo2">
  <span slot="header">Modal</span>
  <span slot="content">Hello World!</span>
</auro-drawer>

Install auro-interruption bundled assets from CDN

In cases where the project is not able to process JS assets, there are pre-processed assets available for use. Two bundles are available -- auro-interruption__bundled.js for modern browsers and auro-interruption__bundled.es5.js for legacy browsers (including IE11).

Since the legacy bundle includes many polyfills that are not needed by modern browsers, we recommend you load these bundles using differential serving so that the browser only loads the bundle it needs. To accomplish this, the script tag for the modern bundle should have type="module" and the script tag for the legacy bundle should have the nomodule attribute. See the example below.

NOTE: Be sure to replace @latest in the URL with the version of the asset you want. @latest is NOT aware of any MAJOR releases, use at your own risk.

<link rel="stylesheet" href="https://unpkg.com/@alaskaairux/design-tokens@latest/dist/tokens/CSSCustomProperties.css" />
<link rel="stylesheet" href="https://unpkg.com/@alaskaairux/webcorestylesheets@latest/dist/bundled/essentials.css" />

<script src="https://unpkg.com/@alaskaairux/auro-interruption@latest/dist/auro-dialog__bundled.js" type="module"></script>
<script src="https://unpkg.com/@alaskaairux/auro-interruption@latest/dist/auro-dialog__bundled.es5.js" nomodule></script>

<script src="https://unpkg.com/@alaskaairux/auro-interruption@latest/dist/auro-drawer__bundled.js" type="module"></script>
<script src="https://unpkg.com/@alaskaairux/auro-interruption@latest/dist/auro-drawer__bundled.es5.js" nomodule></script>

auro-dialog use cases

The <auro-dialog> or <auro-drawer> elements should be used in situations where users may:

  • Be prompted to take an action before doing anything else or going back
  • Be prompted to view content with the option of closing it

Development

In order to develop against this project, if you are not part of the core team, you will be required to fork the project prior to submitting a pull request.

Please be sure to review the contribution guidelines for this project. Please make sure to pay special attention to the conventional commits section of the document.

Start development environment

Once the project has been cloned to your local resource and you have installed all the dependencies you will need to open three different shell sessions. One is for the Gulp tasks, the second is for a series of npm tasks and the last is to run the dev server.

// shell terminal one
$ npm run dev

// shell terminal two
$ npm run serve

Open localhost:8000

Testing

Automated tests are required for every Auro component. See .\test\auro-dialog.test.js for the tests for this component. Run npm test to run the tests and check code coverage. Tests must pass and meet a certain coverage threshold to commit. See the testing documentation for more details.

Demo deployment

To deploy a demo version of the component for review, run npm run demo:build to create a ./build directory that can be pushed to any static server.