@aurodesignsystem/auro-backtotop

Backtotop

<auro-backtotop> is a HTML custom element for the purpose of providing a quick and accessable means to jump back to the top of a long content page.

The component will be hidden while the page Y scroll position is at the top. When scroll down begins the button will display in the bottom right corner of the page. While scrolling down the button will display only an arrow up icon. When scroll up occurs, the button will additionally display any slotted text content.

UI development browser support

For the most up to date information on UI development browser support

Install

$ npm i @aurodesignsystem/auro-backtotop

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-backtotop> component.

import "@aurodesignsystem/auro-backtotop";

Reference component in HTML

<auro-backtotop>Back to top</auro-backtotop>

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-backtotop__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/design-tokens@4.10.0/dist/tokens/CSSCustomProperties.css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@5.1.1/dist/bundled/essentials.css" />
<script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-backtotop@3.1.0/dist/auro-backtotop__bundled.js" type="module"></script>

auro-backtotop use cases

The <auro-backtotop> element should be used in situations where users may:

• Pages with large ammounts of content where a shortcut to jump to the top of the page is appropriate.

API Code Examples

Default auro-backtotop

<auro-backtotop>Back to top</auro-backtotop>

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-backtotop.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.