Skip to content

Commit 4588944

Browse files
committed
fix(pagination): update JSDoc descriptions for dispatched events
1 parent b6a7263 commit 4588944

File tree

4 files changed

+18
-15
lines changed

4 files changed

+18
-15
lines changed

COMPONENT_INDEX.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2764,12 +2764,12 @@ None.
27642764

27652765
### Events
27662766

2767-
| Event name | Type | Detail | Description |
2768-
| :--------------------- | :--------- | :------------------------------------------------- | :------------------------------------- |
2769-
| change | dispatched | <code>{ page?: number; pageSize?: number; }</code> | Dispatched after any user interaction. |
2770-
| click:button--previous | dispatched | <code>{ page: number; }</code> | Dispatched after any user interaction. |
2771-
| click:button--next | dispatched | <code>{ page: number; }</code> | Dispatched after any user interaction. |
2772-
| update | dispatched | <code>{ pageSize: number; page: number; }</code> | Dispatched after any user interaction. |
2767+
| Event name | Type | Detail | Description |
2768+
| :--------------------- | :--------- | :------------------------------------------------- | :------------------------------------------------------------------------------ |
2769+
| change | dispatched | <code>{ page?: number; pageSize?: number; }</code> | Dispatched when the user changes the page or page size through any interaction. |
2770+
| click:button--previous | dispatched | <code>{ page: number; }</code> | Dispatched when the user clicks the previous page button. |
2771+
| click:button--next | dispatched | <code>{ page: number; }</code> | Dispatched when the user clicks the next page button. |
2772+
| update | dispatched | <code>{ pageSize: number; page: number; }</code> | Dispatched reactively whenever the page or page size changes. |
27732773

27742774
## `PaginationNav`
27752775

docs/src/COMPONENT_API.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11037,25 +11037,25 @@
1103711037
"type": "dispatched",
1103811038
"name": "change",
1103911039
"detail": "{\n page?: number;\n pageSize?: number;\n}",
11040-
"description": "Dispatched after any user interaction."
11040+
"description": "Dispatched when the user changes the page or page size through any interaction."
1104111041
},
1104211042
{
1104311043
"type": "dispatched",
1104411044
"name": "click:button--previous",
1104511045
"detail": "{ page: number }",
11046-
"description": "Dispatched after any user interaction."
11046+
"description": "Dispatched when the user clicks the previous page button."
1104711047
},
1104811048
{
1104911049
"type": "dispatched",
1105011050
"name": "click:button--next",
1105111051
"detail": "{ page: number }",
11052-
"description": "Dispatched after any user interaction."
11052+
"description": "Dispatched when the user clicks the next page button."
1105311053
},
1105411054
{
1105511055
"type": "dispatched",
1105611056
"name": "update",
1105711057
"detail": "{\n pageSize: number;\n page: number;\n}",
11058-
"description": "Dispatched after any user interaction."
11058+
"description": "Dispatched reactively whenever the page or page size changes."
1105911059
}
1106011060
],
1106111061
"typedefs": [],

src/Pagination/Pagination.svelte

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
11
<script>
22
/**
3-
* Dispatched after any user interaction.
3+
* Dispatched when the user changes the page or page size through any interaction.
44
* @event change
55
* @type {object}
66
* @property {number} [page]
77
* @property {number} [pageSize]
88
* @event click:button--previous
9+
* Dispatched when the user clicks the previous page button.
910
* @type {object}
1011
* @property {number} page
1112
* @event click:button--next
13+
* Dispatched when the user clicks the next page button.
1214
* @type {object}
1315
* @property {number} page
1416
* @event update
17+
* Dispatched reactively whenever the page or page size changes.
1518
* @type {object}
1619
* @property {number} pageSize
1720
* @property {number} page

types/Pagination/Pagination.svelte.d.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -115,13 +115,13 @@ export type PaginationProps = Omit<$RestProps, keyof $Props> & $Props;
115115
export default class Pagination extends SvelteComponentTyped<
116116
PaginationProps,
117117
{
118-
/** Dispatched after any user interaction. */
118+
/** Dispatched when the user changes the page or page size through any interaction. */
119119
change: CustomEvent<{ page?: number; pageSize?: number }>;
120-
/** Dispatched after any user interaction. */
120+
/** Dispatched when the user clicks the previous page button. */
121121
"click:button--previous": CustomEvent<{ page: number }>;
122-
/** Dispatched after any user interaction. */
122+
/** Dispatched when the user clicks the next page button. */
123123
"click:button--next": CustomEvent<{ page: number }>;
124-
/** Dispatched after any user interaction. */
124+
/** Dispatched reactively whenever the page or page size changes. */
125125
update: CustomEvent<{ pageSize: number; page: number }>;
126126
},
127127
Record<string, never>

0 commit comments

Comments
 (0)