mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-06 03:57:59 +08:00
38 lines
6.7 KiB
JavaScript
38 lines
6.7 KiB
JavaScript
import{o as a,a as t,y as n}from"./vue-libs.b44bc779.js";const e={class:"van-doc-markdown-body"},l=n(`<h1>Overlay</h1><div class="van-doc-card"><h3 id="intro" tabindex="-1">Intro</h3><p>Create a mask layer to emphasize specific page elements and prevent users from performing other operations.</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_">Overlay</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_">Overlay</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-button</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"primary"</span> <span class="hljs-attr">text</span>=<span class="hljs-string">"Show Overlay"</span> @<span class="hljs-attr">click</span>=<span class="hljs-string">"show = true"</span> /></span>
|
|
<span class="hljs-tag"><<span class="hljs-name">van-overlay</span> <span class="hljs-attr">:show</span>=<span class="hljs-string">"show"</span> @<span class="hljs-attr">click</span>=<span class="hljs-string">"show = false"</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">return</span> { show };
|
|
},
|
|
};
|
|
</code></pre></div><div class="van-doc-card"><h3 id="embedded-content" tabindex="-1">Embedded Content</h3><pre><code class="language-html"><span class="hljs-tag"><<span class="hljs-name">van-overlay</span> <span class="hljs-attr">:show</span>=<span class="hljs-string">"show"</span> @<span class="hljs-attr">click</span>=<span class="hljs-string">"show = false"</span>></span>
|
|
<span class="hljs-tag"><<span class="hljs-name">div</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"wrapper"</span> @<span class="hljs-attr">click.stop</span>></span>
|
|
<span class="hljs-tag"><<span class="hljs-name">div</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"block"</span> /></span>
|
|
<span class="hljs-tag"></<span class="hljs-name">div</span>></span>
|
|
<span class="hljs-tag"></<span class="hljs-name">van-overlay</span>></span>
|
|
|
|
<span class="hljs-tag"><<span class="hljs-name">style</span>></span><span class="language-css">
|
|
<span class="hljs-selector-class">.wrapper</span> {
|
|
<span class="hljs-attribute">display</span>: flex;
|
|
<span class="hljs-attribute">align-items</span>: center;
|
|
<span class="hljs-attribute">justify-content</span>: center;
|
|
<span class="hljs-attribute">height</span>: <span class="hljs-number">100%</span>;
|
|
}
|
|
|
|
<span class="hljs-selector-class">.block</span> {
|
|
<span class="hljs-attribute">width</span>: <span class="hljs-number">120px</span>;
|
|
<span class="hljs-attribute">height</span>: <span class="hljs-number">120px</span>;
|
|
<span class="hljs-attribute">background-color</span>: <span class="hljs-number">#fff</span>;
|
|
}
|
|
</span><span class="hljs-tag"></<span class="hljs-name">style</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>show</td><td>Whether to show overlay</td><td><em>boolean</em></td><td><code>false</code></td></tr><tr><td>z-index</td><td>z-index</td><td><em>number | string</em></td><td><code>1</code></td></tr><tr><td>duration</td><td>Animation duration</td><td><em>number | string</em></td><td><code>0.3</code></td></tr><tr><td>class-name</td><td>ClassName</td><td><em>string</em></td><td>-</td></tr><tr><td>custom-class</td><td>Custom style</td><td><em>object</em></td><td>-</td></tr><tr><td>lock-scroll</td><td>Whether to lock background scroll</td><td><em>boolean</em></td><td><code>true</code></td></tr><tr><td>lazy-render <code>v3.4.2</code></td><td>Whether to lazy render util appeared</td><td><em>boolean</em></td><td><code>true</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>click</td><td>Emitted when component is clicked</td><td><em>event: MouseEvent</em></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="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_">OverlayProps</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-overlay-z-index</td><td><em>1</em></td><td>-</td></tr><tr><td>--van-overlay-background-color</td><td><em>rgba(0, 0, 0, 0.7)</em></td><td>-</td></tr></tbody></table></div>`,13),p=[l],i={__name:"README",setup(d,{expose:s}){return s({frontmatter:{}}),(r,o)=>(a(),t("div",e,p))}};export{i as default};
|