# Introducing Back to the Top

[![Build Status](https://travis-ci.org/thingsym/back-to-the-top.svg?branch=master)](https://travis-ci.org/thingsym/back-to-the-top)

Back to the Top is a WordPress plugin that return to scroll smoothly to the top of the page. You can scroll to the smooth anchor link in the page.


Back to the Top will add a link that return the top of the page for your website. You can customize label, color, display and so in the options page. You don't need to edit your theme.

Back to the Top is also a jQuery plugin. [Back to the Top Project Page here.](http://project.thingslabo.com/jquery.backtothetop) You can set easily WordPress plugin ’Back to the Top’ than jQuery plugin ones.

### Features

* Customizable options in the options page
* Selectable the effects easing of the scroll
* The iconic font supported, Dashicons and Font Awesome

## Install Back to the Top

1. Download and unzip files. Or install 'Back to the Top' plugin using the WordPress plugin installer. In that case, skip 2.
2. Upload 'backtothetop' to the '/wp-content/plugins/' directory.
3. Activate the plugin through the 'Plugins' menu in WordPress.
5. Go to the 'Back to the Top' options page through the 'Appearance' menu in WordPress.
4. Have fun!

## Options page screenshot

<img src="screenshot-1.png">

## Customize Stylesheet

You can customize Stylesheet by the Custom CSS. See the following example.

```css
a#backtothetop-fixed {
	background: #f1f1f1;
	border-radius: 10%;
	padding: 0.2em;
}
a#backtothetop-fixed:hover {
	background: #fefefe;
}
```

## WordPress Plugin Directory

Back to the Top is hosted on the WordPress Plugin Directory.

[https://wordpress.org/plugins/back-to-the-top/](https://wordpress.org/plugins/back-to-the-top/)

## Contribution

### Patches and Bug Fixes

Small patches and bug reports can be submitted a issue tracker in Github. Forking on Github is another good way. You can send a pull request.

1. Fork [Back to the Top](https://github.com/thingsym/back-to-the-top) from GitHub repository
2. Create a feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Create new Pull Request

## Changelog

* Version 1.0.4
	* change Requires at least from 3.4 to 4.0
	* improve CI environment
	* updated: update jquery.backtothetop.js v1.1.7
* Version 1.0.3
	* fixed: fix backtothetop.admin.js
	* updated: update jquery.backtothetop.js v1.1.6
* Version 1.0.2
	* fixed: fix handle and option name
	* fixed: fix typo
* Version 1.0.1
	* fixed: refactoring by the PHP_CodeSniffer
	* updated: update jquery.backtothetop.js v1.1.5
	* added: add PHPUnit and tests
* Version 1.0.0
	* initial release

## License

Licensed under [GPLv2](https://www.gnu.org/licenses/gpl-2.0.html).