<auro-menu> is a HTML custom element that provides a list of options for the user to choose from.
For the most up to date information on UI development browser support
$ npm i @aurodesignsystem/auro-menu
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.
The use of any Auro custom element has a dependency on the Auro Design Tokens.
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.
Defining the component dependency within each component that is using the
Reference component in HTML
<auro-menu> <auro-menuoption value="stops">Stops</auro-menuoption> <auro-menuoption value="price">Price</auro-menuoption> <auro-menuoption value="duration">Duration</auro-menuoption> <auro-menuoption value="departure">Departure</auro-menuoption> <auro-menuoption value="arrival">Arrival</auro-menuoption> </auro-menu>
In cases where the project is not able to process JS assets, there are pre-processed assets available for use.
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/@aurodesignsystem/auro-menu@latest/dist/auro-menu__bundled.js" type="module"></script>
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.
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.
$ npm run dev
If running separate sessions is preferred, please run the following commands in individual terminal shells.
$ npm run build:watch $ npm run serve
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.
Automated tests are required for every Auro component. See
.\test\auro-menu.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.
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.
To deploy a demo version of the component for review, run
npm run build:demo to create a
./build directory that can be pushed to any static server.
Built from WC-Generator v3.12.0
auro-menu HTML custom element
The npm package @aurodesignsystem/auro-menu receives a total of 647 weekly downloads. As such, @aurodesignsystem/auro-menu popularity was classified as not popular.
We found that @aurodesignsystem/auro-menu demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.