Skip to main content

RQBMaterialContextValue

Defined in: packages/material/src/RQBMaterialContext.ts:5

Extends​

Properties​

Button​

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

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

Inherited from​

RQBMaterialComponents.Button

Checkbox()​

Checkbox: (props: CheckboxProps) => Element

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

Demos:

API:

Parameters​

ParameterType
propsCheckboxProps

Returns​

Element

Inherited from​

RQBMaterialComponents.Checkbox

CloseIcon​

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

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

Type Declaration​

muiName​

muiName: string

Inherited from​

RQBMaterialComponents.CloseIcon

ContentCopyIcon​

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

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

Type Declaration​

muiName​

muiName: string

Inherited from​

RQBMaterialComponents.ContentCopyIcon

DragIndicator​

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

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

Type Declaration​

muiName​

muiName: string

Inherited from​

RQBMaterialComponents.DragIndicator

FormControl​

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

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

Inherited from​

RQBMaterialComponents.FormControl

FormControlLabel()​

FormControlLabel: (props: FormControlLabelProps) => Element

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

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

Inherited from​

RQBMaterialComponents.FormControlLabel

InputLabel​

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

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

Inherited from​

RQBMaterialComponents.InputLabel

KeyboardArrowDownIcon​

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

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

Type Declaration​

muiName​

muiName: string

Inherited from​

RQBMaterialComponents.KeyboardArrowDownIcon

KeyboardArrowUpIcon​

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

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

Type Declaration​

muiName​

muiName: string

Inherited from​

RQBMaterialComponents.KeyboardArrowUpIcon

ListSubheader​

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

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

Inherited from​

RQBMaterialComponents.ListSubheader

LockIcon​

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

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

Type Declaration​

muiName​

muiName: string

Inherited from​

RQBMaterialComponents.LockIcon

LockOpenIcon​

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

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

Type Declaration​

muiName​

muiName: string

Inherited from​

RQBMaterialComponents.LockOpenIcon

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

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

Inherited from​

RQBMaterialComponents.MenuItem

Radio()​

Radio: (props: RadioProps) => Element

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

Demos:

API:

Parameters​

ParameterType
propsRadioProps

Returns​

Element

Inherited from​

RQBMaterialComponents.Radio

RadioGroup()​

RadioGroup: (props: RadioGroupProps) => Element

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

Demos:

API:

Parameters​

ParameterType
propsRadioGroupProps

Returns​

Element

Inherited from​

RQBMaterialComponents.RadioGroup

Select​

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

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

Type Declaration​

muiName​

muiName: string

Inherited from​

RQBMaterialComponents.Select

showInputLabels?​

optional showInputLabels: boolean

Defined in: packages/material/src/RQBMaterialContext.ts:6

Switch()​

Switch: (props: SwitchProps) => Element

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

Demos:

API:

Parameters​

ParameterType
propsSwitchProps

Returns​

Element

Inherited from​

RQBMaterialComponents.Switch

TextareaAutosize​

TextareaAutosize: ForwardRefExoticComponent<TextareaAutosizeProps & RefAttributes<Element>>

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

Inherited from​

RQBMaterialComponents.TextareaAutosize

TextField()​

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

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

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 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:

API:

Type Parameters​

Type Parameter
Variant extends TextFieldVariants

Parameters​

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

Returns​

Element

Inherited from​

RQBMaterialComponents.TextField

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.