v-dialogs - GitLite

KO | EN

gitlite — search

#javascript #python #ai #go #rust #deep-learning #macos #nodejs #windows #cli #vue #mcp #ios #openai

v-dialogs

(★ 132)

A simple command-style pop-up dialog components for Vue

파일 탐색기

최종 버전 다운로드 (.zip)

- config.yml
- - npm-publish.yml
- extensions.json
- App.vue
- CardPanel.vue
- cover.jpg
- ExamplesAlert.vue
- ExamplesDrawer.vue
- ExamplesGlobal.vue
- ExamplesIndex.vue
- ExamplesMask.vue
- ExamplesMessage.vue
- ExamplesModal.vue
- ExamplesToast.vue
- main.js
- router.js
- TextVNode.vue
- UserCompany.vue
- UserProfile.vue
- - alert.spec.js
  - base.spec.js
  - drawer.spec.js
  - mask.spec.js
  - message.spec.js
  - modal.spec.js
  - toast.spec.js
- - DialogComponentBody.jsx
  - DialogContainer.jsx
  - DialogContentBox.jsx
  - DialogLiteContainer.jsx
- - base-dialog.js
  - base-settings.js
  - base-use.js
  - helper.js
  - manage.js
- - IconClose.vue
  - IconConfirm.vue
  - IconError.vue
  - IconInfo.vue
  - IconLoading.vue
  - IconMaximize.vue
  - IconRestore.vue
  - IconSuccess.vue
  - IconWarning.vue
- - _variable.sass
  - alert.sass
  - animated.sass
  - dialog.sass
  - drawer.sass
  - mask.sass
  - message.sass
  - modal.sass
  - toast.sass
- constants.js
- index.js
- language.js
- alert.d.ts
- base.d.ts
- drawer.d.ts
- index.d.ts
- mask.d.ts
- message.d.ts
- modal.d.ts
- toast.d.ts
.editorconfig
.gitignore
CHANGELOG-CN.md
CHANGELOG.md
eslint.config.js
index.html
jsconfig.json
LICENSE
package.json
pnpm-lock.yaml
postcss.config.cjs
README.md
tsconfig.json
vite.config.js

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/TerryZ/v-dialogs

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd v-dialogs

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm i v-dialogs

이 명령어를 터미널에 그대로 입력해 실행하세요.

yarn add v-dialogs

이 명령어를 터미널에 그대로 입력해 실행하세요.

pnpm add v-dialogs

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# [v-dialogs](https://terryz.github.io/docs-vue3/dialog/)


[![GithubActions](https://github.com/TerryZ/v-dialogs/actions/workflows/npm-publish.yml/badge.svg?branch=master)](https://github.com/TerryZ/v-dialogs/actions/workflows/npm-publish.yml)
[![code coverage](https://codecov.io/gh/TerryZ/v-dialogs/branch/master/graph/badge.svg)](https://codecov.io/gh/TerryZ/v-dialogs)
[![npm version](https://img.shields.io/npm/v/v-dialogs.svg)](https://www.npmjs.com/package/v-dialogs)
[![license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://mit-license.org/)
[![npm](https://img.shields.io/npm/dy/v-dialogs.svg)](https://www.npmjs.com/package/v-dialogs)

A simple command-style pop-up dialog components for **Vue3**

- **Alert** Interactive dialog boxes, for notifications that require explicit feedback from the user
- **Modal** Modal container dialog, It is displayed at the center of the screen
- **Drawer** Another modal container dialog, It is displayed at the edge of the screen, and it is the better choice for quickly viewing details
- **Message** Silent message notification, displayed in the vertical center area of the screen
- **Toast** Silent message notification, displayed in the corner of the screen
- **Mask** A screen mask that blocks user actions

If you are using vue 2.x version, please use [v-dialogs 2.x](https://github.com/TerryZ/v-dialogs/tree/dev-vue-2) version instead

## Examples and Documentation

Documentation and examples please visit below sites

- [Github pages](https://terryz.github.io/docs-vue3/dialog/)

## Features

- Simple style, makes it easier to apply in more UI
- Provides 6 types of dialogs: **Modal**, **Drawer**, **Alert**, **Message**, **Mask** and **Toast**
- Command-based call pop-up dialogs
- **Modal** and **Drawer** provide `DialogModalBox` and `DialogDrawerBox` component form
- **Alert**, **Message** and **Toast** types provides message type quick access function
- Built-in 5 languages: `Chinese`, `English`, `Japanese`, `Portuguese` and `Turkish`
- Globally instance(not recommended)

## Installation

```sh
# npm
npm i v-dialogs
# yarn
yarn add v-dialogs
# pnpm
pnpm add v-dialogs
```

## API

```ts
type MessageContent = string | VNode
type ComponentResult = VNode | Component
type ComponentContent = ComponentResult | (() => ComponentResult)

function DialogAlert(
  message?: MessageContent,
  callback?: Function,
  options?: AlertOptions
): Function
function DialogMessage(
  message?: MessageContent,
  callback?: Function,
  options?: MessageOptions
): Function
function DialogToast(
  message?: MessageContent,
  callback?: Function,
  options?: ToastOptions
): Function
function DialogMask(
  message?: MessageContent,
  callback?: Function,
  options?: MaskOptions
): Function
function DialogModal(
  component: ComponentContent,
  options?: ModalOptions
): Function
function DialogDrawer(
  component: ComponentContent,
  options?: DrawerOptions
): Function
```

## Usage

### Confirm and Message

```ts
import { DialogAlert, DialogAlertConfirm, DialogMessage } from 'v-dialogs'

function deleteUser (userId) {
  const message = 'Deleted data cannot be recovered, are you sure?'
  const handleConfirm = () => {
    executeDeleteUser(userId).then(() => {
      DialogMessage('Delete complete.', { messageType: 'success' })
    })
  }
  DialogAlert(message, handleConfirm, { messageType: 'confirm' })
  // or use quick access way
  // DialogAlertConfirm(message, handleConfirm)
}
```

### Modal dialog

```ts
import { DialogModal, DialogAlert } from 'v-dialogs'
import UserProfile from './UserProfile.vue'

DialogModal(UserProfile, {
  width: 900,
  height: 600,
  title: 'User Profile',
  params: {
    userId: 1,
    userName: 'Terry Zeng'
  },
  callback: (name: string, data: unknown[]) => {
    // close Modal dialog and return data
    if (name === 'close') {
      DialogAlert(`Received message: ${data?.[0]}`)
    }
  }
})
```

### Component form

```vue
<template>
  <div>
    <DialogDrawerBox v-model:visible="visible" >
      <UserProfile />
    </DialogDrawerBox>

<button
      type="button"
      @click="openDialog"
    >Open Drawer</button>
  </div>
</template>

<script setup>
import { ref } from 'vue'
import { DialogDrawerBox } from 'v-dialogs'

import UserProfile from './UserProfile.vue'

const visible = ref(false)

function openDialog () {
  visible.value = true
}
</script>
```

### Fetch data

A example for fetch data scenario

```ts
import { DialogMask, DialogMessageSuccess, DialogAlertError } from 'v-dialogs'

function loadDataList () {
  const destroy = DialogMask()

fetchData()
    .then(data => {
      list.value = data.list
      // Dismiss mask overlay
      destroy()
      DialogMessageSuccess('Data loaded successfully')
    })
    .catch(() => {
      DialogAlertError('Data Load Failure')
    })
}
```

### Message type quick access

**Alert**, **Message** and **Toast** types provides message type quick access function

```ts
import {
  DialogMessage
  DialogMessageSuccess
} from 'v-dialogs'

DialogMessageSuccess('Saved successfully!')
// Equivalent to
DialogMessage('Saved successfully!', { messageType: 'success' })
```

## Globally instance

`v-dialogs` also provides a globally instance to open dialogs, you can use it in any component

The default instance name is `$dlg`

```js
import { createApp } from 'vue'
import dialogs from 'v-dialogs'
import App from 'App.vue'

createApp(App).use(dialogs).mount('#app')
```

> The global instance are only supported as a feature and are not recommended for use

### Option API

```js
export default {
  mounted () {
    this.$dlg.message('Saved successfully!')
  }
}
```

### Composition API

```js
import { getCurrentInstance } from 'vue'

// const $dlg = getCurrentInstance().appContext.config.globalProperties.$dlg
const $dlg = getCurrentInstance().proxy.$dlg

$dlg.message('Saved successfully!')
```