-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: initial component styles and structure #91
- Loading branch information
Showing
18 changed files
with
601 additions
and
1,083 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 |
|---|---|---|
| @@ -0,0 +1,192 @@ | ||
| <!-- | ||
| 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_updated_paths.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` | | ||
| --> | ||
|
|
||
| # Formkit/auro-counter | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/description.md) --> | ||
| <!-- The below content is automatically added from ./docs/partials/description.md --> | ||
| The `auro-counter` component is a ui element that enables a way to increment or decrement a single digit value. Common use case such as adding passengers to a flight. | ||
| <!-- 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 | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentInstall_esm.md) --> | ||
| [](https://github.com/AlaskaAirlines/-formkit/-formkit/auro-counter/actions/workflows/testPublish.yml) | ||
| [](https://www.npmjs.com/package/@auro-formkit/-formkit/-formkit/auro-counter) | ||
| [](https://www.apache.org/licenses/LICENSE-2.0) | ||
|  | ||
|
|
||
| ```shell | ||
| $ npm i @auro-formkit/-formkit/-formkit/auro-counter | ||
| ``` | ||
|
|
||
| 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 --> | ||
|
|
||
| ### Define dependency in project 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 `<-formkit/-formkit/auro-counter>` component. | ||
|
|
||
| <!-- 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 "@auro-formkit/-formkit/-formkit/auro-counter"; | ||
| ``` | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
| **Reference component in HTML** | ||
| <!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) --> | ||
| <!-- The below code snippet is automatically added from ./apiExamples/basic.html --> | ||
|
|
||
| ```html | ||
| <auro-counter> | ||
| Short label | ||
| </auro-counter> | ||
| <br> | ||
| <hr> | ||
| <br> | ||
| <auro-counter> | ||
| This is an example of the wrapping behavior for a long label | ||
| </auro-counter> | ||
| ``` | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ## Install bundled assets from CDN | ||
|
|
||
| <!-- 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 -- `-formkit/-formkit/auro-counter__bundled.js` for modern browsers. Legacy browsers such as IE11 are no longer supported. | ||
|
|
||
| **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. | ||
|
|
||
| <!-- 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 | ||
| <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/design-tokens@4.12.1/dist/tokens/CSSCustomProperties.css" /> | ||
| <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@5.1.2/dist/bundled/essentials.css" /> | ||
| <script src="https://cdn.jsdelivr.net/npm/@auro-formkit/-formkit/-formkit/auro-counter@1.0.0/dist/-formkit/-formkit/auro-counter__bundled.js" type="module"></script> | ||
| ``` | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ## auro-formkit/auro-counter use cases | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/useCases.md) --> | ||
| <!-- The below content is automatically added from ./docs/partials/useCases.md --> | ||
| The `auro-counter` element should be used in situations where users may: | ||
|
|
||
| * 1 | ||
| * 2 | ||
| * 3 | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ## API Code Examples | ||
|
|
||
| ### Default auro-formkit/auro-counter | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) --> | ||
| <!-- The below code snippet is automatically added from ./apiExamples/basic.html --> | ||
|
|
||
| ```html | ||
| <auro-counter> | ||
| Short label | ||
| </auro-counter> | ||
| <br> | ||
| <hr> | ||
| <br> | ||
| <auro-counter> | ||
| This is an example of the wrapping behavior for a long label | ||
| </auro-counter> | ||
| ``` | ||
| <!-- 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/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 | ||
| $ npm run dev | ||
| ``` | ||
|
|
||
| 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 | ||
|
|
||
| <!-- 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\-formkit/-formkit/auro-counter.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 |
|---|---|---|
| @@ -1,3 +1,9 @@ | ||
| <auro-counter> | ||
| Lorem ipsum solar | ||
| Short label | ||
| </auro-counter> | ||
| <br> | ||
| <hr> | ||
| <br> | ||
| <auro-counter> | ||
| This is an example of the wrapping behavior for a long label | ||
| </auro-counter> |
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,9 @@ | ||
| <auro-counter disabled> | ||
| Short label | ||
| </auro-counter> | ||
| <br> | ||
| <hr> | ||
| <br> | ||
| <auro-counter subLabel="with short sub label text" disabled> | ||
| This is an example of the wrapping behavior for a long label | ||
| </auro-counter> |
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,15 @@ | ||
| <auro-counter subLabel="This is an example of a long sub label wrapping behavior"> | ||
| Short label | ||
| </auro-counter> | ||
| <br> | ||
| <hr> | ||
| <br> | ||
| <auro-counter subLabel="with short sub label text"> | ||
| This is an example of the wrapping behavior for a long label | ||
| </auro-counter> | ||
| <br> | ||
| <hr> | ||
| <br> | ||
| <auro-counter subLabel="Combined with an example of a long sub label wrapping behavior"> | ||
| This is an example of the wrapping behavior for a long label | ||
| </auro-counter> |
Oops, something went wrong.