PolymerElements / paper-drawer-panel

A Material Design two-section responsive panel
https://www.webcomponents.org/element/PolymerElements/paper-drawer-panel
25 stars 42 forks source link

Inadequate paper-drawer-panel documentation #155

Open codekrolik opened 7 years ago

codekrolik commented 7 years ago

Description

https://elements.polymer-project.org/elements/paper-drawer-panel

The documentation fails to properly explain the difference between narrow and normal mode, in particular the fact that toggle ONLY WORKS in narrow mode! That makes it incredibly hard to reverse engineer this complicated behavior (by studying a shitton of code).

Moreover, the documentation just plainly states: "The drawer will slide in/out to hide/reveal the main panel." It's absolutely not clear that this statement is about narrow layout, and narrow layout only, so confusing and misleading. Some buttons would just disappear in narrow mode, nothing written about that, too.

Expected outcome

Fix the documentation, properly and fully explain the differences between narrow and normal mode. At least describe how toggling behavior changes between narrow/normal modes and how standard buttons would appear and disappear from page (e.g. with attribute paper-drawer-toggle).

Actual outcome

c86

Live Demo

https://elements.polymer-project.org/elements/paper-drawer-panel

Steps to reproduce

open this and read https://elements.polymer-project.org/elements/paper-drawer-panel