Merge branch 'master' into dev

Author: xavierfoucrier

.editorconfig

@@ -0,0 +1,15 @@
+# top-most editorconfig file
+root = true
+
+# editor configuration
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+# preserve markdown line break
+[*.md]
+trim_trailing_whitespace = false

.gitignore

@@ -1 +1 @@
-node_modules/
+node_modules/

.npmignore

@@ -0,0 +1,9 @@
+mockups/
+css/
+lib/
+js/
+.editorconfig
+index.html
+bower.json
+gulpfile.js
+webpack.config.js

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Oleg Solomka
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,66 +1,65 @@
-# mojs-player
+# @mojs/player – [![npm](https://img.shields.io/npm/v/@mojs/player.svg)](https://www.npmjs.com/package/@mojs/player)
 
-<img src="https://github.com/legomushroom/mojs-player/blob/master/mockups/[email protected]?raw=true" alt="mojs-player" />
+GUI player to control your animations.
+
+![@mojs/player](logo.png "@mojs/player")
 
 Player controls for [mojs](mojs.io). Intended to help you to craft `mojs` animation sequences. To be clear, this player is not needed to play `mojs` animations. It is just a debug tool that gives you the ability to:
- - control your sequences with `GUI` while working on them
- - it saves the current progress of your animation thus you don't loose the `focus`
- - it gives you `bounds` to constrain `focus point` of your animation
- - it gives you the control over the speed of animation
- - it gives you the ability to seek animations freely
- - it saves player's state and settings thus they not get lost when page reloaded
+- control your sequences with `GUI` while working on them
+- it saves the current progress of your animation thus you don't loose the `focus`
+- it gives you `bounds` to constrain `focus point` of your animation
+- it gives you the control over the speed of animation
+- it gives you the ability to seek animations freely
+- it saves player's state and settings thus they not get lost when page reloaded
 
 ## Installation
 
 The `MojsPlayer` depends on `mojs >= 0.225.2` so make sure you link it first.
 
-[CDN](https://www.jsdelivr.com/):
-
-```
-<script src="//cdn.jsdelivr.net/mojs-player/latest/mojs-player.min.js"></script>
-```
-
-[NPM](https://www.npmjs.com/):
-
-```
-[sudo] npm install mojs-player
-```
-
-[Bower](http://bower.io/):
+```console
+# cdn
+<script src="https://cdn.jsdelivr.net/npm/@mojs/player"></script>
 
-```
-bower install mojs-player
+# npm
+npm i @mojs/player
 ```
 
-Import `MojsPlayer` constructor to your code (depends on your environment) :
+Import `MojsPlayer` constructor to your code, depending on your environment:
 
 ```javascript
 const MojsPlayer = require('mojs-player').default;
+
 // or
-import MojsPlayer from 'mojs-player';
+import MojsPlayer from '@mojs/player';
 ```
 
-If you installed it with script link - you should have `MojsPlayer` global.
+> If you installed it with script link — you should have `MojsPlayer` global
 
 ## Usage
 
-Construct `MojsPlayer` and pass your main `Tween/Timeline` as the `add` option:
+Construct `MojsPlayer` and pass your main `Tween/Timeline` to the `add` option:
 
 ```javascript
-// const mainTimeline = new mojs.Timeline({});
-// .. some code regarding timeline ..
-const mojsPlayer = new MojsPlayer({ add: mainTimeline });
+// create the timeline
+const mainTimeline = new mojs.Timeline({});
+
+// add the timeline to the player
+const mojsPlayer = new MojsPlayer({
+  add: mainTimeline
+});
 ```
 
-The `add` option is the only required option to launch. Player's controls should appear at the bottom of the page.
+> The `add` option is the **only required option** to launch: player's controls should appear at the bottom of the page when ready
 
 You can also set other player initial state:
 
 ```javascript
-// ..
 const mojsPlayer = new MojsPlayer({
-  add:      mainTimeline,
-  // options
+
+  // required
+  add:          mainTimeline,
+
+  // optionally
   className:    '',         // class name to add to main HTMLElement
   isSaveState:  true,       // determines if should preserve state on page reload
   isPlaying:    false,      // playback state
@@ -73,7 +72,14 @@ const mojsPlayer = new MojsPlayer({
   speed:        1,          // `speed` value
   isHidden:     false,      // determines if the player should be hidden
   precision:    0.1,        // step size for player handle - for instance, after page reload - player should restore timeline progress - the whole timeline will be updated incrementally with the `precision` step size until the progress will be met.
-  name:         'mojs-player' // name for the player - mainly used for localstorage identifier, use to distuguish between multiple local players
+  name:         'mojs-player', // name for the player - mainly used for localstorage identifier, use to distinguish between multiple local players
+  onToggleHide(isHidden) {  // should be called after user taps on the hide-button (isHidden is a boolean, indicating the visibility state of the player)
+    if (isHidden) {
+      // do something when player is invisible
+    } else {
+      // do something when player is visible
+    }
+  }
 });
 ```
 
@@ -99,32 +105,20 @@ const mojsPlayer = new MojsPlayer({
 
 Install [webpack](https://webpack.github.io/) globally:
 
-```tiddlywiki
+```console
 [sudo] npm install webpack -g
 ```
 
 Install dependencies with [npm](https://www.npmjs.com/):
 
-```
+```console
 [sudo] npm install
 ```
 
 Run [webpack](https://webpack.github.io/):
 
-```
+```console
 webpack
 ```
 
 Please make sure you are on the `dev` branch before making changes.
-
-## License
-
-(The MIT License)
-
-Copyright (c) Oleg Solomka [@LegoMushroom](https://twitter.com/legomushroom) [[email protected]](mailto:[email protected])
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

bower.json

@@ -29,4 +29,4 @@
     "test",
     "tests"
   ]
-}
+}