Skip to main content

UseRule

UseRule: RuleProps & { classNames: { cloneRule: string; dragHandle: string; fields: string; lockRule: string; operators: string; removeRule: string; shiftActions: string; value: string; valueSource: string; }; cloneRule: ActionElementEventHandler; fieldData: FullField<string, string, string, Option<string>, Option<string>>; generateOnChangeHandler: (prop: Exclude<keyof RuleType, "id" | "path">) => ValueChangeEventHandler; hideValueControls: boolean; inputType: InputType | null; onChangeField: ValueChangeEventHandler; onChangeOperator: ValueChangeEventHandler; onChangeValue: ValueChangeEventHandler; onChangeValueSource: ValueChangeEventHandler; operators: OptionList<FullOperator>; outerClassName: string; removeRule: ActionElementEventHandler; shiftRuleDown: (event?: MouseEvent, _context?: any) => void; shiftRuleUp: (event?: MouseEvent, _context?: any) => void; toggleLockRule: ActionElementEventHandler; validationResult: boolean | ValidationResult; valueEditorSeparator: React.ReactNode; valueEditorType: ValueEditorType; values: FlexibleOptionList<Option<string>>; valueSourceOptions: ValueSourceOptions; valueSources: ValueSources; }

Type declaration​

classNames​

classNames: { cloneRule: string; dragHandle: string; fields: string; lockRule: string; operators: string; removeRule: string; shiftActions: string; value: string; valueSource: string; }

classNames.cloneRule​

classNames.cloneRule: string

classNames.dragHandle​

classNames.dragHandle: string

classNames.fields​

classNames.fields: string

classNames.lockRule​

classNames.lockRule: string

classNames.operators​

classNames.operators: string

classNames.removeRule​

classNames.removeRule: string

classNames.shiftActions​

classNames.shiftActions: string

classNames.value​

classNames.value: string

classNames.valueSource​

classNames.valueSource: string

cloneRule​

cloneRule: ActionElementEventHandler

fieldData​

fieldData: FullField<string, string, string, Option<string>, Option<string>>

generateOnChangeHandler()​

generateOnChangeHandler: (prop: Exclude<keyof RuleType, "id" | "path">) => ValueChangeEventHandler

Parameters​

ParameterType
propExclude<keyof RuleType, "id" | "path">

Returns​

ValueChangeEventHandler

hideValueControls​

hideValueControls: boolean

inputType​

inputType: InputType | null

onChangeField​

onChangeField: ValueChangeEventHandler

onChangeOperator​

onChangeOperator: ValueChangeEventHandler

onChangeValue​

onChangeValue: ValueChangeEventHandler

onChangeValueSource​

onChangeValueSource: ValueChangeEventHandler

operators​

operators: OptionList<FullOperator>

outerClassName​

outerClassName: string

removeRule​

removeRule: ActionElementEventHandler

shiftRuleDown()​

shiftRuleDown: (event?: MouseEvent, _context?: any) => void

Parameters​

ParameterType
event?MouseEvent
_context?any

Returns​

void

shiftRuleUp()​

shiftRuleUp: (event?: MouseEvent, _context?: any) => void

Parameters​

ParameterType
event?MouseEvent
_context?any

Returns​

void

toggleLockRule​

toggleLockRule: ActionElementEventHandler

validationResult​

validationResult: boolean | ValidationResult

valueEditorSeparator​

valueEditorSeparator: React.ReactNode

valueEditorType​

valueEditorType: ValueEditorType

values​

values: FlexibleOptionList<Option<string>>

valueSourceOptions​

valueSourceOptions: ValueSourceOptions

valueSources​

valueSources: ValueSources

Defined in​

packages/react-querybuilder/src/components/Rule.tsx:282

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.