@aurodesignsystem/auro-skeleton
v3.1.1
Published
auro-skeleton HTML custom element
Downloads
16,286
Readme
Skeleton
The <auro-skeleton>
custom element is for use when display content takes an extended amount of time to process and render on-screen. This indicator communicates to the user that data is being loaded and that the page is not frozen.
Research conducted by the Nielsen Norman Group states that using skeleton states and loading indicators improve user satisfaction.
The <auro-skeleton>
element uses animation to convey that the page is still loading in order to reduce user uncertainty.
UI development browser support
For the most up to date information on UI development browser support
Install
$ npm i @aurodesignsystem/auro-skeleton
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 answer.
Design Token CSS Custom Property dependency
The use of any Auro custom element has a dependency on the Auro Design Tokens.
Define dependency in project component
Defining the component dependency within each component that is using the <auro-skeleton>
component.
import "@aurodesignsystem/auro-skeleton";
Reference component in HTML
<auro-skeleton shape="circle" style="width: 40px; height: 40px"></auro-skeleton>
<auro-skeleton shape="oval" style="width: 200px; height: 100px;"></auro-skeleton>
<auro-skeleton shape="rectangle" style="width: 400px; height: 300px"></auro-skeleton>
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-skeleton__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
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/[email protected]/dist/tokens/CSSCustomProperties.css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/[email protected]/dist/bundled/essentials.css" />
<script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/[email protected]/dist/auro-skeleton__bundled.js" type="module"></script>
auro-skeleton use cases
The <auro-skeleton>
element can be used on container-based components like <auro-card>
and other structured lists.
API Code Examples
Default auro-skeleton
<auro-skeleton shape="circle" style="width: 40px; height: 40px"></auro-skeleton>
<auro-skeleton shape="oval" style="width: 200px; height: 100px;"></auro-skeleton>
<auro-skeleton shape="rectangle" style="width: 400px; height: 300px"></auro-skeleton>
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 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.
$ npm run dev
Open localhost:8000
If running separate sessions is preferred, please run the following commands in individual terminal shells.
$ 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-skeleton.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 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.