Skip to main content

Function: OrnamentsDesignLayer

▸ OrnamentsDesignLayer(drawInstructions): null | Element

The OrnamentsDesignLayer is a connected observer component linked to the current design engine that renders ornaments for a given panel.

Remarks

This component depends on the PanelOrnamentsExtension for ornament types and positions. You must register this extension in order to use this component as intended.

Parameters​

NameTypeDescription
drawInstructionsOrnamentsDesignLayerPropsAn optional object specifying how to draw given ornament types. The provided object is merged with DEFAULT_ORNAMENT_DRAW_INSTRUCTIONS.

Returns​

null | Element

Defined in​

packages/design-engine-react-components/src/components/ornaments/OrnamentsDesignLayer.tsx:25