-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
perf(demo): implement modern Auro demo system #101
- Loading branch information
1 parent
7718e11
commit 1f2265d
Showing
35 changed files
with
2,501 additions
and
1,288 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| Alaska Airlines Auro Design System | ||
| Copyright 2020 Alaska Airlines, Inc. or its affiliates. All Rights Reserved. | ||
| Copyright 2024 Alaska Airlines, Inc. or its affiliates. All Rights Reserved. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,146 +1,181 @@ | ||
| # auro-icon | ||
|
|
||
| `<auro-icon>` is a [HTML custom element](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) for the purpose of displaying the [icons](https://auro.alaskaair.com/icons/usage) from the Auro Design System. | ||
|
|
||
| <!-- | ||
| The README.md file is a compiled document. No edits should be made directly to this file. | ||
| README.md is created by running `npm run build:docs`. | ||
| This file is generated based on a template fetched from | ||
| `https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/README.md` | ||
| and copied to `./componentDocs/README.md` each time the the docs are compiled. | ||
| The following sections are editable by making changes to the following files: | ||
| | SECTION | DESCRIPTION | FILE LOCATION | | ||
| |------------------------|---------------------------------------------------|-------------------------------------| | ||
| | Description | Description of the component | `./docs/partials/description.md` | | ||
| | Use Cases | Examples for when to use this component | `./docs/partials/useCases.md` | | ||
| | Additional Information | For use to add any component specific information | `./docs/partials/readmeAddlInfo.md` | | ||
| | Component Example Code | HTML sample code of the components use | `./apiExamples/basic.html` | | ||
| --> | ||
|
|
||
| # [Name] | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/description.md) --> | ||
| <!-- The below content is automatically added from ./../docs/partials/description.md --> | ||
| Icons can be used to represent concepts or provide context to options and/or actions within an experience. | ||
|
|
||
| The `<auro-icon>` web component comes pre-configured with all the available [Auro Icons](https://auro.alaskaair.com/icons) . Simply add the `category` and `name` of the icon for quick and easy results. | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
| <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/readmeAddlInfo.md) --> | ||
| <!-- The below content is automatically added from ./../docs/partials/readmeAddlInfo.md --> | ||
| <!-- AURO-GENERATED-CONTENT This file is to be used for any additional content that should be included in the README.md which is specific to this component. --> | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ## UI development browser support | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/browserSupport.md) --> | ||
| For the most up to date information on [UI development browser support](https://auro.alaskaair.com/support/browsersSupport) | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ## Install | ||
|
|
||
| [](https://github.com/AlaskaAirlines/[namespace]-[name]/actions/workflows/testPublish.yml) | ||
| [](https://www.npmjs.com/package/@aurodesignsystem/auro-icon) | ||
| [](https://www.apache.org/licenses/LICENSE-2.0) | ||
|  | ||
| <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentInstall.md) --> | ||
| [](https://github.com/AlaskaAirlines/[namespace]-[name]/actions/workflows/testPublish.yml) | ||
| [](https://www.npmjs.com/package/[npm]/[namespace]-[name]) | ||
| [](https://www.apache.org/licenses/LICENSE-2.0) | ||
|
|
||
| ```shell | ||
| $ npm i @aurodesignsystem/auro-icon | ||
| $ npm i [npm]/[namespace]-[name] | ||
| ``` | ||
|
|
||
| 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. | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ### Design Token CSS Custom Property dependency | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/designTokens.md) --> | ||
| The use of any Auro custom element has a dependency on the [Auro Design Tokens](https://auro.alaskaair.com/getting-started/developers/design-tokens). | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ### CSS Custom Property fallbacks | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/cssFallbacks.md) --> | ||
| [CSS custom properties](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties) are [not supported](https://auro.alaskaair.com/support/custom-properties) 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. | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ### Define dependency in project component | ||
|
|
||
| Defining the component dependency within each component that is using the `<auro-icon>` component. | ||
| <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentImportDescription.md) --> | ||
| Defining the component dependency within each component that is using the `<[namespace]-[name]>` component. | ||
|
|
||
| ```javascript | ||
| import "@aurodesignsystem/auro-icon"; | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
| <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentImport.md) --> | ||
|
|
||
| ```js | ||
| import "[npm]/[namespace]-[name]"; | ||
| ``` | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
| **Reference component in HTML** | ||
|
|
||
| ```html | ||
| <auro-icon category="alert" name="error" accent></auro-icon> | ||
| ``` | ||
|
|
||
| ## CDN Use | ||
|
|
||
| In cases where the project is not able to process JS assets, there are pre-processed assets available for use. | ||
|
|
||
| ### Install | ||
|
|
||
| Include the following example HTML code in the `<head>` element of your page. | ||
|
|
||
| ```html | ||
| <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/design-tokens@latest/dist/tokens/CSSCustomProperties.css" /> | ||
| <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@latest/dist/bundled/essentials.css" /> | ||
|
|
||
| <script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-icon@latest/dist/auro-icon__bundled.js" type="module"></script> | ||
| <script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-icon@latest/dist/auro-alaska__bundled.js" type="module"></script> | ||
| ``` | ||
|
|
||
| **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. | ||
|
|
||
| ### CDN options | ||
|
|
||
| Both [Unpkg](https://www.unpkg.com/) and [JSDelivr](https://www.jsdelivr.com/) are free open source options that you can use. These are 3rd party resources and Auro is not responsible for their uptime. **Use at your own risk.** These bundle resources are included with the npm package, you are free to use any CDN resource that fits your needs. | ||
|
|
||
| ## auro-icon use cases | ||
|
|
||
| The `<auro-icon>` element should be used in situations where users may: | ||
|
|
||
| * want to use an auro icons without a lot of setup | ||
| * want to add an icon to another auro component | ||
|
|
||
| ## API Code Examples | ||
|
|
||
| Primary auro-icon | ||
|
|
||
| ```html | ||
| <auro-icon category="interface" name="chevron-up"></auro-icon> | ||
| <auro-icon category="interface" name="chevron-up" onDark></auro-icon> | ||
| ``` | ||
|
|
||
| Emphasis auro-icon | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/basic.html) --> | ||
| <!-- The below code snippet is automatically added from ./../apiExamples/basic.html --> | ||
|
|
||
| ```html | ||
| <auro-icon category="interface" name="chevron-up" emphasis></auro-icon> | ||
| <auro-icon category="interface" name="chevron-up" emphasis onDark></auro-icon> | ||
| ``` | ||
| <auro-icon category="interface" name="pin-trip"></auro-icon> | ||
| ``` | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ## Install bundled assets from CDN | ||
|
|
||
| Accent auro-icon | ||
| <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/bundleInstallDescription.md) --> | ||
| In cases where the project is not able to process JS assets, there are pre-processed assets available for use. See -- `[namespace]-[name]__bundled.js` for modern browsers. Legacy browsers such as IE11 are no longer supported. | ||
|
|
||
| ```html | ||
| <auro-icon category="interface" name="chevron-up" accent></auro-icon> | ||
| <auro-icon category="interface" name="chevron-up" accent onDark></auro-icon> | ||
| ``` | ||
| **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. | ||
|
|
||
| Disabled auro-icon | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ### Bundle example code | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/bundleUseModBrowsers.md) --> | ||
|
|
||
| ```html | ||
| <auro-icon category="interface" name="chevron-up" disabled></auro-icon> | ||
| <auro-icon category="interface" name="chevron-up" disabled onDark></auro-icon> | ||
| ``` | ||
|
|
||
| ## Alaska Logos | ||
|
|
||
| See [auro-alaska](https://auro.alaskaair.com/components/auro/icon/alaska). | ||
|
|
||
| ## Other airline logos | ||
|
|
||
| The auro-icon component has easy access to other than Alaska airline logos. | ||
|
|
||
| For full list, see [Icons repo](https://github.com/AlaskaAirlines/Icons/tree/master/src/icons/logos). | ||
|
|
||
| Example use: | ||
|
|
||
| <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/design-tokens@[dtVersion]/dist/tokens/CSSCustomProperties.css" /> | ||
| <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@[wcssVersion]/dist/bundled/essentials.css" /> | ||
| <script src="https://cdn.jsdelivr.net/npm/[npm]/[namespace]-[name]@[Version]/dist/[namespace]-[name]__bundled.js" type="module"></script> | ||
| ``` | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ## [namespace]-[name] use cases | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/useCases.md) --> | ||
| <!-- The below content is automatically added from ./../docs/partials/useCases.md --> | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ## API Code Examples | ||
|
|
||
| ### Default [namespace]-[name] | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/basic.html) --> | ||
| <!-- The below code snippet is automatically added from ./../apiExamples/basic.html --> | ||
|
|
||
| ```html | ||
| <auro-icon category="logos" name="tail-AS"></auro-icon> | ||
| ``` | ||
|
|
||
| <auro-icon category="interface" name="pin-trip"></auro-icon> | ||
| ``` | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ## Development | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/developmentDescription.md) --> | ||
| 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/getting-started/developers/contributing) for this project. Please make sure to **pay special attention** to the **conventional commits** section of the document. | ||
| 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. | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ### Start development environment | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/localhost.md) --> | ||
| 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 | ||
| // shell terminal one | ||
| $ npm run dev | ||
| ``` | ||
|
|
||
| Open [localhost:3001](http://localhost:3001/) | ||
| 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 | ||
| ``` | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ### API generation | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/api.md) --> | ||
| 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. | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ### Testing | ||
| Automated tests are required for every Auro component. See `.\test\auro-icon.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. | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/testing.md) --> | ||
| Automated tests are required for every Auro component. See `.\test\[namespace]-[name].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. | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ### Bundled assets | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/bundles.md) --> | ||
| 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. | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:END --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| <auro-icon category="interface" name="pin-trip">Your trip starts here!</auro-icon> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| <auro-icon label category="in-flight" name="wifi">Your flight is enabled with super fast Wi-Fi</auro-icon> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| <auro-icon category="interface" name="pin-trip" ariaHidden="false"></auro-icon> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| <auro-icon category="interface" name="pin-trip"></auro-icon> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| <custom-icon category="interface" name="pin-trip"></custom-icon> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| <auro-icon category="interface" name="pin-trip" ></auro-icon> default inherits color<br/> | ||
| <auro-icon category="interface" name="pin-trip" customColor></auro-icon> applies primary color selector<br/> | ||
| <auro-icon category="interface" name="pin-trip" customColor style="color: orange;"></auro-icon> applies the color from the style attribute |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| <auro-icon style="width: 30rem" category="interface" name="pin-trip" success customSize></auro-icon> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| <auro-icon ondark category="interface" name="pin-trip"></auro-icon> | ||
| <auro-icon ondark category="interface" name="pin-trip" emphasis></auro-icon> | ||
| <auro-icon ondark category="interface" name="pin-trip" accent></auro-icon> | ||
| <auro-icon ondark category="interface" name="pin-trip" disabled></auro-icon> | ||
| <auro-icon ondark category="interface" name="pin-trip" error></auro-icon> | ||
| <auro-icon ondark category="interface" name="pin-trip" success></auro-icon> | ||
| <auro-icon ondark category="interface" name="pin-trip" advisory></auro-icon> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| <auro-icon category="interface" name="pin-trip"></auro-icon> | ||
| <auro-icon category="interface" name="pin-trip" emphasis></auro-icon> | ||
| <auro-icon category="interface" name="pin-trip" accent></auro-icon> | ||
| <auro-icon category="interface" name="pin-trip" disabled></auro-icon> | ||
| <auro-icon category="interface" name="pin-trip" error></auro-icon> | ||
| <auro-icon category="interface" name="pin-trip" success></auro-icon> | ||
| <auro-icon category="interface" name="pin-trip" advisory></auro-icon> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| module.exports = { | ||
| extends: ['@commitlint/config-conventional'], | ||
| rules: { | ||
| 'body-max-line-length': [0, 'always', 120], | ||
| 'footer-max-line-length': [0, 'always', 120], | ||
| 'header-max-length': [0, 'always', 120], | ||
| }, | ||
| }; |
Oops, something went wrong.