Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BMSVieira committed Jan 29, 2024
1 parent 19e4443 commit e95b09e
Showing 1 changed file with 59 additions and 2 deletions.
61 changes: 59 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,59 @@
# ordena.js
Nested lists made easy
<p align="center">
<img width="350" src="https://raw.githubusercontent.com/BMSVieira/ordena.js/main/demo/img/logo_white.png">
</p>

◼️ Demo:
-
https://bmsvieira.github.io/ordena.js

◼️ Installation (Browser):
-

<b>1 - Include JavaScript Source.</b>
```javascript
<script src="path/to/ordena.js"></script>
```
<b>2 - Include Styles.</b>
```javascript
<link rel="stylesheet" href="path/to/ordena.css">
```
<b>3 - Set HTML.</b>
```html

<!-- Main element -->
<div class="od-list" id="list">

<!-- Item -->
<div class="od-item od-c-item">
<div class="od-name od-c-name">Item 1</div>

<!-- Nested Item -->
<div class="od-item od-c-item nested">
<div class="od-name od-c-name">Item 1.1</div>
</div>

<!-- Nested Item -->
<div class="od-item od-c-item nested">
<div class="od-name od-c-name">Item 1.2</div>

<!-- Nested Item -->
<div class="od-item od-c-item nested">
<div class="od-name od-c-name">Item 1.2.1</div>
</div>
</div>
</div>

<!-- Item -->
<div class="od-item od-c-item">
<div class="od-name od-c-name">Item 2</div>
</div>
</div>
```
<b>4 - Initilize.</b>
```javascript
document.addEventListener("DOMContentLoaded", function() {
const demo = new Ordena({
selector: "#list"
});
});
```

0 comments on commit e95b09e

Please sign in to comment.