{"id":23156461,"url":"https://github.com/thecreation/jquery-scrolltotop","last_synced_at":"2025-12-12T04:25:12.068Z","repository":{"id":8806652,"uuid":"10502721","full_name":"thecreation/jquery-scrollToTop","owner":"thecreation","description":"A jQuery plugin that display a button for scrolling the page to the top.","archived":false,"fork":false,"pushed_at":"2017-09-19T11:55:56.000Z","size":486,"stargazers_count":14,"open_issues_count":4,"forks_count":12,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-08-12T03:37:44.388Z","etag":null,"topics":["jquery-plugin","scrolltotop"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thecreation.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-06-05T13:08:22.000Z","updated_at":"2019-01-21T04:17:54.000Z","dependencies_parsed_at":"2022-09-04T03:22:57.924Z","dependency_job_id":null,"html_url":"https://github.com/thecreation/jquery-scrollToTop","commit_stats":null,"previous_names":["amazingsurge/jquery-scrolltotop"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/thecreation/jquery-scrollToTop","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecreation%2Fjquery-scrollToTop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecreation%2Fjquery-scrollToTop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecreation%2Fjquery-scrollToTop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecreation%2Fjquery-scrollToTop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thecreation","download_url":"https://codeload.github.com/thecreation/jquery-scrollToTop/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecreation%2Fjquery-scrollToTop/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270922510,"owners_count":24668567,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-17T02:00:09.016Z","response_time":129,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jquery-plugin","scrolltotop"],"created_at":"2024-12-17T21:13:44.240Z","updated_at":"2025-12-12T04:25:12.034Z","avatar_url":"https://github.com/thecreation.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [jQuery scrollToTop](https://github.com/amazingSurge/jquery-scrollToTop) ![bower][bower-image] [![NPM version][npm-image]][npm-url] [![Dependency Status][daviddm-image]][daviddm-url] [![prs-welcome]](#contributing)\n\n\u003e A jquery plugin that automatically add a button to scroll to top.\n\n## Table of contents\n- [Main files](#main-files)\n- [Quick start](#quick-start)\n- [Requirements](#requirements)\n- [Usage](#usage)\n- [Examples](#examples)\n- [Options](#options)\n- [Methods](#methods)\n- [Events](#events)\n- [No conflict](#no-conflict)\n- [Browser support](#browser-support)\n- [Contributing](#contributing)\n- [Development](#development)\n- [Changelog](#changelog)\n- [Copyright and license](#copyright-and-license)\n\n## Main files\n```\ndist/\n├── jquery-scrollToTop.js\n├── jquery-scrollToTop.es.js\n├── jquery-scrollToTop.min.js\n└── css/\n    ├── scrollToTop.css\n    └── scrollToTop.min.css\n```\n\n## Quick start\nSeveral quick start options are available:\n#### Download the latest build\n\n * [Development](https://raw.githubusercontent.com/amazingSurge/jquery-scrollToTop/master/dist/jquery-scrollToTop.js) - unminified\n * [Production](https://raw.githubusercontent.com/amazingSurge/jquery-scrollToTop/master/dist/jquery-scrollToTop.min.js) - minified\n\n#### Install From Bower\n```sh\nbower install jquery-scrollToTop --save\n```\n\n#### Install From Npm\n```sh\nnpm install jquery-scrollToTop --save\n```\n\n#### Install From Yarn\n```sh\nyarn add jquery-scrollToTop\n```\n\n#### Build From Source\nIf you want build from source:\n\n```sh\ngit clone git@github.com:amazingSurge/jquery-scrollToTop.git\ncd jquery-scrollToTop\nnpm install\nnpm install -g gulp-cli babel-cli\ngulp build\n```\n\nDone!\n\n## Requirements\n`jquery-scrollToTop` requires the latest version of [`jQuery`](https://jquery.com/download/).\n\n## Usage\n#### Including files:\n\n```html\n\u003clink rel=\"stylesheet\" href=\"/path/to/scrollToTop.css\"\u003e\n\u003cscript src=\"/path/to/jquery.js\"\u003e\u003c/script\u003e\n\u003cscript src=\"/path/to/jquery-scrollToTop.js\"\u003e\u003c/script\u003e\n```\n\n#### Initialization\nAll you need to do is call the plugin on the element:\n\n```javascript\njQuery(function($) {\n  $('body').scrollToTop({\n    skin: 'cycle'\n  });\n});\n```\n\n## Examples\nThere are some example usages that you can look at to get started. They can be found in the\n[examples folder](https://github.com/amazingSurge/jquery-scrollToTop/tree/master/examples).\n\n## Options\n`jquery-scrollToTop` can accept an options object to alter the way it behaves. You can see the default options by call `$.scrollToTop.setDefaults()`. The structure of an options object is as follows:\n\n```\n{\n  distance: 200,\n  speed: 1000,\n  easing: 'linear',\n  animation: 'fade', // fade, slide, none\n  animationSpeed: 500,\n\n  mobile: {\n    width: 768,\n    distance: 100,\n    speed: 1000,\n    easing: 'easeInOutElastic',\n    animation: 'slide',\n    animationSpeed: 200\n  },\n\n  trigger: null, // Set a custom triggering element. Can be an HTML string or jQuery object\n  target: null, // Set a custom target element for scrolling to. Can be element or number\n  text: 'Scroll To Top', // Text for element, can contain HTML\n\n  skin: null,\n  throttle: 250,\n\n  namespace: 'scrollToTop'\n}\n```\n\n## Methods\nMethods are called on scrollToTop instances through the scrollToTop method itself.\nYou can also save the instances to variable for further use.\n\n```javascript\n// call directly\n$().scrollToTop('destroy');\n\n// or\nvar api = $().data('scrollToTop');\napi.destroy();\n```\n\n#### jump()\nJump to top.\n```javascript\n$().scrollToTop('jump');\n```\n\n#### enable()\nEnable the scrollbar functions.\n```javascript\n$().scrollToTop('enable');\n```\n\n#### disable()\nDisable the scrollbar functions.\n```javascript\n$().scrollToTop('disable');\n```\n\n#### destroy()\nDestroy the scrollbar instance.\n```javascript\n$().scrollToTop('destroy');\n```\n\n## Events\n`jquery-scrollToTop` provides custom events for the plugin’s unique actions. \n\n```javascript\n$('.the-element').on('scrollToTop::jump', function (e) {\n  // on jump to top\n});\n```\n\nEvent   | Description\n------- | -----------\nenable  | Fired when the `enable` instance method has been called.\ndisable | Fired when the `disable` instance method has been called.\nshow    | Fired when showing the toggle.\nhide    | Fired when hiding the toggle.\njump    | Fired when jumping to the top.\ndestroy | Fires when an instance is destroyed. \n\n## No conflict\nIf you have to use other plugin with the same namespace, just call the `$.scrollToTop.noConflict` method to revert to it.\n\n```html\n\u003cscript src=\"other-plugin.js\"\u003e\u003c/script\u003e\n\u003cscript src=\"jquery-scrollToTop.js\"\u003e\u003c/script\u003e\n\u003cscript\u003e\n  $.scrollToTop.noConflict();\n  // Code that uses other plugin's \"$().scrollToTop\" can follow here.\n\u003c/script\u003e\n```\n\n## Browser support\n\nTested on all major browsers.\n\n| \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/safari/safari_32x32.png\" alt=\"Safari\"\u003e | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/chrome/chrome_32x32.png\" alt=\"Chrome\"\u003e | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/firefox/firefox_32x32.png\" alt=\"Firefox\"\u003e | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/edge/edge_32x32.png\" alt=\"Edge\"\u003e | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/internet-explorer/internet-explorer_32x32.png\" alt=\"IE\"\u003e | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/opera/opera_32x32.png\" alt=\"Opera\"\u003e |\n|:--:|:--:|:--:|:--:|:--:|:--:|\n| Latest ✓ | Latest ✓ | Latest ✓ | Latest ✓ | 9-11 ✓ | Latest ✓ |\n\nAs a jQuery plugin, you also need to see the [jQuery Browser Support](http://jquery.com/browser-support/).\n\n## Contributing\nAnyone and everyone is welcome to contribute. Please take a moment to\nreview the [guidelines for contributing](CONTRIBUTING.md). Make sure you're using the latest version of `jquery-scrollToTop` before submitting an issue. There are several ways to help out:\n\n* [Bug reports](CONTRIBUTING.md#bug-reports)\n* [Feature requests](CONTRIBUTING.md#feature-requests)\n* [Pull requests](CONTRIBUTING.md#pull-requests)\n* Write test cases for open bug issues\n* Contribute to the documentation\n\n## Development\n`jquery-scrollToTop` is built modularly and uses Gulp as a build system to build its distributable files. To install the necessary dependencies for the build system, please run:\n\n```sh\nnpm install -g gulp\nnpm install -g babel-cli\nnpm install\n```\n\nThen you can generate new distributable files from the sources, using:\n```\ngulp build\n```\n\nMore gulp tasks can be found [here](CONTRIBUTING.md#available-tasks).\n\n## Changelog\nTo see the list of recent changes, see [Releases section](https://github.com/amazingSurge/jquery-scrollToTop/releases).\n\n## Copyright and license\nCopyright (C) 2016 amazingSurge.\n\nLicensed under [the LGPL license](LICENSE).\n\n[⬆ back to top](#table-of-contents)\n\n[bower-image]: https://img.shields.io/bower/v/jquery-scrollToTop.svg?style=flat\n[bower-link]: https://david-dm.org/amazingSurge/jquery-scrollToTop/dev-status.svg\n[npm-image]: https://badge.fury.io/js/jquery-scrollToTop.svg?style=flat\n[npm-url]: https://npmjs.org/package/jquery-scrollToTop\n[license]: https://img.shields.io/npm/l/jquery-scrollToTop.svg?style=flat\n[prs-welcome]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg\n[daviddm-image]: https://david-dm.org/amazingSurge/jquery-scrollToTop.svg?style=flat\n[daviddm-url]: https://david-dm.org/amazingSurge/jquery-scrollToTop\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthecreation%2Fjquery-scrolltotop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthecreation%2Fjquery-scrolltotop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthecreation%2Fjquery-scrolltotop/lists"}