form-input-fields 1.0.18 → 1.0.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +43 -43
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  A collection of Material-UI form field components with Formik integration.
4
4
 
5
- **Version 1.0.18**
5
+ **Version 1.0.20**
6
6
 
7
7
  More control in the progress of development.
8
8
 
@@ -232,12 +232,12 @@ The FormTextField component accepts all props from `FormTextFieldProps`, `FieldP
232
232
 
233
233
  #### FormTextFieldProps Interface
234
234
 
235
- | Prop | Type | Default | Description |
236
- | ---------- | ---------------- | ---------- | -------------------------------------------------------------------------------------- | ---------- | --------------------------------- |
237
- | `onChange` | `function` | - | Custom change handler that overrides Formik's |
238
- | `onBlur` | `function` | - | Custom blur handler that overrides Formik's |
239
- | `variant` | `'standard' | 'outlined' | 'filled'` | 'standard' | The variant of the MUI TextField. |
240
- | `sx` | `SxProps<Theme>` | - | The system prop that allows defining system overrides as well as additional CSS styles |
235
+ | Prop | Type | Default | Description |
236
+ | ---------- | -------------------------------------- | ------------ | -------------------------------------------------------------------------------------- |
237
+ | `onChange` | `function` | - | Custom change handler that overrides Formik's |
238
+ | `onBlur` | `function` | - | Custom blur handler that overrides Formik's |
239
+ | `variant` | `'standard' \| 'outlined' \| 'filled'` | `'standard'` | The variant of the MUI TextField. |
240
+ | `sx` | `SxProps<Theme>` | - | The system prop that allows defining system overrides as well as additional CSS styles |
241
241
 
242
242
  #### Common Props (from FieldProps & TextFieldProps)
243
243
 
@@ -360,20 +360,20 @@ The FormDropDownField component accepts all props from `FormDropDownFieldProps`,
360
360
 
361
361
  #### FormDropDownFieldProps Interface
362
362
 
363
- | Prop | Type | Default | Description |
364
- | ---------------- | ----------------------------------------------------- | ------------------------------- | -------------------------------------------------------------------------------------- | ----------------------------------------- | --------------------------------- |
365
- | `items` | `Array<{ id: string | number; description: string }>` | `[]` | Array of items to display in the dropdown |
366
- | `addInputSelect` | `boolean` | `false` | Whether to show a default "Select" option as the first item |
367
- | `selectText` | `string` | `'Select'` | Text to display for the default "Select" option |
368
- | `required` | `boolean` | `false` | Whether the field is required |
369
- | `disabled` | `boolean` | `false` | Whether the field is disabled |
370
- | `className` | `string` | - | Custom class name for the root element |
371
- | `helperText` | `string` | - | Helper text to display below the field |
372
- | `error` | `boolean` | - | Error state of the field (overrides Formik error state) |
373
- | `onChange` | `(value: any) => void` | - | Custom change handler |
374
- | `onBlur` | `(event: React.FocusEvent<HTMLInputElement>) => void` | - | Custom blur handler |
375
- | `variant` | `'standard' | 'outlined' | 'filled'` | 'standard' | The variant of the MUI TextField. |
376
- | `sx` | `SxProps<Theme>` | - | The system prop that allows defining system overrides as well as additional CSS styles |
363
+ | Prop | Type | Default | Description |
364
+ | ---------------- | ------------------------------------------------------ | ------------ | -------------------------------------------------------------------------------------- |
365
+ | `items` | `Array<{ id: string \| number; description: string }>` | `[]` | Array of items to display in the dropdown |
366
+ | `addInputSelect` | `boolean` | `false` | Whether to show a default "Select" option as the first item |
367
+ | `selectText` | `string` | `'Select'` | Text to display for the default "Select" option |
368
+ | `required` | `boolean` | `false` | Whether the field is required |
369
+ | `disabled` | `boolean` | `false` | Whether the field is disabled |
370
+ | `className` | `string` | - | Custom class name for the root element |
371
+ | `helperText` | `string` | - | Helper text to display below the field |
372
+ | `error` | `boolean` | - | Error state of the field (overrides Formik error state) |
373
+ | `onChange` | `(value: any) => void` | - | Custom change handler |
374
+ | `onBlur` | `(event: React.FocusEvent<HTMLInputElement>) => void` | - | Custom blur handler |
375
+ | `variant` | `'standard' \| 'outlined' \| 'filled'` | `'standard'` | The variant of the MUI TextField. |
376
+ | `sx` | `SxProps<Theme>` | - | The system prop that allows defining system overrides as well as additional CSS styles |
377
377
 
378
378
  ### Examples
379
379
 
@@ -1261,33 +1261,33 @@ import { FormMaskField } from 'form-input-fields';
1261
1261
 
1262
1262
  ### Props
1263
1263
 
1264
- | Prop | Type | Default | Description |
1265
- | ------------------ | ---------------- | ---------- | -------------------------------------------------------------------------------------- | ---------- | --------------------------------- |
1266
- | `mask` | `string` | - | Mask pattern using the characters above |
1267
- | `placeholderChar` | `string` | `'_'` | Character shown in placeholder for mask positions |
1268
- | `toUpperCase` | `boolean` | `false` | Convert input to uppercase automatically |
1269
- | `returnCleanValue` | `boolean` | `false` | Return unmasked value to Formik (true) or masked value (false) |
1270
- | `showMaskPattern` | `boolean` | `false` | Show the mask pattern as helper text below the input field |
1271
- | `showPlaceholder` | `boolean` | `false` | Show placeholder text with mask pattern in the input field |
1272
- | `onChange` | `function` | - | Custom change handler with masked, clean, and raw values |
1273
- | `variant` | `'standard' | 'outlined' | 'filled'` | 'standard' | The variant of the MUI TextField. |
1274
- | `sx` | `SxProps<Theme>` | - | The system prop that allows defining system overrides as well as additional CSS styles |
1264
+ | Prop | Type | Default | Description |
1265
+ | ------------------ | -------------------------------------- | ------------ | -------------------------------------------------------------------------------------- |
1266
+ | `mask` | `string` | - | Mask pattern using the characters above |
1267
+ | `placeholderChar` | `string` | `'_'` | Character shown in placeholder for mask positions |
1268
+ | `toUpperCase` | `boolean` | `false` | Convert input to uppercase automatically |
1269
+ | `returnCleanValue` | `boolean` | `false` | Return unmasked value to Formik (true) or masked value (false) |
1270
+ | `showMaskPattern` | `boolean` | `false` | Show the mask pattern as helper text below the input field |
1271
+ | `showPlaceholder` | `boolean` | `false` | Show placeholder text with mask pattern in the input field |
1272
+ | `onChange` | `function` | - | Custom change handler with masked, clean, and raw values |
1273
+ | `variant` | `'standard' \| 'outlined' \| 'filled'` | `'standard'` | The variant of the MUI TextField. |
1274
+ | `sx` | `SxProps<Theme>` | - | The system prop that allows defining system overrides as well as additional CSS styles |
1275
1275
 
1276
1276
  Plus all standard Material-UI TextField props and Formik FieldProps.
1277
1277
 
1278
1278
  #### FormMaskFieldProps Interface
1279
1279
 
1280
- | Prop | Type | Default | Description |
1281
- | ------------------ | ---------------- | ---------- | -------------------------------------------------------------------------------------- | ---------- | --------------------------------- |
1282
- | `mask` | `string` | - | Mask pattern using the characters above |
1283
- | `placeholderChar` | `string` | `'_'` | Character shown in placeholder for mask positions |
1284
- | `toUpperCase` | `boolean` | `false` | Convert input to uppercase automatically |
1285
- | `returnCleanValue` | `boolean` | `false` | Return unmasked value to Formik (true) or masked value (false) |
1286
- | `showMaskPattern` | `boolean` | `false` | Show the mask pattern as helper text below the input field |
1287
- | `showPlaceholder` | `boolean` | `false` | Show placeholder text with mask pattern in the input field |
1288
- | `onChange` | `function` | - | Custom change handler with masked, clean, and raw values |
1289
- | `variant` | `'standard' | 'outlined' | 'filled'` | 'standard' | The variant of the MUI TextField. |
1290
- | `sx` | `SxProps<Theme>` | - | The system prop that allows defining system overrides as well as additional CSS styles |
1280
+ | Prop | Type | Default | Description |
1281
+ | ------------------ | -------------------------------------- | ------------ | -------------------------------------------------------------------------------------- |
1282
+ | `mask` | `string` | - | Mask pattern using the characters above |
1283
+ | `placeholderChar` | `string` | `'_'` | Character shown in placeholder for mask positions |
1284
+ | `toUpperCase` | `boolean` | `false` | Convert input to uppercase automatically |
1285
+ | `returnCleanValue` | `boolean` | `false` | Return unmasked value to Formik (true) or masked value (false) |
1286
+ | `showMaskPattern` | `boolean` | `false` | Show the mask pattern as helper text below the input field |
1287
+ | `showPlaceholder` | `boolean` | `false` | Show placeholder text with mask pattern in the input field |
1288
+ | `onChange` | `function` | - | Custom change handler with masked, clean, and raw values |
1289
+ | `variant` | `'standard' \| 'outlined' \| 'filled'` | `'standard'` | The variant of the MUI TextField. |
1290
+ | `sx` | `SxProps<Theme>` | - | The system prop that allows defining system overrides as well as additional CSS styles |
1291
1291
 
1292
1292
  ### Examples
1293
1293
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "form-input-fields",
3
- "version": "1.0.18",
3
+ "version": "1.0.20",
4
4
  "description": "A customizable form field components built with TypeScript",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.es.js",
@@ -62,7 +62,7 @@
62
62
  "@testing-library/user-event": "^14.6.1",
63
63
  "@types/jest": "^30.0.0",
64
64
  "@types/node": "^24.10.0",
65
- "@types/react": "^19.2.2",
65
+ "@types/react": "^19.2.3",
66
66
  "@types/react-dom": "^19.2.2",
67
67
  "dayjs": "^1.11.19",
68
68
  "eslint-plugin-storybook": "10.0.6",