Skip to content

Commit 4ac9ea9

Browse files
author
Justin Kimbrell
committed
fix: updated readme
1 parent 8467983 commit 4ac9ea9

File tree

2 files changed

+26
-6
lines changed

2 files changed

+26
-6
lines changed

.changeset/swift-rings-flow.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@vue-interface/pagination": patch
3+
---
4+
5+
Updated README.md

packages/pagination/README.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,24 @@ bun i @vue-interface/pagination
2222

2323
## Basic Usage
2424

25-
```vue
26-
<Pagination v-model="pageNum" :total-pages="100"></Pagination>
27-
```
28-
29-
For more comprehensive documentation and examples, please visit the [online documentation](https://vue-interface.github.io/packages/pagination/).
30-
25+
To create a pagination component, use the parent `pagination` class and then add the `pagination-link` class to the links in the pagination. Use the `active` class to indicate the current page and `disabled` class for non-clickable links.
26+
27+
<div class="flex flex-col gap-3">
28+
<!-- #region basicUsage -->
29+
<div class="pagination">
30+
<a href="#" class="pagination-link">«</a>
31+
<a href="#" class="pagination-link">1</a>
32+
<div class="pagination-link active disabled">2</div>
33+
<a href="#" class="pagination-link">3</a>
34+
<div class="pagination-link disabled">...</div>
35+
<a href="#" class="pagination-link">4</a>
36+
<a href="#" class="pagination-link active">5</a>
37+
<a href="#" class="pagination-link">6</a>
38+
<div class="pagination-link disabled">...</div>
39+
<a href="#" class="pagination-link">7</a>
40+
<a href="#" class="pagination-link">8</a>
41+
<a href="#" class="pagination-link">9</a>
42+
<a href="#" class="pagination-link">»</a>
43+
</div>
44+
<!-- #endregion basicUsage -->
45+
</div>

0 commit comments

Comments
 (0)