From 10999baf46936a1beaff53df2877ec12c3e05af4 Mon Sep 17 00:00:00 2001 From: semantic-release-bot Date: Thu, 4 Jul 2024 00:53:16 +0000 Subject: [PATCH] chore(release): 3.1.0 [skip ci] * refactor color token structure with tier 3 tokens [#296](https://github.com/AlaskaAirlines/auro-input/issues/296) ([f15238b](https://github.com/AlaskaAirlines/auro-input/commit/f15238b7f4b5b9668e18b912d559545dfaf35c4d)) * **button:** use new auro-button flat variant for clear and show password ([aa46aba](https://github.com/AlaskaAirlines/auro-input/commit/aa46abaa7d6851e15eb51d377d617dd85d7036ce)) * **deps:** update to latest button beta version ([7be71f6](https://github.com/AlaskaAirlines/auro-input/commit/7be71f6e446617b800feee5ac8a348ad1271db5b)) * **deps:** use updated dependency versions ([c5a9fe6](https://github.com/AlaskaAirlines/auro-input/commit/c5a9fe6c6fc296ab60ebedab81c1bd1aac2e476d)) * **icon:** update to use beta of auro-icon with theme support ([9a5cfae](https://github.com/AlaskaAirlines/auro-input/commit/9a5cfae4fae22b88a897149866fa30dd6236afa5)) * replace hardcoded styles with tokens ([a7ef751](https://github.com/AlaskaAirlines/auro-input/commit/a7ef751818ff56683e0540f44b37df2f8ec3b13c)) --- CHANGELOG.md | 32 ++++------------ README.md | 104 +++++++++++++++++++++++++-------------------------- package.json | 2 +- 3 files changed, 60 insertions(+), 78 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index bf7178c..7c2f6c8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,38 +1,20 @@ # Semantic Release Automated Changelog -# [4.0.0-beta.1](https://github.com/AlaskaAirlines/auro-input/compare/v3.1.0-beta.3...v4.0.0-beta.1) (2024-09-30) - - -### Bug Fixes - -* add file extensions for SSR support ([d91e0e1](https://github.com/AlaskaAirlines/auro-input/commit/d91e0e19da9d759dedc51c7f866c3a6db8ece7d9)) -* realign text and icons on non-bordered inputs [#333](https://github.com/AlaskaAirlines/auro-input/issues/333) ([d1c1df4](https://github.com/AlaskaAirlines/auro-input/commit/d1c1df405802113f19b071de8a3676e7673d1390)) -* remove private default of attribute ([03e9747](https://github.com/AlaskaAirlines/auro-input/commit/03e9747c9cf498b6a318d1963ce5ba56cf069a65)) -* resolve color theming issues ([0fa4568](https://github.com/AlaskaAirlines/auro-input/commit/0fa456872632081596bc488f28cce15d3adc0333)) -* **theming:** resolve minor theming issues [#296](https://github.com/AlaskaAirlines/auro-input/issues/296) ([03c3fae](https://github.com/AlaskaAirlines/auro-input/commit/03c3fae773a96e0a984efdb8d0046e39118fc612)) +# [3.1.0](https://github.com/AlaskaAirlines/auro-input/compare/v3.0.1...v3.1.0) (2024-07-04) ### Features -* **autocomplete:** add html5 autocomplete functionality [#334](https://github.com/AlaskaAirlines/auro-input/issues/334) ([df7dd3a](https://github.com/AlaskaAirlines/auro-input/commit/df7dd3aef9ba69ffc9628c6b779f27aae2a104df)) - - -### Performance Improvements - -* refactor custom component registration config ([3ec2599](https://github.com/AlaskaAirlines/auro-input/commit/3ec2599f817234a26507cdf298d6a89583db2f05)) -* update dependencies ([d65d9f3](https://github.com/AlaskaAirlines/auro-input/commit/d65d9f336ff0c3d758cc54fa5e45bcfa8820caae)) - - -### BREAKING CHANGES - -* trigger major release for color theming support #296 - -# [3.1.0-beta.3](https://github.com/AlaskaAirlines/auro-input/compare/v3.1.0-beta.2...v3.1.0-beta.3) (2024-07-04) +* refactor color token structure with tier 3 tokens [#296](https://github.com/AlaskaAirlines/auro-input/issues/296) ([f15238b](https://github.com/AlaskaAirlines/auro-input/commit/f15238b7f4b5b9668e18b912d559545dfaf35c4d)) ### Performance Improvements -* **deps:** update to latest beta dependencies ([42ecf61](https://github.com/AlaskaAirlines/auro-input/commit/42ecf61f00d25d10c2ecd8c15ad64ed416e38bf4)) +* **button:** use new auro-button flat variant for clear and show password ([aa46aba](https://github.com/AlaskaAirlines/auro-input/commit/aa46abaa7d6851e15eb51d377d617dd85d7036ce)) +* **deps:** update to latest button beta version ([7be71f6](https://github.com/AlaskaAirlines/auro-input/commit/7be71f6e446617b800feee5ac8a348ad1271db5b)) +* **deps:** use updated dependency versions ([c5a9fe6](https://github.com/AlaskaAirlines/auro-input/commit/c5a9fe6c6fc296ab60ebedab81c1bd1aac2e476d)) +* **icon:** update to use beta of auro-icon with theme support ([9a5cfae](https://github.com/AlaskaAirlines/auro-input/commit/9a5cfae4fae22b88a897149866fa30dd6236afa5)) +* replace hardcoded styles with tokens ([a7ef751](https://github.com/AlaskaAirlines/auro-input/commit/a7ef751818ff56683e0540f44b37df2f8ec3b13c)) # [3.1.0-beta.2](https://github.com/AlaskaAirlines/auro-input/compare/v3.1.0-beta.1...v3.1.0-beta.2) (2024-07-03) diff --git a/README.md b/README.md index 8745e98..39a8b55 100644 --- a/README.md +++ b/README.md @@ -15,71 +15,71 @@ 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` | ---> - +--> + # Input Use the `` custom element to create basic single-line text fields. Supports type `text`, `password`, and `email` with validation, required input, error states and a secondary `bordered` theme. Use the slots `label` and `helptext` for additional content support. - + - - - + + + ## UI development browser support For the most up to date information on [UI development browser support](https://auro.alaskaair.com/support/browsersSupport) - - + + ## Install [![Build Status](https://img.shields.io/github/actions/workflow/status/AlaskaAirlines/auro-input/testPublish.yml?style=for-the-badge)](https://github.com/AlaskaAirlines/auro-input/actions/workflows/testPublish.yml) [![See it on NPM!](https://img.shields.io/npm/v/@aurodesignsystem/auro-input?style=for-the-badge&color=orange)](https://www.npmjs.com/package/@aurodesignsystem/auro-input) [![License](https://img.shields.io/npm/l/@aurodesignsystem/auro-input?color=blue&style=for-the-badge)](https://www.apache.org/licenses/LICENSE-2.0) -![ESM supported](https://img.shields.io/badge/ESM-compatible-FFE900?style=for-the-badge) - +![ESM supported](https://img.shields.io/badge/ESM-compatible-FFE900?style=for-the-badge) + ```shell $ npm i @aurodesignsystem/auro-input ``` 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-input"; ``` - + **Reference component in HTML** - - + + ```html - -``` - - + +``` + + ## Install bundled assets from CDN @@ -87,20 +87,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-input use cases @@ -109,21 +109,21 @@ The `` element should be used in situations where users may: * needs to enter information * be filling out a form - - -## API Code Examples - + + +## API Code Examples + ### Default auro-input - - + + ```html - -``` - - + +``` + + ## Development @@ -131,8 +131,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 @@ -152,22 +152,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-input.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 28ece64..64ef96e 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ "================================================================================" ], "name": "@aurodesignsystem/auro-input", - "version": "4.0.0-beta.1", + "version": "3.1.0", "description": "auro-input HTML custom element", "repository": { "type": "git",