-
Notifications
You must be signed in to change notification settings - Fork 6.8k
docs(overlay): expand overview for overlay #6976
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
src/cdk/overlay/overlay.md
Outdated
managing that specific overlay. | ||
|
||
The `OverlayRef` _is_ a `PortalHost`- once creates, content can be added by attaching a `Portal`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
once creates -> once created
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
src/cdk/overlay/overlay.md
Outdated
|
||
The `OverlayRef` _is_ a `PortalHost`- once creates, content can be added by attaching a `Portal`. | ||
See the documentation on portals for further information. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Link to the portal docs (if we have any)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
They don't exist yet; I'm planning to do a pass and add cross-references once I have more of the content authored
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Few typos
src/cdk/overlay/overlay.md
Outdated
`BlockScrollStrategy` will block page scrolling while the overlay is open. Note that some | ||
applications may implement special or customized page scrolling; if the `BlockScrollStrategy` | ||
conflicts with this kind of situation, it can overriden by re-providing `BlockScrollStrategy` with |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can overridden -> can be overridden
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
src/cdk/overlay/overlay.md
Outdated
|
||
`RepositionScrollStrategy` will re-position the overlay element on scroll. Note that this will have | ||
some performance impact on scrolling- users should weigh this cost in the context each specific |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
in the context each -> in the context of each
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Comments addressed
src/cdk/overlay/overlay.md
Outdated
managing that specific overlay. | ||
|
||
The `OverlayRef` _is_ a `PortalHost`- once creates, content can be added by attaching a `Portal`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
src/cdk/overlay/overlay.md
Outdated
|
||
The `OverlayRef` _is_ a `PortalHost`- once creates, content can be added by attaching a `Portal`. | ||
See the documentation on portals for further information. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
They don't exist yet; I'm planning to do a pass and add cross-references once I have more of the content authored
src/cdk/overlay/overlay.md
Outdated
`BlockScrollStrategy` will block page scrolling while the overlay is open. Note that some | ||
applications may implement special or customized page scrolling; if the `BlockScrollStrategy` | ||
conflicts with this kind of situation, it can overriden by re-providing `BlockScrollStrategy` with |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
src/cdk/overlay/overlay.md
Outdated
|
||
`RepositionScrollStrategy` will re-position the overlay element on scroll. Note that this will have | ||
some performance impact on scrolling- users should weigh this cost in the context each specific |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
src/cdk/overlay/overlay.md
Outdated
The `FullscreenOverlayContainer` is an alternative to `OverlayContainer` that supports correct | ||
displaying of overlay elements in | ||
[fullscreen mode][https://developer.mozilla.org/en-US/docs/Web/API/Element/requestFullScreen]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Link syntax
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Whoops, good catch
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, aside from the link syntax error.
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
No description provided.