Skip to content

Commit

Permalink
docs(PPDSC-2874): sync up pagination docs wiki <-> site (#763)
Browse files Browse the repository at this point in the history
Co-authored-by: JohnTParsons <JohnTParsons>
  • Loading branch information
JohnTParsons authored Mar 24, 2023
1 parent bcdf108 commit 18bfe19
Showing 1 changed file with 38 additions and 11 deletions.
49 changes: 38 additions & 11 deletions site/pages/components/pagination.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -380,7 +380,7 @@ const PaginationComponent = (layoutProps: LayoutProps) => (
{
name: 'onPageChange',
type: '(number) => void',
default: 'void',
default: '',
description:
'Action that occurs after a pagination item is clicked on to change page',
required: false,
Expand Down Expand Up @@ -536,6 +536,17 @@ const PaginationComponent = (layoutProps: LayoutProps) => (
description:
'If provided, this overrides the min width of the pagination item',
},
{
attribute: 'iconSize',
type: 'MQ<string>',
default: [
'small - iconSize10',
'medium - iconSize20',
'large - iconSize20',
],
description:
'If provided, this overrides the size of the truncation icon',
},
{
attribute: 'icon',
type: 'Override <NewskitIconProps>',
Expand Down Expand Up @@ -645,6 +656,17 @@ const PaginationComponent = (layoutProps: LayoutProps) => (
description:
'If provided, this overrides the width of the pagination item',
},
{
attribute: 'iconSize',
type: 'MQ<string>',
default: [
'small - iconSize10',
'medium - iconSize20',
'large - iconSize20',
],
description:
'If provided, this overrides the size of the respective navigation icon',
},
{
attribute: 'icon',
type: 'Override <NewskitIconProps>',
Expand Down Expand Up @@ -685,7 +707,7 @@ const PaginationComponent = (layoutProps: LayoutProps) => (
{
title: 'Pagination button',
summary:
'The PaginationButton is default item button implememtation. It is based on the Button component, as that supports a lot of styling options. These props do not need to be supplied manually, they will be provided in the props of the itemButton function. Overrides passed into PaginationItems get turned into standard Button props before being passed into this component.',
'The PaginationButton is default item button implementation. It is based on the Button component, as that supports a lot of styling options. These props do not need to be supplied manually, they will be provided in the props of the itemButton function. Overrides passed into PaginationItems get turned into standard Button props before being passed into this component.',
propsRows: [
{
name: 'children',
Expand Down Expand Up @@ -720,7 +742,8 @@ const PaginationComponent = (layoutProps: LayoutProps) => (
name: 'lastPage',
type: 'number',
default: '',
description: 'The page number of the button to be rendered.',
description:
'The last page (calculated from totalPages and pageSize).',
required: true,
},
{
Expand Down Expand Up @@ -813,26 +836,26 @@ const PaginationComponent = (layoutProps: LayoutProps) => (
true,
) as OverridesRowsProps[]),
{
attribute: 'iconSize',
attribute: 'width',
type: 'MQ<string>',
default: [
'small - sizing050',
'medium - sizing060',
'large - sizing070',
],
description:
'If provided, this overrides the icon size of the truncation item',
'If provided, this overrides the width of the truncation item',
},
{
attribute: 'width',
attribute: 'iconSize',
type: 'MQ<string>',
default: [
'small - sizing050',
'medium - sizing060',
'large - sizing070',
'small - iconSize10',
'medium - iconSize20',
'large - iconSize20',
],
description:
'If provided, this overrides the width of the truncation item',
'If provided, this overrides the icon size of the truncation item',
},
],
},
Expand Down Expand Up @@ -872,7 +895,11 @@ const PaginationComponent = (layoutProps: LayoutProps) => (
{
attribute: 'iconSize',
type: 'MQ<string>',
default: 'iconSize010',
default: [
'small - iconSize10',
'medium - iconSize20',
'large - iconSize20',
],
description:
'If provided, this overrides the icon size of the pagination item display component',
},
Expand Down

0 comments on commit 18bfe19

Please sign in to comment.