https://github.com/gillstrom/deku-scroll-up

"Scroll to top of page" component for deku.
https://github.com/gillstrom/deku-scroll-up

Last synced: 26 days ago
JSON representation

"Scroll to top of page" component for deku.

• Host: GitHub
• URL: https://github.com/gillstrom/deku-scroll-up
• Owner: gillstrom
• License: mit
• Created: 2015-10-11T17:30:52.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-06-07T06:43:08.000Z (over 8 years ago)
• Last Synced: 2024-12-05T09:23:48.481Z (about 1 month ago)
• Language: JavaScript
• Homepage: http://scroll.surge.sh
• Size: 5.86 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

• awesome-deku - deku-scroll-up - "Scroll to top of page" component for deku (Components)

README

        
# deku-scroll-up

> "Scroll to top of page" component for deku

## Install

```

$ npm install --save deku-scroll-up

```

## Usage

```js

import ScrollUp from 'deku-scroll-up';

export function render() {

	return (

		

			UP!

		

	);

}

```

## Attributes

### show

*Required*  

Type: `number`

At what distance from top the element will be displayed.

### top

Type: `number`  

Default: `0`

Position to which you will be moved on click.

### duration

Type: `number`  

Default: `500`

Time in milliseconds it will take to reach the `top` position.

### ease

Type: `string`  

Default: `out-circ`

Type of scrolling easing. Complete list can be found [here](https://github.com/component/ease#aliases).

### class

Type: `string`

Add classes to the element

## License

MIT © [Andreas Gillström](http://github.com/gillstrom)