mirror of
https://github.com/blasten/turn.js.git
synced 2025-05-03 00:12:37 +08:00
Update README
This commit is contained in:
parent
fd058cfa8c
commit
52e330af28
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "turn.js",
|
"name": "turn.js",
|
||||||
"version": "1.0.4",
|
"version": "1.0.5",
|
||||||
"description": "Web page flipper",
|
"description": "Web page flipper",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
"repository": "https://github.com/igghera/turn.js.git",
|
"repository": "https://github.com/igghera/turn.js.git",
|
||||||
|
40
readme.md
40
readme.md
@ -1,13 +1,15 @@
|
|||||||
A fork of [https://github.com/blasten/turn.js](https://github.com/blasten/turn.js)
|
A fork of [https://github.com/blasten/turn.js](https://github.com/blasten/turn.js)
|
||||||
with support for npm/yarn.
|
with support for npm/yarn.
|
||||||
|
|
||||||
Usage:
|
## Usage
|
||||||
|
|
||||||
|
### JS
|
||||||
|
|
||||||
```
|
```
|
||||||
import $ from 'jquery';
|
import $ from 'jquery';
|
||||||
import 'turn.js';
|
import 'turn.js';
|
||||||
|
|
||||||
$('#flipbook').turn({
|
$('#magazine').turn({
|
||||||
width: 800,
|
width: 800,
|
||||||
height: 600,
|
height: 600,
|
||||||
autoCenter: true
|
autoCenter: true
|
||||||
@ -15,10 +17,38 @@ $('#flipbook').turn({
|
|||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
Basically I just added a package.json file and specified a main entry point + a
|
### HTML
|
||||||
dependency (jquery) to make turn.js installable via npm/yarn.
|
|
||||||
|
|
||||||
I have submitted a PR to the authors of [https://github.com/blasten/turn.js](https://github.com/blasten/turn.js) but in the meantime you can use this one, as they don't seem to update their repo regularly.
|
```
|
||||||
|
<div id="magazine">
|
||||||
|
<div><span class="text">Page 1</span></div>
|
||||||
|
<div><span class="text">Page 2</span></div>
|
||||||
|
<div><span class="text">Page 3</span></div>
|
||||||
|
</div>
|
||||||
|
```
|
||||||
|
|
||||||
|
### CSS
|
||||||
|
|
||||||
|
```
|
||||||
|
#magazine{
|
||||||
|
width: 800px;
|
||||||
|
height: 400px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#magazine .turn-page{
|
||||||
|
background-color:#ccc;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
For the full documentation on the library and all available options, please
|
||||||
|
refer to [https://github.com/blasten/turn.js](https://github.com/blasten/turn.js).
|
||||||
|
|
||||||
|
Basically I just added a package.json file, specified a main entry point + a
|
||||||
|
dependency (jquery) and fixed a couple of things to make turn.js installable via npm/yarn
|
||||||
|
and loadable via Webpack in my React project.
|
||||||
|
|
||||||
|
I have submitted a PR to the authors of the original libray, but in the meantime
|
||||||
|
you can use this one, as they don't seem to update their repo regularly.
|
||||||
|
|
||||||
Latest version uses jQuery 1.12.0 because jQuery 3.x was breaking the page
|
Latest version uses jQuery 1.12.0 because jQuery 3.x was breaking the page
|
||||||
flipper.
|
flipper.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user