Skip to content

Commit

Permalink
update setup
Browse files Browse the repository at this point in the history
  • Loading branch information
anbraten committed Mar 26, 2024
1 parent 5a361c1 commit 25348c6
Show file tree
Hide file tree
Showing 7 changed files with 995 additions and 297 deletions.
27 changes: 8 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Former
# 👩🏾‍🌾 Former

Vaul Vue is an unstyled drawer component for Vue that can be used as a Dialog replacement on tablet and mobile devices.
It uses [Radix Vue's Dialog primitive](https://www.radix-vue.com/components/dialog.html) under the hood and is a feature complete port of [Emil Kowalski's Vaul library](https://github.com/emilkowalski/vaul) (built for React).
Former is a library to create [FormKit](https://formkit.com/) forms using an UI.

## Playground

Expand All @@ -10,39 +9,29 @@ Create and test your own form at [playground](https://geprog.github.io/former).
## Installation

```bash
pnpm add vaul-vue
pnpm add former-ui
```

```bash
npm install vaul-vue
npm install former-ui
```

```bash
yarn add vaul-vue
yarn add former-ui
```

## Usage

```vue
<script setup lang="ts">
import { DrawerContent, DrawerOverlay, DrawerPortal, DrawerRoot, DrawerTrigger } from 'vaul-vue'
import { FormBuilder, FormBuilderOptions } from 'former-ui'
</script>
<template>
<DrawerRoot>
<DrawerTrigger> Open </DrawerTrigger>
<DrawerPortal>
<DrawerOverlay />
<DrawerContent>
<p>Content</p>
</DrawerContent>
</DrawerPortal>
</DrawerRoot>
<!-- TODO -->
</template>
```

## Credits

All credits go to these open-source works and resources

-
- https://github.com/formkit/formkit
12 changes: 6 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@
"lint:fix": "eslint . --fix",
"test": "pnpm -r test",
"release": "pnpm -r release && changeset publish",
"build:package": "pnpm --filter vaul-vue build-only",
"build:package": "pnpm --filter former-ui build-only",
"build:playground": "pnpm build:package && pnpm --filter playground build"
},
"devDependencies": {
"@antfu/eslint-config": "^2.6.4",
"@antfu/eslint-config": "^2.9.0",
"@changesets/cli": "^2.27.1",
"@playwright/test": "^1.41.2",
"@rushstack/eslint-patch": "^1.3.3",
"@vue/eslint-config-typescript": "^12.0.0",
"eslint": "^8.56.0",
"@playwright/test": "^1.42.1",
"@rushstack/eslint-patch": "^1.8.0",
"@vue/eslint-config-typescript": "^13.0.0",
"eslint": "^8.57.0",
"prettier": "^3.2.5"
}
}
9 changes: 0 additions & 9 deletions packages/former/README.md

This file was deleted.

1 change: 1 addition & 0 deletions packages/former/README.md
14 changes: 0 additions & 14 deletions packages/former/index.html

This file was deleted.

63 changes: 50 additions & 13 deletions packages/former/package.json
Original file line number Diff line number Diff line change
@@ -1,28 +1,65 @@
{
"name": "formkit-app",
"private": true,
"version": "0.0.0",
"name": "former-ui",
"type": "module",
"version": "0.0.1",
"repository": "https://github.com/geprog/former",
"keywords": [
"vue",
"vue3",
"formkit",
"formbuilder",
"forms"
],
"exports": {
".": {
"import": "./dist/index.js",
"require": "./dist/index.umd.cjs"
}
},
"main": "./dist/index.umd.cjs",
"module": "./dist/index.js",
"types": "./dist/index.d.ts",
"files": [
"README.md",
"dist"
],
"scripts": {
"dev": "vite",
"build": "vue-tsc && vite build",
"preview": "vite preview"
"build": "run-p type-check \"build-only {@}\" --",
"preview": "vite preview",
"test:unit": "vitest",
"build-only": "vite build",
"type-check": "vue-tsc --build --force",
"lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix --ignore-path .gitignore",
"format": "prettier --write src/",
"release": "pnpm run build-only"
},
"dependencies": {
"@formkit/icons": "latest",
"@formkit/vue": "latest",
"@vueuse/integrations": "^10.9.0",
"autoprefixer": "latest",
"postcss": "latest",
"sortablejs": "^1.15.2",
"tailwindcss": "latest",
"vue": "^3.4.21"
"sortablejs": "^1.15.2"
},
"devDependencies": {
"@formkit/core": "^1.6.0",
"@formkit/icons": "^1.6.0",
"@formkit/vue": "^1.6.0",
"@types/jsdom": "^21.1.6",
"@types/node": "^18.19.3",
"@vitejs/plugin-vue": "^5.0.4",
"@vue/test-utils": "^2.4.3",
"@vue/tsconfig": "^0.5.0",
"autoprefixer": "^10.4.19",
"eslint": "^8.49.0",
"eslint-plugin-vue": "^9.17.0",
"jsdom": "^23.0.1",
"npm-run-all2": "^6.1.2",
"postcss": "^8.4.38",
"tailwindcss": "^3.4.1",
"typescript": "^5.2.2",
"vite": "^5.2.0",
"vue-tsc": "^2.0.6"
"vite-plugin-css-injected-by-js": "^3.3.1",
"vite-plugin-dts": "^3.7.3",
"vitest": "^1.4.0",
"vue": "^3.4.21",
"vue-tsc": "^2.0.7"
}
}
28 changes: 14 additions & 14 deletions playground/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,21 @@
"test": "pnpm run test:e2e"
},
"dependencies": {
"@geprog/vue-formkit-schema-wizard": "workspace:*",
"vue": "^3.4.5",
"vue-router": "4"
"former-ui": "workspace:*",
"vue": "^3.4.21",
"vue-router": "^4.3.0"
},
"devDependencies": {
"@tsconfig/node18": "^18.2.2",
"@types/node": "^18.19.3",
"@vitejs/plugin-vue": "^4.5.2",
"@vue/tsconfig": "^0.5.0",
"autoprefixer": "^10.4.16",
"npm-run-all2": "^6.1.1",
"postcss": "^8.4.32",
"tailwindcss": "^3.4.0",
"typescript": "~5.3.0",
"vite": "^5.0.10",
"vue-tsc": "^1.8.25"
"@tsconfig/node20": "^20.1.3",
"@types/node": "^20.11.30",
"@vitejs/plugin-vue": "^5.0.4",
"@vue/tsconfig": "^0.5.1",
"autoprefixer": "^10.4.19",
"npm-run-all2": "^6.1.2",
"postcss": "^8.4.38",
"tailwindcss": "^3.4.1",
"typescript": "^5.4.3",
"vite": "^5.2.6",
"vue-tsc": "^2.0.7"
}
}
Loading

0 comments on commit 25348c6

Please sign in to comment.