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

zenform

v0.0.0-rc.3

Published

react form management made easy

Downloads

72

Readme

logo JavaScript Style Guide styled with prettier License: MIT ComVer npm module formats: umd, cjs, and es size gzip size

Installation

  • npm

      npm i -S zenform
  • yarn

      yarn add zenform

Api

zenform has 2 core components

and a few helper components

Form

Form is top most component, all other components should be its child.

Form Props

  • onSubmit: ({ values: Object, changeSet: Object, formActions: FormActions }) => void
  • initialValues?: Object
  • validations?: (values: Object) => void | Object | Promise<*>
  • validateOnChange?: boolean
  • validateOnBlur?: boolean

To render the form , it takes either a function as render prop or child as a function.
This function will have form render props as arguments.

Form Render Props

  • values: Object
  • handleSubmit: (event?: SyntheticEvent<HTMLFormElement>) => void
  • resetForm: () => void
  • errors: Object
  • touched: Object
  • data: Object
  • activeField: string
  • isDirty: boolean
  • isInvalid: boolean
  • initialValues: Object
  • setFieldValue: (field: string, value: any) => void
  • setMultipleFieldValues: (fieldValues: Array<{field: string, value: any}>) => void
  • setFieldError: (field: string, error: any) => void
  • setMultipleFieldErrors: (fieldErrors: Array<{field: string, error: any}>) => void
  • setFieldTouched: (field: string, isTouched: boolean) => void
  • setMultipleFieldTouched: (fieldTouched: Array<{field: string, isTouched: boolean}>) => void
  • setFieldData: (field: string, data: any) => void
  • setMultipleFieldData: (fieldData: Array<{field: string, data: any}>) => void
  • setActiveField: (field: string) => void

Field

Field is the actual input component, it should always be a child of Form component.

Field Props

  • name: string
  • format?: (value: any) => any
  • parse?: (value: any) => any
  • allowNull?: boolean
  • value?: any

To render the field , it takes either a component (string or react component) or a function as render prop or child as a function.
This function will have field render props as arguments.

Field Render Prop

  • input: Object

    • name: string
    • value: any
    • onChange: (Event<*>) => void
    • onBlur: (Event<*>) => void
    • onFocus: (Event<*>) => void
  • meta: Object

    • error: any
    • data: any
    • isActive: boolean
    • isTouched: boolean

Field Array

Array Field is a helper component for using multiple array input.

Field Array Props

  • name: string

To render the field array, it takes either a function as render prop or child as a function.
This function will have field array render props as arguments.

Field Array Render Prop

  • fields: Object
    • name: string,
    • arrayValues: any[]
    • forEach: (iterator: (name: string, index: number) => void) => void
    • insert: (index: number, value: any) => void
    • map: (iterator: (name: string, index: number) => any) => any[]
    • move: (from: number, to: number) => void
    • pop: () => void
    • push: (value: any) => void
    • remove: (index: number) => void
    • replace: (index: number, value: any) => void
    • swap: (indexA: number, indexB: number) => void
    • unshift: (value: any) => number

Field Observer

A FieldObserver component observes a given field and provides functions to access onChange, onBlur and onFocus on it.
This component doesn't render anything on the dom.

Field Observer Props

  • name: string
  • onChange?: (fieldObserverData: FieldObserverData) => void
  • onBlur?: (fieldObserverData: FieldObserverData) => void
  • onFocus?: (fieldObserverData: FieldObserverData) => void

where FieldObserverData is an object containing

  • name: string
  • value: any
  • formValues: Object
  • data: any
  • isActive: any
  • isTouched: boolean
  • setFieldValue: (field: string, value: any) => void
  • setMultipleFieldValues: (fieldValues: Array<{field: string, value: any}>) => void
  • setFieldError: (field: string, error: any) => void
  • setMultipleFieldErrors: (fieldErrors: Array<{field: string, error: any}>) => void
  • setFieldTouched: (field: string, isTouched: boolean) => void
  • setMultipleFieldTouched: (fieldTouched: Array<{field: string, isTouched: boolean}>) => void
  • setFieldData: (field: string, data: any) => void
  • setMultipleFieldData: (fieldData: Array<{field: string, data: any}>) => void
  • setActiveField: (field: string) => void

Form Observer

A FormObserver component observes values of the whole form and provides functions to access onChange on it.
This component doesn't render anything on the dom.

Form Observer Props

  • onChange?: (formObserverData: FormObserverData) => void

where FormObserverData is an object containing

  • values: Object
  • setFieldValue: (field: string, value: any) => void
  • setMultipleFieldValues: (fieldValues: Array<{field: string, value: any}>) => void
  • setFieldError: (field: string, error: any) => void
  • setMultipleFieldErrors: (fieldErrors: Array<{field: string, error: any}>) => void
  • setFieldTouched: (field: string, isTouched: boolean) => void
  • setMultipleFieldTouched: (fieldTouched: Array<{field: string, isTouched: boolean}>) => void
  • setFieldData: (field: string, data: any) => void
  • setMultipleFieldData: (fieldData: Array<{field: string, data: any}>) => void
  • setActiveField: (field: string) => void

Acknowledgment

License

MIT