Blame view

bower_components/paper-header-panel/README.md 3.75 KB
a1a3bc73   Luigi Serra   graphs updates
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
  
  <!---
  
  This README is automatically generated from the comments in these files:
  paper-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-header-panel.svg?branch=master)](https://travis-ci.org/PolymerElements/paper-header-panel)
  
  _[Demo and API Docs](https://elements.polymer-project.org/elements/paper-header-panel)_
  
  
  ##&lt;paper-header-panel&gt;
  
73bcce88   luigser   COMPONENTS
19
20
21
22
23
24
25
26
27
28
29
30
31
32
  
  `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>
a1a3bc73   Luigi Serra   graphs updates
33
  
73bcce88   luigser   COMPONENTS
34
35
36
37
38
39
40
41
42
  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>
a1a3bc73   Luigi Serra   graphs updates
43
  
73bcce88   luigser   COMPONENTS
44
45
46
47
48
49
50
51
52
  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>
a1a3bc73   Luigi Serra   graphs updates
53
  
73bcce88   luigser   COMPONENTS
54
55
56
57
58
59
  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>
73bcce88   luigser   COMPONENTS
60
  
a1a3bc73   Luigi Serra   graphs updates
61
62
63
64
  ### Modes
  
  Controls header and scrolling behavior. Options are `standard`, `seamed`, `waterfall`, `waterfall-tall`, `scroll` and
  `cover`. Default is `standard`.
73bcce88   luigser   COMPONENTS
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
  
  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>
a1a3bc73   Luigi Serra   graphs updates
81
82
83
  
  
  ### Styling
73bcce88   luigser   COMPONENTS
84
85
86
87
88
89
90
91
92
93
  
  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);
        };
      }
a1a3bc73   Luigi Serra   graphs updates
94
  
73bcce88   luigser   COMPONENTS
95
96
  To change the panel container in different modes:
  
a1a3bc73   Luigi Serra   graphs updates
97
      paper-header-panel {
73bcce88   luigser   COMPONENTS
98
99
100
        --paper-header-panel-standard-container: {
          border: 1px solid gray;
        };
a1a3bc73   Luigi Serra   graphs updates
101
  
73bcce88   luigser   COMPONENTS
102
103
104
        --paper-header-panel-seamed-container: {
          border: 1px solid gray;
        };
a1a3bc73   Luigi Serra   graphs updates
105
  
73bcce88   luigser   COMPONENTS
106
107
108
        --paper-header-panel-waterfall-container: {
          border: 1px solid gray;
        };
a1a3bc73   Luigi Serra   graphs updates
109
  
73bcce88   luigser   COMPONENTS
110
111
112
        --paper-header-panel-waterfall-tall-container: {
          border: 1px solid gray;
        };
a1a3bc73   Luigi Serra   graphs updates
113
  
73bcce88   luigser   COMPONENTS
114
115
116
        --paper-header-panel-scroll-container: {
          border: 1px solid gray;
        };
a1a3bc73   Luigi Serra   graphs updates
117
  
73bcce88   luigser   COMPONENTS
118
119
120
121
        --paper-header-panel-cover-container: {
          border: 1px solid gray;
        };
      }
a1a3bc73   Luigi Serra   graphs updates