Skip to content

useTextDirection

Category
Export Size
821 B
Last Changed
last year

Reactive dir of the element's text.

Demo

This paragraph is in English and correctly goes left to right.


Click to change the direction

Usage

ts
import { useTextDirection } from '@vueuse/core'

const dir = useTextDirection() // Ref<'ltr' | 'rtl' | 'auto'>
import { useTextDirection } from '@vueuse/core'

const dir = useTextDirection() // Ref<'ltr' | 'rtl' | 'auto'>

By default, it returns rlt direction when dir rtl is applied to the html tag, for example:

html
<!--ltr-->
<html> ... </html>

<!--rtl-->
<html dir="rtl"> ... </html>
<!--ltr-->
<html> ... </html>

<!--rtl-->
<html dir="rtl"> ... </html>

Options

ts
import { useTextDirection } from '@vueuse/core'

const mode = useTextDirection({
  selector: 'body'
}) // Ref<'ltr' | 'rtl' | 'auto'>
import { useTextDirection } from '@vueuse/core'

const mode = useTextDirection({
  selector: 'body'
}) // Ref<'ltr' | 'rtl' | 'auto'>

Source

SourceDemoDocs

Contributors

Anthony Fu
iChengbo
Nestor Vera

Changelog

v9.0.0-beta.2 on 7/24/2022
085be - feat: new function (#1678)

Released under the MIT License.