Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inadequate paper-drawer-panel documentation #155

Open
codekrolik opened this issue Dec 3, 2016 · 0 comments
Open

Inadequate paper-drawer-panel documentation #155

codekrolik opened this issue Dec 3, 2016 · 0 comments

Comments

@codekrolik
Copy link

codekrolik commented Dec 3, 2016

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant