mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-06 03:57:59 +08:00
2 lines
15 KiB
JavaScript
2 lines
15 KiB
JavaScript
/*! For license information please see 3624.20d235bc.js.LICENSE.txt */
|
|
(self.webpackChunk=self.webpackChunk||[]).push([["3624"],{20874:function(s,a,n){"use strict";n.r(a);var t=n("80681");let l=["innerHTML"];a.default={setup:()=>({html:""}),render:()=>((0,t.wg)(),(0,t.iD)("div",{class:"van-doc-markdown-body",innerHTML:'<h1>Badge</h1>\n<div class="van-doc-card"><h3 id="intro" tabindex="-1">Intro</h3>\n<p>Display a small badge or a red dot to the top-right of its child.</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_">Badge</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_">Badge</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-badge</span> <span class="hljs-attr">:content</span>=<span class="hljs-string">"5"</span>></span>\n <span class="hljs-tag"><<span class="hljs-name">div</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"child"</span> /></span>\n<span class="hljs-tag"></<span class="hljs-name">van-badge</span>></span>\n<span class="hljs-tag"><<span class="hljs-name">van-badge</span> <span class="hljs-attr">:content</span>=<span class="hljs-string">"10"</span>></span>\n <span class="hljs-tag"><<span class="hljs-name">div</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"child"</span> /></span>\n<span class="hljs-tag"></<span class="hljs-name">van-badge</span>></span>\n<span class="hljs-tag"><<span class="hljs-name">van-badge</span> <span class="hljs-attr">content</span>=<span class="hljs-string">"Hot"</span>></span>\n <span class="hljs-tag"><<span class="hljs-name">div</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"child"</span> /></span>\n<span class="hljs-tag"></<span class="hljs-name">van-badge</span>></span>\n<span class="hljs-tag"><<span class="hljs-name">van-badge</span> <span class="hljs-attr">dot</span>></span>\n <span class="hljs-tag"><<span class="hljs-name">div</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"child"</span> /></span>\n<span class="hljs-tag"></<span class="hljs-name">van-badge</span>></span>\n\n<span class="hljs-tag"><<span class="hljs-name">style</span>></span><span class="language-css">\n <span class="hljs-selector-class">.child</span> {\n <span class="hljs-attribute">width</span>: <span class="hljs-number">40px</span>;\n <span class="hljs-attribute">height</span>: <span class="hljs-number">40px</span>;\n <span class="hljs-attribute">background</span>: <span class="hljs-number">#f2f3f5</span>;\n <span class="hljs-attribute">border-radius</span>: <span class="hljs-number">4px</span>;\n }\n</span><span class="hljs-tag"></<span class="hljs-name">style</span>></span>\n</code></pre>\n</div><div class="van-doc-card"><h3 id="max" tabindex="-1">Max</h3>\n<pre><code class="language-html"><span class="hljs-tag"><<span class="hljs-name">van-badge</span> <span class="hljs-attr">:content</span>=<span class="hljs-string">"20"</span> <span class="hljs-attr">max</span>=<span class="hljs-string">"9"</span>></span>\n <span class="hljs-tag"><<span class="hljs-name">div</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"child"</span> /></span>\n<span class="hljs-tag"></<span class="hljs-name">van-badge</span>></span>\n<span class="hljs-tag"><<span class="hljs-name">van-badge</span> <span class="hljs-attr">:content</span>=<span class="hljs-string">"50"</span> <span class="hljs-attr">max</span>=<span class="hljs-string">"20"</span>></span>\n <span class="hljs-tag"><<span class="hljs-name">div</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"child"</span> /></span>\n<span class="hljs-tag"></<span class="hljs-name">van-badge</span>></span>\n<span class="hljs-tag"><<span class="hljs-name">van-badge</span> <span class="hljs-attr">:content</span>=<span class="hljs-string">"200"</span> <span class="hljs-attr">max</span>=<span class="hljs-string">"99"</span>></span>\n <span class="hljs-tag"><<span class="hljs-name">div</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"child"</span> /></span>\n<span class="hljs-tag"></<span class="hljs-name">van-badge</span>></span>\n</code></pre>\n</div><div class="van-doc-card"><h3 id="custom-color" tabindex="-1">Custom Color</h3>\n<pre><code class="language-html"><span class="hljs-tag"><<span class="hljs-name">van-badge</span> <span class="hljs-attr">:content</span>=<span class="hljs-string">"5"</span> <span class="hljs-attr">color</span>=<span class="hljs-string">"#1989fa"</span>></span>\n <span class="hljs-tag"><<span class="hljs-name">div</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"child"</span> /></span>\n<span class="hljs-tag"></<span class="hljs-name">van-badge</span>></span>\n<span class="hljs-tag"><<span class="hljs-name">van-badge</span> <span class="hljs-attr">:content</span>=<span class="hljs-string">"10"</span> <span class="hljs-attr">color</span>=<span class="hljs-string">"#1989fa"</span>></span>\n <span class="hljs-tag"><<span class="hljs-name">div</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"child"</span> /></span>\n<span class="hljs-tag"></<span class="hljs-name">van-badge</span>></span>\n<span class="hljs-tag"><<span class="hljs-name">van-badge</span> <span class="hljs-attr">dot</span> <span class="hljs-attr">color</span>=<span class="hljs-string">"#1989fa"</span>></span>\n <span class="hljs-tag"><<span class="hljs-name">div</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"child"</span> /></span>\n<span class="hljs-tag"></<span class="hljs-name">van-badge</span>></span>\n</code></pre>\n</div><div class="van-doc-card"><h3 id="custom-content" tabindex="-1">Custom Content</h3>\n<p>Use <code>content</code> slot to custom the content of badge.</p>\n<pre><code class="language-html"><span class="hljs-tag"><<span class="hljs-name">van-badge</span>></span>\n <span class="hljs-tag"><<span class="hljs-name">div</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"child"</span> /></span>\n <span class="hljs-tag"><<span class="hljs-name">template</span> #<span class="hljs-attr">content</span>></span>\n <span class="hljs-tag"><<span class="hljs-name">van-icon</span> <span class="hljs-attr">name</span>=<span class="hljs-string">"success"</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"badge-icon"</span> /></span>\n <span class="hljs-tag"></<span class="hljs-name">template</span>></span>\n<span class="hljs-tag"></<span class="hljs-name">van-badge</span>></span>\n<span class="hljs-tag"><<span class="hljs-name">van-badge</span>></span>\n <span class="hljs-tag"><<span class="hljs-name">div</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"child"</span> /></span>\n <span class="hljs-tag"><<span class="hljs-name">template</span> #<span class="hljs-attr">content</span>></span>\n <span class="hljs-tag"><<span class="hljs-name">van-icon</span> <span class="hljs-attr">name</span>=<span class="hljs-string">"cross"</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"badge-icon"</span> /></span>\n <span class="hljs-tag"></<span class="hljs-name">template</span>></span>\n<span class="hljs-tag"></<span class="hljs-name">van-badge</span>></span>\n<span class="hljs-tag"><<span class="hljs-name">van-badge</span>></span>\n <span class="hljs-tag"><<span class="hljs-name">div</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"child"</span> /></span>\n <span class="hljs-tag"><<span class="hljs-name">template</span> #<span class="hljs-attr">content</span>></span>\n <span class="hljs-tag"><<span class="hljs-name">van-icon</span> <span class="hljs-attr">name</span>=<span class="hljs-string">"down"</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"badge-icon"</span> /></span>\n <span class="hljs-tag"></<span class="hljs-name">template</span>></span>\n<span class="hljs-tag"></<span class="hljs-name">van-badge</span>></span>\n</code></pre>\n<pre><code class="language-css"><span class="hljs-selector-class">.badge-icon</span> {\n <span class="hljs-attribute">display</span>: block;\n <span class="hljs-attribute">font-size</span>: <span class="hljs-number">10px</span>;\n <span class="hljs-attribute">line-height</span>: <span class="hljs-number">16px</span>;\n}\n</code></pre>\n</div><div class="van-doc-card"><h3 id="custom-position" tabindex="-1">Custom Position</h3>\n<p>Use <code>position</code> prop to set the position of badge.</p>\n<pre><code class="language-html"><span class="hljs-tag"><<span class="hljs-name">van-badge</span> <span class="hljs-attr">:content</span>=<span class="hljs-string">"10"</span> <span class="hljs-attr">position</span>=<span class="hljs-string">"top-left"</span>></span>\n <span class="hljs-tag"><<span class="hljs-name">div</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"child"</span> /></span>\n<span class="hljs-tag"></<span class="hljs-name">van-badge</span>></span>\n<span class="hljs-tag"><<span class="hljs-name">van-badge</span> <span class="hljs-attr">:content</span>=<span class="hljs-string">"10"</span> <span class="hljs-attr">position</span>=<span class="hljs-string">"bottom-left"</span>></span>\n <span class="hljs-tag"><<span class="hljs-name">div</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"child"</span> /></span>\n<span class="hljs-tag"></<span class="hljs-name">van-badge</span>></span>\n<span class="hljs-tag"><<span class="hljs-name">van-badge</span> <span class="hljs-attr">:content</span>=<span class="hljs-string">"10"</span> <span class="hljs-attr">position</span>=<span class="hljs-string">"bottom-right"</span>></span>\n <span class="hljs-tag"><<span class="hljs-name">div</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"child"</span> /></span>\n<span class="hljs-tag"></<span class="hljs-name">van-badge</span>></span>\n</code></pre>\n</div><div class="van-doc-card"><h3 id="standalone" tabindex="-1">Standalone</h3>\n<pre><code class="language-html"><span class="hljs-tag"><<span class="hljs-name">van-badge</span> <span class="hljs-attr">:content</span>=<span class="hljs-string">"20"</span> /></span>\n\n<span class="hljs-tag"><<span class="hljs-name">van-badge</span> <span class="hljs-attr">:content</span>=<span class="hljs-string">"200"</span> <span class="hljs-attr">max</span>=<span class="hljs-string">"99"</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>content</td>\n<td>Badge content</td>\n<td><em>number | string</em></td>\n<td>-</td>\n</tr>\n<tr>\n<td>color</td>\n<td>Background color</td>\n<td><em>string</em></td>\n<td><code>#ee0a24</code></td>\n</tr>\n<tr>\n<td>dot</td>\n<td>Whether to show dot</td>\n<td><em>boolean</em></td>\n<td><code>false</code></td>\n</tr>\n<tr>\n<td>max</td>\n<td>Max value, show <code>{max}+</code> when exceed, only works when content is number</td>\n<td><em>number | string</em></td>\n<td>-</td>\n</tr>\n<tr>\n<td>offset</td>\n<td>Offset of badge dot, the two items of the array correspond to the horizontal and vertical offsets</td>\n<td><em>[number | string, number | string]</em></td>\n<td>-</td>\n</tr>\n<tr>\n<td>show-zero</td>\n<td>Whether to show badge when content is zero</td>\n<td><em>boolean</em></td>\n<td><code>true</code></td>\n</tr>\n<tr>\n<td>position</td>\n<td>Badge position, can be set to <code>top-left</code> <code>bottom-left</code> <code>bottom-right</code></td>\n<td><em>string</em></td>\n<td><code>top-right</code></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</tr>\n</thead>\n<tbody>\n<tr>\n<td>default</td>\n<td>Default slot</td>\n</tr>\n<tr>\n<td>content</td>\n<td>Custom badge content</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_">BadgeProps</span>, <span class="hljs-title class_">BadgePosition</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-badge-size</td>\n<td><em>16px</em></td>\n<td>-</td>\n</tr>\n<tr>\n<td>--van-badge-color</td>\n<td><em>var(--van-white)</em></td>\n<td>-</td>\n</tr>\n<tr>\n<td>--van-badge-padding</td>\n<td><em>0 3px</em></td>\n<td>-</td>\n</tr>\n<tr>\n<td>--van-badge-font-size</td>\n<td><em>var(--van-font-size-sm)</em></td>\n<td>-</td>\n</tr>\n<tr>\n<td>--van-badge-font-weight</td>\n<td><em>var(--van-font-bold)</em></td>\n<td>-</td>\n</tr>\n<tr>\n<td>--van-badge-border-width</td>\n<td><em>var(--van-border-width)</em></td>\n<td>-</td>\n</tr>\n<tr>\n<td>--van-badge-background</td>\n<td><em>var(--van-danger-color)</em></td>\n<td>-</td>\n</tr>\n<tr>\n<td>--van-badge-dot-color</td>\n<td><em>var(--van-danger-color)</em></td>\n<td>-</td>\n</tr>\n<tr>\n<td>--van-badge-dot-size</td>\n<td><em>8px</em></td>\n<td>-</td>\n</tr>\n<tr>\n<td>--van-badge-font</td>\n<td><em>-apple-system-font, Helvetica Neue, Arial, sans-serif</em></td>\n<td>-</td>\n</tr>\n</tbody>\n</table>\n</div>'},null,8,l))}}}]); |