# nepalify-react

> React Component : Key mapping to Preeti font and Unicode

Latest version **1.0.8** (published 2020-05-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install nepalify-react
pnpm add nepalify-react
yarn add nepalify-react
bun add nepalify-react
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.8 |
| Published | 2020-05-02 |
| First published | 2019-06-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 709.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 14 |
| Maintainers | dipesh429 |
| Keywords | unicode-nepali, preeti, nepalify, nepali-keyboard-react, traditional-preeti, romanized-unicode |

## Links

- npm: https://www.npmjs.com/package/nepalify-react
- Repository: https://github.com/dipesh429/Nepalify
- Homepage: https://github.com/dipesh429/Nepalify#readme
- Issues: https://github.com/dipesh429/Nepalify/issues
- npm.io page: https://npm.io/package/nepalify-react

## Dependencies (2)

- [react](https://npm.io/package/react.md) ^15.5.4
- [webpack](https://npm.io/package/webpack.md) ^4.0.0

## Recent versions

- 1.0.8 (latest) — 2020-05-02
- 1.0.7 — 2020-04-12
- 1.0.6 — 2019-07-27
- 1.0.5 — 2019-06-28
- 1.0.4 — 2019-06-27
- 1.0.3 — 2019-06-27
- 1.0.1 — 2019-06-27
- 1.0.0 — 2019-06-27

## README

# Nepalify-React
[![npm version](https://badge.fury.io/js/nepalify-react.svg)](https://badge.fury.io/js/nepalify-react) [![GitHub contributors](https://img.shields.io/github/contributors/dipesh429/nepalify-react.svg)](https://GitHub.com/dipesh429/nepalify-react/graphs/contributors/)

React library to key map to preeti or unicode. This library provides an `<input type ="text">` input field which converts preeti or unicode typing into nepali texts. Click [here]() for preeti keyboard layout and click [here]() for unicode keyboard layout. The input and output from the library can be seen in the figure below.


![Loading1](https://raw.githubusercontent.com/dipesh429/Nepalify-React/master/screenshot/unicode1.png)
![Loading2](https://raw.githubusercontent.com/dipesh429/Nepalify-React/master/screenshot/unicode2.png)

##### Download using npm (https://www.npmjs.com/package/nepalify-react)
- using npm install by using `npm i nepalify-react`
- using yarn install by using `yarn add nepalify-react`

#### Usage:
```
import React, { Component, Fragment } from 'react';
import Nepali from 'nepalify-react';
    
export class App extends Component {
  render() {
    return (
      <Fragment>
        <Nepali funcname="preetify" />  //For Preeti mapping
        <Nepali funcname="unicodify" />  //For Unicode mapping
      </Fragment>
    );
  }
}
```

#### API Details:

**Nepalify Component**  `import Nepalify from 'nepalify-react'`

| Props | Value | Default | Description |
| --- | --- | --- | --- |
| `funcname`  | `preetify` or `unicodify` | `unicodify` | Which type of key mapping to use. Traditional Unicode mapping or Romanized Unicode Mapping |
| `valueChange`  | callback function. `(event, value) => {}` | `null` | callback function to call instead of react's `onChange` function | 
| `inputType` | `textarea` or `text` | `text` | type of the input field to apply react nepalify for |
| `initialValue` | String | Empty String | Set `intialValue` of input field. |
| `value` | String | Empty String | To be used as controlled input element in combination with `valueChange` |

#### Note:
You can add other props as per your requirements except given in `API` which will be passed to underlying input element.

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