npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@slothworks/vue-use-form

v0.0.3

Published

Use form hook for handling forms and validations for Vue 3 with composition API.

Downloads

3

Readme

vue-use-form

Although we are not planning any big changes, please keep in mind
that this package is still under development and we're developing it as we go
with our internal project. Any suggestions or tips are welcome.

Use form hook for handling forms and validations for Vue 3 with composition API.

Documentation

You can find a related documentation and examples here.

Basic usage


<template>
  <form>
    <input
      v-model="fields['username']"
      v-bind="fieldHelpers['username'].$attrs"
      v-on="fieldHelpers['username'].$listeners"
      label="Username"
    />
    <input
      v-model="fields['password']"
      v-bind="fieldHelpers['password'].$attrs"
      v-on="fieldHelpers['password'].$listeners"
      label="Password"
      type="password"
    />
    <button
      label="Sign in"
      :loading="submitting"
      :disable="submitting"
      @click="signIn"
    />
  </form>
</template>

<script lang="ts">
import { defineComponent } from 'vue'
import { useForm } from '@slothworks/vue-use-form'
import { email, required, minLength } from '@vuelidate/validators'

interface Credentials {
  username: string
  password: string
}

export default defineComponent({
  name: 'SignInForm',
  setup () {
    const {
      fields,
      submitForm,
      submitting,
      fieldHelpers,
    } = useForm<Credentials>({
      model: {
        username: {
          defaultValue: '',
          validations: {
            required,
            email,
          },
        },
        password: {
          defaultValue: '',
          validations: {
            required,
            minLength: minLength(8),
          },
        },
      },
    })

    const signIn = () => submitForm(() => {
        // YOUR SIGN IN ACTION
      },
      (result) => {
        // ACTION ON SUCCESS
      },
      (error) => {
        // ACTION ON ERROR
      },
    )

    return {
      submitting,
      fields,
      fieldHelpers,
      signIn,
    }
  },
})
</script>

API

Exported props:

interface IUseFormReturn<T> {
  // Values
  fields: T
  fieldHelpers: ComputedRef<FieldHelpersType<T>>
  initialValues: ComputedRef<T>
  // State
  isDirty: ComputedRef<boolean>
  isPristine: ComputedRef<boolean>
  submitting: ComputedRef<boolean>
  // Actions
  resetForm: () => void
  validateForm: () => Promise<boolean>
  submitForm: (
    callback: () => Promise<unknown>,
    onDone?: (result: unknown) => unknown,
    onError?: (error: unknown) => unknown,
  ) => Promise<unknown>
  reinitializeForm: (values: Partial<T>) => void
  setFieldValues: (values: Partial<T>) => void
  // Other
  vuelidate: Ref<Validation>
}

Issues

All known issues are tracked here

Links