Condition

interface

A named yes/no rule the host re-evaluates as state changes. Pass one to a command's or keybinding's `when` to control whether it is enabled and visible. The host watches whatever the predicate reads, so a command greys out on its own when the selection empties.

interface Condition<TId extends string>

Import

import { Condition } from '@modular/sdk';

Members4

id: TId
Identifier, unique within the mod.
kind: 'condition'
titleoptional: string
Label shown where the host explains why something is disabled.
when: ConditionPredicate
Evaluated synchronously whenever the state it reads changes. Return `true` to enable or reveal whatever this condition gates. Keep it pure, the host may call it often.

Notes

category: State