Skip to content
On this page

useTextDirection

Category
Export Size
1.38 kB
Last Changed
2 months ago

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

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:

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

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

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

Options

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'>

Type Declarations

export declare type UseTextDirectionValue = "ltr" | "rtl" | "auto"
export interface UseTextDirectionOptions extends ConfigurableDocument {
  /**
   * CSS Selector for the target element applying to
   *
   * @default 'html'
   */
  selector?: string
  /**
   * Observe `document.querySelector(selector)` changes using MutationObserve
   *
   * @default false
   */
  observe?: boolean
  /**
   * Initial value
   *
   * @default 'ltr'
   */
  initialValue?: UseTextDirectionValue
}
/**
 * Reactive dir of the element's text.
 *
 * @see https://vueuse.org/useTextDirection
 */
export declare function useTextDirection(
  options?: UseTextDirectionOptions
): WritableComputedRef<UseTextDirectionValue>
export declare type UseTextDirectionValue = "ltr" | "rtl" | "auto"
export interface UseTextDirectionOptions extends ConfigurableDocument {
  /**
   * CSS Selector for the target element applying to
   *
   * @default 'html'
   */
  selector?: string
  /**
   * Observe `document.querySelector(selector)` changes using MutationObserve
   *
   * @default false
   */
  observe?: boolean
  /**
   * Initial value
   *
   * @default 'ltr'
   */
  initialValue?: UseTextDirectionValue
}
/**
 * Reactive dir of the element's text.
 *
 * @see https://vueuse.org/useTextDirection
 */
export declare function useTextDirection(
  options?: UseTextDirectionOptions
): WritableComputedRef<UseTextDirectionValue>

Source

SourceDemoDocs

Contributors

Changelog

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

Released under the MIT License.