Skip to main content

ConditionInput

interface

Fields accepted by condition.

interface ConditionInput<TId extends string>

Import

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

Members3

id: TId
Identifier, unique within the mod.
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