Ready Added in 1.2.0

Loading indicator

The Rivet loading indicator helps notify users when their action is being processed

Migrating to Rivet 2

This version of Rivet is deprecated. View the loading indicator documentation on the Rivet 2 website.

New in Rivet 1.2.0

The loading indicator is new as of 1.2.0. If you need help moving to 1.2.0, see our instructions for updating Rivet.

Default

<div class="rvt-loader" aria-label="Content loading"></div>

The loading indicator can be used to indicate the loading of page content, such as when a single page application makes a request for new content. The loading indicator element does not come with any specific positioning styles, so you’ll need to position it appropriately in the container where your content will eventually display once it’s loaded.

Using the loading indicator inside buttons

It can be helpful to indicate that the submit button is in an inactive/loading state, such as when a user submits a form and the data is being sent to the server. The loading indicator can be used inside of buttons by applying the .rvt-button--loading modifier class.

Button loading state

While the button is in the loading state, the aria-busy="true" and disabled attributes should be applied. This helps prevent users from trying to resubmit data while the current form is being submitted.

<button class="rvt-button rvt-button--loading" aria-busy="true" disabled>
  <span class="rvt-button__content">Update settings</span>
  <div class="rvt-loader rvt-loader--xs" aria-label="Content loading"></div>
</button>

Handling button text display while in the loading state

When using the loading indicator inside buttons, the visible button text should be wrapped in a .rvt-button__content class (see above example). This class visually hides the button text when the loading indicator is visible while maintaining the display width of the button. This class also hides any other content inside the button, such as SVG icons.

Class deprecation

In previous versions of Rivet, we used the .rivet-button__text class to wrap a button’s content. However, we realized that the class name implied that non-text button content such as icons did not need to be wrapped to be hidden.

If you are using .rivet-button__text, please update your application to use the new .rivet-button__content class, as the previous class is now deprecated.

Loading indicator sizes

The loading indicator comes in multiple sizes that follow the standard Rivet size naming conventions used for spacing and typography.

rvt-loader--xxs - NOTE: This is the only size usable inside a small button.
rvt-loader--xs - The default size. Same as rvt-loader with no modifier. NOTE: This is the only size usable inside a normal-sized button.
rvt-loader--sm
rvt-loader--md
rvt-loader--lg
rvt-loader--xl
rvt-loader--xxl

<div class="rvt-loader rvt-loader--xxs" aria-label="Content loading"></div>
<div class="rvt-loader rvt-loader--xs" aria-label="Content loading"></div>
<div class="rvt-loader rvt-loader--sm" aria-label="Content loading"></div>
<div class="rvt-loader rvt-loader--md" aria-label="Content loading"></div>
<div class="rvt-loader rvt-loader--lg" aria-label="Content loading"></div>
<div class="rvt-loader rvt-loader--xl" aria-label="Content loading"></div>
<div class="rvt-loader rvt-loader--xxl" aria-label="Content loading"></div>