fargo
1a822493ba
963 markdown files reformatted with the repository's pinned prettier so pnpm format:check covers the folded tree like every other repo file. The formatter's embedded-language pass also normalized code fences (TS semicolons, closed HTML tags in examples, lowercased CSS hex colors, one renumbered list that skipped an index). Alphanumeric token deltas vs the fold commit were audited file-by-file; all are formatter-equivalent markup normalizations plus the four sanitized skills.
1.4 KiB
1.4 KiB
category
| category |
|---|
| Browser |
useTextDirection
Reactive dir of the element's text.
Usage
import { useTextDirection } from '@vueuse/core';
const dir = useTextDirection(); // Ref<'ltr' | 'rtl' | 'auto'>
By default, it returns rtl direction when dir rtl is applied to the html tag, for example:
<!--ltr-->
<html>
...
</html>
<!--rtl-->
<html dir="rtl">
...
</html>
Options
import { useTextDirection } from '@vueuse/core';
const mode = useTextDirection({
selector: 'body',
}); // Ref<'ltr' | 'rtl' | 'auto'>
Type Declarations
export 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
*
* @__NO_SIDE_EFFECTS__
*/
export declare function useTextDirection(
options?: UseTextDirectionOptions,
): WritableComputedRef<UseTextDirectionValue, UseTextDirectionValue>;