skills/angular__angular
1
0
Fork 0
mirror of https://github.com/angular/angular.git synced 2026-09-14 13:54:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(overlay): add note about pre-built styles (#12993)

Browse Source 
Adds a note about the pre-built overlay styles since we have not mention of them anywhere else in the docs.

Fixes #8717.
This commit is contained in:
Kristiyan Kostadinov
2018-09-05 22:39:26 +02:00
committed by Jeremy Elbourn
parent 5d9ab9eeb2
commit 86be1dcb19
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/cdk/overlay/overlay.md
+10
View File
@@ -1,5 +1,15 @@
The `overlay` package provides a way to open floating panels on the screen.
### Initial setup
The CDK overlays depend on a small set of structural styles to work correctly. If you're using
Angular Material, these styles have been included together with the theme, otherwise if you're
using the CDK on its own, you'll have to include the styles yourself. You can do so by importing
the prebuilt styles in your global stylesheet:
```scss
@import '~@angular/cdk/overlay-prebuilt.css';
```
### Creating overlays
Calling `overlay.create()` will return an `OverlayRef` instance. This instance is a handle for
managing that specific overlay.