RQBMaterialComponents

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

Properties

Button

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

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

---

Checkbox()

Checkbox: (props: CheckboxProps) => Element

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

Demos:

• Checkbox
• Transfer List

API:

• Checkbox API
• inherits ButtonBase API

Parameters

Parameter	Type
props	CheckboxProps

Returns

Element

---

CloseIcon

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

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

Type declaration

muiName

muiName: string

---

ContentCopyIcon

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

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

Type declaration

muiName

muiName: string

---

DragIndicator

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

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

Type declaration

muiName

muiName: string

---

FormControl

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

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

---

FormControlLabel()

FormControlLabel: (props: FormControlLabelProps) => Element

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

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

Demos:

• Checkbox
• Radio Group
• Switch

API:

• FormControlLabel API

Parameters

Parameter	Type
props	FormControlLabelProps

Returns

Element

---

KeyboardArrowDownIcon

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

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

Type declaration

muiName

muiName: string

---

KeyboardArrowUpIcon

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

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

Type declaration

muiName

muiName: string

---

ListSubheader

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

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

---

LockIcon

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

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

Type declaration

muiName

muiName: string

---

LockOpenIcon

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

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

Type declaration

muiName

muiName: string

---

MenuItem

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

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

---

Radio()

Radio: (props: RadioProps) => Element

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

Demos:

• Radio Group

API:

• Radio API
• inherits ButtonBase API

Parameters

Parameter	Type
props	RadioProps

Returns

Element

---

RadioGroup()

RadioGroup: (props: RadioGroupProps) => Element

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

Demos:

• Radio Group

API:

• RadioGroup API
• inherits FormGroup API

Parameters

Parameter	Type
props	RadioGroupProps

Returns

Element

---

Select

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

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

Type declaration

muiName

muiName: string

---

Switch()

Switch: (props: SwitchProps) => Element

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

Demos:

• Switch
• Transfer List

API:

• Switch API
• inherits IconButton API

Parameters

Parameter	Type
props	SwitchProps

Returns

Element

---

TextareaAutosize

TextareaAutosize: ForwardRefExoticComponent<TextareaAutosizeProps & RefAttributes<Element>>

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

---

TextField()

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

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

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:

• FormControl
• InputLabel
• FilledInput
• OutlinedInput
• Input
• FormHelperText

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

const inputProps = {
  step: 300,
};

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

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

• using the upper case props for passing values directly to the components
• using the underlying components directly as shown in the demos

Demos:

• Autocomplete
• Text Field

API:

• TextField API
• inherits FormControl API

Type Parameters

Type Parameter
Variant extends TextFieldVariants

Parameters

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

Returns

Element

---

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.