mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-06 03:57:59 +08:00
33 lines
8.6 KiB
JavaScript
33 lines
8.6 KiB
JavaScript
import{o as s,a,y as n}from"./vue-libs.b44bc779.js";const e={class:"van-doc-markdown-body"},d=n(`<h1>Pagination</h1><div class="van-doc-card"><h3 id="intro" tabindex="-1">Intro</h3><p>When the amount of data is too much, use pagination to separate the data, and load only one page at a time.</p></div><div class="van-doc-card"><h3 id="install" tabindex="-1">Install</h3><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><pre><code class="language-js"><span class="hljs-keyword">import</span> { createApp } <span class="hljs-keyword">from</span> <span class="hljs-string">'vue'</span>;
|
|
<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>;
|
|
|
|
<span class="hljs-keyword">const</span> app = <span class="hljs-title function_">createApp</span>();
|
|
app.<span class="hljs-title function_">use</span>(<span class="hljs-title class_">Pagination</span>);
|
|
</code></pre></div><h2 id="usage" tabindex="-1">Usage</h2><div class="van-doc-card"><h3 id="basic-usage" tabindex="-1">Basic Usage</h3><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>
|
|
</code></pre><pre><code class="language-js"><span class="hljs-keyword">import</span> { ref } <span class="hljs-keyword">from</span> <span class="hljs-string">'vue'</span>;
|
|
|
|
<span class="hljs-keyword">export</span> <span class="hljs-keyword">default</span> {
|
|
<span class="hljs-title function_">setup</span>(<span class="hljs-params"></span>) {
|
|
<span class="hljs-keyword">const</span> currentPage = <span class="hljs-title function_">ref</span>(<span class="hljs-number">1</span>);
|
|
<span class="hljs-keyword">return</span> { currentPage };
|
|
},
|
|
};
|
|
</code></pre></div><div class="van-doc-card"><h3 id="simple-mode" tabindex="-1">Simple mode</h3><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>
|
|
</code></pre></div><div class="van-doc-card"><h3 id="show-ellipses" tabindex="-1">Show ellipses</h3><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">"125"</span>
|
|
<span class="hljs-attr">:show-page-size</span>=<span class="hljs-string">"3"</span>
|
|
<span class="hljs-attr">force-ellipses</span>
|
|
/></span>
|
|
</code></pre></div><div class="van-doc-card"><h3 id="custom-button" tabindex="-1">Custom Button</h3><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>
|
|
<span class="hljs-tag"><<span class="hljs-name">template</span> #<span class="hljs-attr">prev-text</span>></span>
|
|
<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>
|
|
<span class="hljs-tag"></<span class="hljs-name">template</span>></span>
|
|
<span class="hljs-tag"><<span class="hljs-name">template</span> #<span class="hljs-attr">next-text</span>></span>
|
|
<span class="hljs-tag"><<span class="hljs-name">van-icon</span> <span class="hljs-attr">name</span>=<span class="hljs-string">"arrow"</span> /></span>
|
|
<span class="hljs-tag"></<span class="hljs-name">template</span>></span>
|
|
<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>
|
|
<span class="hljs-tag"></<span class="hljs-name">van-pagination</span>></span>
|
|
</code></pre></div><h2 id="api" tabindex="-1">API</h2><div class="van-doc-card"><h3 id="props" tabindex="-1">Props</h3><table><thead><tr><th>Attribute</th><th>Description</th><th>Type</th><th>Default</th></tr></thead><tbody><tr><td>v-model</td><td>Current page number</td><td><em>number</em></td><td>-</td></tr><tr><td>mode</td><td>Mode, can be set to <code>simple</code> <code>multi</code></td><td><em>string</em></td><td><code>multi</code></td></tr><tr><td>prev-text</td><td>Previous text</td><td><em>string</em></td><td><code>Previous</code></td></tr><tr><td>next-text</td><td>Next text</td><td><em>string</em></td><td><code>Next</code></td></tr><tr><td>total-items</td><td>Total items</td><td><em>number | string</em></td><td><code>0</code></td></tr><tr><td>items-per-page</td><td>Item number per page</td><td><em>number | string</em></td><td><code>10</code></td></tr><tr><td>page-count</td><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><td><em>number | string</em></td><td><code>-</code></td></tr><tr><td>show-page-size</td><td>Count of page size to show</td><td><em>number | string</em></td><td><code>5</code></td></tr><tr><td>force-ellipses</td><td>Whether to show ellipses</td><td><em>boolean</em></td><td><code>false</code></td></tr></tbody></table></div><div class="van-doc-card"><h3 id="events" tabindex="-1">Events</h3><table><thead><tr><th>Event</th><th>Description</th><th>Arguments</th></tr></thead><tbody><tr><td>change</td><td>Emitted when current page changed</td><td>-</td></tr></tbody></table></div><div class="van-doc-card"><h3 id="slots" tabindex="-1">Slots</h3><table><thead><tr><th>Name</th><th>Description</th><th>SlotProps</th></tr></thead><tbody><tr><td>page</td><td>Custom pagination item</td><td><em>{ number: number, text: string, active: boolean }</em></td></tr><tr><td>prev-text</td><td>Custom prev text</td><td>-</td></tr><tr><td>next-text</td><td>Custom next text</td><td>-</td></tr></tbody></table></div><div class="van-doc-card"><h3 id="types" tabindex="-1">Types</h3><p>The component exports the following type definitions:</p><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>;
|
|
</code></pre></div><h2 id="theming" tabindex="-1">Theming</h2><div class="van-doc-card"><h3 id="css-variables" tabindex="-1">CSS Variables</h3><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><table><thead><tr><th>Name</th><th>Default Value</th><th>Description</th></tr></thead><tbody><tr><td>--van-pagination-height</td><td><em>40px</em></td><td>-</td></tr><tr><td>--van-pagination-font-size</td><td><em>var(--van-font-size-md)</em></td><td>-</td></tr><tr><td>--van-pagination-item-width</td><td><em>36px</em></td><td>-</td></tr><tr><td>--van-pagination-item-default-color</td><td><em>var(--van-primary-color)</em></td><td>-</td></tr><tr><td>--van-pagination-item-disabled-color</td><td><em>var(--van-gray-7)</em></td><td>-</td></tr><tr><td>--van-pagination-item-disabled-background-color</td><td><em>var(--van-background-color)</em></td><td>-</td></tr><tr><td>--van-pagination-background-color</td><td><em>var(--van-background-color-light)</em></td><td>-</td></tr><tr><td>--van-pagination-desc-color</td><td><em>var(--van-gray-7)</em></td><td>-</td></tr><tr><td>--van-pagination-disabled-opacity</td><td><em>var(--van-disabled-opacity)</em></td><td>-</td></tr></tbody></table></div>`,15),l=[d],h={__name:"README",setup(p,{expose:t}){return t({frontmatter:{}}),(r,c)=>(s(),a("div",e,l))}};export{h as default};
|