API Reference › components-react› PropertyEditors

PropertyEditors

Classes and components for working with Property Editors.

Classes

Name Description  
BasicPropertyEditor Basic Property Editor registered for the "text" and "string" type names.  
BooleanEditor BooleanEditor React component that is a property editor with checkbox input  
BooleanPropertyEditor Boolean Property Editor registered for the "bool" and "boolean" type names.  
DataControllerBase DataControllerBase is the base class for all Data Controllers.  
EnumButtonGroupEditor EnumButtonGroupEditor React component that is a property editor with select input  
EnumEditor EnumEditor React component that is a property editor with select input  
EnumPropertyButtonGroupEditor Enum Property Button Group Editor registered for the "enum" type name and the "enum-buttongroup" editor name.  
EnumPropertyEditor Enum Property Button Group Editor registered for the "enum" type name.  
ImageCheckBoxEditor ImageCheckBoxEditor  
ImageCheckBoxPropertyEditor ImageCheckBox Property Editor registered for the "bool" and "boolean" type names.  
NumericInputEditor NumericInputEditor React component that is a property editor with numeric input & up/down buttons  
NumericInputPropertyEditor Numeric Input Property Editor registered for the "number" type name and "numeric-input" editor name.  
PropertyEditorBase PropertyEditor is the base class for all property editors.  
PropertyEditorManager Manages Property Editors.  
SliderEditor SliderEditor React component that is a property editor with numeric input & up/down buttons  
SliderPropertyEditor Slider Property Editor registered for the "number" type name and "slider" editor name.  
TextareaEditor TextareaEditor React component that is a property editor with text input  
TextareaPropertyEditor Textarea Property Editor registered for the "text" and "string" type names and "multi-line" editor name.  
TextEditor TextEditor React component that is a property editor with text input  
ToggleEditor ToggleEditor React component that is a property editor with checkbox input  
TogglePropertyEditor Toggle Property Editor registered for the "bool" and "boolean" type names and "toggle" editor name.  

Global Functions

Name Description  
areEqual Checks if two values are equal.  
createEditorSpec Utility function to create an editor spec for editor with concrete metadata and value types.  
EditorContainer EditorContainer React component used by the Tree and PropertyGrid for cell editing.  
EditorRenderer Editor component that renders an editor based on the metadata and value.  
EditorsRegistryProvider Provider that adds supplied editors into EditorsRegistry.  
FormattedNumericInput A numeric input that allows to pass custom parsing/formatting logic to handle values with units etc.  
isBoolean Type guard for boolean value.  
isDate Type guard for date value.  
isEnum Type guard for enum value.  
isInstanceKey Type guard for instance key value.  
isNumeric Type guard for numeric value.  
isText Type guard for text value.  
PropertyRecordEditor Editor component for editing property values represented by PropertyRecord.  
useCommittableValue Custom React hook that provides to commit or cancel value changes by editor using  
useEditor Custom React hook that returns editor for specified metadata and value.  

Interfaces

Name Description  
AsyncErrorMessage Asynchronous Error Message returned as part of AsyncValueProcessingResult  
AsyncValueProcessingResult Asynchronous Value Process Result  
BooleanValue Type definition for boolean value that can be handled by editor.  
DataController DataControllers can be implemented per typename to validate and commit values.  
DateValue Type definition for date value that can be handled by editor.  
EditorContainerProps EditorContainer React component properties Deprecated
EditorProps Generic editor props that are supplied to the editor for rendering.  
EditorSpec An editor specification defining single editor with a predicate that determines if the editor can be used for a given value.  
EnumChoice Type definition for available enum choice that can be supplied for editing enum values.  
EnumValue Type definition for enum value that can be handled by editor.  
EnumValueMetadata Additional metadata that is used along side enum value to determine applicable editor.  
InstanceKeyValue Type definition for instance key value that can be handled by editor.  
NumericValue Type definition for numeric value that can be handled by editor.  
PropertyEditorProps Properties for a property editor component  
PropertyUpdatedArgs Arguments for the Property Updated event callback  
TextValue Type definition for text value that can be handled by editor.  
TypeEditor Interface implemented by React based type editors  
ValueMetadata Additional metadata that is used along side value.  

Type Aliases

Name Description  
Value Type definition for a value.  
ValueType Value types supported by editor system.  

Last Updated: 17 April, 2025