0.9.7 β€’ Published 3 years ago

relsa v0.9.7

Weekly downloads
-
License
MIT
Repository
-
Last release
3 years ago

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

🏠 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! Feel free to check issues page. Also you can help me with this README :)

Show your support

Press project's ⭐️

Send πŸ’ΈπŸ’°πŸ’Έ here


README was generated by readme-md-generator

0.9.7

3 years ago

0.9.6

3 years ago

0.9.5

3 years ago

0.9.4

3 years ago

0.9.3

3 years ago

0.9.0

3 years ago

0.9.2

3 years ago

0.9.1

3 years ago

0.0.1

3 years ago