common-intellisense/scripts/nextui/Pagination.json

%description%

{
  "props": [
    {
      "Attribute": "variant",
      "Type": "`flat` | `bordered` | `light` | `faded`",
      "Description": "The pagination variant.",
      "Default": "`flat`"
    },
    {
      "Attribute": "color",
      "Type": "`default` | `primary` | `secondary` | `success` | `warning` | `danger`",
      "Description": "The pagination color theme.",
      "Default": "`default`"
    },
    {
      "Attribute": "size",
      "Type": "`sm` | `md` | `lg`",
      "Description": "The pagination size.",
      "Default": "`md`"
    },
    {
      "Attribute": "radius",
      "Type": "`none` | `sm` | `md` | `lg` | `full`",
      "Description": "The pagination border radius.",
      "Default": "`xl`"
    },
    {
      "Attribute": "total",
      "Type": "`number`",
      "Description": "The total number of pages.",
      "Default": "`1`"
    },
    {
      "Attribute": "dotsJump",
      "Type": "`boolean`",
      "Description": "The number of pages that are added or subtracted on the '...' button.",
      "Default": "`5`"
    },
    {
      "Attribute": "initialPage",
      "Type": "`number`",
      "Description": "The initial page. (uncontrolled)",
      "Default": "`1`"
    },
    {
      "Attribute": "page",
      "Type": "`number`",
      "Description": "The current page. (controlled)",
      "Default": "-"
    },
    {
      "Attribute": "siblings",
      "Type": "`number`",
      "Description": "The number of pages to show before and after the current page.",
      "Default": "`1`"
    },
    {
      "Attribute": "boundaries",
      "Type": "`number`",
      "Description": "The number of pages to show at the beginning and end of the pagination.",
      "Default": "`1`"
    },
    {
      "Attribute": "loop",
      "Type": "`boolean`",
      "Description": "Whether the pagination should be looped.",
      "Default": "`false`"
    },
    {
      "Attribute": "isCompact",
      "Type": "`boolean`",
      "Description": "Whether the pagination should have a compact style.",
      "Default": "`false`"
    },
    {
      "Attribute": "isDisabled",
      "Type": "`boolean`",
      "Description": "Whether the pagination is disabled.",
      "Default": "`false`"
    },
    {
      "Attribute": "showShadow",
      "Type": "`boolean`",
      "Description": "Whether the pagination cursor should have a shadow.",
      "Default": "`false`"
    },
    {
      "Attribute": "showControls",
      "Type": "`boolean`",
      "Description": "Whether the pagination should have controls.",
      "Default": "`false`"
    },
    {
      "Attribute": "disableCursorAnimation",
      "Type": "`boolean`",
      "Description": "Whether the pagination cursor should be hidden.",
      "Default": "`false`"
    },
    {
      "Attribute": "renderItem",
      "Type": "[PaginationItemProps](#pagination-item-props)",
      "Description": "The pagination item render function.",
      "Default": "-"
    },
    {
      "Attribute": "getItemAriaLabel",
      "Type": "`(page: string) => string`",
      "Description": "A function that allows you to customize the pagination items aria-label.",
      "Default": "-"
    },
    {
      "Attribute": "disableAnimation",
      "Type": "`boolean`",
      "Description": "Whether the pagination cursor should be animated.",
      "Default": "`false`"
    },
    {
      "Attribute": "classNames",
      "Type": "`Record<\"base\"｜ \"wrapper\" ｜ \"prev\"｜ \"next\" ｜ \"item\" ｜ \"cursor\" ｜ \"forwardIcon\" ｜ \"ellipsis\" ｜ \"chevronNext\", string>`",
      "Description": "Allows to set custom class names for the pagination slots.",
      "Default": "-"
    }
  ],
  "link": "https://nextui.org/docs/components/pagination",
  "events": [
    {
      "Attribute": "onChange",
      "Type": "`(page: number) => void`",
      "Description": "Handler that is called when the pagination acitve page changes."
    }
  ]
}