Skip to content

Commit 3db476e

Browse files
IvanIhnatsiukIvanIhnatsiuk
committed
fix: better description for autocomplete and autoSkip
1 parent 86afd67 commit 3db476e

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

‎README.md‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -130,27 +130,27 @@ For applications requiring conditional or more complex formatting, this package
130130

131131
### MaskedTextInput Component - Props
132132

133-
| Prop | Type | Description |
134-
| ----------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- |
135-
| `mask` | `string` | The mask format to be applied to the text input, defining the pattern for formatting. Example: `"[0000] [0000] [0000] [0000]"`. |
136-
| `customNotations` | `Notation[]` | Array of custom notations for the mask format. Each notation object includes: `character`, `characterSet`, and `isOptional`. |
137-
| `allowedKeys` | `string` | A string specifying the characters that are permitted for input. |
138-
| `validationRegex` | `regex string` | A validation regex that runs before applying the mask. |
139-
| `onChangeText` | `(formatted: string, extracted: string) => void` | Callback function triggered on text change. Receives `formattedValue` (with mask) and `extractedValue` (raw input). |
140-
| `onTailPlaceholderChange` | `(tailPlaceholder: string) => void` | Callback function called when the tail placeholder changes, receiving the updated `tailPlaceholder` value. |
141-
| `affinityFormat` | `string[]` | Array of strings for affinity format, used to determine the best mask format based on the input. |
142-
| `autocomplete` | `boolean` | Enables or disables autocomplete for the text input. Default is `true` |
143-
| `autoSkip` | `boolean` | Automatically skips to the next input field when the current one is filled. Default is `false`. |
144-
| `isRTL` | `boolean` | Enables right-to-left (RTL) text direction for the text input. Default is `false`. |
145-
| `affinityCalculationStrategy` | `AFFINITY_CALCULATION_STRATEGY` | Defines the strategy for affinity calculation, determining how the best mask format is selected based on input. |
146-
| `customTransformation` | `CustomTransformation` | Custom transformation applied to the text input to define how the input text should be transformed. |
147-
| `defaultValue` | `string` | The default value for the input field. |
148-
| `value` | `string` | Current value of the input field, allowing controlled input behavior. |
149-
| `allowSuggestions` | `boolean` (iOS only) | Enables or disables input suggestions on iOS. Default is `false`. |
150-
| `autocompleteOnFocus` | `boolean` | Enables autocomplete when the text input is focused. |
151-
| `placeholder` | `string` | Placeholder text displayed in the input. |
152-
| `keyboardType` | `string` | Sets the keyboard type. Useful for numeric masks with `keyboardType="numeric"`. |
153-
| `autoFocus` | `boolean` | If `true`, focuses the input on component load. Default is `false`. |
133+
| Prop | Type | Description |
134+
| ----------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
135+
| `mask` | `string` | The mask format to be applied to the text input, defining the pattern for formatting. Example: `"[0000] [0000] [0000] [0000]"`. |
136+
| `customNotations` | `Notation[]` | Array of custom notations for the mask format. Each notation object includes: `character`, `characterSet`, and `isOptional`. |
137+
| `allowedKeys` | `string` | A string specifying the characters that are permitted for input. |
138+
| `validationRegex` | `regex string` | A validation regex that runs before applying the mask. |
139+
| `onChangeText` | `(formatted: string, extracted: string) => void` | Callback function triggered on text change. Receives `formattedValue` (with mask) and `extractedValue` (raw input). |
140+
| `onTailPlaceholderChange` | `(tailPlaceholder: string) => void` | Callback function called when the tail placeholder changes, receiving the updated `tailPlaceholder` value. |
141+
| `affinityFormat` | `string[]` | Array of strings for affinity format, used to determine the best mask format based on the input. |
142+
| `autocomplete` | `boolean` | Autocompletion allows predictive insertion of constant characters. Default is `true` |
143+
| `autoSkip` | `boolean` | Automatic character skipping works as an "anti-autocompletion", erasing the constant characters (see constant blocks and separators) at the end of the line when hitting backspace. Default is `false`. |
144+
| `isRTL` | `boolean` | Enables right-to-left (RTL) text direction for the text input. Default is `false`. |
145+
| `affinityCalculationStrategy` | `AFFINITY_CALCULATION_STRATEGY` | Defines the strategy for affinity calculation, determining how the best mask format is selected based on input. |
146+
| `customTransformation` | `CustomTransformation` | Custom transformation applied to the text input to define how the input text should be transformed. |
147+
| `defaultValue` | `string` | The default value for the input field. |
148+
| `value` | `string` | Current value of the input field, allowing controlled input behavior. |
149+
| `allowSuggestions` | `boolean` (iOS only) | Enables or disables input suggestions on iOS. Default is `false`. |
150+
| `autocompleteOnFocus` | `boolean` | Enables autocomplete when the text input is focused. |
151+
| `placeholder` | `string` | Placeholder text displayed in the input. |
152+
| `keyboardType` | `string` | Sets the keyboard type. Useful for numeric masks with `keyboardType="numeric"`. |
153+
| `autoFocus` | `boolean` | If `true`, focuses the input on component load. Default is `false`. |
154154

155155
## Cookbook
156156

0 commit comments

Comments
 (0)