Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alaskaairlines/auro-dialog
Custom element that displays additional information over page content
https://github.com/alaskaairlines/auro-dialog
auro custom-element design-system generator-v4-3-2
Last synced: about 1 month ago
JSON representation
Custom element that displays additional information over page content
- Host: GitHub
- URL: https://github.com/alaskaairlines/auro-dialog
- Owner: AlaskaAirlines
- License: apache-2.0
- Created: 2024-01-22T18:56:53.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-10-08T16:59:20.000Z (3 months ago)
- Last Synced: 2024-10-17T13:45:38.877Z (2 months ago)
- Topics: auro, custom-element, design-system, generator-v4-3-2
- Language: JavaScript
- Homepage: https://auro.alaskaair.com/components/auro/dialog
- Size: 842 KB
- Stars: 0
- Watchers: 10
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Dialog
The `` component is an intrusive interactive component, not passive. The component is best used when there is a requirement the user be made aware of the content being shown, moving focus from the main content to the dialog content.
The component also supports a modal (blocking) state where the user must interact with the content of the component in order to continue. Passive dismissal of the content is not allowed. Users of this state must add a trigger for the user to move beyond this content.
Auro holds the opinions of the [Nielsen Norman Group](https://www.nngroup.com/articles/modal-nonmodal-dialog/) on dialog and modal use to be true.
**Important Notice**: This component no longer lives within the `auro-interruption` repository, as that is now being deprecated. `` is now a standalone component and users will be required to install it seperately. See the [Install Page](https://auro.alaskaair.com/components/auro/dialog/install) for instructions on how to install the component.
## UI development browser support
For the most up to date information on [UI development browser support](https://auro.alaskaair.com/support/browsersSupport)
## Install
[](https://github.com/AlaskaAirlines/auro-dialog/actions/workflows/testPublish.yml)
[](https://www.npmjs.com/package/@aurodesignsystem/auro-dialog)
[](https://www.apache.org/licenses/LICENSE-2.0)
```shell
$ npm i @aurodesignsystem/auro-dialog
```
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](https://stackoverflow.com/questions/18875674/whats-the-difference-between-dependencies-devdependencies-and-peerdependencies) answer.
### Design Token CSS Custom Property dependency
The use of any Auro custom element has a dependency on the [Auro Design Tokens](https://auro.alaskaair.com/getting-started/developers/design-tokens).
### Define dependency in project component
Defining the component dependency within each component that is using the `` component.
```js
import "@aurodesignsystem/auro-dialog";
```
**Reference component in HTML**
```html
Open default dialog
Default Dialog
When traveling on Alaska Airlines flights, Alaska Airlines checked baggage fees may apply. See alaskaair.com/bagrules for our rules. For itineraries that include other airlines, their checked baggage fees may apply, as displayed on their websites.
Baggage rules and fees will be based on the specific itinerary chosen. The applicable first and second bag fees will be displayed after you have added flights to the cart.
Before checking your bags, remember to:
- Caerphilly croque monsieur fondue
- Taleggio goat mascarpone cow manchego cheese and wine emmental cheese strings
- Cheddar cheese and biscuits chalk and cheese
- Camembert de normandie stinking bishop bavarian bergkase
Close
```
## Install bundled assets from CDN
In cases where the project is not able to process JS assets, there are pre-processed assets available for use. See -- `auro-dialog__bundled.js` for modern browsers. Legacy browsers such as IE11 are no longer supported.
**WARNING!** When installing into your application environment, DO NOT use `@latest` for the requested version. Risks include unknown MAJOR version releases and instant adoption of any new features and possible bugs without developer knowledge. The `@latest` wildcard should NEVER be used for production customer-facing applications. You have been warned.
### Bundle example code
```html
```
## auro-dialog use cases
The `` component 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
## API Code Examples
### Default auro-dialog
```html
Open default dialog
Default Dialog
When traveling on Alaska Airlines flights, Alaska Airlines checked baggage fees may apply. See alaskaair.com/bagrules for our rules. For itineraries that include other airlines, their checked baggage fees may apply, as displayed on their websites.
Baggage rules and fees will be based on the specific itinerary chosen. The applicable first and second bag fees will be displayed after you have added flights to the cart.
Before checking your bags, remember to:
- Caerphilly croque monsieur fondue
- Taleggio goat mascarpone cow manchego cheese and wine emmental cheese strings
- Cheddar cheese and biscuits chalk and cheese
- Camembert de normandie stinking bishop bavarian bergkase
Close
```
## 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](https://auro.alaskaair.com/contributing) 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 a shell session to run the **dev server**.
```shell
$ npm run dev
```
Open [localhost:8000](http://localhost:8000/)
If running separate sessions is preferred, please run the following commands in individual terminal shells.
```shell
$ npm run build:watch
$ npm run serve
```
### API generation
The custom element API file is generated in the build and committed back to the repo with a version change. If the API doc has changed without a version change, author's are to run `npm run build:api` to generate the doc and commit to version control.
### 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](https://auro.alaskaair.com/support/tests) for more details.
### Bundled assets
Bundled assets are only generated in the remote and not merged back to this repo. To review and/or test a bundled asset locally, run `$ npm run bundler` to generate assets.