feat: use-input-mask

Author: elsangedy

.gitignore

@@ -0,0 +1,68 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# next.js build output
+.next
+.docz
+dist
+build
+
+.DS_Store
+package-lock.json
+yarn.lock

.npmrc

@@ -0,0 +1 @@
+registry=http://registry.npmjs.org/

.prettierrc

@@ -0,0 +1,11 @@
+{
+  "printWidth": 80,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "bracketSpacing": true,
+  "jsxBracketSameLine": false,
+  "proseWrap": "always"
+}

LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright (c) 2019 Kent C. Dodds
+
+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.

README.md

@@ -0,0 +1,62 @@
+# use-input-mask
+
+![MIT License][license-badge]
+[![downloads][downloads-badge]][npmcharts]
+[![PRs Welcome][prs-badge]][prs]
+
+## Installation
+
+```bash
+$ yarn add use-input-mask
+# or
+$ npm i use-input-mask
+```
+
+## Usage
+
+```jsx
+import React from 'react'
+
+import useInputMask from 'use-input-mask'
+
+import { createAutoCorrectedDatePipe } from "text-mask-addons";
+
+const MyDateInput = props => {
+  const input = useRef(null);
+
+  const autoCorrectedDatePipe = createAutoCorrectedDatePipe("dd/mm/yyyy HH:MM");
+
+  const onChange = useInputMask({
+    input,
+    onChange: props.onChange,
+    mask: [/\d/, /\d/, "/", /\d/, /\d/, "/", /\d/, /\d/, /\d/, /\d/],
+    pipe: autoCorrectedDatePipe,
+    keepCharPositions: true
+  });
+
+  return <input {...props} ref={input} onChange={onChange} />;
+};
+
+export default MyDateInput
+```
+
+## Roadmap
+* [ ] tests
+* [ ] ci/cd
+* [ ] semantic-release
+* [ ] docs
+* [ ] all-contributors
+
+## Inspiration
+
+[text-mask](https://github.com/text-mask/text-mask)
+
+## LIENSE
+
+MIT
+
+[license-badge]: https://img.shields.io/npm/l/use-input-mask.svg?style=flat-square
+[downloads-badge]: https://img.shields.io/npm/dm/use-input-mask.svg?style=flat-square
+[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
+[prs]: http://makeapullrequest.com
+[npmcharts]: http://npmcharts.com/compare/use-input-mask

docs/Currency.js

@@ -0,0 +1,42 @@
+import React, { useRef } from 'react'
+
+import useInputMask from '../src'
+
+import { createNumberMask } from 'text-mask-addons'
+
+const CurrencyInput = props => {
+  const input = useRef(null)
+
+  const maskMoney = createNumberMask({
+    prefix: 'R$ ',
+    includeThousandsSeparator: true,
+    thousandsSeparatorSymbol: '.',
+    allowDecimal: true,
+    integerLimit: 9,
+    decimalSymbol: ',',
+    requireDecimal: true,
+  })
+
+  const onChange = useInputMask({
+    input,
+    onChange: props.onChange,
+    mask: value => {
+      const mask = maskMoney(value)
+
+      const decimalsRegex = /,([0-9]{1,2})/
+      const result = decimalsRegex.exec(value)
+
+      if (!!result && result[1].length < 2) {
+        mask.push('0')
+      } else if (!result) {
+        mask.push('00')
+      }
+
+      return mask
+    },
+  })
+
+  return <input {...props} ref={input} onChange={onChange} />
+}
+
+export default CurrencyInput

docs/Currency.mdx

@@ -0,0 +1,64 @@
+---
+name: Currency
+menu: Examples
+---
+
+import { Playground } from 'docz'
+
+import CurrencyInput from './Currency'
+
+# Currency
+
+<Playground>
+  <CurrencyInput
+    onChange={e => console.log(e.target.value)}
+    placeholder="Currency input"
+  />
+</Playground>
+
+## Code
+
+```js
+import React, { useRef } from 'react'
+
+import useInputMask from 'use-input-mask'
+
+import { createNumberMask } from 'text-mask-addons'
+
+const CurrencyInput = props => {
+  const input = useRef(null)
+
+  const maskMoney = createNumberMask({
+    prefix: 'R$ ',
+    includeThousandsSeparator: true,
+    thousandsSeparatorSymbol: '.',
+    allowDecimal: true,
+    integerLimit: 9,
+    decimalSymbol: ',',
+    requireDecimal: true,
+  })
+
+  const onChange = useInputMask({
+    input,
+    onChange: props.onChange,
+    mask: value => {
+      const mask = maskMoney(value)
+
+      const decimalsRegex = /,([0-9]{1,2})/
+      const result = decimalsRegex.exec(value)
+
+      if (!!result && result[1].length < 2) {
+        mask.push('0')
+      } else if (!result) {
+        mask.push('00')
+      }
+
+      return mask
+    },
+  })
+
+  return <input {...props} ref={input} onChange={onChange} />
+}
+
+export default CurrencyInput
+```

docs/Date.js

@@ -0,0 +1,24 @@
+import React, { useRef } from 'react'
+
+import useInputMask from '../src'
+
+import { createAutoCorrectedDatePipe } from 'text-mask-addons'
+
+const DateInput = props => {
+  const input = useRef(null)
+
+  const autoCorrectedDatePipe = createAutoCorrectedDatePipe('dd/mm/yyyy HH:MM')
+
+  const onChange = useInputMask({
+    input,
+    onChange: props.onChange,
+    mask: [/\d/, /\d/, '/', /\d/, /\d/, '/', /\d/, /\d/, /\d/, /\d/],
+    pipe: autoCorrectedDatePipe,
+    placeholder: 'Please enter a date',
+    keepCharPositions: true,
+  })
+
+  return <input {...props} ref={input} onChange={onChange} />
+}
+
+export default DateInput

docs/Date.mdx

@@ -0,0 +1,46 @@
+---
+name: Date
+menu: Examples
+---
+
+import { Playground } from 'docz'
+
+import DateInput from './Date'
+
+# Date
+
+<Playground>
+  <DateInput
+    onChange={e => console.log(e.target.value)}
+    placeholder="Date input"
+  />
+</Playground>
+
+## Code
+
+```js
+import React, { useRef } from 'react'
+
+import useInputMask from 'use-input-mask'
+
+import { createAutoCorrectedDatePipe } from 'text-mask-addons'
+
+const DateInput = props => {
+  const input = useRef(null)
+
+  const autoCorrectedDatePipe = createAutoCorrectedDatePipe('dd/mm/yyyy HH:MM')
+
+  const onChange = useInputMask({
+    input,
+    onChange: props.onChange,
+    mask: [/\d/, /\d/, '/', /\d/, /\d/, '/', /\d/, /\d/, /\d/, /\d/],
+    pipe: autoCorrectedDatePipe,
+    placeholder: 'Please enter a date',
+    keepCharPositions: true,
+  })
+
+  return <input {...props} ref={input} onChange={onChange} />
+}
+
+export default DateInput
+```

docs/Home.mdx

@@ -0,0 +1,34 @@
+---
+name: Home
+route: /
+---
+
+# Getting Started
+
+https://github.com/elsangedy/use-input-mask
+
+https://github.com/text-mask/text-mask
+
+## Install
+
+```bash
+yarn add use-input-mask
+```
+
+## Hook
+
+```js
+import useInputMask from 'use-input-mask'
+
+const onChange = useInputMask({
+  input,
+  onChange,
+  guide,
+  keepCharPositions,
+  mask,
+  pipe,
+  placeholderChar,
+  showMask,
+  initialValue,
+})
+```