# useRtl API

> Auto-generated API reference for `useRtl` from @vuetify/v0 (Vuetify0).
> Source of truth: https://0.vuetifyjs.com/api/use-rtl

## Related

- https://0.vuetifyjs.com/composables/plugins/use-rtl
- https://0.vuetifyjs.com/composables/plugins/use-locale
- https://0.vuetifyjs.com/guide/features/accessibility

## Functions

### createRtl

Creates a new RTL direction instance.

```ts
(options?: RtlOptions) => RtlContext
```

### createRtlFallback

```ts
() => RtlContext
```

### createRtlContext

```ts
<_E>(_options?: RtlPluginOptions | undefined) => ContextTrinity<_E>
```

### createRtlPlugin

```ts
(_options?: RtlPluginOptions | undefined) => Plugin
```

### useRtl

```ts
<_E>(namespace?: string) => _E
```

## Options

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `default` | `boolean \| undefined` | — | no | Initial direction. Defaults to false (LTR). |
| `adapter` | `RtlAdapter \| undefined` | — | no | Adapter for framework-specific side-effects. |
| `target` | `string \| HTMLElement \| null \| undefined` | — | no | Target element or selector for dir attribute. Defaults to documentElement. |

## Methods

| Name | Type | Description |
|---|---|---|
| `toggle` | `() => void` | Convenience method to flip direction |
| `dispose` | `() => void` | Release adapter resources (watch teardown, unhead entry). Called automatically on `app.unmount` when using the plugin path. Call manually when using a standalone context (`createRtlContext`). |

## Properties

| Name | Type | Description |
|---|---|---|
| `isRtl` | `Ref<boolean, boolean>` | Writable ref — true = RTL, false = LTR |