PropertyListProps Interface
Properties of PropertyList React component
Extends
Properties
| Name | Type | Description | |
|---|---|---|---|
| actionButtonRenderers | ActionButtonRenderer[] | undefined | Array of action button renderers | |
| category | PropertyCategory | undefined | ||
| columnInfo | | undefined | Information for styling property grid columns | |
| columnRatio | number | undefined | ||
| editingPropertyKey | string | undefined | ||
| isPropertyHoverEnabled | boolean | undefined | Enables/disables property hovering effect | |
| isPropertyRightClickSelectionEnabled | boolean | undefined | Enables/disables property right click selection | |
| isPropertySelectionEnabled | boolean | undefined | Enables/disables property selection | |
| isResizeHandleBeingDragged | boolean | undefined | Is resize handle being dragged | |
| isResizeHandleHovered | boolean | undefined | Is resize handle hovered | |
| onColumnChanged | (ratio: number) => void | { ratio: number } | undefined | Callback to column ratio changed event | |
| onEditCancel | () => void | undefined | ||
| onEditCommit | (args: PropertyUpdatedArgs, category: PropertyCategory) => void | undefined | ||
| onPropertyClicked | (property: PropertyRecord, key?: string) => void | undefined | ||
| onPropertyContextMenu | (property: PropertyRecord, e: React.MouseEvent<Element, MouseEvent>) => void | undefined | ||
| onPropertyRightClicked | (property: PropertyRecord, key?: string) => void | undefined | ||
| onResizeHandleDragChanged | (isDragStarted: boolean) => void | undefined | Callback to drag event change | |
| onResizeHandleHoverChanged | (isHovered: boolean) => void | undefined | Callback to hover event change | |
| orientation | Orientation | ||
| properties | PropertyRecord[] | ||
| propertyValueRendererManager | PropertyValueRendererManager | undefined | ||
| selectedPropertyKey | string | undefined | ||
| width | number |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| className | string | undefined | CommonProps | Custom CSS class name |
| itemId | string | undefined | CommonProps | Optional unique identifier for item. |
| style | React.CSSProperties | undefined | CommonProps | Custom CSS style properties |
Defined in
Last Updated: 20 November, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.