Giter VIP home page Giter VIP logo

react-skills's Introduction

react-skills

npm_version license

A dependency-free, pure-css animated, resizable, customizable, skill bars panel React component.

react-skills preview



Links

Installation

npm i react-skills

Usage

import { SkillBars } from 'react-skills';

const skillsData= [
  {
    name: 'ReactJS',
    level: 100,
    color: 'blue',
  },
  {
    name: 'SomeOtherTech',
    level: 85,
    color: 'red',
  }
]

// ...

<SkillBars skills={skillsData} />

or you can use the SkillBar (singular) component this way:

import { SkillBar } from 'react-skills';

// ...

<SkillBar name="ReactJS" level={100} color="blue" />
<SkillBar name="SomeOtherTech" level={80} color="red" />

Developers

Start

npm run start or yarn start

Runs the library in development mode. Open http://localhost:3000 to view it in the browser.

Test

npm run test or yarn test

Runs the test watcher in an interactive mode.

Build

npm run build or yarn build

Builds the library for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

Deploy

npm run deploy or yarn deploy Builds the component then push it on NPM as new version. Builds the github page app for production to the demo folder. Creates a gh-page github branch and push the demo build on that branch.

Props API

SkillBar

Displays a animated skill bar

Property Type Required Default value Description
name string yes The name of the skill.
level number yes The skill level.
color string yes The background color.
duration number no 2 The animation duration in seconds.
height number no 30 The component height.
levelProgress bool no false Whether or not the level text should increment as the bar grows up or directly display the level value.
flat bool no false Whether the component owns a box shadow or not.
labelWidth number no 100 The label width.
customLabel func no null User defined function that takes a skill parameter and returns a React component to display instead of the default label.

SkillBars

Group your Skillbars components together

Property Type Required Default value Description
skills arrayOf yes An array of SkillBar props data
duration number no 2 The animation duration in seconds.
levelProgress bool no false Whether or not the level text should increment as the bar grow up or directly display the level value.
flat bool no false Whether the skillbars own a box shadow or not.
barsHeight number no 30 The SkillBar component height.
labelsWidth number no 100 The SkillBar component label width.
spacing number no 15 The spacing between each SkillBar row.
customLabels func no null User defined function that takes a skill parameter and returns a React component to display instead of the default labels.

This document was generated by the Create React Readme v1.0.2.

react-skills's People

Contributors

dependabot[bot] avatar

Stargazers

Alfonso Marquez avatar Loc Phan avatar Alireza Kavian avatar  avatar

Watchers

James Cloos avatar Kevin Castejon avatar

Forkers

nicodinh

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.