(react) react-hook-form Switch example

Our form elements needs to be usable with react-hook-form
This commit is contained in:
Romain Le Cellier
2023-07-26 16:52:38 +02:00
parent b72d0d5c90
commit e3bf4cadf2
3 changed files with 89 additions and 33 deletions

View File

@@ -99,6 +99,14 @@ In order to control the value of the switch, you can use the `checked` or `defau
<Story id="components-forms-switch--controlled"/>
</Canvas>
## Usage with react-hook-form
You can use this input with [react-hook-form](https://react-hook-form.com/docs)
<Canvas sourceState="shown">
<Story id="components-forms-switch--react-hook-form"/>
</Canvas>
## Props
The props of this component are as close as possible to the native checkbox component. You can see the list of props below.

View File

@@ -1,7 +1,15 @@
import { yupResolver } from "@hookform/resolvers/yup";
import { Meta } from "@storybook/react";
import { useForm } from "react-hook-form";
import * as Yup from "yup";
import React from "react";
import { Switch } from ":/components/Forms/Switch/index";
import { Button } from ":/components/Button";
import {
getFieldState,
getFieldErrorMessage,
onSubmit,
} from ":/tests/reactHookFormUtils";
export default {
title: "Components/Forms/Switch",
@@ -122,6 +130,49 @@ export const Controlled = {
},
};
export const ReactHookForm = () => {
interface SwitchExampleFormValues {
terms: boolean;
}
const switchExampleSchema = Yup.object().shape({
terms: Yup.boolean()
.required()
.oneOf([true], "You have to accept the terms of use"),
});
const { register, handleSubmit, formState } =
useForm<SwitchExampleFormValues>({
defaultValues: {
terms: false,
},
mode: "onChange",
reValidateMode: "onChange",
resolver: yupResolver(switchExampleSchema),
});
return (
<form
style={{
display: "flex",
flexDirection: "column",
gap: "1rem",
width: "400px",
}}
onSubmit={handleSubmit(onSubmit)}
>
<Switch
label="I accept the terms of use"
fullWidth
state={getFieldState("terms", formState)}
text={getFieldErrorMessage("terms", formState)}
{...register("terms")}
/>
<Button fullWidth={true}>Log-in</Button>
</form>
);
};
export const FormExample = {
render: () => {
return (

View File

@@ -1,4 +1,4 @@
import React, { InputHTMLAttributes } from "react";
import React, { InputHTMLAttributes, forwardRef } from "react";
import classNames from "classnames";
import { Field, FieldProps } from ":/components/Forms/Field";
@@ -8,36 +8,33 @@ type Props = InputHTMLAttributes<HTMLInputElement> &
labelSide?: "left" | "right";
};
export const Switch = ({
label,
text,
state,
fullWidth,
labelSide = "left",
...props
}: Props) => {
return (
<label
className={classNames(
"c__checkbox",
"c__switch",
"c__switch--" + labelSide,
{
"c__checkbox--disabled": props.disabled,
"c__switch--full-width": fullWidth,
},
)}
>
<Field text={text} compact={true} state={state} fullWidth={fullWidth}>
<div className="c__checkbox__container">
{label && <div className="c__checkbox__label">{label}</div>}
<div className="c__switch__rail__wrapper">
<input type="checkbox" {...props} />
<div className="c__switch__rail" />
export const Switch = forwardRef<HTMLInputElement, Props>(
(
{ label, text, state, fullWidth, labelSide = "left", ...props }: Props,
ref,
) => {
return (
<label
className={classNames(
"c__checkbox",
"c__switch",
"c__switch--" + labelSide,
{
"c__checkbox--disabled": props.disabled,
"c__switch--full-width": fullWidth,
},
)}
>
<Field text={text} compact={true} state={state} fullWidth={fullWidth}>
<div className="c__checkbox__container">
{label && <div className="c__checkbox__label">{label}</div>}
<div className="c__switch__rail__wrapper">
<input type="checkbox" {...props} ref={ref} />
<div className="c__switch__rail" />
</div>
</div>
</div>
</Field>
</label>
);
};
</Field>
</label>
);
},
);