Skip to content

Commit ea9651b

Browse files
committed
change doc
1 parent 8e5e006 commit ea9651b

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

src/lib/sticky-header/sticky-header-dir.ts

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,13 @@ import {Scrollable} from '../core/overlay/scroll/scrollable';
1111

1212

1313
/**
14-
* 'cdkStickyRegion' is a region contains one sticky header and other
15-
* contents that user wants to put under the sticky-header. There only can
16-
* be one sticky-header in one 'cdkStickyRegion'.
17-
* If a user does not define a 'cdkStickyRegion' for a sticky-header, the direct
18-
* parent node of the sticky-header will be set as the 'cdkStickyRegion'.
14+
* Directive that marks an element as a "sticky region", meant to contain exactly one sticky-header
15+
* along with the content associated with that header. The sticky-header inside of the region will
16+
* "stick" to the top of the scrolling container as long as this region is within the scrolling
17+
* viewport.
18+
*
19+
* If a user does not explicitly define a sticky-region for a sticky-header, the direct
20+
* parent node of the sticky-header will be used as the sticky-region.
1921
*/
2022
@Directive({
2123
selector: '[cdkStickyRegion]',

0 commit comments

Comments
 (0)