Essentials Back to Top

Provide a configurable button that appears after scrolling and returns users to the top of the page.

Configuration Guide

  • Add the web part to the page where the return-to-top action should appear.
  • Choose the button position: Bottom-right, Bottom-left, or Bottom-centre.
  • Set the scroll threshold in pixels for when the button becomes visible.
  • Select the icon style: Arrow up, Double chevron, or Text "TOP".
  • Choose a background colour and confirm the accessible label used for screen readers.
  • Toggle visibility for mobile and email view as needed.

Key Features Configuration

FeatureDescriptionConfiguration
PositionWhere the button appears on screenBottom-right, Bottom-left, Bottom-centre
Visibility thresholdHow far user scrolls before the button showsPixels scrolled before display
Icon styleVisual style of the button iconArrow up, Double chevron, Text "TOP"
Background colourBackground fill of the buttonColour picker input
Accessibility labelText read aloud by screen readersScreen reader label text
Mobile/email visibilityControl display on small screens and emailsToggle on/off

Property Pane Options

OptionTypeDescription
PositionRadioChoose where the button appears on the page
Show after scrolling (px)Slider / NumberPixel threshold to show the button
Icon styleRadioSelect the visual style of the button icon
Background colourColour pickerSet the button background colour
Accessible labelTextProvide a label for screen readers
Show in mobile and email viewToggleEnable or disable display on mobile/email

Illustration