build: update dgeni templates to include deprecated tag description
#29873
Conversation
angular-robot
bot
added
the
area: build & ci
previously we weren't showing any other information other than `breaking-change` for deprecated fields, this commit adds a component that protrays information regarding deprecation in tooltips rather than `title` attribute closes angular/components#29873
|
see comment for a preview. |
| @@ -6,9 +6,7 @@ <h4 id="{$ constant.name $}" class="docs-header-link docs-api-h4 docs-api-consta | |||
| </h4> | |||
|
|
|||
| {%- if constant.isDeprecated -%} | |||
| <div class="docs-api-constant-deprecated-marker" {$ macros.deprecationTitle(constant) $}> | |||
| Deprecated | |||
There was a problem hiding this comment.
Should we always keep Deprecated for accessibility reasons?
There was a problem hiding this comment.
if you mean Deprecated text I made it change so that deprecationTitle have two parameter, the first one is the doc itself and second one is the label we would like to show tooltip against. In case of just keeping Deprecated we won't be able to show tooltip against deprecated class name or so.
There was a problem hiding this comment.
I don't fully remember how it's showing up right now, but I was thinking we want some static text, next to the "class name" showing "Deprecated". That one you can hover for more details?
There was a problem hiding this comment.
I reverted that change and kept the Deprecated text instead of adding it directly from the component on docs site.
changes how deprecated fields are generated for docs content, before this commit deprecated related text was shown via `title` attribute on hover and the `deprecated` tag description was never shown unless user check it manually via code. this commit exports `deprecated` tag description to reflect it directly in docs using `material/tooltip` on doc site
devversion
added
the
target: minor
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
changes how deprecated fields are generated for docs content, before this commit deprecated related text was shown via
titleattribute on hover and thedeprecatedtag description was never shown unless user check it manually via code. this commit exportsdeprecatedtag description to reflect it directly in docs usingmaterial/tooltipon doc site