Fitbit-flip NPM

Flip animation for Fitbit

This library allows you create flip animations in Fitbit apps and clockfaces.

Example

Installation

Install the library with npm i fitbit-flip

The installer will ask you if it can copy the library gui files in your resources folder:
Press Y and the fitbit-flip.gui file will be created automatically.
Press N if you prefer to copy the file manually afterwards (default choice is Yes)

You still need to modify the resources/widgets.gui file to add the link to fitbit-flip.gui:

<svg>
    <defs>
        <link rel="stylesheet" href="styles.css" />
        <link rel="import" href="/mnt/sysassets/widgets_common.gui" />
        <!-- import fitbit-flip ui file -->
        <link rel="import" href="fitbit-flip.gui" />
    </defs>
</svg>

Usage

Use a fitbit-flip symbol in your index.gui file:

    <use href="#fitbit-flip" id="elem" x="20" y="20" />

Import and use the library in your app/index.js:

    import { FitbitFlip } from 'fitbit-flip';

    const elem = new FitbitFlip({
        id: "elem", // id of GUI element
        img_width: 84, //width of image to animate (there will be 2 per element)
        img_height: 67, //height of image to animate (there will be 2 per element)
        duration: 1 // time in seconds to complete half animation (optional, if omited - 1 second will be assumed)
    });

    //assign images to animate
    elem.startStaticImage = `new_top.png`; // new image to show (first part)
    elem.endImage = `new_bottom.png`;  // new image to show (second part)
    elem.startImage = `old_top.png`;  // old image (first part)
    elem.endStaticImage = `old_bottom.png`; // old image (second part)
    
    elem.duration = 2; // duration (time in seconds to complete half animation) can also be changed if needed 

    elem.flip();    // animate

Launch your app and enjoy.