Skip to content

martinszeltins/regle

ย 
ย 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

regle cover

npm version npm download npm download

Regle

Regle \สษ›ษกl\ (French word for 'rule' ) is a Typescript-first model-based form validation library for Vue 3. It's heavily inspired by Vuelidate.

๐Ÿ“š Documentation

Documentation

๐ŸŽฎ Play with it

Simple demo Advanced Demo
Open in StackBlitz TODO

๐Ÿงฐ Features

  • โœ… Typescript first
  • ๐Ÿค– 100% type inference
  • ๐Ÿ“– Model based validation
  • ๐Ÿช— Extensible
  • ๐Ÿฆธโ€โ™‚๏ธ Zod support
  • ๐Ÿชถ Light (~6kb gzip)
  • ๐Ÿ›’ Collection validation

Compatibility:

  • vue Vue 3.3+
  • nuxt Nuxt 3
  • pinia Pinia

โ˜‘๏ธ Roadmap

For v1.0

  • Unit tests
  • E2E tests
  • Example repo, Reproduction repl
  • Type tests

Next iterations

  • Valibot support
  • Yup support
  • TS docs

๐Ÿค” Maybe in roadmap

  • Typed plugin system (like scrollToError)

โฌ‡๏ธ Quick install

pnpm install @regle/core @regle/rules
# or
yarn add @regle/core @regle/rules
# or
npm install @regle/core @regle/rules

๐Ÿ“‘ License

MIT License

About

๐Ÿ“ Typescript first model-based form validation library for Vue 3

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 89.5%
  • Vue 9.9%
  • JavaScript 0.6%