https://github.com/andrepolischuk/typographic-arrows
Use real arrows, not alphabetic substitutes
https://github.com/andrepolischuk/typographic-arrows
arrows textr textr-plugins typography
Last synced: about 2 months ago
JSON representation
Use real arrows, not alphabetic substitutes
- Host: GitHub
- URL: https://github.com/andrepolischuk/typographic-arrows
- Owner: andrepolischuk
- License: mit
- Created: 2015-04-20T12:51:25.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2017-04-20T08:49:29.000Z (about 8 years ago)
- Last Synced: 2024-04-26T22:01:53.118Z (about 1 year ago)
- Topics: arrows, textr, textr-plugins, typography
- Language: JavaScript
- Homepage:
- Size: 12.7 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# typographic-arrows [![Build Status][travis-image]][travis-url]
> Use real arrows, not alphabetic substitutes
Micro module for real arrows.
## Install
```sh
npm install --save typographic-arrows
```
## Usage
```js
import arrows from 'typographic-arrows';
arrows('a <- b'); // a ← b
arrows('a -> b'); // a → b
arrows('a <-> b'); // a ↔ b
arrows('a <= b'); // a ⇐ b
arrows('a => b'); // a ⇒ b
arrows('a <=> b'); // a ⇔ b
```
## API
### arrows(input)
#### input
Type: `string`
Text for transform.
## License
MIT
[travis-url]: https://travis-ci.org/andrepolischuk/typographic-arrows
[travis-image]: https://travis-ci.org/andrepolischuk/typographic-arrows.svg?branch=master