Components: Docs missing for "fullscreen"

[mackelito]

Bug, feature request, or proposal:

Proposal

What is the expected behavior?

Docs on how to use fullscreen and what it does and when it use it (perhaps also explain potential downsides)

What is the current behavior?

Docs for fullscreen is missing

Note

I'm talking about this added feature https://github.com/angular/material2/commit/aa6c740

[EdricChan03]

@mackelito The fullscreen attribute is just used to make the sidenav container appear fullscreen and to not have a "margin" around the sidenav container.

It uses this to style the sidenav container (Btw, I'm using the latest version of Angular Material 5.0.4):

.mat-drawer-container[fullscreen] {
    top: 0;
    left: 0;
    right: 0;
    bottom: 0;
    position: absolute;
}

[mackelito]

@Chan4077 well this issue was just that there is no docs about it so users will not know that it exists...

As for potential downsides.. it fullscreen is used then the native adressbar will not shrink when scrolling down and for some that might be a big issue ;)

[mmalerba]

We actually plan to remove this, hence its lack of documentation. It's just a shortcut for some CSS that can be applied by the user.

Reasoning is that this is just one of a couple ways users could achieve a fullscreen effect. Instead of an attribute we will expand the relevant docs section (https://material.angular.io/components/sidenav/overview#sizing-the-sidenav) to talk about pros/cons of different fullscreen CSS strategies

[slavafomin]

I've stumbled upon this fullscreen attribute when looking through the code of the demo app. Then I've tried to find it in the documentation, but failed to do so.

I think, this fullscreen aspect should be explained in the documentation, because it's the first thing any new user of the library will try to do. And if your are planning to remove it altogether, then we should update the demo app to not use it, because the demo app should be treated like a canonical way to use the library and right now it promotes the bad thing (i.e. deprecated attribute).

[jrahulroy]

Please add it to documentation, as it wasting everyones time going through the github issues and find the solution