package.json 9.81 KB
{
  "name": "@bootstrap-vue/pagination",
  "version": "1.0.0",
  "meta": {
    "title": "Pagination",
    "description": "Quick first, previous, next, last, and page buttons for pagination control of another component (such as <b-table> or lists).",
    "components": [
      {
        "component": "BPagination",
        "props": [
          {
            "prop": "align",
            "description": "Alignment of the page buttons: 'start' (or 'left'), 'center', 'end' (or 'right'), or 'fill'"
          },
          {
            "prop": "ariaLabel",
            "description": "Value to place in the 'aria-label' attribute of the pagination control"
          },
          {
            "prop": "ellipsisClass",
            "version": "2.3.0",
            "description": "Class(es) to apply to the 'ellipsis' placeholders"
          },
          {
            "prop": "ellipsisText",
            "description": "Content to place in the ellipsis placeholder"
          },
          {
            "prop": "firstClass",
            "version": "2.3.0",
            "description": "Class(es) to apply to the 'Go to first page' button"
          },
          {
            "prop": "firstNumber",
            "version": "2.3.0",
            "description": "Display first page number instead of Goto First button"
          },
          {
            "prop": "firstText",
            "description": "Content to place in the goto first page button"
          },
          {
            "prop": "hideEllipsis",
            "description": "Do not show ellipsis buttons"
          },
          {
            "prop": "hideGotoEndButtons",
            "description": "Hides the goto first and goto last page buttons"
          },
          {
            "prop": "labelFirstPage",
            "description": "Value to place in the 'aria-label' attribute of the goto first page button"
          },
          {
            "prop": "labelLastPage",
            "description": "Value to place in the 'aria-label' attribute of the goto last page button"
          },
          {
            "prop": "labelNextPage",
            "description": "Value to place in the 'aria-label' attribute of the goto next page button"
          },
          {
            "prop": "labelPage",
            "description": "Value to place in the 'aria-label' attribute of the goto page button. Page number will be prepended automatically"
          },
          {
            "prop": "labelPrevPage",
            "description": "Value to place in the 'aria-label' attribute of the goto previous page button"
          },
          {
            "prop": "lastClass",
            "version": "2.3.0",
            "description": "Class(es) to apply to the 'Go to last page' button"
          },
          {
            "prop": "lastNumber",
            "version": "2.3.0",
            "description": "Display last page number instead of Goto Last button"
          },
          {
            "prop": "lastText",
            "description": "Content to place in the goto last page button"
          },
          {
            "prop": "limit",
            "description": "Maximum number of buttons to show (including ellipsis if shown, but excluding the bookend buttons)"
          },
          {
            "prop": "nextClass",
            "version": "2.3.0",
            "description": "Class(es) to apply to the 'Go to next page' button"
          },
          {
            "prop": "nextText",
            "description": "Content to place in the goto next page button"
          },
          {
            "prop": "pageClass",
            "version": "2.3.0",
            "description": "Class(es) to apply to the 'Go to page #' buttons"
          },
          {
            "prop": "perPage",
            "description": "Number of rows per page"
          },
          {
            "prop": "pills",
            "version": "2.1.0",
            "description": "Applies pill styling to the pagination buttons"
          },
          {
            "prop": "prevClass",
            "version": "2.3.0",
            "description": "Class(es) to apply to the 'Go to previous page' button"
          },
          {
            "prop": "prevText",
            "description": "Content to place in the goto previous page button"
          },
          {
            "prop": "size",
            "description": "Size of the rendered buttons: 'sm', 'md' (default), or 'lg'"
          },
          {
            "prop": "totalRows",
            "description": "Total number of rows in the dataset"
          },
          {
            "prop": "value",
            "description": "Current page number, starting from 1"
          }
        ],
        "events": [
          {
            "event": "change",
            "description": "Emitted when page changes via user interaction",
            "args": [
              {
                "arg": "page",
                "description": "Selected page number (starting with `1`)"
              }
            ]
          },
          {
            "event": "input",
            "description": "Emitted when page changes via user interaction or programmatically",
            "args": [
              {
                "arg": "page",
                "description": "Selected page number (starting with `1`), or `null` if no page found"
              }
            ]
          },
          {
            "event": "page-click",
            "description": "Emitted when a page button was clicked. Cancelable",
            "version": "2.17.0",
            "args": [
              {
                "arg": "bvEvent",
                "type": "BvEvent",
                "description": "The `BvEvent` object. Call `bvEvent.preventDefault()` to cancel page selection"
              },
              {
                "arg": "page",
                "description": "Page number to select (starting with `1`)"
              }
            ]
          }
        ],
        "slots": [
          {
            "name": "ellipsis-text",
            "description": "The '...' indicator content. Overrides the `ellipsis-text` prop"
          },
          {
            "name": "first-text",
            "description": "The 'Go to first page' button content",
            "scope": [
              {
                "prop": "disabled",
                "type": "Boolean",
                "description": "Will be `true` if this button is disabled (non-clickable)"
              },
              {
                "prop": "index",
                "type": "Number",
                "description": "Page number (indexed from `0` to `numberOfPages - 1`)"
              },
              {
                "prop": "page",
                "type": "Number",
                "description": "Page number (from `1` to `numberOfPages`)"
              }
            ]
          },
          {
            "name": "last-text",
            "description": "The 'Go to last page' button content",
            "scope": [
              {
                "prop": "disabled",
                "type": "Boolean",
                "description": "Will be `true` if this button is disabled (non-clickable)"
              },
              {
                "prop": "index",
                "type": "Number",
                "description": "Page number (indexed from `0` to `numberOfPages - 1`)"
              },
              {
                "prop": "page",
                "type": "Number",
                "description": "Page number (from `1` to `numberOfPages`)"
              }
            ]
          },
          {
            "name": "next-text",
            "description": "The 'Go to next page' button content",
            "scope": [
              {
                "prop": "disabled",
                "type": "Boolean",
                "description": "Will be `true` if this button is disabled (non-clickable)"
              },
              {
                "prop": "index",
                "type": "Number",
                "description": "Page number (indexed from `0` to `numberOfPages - 1`)"
              },
              {
                "prop": "page",
                "type": "Number",
                "description": "Page number (from `1` to `numberOfPages`)"
              }
            ]
          },
          {
            "name": "page",
            "description": "Page number button content",
            "scope": [
              {
                "prop": "active",
                "type": "Boolean",
                "description": "If the page is the active page"
              },
              {
                "prop": "content",
                "type": "String",
                "description": "Default button content"
              },
              {
                "prop": "disabled",
                "type": "Boolean",
                "description": "Will be `true` if this button is disabled (non-clickable)"
              },
              {
                "prop": "index",
                "type": "Number",
                "description": "Page number (indexed from `0` to `numberOfPages - 1`)"
              },
              {
                "prop": "page",
                "type": "Number",
                "description": "Page number (from `1` to `numberOfPages`)"
              }
            ]
          },
          {
            "name": "prev-text",
            "description": "The 'Go to previous page' button content",
            "scope": [
              {
                "prop": "disabled",
                "type": "Boolean",
                "description": "Will be `true` if this button is disabled (non-clickable)"
              },
              {
                "prop": "index",
                "type": "Number",
                "description": "Page number (indexed from `0` to `numberOfPages - 1`)"
              },
              {
                "prop": "page",
                "type": "Number",
                "description": "Page number (from `1` to `numberOfPages`)"
              }
            ]
          }
        ]
      }
    ]
  }
}