@zecos/inputs-basic v0.0.13

@zecos/inputs-basic

@zecos/inputs-basic is a library for quickly creating form fields for rapid prototyping.

@zecos/inputs-basic is based on the @zecos/inputs library, which allows you to create your own UI input components with minimal boilerplate.

Installation

yarn add @zecos/inputs-basic

npm i -S @zecos/inputs-basic

Example

import React from "react"
import { nameValidator } from "@zecos/validators"
import { Text, TextArea, Select } from "@zecos/inputs-basic"

export const InputForm = () => {
  const {FirstName, firstNameState} = Text({
    validate: nameValidator,
    name: "firstName"
  })

  const {DescribeYourself, describeYourselfState} = TextArea({
    name: "describeYourself"
  })
  
  const {FavoriteColor, favoriteColorState} = Select({
    init: "blue",
    name: "favoriteColor",
  })

  return (
    <form className="form">
      {/* These are your inputs */}
      <FirstName />
      <DescribeYourself />
      <FavoriteColor options={{Blue: "blue", Red: "red"}}/>

      {/* display the data */}
      First Name State: {firstNameState.value}<br />
      Describe Yourself: {describeYourselfState.value}<br />
      Favorite Color: {favoriteColorState.value}
    </form>
  )
}

How it works

You pick an input type:

• Text
• TextArea
• Select

Then pass it its options:

name: string: will determine the classname, label, etc. THIS MUST BE CAMEL CASE. validate?: fn => Error: an optional function to return an array of errors to display. Do not throw the errors. This works seamlessly with the @zecos/validators library.

• init?: string | number: an optional initial value for the field. The default is "".

All together, for a text input, it looks like this:

const [FirstName, firstNameState, firstNameActions] = text({
  validate: nameValidator,
  name: "firstName"
})

This returns an array of 3 values:

• 0: the input component ()
• 1: the field state, which includes:
  • value: value of the field
  • touched: whether or not the user has focused and blurred the input
  • errors: the errors returned by your validate function
  • pristine: whether or not the field data has been manipulated

• 2: the field actions, which include:

  • getState: returns the same thing as 1
  • setValue: set the value of the field (also runs validation and sets pristine to false)
  • reset: sets the field back to its original state (pristine, untouched, with the original init values)
  • setTouched: set the touched value to true

So, you see, you can manipulate the field data yourself, but it also manages the field data for you.

The component can then be used as your input with no additional setup:

<FirstName />

This is very powerful and enables you to eliminate a lot of the boilerplate of writing forms while maintaining flexibility.

You can rapidly prototype your forms, and, when you outgrow and need more customization, it's very easy to write your own library with @zecos/inputs.