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

@wedgekit/form

v5.0.5

Published

A layout and validation tool for form fields.

Downloads

13

Readme

WedgeKit Form

Install

yarn add @wedgekit/form

Usage

import Form, { Field } from '@wedgekit/form';
// ...

const handleFirstNameValidation = (value) => {
  if (dirtyWords.some((d) => value.includes(d))) {
    return 'DIRTY_WORD';
  }

  return null;
};

const App = (props) => (
  <Form onSubmit={handleSubmit}>
    {({ formProps, dirty, submitting, valid }) => (
      <form {...formProps}>
        <Field
          name="firstName"
          label="First Name"
          defaultValue=""
          validate={handleFirstNameValidation}
        >
          {({ fieldProps }) => <Input {...fieldProps} />}
        </Field>
        <Button domain="primary" type="submit" disabled={!dirty || submitting || !valid}>
          Submit
        </Button>
      </form>
    )}
  </Form>
);

// ...

API

Form

children

  • Type: (FormState) => Node
  • Required: ✅

A renderProp that offers access to the current form state as well as expects formProps to be passed into an HTML form element.

<Form>
  {({ formProps }) => (
    <form {...formProps}>
      // ...
    </form>
  )}

disabled

  • Type: boolean
  • Required: ❌

Disabled will set the entire form to a disabled state.

onSubmit

  • Type: () => ?Object | Promise<?Object> | void
  • Required: ❌

From Final Form Documentation:

Function to call when the form is submitted. There are three possible ways to write an onSubmit function:

  • Synchronously: returns undefined on success, or an Object of submission errors on failure
  • Asynchronously with a callback: returns undefined, calls callback() with no arguments on success, or with an Object of submission errors on failure.
  • Asynchronously with a Promise: returns a Promise<?Object> that resolves with no value on success or resolves with an Object of submission errors on failure. The reason it resolves with errors is to leave rejection for when there is a server or communications error.

Submission errors must be in the same shape as the values of the form. You may return a generic error for the whole form (e.g. 'Login Failed') using the special FORM_ERROR string key.

scrollRef

If used inside of a fixed height container, the ref of the containing element should be passed to the form in the scrollRef prop. This specifies which container to scroll when a form field needs to be brought into view. Default is the window object.

Form State

formProps

  • Type: { ref: Ref<'form'>, onSubmit: () => void, onKeyDown: () => void }

A set of props passed into an HTML form element to manage the state of the form.

disabled

  • Type: boolean

A boolean denoting if the form is currently disabled.

dirty

  • Type: boolean

A boolean denoting if the state of the form is not equal to the state last submitted.

submitting

  • Type: boolean

A boolean denoting if the form is currently being submitted asynchronously.

getValues

  • Type: () => ?Object