API Reference › components-react› Properties › PropertyRendererProps

PropertyRendererProps Interface

Properties of PropertyRenderer React component

Extends

Properties

Name Type Description
highlight HighlightingComponentProps | undefined Props used for highlighting.  
indentation number | undefined Multiplier of how much the property is indented to the right  
isEditing boolean | undefined Indicates property is being edited  
onEditCancel () => void | undefined Called when property edit is cancelled.  
onEditCommit (args: PropertyUpdatedArgs) => void | undefined Called when property edit is committed.  
propertyValueRendererManager PropertyValueRendererManager | undefined Custom value renderer  

Inherited properties

Name Type Inherited from Description
actionButtonRenderers Inherited ActionButtonRenderer[] | undefined SharedRendererProps Array of action button renderers
alwaysShowEditor Inherited (property: PropertyRecord) => boolean | undefined SharedRendererProps Callback to determine which editors should be always visible
columnInfo Inherited | undefined SharedRendererProps Information for styling property grid columns
columnRatio Inherited number | undefined SharedRendererProps Ratio between label and value cells
isHoverable Inherited boolean | undefined SharedRendererProps Indicates that properties have hover effect
isPropertyEditingEnabled Inherited boolean | undefined SharedRendererProps Enables/disables property editing
isResizeHandleBeingDragged Inherited boolean | undefined SharedRendererProps Is resize handle being dragged
isResizeHandleHovered Inherited boolean | undefined SharedRendererProps Is resize handle hovered
isSelectable Inherited boolean | undefined SharedRendererProps Indicates that properties can be selected
isSelected Inherited boolean | undefined SharedRendererProps Controls component selection
onClick Inherited (property: PropertyRecord, key?: string) => void | undefined SharedRendererProps Called when property gets clicked.
onColumnRatioChanged Inherited (ratio: number) => void | { ratio: number } | undefined SharedRendererProps Callback to column ratio changed event
onContextMenu Inherited (property: PropertyRecord, e: React.MouseEvent<Element, MouseEvent>) => void | undefined SharedRendererProps Called to show a context menu for properties
onResizeHandleDragChanged Inherited (isDragStarted: boolean) => void | undefined SharedRendererProps Callback to drag event change
onResizeHandleHoverChanged Inherited (isHovered: boolean) => void | undefined SharedRendererProps Callback to hover event change
onRightClick Inherited (property: PropertyRecord, key?: string) => void | undefined SharedRendererProps Called when property gets right clicked.
orientation Inherited Orientation SharedRendererProps Orientation to use for displaying the property
propertyRecord Inherited PropertyRecord SharedRendererProps PropertyRecord to render
uniqueKey Inherited string | undefined SharedRendererProps Unique string, that identifies this property component.
width Inherited number | undefined SharedRendererProps Width of the whole property element

Defined in

Last Updated: 30 January, 2025