Skip to content

Commit

Permalink
feat: init vibrary, deprecate old vfm
Browse files Browse the repository at this point in the history
  • Loading branch information
hunterliu1003 committed Jul 16, 2022
1 parent 6ac06bb commit 32239de
Show file tree
Hide file tree
Showing 153 changed files with 13,917 additions and 13,153 deletions.
14 changes: 4 additions & 10 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
# default
dist
types/**/*.d.ts

# docs
docs/.nuxt
docs/docs
docs/static

# example
example/dist
node_modules
docs
coverage
.cache
3 changes: 3 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": "@antfu"
}
16 changes: 10 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
.DS_Store
.vite-ssg-dist
.vite-ssg-temp
*.local
dist
dist-ssr
node_modules
*.swp
*.swo
.idea/
*.log
coverage

dist

!/packages/lib/dist
.cache
docs
9 changes: 9 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"[typescript]": {
"editor.defaultFormatter": "dbaeumer.vscode-eslint"
},
"[vue]": {
"editor.defaultFormatter": "dbaeumer.vscode-eslint"
},
"vitest.commandLine": "pnpm run test"
}
118 changes: 24 additions & 94 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,102 +1,32 @@
# Vue Final Modal
# vue-final-modal

<p align="center"><a href="https://vue-final-modal.org" target="_blank" rel="noopener noreferrer"><img src="https://vue-final-modal.org/preview.png" alt="Vue Final Modal Logo"></a></p>
A published-ready template for Vue 3 components and composable functions library.

<p align="center">
<a href="https://npmcharts.com/compare/vue-final-modal?minimal=true"><img src="https://badgen.net/npm/dm/vue-final-modal" alt="Downloads"></a>
<a href="https://www.npmjs.com/package/vue-final-modal"><img src="https://img.shields.io/npm/l/vue-final-modal.svg?sanitize=true" alt="License"></a>
<a href="https://app.netlify.com/sites/vue-final-modal/deploys"><img src="https://api.netlify.com/api/v1/badges/444b13a8-540f-4438-94da-80c865c8f103/deploy-status" alt="Netlify Status"></a>
</p>
<p align="center">
<a href="https://www.npmjs.com/package/vue-final-modal"><img src="https://badgen.net/npm/v/vue-final-modal" alt="Version"></a>
<a href="https://www.npmjs.com/package/vue-final-modal"><img src="https://badgen.net/badgesize/brotli/hunterliu1003/vue-final-modal/master/dist/VueFinalModal.umd.js" alt="Size"></a>
<a href='https://coveralls.io/github/vue-final/vue-final-modal?branch=master'><img src='https://coveralls.io/repos/github/vue-final/vue-final-modal/badge.svg?branch=master' alt='Coverage Status' /></a>
</p>
<p align="center">
<a href="https://www.npmjs.com/package/vue-final-modal"><img src="https://badgen.net/npm/v/vue-final-modal/next" alt="Version"></a>
<a href="https://www.npmjs.com/package/vue-final-modal"><img src="https://badgen.net/badgesize/brotli/hunterliu1003/vue-final-modal/v3/dist/VueFinalModal.umd.js" alt="Size"></a>
<a href='https://coveralls.io/github/vue-final/vue-final-modal?branch=v3'><img src='https://coveralls.io/repos/github/vue-final/vue-final-modal/badge.svg?branch=v3' alt='Coverage Status' /></a>
</p>
- pnpm
- typescript
- vue 3
- vite
- vitest
- viteplay for documentation
- @vueuse/core

<p align="right">
<a href="https://www.buymeacoffee.com/PL2qJIx" target="_blank" rel="noopener noreferrer">
<img width="200" src="https://cdn.buymeacoffee.com/buttons/v2/default-green.png" alt="Buy Me A Coffee" />
</a>
</p>

## 😎 Looking for a Vue 3 version? [It's over here](https://v3.vue-final-modal.org)

## 🎉 [Documentation](https://vue-final-modal.org)

## 🙌 [Examples](https://vue-final-modal.org/examples/liveDemo)

## Introduction

### **Vue Final Modal** is a **renderless component**!

You can create a `higher-order component` easily and can customize `template`, `script` and `style` based on your needs.

## Features

### Styleless component

try not to pre-define any CSS as much as possible.

### [WindiCSS](https://windicss.org/) friendly

Works well with utility-first CSS framework.

### [Tiny bundle size](https://bundlephobia.com/result?p=vue-final-modal)

### Feature rich

Support `stackable`, `detachable`, `scrollable`, `draggable`, `resizable`, `transition`, `accessibility`, `focusTrap`, `dynamic modal`, etc.

### Supports

`Vue 3`, `Vue 2` and `Nuxt`

## **Contribution**

Steps to run the repo for contribution:
## Scripts

```bash
# Clone repo
git clone https://github.com/vue-final/vue-final-modal.git

# Require Node version 12 or higher
npm i -g pnpm
pnpm i
# Start dev server and rebuild lib on change
pnpm dev

# http://localhost:3000/
# Build lib
pnpm build
# Run unit test
pnpm test
# Run unit test and display test coverage
pnpm coverage
# Lint
pnpm lint
# Clean up all node_modules
pnpm clean
# Run vue-tsc for each repo
pnpm typecheck
```

Thank you to all the people who already contributed to `vue-final-modal`!

<a href="https://github.com/vue-final/vue-final-modal/graphs/contributors">
<img src="https://contrib.rocks/image?repo=vue-final/vue-final-modal" />
</a>

Made with [contributors-img](https://contrib.rocks).

To develop `vue-final-modal`, I learn a lot from these awesome libraries:

- [Vuetify](https://vuetifyjs.com/en/)
- attach
- [Element UI](https://element.eleme.io/)
- stackable modal
- zIndex
- zIndexBase
- [vue-js-modal](https://github.com/euvl/vue-js-modal)
- dynamic modal
- transition
- focusTrap for A11y
- [body-scroll-lock](https://github.com/willmcpo/body-scroll-lock)
- lockScroll
- [vue-resizable](https://github.com/nikitasnv/vue-resizable)
- drag & resize

There is no perfect library even the `final` of vue modal component.

🚀 If you have any ideas for optimization of `vue-final-modal`, feel free to open [issues](https://github.com/hunterliu1003/vue-final-modal/issues) or [pull requests](https://github.com/hunterliu1003/vue-final-modal/pulls).
## Happy coding!!
11 changes: 11 additions & 0 deletions deprecated/.eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# default
dist
types/**/*.d.ts

# docs
docs/.nuxt
docs/docs
docs/static

# example
example/dist
File renamed without changes.
8 changes: 8 additions & 0 deletions deprecated/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
node_modules
*.swp
*.swo
coverage

dist

!/packages/lib/dist
File renamed without changes.
File renamed without changes.
File renamed without changes.
102 changes: 102 additions & 0 deletions deprecated/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
# Vue Final Modal

<p align="center"><a href="https://vue-final-modal.org" target="_blank" rel="noopener noreferrer"><img src="https://vue-final-modal.org/preview.png" alt="Vue Final Modal Logo"></a></p>

<p align="center">
<a href="https://npmcharts.com/compare/vue-final-modal?minimal=true"><img src="https://badgen.net/npm/dm/vue-final-modal" alt="Downloads"></a>
<a href="https://www.npmjs.com/package/vue-final-modal"><img src="https://img.shields.io/npm/l/vue-final-modal.svg?sanitize=true" alt="License"></a>
<a href="https://app.netlify.com/sites/vue-final-modal/deploys"><img src="https://api.netlify.com/api/v1/badges/444b13a8-540f-4438-94da-80c865c8f103/deploy-status" alt="Netlify Status"></a>
</p>
<p align="center">
<a href="https://www.npmjs.com/package/vue-final-modal"><img src="https://badgen.net/npm/v/vue-final-modal" alt="Version"></a>
<a href="https://www.npmjs.com/package/vue-final-modal"><img src="https://badgen.net/badgesize/brotli/hunterliu1003/vue-final-modal/master/dist/VueFinalModal.umd.js" alt="Size"></a>
<a href='https://coveralls.io/github/vue-final/vue-final-modal?branch=master'><img src='https://coveralls.io/repos/github/vue-final/vue-final-modal/badge.svg?branch=master' alt='Coverage Status' /></a>
</p>
<p align="center">
<a href="https://www.npmjs.com/package/vue-final-modal"><img src="https://badgen.net/npm/v/vue-final-modal/next" alt="Version"></a>
<a href="https://www.npmjs.com/package/vue-final-modal"><img src="https://badgen.net/badgesize/brotli/hunterliu1003/vue-final-modal/v3/dist/VueFinalModal.umd.js" alt="Size"></a>
<a href='https://coveralls.io/github/vue-final/vue-final-modal?branch=v3'><img src='https://coveralls.io/repos/github/vue-final/vue-final-modal/badge.svg?branch=v3' alt='Coverage Status' /></a>
</p>

<p align="right">
<a href="https://www.buymeacoffee.com/PL2qJIx" target="_blank" rel="noopener noreferrer">
<img width="200" src="https://cdn.buymeacoffee.com/buttons/v2/default-green.png" alt="Buy Me A Coffee" />
</a>
</p>

## 😎 Looking for a Vue 3 version? [It's over here](https://v3.vue-final-modal.org)

## 🎉 [Documentation](https://vue-final-modal.org)

## 🙌 [Examples](https://vue-final-modal.org/examples/liveDemo)

## Introduction

### **Vue Final Modal** is a **renderless component**!

You can create a `higher-order component` easily and can customize `template`, `script` and `style` based on your needs.

## Features

### Styleless component

try not to pre-define any CSS as much as possible.

### [WindiCSS](https://windicss.org/) friendly

Works well with utility-first CSS framework.

### [Tiny bundle size](https://bundlephobia.com/result?p=vue-final-modal)

### Feature rich

Support `stackable`, `detachable`, `scrollable`, `draggable`, `resizable`, `transition`, `accessibility`, `focusTrap`, `dynamic modal`, etc.

### Supports

`Vue 3`, `Vue 2` and `Nuxt`

## **Contribution**

Steps to run the repo for contribution:

```bash
# Clone repo
git clone https://github.com/vue-final/vue-final-modal.git

# Require Node version 12 or higher
npm i -g pnpm
pnpm i
pnpm dev

# http://localhost:3000/
```

Thank you to all the people who already contributed to `vue-final-modal`!

<a href="https://github.com/vue-final/vue-final-modal/graphs/contributors">
<img src="https://contrib.rocks/image?repo=vue-final/vue-final-modal" />
</a>

Made with [contributors-img](https://contrib.rocks).

To develop `vue-final-modal`, I learn a lot from these awesome libraries:

- [Vuetify](https://vuetifyjs.com/en/)
- attach
- [Element UI](https://element.eleme.io/)
- stackable modal
- zIndex
- zIndexBase
- [vue-js-modal](https://github.com/euvl/vue-js-modal)
- dynamic modal
- transition
- focusTrap for A11y
- [body-scroll-lock](https://github.com/willmcpo/body-scroll-lock)
- lockScroll
- [vue-resizable](https://github.com/nikitasnv/vue-resizable)
- drag & resize

There is no perfect library even the `final` of vue modal component.

🚀 If you have any ideas for optimization of `vue-final-modal`, feel free to open [issues](https://github.com/hunterliu1003/vue-final-modal/issues) or [pull requests](https://github.com/hunterliu1003/vue-final-modal/pulls).
File renamed without changes.
55 changes: 55 additions & 0 deletions deprecated/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
{
"name": "vue-final-modal-monorepo",
"version": "0.0.0",
"description": "Vue Final Modal is a renderless, stackable, detachable and lightweight modal component.",
"main": "index.js",
"scripts": {
"dev": "pnpm -r --parallel run dev",
"test": "pnpm test --filter=vue-final-modal",
"build": "pnpm -r run build",
"clean": "pnpm -r exec -- rm -rf node_modules",
"lint": "eslint -c .eslintrc.js --fix --ext .js,.vue packages",
"lint:diff": "eslint -c .eslintrc.js --fix $(git diff --name-only --diff-filter=ACM HEAD | grep -E '.(js|vue)$' | xargs)"
},
"devDependencies": {
"@vue/eslint-config-prettier": "^6.0.0",
"eslint": "^7.32.0",
"eslint-plugin-prettier": "3.3.1",
"eslint-plugin-vue": "^7.17.0",
"lint-staged": "^10.5.4",
"prettier": "^1.19.1",
"yorkie": "^2.0.0"
},
"gitHooks": {
"pre-commit": "lint-staged"
},
"lint-staged": {
"*.{js,jsx,vue}": [
"pnpm lint:diff"
]
},
"repository": {
"type": "git",
"url": "git+https://github.com/vue-final/vue-final-modal.git"
},
"author": "Hunter Liu",
"license": "MIT",
"bugs": {
"url": "https://github.com/vue-final/vue-final-modal/issues"
},
"homepage": "https://vue-final-modal.org",
"keywords": [
"vue",
"nuxt",
"modal",
"dialog",
"custom-modal",
"vue-final-modal",
"vue-modal",
"vue-dialog",
"vue-component"
],
"dependencies": {
"vue": "^3.2.20"
}
}
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit 32239de

Please sign in to comment.