Blame view

bower_components/paper-scroll-header-panel/README.md 2.46 KB
73bcce88   luigser   COMPONENTS
1
  
a1a3bc73   Luigi Serra   graphs updates
2
  <!---
73bcce88   luigser   COMPONENTS
3
  
a1a3bc73   Luigi Serra   graphs updates
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
  This README is automatically generated from the comments in these files:
  paper-scroll-header-panel.html
  
  Edit those files, and our readme bot will duplicate them over here!
  Edit this file, and the bot will squash your changes :)
  
  -->
  
  [![Build Status](https://travis-ci.org/PolymerElements/paper-scroll-header-panel.svg?branch=master)](https://travis-ci.org/PolymerElements/paper-scroll-header-panel)
  
  _[Demo and API Docs](https://elements.polymer-project.org/elements/paper-scroll-header-panel)_
  
  
  ##&lt;paper-scroll-header-panel&gt;
  
  
  Material design: [Scrolling techniques](https://www.google.com/design/spec/patterns/scrolling-techniques.html)
  
  `paper-scroll-header-panel` contains a header section and a content section.  The
  header is initially on the top part of the view but it scrolls away with the
  rest of the scrollable content.  Upon scrolling slightly up at any point, the
  header scrolls back into view.  This saves screen space and allows users to
  access important controls by easily moving them back to the view.
  
  __Important:__ The `paper-scroll-header-panel` will not display if its parent does not have a height.
  
  Using [layout classes](https://www.polymer-project.org/1.0/docs/migration.html#layout-attributes) or custom properties, you can easily make the `paper-scroll-header-panel` fill the screen
73bcce88   luigser   COMPONENTS
31
32
33
34
35
  
  ```html
  <body class="fullbleed layout vertical">
    <paper-scroll-header-panel class="flex">
      <paper-toolbar>
a1a3bc73   Luigi Serra   graphs updates
36
        <div>Hello World!</div>
73bcce88   luigser   COMPONENTS
37
38
39
40
      </paper-toolbar>
    </paper-scroll-header-panel>
  </body>
  ```
a1a3bc73   Luigi Serra   graphs updates
41
42
43
  
  or, if you would prefer to do it in CSS, just give `html`, `body`, and `paper-scroll-header-panel` a height of 100%:
  
73bcce88   luigser   COMPONENTS
44
45
46
47
48
49
50
51
52
  ```css
  html, body {
    height: 100%;
    margin: 0;
  }
  paper-scroll-header-panel {
    height: 100%;
  }
  ```
a1a3bc73   Luigi Serra   graphs updates
53
54
55
  
  `paper-scroll-header-panel` works well with `paper-toolbar` but can use any element
  that represents a header by adding a `paper-header` class to it.
73bcce88   luigser   COMPONENTS
56
57
58
59
60
61
62
63
  
  ```html
  <paper-scroll-header-panel>
    <paper-toolbar>Header</paper-toolbar>
    <div>Content goes here...</div>
  </paper-scroll-header-panel>
  ```
  
a1a3bc73   Luigi Serra   graphs updates
64
65
  ### Styling
  =======
73bcce88   luigser   COMPONENTS
66
  
a1a3bc73   Luigi Serra   graphs updates
67
  The following custom properties and mixins are available for styling:
73bcce88   luigser   COMPONENTS
68
  
a1a3bc73   Luigi Serra   graphs updates
69
70
71
72
73
  Custom property | Description | Default
  ----------------|-------------|----------
  --paper-scroll-header-panel-full-header | To change background for toolbar when it is at its full size | {}
  --paper-scroll-header-panel-condensed-header | To change the background for toolbar when it is condensed | {}
  --paper-scroll-header-container | To override or add container styles | {}
73bcce88   luigser   COMPONENTS

73bcce88   luigser   COMPONENTS