Sticky header demo code (#6033)

* add lib files for sticky-header

add chose parent

add support to 'optional 'cdkStickyRegion' input '

add app-demo for sticky-header

fix bugs and deleted unused tag id in HTML files

modify

fix some code according to PR review comments

change some format to pass TSlint check

add '_' before private elements

delete @Injectable for StickyHeaderDirective. Because we do not need @Injectable

refine code

encapsulate 'set style for element'

change @input()

Delete 'Observable.fromEvent(this.upperScrollableContainer, 'scroll')'

add const STICK_START_CLASS and STICK_END_CLASS

Add doc for [cdkStickyRegion] and 'unstuckElement()'. Delete 'detach()' function, add its content into 'ngOnDestroy()'.

change 'MdStickyHeaderModule' to 'CdkStickyHeaderModule';

encapsulate reset css style operation for sticky header.

delete unnecessary gloable variables

delete global variable '_width'

Add doc for 'sticker()' function. explained how it works.

add more doc for 'sticker()', explaining 'isStuck' flag

2 space for indent

fix

delete sticky-header demo part from this branch

revert firebase file

change code according to comments in PR

revert firbaserc

revert demo-app.ts

revert routes.ts

revert demo-app-module.ts

change

fix the problem of : 'this.stickyParent' might be 'null'

change doc

Change the constructor of 'cdkStickyRegion' to 'constructor(public readonly _elementRef: ElementRef) { }'

Added prefix 'mat-' for CSS class

Delete 'public' before variables

Object.assign isn't supported in IE11; use extendObject from src/lib/core/util.

 IE11 will have trouble with  `translate3d(0, 0, 0);', change to `translate3d(0px, 0px, 0px);'

Added docs for all variables

extract 'generate CSS style'

created a generateStyleCSS() function, let it be responsible for generating all those CSS styles.

reformat

add debounce to solve 'getBoundingClientRect() cause slow down' problem.

add position:sticky and check whether browser support it. If not , use the naive implementation

Removed unused 'scrollableRegion' and 'parentRegion'

removed commented lines

default public

Add comments about why setting style top and position for iPhone and not IE. And extract detectBrowser() as a new function

format

consider all circumstances of browser.

use "===" instead of '=='

 make 'navigator.userAgent.toLocaleLowerCase()' a local variable

optimize

Added comments on const 'STICK_START_CLASS' and 'STICK_END_CLASS'.
change their content to cdk-sticky-header-start and cdk-sticky-header-end

Added comments for STICK_START_CLASS and STICK_END_CLASS.

Changed the format of one-line JsDoc

unsubscribe sbscriptions onDestory

Use what modernizr does on compatibility instead of get the browser version directly.

add 'padding' and 'stickyRegionHeight' variables to avoid calling 'getComputedStyle()' too many times (which is expensive).

move docs above @directive

removed the underscore in'_element: ElementRef',

expand 'reg' to 'region'

use 'if (this.isIE)' instead of 'if(this.isIE === true)'

added more newlines between params in 'generateCssStyle()' function to make it easier to understand.

Added reference link to Modernizer in docs of getSupportList()

Deleted "_supportList" variable

renamed 'isIE' to 'isStickyPositionSupported', and removed extra space before Observable

Set debounce time as a const variable

Added docs for 'const DEBOUNCE_TIME: number = 5;'

Changed ' if(this.stickyParent == null)' to ' if(!this.stickyParent)'

 Removed the @param and @returns and make sure the types are correct in the function signature in 'generateCssStyle(...)' function

Added docs for `isStickyPositionSupported` variable

changed '+=' to '=' of 'stickyText' in getSupportList() function

nit added " " between 'if' and '('

nit

Added comments

deleted unused import

change comments

optimize comments

deleted unnecessary global variables(padding and stickyRegionHeight)

Added check whether we are on browser

Array<string> to string[]

test?

try to reopen the old PR

fix after rebase

revert list.ts

test

test 222

revert demo

revert list.ts second time

Move code to 'src/cdk'

revert 'move code to 'src/cdk'' , it should be done in a new PR

revert

avoid calling 'getComputedStyle()' too many times.

rename as sticky-header.ts

Add blank lines between these top-level symbol

make '_isStickyPositionSupported' private

Changed the originalCSS to private and use '{} as CSSStyleDeclaration' instead of ''any.

Rename '_containerStart' to '_stickyRegionTop'

rename

optimize discription for '_stickyRegionBottomThreshold'

private _originalStyles = {
      position: '',
      top: '',
      right: '',
      left: '',
      bottom: '',
      width:  '',
      zIndex: ''};

Deleted 'generateCssStyle()' and 'getCssNumber()' function

Deleted 'getCssValue()' function

fix CSSStyleDeclaration

change sticky width to 'this.upperScrollableContainer.clientWidth'

fix

nit

Added the 'isPositionStickySupported() ' function  to src/cdk/platform/features.ts.
Consume that function in this component and just always use both the webkit and unprefixed styles.

nit

update doc 'Debounce time in milliseconds for events that affect the sticky positioning (e.g. scroll, resize, touch move). Set as 5 milliseconds which is the highest delay that doesn't drastically affect the positioning adversely.'

changed the doc to  '/** z-index to be applied to the sticky header (default is 10). */'

fix tslint error

for comment 'Can you evaluate each method to make sure their accessor privacy is right? E.g. see which functions need to be public, private, static, etc'

Deleted variable 'elemHeight'

Chaned to 'if (!this.stickyParent)'

Simplified Docs for 'sticker()'.

set 'defineRestriction()' function to private

use 'RxChain'

rename to  '_isPositionStickySupported'

Use // for comments, /* */ for docs

@angular/cdk

rename : values -> headerStyles

Move closing brace to the next line

optimized: [this._onScrollSubscription, this._onScrollSubscription, this._onResizeSubscription]
        .forEach(s => s && s.unsubscribe());

You should be able to do just '0' instead of '0px'

Format like TODO(sllethe): ...

private _attachEventListeners? Add a description like "Add listeners for events that affect sticky positioning."

optimize doc

Rename 'defineRestrictions' to '_measureStickyRegionBounds'

rename: private _resetElementStyles

let stuckRight: any = this.upperScrollableContainer.getBoundingClientRect().right;
chaned 'any' to 'number'

nit

change doc '/**
   * Unsticks the header so that it goes back to scrolling normally.
   *
   * This should be called when the element reaches the bottom of its cdkStickyRegion so that it
   * smoothly scrolls out of view as the next sticky-header moves in.
   */'

_unstuckElement -> _unstickElement

rename 'sticker()' to '_applyStickyPositionStyles()'

rename 'defineRestrictionsAndStick()' to '_updateStickyPositioning()'

Add demo to sticky-header

add lib files for sticky-header

add chose parent

add support to 'optional 'cdkStickyRegion' input '

add app-demo for sticky-header

fix bugs and deleted unused tag id in HTML files

modify

fix some code according to PR review comments

change some format to pass TSlint check

add '_' before private elements

delete @Injectable for StickyHeaderDirective. Because we do not need @Injectable

* # This is a combination of 7 commits.
# This is the 1st commit message:

# This is a combination of 3 commits.
# This is the 1st commit message:

# This is a combination of 6 commits.
# This is the 1st commit message:

refine code

encapsulate 'set style for element'

change @input()

Delete 'Observable.fromEvent(this.upperScrollableContainer, 'scroll')'

add const STICK_START_CLASS and STICK_END_CLASS

Add doc for [cdkStickyRegion] and 'unstuckElement()'. Delete 'detach()' function, add its content into 'ngOnDestroy()'.

encapsulate reset css style operation for sticky header.

delete unnecessary gloable variables

delete global variable '_width'

Add doc for 'sticker()' function. explained how it works.

add more doc for 'sticker()', explaining 'isStuck' flag

2 space for indent

fix

delete sticky-header demo part from this branch

# This is the commit message #2:

revert firebase file
# This is the commit message #3:

change code according to comments in PR
# This is the commit message #4:

revert firbaserc
# This is the commit message #5:

revert demo-app.ts
# This is the commit message #6:

revert routes.ts
# This is the commit message #2:

change
# This is the commit message #3:

fix the problem of : 'this.stickyParent' might be 'null'
# This is the commit message #2:

change doc
# This is the commit message #3:

Change the constructor of 'cdkStickyRegion' to 'constructor(public readonly _elementRef: ElementRef) { }'
# This is the commit message #4:

Added prefix 'mat-' for CSS class
# This is the commit message #5:

Delete 'public' before variables
# This is the commit message #6:

Object.assign isn't supported in IE11; use extendObject from src/lib/core/util.
# This is the commit message #7:

 IE11 will have trouble with  `translate3d(0, 0, 0);', change to `translate3d(0px, 0px, 0px);'

* refine code

encapsulate 'set style for element'

change @input()

Delete 'Observable.fromEvent(this.upperScrollableContainer, 'scroll')'

add const STICK_START_CLASS and STICK_END_CLASS

Add doc for [cdkStickyRegion] and 'unstuckElement()'. Delete 'detach()' function, add its content into 'ngOnDestroy()'.

encapsulate reset css style operation for sticky header.

delete unnecessary gloable variables

delete global variable '_width'

Add doc for 'sticker()' function. explained how it works.

add more doc for 'sticker()', explaining 'isStuck' flag

2 space for indent

fix

delete sticky-header demo part from this branch

revert firebase file

change code according to comments in PR

revert firbaserc

revert demo-app.ts

revert routes.ts

change

fix the problem of : 'this.stickyParent' might be 'null'

change doc

Change the constructor of 'cdkStickyRegion' to 'constructor(public readonly _elementRef: ElementRef) { }'

Added prefix 'mat-' for CSS class

Delete 'public' before variables

Object.assign isn't supported in IE11; use extendObject from src/lib/core/util.

 IE11 will have trouble with  `translate3d(0, 0, 0);', change to `translate3d(0px, 0px, 0px);'

Added docs for all variables

extract 'generate CSS style'

created a generateStyleCSS() function, let it be responsible for generating all those CSS styles.

reformat

add debounce to solve 'getBoundingClientRect() cause slow down' problem.

add position:sticky and check whether browser support it. If not , use the naive implementation

removed unused import

Removed unused 'scrollableRegion' and 'parentRegion'

removed commented lines

default public

Add comments about why setting style top and position for iPhone and not IE. And extract detectBrowser() as a new function

format

consider all circumstances of browser.

use "===" instead of '=='

 make 'navigator.userAgent.toLocaleLowerCase()' a local variable

optimize

Added comments on const 'STICK_START_CLASS' and 'STICK_END_CLASS'.
change their content to cdk-sticky-header-start and cdk-sticky-header-end

Added comments for STICK_START_CLASS and STICK_END_CLASS.

Changed the format of one-line JsDoc

unsubscribe sbscriptions onDestory

Use what modernizr does on compatibility instead of get the browser version directly.

add 'padding' and 'stickyRegionHeight' variables to avoid calling 'getComputedStyle()' too many times (which is expensive).

move docs above @directive

removed the underscore in'_element: ElementRef',

expand 'reg' to 'region'

use 'if (this.isIE)' instead of 'if(this.isIE === true)'

added more newlines between params in 'generateCssStyle()' function to make it easier to understand.

Added reference link to Modernizer in docs of getSupportList()

Deleted "_supportList" variable

renamed 'isIE' to 'isStickyPositionSupported', and removed extra space before Observable

Set debounce time as a const variable

Added docs for 'const DEBOUNCE_TIME: number = 5;'

Changed ' if(this.stickyParent == null)' to ' if(!this.stickyParent)'

 Removed the @param and @returns and make sure the types are correct in the function signature in 'generateCssStyle(...)' function

Added docs for `isStickyPositionSupported` variable

changed '+=' to '=' of 'stickyText' in getSupportList() function

nit added " " between 'if' and '('

nit

Added comments

deleted unused import

change comments

optimize comments

deleted unnecessary global variables(padding and stickyRegionHeight)

Added check whether we are on browser

Array<string> to string[]

test?

try to reopen the old PR

fix after rebase

revert list.ts

test

test 222

revert demo

revert list.ts second time

Move code to 'src/cdk'

revert 'move code to 'src/cdk'' , it should be done in a new PR

revert

avoid calling 'getComputedStyle()' too many times.

rename as sticky-header.ts

imported PlatformModule

Add blank lines between these top-level symbol

make '_isStickyPositionSupported' private

Changed the originalCSS to private and use '{} as CSSStyleDeclaration' instead of ''any.

Rename '_containerStart' to '_stickyRegionTop'

rename

optimize discription for '_stickyRegionBottomThreshold'

private _originalStyles = {
      position: '',
      top: '',
      right: '',
      left: '',
      bottom: '',
      width:  '',
      zIndex: ''};

Deleted 'generateCssStyle()' and 'getCssNumber()' function

Deleted 'getCssValue()' function

fix CSSStyleDeclaration

change sticky width to 'this.upperScrollableContainer.clientWidth'

fix

nit

Added the 'isPositionStickySupported() ' function  to src/cdk/platform/features.ts.
Consume that function in this component and just always use both the webkit and unprefixed styles.

nit

nit

update doc 'Debounce time in milliseconds for events that affect the sticky positioning (e.g. scroll, resize, touch move). Set as 5 milliseconds which is the highest delay that doesn't drastically affect the positioning adversely.'

changed the doc to  '/** z-index to be applied to the sticky header (default is 10). */'

fix tslint error

for comment 'Can you evaluate each method to make sure their accessor privacy is right? E.g. see which functions need to be public, private, static, etc'

Deleted variable 'elemHeight'

Chaned to 'if (!this.stickyParent)'

Simplified Docs for 'sticker()'.

set 'defineRestriction()' function to private

use 'RxChain'

deleted unused 'tableModule' in modules.ts

rename to  '_isPositionStickySupported'

Use // for comments, /* */ for docs

@angular/cdk

rename : values -> headerStyles

Move closing brace to the next line

optimized: [this._onScrollSubscription, this._onScrollSubscription, this._onResizeSubscription]
        .forEach(s => s && s.unsubscribe());

You should be able to do just '0' instead of '0px'

Format like TODO(sllethe): ...

private _attachEventListeners? Add a description like "Add listeners for events that affect sticky positioning."

optimize doc

Rename 'defineRestrictions' to '_measureStickyRegionBounds'

rename: private _resetElementStyles

let stuckRight: any = this.upperScrollableContainer.getBoundingClientRect().right;
chaned 'any' to 'number'

nit

change doc '/**
   * Unsticks the header so that it goes back to scrolling normally.
   *
   * This should be called when the element reaches the bottom of its cdkStickyRegion so that it
   * smoothly scrolls out of view as the next sticky-header moves in.
   */'

_unstuckElement -> _unstickElement

rename 'sticker()' to '_applyStickyPositionStyles()'

rename 'defineRestrictionsAndStick()' to '_updateStickyPositioning()'

* Add demo to sticky-header

* revert

* deleted HEAD file

* removed unused 'id'

* changed class name to a more meaningful name

* removed unused CSS

* You have lots of duplicate of -webkit-appearance: none;padding: 20px;. Merge them into one

* nit

* nit: use header-style and header-color1

* very nit: add some different text so we can see the changes?

* fix according to comments in pr

* fix white space between different <div>s

* P -> p

Author: sllethe

src/demo-app/demo-app-module.ts

@@ -76,10 +76,12 @@ import {
   MdToolbarModule,
   MdTooltipModule,
   OverlayContainer,
-  StyleModule
+  StyleModule,
+  StickyHeaderModule
 } from '@angular/material';
 import {CdkTableModule} from '@angular/cdk';
 import {TableHeaderDemo} from './table/table-header-demo';
+import {StickyHeaderDemo} from './sticky-header/sticky-header-demo';
 
 /**
  * NgModule that includes all Material modules that are required to serve the demo-app.
@@ -118,7 +120,8 @@ import {TableHeaderDemo} from './table/table-header-demo';
     MdTooltipModule,
     MdNativeDateModule,
     CdkTableModule,
-    StyleModule
+    StyleModule,
+    StickyHeaderModule
   ]
 })
 export class DemoMaterialModule {}
@@ -184,6 +187,7 @@ export class DemoMaterialModule {}
     PlatformDemo,
     TypographyDemo,
     ExpansionDemo,
+    StickyHeaderDemo
   ],
   providers: [
     {provide: OverlayContainer, useClass: FullscreenOverlayContainer},

src/demo-app/demo-app/demo-app.ts

@@ -67,7 +67,8 @@ export class DemoApp {
     {name: 'Tooltip', route: 'tooltip'},
     {name: 'Platform', route: 'platform'},
     {name: 'Style', route: 'style'},
-    {name: 'Typography', route: 'typography'}
+    {name: 'Typography', route: 'typography'},
+    {name: 'Sticky Header', route: 'sticky-header'}
   ];
 
   constructor(private _element: ElementRef) {

src/demo-app/demo-app/routes.ts

@@ -36,6 +36,7 @@ import {DatepickerDemo} from '../datepicker/datepicker-demo';
 import {TableDemo} from '../table/table-demo';
 import {TypographyDemo} from '../typography/typography-demo';
 import {ExpansionDemo} from '../expansion/expansion-demo';
+import {StickyHeaderDemo} from '../sticky-header/sticky-header-demo';
 
 export const DEMO_APP_ROUTES: Routes = [
   {path: '', component: Home},
@@ -74,4 +75,5 @@ export const DEMO_APP_ROUTES: Routes = [
   {path: 'style', component: StyleDemo},
   {path: 'typography', component: TypographyDemo},
   {path: 'expansion', component: ExpansionDemo},
+  {path: 'sticky-header', component: StickyHeaderDemo}
 ];

src/demo-app/sticky-header/sticky-header-demo.html

@@ -0,0 +1,33 @@
+<div class="demo-sticky">
+  <div class="demo-centered" cdk-scrollable>
+    <div>
+      <h1>Sticky-header Demo</h1>
+    </div>
+
+    <div class="demo-container">
+
+      <div>
+        <div cdkStickyHeader class="demo-header-style demo-header-color3" >
+          <h2>Unread Messages</h2>
+        </div>
+        <p *ngFor="let item of items">{{item.name}} :  {{item.messages}}</p>
+      </div>
+
+      <div cdkStickyRegion >
+        <div cdkStickyHeader class="demo-header-style demo-header-color2">
+          <h2>Late Messages</h2>
+        </div>
+        <p *ngFor="let item of items">{{item.name}} :  {{item.messages}}</p>
+        <p *ngFor="let item of items">{{item.name}} :  {{item.messages}}</p>
+      </div>
+
+      <div cdkStickyRegion>
+        <div cdkStickyHeader class="demo-header-style demo-header-color1" >
+          <h2>Read Messages</h2>
+        </div>
+        <p *ngFor="let item of items">{{item.name}} :  {{item.messages}}</p>
+        <p *ngFor="let item of items">{{item.name}} :  {{item.messages}}</p>
+      </div>
+    </div>
+  </div>
+</div>

src/demo-app/sticky-header/sticky-header-demo.scss

@@ -0,0 +1,80 @@
+.demo-sticky {
+  .demo-centered {
+    text-align: left;
+    -webkit-appearance: none;
+    -moz-appearance: none;
+    height: 500px;
+    overflow: auto;}
+
+  button {
+    position: fixed;
+    margin: 16px;
+    z-index: 99;
+  }
+
+  * {
+    margin: 0;
+    padding: 0;
+  }
+
+  body {
+    font: 14px/1.5 Helvetica, Arial, sans-serif;
+    -webkit-appearance: none;
+    -moz-appearance: none;
+
+  }
+
+  h1 {
+    font-size: 20px;
+    padding: 20px;
+    -webkit-appearance: none;
+    -moz-appearance: none;
+  }
+
+  h2 {
+    font-size: 20px;
+    padding: 20px;
+    -webkit-appearance: none;
+    -moz-appearance: none;
+  }
+
+  p {
+    text-indent: 4em;
+    padding:15px;
+    -webkit-appearance: none;
+    -moz-appearance: none;
+  }
+
+  div{
+    margin: 0; border: 0; padding: 0;
+    -webkit-appearance: none;
+    -moz-appearance: none;
+  }
+}
+
+.mat-radio-button {
+  display: block;
+}
+
+.demo-container {
+  margin: 0;
+  -webkit-appearance: none;
+  -moz-appearance: none;
+}
+
+.demo-header-style{
+  -webkit-appearance: none;
+  padding: 20px;
+}
+
+.demo-header-color1 {
+  background: #cecece;
+}
+
+.demo-header-color2 {
+  background: #cea7a7;
+}
+
+.demo-header-color3 {
+  background: #c2eae5;
+}

src/demo-app/sticky-header/sticky-header-demo.ts

@@ -0,0 +1,27 @@
+import {Component} from '@angular/core';
+import {BrowserModule} from '@angular/platform-browser';
+import {CdkStickyRegion, CdkStickyHeader} from '@angular/material';
+
+
+@Component({
+  moduleId: module.id,
+  selector: 'sticky-header-demo',
+  templateUrl: 'sticky-header-demo.html',
+  styleUrls: ['sticky-header-demo.css'],
+})
+
+export class StickyHeaderDemo {
+  items: any[] = [
+    {name: 'Min', messages: 'Brunch is this weekend?'},
+    {name: 'Li', messages: 'Yes'},
+    {name: 'Chan', messages: 'Looking'},
+    {name: 'Chan', messages: 'Forward'},
+    {name: 'Chan', messages: 'To It !'},
+    {name: 'Min', messages: 'Branch is this weekend?'},
+    {name: 'Eat', messages: 'Green Peppers'},
+    {name: 'Chan', messages: 'Where?'},
+    {name: 'Jack', messages: 'Pirate!'},
+    {name: 'Jone', messages: 'Black pearl'},
+    {name: 'Jack', messages: 'Back to the sea!'},
+  ];
+}