https://github.com/wooorm/direction
Detect directionality: left-to-right, right-to-left, or neutral
https://github.com/wooorm/direction
direction directionality ltr rtl
Last synced: 15 days ago
JSON representation
Detect directionality: left-to-right, right-to-left, or neutral
- Host: GitHub
- URL: https://github.com/wooorm/direction
- Owner: wooorm
- License: mit
- Created: 2014-06-14T09:13:04.000Z (almost 11 years ago)
- Default Branch: main
- Last Pushed: 2024-10-25T11:13:35.000Z (6 months ago)
- Last Synced: 2025-04-03T15:09:47.380Z (24 days ago)
- Topics: direction, directionality, ltr, rtl
- Language: JavaScript
- Homepage: https://wooorm.com/direction/
- Size: 109 KB
- Stars: 43
- Watchers: 3
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Funding: funding.yml
- License: license
Awesome Lists containing this project
README
# direction
[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
Detect the direction of text: left-to-right, right-to-left, or neutral.
## Contents
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`direction(value)`](#directionvalue)
* [CLI](#cli)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Contribute](#contribute)
* [License](#license)
## What is this?
This package detects whether text is written left-to-right or right-to-left.
## When should I use this?
This is a simple and fast algorithm.
It looks at the first strong left-to-right or right-to-left character (for
example, the letter `a` is LTR, the letter `ى` is RTL).
That’s often enough but might be too naïve as it doesn’t take percentages or so
into account.
## Install
This package is [ESM only][esm].
In Node.js (version 14.14+, 16.0+), install with [npm][]:
```sh
npm install direction
```
In Deno with [`esm.sh`][esmsh]:
```js
import {direction} from 'https://esm.sh/direction@2'
```
In browsers with [`esm.sh`][esmsh]:
```html
import {direction} from 'https://esm.sh/direction@2?bundle'
```
## Use
```js
import {direction} from 'direction'
direction('A') // => 'ltr'
direction('anglais') // => 'ltr'
direction('بسيطة') // => 'rtl'
direction('@') // => 'neutral'
```
## API
This package exports the identifier `direction`.
There is no default export.
### `direction(value)`
Get the direction from a given value.
###### `value`
Value to check (`string`, required).
##### Returns
Direction for `value` (`'ltr'`, `'rtl'`, or `'neutral'`).
## CLI
```txt
Usage: direction [options]
Detect the direction of text: left-to-right, right-to-left, or neutral
Options:
-h, --help output usage information
-v, --version output version number
Usage:
# output directionality
$ direction @
# neutral
# output directionality from stdin
$ echo 'الانجليزية' | direction
# rtl
```
## Types
This package is fully typed with [TypeScript][].
It exports no additional types.
## Compatibility
This package is at least compatible with all maintained versions of Node.js.
As of now, that is Node.js 14.14+ and 16.0+.
It also works in Deno and modern browsers.
## Security
This package is safe.
## Contribute
Yes please!
See [How to Contribute to Open Source][contribute].
## License
[MIT][license] © [Titus Wormer][author]
[build-badge]: https://github.com/wooorm/direction/workflows/main/badge.svg
[build]: https://github.com/wooorm/direction/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/direction.svg
[coverage]: https://codecov.io/github/wooorm/direction
[downloads-badge]: https://img.shields.io/npm/dm/direction.svg
[downloads]: https://www.npmjs.com/package/direction
[size-badge]: https://img.shields.io/bundlephobia/minzip/direction.svg
[size]: https://bundlephobia.com/result?p=direction
[npm]: https://docs.npmjs.com/cli/install
[esmsh]: https://esm.sh
[license]: license
[author]: https://wooorm.com
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[typescript]: https://www.typescriptlang.org
[contribute]: https://opensource.guide/how-to-contribute/