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

react-input

v4.1.3

Published

Easy forms for React

Downloads

152

Readme

React Input

npm version Build Status Coverage Status npm downloads

Overview

React input is a lightweight, dependency free component for building forms in React without having to think about what happens under the hood. It uses one component and an array of objects that describe the inputs in the form.

Usage

Install the component via npm: npm install react-input.

<Form
  fields={[
    {
      name: 'Email',
      key: 'email',
      type: 'email',
      error: false,
      required: false,
      placeholder: 'Enter an email',
      onChange: value => {
        // handle a changed value on the input
      },
      renderAfter: () => (
        <div>Include an element after the input, which is useful for instructional text or strength meters for passwords</div>
      ),
      renderBefore: () => (
        <div>Include an element before the input</div>
      )
    },
    // additional inputs to include in the form
  ]}
  onChange={state => /* handle form change */ }
  onSubmit={state => /* handle form submit */ }
/>

For a detailed example, see the example project.

Form Props

| Name | Type | Description | Required | Default | |-------------|----------|----------------------------------------------------------|---------- |----------| | fields | array | Array of inputs to include | true | | | labels | boolean | If false, labels are disabled | | true | | isPending | boolean | If true, an .is-pending class is added to the form | | null | | isRejected | boolean | If true, an .is-rejected class is added to the form | | null | | isFulfilled | boolean | If true, an .is-fulfilled class is added to the form | | null |

The isPending, isRejected and isFulfilled props are useful to add different styles to the form for different states.

Form Events

| Event | Description | |--------- |---------------------------------------------------------------------------------------------------------| | onChange | Runs when any input in the form changes. The first parameter is the state of the form after the change. | | onSubmit | Runs when the submit button is clicked. The first parameter is the current state of the form. |

Input Properties and Events

Only text based inputs can be used, e.g., email, text, tel and password.

Properties

| Name | Type | Description | Required | Default | |--------------|----------|---------------------------------|---------- |----------| | key | string | Unique key for the field | true | | | type | string | The type of input | |'text' | | name | string | The name of input | | | | label | boolean | Label for the input field | | true | | required | boolean | Make field required | | true | | error | boolean | Is the input in an error state? | | false | | renderAfter | function | Element to render after the input | | | | renderBefore | function | Element to render before the input | | |

Events

| Event | Description | |--------- |-----------------------------------------------------------------------------| | onChange | Runs when the value of the input changes. The first parameter is the value. |

In addition to the props listed above, all standard HTML input attributes are supported and can be used as props on the inputs.


Copyright 2015 Patrick Burtchaell. Licensed MIT.