Hook Form Semantic — React Hook Form + Semantic UI React components

Production‑ready React Hook Form (RHF) field components built on Semantic UI React. Quickly wire up common inputs — phone, date/time, date ranges, numeric, JSON editor, WYSIWYG, sort, menus — with consistent error handling and semantics that match RHF and Semantic UI.

Highlights

• React 18 + TypeScript, ESM‑only build
• First‑class RHF integration (Controller‑based wiring)
• Semantic UI React props passthrough for familiar DX
• Batteries included: date/time, ranges, numeric, phone, JSON editor, WYSIWYG, sort/menu utilities
• Vite playground for live testing; Vitest + Testing Library for unit tests

Contents

• Installation
• CSS (what to import)
• Quick start
• Components overview (mini examples)
• Playground
• Tests
• Build & publish
• API docs (TypeDoc)
• FAQ

---

Installation

Core peer dependencies (always install in your app)

npm i @karmaniverous/hook-form-semantic react react-dom react-hook-form semantic-ui-react semantic-ui-css
Copy

Install peers per component you use

• Numeric input (HookFormNumeric)
  • react-number-format
• Phone input (HookFormPhone)
  • react-international-phone google-libphonenumber react-responsive
• Date & DateTime (HookFormDatePicker)
  • react-date-picker react-datetime-picker react-calendar react-clock
• Date range & DateTime range (HookFormDateRangePicker)
  • @wojtekmaj/react-daterange-picker @wojtekmaj/react-datetimerange-picker react-calendar react-clock
• RRStack (HookFormRRStack)
  • @karmaniverous/rrstack
• WYSIWYG (HookFormWysiwygEditor)
  • react-draft-wysiwyg draft-js html-to-draftjs draftjs-to-html
• JSON editor (HookFormJsonEditor)
  • vanilla-jsoneditor

Examples

# Phone + Numeric + Date
npm i react-international-phone google-libphonenumber react-responsive react-number-format react-date-picker react-datetime-picker react-calendar react-clock

# Date range
npm i @wojtekmaj/react-daterange-picker @wojtekmaj/react-datetimerange-picker react-calendar react-clock

# WYSIWYG
npm i react-draft-wysiwyg draft-js html-to-draftjs draftjs-to-html

# JSON editor
npm i vanilla-jsoneditor

# RRStack
npm i @karmaniverous/rrstack
Copy

ESM only

• This package ships ESM only. Most modern toolchains (Vite, Next, CRA v5+, Rollup, Webpack 5) work out of the box.

CSS (import what you use)

Add the relevant styles (typically once in your app entry):

import 'semantic-ui-css/semantic.min.css';
// Date/time + calendar
import 'react-date-picker/dist/DatePicker.css';
import 'react-datetime-picker/dist/DateTimePicker.css';
import 'react-calendar/dist/Calendar.css';
import 'react-clock/dist/Clock.css';
// Date range pickers
import '@wojtekmaj/react-daterange-picker/dist/DateRangePicker.css';
import '@wojtekmaj/react-datetimerange-picker/dist/DateTimeRangePicker.css';
// WYSIWYG
import 'react-draft-wysiwyg/dist/react-draft-wysiwyg.css';
// JSON editor (theme optional)
import 'vanilla-jsoneditor/themes/jse-theme-dark.css';
Copy

Only import the styles for components you actually use.

---

Quick start

import { useForm } from 'react-hook-form';
import { Input } from 'semantic-ui-react';
import {
  HookFormField,
  HookFormPhone,
  HookFormDatePicker,
} from '@karmaniverous/hook-form-semantic';

type FormData = { name: string; phone: string; birthDate: Date | null };

export default function Example() {
  const { control, handleSubmit } = useForm<FormData>({
    defaultValues: { name: '', phone: '', birthDate: null },
  });

  return (
    <form onSubmit={handleSubmit(console.log)}>
      <HookFormField<FormData, { value: string }>
        control={Input}
        hookControl={control}
        hookName="name"
        label="Name"
        placeholder="Your name"
      />

      <HookFormPhone<FormData>
        hookControl={control}
        hookName="phone"
        label="Phone"
        phoneDefaultCountry="us"
      />

      <HookFormDatePicker<FormData>
        hookControl={control}
        hookName="birthDate"
        label="Birth date"
      />

      <button type="submit">Submit</button>
    </form>
  );
}
Copy

---

Components overview (mini examples)

All components use RHF Controller wiring and propagate Semantic UI‑style errors. Pass Semantic UI props via the component’s prefixed prop groups (e.g., menu*, dropdown*) or directly where noted.

• HookFormField
  • Generic wrapper for any input/control. Use control={Input} for simple cases or function‑as‑child for custom mapping.
  • Example (function child mapping checked/value):

<HookFormField<MyForm, { checked: boolean }>
  hookControl={control}
  hookName="subscribed"
  label="Subscribed"
>
  {(field) => (
    <input
      type="checkbox"
      checked={!!(field as { checked?: boolean }).checked}
      onChange={(e) => field.onChange(e, { checked: e.currentTarget.checked })}
    />
  )}
</HookFormField>
Copy

• HookFormNumeric
  • Numeric input using react-number-format with Semantic UI Input.
  • Example:

<HookFormNumeric<MyForm>
  hookControl={control}
  hookName="age"
  label="Age"
  numericAllowNegative={false}
  numericDecimalScale={0}
/>
Copy

• HookFormPhone
  • International phone input using react-international-phone with validation via google-libphonenumber.
  • Example:

<HookFormPhone<MyForm>
  hookControl={control}
  hookName="phone"
  label="Phone"
  phoneDefaultCountry="us"
/>
Copy

• HookFormDatePicker
  • Single date with optional “Include Time” toggle (react-date-picker / react-datetime-picker).
  • Example:

<HookFormDatePicker<MyForm>
  hookControl={control}
  hookName="birthDate"
  label="Birth date"
/>
Copy

• HookFormDateRangePicker
  • Date or datetime ranges with presets.
  • Utilities exported: defaultPresets, filterPresets, extractTimestamps.
  • Example:

import {
  HookFormDateRangePicker,
  defaultPresets,
  filterPresets,
} from '@karmaniverous/hook-form-semantic';

<HookFormDateRangePicker<MyForm>
  hookControl={control}
  hookName="range"
  label="Range"
  presets={filterPresets(['past', 'present'], defaultPresets)}
/>;
Copy

• HookFormMenu / HookFormMenuDisplayMode
  • Menu selection control; the DisplayMode variant ships a prebuilt “Cards/Table” selector.

<HookFormMenuDisplayMode<MyForm> hookControl={control} hookName="mode" />
Copy

• HookFormSort
  • Dropdown + button to manage [field, ascending] tuple semantics.

<HookFormSort<MyForm>
  hookControl={control}
  hookName="sort"
  label="Sort"
  dropdownOptions={[
    { key: 'name', text: 'Name', value: 'name' },
    { key: 'date', text: 'Date Created', value: 'date' },
  ]}
/>
Copy

• HookFormWysiwygEditor
  • Rich text editor (react-draft-wysiwyg); returns HTML string to RHF.

<HookFormWysiwygEditor<MyForm>
  hookControl={control}
  hookName="content"
  label="Content"
/>
Copy

• HookFormJsonEditor
  • Vanilla JSON Editor integration; accepts/returns either JSON object or text.

<HookFormJsonEditor<MyForm>
  hookControl={control}
  hookName="jsonData"
  label="JSON"
/>
Copy

---

Playground

A Vite playground is included for quick browser testing with HMR.

npm run dev       # http://localhost:5173
npm run preview   # production preview
Copy

The playground imports components directly from src/ (no publish needed). See playground/src/App.tsx.

---

Tests

Vitest + Testing Library + jest-dom in a happy-dom environment.

npm run test        # run once with coverage (v8)
npm run test:watch  # watch mode
npm run test:ui     # Vitest UI
Copy

---

Build & publish

npm run build   # ESM modules to dist/mjs + types to dist/index.d.ts
Copy

Externalized peer deps: react, react-dom, react/jsx-runtime, and others listed in package.json (install in your app).

Optional release automation (release‑it) is configured. See scripts in package.json.

---

API docs (TypeDoc)

npm run docs
Copy

Outputs static docs in docs/ (config in typedoc.json). Hosted docs: docs.karmanivero.us/hook-form-semantic

---

FAQ

• Why ESM only?
  • Smaller surface area and simpler builds. Most modern bundlers work natively.
• Do I need all peer dependencies?
  • No. Install the peers for only the components you use (see “Install peers per component”).
• Styling?
  • Import Semantic UI CSS and any widget CSS you use (date pickers, WYSIWYG, JSON editor).

---

Built for you with ❤️ on Bali! Find more great tools & templates on my GitHub Profile.