# `TextDirection`

Which way text runs, written as HTML's `dir` writes it, `ltr` and `rtl`: what `locale.direction` gives.

[Places](types.md#places); not ordered; since Jadpo 0.1.0.

## Make one

Pick one of its variants, `TextDirection.left_to_right`.

`text.parse(raw, as: TextDirection)` reads one from its text; text that isn't one at all fails `malformed`, such as `left_to_right`, `auto` or `""`.

This operation gives one: `locale.direction`.

## Variants

| Variant | Written |
|---|---|
| `left_to_right` | `ltr` |
| `right_to_left` | `rtl` |

## Text, JSON and storage

`text.from` writes its canonical text, the one form `text.parse` reads back. JSON sends its canonical text as a string.

| Text | JSON |
|---|---|
| `ltr` | `"ltr"` |
| `rtl` | `"rtl"` |

It is stored in one column named for the field, of type `text`. `rtl` is stored as `'rtl'`.

## Shown to people

`text.format(value, locale:)` shows it to people in their locale.

With `locale: Locale.en_gb`:

| Value | Shown |
|---|---|
| `ltr` | `ltr` |
| `rtl` | `rtl` |

## Operations

- `locale.direction(value: Locale) -> TextDirection`: Which way `value`'s text runs, as CLDR says: `TextDirection.left_to_right` for English, `TextDirection.right_to_left` for Arabic and Hebrew.

Like every standard type, it also has the contract's own operations: `text.parse`, `text.from`, `text.format`, `json.read`, `json.write` and `==`. It isn't ordered, so `<` and sorting don't take it. [Every standard type meets one contract](../topics/every-standard-type-meets-one-contract.md) says how they work.