From 639626c1b3ec6a8a68d18b7f31d1d06c8c18e70f Mon Sep 17 00:00:00 2001 From: Eric Liu Date: Sat, 3 May 2025 10:28:46 -0700 Subject: [PATCH] docs(pagination): improve docs --- docs/src/pages/components/Pagination.svx | 31 ++++++++++++++---------- 1 file changed, 18 insertions(+), 13 deletions(-) diff --git a/docs/src/pages/components/Pagination.svx b/docs/src/pages/components/Pagination.svx index 3aeb1f36..e7812593 100644 --- a/docs/src/pages/components/Pagination.svx +++ b/docs/src/pages/components/Pagination.svx @@ -7,47 +7,52 @@ components: ["Pagination", "PaginationSkeleton"] import Preview from "../../components/Preview.svelte"; +`Pagination` provides navigation controls for large data sets. It displays the current page, total items, and allows users to change page size and navigate between pages. + ## Default - +Create a basic pagination component with default page size options. + + ## Current page +Set the current page using the `page` prop. + ## Custom page sizes - +Specify custom page sizes and set a default page size. + + ## Unknown pages -If the total number of pages is unknown, set `pagesUnknown` to `true`. - -This will render the item range text without factoring in the total number of pages. +Set `pagesUnknown` to `true` when the total number of pages is unknown. This renders the item range text without factoring in the total number of pages. ## Page window -The number of native select items rendered is derived from the value of `totalItems`. - -If `totalItems` is a very large number, this can impact rendering performance since -thousands of elements may be rendered. By default, the window of rendered items is -capped at 1,000. For example, if `totalItems=100_000` and the `pageSize=10`, -1,000 select options are rendered. - -Use the `pageWindow` prop to increase this value. +The number of native select items rendered is derived from `totalItems`. For large datasets, this can impact performance. Use `pageWindow` to control the number of rendered items. ## Hidden page input +Disable the page input by setting `pageInputDisabled` to `true`. + ## Hidden page size +Disable the page size selector by setting `pageSizeInputDisabled` to `true`. + ## Skeleton +Use `PaginationSkeleton` to show a loading state. +