polymer_1.2.3/bower_components/paper-header-panel/README.md - Issue 1581713003: [third_party] add polymer 1.2.3

Side by Side Diff: polymer_1.2.3/bower_components/paper-header-panel/README.md

Issue 1581713003: [third_party] add polymer 1.2.3 (Closed) Base URL: https://chromium.googlesource.com/infra/third_party/npm_modules.git@master

Patch Set: 1.2.3 Created 4 years, 11 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch

« no previous file with comments | « polymer_1.2.3/bower_components/paper-header-panel/CONTRIBUTING.md ('k') | polymer_1.2.3/bower_components/paper-header-panel/bower.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

OLD	NEW
(Empty)
	1

	2 <!---

	3

	4 This README is automatically generated from the comments in these files:

	5 paper-header-panel.html

	6

	7 Edit those files, and our readme bot will duplicate them over here!

	8 Edit this file, and the bot will squash your changes :)

	9

	10 -->

	11

	12 [![Build Status](https://travis-ci.org/PolymerElements/paper-header-panel.svg?br anch=master)](https://travis-ci.org/PolymerElements/paper-header-panel)

	13

	14 _[Demo and API Docs](https://elements.polymer-project.org/elements/paper-header- panel)_

	15

	16

	17 ##<paper-header-panel>

	18

	19

	20 `paper-header-panel` contains a header section and a content panel section.

	21

	22 __Important:__ The `paper-header-panel` will not display if its parent does not have a height.

	23

	24 Using layout classes, you can make the `paper-header-panel` fill the screen

	25

	26 <body class="fullbleed layout vertical">

	27 <paper-header-panel class="flex">

	28 <paper-toolbar>

	29 <div>Hello World!</div>

	30 </paper-toolbar>

	31 </paper-header-panel>

	32 </body>

	33

	34 Special support is provided for scrolling modes when one uses a paper-toolbar or equivalent for the

	35 header section.

	36

	37 Example:

	38

	39 <paper-header-panel>

	40 <paper-toolbar>Header</paper-toolbar>

	41 <div>Content goes here...</div>

	42 </paper-header-panel>

	43

	44 If you want to use other than `paper-toolbar` for the header, add `paper-header` class to that

	45 element.

	46

	47 Example:

	48

	49 <paper-header-panel>

	50 <div class="paper-header">Header</div>

	51 <div>Content goes here...</div>

	52 </paper-header-panel>

	53

	54 To have the content fit to the main area, use the `fit` class.

	55

	56 <paper-header-panel>

	57 <div class="paper-header">standard</div>

	58 <div class="fit">content fits 100% below the header</div>

	59 </paper-header-panel>

	60

	61 ### Modes

	62

	63 Controls header and scrolling behavior. Options are `standard`, `seamed`, `water fall`, `waterfall-tall`, `scroll` and

	64 `cover`. Default is `standard`.

	65

	66 Mode \| Description

	67 ----------------\|-------------

	68 `standard` \| The header is a step above the panel. The header will consume the p anel at the point of entry, preventing it from passing through to the opposite s ide.

	69 `seamed` \| The header is presented as seamed with the panel.

	70 `waterfall` \| Similar to standard mode, but header is initially presented as sea med with panel, but then separates to form the step.

	71 `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 conde nsing (`tall` class is removed from the header).

	72 `scroll` \| The header keeps its seam with the panel, and is pushed off screen.

	73 `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 co vering the header.

	74

	75 Example:

	76

	77 <paper-header-panel mode="waterfall">

	78 <div class="paper-header">standard</div>

	79 <div class="content fit">content fits 100% below the header</div>

	80 </paper-header-panel>

	81

	82

	83 ### Styling

	84

	85 To change the shadow that shows up underneath the header:

	86

	87 paper-header-panel {

	88 --paper-header-panel-shadow: {

	89 height: 6px;

	90 bottom: -6px;

	91 box-shadow: inset 0px 5px 6px -3px rgba(0, 0, 0, 0.4);

	92 };

	93 }

	94

	95 To change the panel container in different modes:

	96

	97 paper-header-panel {

	98 --paper-header-panel-standard-container: {

	99 border: 1px solid gray;

	100 };

	101

	102 --paper-header-panel-seamed-container: {

	103 border: 1px solid gray;

	104 };

	105

	106 --paper-header-panel-waterfall-container: {

	107 border: 1px solid gray;

	108 };

	109

	110 --paper-header-panel-waterfall-tall-container: {

	111 border: 1px solid gray;

	112 };

	113

	114 --paper-header-panel-scroll-container: {

	115 border: 1px solid gray;

	116 };

	117

	118 --paper-header-panel-cover-container: {

	119 border: 1px solid gray;

	120 };

	121 }

	122

	123

OLD	NEW