Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shinnn/set-location-hash.js
Set the anchor portion of current URL without scrolling
https://github.com/shinnn/set-location-hash.js
Last synced: 27 days ago
JSON representation
Set the anchor portion of current URL without scrolling
- Host: GitHub
- URL: https://github.com/shinnn/set-location-hash.js
- Owner: shinnn
- License: mit
- Created: 2014-04-04T15:21:36.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2014-09-21T05:52:28.000Z (about 10 years ago)
- Last Synced: 2024-05-29T10:10:15.553Z (6 months ago)
- Language: JavaScript
- Size: 242 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# set-location-hash.js
[](http://badge.fury.io/bo/set-location-hash)
[](http://badge.fury.io/js/set-location-hash)
[](https://travis-ci.org/shinnn/set-location-hash.js)
[](https://david-dm.org/shinnn/set-location-hash.js#info=devDependencies)
[](https://ci.testling.com/shinnn/set-location-hash.js)
A client-side library to set the anchor portion of current URL without scrolling
```javascript
// On http://yoursite.com/
setLocationHash('foo');
location.href; //=> "http://yoursite.com/#foo"
```
## Installation
### Package managers
#### [Bower](http://bower.io/)
```
bower i --save set-location-hash
```
#### [npm](https://www.npmjs.org/)
```
npm i --save set-location-hash
```
#### [Duo](http://duojs.org/)
```javascript
var setLocationHash = require('shinnn/set-location-hash.js');
```
### Standalone
[Download the script file directly.](https://raw.githubusercontent.com/shinnn/set-location-hash.js/master/dist/set-location-hash.js "view raw")
### [AMD](https://github.com/amdjs/amdjs-api/blob/master/AMD.md) support
This repository includes [the AMD-friendly build](https://raw.githubusercontent.com/shinnn/set-location-hash.js/master/dist/set-location-hash-amd.js) but the package managers doesn't include it. If you want to use it, download it directly.
## API
### setLocationHash(*identifier* [, *options*])
*identifier*: `String`
*options*: `Object`
Return: `String` (Current entire URL)
Change the [fragment identifier](http://www.w3.org/TR/html4/intro/intro.html#h-2.1.2) of current URL to the `String` of the `identifier` argument.
This function is vary similar to `location.hash` property, but this function won't change the scroll position of the page unlike `location.hash`.
If the browser supports [`history.pushState`](https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Manipulating_the_browser_history#The_pushState\(\).C2.A0method) and [`history.replaceState`](https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Manipulating_the_browser_history#The_replaceState\(\).C2.A0method), you can set `replace` and `force` options by passing an `Object` to the `options` argument.
#### options.replace
Type: `Boolean`
Default: `false`
Replace the browser history instead of pushing a new history.
```javascript
// On http://yoursite.com/
history.length; //=> 1
setLocationHash('foo', {replace: true});
history.length; //=> 1
setLocationHash('bar');
history.length; //=> 2
```
#### options.force
Type: `Boolean`
Default: `false`
By default, this function doesn't push a new history when the old URL is the same as new one. If you set this option `true`, it will push a new history in any case.
```javascript
// On http://yoursite.com/#foo
history.length; //=> 1
setLocationHash('foo');
history.length; //=> 1
setLocationHash('foo', {force: true});
history.length; //=> 2
```
## License
Copyright (c) 2014 [Shinnosuke Watanabe](https://github.com/shinnn)
Licensed under [the MIT License](./LICENSE).