bootstrap-vue
Version:
With more than 85 components, over 45 available plugins, several directives, and 1000+ icons, BootstrapVue provides one of the most comprehensive implementations of the Bootstrap v4 component and grid system available for Vue.js v2.6, complete with extens
316 lines (315 loc) • 10.8 kB
JSON
{
"name": "@bootstrap-vue/pagination-nav",
"version": "1.0.0",
"meta": {
"title": "Pagination Nav",
"description": "Quick first, previous, next, last, and page buttons for navigation based pagination, supporting regular links or router links.",
"components": [
{
"component": "BPaginationNav",
"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": "baseUrl",
"description": "Base URL to use when auto generating page links"
},
{
"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": "linkGen",
"description": "Link generator function. See docs for details"
},
{
"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": "noPageDetect",
"description": "Disable of auto detection of current page"
},
{
"prop": "numberOfPages",
"description": "Total number of pages"
},
{
"prop": "pageClass",
"version": "2.3.0",
"description": "Class(es) to apply to the 'Go to page #' buttons"
},
{
"prop": "pageGen",
"description": "Page number generator function. See docs for details"
},
{
"prop": "pages",
"description": "Array of page numbers and links"
},
{
"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": "useRouter",
"description": "Render router-links instead of links when auto generating the page links"
},
{
"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. Not scoped"
},
{
"name": "first-text",
"description": "The \"go to first page\" button content. Optionally scoped",
"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. Optionally scoped",
"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. Optionally scoped",
"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. Always scoped",
"scope": [
{
"prop": "active",
"type": "Boolean",
"description": "If the page is the active page"
},
{
"prop": "content",
"type": "String",
"description": "Default button content, or the result of the page-gen function"
},
{
"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. Optionally scoped",
"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)"
}
]
}
]
}
]
}
}