npmpackage.info

Gathering detailed insights and metrics for vf-modal

Other packages similar to vf-modal

@visual-framework/vf-chatbot-modal

1.0.0-beta.2

Visual Framework Chatbot Modal component

Gathering detailed insights and metrics for vf-modal

vf-modal - 0.2.7-next | npmpackage.info

vf-modal

0.2.7-next

MIT

TypeScript

30.02 kB

2.5

Installations

npm install vf-modal

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

14.16.0

NPM Version

6.14.11 Pull Requests

Open

17

Total

37

Closed

9

Merged

11

Issues

Open

0

Total

0

Closed

0

Releases

0.2.12-next

0.2.12-next.1

Updated on Mar 17, 2023

v0.2.11-next

Updated on May 07, 2022

v0.2.10-next

Updated on May 07, 2022

v0.2.5

Updated on Mar 05, 2021

v0.2.4

Updated on Mar 04, 2021

v0.2.2

v0.2.3

Updated on Jan 22, 2021

View All 14 releases

Languages

TypeScript

JavaScript

Vue

Stylus

TypeScript (74.12%)

JavaScript (17.76%)

Vue (5.03%)

Stylus (3.08%)

Developer

odex21

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

23 Stars

110 Commits

20 Branches

1 Contributors

Updated on Nov 30, 2023

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

0.2.7-next

Package Id

vf-modal@0.2.7-next

Unpacked Size

30.02 kB

Size

7.69 kB

File Count

NPM Version

6.14.11

Node Version

14.16.0

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

vf-modal

A simple modal framework for vue3.

only 3KB gzip size

Todo

add tests
build a docs
more demos

Install

1$ npm install vf-modal@next
2$ yarn add vf-modal@next
3

Start

It is compiled to es6 by default. If you need compatibility with lower versions of browsers, you can refer to the following configuration.

Config Webpack or Vue CLI

Vue CLI

1module.exports = {
2  transpileDependencies: ['vf-modal']
3}

Webpack

1module.exports = {
2  modules: {
3    rules: [
4      test: /\.m?js$/,
5      use: {
6        loader: 'babel-loader',
7      },
8      include: [/vf-modal/]
9    ]
10  }
11}

Usage

Create a VfModal

create a file like modal.js

1import { createVfModal, } from 'vf-modal/index'
2import NetError from './modals/NetError.vue'
3import 'vf-modal/dist/index.css'
4
5const { VfModal, Controller } = createVfModal({
6  // define some modals
7  modals: {
8    net: {
9      component: NetError
10    },
11    hello: {
12      component: defineComponent({
13        props: {
14          msg: {
15            default: 'hello',
16            required: true,
17            type: String
18          }
19        },
20        setup (props) {
21          const { msg } = toRefs(props)
22          return <>
23            <p>Hello World</p>
24            <p> msg:{msg.value}</p>
25          </>
26        }
27      })
28    }
29  }
30})
31
32export {
33  VfModal,
34  Controller
35}

import VfModal in App.vue

1<template>
2  <router-view />
3  <vf-modal />
4</template>
5
6<script>
7import {VfModal} from './modal'
8
9export default {
10  name: 'App',
11  components: {
12    VfModal
13  }
14}
15</script>

Open a modal anywhere

1import { Controller } from './modal'
2
3/**
4 * open a modal with key
5 * @param key {ModalKey}
6 * @param opt {
7 *   props: {Record<string, any>} props of the modal component
8 *   zIndex: {number} default is 1
9 *   on: {EventMap} event listener
10 * }
11 * @return {
12 *   renderList: RenderList
13 *   isClosed: () => Promise<void>
14 *   close: () => void
15 * }
16 */
17Controller.open('net')
18const { close, isClosed } = Controller.open('hello', {
19  props: {
20    msg: 'haha'
21  },
22  on: {
23    // like <Component @xxx="function" />
24    xxx: (...args) => {
25      // do something
26    }
27  },
28  // maybe useful when stacking multiple modals
29  zIndex: 10
30})
31
32// ```only``` close the 'hello' modal
33close()
34// ```only``` await the 'hello' modal closed
35isClosed()
36  .then(() => {
37    // do something
38  }) 
39
40
41/**
42* close a modal
43* @param key  key of modal that you would close , if not provided, will close modal directly
44*/
45Controller.close()
46Controller.close('hello')
47
48/**
49* returns a promise that will be resolved when the ```VFModal``` component is invisible
50* that means it will be resolved on the ```onAfterEnter``` hook is triggered.
51*/
52Controller.isClosed()
53  .then(() => {
54    // do something
55  })

More Optiions

create config

modals: The map object of modal.
- type:
```
1interface ModalObj {
2 component: any
3 zIndex?: number
4 props?: Record<string, any>,
5 on?: EventMap
6}
```
- component: vue componet
- zIndex: style z-index, which can be overridden on open
- props: props of component, which can be overridden on open
- on: listener of component, which can be overridden on open
```
1type Handler<T = any> = (event?: T) => void;
2interface EventMap {
3  [ x: string ]: Handler
4}
```
provide: the function called in setup
mask: mask of modal
- clickHandler: the function called when mask is clicked
```
1type clickHandler = (controller: Controller, emiiter: Emitter, instance: VfModal) => void
```
  The emitter can also be obtained in modal through the injection
- autoCloseModal: if true modal will be closed when clicking mask, default is false
- classname: classname for mask, default is 'vf-modal-mask-wrapper'
transition: Vue's transition for modal
- name: Vue's transition name, default is 'vf-modal-fade'
- type: Vue's transition name, default is 'transition'

on: modal open/close hooks

1interface on {
2  modalOpen?: Function
3  modalClose?: Function
4}

multipleModal: control whether the same modal can open multiple
closeWhenRouteChanges: close modal when route changed.
container: the component that wrap the modal, it's classname is 'vf-modal-container-wrapper', default is 'div'

Injections

You can provide your own injection using the provide property in createConfig, but vf-modal also provides an injection with the basic state of current context.

type

1interface VfModalInstanceState {
2  renderList: RenderList
3  close: (key?: string) => void
4  emitter: Emitter
5}

renderList: list of currently rendered modal
close: same close method as provided by the Controller
emitter: a emitter create by mitt

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

53 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-qxrj-hx23-xp82
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-67mh-4wv8-2f99
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-593f-38f6-jp5m
Warn: Project is vulnerable to: GHSA-x2rg-q646-7m2v
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-mv48-hcvh-8jj8
Warn: Project is vulnerable to: GHSA-353f-5xf4-qw67
Warn: Project is vulnerable to: GHSA-64vr-g452-qvp3
Warn: Project is vulnerable to: GHSA-9cwx-2883-4wfx
Warn: Project is vulnerable to: GHSA-vg6x-rcgg-rjx6
Warn: Project is vulnerable to: GHSA-x574-m823-4x7w
Warn: Project is vulnerable to: GHSA-4r4m-qw57-chr8
Warn: Project is vulnerable to: GHSA-xcj6-pq6g-qj4x
Warn: Project is vulnerable to: GHSA-356w-63v5-8wf4
Warn: Project is vulnerable to: GHSA-859w-5945-r5v3
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

2.5

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to vf-modal

Other packages similar to vf-modal

vf-modal

Installations

Developer Guide

No

CommonJS

14.16.0

6.14.11

Pull Requests

17

37

9

11

Issues

0

0

0

Releases

Languages

Developer

odex21

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

vf-modal

A simple modal framework for vue3.

Todo

Install

Start

Usage

Create a VfModal

More Optiions

create config

Injections

10

10

10

0

0

0

0

0

0

0

0

0

0

2.5

/10