progress-widgets

Progress Widgets for React.js

By Jason Dunn

Github: https://www.github.com/jgddesigns

A progress widgets component for use with React.js and Next.js. Customize size, color and progress sections. Bar, Meter, Pie and Symbol Widgets available. Can be used to display metrics for goals or tasks, as a meter for video game progress, quantities such as temperature, or anything else you can think of!

DEMO: https://progress-widgets-deploy.vercel.app/

NPM Package: https://www.npmjs.com/package/progress-widgets

Examples:

Getting Started:

From Terminal 
    npm install progress-widgets

Import Line
    import ProgressWidgets from 'progress-widgets'

Component Example:

  <ProgressWidgets Trigger={[Trigger, setTrigger]} TriggerAmount={[TriggerAmount, setTriggerAmount]} Title="My Symbols Widget" Type="symbols" Color={["red", "orange", "yellow", "lime", "green"]}  Size={4} LengthValue={12} Style="stars"/>

Props Detailed:

Trigger (required)

    A React state-variable set that holds a boolean value which triggers the movement of the current widget. The variable moves the widget when set to 'true'. The state does not need to be set to 'false' on the project end.

    Example:

        Trigger={[MyTrigger, setMyTrigger]}

    *Needs a function that includes setMyTrigger(true). This is to be called when the widget progress is intended to change. 
    **The names 'MyTrigger' and 'setMyTrigger' can be anything on your end, as long as they are a state variable and passed in the 'Trigger' prop as a two element array object as shown above.

    
TriggerAmount (required)

    A React state-variable set that holds a number value containing the current percentage at which the widget is intended to increment. The percentage needs to be set prior to setting the Trigger state to 'true'. The amount can be static and the increment can be stable over time (ex. 10). It can also be changed on your end by calling setMyTriggerAmount(x) based on percentages (such as a damage meter or experience bar seen in a video games).

    Example:

        TriggerAmount={[MyTriggerAmount, setMyTriggerAmount]}

    *If the increment amount is intended to fluctuate, a function needs to be called that includes setMyTriggerAmount(x). As mentioned above, this is to be called prior to setMyTrigger(true).
    **The names 'MyTriggerAmount' and 'setMyTriggerAmount' can be anything on your end, as long as they are a state variable and passed in the 'TriggerAmount' prop as a two element array object as shown above.
    **Based on 100 max percentage.


Title (optional)

    A string holding the title of the chart.

    Defaults to no title if prop is not set.

    Example:

        Title="My Progress Widget"


Type (optional)

    A string containing the type of widget. 

    Choices:

        bar
        meter
        pie
        symbols

    Defaults to "bar" if prop is not set.

    Examples:

        Type="meter"

        Type="Meter"

        Type="METER"

        Type="MeTeR"


Color (optional)

    An array containing the colors intended to be used.

    In bar, meter, and pie types, the number of sections is dependent on the amount of colors in the array.

    Accepts:

        Hex Value: '#000fff'
            or
        CSS Color: 'green'

    Defaults to ["red", "yellow", "green"] if prop is not set.

    Examples:

        Color=["#000fff", "#123abc", "#000fff", "#ea45ca"]

        Color=["blue", "turqoise", "aqua", "sky-blue"]

        Color=["blue", "turqoise", "#000fff", "#ea45ca"]


Size (optional)

    Ranges from extra small to extra large using number values 1-5.

    Defaults to 3 (medium) if prop is not set.

    Example:

        Size={4}


LengthValue (optional, 'symbols' type only)

    Number value that sets the amount of symbols to be displayed.

    Defaults to 10 if prop is not set.

    Example:

        LengthValue={25}


Style (optional, 'symbols' type only)

    A string describing the style of symbol used in the 'symbols' widget. 

    Choices:

        circles 
        squares 
        bar 
        meter 
        stars 
        hearts 
        moons 
        hexagons 
        diamonds 
        trapezoids
        arrows_right
        arrows_left
        arrows_up
        arrows_down

    Defaults to "squares" if prop is not set.

    Examples:

        Style="trapezoids"

MIT License

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.