mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-06 03:57:59 +08:00
2 lines
9.4 KiB
JavaScript
2 lines
9.4 KiB
JavaScript
/*! For license information please see 902.61d9d82d.js.LICENSE.txt */
|
|
(self.webpackChunk=self.webpackChunk||[]).push([["902"],{67206:function(t,n,s){"use strict";s.r(n);var a=s("80681");let e=["innerHTML"];n.default={setup:()=>({html:""}),render:()=>((0,a.wg)(),(0,a.iD)("div",{class:"van-doc-markdown-body",innerHTML:'<h1>Pagination</h1>\n<div class="van-doc-card"><h3 id="intro" tabindex="-1">Intro</h3>\n<p>When the amount of data is too much, use pagination to separate the data, and load only one page at a time.</p>\n</div><div class="van-doc-card"><h3 id="install" tabindex="-1">Install</h3>\n<p>Register component globally via <code>app.use</code>, refer to <a href="#/en-US/advanced-usage#zu-jian-zhu-ce" target="_blank">Component Registration</a> for more registration ways.</p>\n<pre><code class="language-js"><span class="hljs-keyword">import</span> { createApp } <span class="hljs-keyword">from</span> <span class="hljs-string">'vue'</span>;\n<span class="hljs-keyword">import</span> { <span class="hljs-title class_">Pagination</span> } <span class="hljs-keyword">from</span> <span class="hljs-string">'vant'</span>;\n\n<span class="hljs-keyword">const</span> app = <span class="hljs-title function_">createApp</span>();\napp.<span class="hljs-title function_">use</span>(<span class="hljs-title class_">Pagination</span>);\n</code></pre>\n</div><h2 id="usage" tabindex="-1">Usage</h2>\n<div class="van-doc-card"><h3 id="basic-usage" tabindex="-1">Basic Usage</h3>\n<pre><code class="language-html"><span class="hljs-tag"><<span class="hljs-name">van-pagination</span> <span class="hljs-attr">v-model</span>=<span class="hljs-string">"currentPage"</span> <span class="hljs-attr">:total-items</span>=<span class="hljs-string">"24"</span> <span class="hljs-attr">:items-per-page</span>=<span class="hljs-string">"5"</span> /></span>\n</code></pre>\n<pre><code class="language-js"><span class="hljs-keyword">import</span> { ref } <span class="hljs-keyword">from</span> <span class="hljs-string">'vue'</span>;\n\n<span class="hljs-keyword">export</span> <span class="hljs-keyword">default</span> {\n <span class="hljs-title function_">setup</span>(<span class="hljs-params"></span>) {\n <span class="hljs-keyword">const</span> currentPage = <span class="hljs-title function_">ref</span>(<span class="hljs-number">1</span>);\n <span class="hljs-keyword">return</span> { currentPage };\n },\n};\n</code></pre>\n</div><div class="van-doc-card"><h3 id="simple-mode" tabindex="-1">Simple mode</h3>\n<pre><code class="language-html"><span class="hljs-tag"><<span class="hljs-name">van-pagination</span> <span class="hljs-attr">v-model</span>=<span class="hljs-string">"currentPage"</span> <span class="hljs-attr">:page-count</span>=<span class="hljs-string">"12"</span> <span class="hljs-attr">mode</span>=<span class="hljs-string">"simple"</span> /></span>\n</code></pre>\n</div><div class="van-doc-card"><h3 id="show-ellipses" tabindex="-1">Show ellipses</h3>\n<pre><code class="language-html"><span class="hljs-tag"><<span class="hljs-name">van-pagination</span>\n <span class="hljs-attr">v-model</span>=<span class="hljs-string">"currentPage"</span>\n <span class="hljs-attr">:total-items</span>=<span class="hljs-string">"125"</span>\n <span class="hljs-attr">:show-page-size</span>=<span class="hljs-string">"3"</span>\n <span class="hljs-attr">force-ellipses</span>\n/></span>\n</code></pre>\n</div><div class="van-doc-card"><h3 id="custom-button" tabindex="-1">Custom Button</h3>\n<pre><code class="language-html"><span class="hljs-tag"><<span class="hljs-name">van-pagination</span> <span class="hljs-attr">v-model</span>=<span class="hljs-string">"currentPage"</span> <span class="hljs-attr">:total-items</span>=<span class="hljs-string">"50"</span> <span class="hljs-attr">:show-page-size</span>=<span class="hljs-string">"5"</span>></span>\n <span class="hljs-tag"><<span class="hljs-name">template</span> #<span class="hljs-attr">prev-text</span>></span>\n <span class="hljs-tag"><<span class="hljs-name">van-icon</span> <span class="hljs-attr">name</span>=<span class="hljs-string">"arrow-left"</span> /></span>\n <span class="hljs-tag"></<span class="hljs-name">template</span>></span>\n <span class="hljs-tag"><<span class="hljs-name">template</span> #<span class="hljs-attr">next-text</span>></span>\n <span class="hljs-tag"><<span class="hljs-name">van-icon</span> <span class="hljs-attr">name</span>=<span class="hljs-string">"arrow"</span> /></span>\n <span class="hljs-tag"></<span class="hljs-name">template</span>></span>\n <span class="hljs-tag"><<span class="hljs-name">template</span> #<span class="hljs-attr">page</span>=<span class="hljs-string">"{ text }"</span>></span>{{ text }}<span class="hljs-tag"></<span class="hljs-name">template</span>></span>\n<span class="hljs-tag"></<span class="hljs-name">van-pagination</span>></span>\n</code></pre>\n</div><h2 id="api" tabindex="-1">API</h2>\n<div class="van-doc-card"><h3 id="props" tabindex="-1">Props</h3>\n<table>\n<thead>\n<tr>\n<th>Attribute</th>\n<th>Description</th>\n<th>Type</th>\n<th>Default</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>v-model</td>\n<td>Current page number</td>\n<td><em>number</em></td>\n<td>-</td>\n</tr>\n<tr>\n<td>mode</td>\n<td>Mode, can be set to <code>simple</code> <code>multi</code></td>\n<td><em>string</em></td>\n<td><code>multi</code></td>\n</tr>\n<tr>\n<td>prev-text</td>\n<td>Previous text</td>\n<td><em>string</em></td>\n<td><code>Previous</code></td>\n</tr>\n<tr>\n<td>next-text</td>\n<td>Next text</td>\n<td><em>string</em></td>\n<td><code>Next</code></td>\n</tr>\n<tr>\n<td>total-items</td>\n<td>Total items</td>\n<td><em>number | string</em></td>\n<td><code>0</code></td>\n</tr>\n<tr>\n<td>items-per-page</td>\n<td>Item number per page</td>\n<td><em>number | string</em></td>\n<td><code>10</code></td>\n</tr>\n<tr>\n<td>page-count</td>\n<td>The total number of pages, if not set, will be calculated based on <code>total-items</code> and <code>items-per-page</code></td>\n<td><em>number | string</em></td>\n<td><code>-</code></td>\n</tr>\n<tr>\n<td>show-page-size</td>\n<td>Count of page size to show</td>\n<td><em>number | string</em></td>\n<td><code>5</code></td>\n</tr>\n<tr>\n<td>force-ellipses</td>\n<td>Whether to show ellipses</td>\n<td><em>boolean</em></td>\n<td><code>false</code></td>\n</tr>\n<tr>\n<td>show-prev-button <code>v4.2.1</code></td>\n<td>Whether to show prev button</td>\n<td><em>boolean</em></td>\n<td><code>true</code></td>\n</tr>\n<tr>\n<td>show-next-button <code>v4.2.1</code></td>\n<td>Whether to show next button</td>\n<td><em>boolean</em></td>\n<td><code>true</code></td>\n</tr>\n</tbody>\n</table>\n</div><div class="van-doc-card"><h3 id="events" tabindex="-1">Events</h3>\n<table>\n<thead>\n<tr>\n<th>Event</th>\n<th>Description</th>\n<th>Arguments</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>change</td>\n<td>Emitted when current page changed</td>\n<td>-</td>\n</tr>\n</tbody>\n</table>\n</div><div class="van-doc-card"><h3 id="slots" tabindex="-1">Slots</h3>\n<table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Description</th>\n<th>SlotProps</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>page</td>\n<td>Custom pagination item</td>\n<td><em>{ number: number, text: string, active: boolean }</em></td>\n</tr>\n<tr>\n<td>prev-text</td>\n<td>Custom prev text</td>\n<td>-</td>\n</tr>\n<tr>\n<td>next-text</td>\n<td>Custom next text</td>\n<td>-</td>\n</tr>\n</tbody>\n</table>\n</div><div class="van-doc-card"><h3 id="types" tabindex="-1">Types</h3>\n<p>The component exports the following type definitions:</p>\n<pre><code class="language-ts"><span class="hljs-keyword">import</span> <span class="hljs-keyword">type</span> { <span class="hljs-title class_">PaginationMode</span>, <span class="hljs-title class_">PaginationProps</span> } <span class="hljs-keyword">from</span> <span class="hljs-string">'vant'</span>;\n</code></pre>\n</div><h2 id="theming" tabindex="-1">Theming</h2>\n<div class="van-doc-card"><h3 id="css-variables" tabindex="-1">CSS Variables</h3>\n<p>The component provides the following CSS variables, which can be used to customize styles. Please refer to <a href="#/en-US/config-provider" target="_blank">ConfigProvider component</a>.</p>\n<table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Default Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>--van-pagination-height</td>\n<td><em>40px</em></td>\n<td>-</td>\n</tr>\n<tr>\n<td>--van-pagination-font-size</td>\n<td><em>var(--van-font-size-md)</em></td>\n<td>-</td>\n</tr>\n<tr>\n<td>--van-pagination-item-width</td>\n<td><em>36px</em></td>\n<td>-</td>\n</tr>\n<tr>\n<td>--van-pagination-item-default-color</td>\n<td><em>var(--van-primary-color)</em></td>\n<td>-</td>\n</tr>\n<tr>\n<td>--van-pagination-item-disabled-color</td>\n<td><em>var(--van-gray-7)</em></td>\n<td>-</td>\n</tr>\n<tr>\n<td>--van-pagination-item-disabled-background</td>\n<td><em>var(--van-background)</em></td>\n<td>-</td>\n</tr>\n<tr>\n<td>--van-pagination-background</td>\n<td><em>var(--van-background-2)</em></td>\n<td>-</td>\n</tr>\n<tr>\n<td>--van-pagination-desc-color</td>\n<td><em>var(--van-gray-7)</em></td>\n<td>-</td>\n</tr>\n<tr>\n<td>--van-pagination-disabled-opacity</td>\n<td><em>var(--van-disabled-opacity)</em></td>\n<td>-</td>\n</tr>\n</tbody>\n</table>\n</div>'},null,8,e))}}}]); |