iran-license-plate
v0.3.12
Published
A general react component for Iran license plate.
Downloads
187
Maintainers
Readme
Iran Lisence Plate
Iran Lisence Plate is a React Component
based on Typescript
to display Iran car plaque appropriately depending on the serial number.
Features
- ⚛ React Component.
- ☑ Typescript.
- 👌 Validating license serial.
- 🎈 Include free city license plate.
- 📐 Responsive and mobile friendly.
- 🌈 Colorize plate.
Installation
This module is distributed via npm which is bundled with node and should be installed as one of your project's dependencies
:
npm i iran-license-plate
This package also depends on
react
. Please make sure you have it installed as well.
🚨Shortcut: you can see all options by visiting : storybook🚨
Usage
import IranLicensePlate from "iran-license-plate";
import "iran-license-plate/dist/License.css";
function App() {
return (
<div>
<IranLicensePlate serial="IR15-546T55" />
</div>
);
}
Avalilible Params
| property | type | description |
| ----------- | --------------------- | --------------------------------------------------------------------------------------------------------------------- |
| isLoading
| boolean
/undefined
| isshow loading indicator |
| isUnknown
| boolean
/undefined
| preserve unknown situation |
| serial
| string
| the serial number of license plate for all options please visit : https://majidalinejad.github.io/Iran-License-Plate/ |
Contributors
This project follows the all contributors specification. Contributions of any kind welcome!
Documented with :
WIKI PAGE
for more information please visit wiki page
LICENSE
MIT