https://github.com/jsmyanmar/react-mm-text

https://github.com/jsmyanmar/react-mm-text

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/jsmyanmar/react-mm-text
• Owner: jsmyanmar
• License: mit
• Created: 2018-03-02T11:47:46.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-05-05T12:02:03.000Z (over 5 years ago)
• Last Synced: 2024-05-20T03:14:51.775Z (8 months ago)
• Language: JavaScript
• Size: 801 KB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• Awesome-Myanmar - React Myanmar Text

README

        
# React Myanmar Text - [Demo](https://jsmyanmar.github.io/react-mm-text/)

[travis-image]: https://travis-ci.org/jsmyanmar/react-mm-text.svg?branch=master

[travis-url]: https://travis-ci.org/jsmyanmar/react-mm-text

[![Build Status][travis-image]][travis-url]

A small react component library to render unicode standard or zawgyi font.

---

## Installation

Using `npm`

```bash

npm install react-mm-text --save

```

Using `yarn`

```bash

yarn add react-mm-text

```

---

## Usage

```javascript

import React from 'react';

import MMText from 'react-mm-text';

class AppExample extends React.Component {

  render() {

    return (

      


        


          

        

      

    )

  }


}

```

---

## API

### Props

| Prop | Type | Default | Note |

| --- | --- | --- | --- |

| `text` | `String(require)` |  | The plain text for render. |

| `showFont` | `String` | `unicode` | The font type for render. Acceptable values for `showFont` are `unicode` and `zawgyi`. The default is `unicode`. |

| `conveter` | `String` | `rabbit` | The conveter name to convert. Only one of `rabbit` and `knayi` are accept. The default value is `rabbit`. |

| `detector` | `String` | `myanmar-tools` | The detector name to detect font. Only one of `myanmar-tools` and `knayi` are accept. The default value is `myanmar-tools`. |

---

## Todo

  - [ ] Add more docs and contributing guide

  - [ ] Add example

  - [ ] Add more testing details

## License

The [MIT](./LICENSE) licensed.