SkillAgentSearch skills...

Relsa

Relsa is a javascript-made horizontal progress bar with switchable steps

Install / Use

/learn @0leg53/Relsa
About this skill

Quality Score

0/100

Supported Platforms

Universal

README

<h1> Relsa 🚂</h1> <p> <img alt="Tests coverage" src="https://github.com/0leg53/relsa/blob/main/coverage/badge.svg" /> <a href="https://www.npmjs.com/package/relsa"><img src="https://badge.fury.io/js/relsa.svg" alt="npm version"></a> <a href="#" target="_blank"> <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-limone.svg" /> </a> </p>

Relsa is javascript-made horizontal progress bar with switchable steps. No dependencies. My first project btw :)

<img alt="Demo GIF" src="https://github.com/0leg53/relsa/blob/main/demo/demo.gif" />

🏠 Homepage

Install

npm install relsa

Usage

  1. Include css- and js- files to page:
<link rel="stylesheet" href="../dist/relsa.css" />
<script src="../dist/relsa.js"></script>

or

import Relsa from 'relsa';
import '~/node_modules/relsa/module/relsa.css';
  1. Add block with selector classname:
<body>
  <div class="relsa"></div>
</body>
  1. Call the Relsa's instance with 'container' property:
var relsa = new Relsa({
  container: '.relsa',
});

Options and methods:

Options:

  • container (String), default: ".relsa-container" — selector for Relsa's render node.

  • render (Number), default: 4 — sets quanity of rendering dots in Relsa.

  • startIndex (Number), default: 1 — sets initial active dot.

  • customDotClassName (String), default: "" — adds custom classname for dots.

  • isResponsive (Boolean), default: true — add compact view for small screens (max-width: 426px).

Methods:

  • setNext() — sets next active dot
  • setPrev() — sets previous active dot
  • setActiveItem(index) — sets active dot by index

Contacts

👤 Oleg Sergeev

🤝 Contributing

Contributions, issues and feature requests are highly welcome! <br /> Feel free to check issues page. <br /> Also you can help me with this README :)

Show your support

Press project's ⭐️

Send 💸💰💸 here


README was generated by readme-md-generator

Related Skills

View on GitHub
GitHub Stars17
CategoryDevelopment
Updated3y ago
Forks0

Languages

JavaScript

Security Score

75/100

Audited on Mar 30, 2023

No findings