Skip to main content
Version: 1.x

@microsoft/fast-foundation > AnchoredRegionConfig

AnchoredRegionConfig interface

A utility interface to store anchored region configurations that correspond to various common flyout positioning schemes

Signature:
export interface AnchoredRegionConfig 

Properties

PropertyTypeDescription
autoUpdateModeAutoUpdateModeThe auto-update setting of the component
fixedPlacementbooleanWhether the region is positioned using css "position: fixed". Otherwise the region uses "position: absolute". Fixed placement allows the region to break out of parent containers,
horizontalDefaultPositionHorizontalPositionThe default horizontal position of the region relative to the anchor element
horizontalInsetbooleanhether the region overlaps the anchor on the horizontal axis
horizontalPositioningModeAxisPositioningModeSets what logic the component uses to determine horizontal placement.
horizontalScalingAxisScalingModeDefines how the width of the region is calculate
horizontalThresholdnumberHow short the space allocated to the default position has to be before the widest area is selected for layout
horizontalViewportLockbooleanWhether the region remains in the viewport (ie. detaches from the anchor) on the horizontal axis
verticalDefaultPositionVerticalPositionThe default vertical position of the region relative to the anchor element
verticalInsetbooleanWhether the region overlaps the anchor on the vertical axis
verticalPositioningModeAxisPositioningModeSets what logic the component uses to determine vertical placement.
verticalScalingAxisScalingModeDefines how the height of the region is calculated
verticalThresholdnumberHow short the space allocated to the default position has to be before the tallest area is selected for layout
verticalViewportLockbooleanWhether the region remains in the viewport (ie. detaches from the anchor) on the vertical axis