Skip to content

fix README.md #245

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix README.md #245

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ function DateInput(props) {
| Name | Type | Default | Description |
| :-----------------------------------------: | :-------------------------: | :-----: | :--------------------------------------------------------------------- |
| **[`mask`](#mask)** | `{String\|Array<String, RegExp>}` | | Mask format |
| **[`maskPlaceholder`](#maskplaceholder)** | `{String}` | `_` | Placeholder to cover unfilled parts of the mask |
| **[`maskChar`](#maskphar)** | `{String}` | `_` | Placeholder to cover unfilled parts of the mask |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maskphar --> maskchar

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually it's maskChar that got replaced with maskPlaceholder.

| **[`alwaysShowMask`](#alwaysshowmask)** | `{Boolean}` | `false` | Whether mask prefix and placeholder should be displayed when input is empty and has no focus |
| **[`beforeMaskedStateChange`](#beforemaskedstatechange)** | `{Function}` | | Function to modify value and selection before applying mask |
| **[`children`](#children)** | `{ReactElement}` | | Custom render function for integration with other input components |
Expand Down Expand Up @@ -69,16 +69,16 @@ return <InputMask mask={mask} />;
```


### `maskPlaceholder`
### `maskChar`
```jsx
// Will be rendered as 12/--/--
<InputMask mask="99/99/99" maskPlaceholder="-" value="12" />
<InputMask mask="99/99/99" maskChar="-" value="12" />

// Will be rendered as 12/mm/yy
<InputMask mask="99/99/99" maskPlaceholder="dd/mm/yy" value="12" />
<InputMask mask="99/99/99" maskChar="dd/mm/yy" value="12" />

// Will be rendered as 12/
<InputMask mask="99/99/99" maskPlaceholder={null} value="12" />
<InputMask mask="99/99/99" maskChar={null} value="12" />
```
Character or string to cover unfilled parts of the mask. Default character is "\_". If set to `null` or empty string, unfilled parts will be empty as in a regular input.

Expand Down Expand Up @@ -114,7 +114,7 @@ function beforeMaskedStateChange({ nextState }) {
};
}

return <InputMask mask="99/99/99" maskPlaceholder={null} beforeMaskedStateChange={beforeMaskedStateChange} />;
return <InputMask mask="99/99/99" maskChar={null} beforeMaskedStateChange={beforeMaskedStateChange} />;
```

Please note that `beforeMaskedStateChange` executes more often than `onChange` and must be pure.
Expand Down