Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alaskaairlines/auro-tokenlist
Custom element for displaying auro design tokens and WCAG status
https://github.com/alaskaairlines/auro-tokenlist
auro custom-element design-system wcgen-v3-9-3
Last synced: about 1 month ago
JSON representation
Custom element for displaying auro design tokens and WCAG status
- Host: GitHub
- URL: https://github.com/alaskaairlines/auro-tokenlist
- Owner: AlaskaAirlines
- License: apache-2.0
- Created: 2021-10-23T22:43:36.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-23T00:15:54.000Z (5 months ago)
- Last Synced: 2024-10-31T09:47:51.729Z (about 2 months ago)
- Topics: auro, custom-element, design-system, wcgen-v3-9-3
- Language: JavaScript
- Homepage: http://auro.alaskaair.com/components/auro/tokenlist
- Size: 1.88 MB
- Stars: 0
- Watchers: 7
- Forks: 0
- Open Issues: 3
-
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
# Token display elements
``, `` and `` are [HTML custom elements](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) for the purpose of illustrating design tokens and their related data.
## 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-tokenlist/actions?query=workflow%3A%22test+and+publish%22)
[](https://www.npmjs.com/package/@aurodesignsystem/auro-tokenlist)
[](https://www.apache.org/licenses/LICENSE-2.0)
```shell
$ npm i @aurodesignsystem/auro-tokenlist
```
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.
### Install peer dependencies
```shell
$ npm i @alaskaairux/design-tokens
$ npm i @alaskaairux/webcorestylesheets
$ npm i @alaskaairux/auro-icon
$ npm i @alaskaairux/auro-popover
```
### 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).
### Browser support
The `auro-tokenlist` series of custom elements do not support legacy browsers.
### Define dependency in project component
Defining the component dependency within each component that is using the ``, `` and `` elements.
```javascript
import "@aurodesignsystem/auro-tokendisplay/dist/auro-tokendisplay";
import "@aurodesignsystem/auro-tokendisplay/dist/auro-tokenavatar";
import "@aurodesignsystem/auro-tokendisplay/dist/auro-tokenlist";
```
## 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.
### Bundle example code
**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.
```html
// Peer dependencies
```
## 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/getting-started/developers/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 two different shell sessions. One is for the **npm tasks**, the second is to run the **server**.
```shell
// shell terminal one
$ npm run dev
// shell terminal two
$ npm run serve
```
Open [localhost:8000](http://localhost:8000/)
### Testing
Automated tests are required for every Auro component. See `.\test\auro-tokenlist.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.
### 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.
Built from WC-Generator v3.9.3
### Useful Function For later:
In the event that rgba values are passed in and need to be converted to hex values to hit the wcag api(currently 6/2021 the WCAG api doesn't not accept 8 char hex values) then this function may prove useful for converting rgb/rgba values to hex.
```js
/**
* @private internal function
* @param {string} rgb(a) value string ex "rgba(0,22,23,0.5)"
* @returns {string} 7-8 char hex value ex "#00161780"
*/
rgbaToHex(rgbaString) {
// remove whitespace
rgbaString = rgbaString.replace(/\+/g,'');
// find indices of parentheses
const valuesStart = rgbaString.indexOf('(')+1;
const valuesEnd = rgbaString.indexOf(')');
// pull rgb(a) values out into an array and convert them to decimal
let rgba = rgbaString.substring(valuesStart, valuesEnd).split(',').map(x=>+x);
if(rgba.length == 4) {
rgba[3]=Math.round(rgba[3] * 255);
}
rgba = rgba.map(x => {
// convert to hex;
x = x.toString(16);
// add 0 to single char values
if (x.length==1) {
x = "0" + x;
}
// update array
return x;
})
return "#" + rgba.join('');
}
```