0.9.7 β’ Published 3 years ago
relsa v0.9.7
Relsa is javascript-made horizontal progress bar with switchable steps. No dependencies. My first project btw :)
π Homepage
Install
npm install relsa
Usage
- 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';
- Add block with selector classname:
<body>
<div class="relsa"></div>
</body>
- 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 dotsetPrev()
β sets previous active dotsetActiveItem(index)
β sets active dot by index
Contacts
π€ Oleg Sergeev
- Github: @0leg53
- LinkedIn: @sergeevoleg
- Telegram: @sergeevoleg
π€ 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