nutui-uniapp

Appearance

Popup 弹出层 ​

介绍 ​

弹出层容器，用于展示弹窗、信息提示等内容，支持多个弹出层叠加展示

基础用法 ​

通过设置 visible 控制显示/隐藏

html
<template>
  <nut-cell title="展示弹出层" is-link @click="showBasic = true"></nut-cell>
  <nut-popup :custom-style="{ padding: '30px 50px' }" v-model:visible="showBasic">正文</nut-popup>
</template>
<script lang="ts">
  import { reactive, toRefs } from 'vue';
  export default {
    props: {},
    setup() {
      const state = reactive({
        showBasic: false
      });
      return { ...toRefs(state) };
    }
  };
</script>

弹出位置 ​

通过设置 position 的值来控制弹出位置

html
<template>
  <nut-cell title="顶部弹出" is-link @click="showTop = true"></nut-cell>
  <nut-popup position="top" :custom-style="{ height: '20%' }" v-model:visible="showTop"></nut-popup>
  <nut-cell title="底部弹出" is-link @click="showBottom = true"></nut-cell>
  <nut-popup position="bottom" :custom-style="{ height: '20%' }" v-model:visible="showBottom"></nut-popup>
  <nut-cell title="左侧弹出" is-link @click="showLeft = true"></nut-cell>
  <nut-popup position="left" :custom-style="{ width: '20%', height: '100%' }" v-model:visible="showLeft"></nut-popup>
  <nut-cell title="右侧弹出" is-link @click="showRight = true"></nut-cell>
  <nut-popup position="right" :custom-style="{ width: '20%', height: '100%' }" v-model:visible="showRight"></nut-popup>
</template>
<script lang="ts">
  import { reactive, toRefs } from 'vue';
  export default {
    props: {},
    setup() {
      const state = reactive({
        showTop: false,
        showBottom: false,
        showLeft: false,
        showRight: false,
      });
      return { ...toRefs(state) };
    }
  };
</script>

图标 ​

通过 closeable 控制图标是否可关闭，close-icon-position 来设置图标的位置，close-icon 来自定义显示图标，详情可参照图标

html
<template>
  <nut-cell title="关闭图标" is-link @click="showIcon = true"></nut-cell>
  <nut-popup position="bottom" closeable :custom-style="{ height: '20%' }" v-model:visible="showIcon"></nut-popup>
  <nut-cell title="图标位置" is-link @click="showIconPosition = true" ></nut-cell>
  <nut-popup position="bottom" closeable close-icon-position="top-left" :custom-style="{ height: '20%' }" v-model:visible="showIconPosition" ></nut-popup>
  <nut-cell title="自定义图标" is-link @click="showCloseIcon = true" ></nut-cell>
  <nut-popup position="bottom" closeable close-icon-position="top-left" :custom-style="{ height: '20%' }" v-model:visible="showCloseIcon">
    <template #close-icon>
      <nut-icon name="heart" />
    </template>
  </nut-popup>
</template>
<script lang="ts">
  import { reactive, toRefs } from 'vue';
  export default {
    props: {},
    setup() {
      const state = reactive({
        showIcon: false,
        showIconPosition: false,
        showCloseIcon: false,
      });
      return { ...toRefs(state) };
    }
  };
</script>

圆角弹框 ​

通过设置 round 来控制是否显示圆角

html
<template>
  <nut-cell title="圆角弹框" is-link @click="showRound = true"></nut-cell>
  <nut-popup position="bottom" closeable round :custom-style="{ height: '30%' }" v-model:visible="showRound"></nut-popup>
</template>
<script lang="ts">
  import { reactive, toRefs } from 'vue';
  export default {
    props: {},
    setup() {
      const state = reactive({
        showRound: false,
      });
      return { ...toRefs(state) };
    }
  };
</script>

多层堆叠 ​

html
<template>
  <nut-cell title="多层堆叠" is-link @click="showPop1 = true"></nut-cell>
  <nut-popup :custom-style="{ padding: '30px 50px' }" v-model:visible="showPop1">
    <div @click="showPop2 = true">点击它</div>
  </nut-popup>
  <nut-popup :custom-style="{ padding: '30px 50px' }" v-model:visible="showPop2">正文</nut-popup>
</template>
<script lang="ts">
  import { reactive, toRefs } from 'vue';
  export default {
    props: {},
    setup() {
      const state = reactive({
        showPop1: false,
        showPop2: false
      });
      return { ...toRefs(state) };
    }
  };
</script>

API ​

当前组件内部透传了 Icon组件 和 Overlay组件

Props ​

参数说明类型默认值
v-model:visible控制当前组件显示/隐藏booleanfalse
z-index遮罩层级string | number2000+
duration组件显示/隐藏的动画时长，单位秒string | number0.3
lock-scroll H5背景是否锁定booleantrue
overlay是否显示遮罩booleantrue
close-on-click-overlay是否点击遮罩关闭booleantrue
position弹出位置（top,bottom,left,right,center）string"center"
transition动画名string-
custom-style自定义弹框样式CSSProperties-
pop-class自定义弹框类名string-
closeable是否显示关闭按钮booleanfalse
close-icon-position关闭按钮位置（top-left,top-right,bottom-left,bottom-right）string"top-right"
close-icon图标名称 或图片链接string"close"
destroy-on-close弹层关闭后 slot内容会不会清空booleantrue
round是否显示圆角booleanfalse
overlay-class自定义遮罩层类名string''
overlay-style自定义遮罩层样式string''
safe-area-inset-bottom是否开启 iphone 系列全面屏底部安全区适配,仅当 position 为 bottom 时有效booleanfalse

Events ​

事件名说明回调参数
click-pop点击弹出层时触发event: Event
click-close-icon点击关闭图标时触发event: Event
open打开弹框时触发-
close关闭弹框时触发-
opened遮罩打开动画结束时触发event: Event
closed遮罩关闭动画结束时触发event: Event
click-overlay点击遮罩触发event: Event

Slots ​

名称说明
default自定义内嵌内容
closeIcon关闭按钮的自定义图标

主题定制 ​

样式变量 ​

组件提供了下列 CSS 变量，可用于自定义样式，使用方法请参考 ConfigProvider 组件。

名称默认值
--nut-popup-close-icon-margin16px
--nut-popup-border-radius20px

MIT Licensed

版权所有 © 2023 年-至今 yang1206 贡献者