Backtotop

<auro-backtotop> is a HTML custom element for the purpose of providing a quick and accessible 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.

Use Cases

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

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

Install

$ npm i @aurodesignsystem/auro-backtotop

Define Dependency in Project

Defining the dependency within each project that is using the <auro-backtotop> component.

import "@aurodesignsystem/auro-backtotop";

Use CDN

In cases where the project is not able to process JS assets, there are pre-processed assets available for use. Legacy browsers such as IE11 are no longer supported.

<script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-backtotop@latest/+esm"></script>

Basic Example

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

Custom Component Registration for Version Management

There are two key parts to every Auro component: the class and the custom element definition. The class defines the component’s behavior, while the custom element registers it under a specific name so it can be used in HTML.

When you install the component as described on the Install page, the class is imported automatically, and the component is registered globally for you.

However, if you need to load multiple versions of the same component on a single page (for example, when two projects depend on different versions), you can manually register the class under a custom element name to avoid conflicts.

You can do this by importing only the component class and using the register(name) method with a unique name:

// Import the class only
import { AuroBackToTop } from '@aurodesignsystem/auro-backtotop/class';

// Register with a custom name if desired
AuroBackToTop.register('custom-backtotop');

This will create a new custom element <custom-backtotop> that behaves exactly like <auro-backtotop>, allowing both to coexist on the same page without interfering with each other.

<custom-backtotop>Custom back to top</custom-backtotop>