README.md

rjsf-bulma - v5.0.0-beta.5

rjsf-bulma - v5.0.0-beta.5

Table of contents

References

• default

Interfaces

• BulmaContext
• FilesInfoTemplateProps
• UseFileWidgetReturn

Type Aliases

• FileInfoType

Variables

• Form
• Templates
• Theme
• Widgets

Functions

• IconButton
• createIsSmallUiSchema
• useBaseInputTemplate
• useCheckboxWidget
• useCheckboxesWidget
• useFileWidget
• useRadioWidget
• useSelectWidget
• useTextareaWidget

References

default

Renames and re-exports Form

Type Aliases

FileInfoType

Ƭ FileInfoType: Object

Type declaration

Name	Type
dataURL?	string | null
name	string
size	number
type	string

Variables

Form

• Const Form: ComponentType<FormProps>

---

Templates

• Templates: Object

Type declaration

Name	Type
ArrayFieldItemTemplate	FC<ArrayFieldTemplateItemType<any, any>>
ArrayFieldTemplate	FC<ArrayFieldTemplateProps<any, any>>
BaseInputTemplate	FC<WidgetProps<any, any>>
ButtonTemplates	{ AddButton: FC<IconButtonProps<any, any>> ; MoveDownButton: FC<IconButtonProps<any, any>> ; MoveUpButton: FC<IconButtonProps<any, any>> ; RemoveButton: FC<IconButtonProps<any, any>> ; SubmitButton: FC<SubmitButtonProps<any, any>> }
ButtonTemplates.AddButton	FC<IconButtonProps<any, any>>
ButtonTemplates.MoveDownButton	FC<IconButtonProps<any, any>>
ButtonTemplates.MoveUpButton	FC<IconButtonProps<any, any>>
ButtonTemplates.RemoveButton	FC<IconButtonProps<any, any>>
ButtonTemplates.SubmitButton	FC<SubmitButtonProps<any, any>>
DescriptionFieldTemplate	FC<DescriptionFieldProps<any, any>>
ErrorListTemplate	FC<ErrorListProps<any, any>>
FieldErrorTemplate	FC<FieldErrorProps<any, any>>
FieldHelpTemplate	FC<FieldHelpProps<any, any>>
FieldTemplate	FC<FieldTemplateProps<any, any>>
FilesInfoTemplate	FC<FilesInfoTemplateProps>
ObjectFieldTemplate	FC<ObjectFieldTemplateProps<any, any>>
TitleFieldTemplate	FC<TitleFieldProps<any, any>>
WrapIfAdditionalTemplate	FC<WrapIfAdditionalTemplateProps<any, any>>

---

Theme

• Const Theme: ThemeProps

---

Widgets

• Widgets: Object

Type declaration

Name	Type
CheckboxWidget	FC<WidgetProps<any, any>>
CheckboxesWidget	FC<WidgetProps<any, any>>
FileWidget	FC<WidgetProps<any, any>>
RadioWidget	FC<WidgetProps<any, any>>
RangeWidget	FC<WidgetProps<any, any>>
SelectWidget	FC<WidgetProps<any, any>>
TextareaWidget	FC<WidgetProps<any, any>>

Functions

IconButton

▸ IconButton(props, context?): null | ReactElement<any, any>

Parameters

Name	Type
props	IconButtonProps<any, any>
context?	any

Returns

null | ReactElement<any, any>

---

createIsSmallUiSchema

▸ createIsSmallUiSchema(uiSchema?): UiSchema

Parameters

Name	Type
uiSchema	UiSchema<any, any>

Returns

UiSchema

---

useBaseInputTemplate

▸ useBaseInputTemplate(props): Object

Parameters

Name	Type
props	WidgetProps<any, any>

Returns

Object

Name	Type
hasErrors	boolean
inputProps	{}
onBlur	(__namedParameters: FocusEvent<HTMLInputElement, Element>) => void
onChange	(__namedParameters: ChangeEvent<HTMLInputElement>) => void
onFocus	(__namedParameters: FocusEvent<HTMLInputElement, Element>) => void
value	any

---

useCheckboxWidget

▸ useCheckboxWidget(props): Object

Parameters

Name	Type
props	WidgetProps<any, any>

Returns

Object

Name	Type
onBlur	(__namedParameters: FocusEvent<HTMLInputElement, Element>) => void
onChange	(__namedParameters: ChangeEvent<HTMLInputElement>) => void
onFocus	(__namedParameters: FocusEvent<HTMLInputElement, Element>) => void
value	any

---

useCheckboxesWidget

▸ useCheckboxesWidget(props): Object

Parameters

Name	Type
props	WidgetProps<any, any>

Returns

Object

Name	Type
enumOptions	EnumOptionsType[]
getCheckboxProps	(option: EnumOptionsType) => { checked: boolean ; disabled: boolean ; onBlur: (__namedParameters: FocusEvent<HTMLInputElement, Element>) => void = handleBlur; onChange: (__namedParameters: ChangeEvent<HTMLInputElement>) => void ; onFocus: (__namedParameters: FocusEvent<HTMLInputElement, Element>) => void = handleFocus }

---

useFileWidget

▸ useFileWidget<T, F>(__namedParameters): UseFileWidgetReturn

Type parameters

Name
T
F

Parameters

Name	Type
__namedParameters	WidgetProps<T, F>

Returns

UseFileWidgetReturn

---

useRadioWidget

▸ useRadioWidget(props): Object

Parameters

Name	Type
props	WidgetProps<any, any>

Returns

Object

Name	Type
enumOptions	EnumOptionsType[]
isChecked	(v: any) => boolean
isDisabled	(v: any) => boolean
onBlur	(__namedParameters: FocusEvent<HTMLInputElement, Element>) => void
onChange	(__namedParameters: ChangeEvent<HTMLInputElement>) => void
onFocus	(__namedParameters: FocusEvent<HTMLInputElement, Element>) => void

---

useSelectWidget

▸ useSelectWidget(props): Object

Parameters

Name	Type
props	WidgetProps<any, any>

Returns

Object

Name	Type
enumOptions	EnumOptionsType[]
hasErrors	boolean
isDisabled	(value: any) => boolean
onBlur	(event: FocusEvent<HTMLSelectElement, Element>) => void
onChange	(event: ChangeEvent<HTMLSelectElement>) => void
onFocus	(event: FocusEvent<HTMLSelectElement, Element>) => void
value	any

---

useTextareaWidget

▸ useTextareaWidget(props): Object

Parameters

Name	Type
props	WidgetProps<any, any>

Returns

Object

Name	Type
hasErrors	boolean
onBlur	(__namedParameters: FocusEvent<HTMLTextAreaElement, Element>) => void
onChange	(__namedParameters: ChangeEvent<HTMLTextAreaElement>) => void
onFocus	(__namedParameters: FocusEvent<HTMLTextAreaElement, Element>) => void
value	any