Skip to main content

RQBMaterialComponents

Defined in: packages/material/src/types.ts:28

Extended by​

Properties​

Button​

Button: ExtendButtonBase<ButtonTypeMap<{ }, "button">>

Defined in: packages/material/src/types.ts:29


Checkbox​

Checkbox: (props: CheckboxProps) => Element

Defined in: packages/material/src/types.ts:30

Demos:

API:

Parameters​

ParameterType
propsCheckboxProps

Returns​

Element


CloseIcon​

CloseIcon: OverridableComponent<SvgIconTypeMap<{ }, "svg">> & { muiName: string; }

Defined in: packages/material/src/types.ts:31

Type Declaration​

muiName​

muiName: string


ContentCopyIcon​

ContentCopyIcon: OverridableComponent<SvgIconTypeMap<{ }, "svg">> & { muiName: string; }

Defined in: packages/material/src/types.ts:32

Type Declaration​

muiName​

muiName: string


DragIndicator​

DragIndicator: OverridableComponent<SvgIconTypeMap<{ }, "svg">> & { muiName: string; }

Defined in: packages/material/src/types.ts:33

Type Declaration​

muiName​

muiName: string


FormControl​

FormControl: OverridableComponent<FormControlTypeMap<{ }, "div">>

Defined in: packages/material/src/types.ts:34


FormControlLabel​

FormControlLabel: (props: FormControlLabelProps) => Element

Defined in: packages/material/src/types.ts:35

Drop-in replacement of the Radio, Switch and Checkbox component. Use this component if you want to display an extra label.

Demos:

API:

Parameters​

ParameterType
propsFormControlLabelProps

Returns​

Element


InputLabel​

InputLabel: OverridableComponent<InputLabelTypeMap<{ }, "label">>

Defined in: packages/material/src/types.ts:36


KeyboardArrowDownIcon​

KeyboardArrowDownIcon: OverridableComponent<SvgIconTypeMap<{ }, "svg">> & { muiName: string; }

Defined in: packages/material/src/types.ts:37

Type Declaration​

muiName​

muiName: string


KeyboardArrowUpIcon​

KeyboardArrowUpIcon: OverridableComponent<SvgIconTypeMap<{ }, "svg">> & { muiName: string; }

Defined in: packages/material/src/types.ts:38

Type Declaration​

muiName​

muiName: string


LayersClearIcon​

LayersClearIcon: OverridableComponent<SvgIconTypeMap<{ }, "svg">> & { muiName: string; }

Defined in: packages/material/src/types.ts:40

Type Declaration​

muiName​

muiName: string


ListSubheader​

ListSubheader: OverridableComponent<ListSubheaderTypeMap<{ }, "li">>

Defined in: packages/material/src/types.ts:39


LockIcon​

LockIcon: OverridableComponent<SvgIconTypeMap<{ }, "svg">> & { muiName: string; }

Defined in: packages/material/src/types.ts:41

Type Declaration​

muiName​

muiName: string


LockOpenIcon​

LockOpenIcon: OverridableComponent<SvgIconTypeMap<{ }, "svg">> & { muiName: string; }

Defined in: packages/material/src/types.ts:42

Type Declaration​

muiName​

muiName: string


MenuItem: ExtendButtonBase<MenuItemTypeMap<{ }, "li">>

Defined in: packages/material/src/types.ts:43


Radio​

Radio: (props: RadioProps) => Element

Defined in: packages/material/src/types.ts:44

Demos:

API:

Parameters​

ParameterType
propsRadioProps

Returns​

Element


RadioGroup​

RadioGroup: (props: RadioGroupProps) => Element

Defined in: packages/material/src/types.ts:45

Demos:

API:

Parameters​

ParameterType
propsRadioGroupProps

Returns​

Element


RedoIcon​

RedoIcon: OverridableComponent<SvgIconTypeMap<{ }, "svg">> & { muiName: string; }

Defined in: packages/material/src/types.ts:51

Type Declaration​

muiName​

muiName: string


Select​

Select: (<Value>(props: SelectProps<Value>) => Element) & { muiName: string; }

Defined in: packages/material/src/types.ts:46

Type Declaration​

muiName​

muiName: string


Switch​

Switch: (props: SwitchProps) => Element

Defined in: packages/material/src/types.ts:47

Demos:

API:

Parameters​

ParameterType
propsSwitchProps

Returns​

Element


TextareaAutosize​

TextareaAutosize: ForwardRefExoticComponent<TextareaAutosizeProps & RefAttributes<Element>>

Defined in: packages/material/src/types.ts:48


TextField​

TextField: <Variant>(props: { variant?: Variant; } & Omit<StandardTextFieldProps | OutlinedTextFieldProps | FilledTextFieldProps, "variant">) => Element

Defined in: packages/material/src/types.ts:49

The TextField is a convenience wrapper for the most common cases (80%). It cannot be all things to all people, otherwise the API would grow out of control.

Advanced Configuration​

It's important to understand that the text field is a simple abstraction on top of the following components:

If you wish to alter the props applied to the input element, you can do so as follows:

const slotProps = {
htmlInput: {
step: 300
}
};

return <TextField id="time" type="time" slotProps={slotProps} />;

For advanced cases, please look at the source of TextField by clicking on the "Edit this page" button above. Consider either:

  • using the slotProps prop for passing values directly to the components
  • using the underlying components directly as shown in the demos

Demos:

API:

Type Parameters​

Type Parameter
Variant extends TextFieldVariants

Parameters​

ParameterType
props{ variant?: Variant; } & Omit<StandardTextFieldProps | OutlinedTextFieldProps | FilledTextFieldProps, "variant">

Returns​

Element


UndoIcon​

UndoIcon: OverridableComponent<SvgIconTypeMap<{ }, "svg">> & { muiName: string; }

Defined in: packages/material/src/types.ts:50

Type Declaration​

muiName​

muiName: string


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.