Skip to content

Latest commit

 

History

History
101 lines (68 loc) · 2.62 KB

README.md

File metadata and controls

101 lines (68 loc) · 2.62 KB
Raw

Vanillatop

LICENSE MIT version downloads dependencies

Lightweight plugin in vanilla javascript to animate scrolling to the top of the page.

Vanillatop

Changelog

  • V 1.0.6 - Gulp dart-sass added
  • V 1.0.5 - Faster scrolling, Gulp file added
  • V 1.0.4 - Rewrite html demo page
  • V 1.0.3 - Add scss include file
  • V 1.0.2 - Css anchor modification
  • V 1.0.1 - Readme update
  • V 1.0.0 - Initial version

Features

  • Extremely lightweight (1KB after gzip and minify)
  • Responsive
  • Cross Browser Compatible (work smooth in any modern browser)
  • Scss file to tweak the design to your needs
  • Predefined options that garanties a smooth functioning
  • JQuery independant
  • Auto hide button on top of webpage

Examples

Vanillatop is in use in theses sites:

Download

Download directly from github and install it to your site:

https://github.com/bernydole/vanillatop

or via npm:

npm install vanillatop

or as external files from unpkg without having to download and host them:

<link rel="stylesheet" href="https://unpkg.com/vanillatop/dist/vanillatop.min.css">
<script src="https://unpkg.com/vanillatop/dist/vanillatop.min.js"></script>

Installation

  • Download vanillatop.min.js and vanillatop.min.css.
  • Link them to your html page.
  • Add your link whith the class vanillatop wherewer you want inside <body> tags.
<html>
	<head>
		<link rel="stylesheet" href="https://unpkg.com/vanillatop/dist/vanillatop.min.css">
	</head>
	<body>
		<!-- Your HTML content -->
		<a href="#!" class="vanillatop"></a>
		<script src="https://unpkg.com/vanillatop/dist/vanillatop.min.js"></script>
	</body>
</html>

Customization

Style sheet

The plugin has an scss style sheet file that you can modify to adapt to your needs.

src/vanillatop.scss

Additional topics

Dependencies

Vanillatop has no dependency. JQuery is not needed due to the fact that this plugin is written in Vanilla Javascript.

Browser support

Vanillatop should work properly on all evergreen browsers and IE9+.

Release policy

Vanillatop adheres to Semantic Versioning.

Licence

This plugin is open-sourced software licensed under the MIT licence and is distributed free of charge.