Durata

A class to move a initial float value to a target value during a defined time period.

Features / Structure / Interface

• No dependencies
• AMD-, CommonJS and global-support

Installation

    $ npm install durata

API documentation

API of Durata

Examples

Simple Demonstration

Demonstrates the progress of a passed float-value.

<div id="output"></div>
<script src="node_modules/durata/dist/durata.min.js"></script>
<script>
    var output = document.getElementById('output'),
        // Move value from 200 to 10000 during 5000 milliseconds
        progress = Durata.create(200, 10000, 5000);

    progress.on('update', function () {
        output.innerText = Math.ceil(progress.get());
    });
</script>

Demo: https://jsfiddle.net/sp29t5h4/

Create a new animated value

Moving a maroon colored div from a upper left position to a lower right position.

<div id="spot"
     style="position: absolute;
            width: 100px;
            height: 100px;
            top: 30px;
            left: 45px;
            background-color: maroon">&nbsp;</div>

<script src="node_modules/durata/dist/durata.min.js"></script>

<script>
    var spot = document.getElementById('spot'),
        xPos = Durata.create(5, 515, 1000),
        yPos = Durata.create(25, 445, 1200);

    function updateSpot(xPos, yPos) {
        this.style.left = xPos.get() + 'px';
        this.style.top = yPos.get() + 'px';
        if (!xPos.isComplete() || !yPos.isComplete()) {
            requestAnimationFrame(updateSpot.bind(this, xPos, yPos));
        }
    }

    requestAnimationFrame(updateSpot.bind(spot, xPos, yPos));
</script>

Demo: https://jsfiddle.net/d0hqa18r/

Use durata with AMD and group values to move by array

Morphing color maroon to marine blue in 2 seconds and alert a text when complete. The morphing is done by registering an event listener, that will be called when an update of animation frame arises.

<div id="spot"
     style="position: absolute;
            width: 100px;
            height: 100px;
            top: 30px;
            left: 45px;
            background-color: maroon">&nbsp;</div>

<script src="node_modules/requirejs/require.js"></script>

<script>
    require.config({baseUrl: 'node_modules'});

    var spot = document.getElementById('spot');
    function updateSpotColor() {
        spot.style.backgroundColor = [
          'rgb(' + this.get()[0], this.get()[1], this.get()[2] + ')'
        ].join(',');
    }

    require(['durata/dist/durata.min'], function(Durata) {
        Durata
          .create([128, 0, 0], [42, 107, 204], 2000)
          .on('update', updateSpotColor)
          .on('complete', function () { alert('Color morphing complete'); });
    });
</script>

Demo: https://jsfiddle.net/bqLtvamg/

Grab progress on update

<div id="border"
     style="position: absolute;
            z-index: 5;
            width: 500px;
            height: 30px;
            top: 30px;
            left: 45px;
            border: 1px solid black;
            text-align: center;
            background: none">0%</div>
<div id="bar"
     style="position: absolute;
            z-index: 2;
            width: 0;
            height: 30px;
            top: 31px;
            left: 46px;
            background-color: blue">&nbsp;</div>

<script src="node_modules/requirejs/require.js"></script>

<script>
    require.config({baseUrl: 'node_modules'});

    var bar = document.getElementById('bar'),
        border = document.getElementById('border');
    function updateBarWidth(tween) {
        this.style.width = tween.get() + 'px';
        border.innerHTML = Math.round(tween.getProgress()*100) + '%';

        if (!tween.isComplete()) {
            requestAnimationFrame(updateBarWidth.bind(this, tween));
        }
    }

    require(['durata/dist/durata.min'], function(Durata) {
        var tween = Durata.create(0, 500, 7000);
        requestAnimationFrame(updateBarWidth.bind(bar, tween));
    });
</script>

Demo https://jsfiddle.net/w8Lmsv4r/

Use durata with easing

The easing-function takes a value between 0.0 and 1.0. For best the function should return a value in this range (0.0 to 1.0).

<div id="spot"
     style="position: absolute;
            width: 100px;
            height: 100px;
            top: 30px;
            left: 45px;
            background-color: rgb(42,107,204)">&nbsp;</div>

<script src="node_modules/requirejs/require.js"></script>

<script>
    require.config({baseUrl: 'node_modules'});

    var spot = document.getElementById('spot');
    function updateSpot(xPos, yPos, r, g, b) {
        this.style.left = xPos.get() + 'px';
        this.style.top = yPos.get() + 'px';
        this.style.backgroundColor
            = 'rgb(' + r.get() + ',' + g.get() + ',' + b.get() + ')';
        if (!xPos.isComplete() || !yPos.isComplete()
            || !r.isComplete() || !g.isComplete() || !b.isComplete()
        ) {
            requestAnimationFrame(updateSpot.bind(this, xPos, yPos, r, g, b));
        }
    }

    require (['durata/dist/durata.min'], function (Durata) {
        var xPos = Durata.create(5, 515, 1000),
                                                // pass easing function
            yPos = Durata.create(25, 445, 1000, function(y) { return y*y*y; });
        var r = Durata.create(42, 255, 2000);
        var g = Durata.create(107, 215, 1200);
        var b = Durata.create(204, 0, 1500);

        requestAnimationFrame(updateSpot.bind(spot, xPos, yPos, r, g, b));
    });
</script>

Demo: https://jsfiddle.net/cyf3v7uj/

Development

If you want to distribute your changes in the 'dist'-directory, you can use gulp:

    $ npm run build

License

The MIT License (MIT)

Copyright (c) 2018 Daniel Moritz

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.