mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-06 03:57:59 +08:00
39 lines
11 KiB
JavaScript
39 lines
11 KiB
JavaScript
import{o as a,a as t,y as n}from"./vue-libs.b44bc779.js";const l={class:"van-doc-markdown-body"},e=n(`<h1>Tag</h1><div class="van-doc-card"><h3 id="intro" tabindex="-1">Intro</h3><p>Used to mark keywords and summarize the main content.</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_">Tag</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_">Tag</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-tag</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"primary"</span>></span>Tag<span class="hljs-tag"></<span class="hljs-name">van-tag</span>></span>
|
|
<span class="hljs-tag"><<span class="hljs-name">van-tag</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"success"</span>></span>Tag<span class="hljs-tag"></<span class="hljs-name">van-tag</span>></span>
|
|
<span class="hljs-tag"><<span class="hljs-name">van-tag</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"danger"</span>></span>Tag<span class="hljs-tag"></<span class="hljs-name">van-tag</span>></span>
|
|
<span class="hljs-tag"><<span class="hljs-name">van-tag</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"warning"</span>></span>Tag<span class="hljs-tag"></<span class="hljs-name">van-tag</span>></span>
|
|
</code></pre></div><div class="van-doc-card"><h3 id="plain-style" tabindex="-1">Plain style</h3><pre><code class="language-html"><span class="hljs-tag"><<span class="hljs-name">van-tag</span> <span class="hljs-attr">plain</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"primary"</span>></span>Tag<span class="hljs-tag"></<span class="hljs-name">van-tag</span>></span>
|
|
</code></pre></div><div class="van-doc-card"><h3 id="round-style" tabindex="-1">Round style</h3><pre><code class="language-html"><span class="hljs-tag"><<span class="hljs-name">van-tag</span> <span class="hljs-attr">round</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"primary"</span>></span>Tag<span class="hljs-tag"></<span class="hljs-name">van-tag</span>></span>
|
|
</code></pre></div><div class="van-doc-card"><h3 id="mark-style" tabindex="-1">Mark style</h3><pre><code class="language-html"><span class="hljs-tag"><<span class="hljs-name">van-tag</span> <span class="hljs-attr">mark</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"primary"</span>></span>Tag<span class="hljs-tag"></<span class="hljs-name">van-tag</span>></span>
|
|
</code></pre></div><div class="van-doc-card"><h3 id="closeable" tabindex="-1">Closeable</h3><pre><code class="language-html"><span class="hljs-tag"><<span class="hljs-name">van-tag</span> <span class="hljs-attr">:show</span>=<span class="hljs-string">"show"</span> <span class="hljs-attr">closeable</span> <span class="hljs-attr">size</span>=<span class="hljs-string">"medium"</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"primary"</span> @<span class="hljs-attr">close</span>=<span class="hljs-string">"close"</span>></span>
|
|
Tag
|
|
<span class="hljs-tag"></<span class="hljs-name">van-tag</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> show = <span class="hljs-title function_">ref</span>(<span class="hljs-literal">true</span>);
|
|
<span class="hljs-keyword">const</span> <span class="hljs-title function_">close</span> = (<span class="hljs-params"></span>) => {
|
|
show.<span class="hljs-property">value</span> = <span class="hljs-literal">false</span>;
|
|
};
|
|
|
|
<span class="hljs-keyword">return</span> {
|
|
show,
|
|
close,
|
|
};
|
|
},
|
|
};
|
|
</code></pre></div><div class="van-doc-card"><h3 id="custom-size" tabindex="-1">Custom Size</h3><pre><code class="language-html"><span class="hljs-tag"><<span class="hljs-name">van-tag</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"primary"</span>></span>Tag<span class="hljs-tag"></<span class="hljs-name">van-tag</span>></span>
|
|
<span class="hljs-tag"><<span class="hljs-name">van-tag</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"primary"</span> <span class="hljs-attr">size</span>=<span class="hljs-string">"medium"</span>></span>Tag<span class="hljs-tag"></<span class="hljs-name">van-tag</span>></span>
|
|
<span class="hljs-tag"><<span class="hljs-name">van-tag</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"primary"</span> <span class="hljs-attr">size</span>=<span class="hljs-string">"large"</span>></span>Tag<span class="hljs-tag"></<span class="hljs-name">van-tag</span>></span>
|
|
</code></pre></div><div class="van-doc-card"><h3 id="custom-color" tabindex="-1">Custom Color</h3><pre><code class="language-html"><span class="hljs-tag"><<span class="hljs-name">van-tag</span> <span class="hljs-attr">color</span>=<span class="hljs-string">"#7232dd"</span>></span>Tag<span class="hljs-tag"></<span class="hljs-name">van-tag</span>></span>
|
|
<span class="hljs-tag"><<span class="hljs-name">van-tag</span> <span class="hljs-attr">color</span>=<span class="hljs-string">"#ffe1e1"</span> <span class="hljs-attr">text-color</span>=<span class="hljs-string">"#ad0000"</span>></span>Tag<span class="hljs-tag"></<span class="hljs-name">van-tag</span>></span>
|
|
<span class="hljs-tag"><<span class="hljs-name">van-tag</span> <span class="hljs-attr">color</span>=<span class="hljs-string">"#7232dd"</span> <span class="hljs-attr">plain</span>></span>Tag<span class="hljs-tag"></<span class="hljs-name">van-tag</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>type</td><td>Type, can be set to <code>primary</code> <code>success</code> <code>danger</code> <code>warning</code></td><td><em>string</em></td><td><code>default</code></td></tr><tr><td>size</td><td>Size, can be set to <code>large</code> <code>medium</code></td><td><em>string</em></td><td>-</td></tr><tr><td>color</td><td>Custom color</td><td><em>string</em></td><td>-</td></tr><tr><td>show</td><td>Whether to show tag</td><td><em>boolean</em></td><td><code>true</code></td></tr><tr><td>plain</td><td>Whether to be plain style</td><td><em>boolean</em></td><td><code>false</code></td></tr><tr><td>round</td><td>Whether to be round style</td><td><em>boolean</em></td><td><code>false</code></td></tr><tr><td>mark</td><td>Whether to be mark style</td><td><em>boolean</em></td><td><code>false</code></td></tr><tr><td>text-color</td><td>Text color</td><td><em>string</em></td><td><code>white</code></td></tr><tr><td>closeable</td><td>Whether to be closeable</td><td><em>boolean</em></td><td><code>false</code></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></tr></thead><tbody><tr><td>default</td><td>Default slot</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>click</td><td>Emitted when component is clicked</td><td><em>event: MouseEvent</em></td></tr><tr><td>close</td><td>Emitted when close icon is clicked</td><td><em>event: MouseEvent</em></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_">TagSize</span>, <span class="hljs-title class_">TagType</span>, <span class="hljs-title class_">TagProps</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-tag-padding</td><td><em>0 var(--van-padding-base)</em></td><td>-</td></tr><tr><td>--van-tag-text-color</td><td><em>var(--van-white)</em></td><td>-</td></tr><tr><td>--van-tag-font-size</td><td><em>var(--van-font-size-sm)</em></td><td>-</td></tr><tr><td>--van-tag-border-radius</td><td><em>2px</em></td><td>-</td></tr><tr><td>--van-tag-line-height</td><td><em>16px</em></td><td>-</td></tr><tr><td>--van-tag-medium-padding</td><td><em>2px 6px</em></td><td>-</td></tr><tr><td>--van-tag-large-padding</td><td><em>var(--van-padding-base) var(--van-padding-xs)</em></td><td>-</td></tr><tr><td>--van-tag-large-border-radius</td><td><em>var(--van-border-radius-md)</em></td><td>-</td></tr><tr><td>--van-tag-large-font-size</td><td><em>var(--van-font-size-md)</em></td><td>-</td></tr><tr><td>--van-tag-round-border-radius</td><td><em>var(--van-border-radius-max)</em></td><td>-</td></tr><tr><td>--van-tag-danger-color</td><td><em>var(--van-danger-color)</em></td><td>-</td></tr><tr><td>--van-tag-primary-color</td><td><em>var(--van-primary-color)</em></td><td>-</td></tr><tr><td>--van-tag-success-color</td><td><em>var(--van-success-color)</em></td><td>-</td></tr><tr><td>--van-tag-warning-color</td><td><em>var(--van-warning-color)</em></td><td>-</td></tr><tr><td>--van-tag-default-color</td><td><em>var(--van-gray-6)</em></td><td>-</td></tr><tr><td>--van-tag-plain-background-color</td><td><em>var(--van-background-color-light)</em></td><td>-</td></tr></tbody></table></div>`,18),d=[e],i={__name:"README",setup(p,{expose:s}){return s({frontmatter:{}}),(c,o)=>(a(),t("div",l,d))}};export{i as default};
|