textual.types

Export some objects that are used by Textual and that help document other features.

ActionParseResult `module-attribute` ¶

ActionParseResult = 'tuple[str, str, tuple[object, ...]]'

An action is its name and the arbitrary tuple of its arguments.

AnimationLevel = Literal['none', 'basic', 'full']

The levels that the TEXTUAL_ANIMATIONS env var can be set to.

CSSPathType = Union[
    str, PurePath, List[Union[str, PurePath]]
]

Valid ways of specifying paths to CSS files.

CallbackType = Union[
    Callable[[], Awaitable[None]], Callable[[], None]
]

Type used for arbitrary callables used in callbacks.

Direction = Literal[-1, 1]

Valid values to determine navigation direction.

In a vertical setting, 1 points down and -1 points up. In a horizontal setting, 1 points right and -1 points left.

EasingFunction = Callable[[float], float]

Signature for a function that parametrizes animation speed.

An easing function must map the interval [0, 1] into the interval [0, 1].

IgnoreReturnCallbackType = Union[
    Callable[[], Awaitable[Any]], Callable[[], Any]
]

A callback which ignores the return type.

InputValidationOn = Literal['blur', 'changed', 'submitted']

Possible messages that trigger input validation.