@codehesion-za/headless

Codehesion Headless Library for React

Requirements

This package has a few requirements to be used.

• Node: >= 16
• Formik: >= 2.2.9
• Zod: >= 3.20.2
• Zod-Formik-Adapter: >= 1.2.0

How to install

Run the one of the following commands to install the package

npm i -E @codehesion-za/headless

yarn add -E @codehesion-za/headless

pnpm i -E @codehesion-za/headless

To get the minimal tailwind to work you have to add the project into your tailwind.config.js content array

content: ['node_modules/@codehesion-za/headless/**/*.{js,jsx,ts,tsx}'];

Components

• Formik Base
  • Button
  • Checkbox
  • Drop File Input
  • File Input
  • Form
  • Form Error
  • Radio Button
  • Switch
  • Text Input
• Flat List

Hooks

• useModal

Preview

This app is deployed to Render.com so you can view the ladle stories for the components.

Deployed to: https://react-headless.onrender.com/

Versioning

We use changeset to log changes and handle version bumps.

Logging changes

At any point during development you can run the following command:

yarn changeset

The above command will prompt the user to create a changelog entry. Once completed, a [git tracked] file will be created. A new file is added to the changeset directory each time the command is executed and completed.

Releasing a new version

Once ready to release a new version of the package, run the following command:

yarn changeset version

The above command will consume all unapplied changesets (and delete the files), updating the CHANGELOG.md file.