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.

Sign up for GitHub

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

Jump to bottom

docs-bug(badge): Example uses inline elements. #25751

Closed
james-schwartzkopf opened this issue Oct 4, 2022 · 1 comment · Fixed by #25758
Closed

docs-bug(badge): Example uses inline elements. #25751

james-schwartzkopf opened this issue Oct 4, 2022 · 1 comment · Fixed by #25758
Assignees
@crisbeto
Labels
area: material/badge docs This issue is related to documentation P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent

Comments

@james-schwartzkopf
Copy link

Documentation Feedback

Issue #16992 was fixed by adding a line to the docs saying "Badges must always be applied to block-level elements".

This is immediately followed by examples using inline elements.

We recently wasted a lot of time trying to figure out why our badges weren't working till we found this issue, and only then noticed the warning on the badge page.

Affected documentation page

https://material.angular.io/components/badge/overview
@james-schwartzkopf james-schwartzkopf added docs This issue is related to documentation needs triage This issue needs to be triaged by the team labels Oct 4, 2022
crisbeto added a commit to crisbeto/material2 that referenced this issue Oct 5, 2022
@crisbeto
docs(material/badge): don't use inline elements in badge demo
210220c 
The badge docs were saying that badges might not work on inline elements while the example was still using inline elements itself. These changes update the example to use `div` elements instead.

Fixes angular#25751.
@crisbeto crisbeto added P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent has pr area: material/badge and removed needs triage This issue needs to be triaged by the team labels Oct 5, 2022
@crisbeto crisbeto self-assigned this Oct 5, 2022
@crisbeto crisbeto mentioned this issue Oct 5, 2022
Merged
crisbeto added a commit that referenced this issue Oct 7, 2022
@crisbeto
docs(material/badge): don't use inline elements in badge demo (#25758)
d75a87d 
The badge docs were saying that badges might not work on inline elements while the example was still using inline elements itself. These changes update the example to use `div` elements instead.

Fixes #25751.
crisbeto added a commit that referenced this issue Oct 7, 2022
@crisbeto
docs(material/badge): don't use inline elements in badge demo (#25758)
512ba8d 
The badge docs were saying that badges might not work on inline elements while the example was still using inline elements itself. These changes update the example to use `div` elements instead.

Fixes #25751.

(cherry picked from commit d75a87d)
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.
@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Nov 7, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area: material/badge docs This issue is related to documentation P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent
2 participants
@crisbeto @james-schwartzkopf