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

Alert component used in the docs but not available with latest release #19098

Closed
thisismydesign opened this issue Jan 5, 2020 · 4 comments
Closed
Labels
component: alert This is the name of the generic UI component, not the React module!

Comments

@thisismydesign
Copy link

I don't how to use the Alert component showcased here:

The docs specify the dependency as "@material-ui/lab": "^4.0.0-alpha.18", but using the latest v4.8.2 release this component is not there.

Which would make sense as it was added a few days ago: #18702

But it perhaps shouldn't be shown in the documentation yet?

@thisismydesign
Copy link
Author

Closing in favor of root cause issue: #19099

@mbrookes
Copy link
Member

mbrookes commented Jan 6, 2020

I don't how to use the Alert component showcased here:
material-ui.com/components/snackbars/#customized-snackbars

You can use the "Show the source" button to view the source, or the "Copy the source" button to copy it.

The docs specify the dependency as "@material-ui/lab"

No, they don't (not until the next release).

But it perhaps shouldn't be shown in the documentation yet?

It isn't.

But reading between the lines, I suspect you might be following the GitHub link? If so I agree it makes a certain amount of sense to link to the same version of the code there, but it does somewhat depend on your reason for viewing the code in GitHub, rather than viewing the published version of the demo code natively in the docs.

@thisismydesign
Copy link
Author

But reading between the lines, I suspect you might be following the GitHub link?

Yes (but I quite literally closed this issue and stated just that in the referenced one).

I'm sure you know best but your doc references a doc folder in your github which has incorrect information. We can argue about what counts as "in the documentation" but you can't argue away a bad user experience.

@oliviertassinari
Copy link
Member

oliviertassinari commented Jan 6, 2020

@mbrookes what's the advantage of linking the HEAD vs the tag of the release? I don't remember why we didn't link the tag.

@zannager zannager added the component: alert This is the name of the generic UI component, not the React module! label Dec 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: alert This is the name of the generic UI component, not the React module!
Projects
None yet
Development

No branches or pull requests

4 participants