Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alaskaairlines/auro-accordion
Custom element that allows users to toggle the display for sections of content
https://github.com/alaskaairlines/auro-accordion
auro custom-element design-system
Last synced: about 1 month ago
JSON representation
Custom element that allows users to toggle the display for sections of content
- Host: GitHub
- URL: https://github.com/alaskaairlines/auro-accordion
- Owner: AlaskaAirlines
- License: apache-2.0
- Created: 2020-08-20T19:36:40.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-19T17:22:02.000Z (about 1 month ago)
- Last Synced: 2024-11-19T18:27:13.951Z (about 1 month ago)
- Topics: auro, custom-element, design-system
- Language: JavaScript
- Homepage: https://auro.alaskaair.com/components/auro/accordion
- Size: 1.85 MB
- Stars: 1
- Watchers: 13
- Forks: 2
- Open Issues: 8
-
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
# Accordion
`` is a [HTML custom element](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) for the purpose of toggling the visibility of large content section by clicking on a smaller trigger element.
## Transitioning from v1.x to v3.x
The new `@aurodesignsystem/auro-accordion` element includes breaking changes that are not backwards compatible with earlier releases. Earlier versions may be installed by running the following command.
```
$ npm i @aurodesignsystem/[email protected]
```
Or, by CDN.
```html
```
## 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-accordion/actions/workflows/testPublish.yml)
[](https://www.npmjs.com/package/@aurodesignsystem/auro-accordion)
[](https://www.apache.org/licenses/LICENSE-2.0)
```shell
$ npm i @aurodesignsystem/auro-accordion
```
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-accordion";
```
**Reference component in HTML**
```html
Trigger
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
```
## 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. See -- `auro-accordion__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.
### Bundle example code
```html
```
## auro-accordion use cases
The `` element should be used in situations where users may:
- Hide/show long sub-content based on headline trigger
- Use is for in-page content only when excessive content length is distracting to the specific experience
## API Code Examples
### Default auro-accordion
```html
Trigger
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
```
## 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/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 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
```
### 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-accordion.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
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.