Scroll To

Allows you to add a button to your page that will automatically scroll the browser to a location of your choosing on the page. This can be the top of the page, or a custom location using the Anchor tool.

Examples

No Example

The Foundry Documentation pages are built using the Partitions tool, which creates fixed position layouts. Scroll To works by scrolling of the page itself, and cannot scroll the areas within Partitions' fixed layout.

I'll be back.

In previous versions of Foundry the Scroll To tool was singular in what it could do. In this latest version we've given it the ability to handle not only scrolling to specific anchor locations, but also made it able to act as a Scroll To Top tool as well.

Additionally you can now use either a Button or an Image to act as the trigger which initiates the scrolling.

Settings

Edit Mode

Edit Mode Title

Allows you to add a custom label to the top title bar of the tool. This lets you quickly identify what purpose you're using that tool for in your layout. This title is also visible when you've collapsed or hidden the contents of the tool in Edit Mode.

Destination

Destination

By default the Scroll To tool acts as a Scroll To Top button, allowing the visitor to return to the top of the current page. You can change the destination to the Anchor option to choose a custom location to scroll to using the Foundry Anchor tool as the destination.

Anchor ID

When using the Anchor destination as your location to scroll to, this is where you'll add the unique ID of your Anchor tool. This tells Scroll To where exactly on the page to scroll the page to.

Scroll Easing

In real life most objects don’t just start and stop instantly, and rarely move at a constant speed. The Scroll Easing setting allows us to apply some of this real world feel to our page as it scrolls. We've provided several styles to help you get the feeling you are after.

Trigger

You can opt to use either a Button or an Image as the trigger which will cause the page to scroll. By default we populate the parent tool with a Button, but if you'd like to use an Image instead, simply delete the Button child item in Edit Mode and click the small + button to add an Image instead.

We use the Foundry Button / Image tools for the triggers, so you'll have access to all of their settings for styling, etc. when you click on them in Edit Mode. Be sure not to set a link on the button or image however as the Scroll To parent tool will take care of this for you.

Positioning

Here you can decide whether you'd like to position the Scroll To trigger in a fixed position in one of the four corners of the browser window, or leave it inline where you've placed it in Edit Mode.

Generally Fixed positioning is used for a Scroll To Top style button, where clicking on the trigger returns the visitor to the top of the page, where as inline is mostly used for Anchor-based destinations elsewhere on the page. That said, the option to change this is up to you.

Location

These controls are used for the Fixed positioning of the trigger and allow you to place the trigger in one of the four corners of the browser window.

Z-Index

Allows you to adjust the layering of thwe trigger element using a custom z-index value.

Offsets

Here you can specify how far from the browser edge, in both the horizontal and vertical directions, that you'd like to offset the trigger.

Trigger Animation

Animate Trigger After Scrolling

When enabled the trigger will be hidden until the visitor has scrolled the browser window a set distance (configurable below). Once the distance has been reached the trigger will animate in and become visible.

Scroll Distance

This is the distance the visitor will need to scroll before the trigger becomes visible.

Animation

Here you'll choose the animation effect that will be applied to the trigger once the scroll distance has been reached.

  • Fade In
  • Fade In Up
  • Fade In Down
  • Fade In Left
  • Fade In Right
  • Fade In Top Left
  • Fade In Top Right
  • Fade In Bottom Left
  • Fade In Bottom Right
  • Subtle Fade In Top
  • Subtle Fade In Bottom
  • Subtle Fade In Left
  • Subtle Fade In Right
  • Flip Horizontal
  • Flip Vertical
  • Scale In Center
  • Scale In Top
  • Scale In Bottom
  • Scale In Left
  • Scale In Right
  • Scale In Vertical Center
  • Scale In Horizontal Center
  • Subtle Rotate (Clockwise)
  • Subtle Rotate (Counter Clockwise)
  • Subtle Rotate & Scale (Clockwise)
  • Subtle Rotate & Scale (Counter Clockwise)
  • Rotate In Center
  • Rotate In Top
  • Rotate In Bottom
  • Rotate In Left
  • Rotate In Right
  • Rotate In Vertical
  • Rotate In Horizontal
  • Swirl in Forward
  • Swirl in Back
  • Slit in Vertical
  • Slit in Horizontal
  • Puff In
  • Zoom Out
  • Bounce In Top
  • Bounce In Bottom
  • Bounce In Left
  • Bounce In Right
  • Bounce In Forward
  • Bounce In Back
  • Subtle Bounce In Top
  • Subtle Bounce In Bottom
  • Subtle Bounce In Left
  • Subtle Bounce In Right
  • Roll In Top
  • Roll In Bottom
  • Roll In Left
  • Roll In Right
  • Wobble Horizontal Bottom
  • Wobble Horizontal Top
  • Wobble Horizontal
  • Wobble Vertical
  • Wobble Diagonal
  • Shake Horizontal
  • Shake Vertical
  • Shake Bottom
  • Shake Top
  • Heartbeat
Duration

Controls the length of your trigger animation. You can also think of the Duration setting as a sort of Speed setting. The larger the value here the longer the animation runs, which also translates to a slower animation. A shorter value will result in a quicker animation. When using Custom Animations you can set a duration for the animation process both as it animates in and as it animates out.

Delay

Used to delay the trigger animation. The delay period begins when the animation would normally be triggered.

Easing

In real life most objects don’t just start and stop instantly, and rarely move at a constant speed. The Easing setting allows us to apply some of this real world feel to our animated objects. We've provided several styles to help you get the feeling you are after.

HTML Comment

HTML Comment

Enabling this feature adds an HTML comment to the exported code to indicate the name of the tool being used here. This is helpful to both yourself and others when troubleshooting, or inspecting the code. This is enabled by default.

Custom

This field allows you to replace the default HTML Comment with your own text.

CSS

Classes

Allows you to specify an options class, or classes, that will be added to this tool's wrapper. You can use this to apply custom styling from the Blacksmith tool, or add a Bootstrap v5 preset class to your item. If you're applying more than one class be sure that you separate each class name with a space. Do not use special characters.