Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alaskaairlines/auro-card
Custom element for the purpose of providing a flexible way to convey a summary of information
https://github.com/alaskaairlines/auro-card
auro custom-element design-system generator-v4-5-6
Last synced: about 1 month ago
JSON representation
Custom element for the purpose of providing a flexible way to convey a summary of information
- Host: GitHub
- URL: https://github.com/alaskaairlines/auro-card
- Owner: AlaskaAirlines
- License: apache-2.0
- Created: 2021-02-05T01:34:08.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-11T17:02:57.000Z (about 2 months ago)
- Last Synced: 2024-11-11T18:18:49.805Z (about 2 months ago)
- Topics: auro, custom-element, design-system, generator-v4-5-6
- Language: HTML
- Homepage: https://auro.alaskaair.com/components/auro/card
- Size: 1.15 MB
- Stars: 0
- Watchers: 10
- Forks: 5
- Open Issues: 7
-
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
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Card
`` is highly customizable [HTML custom element](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) is a type of UI design component that display content and actions about a single topic.
## 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-card/actions/workflows/testPublish.yml)
[](https://www.npmjs.com/package/@aurodesignsystem/auro-card)
[](https://www.apache.org/licenses/LICENSE-2.0)
```shell
$ npm i @aurodesignsystem/auro-card
```
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-card";
```
**Reference component in HTML**
```html
Card Title
Context goes here.
More info
```
## 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-card__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-card use cases
The `` element can be use in a variety of ways, including:
- Navigation: Cards can be used for navigation purposes.
- Featured information: Cards can be used to display featured information or related content.
- Content containers: Cards can be used to organize information consistently within a page.
- Grouping information: Cards can be used to group information.
- Providing a visual hierarchy: Cards can provide a clear visual hierarchy, organizing information into brief, self-contained units.
- Providing an overview: Cards can serve as an overview and an entry point for more detailed information.
- Providing a summary: Cards can present a summary and link to additional details.
## API Code Examples
### Default auro-card
```html
Card Title
Context goes here.
More info
```
## 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-card.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.