-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
46 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
![downloads](https://img.shields.io/npm/dm/scroll-to-stick?style=flat-square) | ||
![version](https://img.shields.io/npm/v/scroll-to-stick?color=green&style=flat-square) | ||
|
||
<p align="center"> | ||
<a href="https://github.com/dibosh/kustron"> | ||
<img alt="scroll to stick" title="scroll to stick" src="www/assets/icon_sts.png" width="200"> | ||
</a> | ||
</p> | ||
|
||
<p align="center"> | ||
A Javascript way to create parallax header effects. | ||
</p> | ||
|
||
## Table of Contents | ||
|
||
- [Introduction](#introduction) | ||
- [Features](#features) | ||
- [Usage](#usage) | ||
- [Feedback](#feedback) | ||
|
||
## Introduction | ||
|
||
If you are building a mobile-first webapp and you would like to have a parallax effect that normally a native app header can have- this tiny simple lib will get your job done. | ||
|
||
## Features | ||
|
||
* Native like parallex effect, simply using Javascript | ||
|
||
* Event driven helper method, to help you do or invoke other customizations when the parallex effect starts and ends | ||
|
||
## Prerequisite | ||
|
||
- Install via [npm](https://www.npmjs.com/)- `npm i scroll-to-stick` | ||
|
||
## Usage | ||
|
||
- Check the [webpage](https://dibosh.github.io/scroll-to-stick/) for detailed usage guide. | ||
|
||
|
||
## Feedback | ||
|
||
Feel free to [file an issue](https://github.com/dibosh/scroll-to-stick/issues/new). | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters