2.0.0 • Published 4 years ago

formik-semantic-ui-react v2.0.0

Weekly downloads
45
License
Apache-2.0
Repository
github
Last release
4 years ago

GitHub Workflow Status GitHub Workflow Status npm GitHub Repo stars GitHub

formik-semantic-ui-react

Simple wrappers for Formik and Semantic UI React.

Features:

:lock_with_ink_pen: TypeScript ready !!

:fire: Support Formik v2 & Semantic UI React v2 !!

:muscle: Easy to use. Just import form components from formik-semantic-ui-react and set their name prop. All the components will be connected with Formik form !

:v: Handle onChange, onReset, OnSubmit, loading and errors for you.

:sparkles: You can use Semantic Prompt Labels to prompt error by setting errorPrompt prop !!

Example

Code Sandbox (Login Form)

Code Sandbox (Register Form)

import React from 'react';
import { Formik } from 'formik';
import { Form, Input, SubmitButton, ResetButton } from 'formik-semantic-ui-react';

export const LoginForm = (props: any) => {
  const initialValues = {
    email: '',
    password: '',
  };

  return (
    <div>
      <Formik
        initialValues={initialValues}
        onSubmit={ ()=>{ console.log('Form Submit' )} }
      >
        <Form size="large">
          <Input
            name="email"
            placeholder="Email"
            errorPrompt
          />
          <Input
            name="password"
            type="password"
            placeholder="Password"
            errorPrompt
          />
          <SubmitButton fluid primary>
            Login
          </SubmitButton>
          <ResetButton fluid secondary>
            Reset
          </ResetButton>
        </Form>
      </Formik>
    </div>
  );
};

Install

Using npm:

npm i formik-semantic-ui-react

Using Yarn:

yarn add formik-semantic-ui-react

Components

NameProps
CheckboxFieldProps & CheckboxProps & FieldErrorProps
FormFormProps
FieldFieldProps
FormikDebugCSS Style Props
InputFieldProps & InputProps & FieldErrorProps & inputLabel
RadioFieldProps & RadioProps & FieldErrorProps
SelectFieldProps & SelectProps & FieldErrorProps
TextAreaFieldProps & TextAreaProps & FieldErrorProps

Form Button

NamePropsDescription
SubmitButtonButtonPropsIt will trigger formik form onSubmit when on click
ResetButtonButtonPropsIt will trigger formik form onReset when on click

Props

FieldProps

PropertyRequiredTypeDefaultDescription
nameYesstringFormik name property
validateNoFunctionFormik validate property
fastNobooleanfalseUse Formik FastField

inputLabel

You can use inline input label instead of field label.

Just pass string or SemanticShorthandItem<LabelProps> to inputLabel.

FieldErrorProps

PropertyRequiredTypeDefaultDescription
errorPromptNoboolean | ErrorPromptConfigfalsePrompt Error Label

ErrorPromptConfig

PropertyRequiredTypeDefaultDescription
promptNobooleantrueFormik label's prompt property PS. To config basic & color, you have to set prompt to false
basicNobooleanFormik label's basic property
colorNoSemanticCOLORSFormik label's color property
pointingNoboolean | 'above' | 'below' | 'left' | 'right''above'Formik label's pointing property

License

Apache 2.0

2.0.0

4 years ago

1.2.1

4 years ago

1.2.0

4 years ago

1.1.1

4 years ago

1.1.0

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago

0.1.0

4 years ago