API ReferenceOverridescomponentOverlay

componentOverlay

Override the overlay shown on hover or selection of a component.

const overrides = { overlay: ({ children }) => <div>{children}</div>, };

Props

PropExampleType
children<div />ReactNode
componentIdHeading-1234string
componentTypeHeadingstring
hoverfalseboolean
isSelectedfalseboolean

children

The default node for the overlay.

componentId

The id for the component underneath the overlay.

componentType

The type for the component underneath the overlay.

hover

Whether or not the the component for this overlay is hovered over.

A parent will not be true if a child node is true.

isSelected

Whether or not the the component for this overlay is selected.