react-input-date-mask
Version:
Masked input component for React
54 lines (42 loc) • 2.86 kB
Markdown
# react-input-date-mask
Input date masking component for React. React-input-date-mask requires React 16.8.0 or later.
#### [Demo](https://elter1109.github.io/reactInputDateMask/)
# Table of Contents
* [Install](#install)
* [Usage](#usage)
* [Properties](#properties)
* [Examples](#examples)
# Install
```npm install react-input-date-mask --save```
# Usage
```jsx
import React from 'react';
import ReactInputDateMask from 'react-input-date-mask';
function DateInput(props) {
return <ReactInputDateMask mask='dd/mm/yyyy' showMaskOnFocus={true} className={props.className} value={props.value} onChange={props.onChange} showMaskOnHover={true} />;
}
```
# Properties
| Name | Type | Default | Description |
| :-----------------------------------------: | :-------------------------: | :-----: | :--------------------------------------------------------------------- |
| **[`mask`](#mask)** | `{String}` | 'dd.mm.yyyy' | Mask format |
| **[`showMaskOnFocus`](#showMaskOnFocus)** | `{Boolean}` | `false` | If this option - true, the mask will only be displayed when an event occurs onFocus |
| **[`showMaskOnHover`](#showMaskOnHover)** | `{Boolean}` | `false` | If this option - true, when you mouse over the input, the mask appears, when you mouse leave the input, the mask disappears
| **[`className`](#properties)** | `{String}` | | |
| **[`onChange`](#properties)** | `{Function}` | | |
| **[`disabled`](#properties)** | `{Boolean}` | `false` | |
| **[`readOnly`](#properties)** | `{Boolean}` | `false` | |
### `mask`
Mask format. Can be a string. There are two options. The first option by default: 'dd.mm.yyyy'. The second options: 'mm.dd.yyyy'. As a separator, you can use `/` or `.` <br /><br />
```jsx
<ReactInputDateMask mask='mm.dd.yyyy' or <ReactInputDateMask mask='dd.mm.yyyy'
```
```jsx
<ReactInputDateMask mask='mm/dd/yyyy' or <ReactInputDateMask mask='dd/mm/yyyy'
```
### `showMaskOnFocus`
If this option - false, the mask will always be displayed. If this option - true, the mask will only be displayed when an event occurs onFocus
### `showMaskOnHover`
This option is available when the option "showMaskOnFocus" - true. If this option - true, when you mouse over the input, the mask appears, when you mouse leave the input, the mask disappears
### `properties`
You can also pass the following properties: `className`, `disabled`, `readOnly`, `onChange`