wot-design-uni/docs/en-US/component/popup.md

Popup

A popup layer that displays content on top of the current page.

Basic Usage

The visible attribute controls whether the popup is displayed. The position attribute sets the popup position, which can be 'center', 'top', 'right', 'bottom', 'left', default is 'center'.

<wd-popup :visible.sync="show" position="bottom">
  <view style="height: 200px; text-align: center; line-height: 200px;">
    Content
  </view>
</wd-popup>

Close Button

Set the closable attribute to display a close button in the popup.

<wd-popup :visible.sync="show" position="bottom" closable>
  <view style="height: 200px; text-align: center; line-height: 200px;">
    Content
  </view>
</wd-popup>

Close Button Position

Set the close-position attribute to customize the position of the close button, which can be 'top-left', 'top-right', 'bottom-left', 'bottom-right', default is 'top-right'.

<wd-popup :visible.sync="show" position="bottom" closable close-position="top-left">
  <view style="height: 200px; text-align: center; line-height: 200px;">
    Content
  </view>
</wd-popup>

Custom Close Icon

Set the close-icon attribute to customize the close icon.

<wd-popup :visible.sync="show" position="bottom" closable close-icon="check">
  <view style="height: 200px; text-align: center; line-height: 200px;">
    Content
  </view>
</wd-popup>

Rounded Corners

Set the border-radius attribute to customize the border radius of the popup. This attribute is only valid when the position is 'top', 'right', 'bottom', 'left'.

<wd-popup :visible.sync="show" position="bottom" border-radius="16px">
  <view style="height: 200px; text-align: center; line-height: 200px;">
    Content
  </view>
</wd-popup>

Disable Mask Click

Set the close-on-click-modal attribute to false to disable closing the popup when clicking the mask.

<wd-popup :visible.sync="show" position="bottom" :close-on-click-modal="false">
  <view style="height: 200px; text-align: center; line-height: 200px;">
    Content
  </view>
</wd-popup>

root-portal

When the root-portal attribute is set to true, the popup will be teleported to the page root node, which can avoid the influence of parent component's transform, filter and other CSS properties on the fixed positioning of the popup.

Different platforms use different implementation schemes:

• H5: Use Vue 3's teleport feature
• APP: Use renderjs to move elements to the uni-app root node
• WeChat Mini Program/Alipay Mini Program: Use root-portal component
• Other platforms: root-portal feature is not supported

<wd-popup v-model="show" root-portal position="center" custom-style="height: 200px;" @close="handleClose">
  <text class="custom-txt">I'm teleported to the root node</text>
</wd-popup>

:::tip Tip This feature is mainly used to solve layering and positioning issues of popups in complex layouts, and it is recommended to enable it only when needed. :::

Attributes

Attribute	Description	Type	Default	Version
visible	Whether to display the popup, supports the .sync modifier	boolean	false	-
position	Popup position	string	center	-
closable	Whether to display the close button	boolean	false	-
close-position	Close button position	string	top-right	-
close-icon	Close button icon	string	close	-
modal	Whether to display the mask	boolean	true	-
modal-style	Custom mask style	object	-	-
modal-class	Custom mask class	string	-	-
z-index	z-index	number	10	-
lazy-render	Whether to lazily render the popup	boolean	true	-
close-on-click-modal	Whether to close the popup when clicking the mask	boolean	true	-
duration	Animation duration	number	300(ms)	-
custom-style	Custom popup style	object	-	-
border-radius	Border radius of the popup	string	0	-
safe-area-inset-bottom	Whether to enable bottom safe area adaptation	boolean	false	-
root-portal	Whether to break away from the page to solve various fixed failure issues	boolean	false	1.11.0

Events

Event Name	Description	Parameters	Version
open	Triggered when the popup is opened	-	-
opened	Triggered when the popup opening animation ends	-	-
close	Triggered when the popup is closed	-	-
closed	Triggered when the popup closing animation ends	-	-
click-modal	Triggered when the mask is clicked	-	-

Slots

Name	Description	Version
default	Content of the popup	-

External Style Classes

Class Name	Description	Version
custom-class	Root node custom class	-