Skip to content

Commit 3e025d9

Browse files
JeanMecheAndrewKushnir
authored andcommitted
docs(docs-infra): Add a deprecated label to APIs (#50287)
This adds a deprecated label next to the other labels on the API pages for methods & properties. Fixes #44265 PR Close #50287
1 parent d0f6d31 commit 3e025d9

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

aio/src/styles/2-modules/label/_label.scss

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ label.api-status-label {
99
margin-right: 8px;
1010
font-weight: 500;
1111
text-transform: uppercase;
12+
line-height: initial;
1213

1314
@media screen and (max-width: 600px) {
1415
display: block;

aio/tools/transforms/templates/api/lib/memberHelpers.html

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ <h6 class="no-anchor">Throws</h6>
8383
{%- if method.name !== 'constructor' %}
8484
<thead><tr><th>
8585
<div class="with-github-links">
86-
<h3>
86+
<h3 {% if method.deprecated %} class="deprecated-api-item"{% endif %}>
8787
{%- if method.isCallMember %}<i>call signature</i>
8888
{%- elseif method.isNewMember %}<i>construct signature</i>
8989
{%- else %}{$ method.name $}()
@@ -94,6 +94,9 @@ <h3>
9494
<a href="guide/releases#developer-preview">developer preview</a>
9595
</label>
9696
{% endif %}
97+
{%- if method.deprecated %}
98+
<label class="api-status-label deprecated" title="This API is deprecated">Deprecated</label>
99+
{% endif %}
97100
{$ github.githubLinks(method, versionInfo) $}
98101
</div>
99102
</th></tr></thead>
@@ -231,6 +234,9 @@ <h2>{$ headingText $}</h2>
231234
<a href="guide/releases#developer-preview">developer preview</a>
232235
</label>
233236
{% endif %}
237+
{%- if property.deprecated %}
238+
<label class="api-status-label deprecated" title="This API is deprecated">Deprecated</label>
239+
{% endif %}
234240

235241
{%- if (property.isGetAccessor or property.isReadonly) and not property.isSetAccessor %}
236242
<span class='read-only-property'>Read-Only</span>{% endif %}

0 commit comments

Comments
 (0)