From bf5de0827aa00989f317c8c5365eaf571523b3e0 Mon Sep 17 00:00:00 2001 From: semantic-release-bot Date: Mon, 24 Jun 2024 22:31:32 +0000 Subject: [PATCH] chore(release): 3.12.0-beta.1 [skip ci] * refactor color tokens to use tier 3 tokens [#198](https://github.com/AlaskaAirlines/auro-menu/issues/198) ([9100c1d](https://github.com/AlaskaAirlines/auro-menu/commit/9100c1d97c3b4af43df90d353d070f2a40ceb57e)) --- CHANGELOG.md | 34 ++---------------- README.md | 100 +++++++++++++++++++++++++-------------------------- package.json | 2 +- 3 files changed, 54 insertions(+), 82 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b8af263..be49b8e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,39 +1,11 @@ # Semantic Release Automated Changelog -## [3.11.9](https://github.com/AlaskaAirlines/auro-menu/compare/v3.11.8...v3.11.9) (2024-07-02) +# [3.12.0-beta.1](https://github.com/AlaskaAirlines/auro-menu/compare/v3.11.4...v3.12.0-beta.1) (2024-06-24) -### Performance Improvements - -* **deps:** update to correct icon version ([1330bf2](https://github.com/AlaskaAirlines/auro-menu/commit/1330bf2fc6b0b61565cb341579138266e50604fb)) - -## [3.11.8](https://github.com/AlaskaAirlines/auro-menu/compare/v3.11.7...v3.11.8) (2024-07-02) - - -### Performance Improvements - -* **icon:** use auro-icon for selected check mark ([9d3ef07](https://github.com/AlaskaAirlines/auro-menu/commit/9d3ef07da6af5c7f55465b275c361c1d7fd832ff)) - -## [3.11.7](https://github.com/AlaskaAirlines/auro-menu/compare/v3.11.6...v3.11.7) (2024-07-02) - - -### Reverts - -* Revert "perf(icon): use auro-icon for selected check mark" ([fa75810](https://github.com/AlaskaAirlines/auro-menu/commit/fa75810528f5211961eb41f33424b1e47b064002)) - -## [3.11.6](https://github.com/AlaskaAirlines/auro-menu/compare/v3.11.5...v3.11.6) (2024-07-02) - - -### Performance Improvements - -* **icon:** use auro-icon for selected check mark ([180f905](https://github.com/AlaskaAirlines/auro-menu/commit/180f905f0f5557ac0c138a2cd048efba4a515eba)) - -## [3.11.5](https://github.com/AlaskaAirlines/auro-menu/compare/v3.11.4...v3.11.5) (2024-06-27) - - -### Bug Fixes +### Features -* **imports:** update all imports to include extension in file path [#208](https://github.com/AlaskaAirlines/auro-menu/issues/208) ([cd1ebf9](https://github.com/AlaskaAirlines/auro-menu/commit/cd1ebf95350c9016d7a7ed2626aa162158e1cba8)) +* refactor color tokens to use tier 3 tokens [#198](https://github.com/AlaskaAirlines/auro-menu/issues/198) ([9100c1d](https://github.com/AlaskaAirlines/auro-menu/commit/9100c1d97c3b4af43df90d353d070f2a40ceb57e)) ## [3.11.4](https://github.com/AlaskaAirlines/auro-menu/compare/v3.11.3...v3.11.4) (2024-03-01) diff --git a/README.md b/README.md index 39c93f9..7fc1171 100644 --- a/README.md +++ b/README.md @@ -15,8 +15,8 @@ The following sections are editable by making changes to the following files: | 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` | ---> - +--> + # Menu @@ -26,19 +26,19 @@ The `` element provides a list of options for a user to select from. A list of options is created within the `` of the `` element by using the `` element to define options. Use a standard `
` element to create dividers within the list of options. The `` element is designed for contextual menus, e.g. a dropdown menus. They are not intended to be used for navigation menus which have a different semantic meaning. The `` element does not support hide/show functionality within its scope. This functionality will be managed by a wrapping element such as a drop-down menu composite element. - + - - + + ## UI development browser support For the most up to date information on [UI development browser support](https://auro.alaskaair.com/support/browsersSupport) - - + + ## Install @@ -52,15 +52,15 @@ $ 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](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). - - + + ### CSS Custom Property fallbacks @@ -68,25 +68,25 @@ The use of any Auro custom element has a dependency on the [Auro Design Tokens]( 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 `` component. - - - + + + ```js import "@aurodesignsystem/auro-menu"; ``` - + **Reference component in HTML** - - + + ```html Stops @@ -94,10 +94,10 @@ import "@aurodesignsystem/auro-menu"; Duration Departure Arrival - -``` - - + +``` + + ## Install bundled assets from CDN @@ -105,20 +105,20 @@ In cases where the project is not able to process JS assets, there are pre-proce **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-menu use cases @@ -126,15 +126,15 @@ In cases where the project is not able to process JS assets, there are pre-proce The `` element should be used in situations where users may: * A user needs to select one option from a list of options. - - -## API Code Examples - + + +## API Code Examples + ### Default auro-menu - - + + ```html Stops @@ -142,10 +142,10 @@ The `` element should be used in situations where users may: Duration Departure Arrival - -``` - - + +``` + + ## Development @@ -153,8 +153,8 @@ In order to develop against this project, if you are not part of the core team, 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 @@ -174,22 +174,22 @@ $ 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-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](https://auro.alaskaair.com/support/tests) for more details. - - + + ### Bundled assets diff --git a/package.json b/package.json index 249a7cc..fb15623 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ "================================================================================" ], "name": "@aurodesignsystem/auro-menu", - "version": "3.11.9", + "version": "3.12.0-beta.1", "description": "auro-menu HTML custom element", "repository": { "type": "git",