direction
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesizeDetect the direction of text: left-to-right, right-to-left, or neutral.
Contents
* [`direction(value)`](#directionvalue)
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 lettera
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 onlyesm. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:npm install direction
In Deno with Skypack:
import {direction} from 'https://cdn.skypack.dev/direction@2?dts'
In browsers with Skypack:
<script type="module">
import {direction} from 'https://cdn.skypack.dev/direction@2?min'
</script>
Use
import {direction} from 'direction'
direction('A') // => 'ltr'
direction('anglais') // => 'ltr'
direction('بسيطة') // => 'rtl'
direction('@') // => 'neutral'
API
This package exports the following identifier:direction
.
There is no default export.direction(value)
Detect the direction of value
(string?
).
Returns 'ltr'
, 'rtl'
, or 'neutral'
.CLI
Usage: direction [options] <words...>
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