mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-06 03:57:59 +08:00
62 lines
10 KiB
JavaScript
62 lines
10 KiB
JavaScript
import{o as t,a,y as n}from"./vue-libs.b44bc779.js";const e={class:"van-doc-markdown-body"},l=n(`<h1>Notify</h1><div class="van-doc-card"><h3 id="intro" tabindex="-1">Intro</h3><p>The display message prompt is at the top of the page, and supports two methods: function call and component call.</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_">Notify</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_">Notify</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-js"><span class="hljs-title class_">Notify</span>(<span class="hljs-string">'Notify Message'</span>);
|
|
</code></pre></div><div class="van-doc-card"><h3 id="notify-type" tabindex="-1">Notify Type</h3><pre><code class="language-js"><span class="hljs-title class_">Notify</span>({ <span class="hljs-attr">type</span>: <span class="hljs-string">'primary'</span>, <span class="hljs-attr">message</span>: <span class="hljs-string">'Notify Message'</span> });
|
|
<span class="hljs-title class_">Notify</span>({ <span class="hljs-attr">type</span>: <span class="hljs-string">'success'</span>, <span class="hljs-attr">message</span>: <span class="hljs-string">'Notify Message'</span> });
|
|
<span class="hljs-title class_">Notify</span>({ <span class="hljs-attr">type</span>: <span class="hljs-string">'danger'</span>, <span class="hljs-attr">message</span>: <span class="hljs-string">'Notify Message'</span> });
|
|
<span class="hljs-title class_">Notify</span>({ <span class="hljs-attr">type</span>: <span class="hljs-string">'warning'</span>, <span class="hljs-attr">message</span>: <span class="hljs-string">'Notify Message'</span> });
|
|
</code></pre></div><div class="van-doc-card"><h3 id="custom-notify" tabindex="-1">Custom Notify</h3><pre><code class="language-js"><span class="hljs-title class_">Notify</span>({
|
|
<span class="hljs-attr">message</span>: <span class="hljs-string">'Custom Color'</span>,
|
|
<span class="hljs-attr">color</span>: <span class="hljs-string">'#ad0000'</span>,
|
|
<span class="hljs-attr">background</span>: <span class="hljs-string">'#ffe1e1'</span>,
|
|
});
|
|
|
|
<span class="hljs-title class_">Notify</span>({
|
|
<span class="hljs-attr">message</span>: <span class="hljs-string">'Custom Position'</span>,
|
|
<span class="hljs-attr">position</span>: <span class="hljs-string">'bottom'</span>,
|
|
});
|
|
|
|
<span class="hljs-title class_">Notify</span>({
|
|
<span class="hljs-attr">message</span>: <span class="hljs-string">'Custom Duration'</span>,
|
|
<span class="hljs-attr">duration</span>: <span class="hljs-number">1000</span>,
|
|
});
|
|
</code></pre></div><div class="van-doc-card"><h3 id="global-method" tabindex="-1">Global Method</h3><p>After registering the Notify component through <code>app.use</code>, the <code>$notify</code> method will be automatically mounted on all subcomponents of the app.</p><pre><code class="language-js"><span class="hljs-keyword">export</span> <span class="hljs-keyword">default</span> {
|
|
<span class="hljs-title function_">mounted</span>(<span class="hljs-params"></span>) {
|
|
<span class="hljs-variable language_">this</span>.$notify(<span class="hljs-string">'Notify Message'</span>);
|
|
},
|
|
};
|
|
</code></pre></div><div class="van-doc-card"><h3 id="component-call" tabindex="-1">Component Call</h3><pre><code class="language-html"><span class="hljs-tag"><<span class="hljs-name">van-button</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"primary"</span> <span class="hljs-attr">text</span>=<span class="hljs-string">"Component Call"</span> @<span class="hljs-attr">click</span>=<span class="hljs-string">"showNotify"</span> /></span>
|
|
<span class="hljs-tag"><<span class="hljs-name">van-notify</span> <span class="hljs-attr">v-model:show</span>=<span class="hljs-string">"show"</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"success"</span>></span>
|
|
<span class="hljs-tag"><<span class="hljs-name">van-icon</span> <span class="hljs-attr">name</span>=<span class="hljs-string">"bell"</span> <span class="hljs-attr">style</span>=<span class="hljs-string">"margin-right: 4px;"</span> /></span>
|
|
<span class="hljs-tag"><<span class="hljs-name">span</span>></span>Content<span class="hljs-tag"></<span class="hljs-name">span</span>></span>
|
|
<span class="hljs-tag"></<span class="hljs-name">van-notify</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">false</span>);
|
|
|
|
<span class="hljs-keyword">const</span> <span class="hljs-title function_">showNotify</span> = (<span class="hljs-params"></span>) => {
|
|
show.<span class="hljs-property">value</span> = <span class="hljs-literal">true</span>;
|
|
<span class="hljs-built_in">setTimeout</span>(<span class="hljs-function">() =></span> {
|
|
show.<span class="hljs-property">value</span> = <span class="hljs-literal">false</span>;
|
|
}, <span class="hljs-number">2000</span>);
|
|
};
|
|
|
|
<span class="hljs-keyword">return</span> {
|
|
show,
|
|
showNotify,
|
|
};
|
|
},
|
|
};
|
|
</code></pre></div><h2 id="api" tabindex="-1">API</h2><div class="van-doc-card"><h3 id="methods" tabindex="-1">Methods</h3><table><thead><tr><th>Methods</th><th>Attribute</th><th>Return value</th><th>Description</th></tr></thead><tbody><tr><td>Notify</td><td><code>options | message</code></td><td>notify instance</td><td>Show notify</td></tr><tr><td>Notify.clear</td><td>-</td><td><code>void</code></td><td>Close notify</td></tr><tr><td>Notify.setDefaultOptions</td><td><code>options</code></td><td><code>void</code></td><td>Set default options of all notifies</td></tr><tr><td>Notify.resetDefaultOptions</td><td>-</td><td><code>void</code></td><td>Reset default options of all notifies</td></tr></tbody></table></div><div class="van-doc-card"><h3 id="options" tabindex="-1">Options</h3><table><thead><tr><th>Attribute</th><th>Description</th><th>Type</th><th>Default</th></tr></thead><tbody><tr><td>type</td><td>Can be set to <code>primary</code> <code>success</code> <code>warning</code></td><td><em>NotifyType</em></td><td><code>danger</code></td></tr><tr><td>message</td><td>Message</td><td><em>string</em></td><td>-</td></tr><tr><td>duration</td><td>Duration(ms), won't disappear if value is 0</td><td><em>number | string</em></td><td><code>3000</code></td></tr><tr><td>position <code>v3.4.0</code></td><td>Position, can be set to <code>bottom</code></td><td><em>NotifyPosition</em></td><td><code>top</code></td></tr><tr><td>color</td><td>Message color</td><td><em>string</em></td><td><code>white</code></td></tr><tr><td>background</td><td>Background color</td><td><em>string</em></td><td>-</td></tr><tr><td>className</td><td>Custom className</td><td><em>string | Array | object</em></td><td>-</td></tr><tr><td>lockScroll <code>v3.0.7</code></td><td>Whether to lock background scroll</td><td><em>boolean</em></td><td><code>false</code></td></tr><tr><td>onClick</td><td>Callback function after click</td><td><em>(event: MouseEvent) => void</em></td><td>-</td></tr><tr><td>onOpened</td><td>Callback function after opened</td><td><em>() => void</em></td><td>-</td></tr><tr><td>onClose</td><td>Callback function after close</td><td><em>() => void</em></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_">NotifyType</span>,
|
|
<span class="hljs-title class_">NotifyProps</span>,
|
|
<span class="hljs-title class_">NotifyOptions</span>,
|
|
<span class="hljs-title class_">NotifyPosition</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-notify-text-color</td><td><em>var(--van-white)</em></td><td>-</td></tr><tr><td>--van-notify-padding</td><td><em>var(--van-padding-xs) var(--van-padding-md)</em></td><td>-</td></tr><tr><td>--van-notify-font-size</td><td><em>var(--van-font-size-md)</em></td><td>-</td></tr><tr><td>--van-notify-line-height</td><td><em>var(--van-line-height-md)</em></td><td>-</td></tr><tr><td>--van-notify-primary-background-color</td><td><em>var(--van-primary-color)</em></td><td>-</td></tr><tr><td>--van-notify-success-background-color</td><td><em>var(--van-success-color)</em></td><td>-</td></tr><tr><td>--van-notify-danger-background-color</td><td><em>var(--van-danger-color)</em></td><td>-</td></tr><tr><td>--van-notify-warning-background-color</td><td><em>var(--van-warning-color)</em></td><td>-</td></tr></tbody></table></div>`,15),o=[l],h={__name:"README",setup(d,{expose:s}){return s({frontmatter:{}}),(c,r)=>(t(),a("div",e,o))}};export{h as default};
|