react-freemask v1.0.0

Readme

Input Mask bebas berbasis React

FreeMask hanyalah komponen yang menampilkan bidang isian yang serupa dengan Input Mask yang banyak dipahami. Tidak seperti Input Mask, FreeMask tidak (atau belum) menyediakan penanganan dalam penulisan, pengguna bebas menulis sesuai pola yang dibentuk oleh FreeMask.

FreeMask akan lebih efektif digunakan pada kasus isian berpola, namun tidak ketat, misalnya:

... mm > ... minggu

Maka pengguna bebas menuliskan isian minggu dengan 1 atau satu.

Lihat demonya di Storybook.

Pemasangan

# menggunakan yarn
yarn add react-freemask

# atau dengan menggunakan npm
npm i react-freemask

Penggunaan

Impor

import FreeMask from 'react-freemask';
import 'react-freemask/build/css/react-freemask.min.css';

Render

<FreeMask segments={['?size', 'mm']} />

// '?size' artinya isian dengan nama size
// 'mm' artinya teks statis biasa

Penggunaan isian bisa digunakan lebih dari satu.

<FreeMask segments={['?width', 'x', '?height']} />

Menggunakan value & onChange

<FreeMask
  segments={['?size', ' mm']}
  value={{ size: '123' }}
  onChange={value => console.log(value)}
/>

value pada parameter props.onChange memiliki format yang sama dengan props.value.

Menggunakan onKeyDown

<FreeMask segments={['?size', ' mm']} onKeyDown={e => console.log(e)} />

props.onKeyDown memiliki sifat yang sama dengan event pada tag <div> konvensional.

Mengambil nilai dari FreeMask

Nilai yang ada pada FreeMask bisa diambil dengan cara "konvensional" dalam tipe string, yaitu dengan memanfaatkan ref.

const ref = useRef(null); // fitur Hook pada function component (untuk React >= 16.8)
// atau
const ref = createRef(); // pada class component

<FreeMask
  ref={ref}
  segments={['?size', ' mm']}
  value={{ size: 123 }}
  onChange={() => {}}
/>;

// diambil dengan cara ini
// dan mendapatkan nilai "123 mm"
ref.current.value;

Tentu saja, kita harus mengikuti aturan penggunaan ref agar bisa digunakan dengan benar, cek di sini.

Tema

Secara bawaan, tidak ada tema khusus yang digunakan. Berikut beberapa tema minimalis yang bisa digunakan:

Bootstrap

// impor tema
import 'react-freemask/build/css/react-freemask.bootstrap.min.css';

// penggunaan
<FreeMask theme="bootstrap" ... />

Material

// impor tema
import 'react-freemask/build/css/react-freemask.material.min.css';

// penggunaan
<FreeMask theme="material" ... />

Tentu saja kita bisa menggunakan file css tersendiri untuk injeksi style pada komponen, dengan mengimpornya seperti contoh di atas.

Props

FreeMask adalah komponen berbasis <div>, sehingga dapat diinjeksikan props tambahan, misalnya style.

CDN

Bagi pengguna yang masih menggunakan cara lama, bisa memanfaatkan link CDN di bawah ini.

<!-- CSS -->
<link
  rel="stylesheet"
  href="https://unpkg.com/react-freemask/build/css/react-freemask.min.css"
  crossorigin
/>

<!-- Tema -->
<!-- gunakan saat dibutuhkan -->
<link
  rel="stylesheet"
  href="https://unpkg.com/react-freemask/build/css/react-freemask.bootstrap.min.css"
  crossorigin
/>
<!-- atau -->
<link
  rel="stylesheet"
  href="https://unpkg.com/react-freemask/build/css/react-freemask.material.min.css"
  crossorigin
/>

<!-- Javascript -->
<script
  src="https://unpkg.com/react-freemask/build/js/react-freemask.umd.js"
  crossorigin
></script>

Penggunaannya bisa dilihat di GitHub Gist