@visual-framework/vf-back-to-top v1.0.2

Back to top component

About

An anchor or JavaScript button to scroll the user to top of the current page, or to a target element.

Usage

Only use on component per page, multiple "back to top" links are not recommended.

Inline variant

The inline variant can be used without JavaScript and placed at the bottom of content or the page.

Floating variant

The floating variant is recommended for this component, which appears floating at the bottom right of page. It will appear once the user has scrolled down to 100% of the page height. This requires JavaScript to function.

Angular

As of version 1.0.2 vf-back-to-top has experimental Angular support. This package was generated with Angular version 18.2.1 with fallback support for 15.2.4 and has been tested on application with Angular version 18.2.1

1. install yarn add @visual-framework/vf-back-to-top

2. import in your app.module

   import { VfBackToTopAngularModule } from '@visual-framework/vf-back-to-top/vf-back-to-top.angular';
   
   @NgModule({
     imports: [VfBackToTopAngularModule, YourOtherModules],
     ...
   })

3. can be used as

   <vf-back-to-top [type]="'inline'" [text]="'Top'" [scrollToId]="'top'" [example]="true"></vf-back-to-top>
   <vf-back-to-top [type]="'floating'" [example]="false"></vf-back-to-top>

4. add to your styles.scss

   @import '../node_modules/@visual-framework/vf-sass-config/index.scss';
   @import "../node_modules/@visual-framework/vf-back-to-top/vf-back-to-top.scss";

   you should also install vf-sass-starter for the styles

Usage:

<vf-back-to-top [type]="'inline'" [text]="'Top'" [scrollToId]="'top'" [example]="true"></vf-back-to-top>
<vf-back-to-top [type]="'floating'" [example]="false"></vf-back-to-top>

Install

This repository is distributed with npm. After installing npm and yarn, you can install vf-back-to-top with this command.

$ yarn add --dev @visual-framework/vf-back-to-top

JS

You should import this component in ./components/vf-component-rollup/scripts.js or your other JS process:

import { vfBackToTop } from 'vf-back-to-top/vf-back-to-top';
// Or import directly
// import { vfBackToTop } from '../components/raw/vf-back-to-top/vf-back-to-top.js';
vfBackToTop(); // invoke it

Sass/CSS

The style files included are written in Sass. If you're using a VF-core project, you can import it like this:

@import "@visual-framework/vf-back-to-top/index.scss";

Make sure you import Sass requirements along with the modules. You can use a project boilerplate or the vf-sass-starter

Help

• Read the Visual Framework troubleshooting
• Open a ticket
• Chat on Slack