# react-license-plate

> A library for displaying license plates

Latest version **1.0.0** (published 2020-10-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-license-plate
pnpm add react-license-plate
yarn add react-license-plate
bun add react-license-plate
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2020-10-30 |
| First published | 2020-10-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 0 |
| Unpacked size | 7.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | AO19 |
| Maintainers | ao19 |
| Keywords | react, typescript, npm, license plate |

## Links

- npm: https://www.npmjs.com/package/react-license-plate
- Repository: https://github.com/AO19/react-license-plate
- Homepage: https://github.com/AO19/react-license-plate#readme
- Issues: https://github.com/AO19/react-license-plate/issues
- npm.io page: https://npm.io/package/react-license-plate

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2020-10-30

## README

# react-license-plate

A simple React component that visualizes a european (for now) license plate with the flag, country code and license plate number (id).

## How to use

`npm install react-license-plate`

You can now import `react-license-plate` like so:

```js
import LicensePlate from 'react-license-plate'
...
```

## Available props

```ts
interface ILicensePlateProps {
  plateColor?: string;
  countryCode: string;
  countryCodeColor?: string;
  plateId: string;
  height: number;
}
```

| Prop             | Default |             Value |
| ---------------- | :-----: | ----------------: |
| plateColor       |  #fff   |               HEX |
| countryCode      |         | max. 3 characters |
| countryCodeColor |  #fff   |               HEX |
| plateId          |         |              Text |
| height           |         |                px |

## Examples

Code:

```js
<LicensePlate
  plateColor="#fff"
  countryCode="D"
  countryCodeColor="#fff"
  plateId="KA-PA 777"
  height={150}
/>
```

Result:

![Example One](./images/exampleGermany.jpg)

Code:

```js
<LicensePlate countryCode="D" plateId="KA-PA 777" height={150} />
```

Result:

![Example One](./images/exampleNetherlands.jpg)

---
_Source: https://npm.io/package/react-license-plate · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._