@2alheure/vue-modal 中文文档教程

发布于 3年前 浏览 28 项目主页 更新于 3年前

Vue.js Modal

一个简单的 Vue.js 模态组件。
此组件与 Vue 3 兼容。

Installation

首先,运行 npm install @2alheure/vue-modal
然后使用 import Modal from "@2alheure/vue-modal"; 导入它。

Usage

Simple usage example

<Modal :displayed="isModalDisplayed" @close="isModalDisplayed = false">
  <p>Look at that beautiful modal! =D</p>
</Modal>

<!-- OR -->

<Modal v-model="isModalDisplayed">
  <p>Look at that beautiful modal! =D</p>
</Modal>



<script>
  import Modal from "@2alheure/vue-modal";

  export default {
    components: {
      Modal
    },
    data() {
      return {
        isModalDisplayed: true
      };
    }
  }
</script>

Props

NameTypeDefault valueDescription
modelValueBooleanfalseWhether the modal should be displayed or not.

This is the prop actually used by the v-model directive.
This prop is required.
adaptativeBooleanfalseWhether to let the modal adapt its size to its content or not. If not, the modal will be half the width of the window.
btnCloseBooleantrueWhether a "close" button should be displayed or not.
escCloseBooleantrueWhether the modal should close when the "escape" key is pressed or not.
overlayCloseBooleantrueWhether the modal should close when the user clicks outside its content or not.

Events

NameValue typeValueDescription
update:modelValueBooleanfalseTriggered each time the modal should be closed:
The cross button or the outside of the modal has been cliked, escape key has been pressed.

This is the event used for the v-model directive.
update:modelValueBooleantrueTriggered each time the modal is opened.

Vue.js Modal

A simple Modal component for Vue.js.
This component is compatible with Vue 3.

Installation

First, run npm install @2alheure/vue-modal.
Then import it with import Modal from "@2alheure/vue-modal";.

Usage

Simple usage example

<Modal :displayed="isModalDisplayed" @close="isModalDisplayed = false">
  <p>Look at that beautiful modal! =D</p>
</Modal>

<!-- OR -->

<Modal v-model="isModalDisplayed">
  <p>Look at that beautiful modal! =D</p>
</Modal>



<script>
  import Modal from "@2alheure/vue-modal";

  export default {
    components: {
      Modal
    },
    data() {
      return {
        isModalDisplayed: true
      };
    }
  }
</script>

Props

NameTypeDefault valueDescription
modelValueBooleanfalseWhether the modal should be displayed or not.

This is the prop actually used by the v-model directive.
This prop is required.
adaptativeBooleanfalseWhether to let the modal adapt its size to its content or not. If not, the modal will be half the width of the window.
btnCloseBooleantrueWhether a "close" button should be displayed or not.
escCloseBooleantrueWhether the modal should close when the "escape" key is pressed or not.
overlayCloseBooleantrueWhether the modal should close when the user clicks outside its content or not.

Events

NameValue typeValueDescription
update:modelValueBooleanfalseTriggered each time the modal should be closed:
The cross button or the outside of the modal has been cliked, escape key has been pressed.

This is the event used for the v-model directive.
update:modelValueBooleantrueTriggered each time the modal is opened.
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文