frances3006 / checkboxchallenge

CheckboxChallenge

This project is creating a basic Checkbox component.

To install dependencies run in the root folder:

npm install

To run the project in the root folder run:

npm run start
open http://localhost:8080

To run tests, in the root folder, run:

npm run test

To import the component use:

import { Checkbox } from 'PATH_TO_COMPONENTS/checkbox/checbox';

You can render the checkbox with the following props.

<Checkbox labelText={labelName} disabled={false} onChange={checkboxChangeFunction}/>

• labelText is a mandatory string prop for the checkbox label
• disabled is an optional boolean prop that allows the checkbox to be disabled
• onChange optional function prop which provides a callback for when the checkbox is clicked

This project is using Typescript for the components and CSS modules for styling. Tests can be found in test within the checkbox folder.

The tests are configured using Jest and enzyme.