0.1.4 • Published 3 years ago
react-doge-numpad v0.1.4
react-doge-numpad
Wow! Such component! Very react! So numpad!
This react component is created by a DOGE lover. No it's nth related to the component itself. I just want to share my love to DOGE to all of you.
This is NOT a joke, this is NOT an assignment of a course. This is a working react component.
This is a Numpad component. I build this becoz I want a react numpad component so badly but MOST of the react numpad components available in the npmjs are apparently some assignments of some programming courses. I give up and I have to build one for myself. And now I want to share it to you all.
Install
npm install --save react-doge-numpad
Usage
import React, { useState } from 'react'
import Numpad from 'react-doge-numpad'
import 'react-doge-numpad/dist/index.css'
const App = () => {
const [value, setValue] = useState("");
return (
<Numpad
label="Label"
value={0}
decimal={true}
max={1000000000000}
min={0}
onChange={(value: number | string) => setValue(`${value}`)}>
<input type="text" value={value} />
</Numpad>
);
}
Parameters
Name | Type | Mandatory | Default | Description |
---|---|---|---|---|
inline | boolean | N | true | By default Numpad is a popup. Setting inline to be true will render the component inline instead of a popup |
label | string | N | "" | Title of the Numpad |
value | number | N | 0 | Default value shown on the Numpad |
decimal | boolean | N | true | Indicate whether the Numpad support decimal |
max | number | N | 1000000000000 | Upper bound of the number |
min | number | N | 0 | Lower bound of the number |
onChange | (value: number/string) => void | N | () => false | Callback for handling event when user press Enter |
renderValue | (value: number/string) => string | N | (value) => String(value) | Custom function for render/format the number (e.g. currency formating) |
children | JSXElement | N | null | Children are required if inline is set to false , meaning the Numpad is shown as a popup. To enable the Numpad user needs to click or press keys on the children element(s). It can be a <input> , a <button> , or whatever React components. |
License
MIT © ShawTim