Skip to content

Commit 5c91e73

Browse files
crisbetoandrewseguin
authored andcommitted
docs(overlay): mention the FlexibleConnectedPositionStrategy in the overlay guide (#10842)
Adds a description of the `FlexibleConnectedPositionStrategy` to the overlay module guide.
1 parent acb0bd0 commit 5c91e73

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/cdk/overlay/overlay.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,14 @@ element on the page. This is commonly used for menus, pickers, and tooltips. Whe
3737
connected strategy, a set of preferred positions is provided; the "best" position will be selected
3838
based on how well the overlay would fit within the viewport.
3939

40+
`FlexibleConnectedPositionStrategy` expands upon the functionality from the
41+
`ConnectedPositionStrategy` by adding more advanced features on top of being able to position an
42+
overlay relative to another element on the page. These features include the ability to have an
43+
overlay become scrollable once its content reaches the viewport edge, being able to configure a
44+
margin between the overlay and the viewport edge, having an overlay be pushed into the viewport if
45+
it doesn't fit into any of its preferred positions, as well as configuring whether the overlay's
46+
size can grow while the overlay is open.
47+
4048
A custom position strategy can be created by implementing the `PositionStrategy` interface.
4149
Each `PositionStrategy` defines an `apply` method that is called whenever the overlay's position
4250
should be updated. A custom position strategy can additionally expose any other APIs necessary as

0 commit comments

Comments
 (0)