-
Notifications
You must be signed in to change notification settings - Fork 4.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs: Add Block Patterns Paging Readme
- Loading branch information
Showing
1 changed file
with
63 additions
and
0 deletions.
There are no files selected for viewing
63 changes: 63 additions & 0 deletions
63
packages/block-editor/src/components/block-patterns-paging/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
# Block Patterns Paging | ||
|
||
A component that renders a paging control for navigating through block patterns. | ||
|
||
## Table of contents | ||
|
||
1. [Development guidelines](#development-guidelines) | ||
2. [Related components](#related-components) | ||
|
||
## Development guidelines | ||
|
||
### Usage | ||
|
||
Render a `BlockPatternsPaging` component to display a paging control for navigating through block patterns. | ||
|
||
```jsx | ||
import { BlockPatternsPaging } from '@wordpress/block-editor'; | ||
|
||
const MyBlockPatternsPaging = () => ( | ||
<BlockPatternsPaging | ||
currentPage={ 1 } | ||
totalPages={ 3 } | ||
changePage={ ( newPage ) => { | ||
// Handle the new page value | ||
} } | ||
totalItems={ 10 } | ||
/> | ||
); | ||
``` | ||
|
||
### Props | ||
|
||
### `currentPage` | ||
|
||
- **Type:** `number` | ||
- **Required:** Yes | ||
|
||
The current page number. | ||
|
||
### `totalPages` | ||
|
||
- **Type:** `number` | ||
- **Required:** Yes | ||
|
||
The total number of pages. | ||
|
||
### `changePage` | ||
|
||
- **Type:** `Function` | ||
- **Required:** Yes | ||
|
||
A function that will be called when the page is changed. It receives the new page number as an argument. | ||
|
||
### `totalItems` | ||
|
||
- **Type:** `number` | ||
- **Required:** Yes | ||
|
||
The total number of items. | ||
|
||
## Related components | ||
|
||
Block Editor components are components that can be used to compose the UI of your block editor. Thus, they can only be used under a [BlockEditorProvider](https://github.com/WordPress/gutenberg/blob/master/packages/block-editor/src/components/provider/README.md) in the components tree. |