Skip to content

Commit 867283a

Browse files
committed
change comments
1 parent 6511ebb commit 867283a

File tree

1 file changed

+3
-9
lines changed

1 file changed

+3
-9
lines changed

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

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ export class CdkStickyRegion {
3232
}
3333

3434

35-
// STICK_START_CLASS is used to mark a header is stuck.
35+
/** Class applied when the header is "stuck" */
3636
const STICK_START_CLASS = 'cdk-sticky-header-start';
37-
// STICK_END_CLASS is used to mark a header is unstuck.
37+
/** Class applied when the header is not "stuck" */
3838
const STICK_END_CLASS = 'cdk-sticky-header-end';
3939
/**
4040
* Set a debounce time which is used in debounce() function when adding event listeners.
@@ -62,13 +62,7 @@ export class CdkStickyHeader implements OnDestroy, AfterViewInit {
6262
@Input('cdkStickyHeaderZIndex') zIndex: number = 10;
6363

6464
isStuck: boolean = false;
65-
/**
66-
* isStickyPositionSupported == true, means current browser support 'position: sticky'
67-
* or 'position: -webkit-sticky'.
68-
* isStickyPositionSupported == false, means current browser does not support sticky
69-
* positioning and need to use the original implementation to get the sticky effect.
70-
* @type {boolean}
71-
*/
65+
/** Whether the browser support CSS sticky positioning. */
7266
isStickyPositionSupported: boolean = true;
7367

7468

0 commit comments

Comments
 (0)