Skip to main content

ConsequentPropertyDef

Defined in: rules-engine/src/types/rulesEngine.ts:136

Definition of a single editable property of a consequent type. Used by the built-in ConsequentBuilderBody to render an appropriate input for each property. Property values are stored on the consequent under params[name].

Properties​

defaultValue?​

optional defaultValue?: unknown

Defined in: rules-engine/src/types/rulesEngine.ts:146

Value seeded into params[name] when the consequent type is selected.

inputType?​

optional inputType?: ConsequentPropertyInputType

Defined in: rules-engine/src/types/rulesEngine.ts:142

Input type to render. Defaults to "text".

label?​

optional label?: string

Defined in: rules-engine/src/types/rulesEngine.ts:140

Visible label for the input. Defaults to name.

name​

name: string

Defined in: rules-engine/src/types/rulesEngine.ts:138

Key under which the value is stored in the consequent's params object.

values?​

optional values?: FlexibleOption[]

Defined in: rules-engine/src/types/rulesEngine.ts:144

Options for the "select" input type.

caution

API documentation is generated from the latest commit on the main branch. It may be somewhat inconsistent with official releases of React Query Builder.