Documentation & Demo

Documentation and demo can be found here

Table of Contents

• Installation
• Description
  • Parameter naming
• Setup
• Development
  • Linting
  • Testing
• How To Contribute
  • Bots used
• License

Installation

With yarn

yarn add react-skillbars

or with npm

npm install react-skillbars

Setup

Import

import ReactSkillbar from 'react-skillbars';

Development

Linting

yarn lib:lint

Testing

yarn lib:test

jest is used for as the testing framework.

Testing coverage is enforced via the jest.config.js to 100% across the board.

How to Contribute

1. Clone repo and create a new branch:

   git checkout https://github.com/crisboarna/react-skillbars -b name_for_new_branch`.
   `

2. Make changes and test
3. Submit Pull Request with comprehensive description of changes

Bots used

To facilitate development the following bots are integrated into the repository:

1. Request Info
2. Semantic Pull Requests
3. Welcome
4. Snyk
5. Todo

License

Full license details can be found in LICENSE.md

2.2.0 (2023-12-06)

Features

• dependencies: updated all dependencies to latest (96544d7)

2.1.0 (2022-10-24)

Features

• bar: configurable symbol and bar background color (0b7797e)

2.0.1 (2022-05-01)

Bug Fixes

• dist: cleaned up distributable, minified (ec478ab)

2.0.0 (2022-04-29)

Features

• hooks: added hooks, ssr, intersection observer (6a4501e)

BREAKING CHANGES

• hooks: removed window dependency