Skip to main content

Module: @react-querybuilder/material

Type Aliases​

MaterialActionProps​

MaterialActionProps: ActionWithRulesProps & ComponentPropsWithoutRef<typeof Button> & { muiComponents?: RQBMaterialComponents }

Defined in​

packages/material/src/MaterialActionElement.tsx:10

MaterialDragHandleProps​

MaterialDragHandleProps: DragHandleProps & Omit<ComponentPropsWithRef<typeof DragIndicator>, "path"> & { muiComponents?: RQBMaterialComponents }

Defined in​

packages/material/src/MaterialDragHandle.tsx:10

MaterialNotToggleProps​

MaterialNotToggleProps: NotToggleProps & ComponentPropsWithoutRef<typeof __type> & { muiComponents?: RQBMaterialComponents }

Defined in​

packages/material/src/MaterialNotToggle.tsx:10

MaterialShiftActionsProps​

MaterialShiftActionsProps: ShiftActionsProps & React.ComponentPropsWithoutRef<typeof Button> & { muiComponents?: RQBMaterialComponents }

Defined in​

packages/material/src/MaterialShiftActions.tsx:8

MaterialValueEditorProps​

MaterialValueEditorProps: ValueEditorProps & { extraProps?: Record<string, any> ; muiComponents?: RQBMaterialComponents }

Defined in​

packages/material/src/MaterialValueEditor.tsx:14

MaterialValueSelectorProps​

MaterialValueSelectorProps: VersatileSelectorProps & ComponentPropsWithoutRef<typeof Select> & { muiComponents?: RQBMaterialComponents }

Defined in​

packages/material/src/MaterialValueSelector.tsx:11

RQBMaterialComponents​

RQBMaterialComponents: Object

Type declaration​

NameType
Buttontypeof Button
Checkboxtypeof __type
CloseIcontypeof CloseIcon
ContentCopyIcontypeof ContentCopyIcon
DragIndicatortypeof DragIndicator
FormControltypeof FormControl
FormControlLabeltypeof __type
Inputtypeof Input
KeyboardArrowDownIcontypeof KeyboardArrowDownIcon
KeyboardArrowUpIcontypeof KeyboardArrowUpIcon
ListSubheadertypeof ListSubheader
LockIcontypeof LockIcon
LockOpenIcontypeof LockOpenIcon
MenuItemtypeof MenuItem
Radiotypeof __type
RadioGrouptypeof __type
Selecttypeof Select
Switchtypeof __type
TextareaAutosizetypeof TextareaAutosize

Defined in​

packages/material/src/types.ts:25

Variables​

QueryBuilderMaterial​

Const QueryBuilderMaterial: QueryBuilderContextProvider<{ muiComponents?: RQBMaterialComponents }>

Defined in​

packages/material/src/index.tsx:42

RQBMaterialContext​

Const RQBMaterialContext: Context<null | RQBMaterialComponents>

Defined in​

packages/material/src/RQBMaterialContext.ts:4

defaultMuiComponents​

Const defaultMuiComponents: Object

Type declaration​

NameType
ButtonExtendButtonBase<ButtonTypeMap<, "button">>
Checkbox(props: CheckboxProps) => JSX.Element
CloseIconOverridableComponent<SvgIconTypeMap<, "svg">> & { muiName: string }
ContentCopyIconOverridableComponent<SvgIconTypeMap<, "svg">> & { muiName: string }
DragIndicatorOverridableComponent<SvgIconTypeMap<, "svg">> & { muiName: string }
FormControlOverridableComponent<FormControlTypeMap<, "div">>
FormControlLabel(props: FormControlLabelProps) => JSX.Element
Input(props: InputProps) => Element & { muiName: string }
KeyboardArrowDownIconOverridableComponent<SvgIconTypeMap<, "svg">> & { muiName: string }
KeyboardArrowUpIconOverridableComponent<SvgIconTypeMap<, "svg">> & { muiName: string }
ListSubheaderOverridableComponent<ListSubheaderTypeMap<, "li">>
LockIconOverridableComponent<SvgIconTypeMap<, "svg">> & { muiName: string }
LockOpenIconOverridableComponent<SvgIconTypeMap<, "svg">> & { muiName: string }
MenuItemExtendButtonBase<MenuItemTypeMap<, "li">>
Radio(props: RadioProps) => JSX.Element
RadioGroup(props: RadioGroupProps) => JSX.Element
Select<Value>(props: SelectProps<Value>) => Element & { muiName: string }
Switch(props: SwitchProps) => JSX.Element
TextareaAutosizeForwardRefExoticComponent<TextareaAutosizeProps & RefAttributes<Element>>

Defined in​

packages/material/src/useMuiComponents.ts:28

materialControlElements​

Const materialControlElements: Object

Type declaration​

NameType
actionElement(__namedParameters: MaterialActionProps) => Element
actionElement.displayNamestring
dragHandleForwardRefExoticComponent<Omit<MaterialDragHandleProps, "ref"> & RefAttributes<HTMLSpanElement>>
notToggle(__namedParameters: MaterialNotToggleProps) => Element
notToggle.displayNamestring
shiftActions(__namedParameters: MaterialShiftActionsProps) => Element
shiftActions.displayNamestring
valueEditor(props: MaterialValueEditorProps) => null | Element
valueEditor.displayNamestring
valueSelector(__namedParameters: MaterialValueSelectorProps) => Element
valueSelector.displayNamestring

Defined in​

packages/material/src/index.tsx:27

materialTranslations​

Const materialTranslations: Object

Type declaration​

NameType
cloneRule{ label: Element }
cloneRule.labelElement
cloneRuleGroup{ label: Element }
cloneRuleGroup.labelElement
lockGroup{ label: Element }
lockGroup.labelElement
lockGroupDisabled{ label: Element }
lockGroupDisabled.labelElement
lockRule{ label: Element }
lockRule.labelElement
lockRuleDisabled{ label: Element }
lockRuleDisabled.labelElement
removeGroup{ label: Element }
removeGroup.labelElement
removeRule{ label: Element }
removeRule.labelElement
shiftActionDown{ label: Element }
shiftActionDown.labelElement
shiftActionUp{ label: Element }
shiftActionUp.labelElement

Defined in​

packages/material/src/translations.tsx:55

Functions​

MaterialActionElement​

MaterialActionElement(«destructured»): Element

Parameters​

NameType
«destructured»MaterialActionProps

Returns​

Element

Defined in​

packages/material/src/MaterialActionElement.tsx:15

MaterialDragHandle​

MaterialDragHandle(props): ReactNode

Parameters​

NameType
propsOmit<MaterialDragHandleProps, "ref"> & RefAttributes<HTMLSpanElement>

Returns​

ReactNode

Defined in​

packages/material/src/MaterialDragHandle.tsx:15

MaterialNotToggle​

MaterialNotToggle(«destructured»): Element

Parameters​

NameType
«destructured»MaterialNotToggleProps

Returns​

Element

Defined in​

packages/material/src/MaterialNotToggle.tsx:17

MaterialShiftActions​

MaterialShiftActions(«destructured»): Element

Parameters​

NameType
«destructured»MaterialShiftActionsProps

Returns​

Element

Defined in​

packages/material/src/MaterialShiftActions.tsx:13

MaterialValueEditor​

MaterialValueEditor(props): null | Element

Parameters​

NameType
propsMaterialValueEditorProps

Returns​

null | Element

Defined in​

packages/material/src/MaterialValueEditor.tsx:20

MaterialValueSelector​

MaterialValueSelector(«destructured»): Element

Parameters​

NameType
«destructured»MaterialValueSelectorProps

Returns​

Element

Defined in​

packages/material/src/MaterialValueSelector.tsx:16

useMuiComponents​

useMuiComponents(preloadedComponents?): RQBMaterialComponents

Parameters​

NameType
preloadedComponents?RQBMaterialComponents

Returns​

RQBMaterialComponents

Defined in​

packages/material/src/useMuiComponents.ts:50