SGH / COMPONENTS

Blame view

bower_components/paper-header-panel/README.md 3.29 KB
Edit Raw Normal View History
c5169e0e   Renato De Donato   a new hope 
1
 
  # paper-header-panel
73bcce88   luigser   COMPONENTS 
2
3
4
5
6
7
8
9
10
11
12
13
14
15
 
  
  `paper-header-panel` contains a header section and a content panel section.
  
  __Important:__ The `paper-header-panel` will not display if its parent does not have a height.
  
  Using layout classes, you can make the `paper-header-panel` fill the screen
  
      <body class="fullbleed layout vertical">
        <paper-header-panel class="flex">
          <paper-toolbar>
            <div>Hello World!</div>
          </paper-toolbar>
        </paper-header-panel>
      </body>
c5169e0e   Renato De Donato   a new hope 
16
73bcce88   luigser   COMPONENTS 
17
18
19
20
21
22
23
24
25
 
  Special support is provided for scrolling modes when one uses a paper-toolbar or equivalent for the
  header section.
  
  Example:
  
      <paper-header-panel>
        <paper-toolbar>Header</paper-toolbar>
        <div>Content goes here...</div>
      </paper-header-panel>
c5169e0e   Renato De Donato   a new hope 
26
27
73bcce88   luigser   COMPONENTS 
28
29
30
31
32
33
34
35
36
 
  If you want to use other than `paper-toolbar` for the header, add `paper-header` class to that
  element.
  
  Example:
  
      <paper-header-panel>
        <div class="paper-header">Header</div>
        <div>Content goes here...</div>
      </paper-header-panel>
c5169e0e   Renato De Donato   a new hope 
37
73bcce88   luigser   COMPONENTS 
38
39
40
41
42
43
 
  To have the content fit to the main area, use the `fit` class.
  
      <paper-header-panel>
        <div class="paper-header">standard</div>
        <div class="fit">content fits 100% below the header</div>
      </paper-header-panel>
c5169e0e   Renato De Donato   a new hope 
44
45
 
      
  ## Modes
73bcce88   luigser   COMPONENTS 
46
c5169e0e   Renato De Donato   a new hope 
47
 
  Controls header and scrolling behavior. Options are `standard`, `seamed`, `waterfall`, `waterfall-tall`, `scroll` and `cover`. Default is `standard`.
73bcce88   luigser   COMPONENTS 
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
  
  Mode | Description
  ----------------|-------------
  `standard` | The header is a step above the panel. The header will consume the panel at the point of entry, preventing it from passing through to the opposite side.
  `seamed` | The header is presented as seamed with the panel.
  `waterfall` | Similar to standard mode, but header is initially presented as seamed with panel, but then separates to form the step.
  `waterfall-tall` | The header is initially taller (`tall` class is added to the header). As the user scrolls, the header separates (forming an edge) while condensing (`tall` class is removed from the header).
  `scroll` | The header keeps its seam with the panel, and is pushed off screen.
  `cover` | The panel covers the whole `paper-header-panel` including the header. This allows user to style the panel in such a way that the panel is partially covering the header.
  
  Example:
  
      <paper-header-panel mode="waterfall">
        <div class="paper-header">standard</div>
        <div class="content fit">content fits 100% below the header</div>
      </paper-header-panel>
c5169e0e   Renato De Donato   a new hope 
64
65
 
      
  ## Styling header panel:
73bcce88   luigser   COMPONENTS 
66
67
68
69
70
71
72
73
74
75
 
  
  To change the shadow that shows up underneath the header:
  
      paper-header-panel {
        --paper-header-panel-shadow: {
            height: 6px;
            bottom: -6px;
            box-shadow: inset 0px 5px 6px -3px rgba(0, 0, 0, 0.4);
        };
      }
73bcce88   luigser   COMPONENTS 
76
77
 
  To change the panel container in different modes:
c5169e0e   Renato De Donato   a new hope 
78
 
      paper-slider {
73bcce88   luigser   COMPONENTS 
79
80
81
 
        --paper-header-panel-standard-container: {
          border: 1px solid gray;
        };
73bcce88   luigser   COMPONENTS 
82
83
84
 
        --paper-header-panel-seamed-container: {
          border: 1px solid gray;
        };
73bcce88   luigser   COMPONENTS 
85
86
87
 
        --paper-header-panel-waterfall-container: {
          border: 1px solid gray;
        };
73bcce88   luigser   COMPONENTS 
88
89
90
 
        --paper-header-panel-waterfall-tall-container: {
          border: 1px solid gray;
        };
73bcce88   luigser   COMPONENTS 
91
92
93
 
        --paper-header-panel-scroll-container: {
          border: 1px solid gray;
        };
73bcce88   luigser   COMPONENTS 
94
95
96
97
 
        --paper-header-panel-cover-container: {
          border: 1px solid gray;
        };
      }