angular / material.angular.io

Docs site for Angular Components
http://material.angular.io
MIT License
887 stars 396 forks source link

docs-bug(material-experimental): Experimental by default #1254

Open daleu opened 3 months ago

daleu commented 3 months ago

Documentation Feedback

I have been updating a page from Angular Material v16 to v17. During this process, all the components have been migrated as expected to the new UI, except for the mat-chip component.

Doing a lot of research I found that it was not an error. The mat-chip style was updated as expected, but the documentation for the Angular Material v17 is not showing the same styles.

Checking what was implemented on StackBlitz link that you find on the component overview, I found that the official Angular Material documentation is using the @angular/material-experimental library by default. So the Angular Material documentation page, is showing all the styles based on the @angular/material-experimental library, which as you can find here, nothing in this package is considered stable or production ready.

So, my conclusions are the the official Angular Material documentation is showing all the component styles using and experimental library, when the Angular Material release is stable. If it's expected is ok to maintain it as this, but I would mention somewhere that what you are seeing is experimental.

This is happening from Angular Material v17 and above, and I think that is happening for all the components. I checked on Angular Material v16, and the @angular/material-experimental library is not used to show the components on the documentation.

Thanks in advance! :)

Affected documentation page

https://v17.material.angular.io

amysorto commented 3 months ago

The docs were updated to show M3, and at the time they were in experimental. But I agree if we do show something that is considered experimental there should be something to denote that. I'll move this issue do the docs repo. Thanks for the feedback!