Commit 873c32bc by Peter Holmberg Committed by GitHub

Docs: Pagination component (#28143)

* Add basic docs for pagination component

* Update packages/grafana-ui/src/components/Pagination/Pagination.tsx

Co-authored-by: Alex Khomenko <Clarity-89@users.noreply.github.com>

* Update packages/grafana-ui/src/components/Pagination/Pagination.mdx

Co-authored-by: Alex Khomenko <Clarity-89@users.noreply.github.com>

Co-authored-by: Alex Khomenko <Clarity-89@users.noreply.github.com>
parent 670b8512
import { Meta, Story, Preview, Props } from '@storybook/addon-docs/blocks'; import { Meta, Story, Preview, Props } from '@storybook/addon-docs/blocks';
import { Pagination } from './Pagination'; import { Pagination } from './Pagination';
<Meta title="MDX|Pagination" component={Pagination} />
# Pagination # Pagination
Component used for rendering a page selector below paginated content.
### Usage
```tsx
<div>
<div>
Page 1 content
</div>
<Pagination currentPage={1} numberOfPages={5} onNavigate={() => fetchPage(2)} />
</div>
```
<Meta title="MDX|Pagination" component={Pagination} />
<Props of={Pagination}/> <Props of={Pagination} />
\ No newline at end of file
...@@ -4,8 +4,11 @@ import { stylesFactory } from '../../themes'; ...@@ -4,8 +4,11 @@ import { stylesFactory } from '../../themes';
import { Button, ButtonVariant } from '../Button'; import { Button, ButtonVariant } from '../Button';
interface Props { interface Props {
/** The current page index being shown. */
currentPage: number; currentPage: number;
/** Number of total pages. */
numberOfPages: number; numberOfPages: number;
/** Callback function for fetching the selected page */
onNavigate: (toPage: number) => void; onNavigate: (toPage: number) => void;
} }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment