formik-mui-fields 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Wadii Basmi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,192 @@
+# @repo/formik-fields
+
+Formik-connected [MUI](https://mui.com/) form field components. Each component wraps an MUI input, wires it to Formik via `useField`, and automatically handles value binding, change/blur events, and validation error display.
+
+## Installation
+
+This is a private internal package. Install peer dependencies in your consuming app:
+
+```bash
+npm install @mui/material formik react react-dom
+```
+
+## Components
+
+### FormikTextField
+
+Text input bound to Formik. Passes through all MUI `TextFieldProps`.
+
+```tsx
+<FormikTextField name="email" label="Email" type="email" />
+```
+
+### FormikSelect
+
+Dropdown select with an `options` array. Passes through MUI `SelectProps`.
+
+```tsx
+<FormikSelect
+  name="country"
+  label="Country"
+  options={[
+    { value: "us", label: "United States" },
+    { value: "fr", label: "France" },
+  ]}
+/>
+```
+
+### FormikAutocomplete
+
+Generic autocomplete. Accepts a type parameter for option shape.
+
+```tsx
+<FormikAutocomplete
+  name="user"
+  label="User"
+  options={users}
+  getOptionLabel={(u) => u.name}
+  isOptionEqualToValue={(a, b) => a.id === b.id}
+/>
+```
+
+### FormikRadioGroup
+
+Radio button group with an `options` array.
+
+```tsx
+<FormikRadioGroup
+  name="plan"
+  label="Plan"
+  options={[
+    { value: "free", label: "Free" },
+    { value: "pro", label: "Pro" },
+  ]}
+  row
+/>
+```
+
+### FormikCheckbox
+
+Checkbox bound to a boolean Formik field. Passes through MUI `CheckboxProps`.
+
+```tsx
+<FormikCheckbox name="agree" label="I agree to the terms" />
+```
+
+### FormikSwitch
+
+Toggle switch bound to a boolean Formik field. Passes through MUI `SwitchProps`.
+
+```tsx
+<FormikSwitch name="notifications" label="Enable notifications" />
+```
+
+### FormikSlider
+
+Range slider. Passes through MUI `SliderProps`.
+
+```tsx
+<FormikSlider name="volume" label="Volume" min={0} max={100} />
+```
+
+### FormikRating
+
+Star rating input. Passes through MUI `RatingProps`.
+
+```tsx
+<FormikRating name="score" label="Rating" max={5} />
+```
+
+### FormikToggleButtonGroup
+
+Exclusive toggle button group with an `options` array. Passes through MUI `ToggleButtonGroupProps`.
+
+```tsx
+<FormikToggleButtonGroup
+  name="alignment"
+  label="Text Alignment"
+  options={[
+    { value: "left", label: "Left" },
+    { value: "center", label: "Center" },
+    { value: "right", label: "Right" },
+  ]}
+  exclusive
+/>
+```
+
+### FormikColorPicker
+
+Color picker using a circular swatch that opens a Chrome-style color picker (via `react-color`).
+
+```tsx
+<FormikColorPicker name="brandColor" label="Brand Color" />
+```
+
+### FormikFontPicker
+
+Google Fonts autocomplete. Fetches font list from `/api/google/fonts` and injects a preview stylesheet for the selected font.
+
+```tsx
+<FormikFontPicker name="fontFamily" label="Font" />
+```
+
+### FormikImageUpload
+
+Drag-and-drop style image upload with optional cropping dialog. Supports configurable aspect ratios (`1.91:1`, `1:1`, `3:1`).
+
+```tsx
+<FormikImageUpload name="avatar" label="Profile Picture" height={150} />;
+
+{
+  /* With cropping enabled */
+}
+<FormikImageUpload
+  name="banner"
+  label="Banner"
+  cropEnabled
+  cropOptions={["1.91:1", "1:1"]}
+/>;
+```
+
+## Usage
+
+All components are designed to be used inside a Formik `<Form>` or `<Formik>` context:
+
+```tsx
+import { Formik, Form } from "formik";
+import {
+  FormikTextField,
+  FormikSelect,
+  FormikCheckbox,
+} from "@repo/formik-fields";
+
+const MyForm = () => (
+  <Formik
+    initialValues={{ name: "", role: "", agree: false }}
+    onSubmit={(values) => console.log(values)}
+  >
+    <Form>
+      <FormikTextField name="name" label="Name" />
+      <FormikSelect
+        name="role"
+        label="Role"
+        options={[
+          { value: "admin", label: "Admin" },
+          { value: "user", label: "User" },
+        ]}
+      />
+      <FormikCheckbox name="agree" label="I agree" />
+      <button type="submit">Submit</button>
+    </Form>
+  </Formik>
+);
+```
+
+## Peer Dependencies
+
+| Package         | Version |
+| --------------- | ------- |
+| `@mui/material` | >= 7    |
+| `formik`        | >= 2    |
+| `react`         | >= 18   |
+| `react-dom`     | >= 18   |