Skip to main content

Interface: FocusAreaOptions

Hierarchy

Properties

animateOnPan

Optional animateOnPan: boolean

If true, set the LayoutStore's isTransitioning value to true.

Inherited from

BaseFocusOptions.animateOnPan

Defined in

packages/design-engine-react-components/src/hooks/useFocus/layout/types.ts:20


changeZoom

Optional changeZoom: boolean

Whether or not to actually change the zoom value when focusing.

Default

true

Inherited from

BaseFocusOptions.changeZoom

Defined in

packages/design-engine-react-components/src/hooks/useFocus/layout/types.ts:16


margins

Optional margins: Margins

An object with top, left, right, and bottom, in pixels. Used to provide more space around the focused area.

Defined in

packages/design-engine-react-components/src/hooks/useFocus/layout/types.ts:27


restrictToPanelBoundary

Optional restrictToPanelBoundary: boolean

If the area requested to be focused is larger than the panel in some dimension, then constrain on the dimensions of the panel.

Default

true

Defined in

packages/design-engine-react-components/src/hooks/useFocus/layout/types.ts:33