Skip to content

Commit f4dec1d

Browse files
authored
Add beta-until label (#254)
For new and deprectaed labels it is already possible to include a version number. Although we have a generic `beta` label that can be used to display just the text `Beta`, there is no way to display a version with the text, for example `Beta until 5.12`. This PR adds a new `label--beta-until-<version>` role to be used for beta labels where a version number is also required.
1 parent 34b1d0e commit f4dec1d

File tree

4 files changed

+16
-3
lines changed

4 files changed

+16
-3
lines changed

preview-src/docs-roles.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ Flags sections as Not Available on Aura, Aura DB Enterprise, Enterprise Edition,
1313
--
1414

1515

16+
[role=label--new-5.11 label--beta-until-5.12]
17+
== Beta until
18+
19+
Lorem ipsum.
20+
21+
1622
[role="label--new-5.17 label--enterprise-edition"]
1723
== Relationship property type constraints
1824

src/css/labels.css

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,8 @@ span.label--yes {
167167
}
168168

169169
span.label--alpha,
170-
span.label--beta {
170+
span.label--beta,
171+
span.label--beta-until {
171172
background: var(--alpha-beta-background-color);
172173
color: var(--alpha-beta-color);
173174
}

src/js/60-docs-roles.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ document.addEventListener('DOMContentLoaded', function () {
2727

2828
// label could be eg aura-db-enterprise - we use the full label
2929
// label could be eg new-5.20 - we use 'new' for the label and add the version as text
30-
label = (rolesData[label] && rolesData[label].category !== 'version') ? label : labelParts[0]
30+
label = (rolesData[label] && rolesData[label].labelCategory !== 'version') ? label : labelParts.slice(0, -1).join('-')
3131

3232
// ignore labels that are not defined in rolesData
3333
if (!rolesData[label]) {
@@ -47,7 +47,7 @@ document.addEventListener('DOMContentLoaded', function () {
4747

4848
// get version number for version labels
4949
if ((rolesData[label].labelCategory === 'version' || rolesData[label].versionText) && labelParts[1]) {
50-
labelDetails.data.version = labelParts[1]
50+
labelDetails.data.version = labelParts.pop()
5151
const joinText = rolesData[label].versionText ? rolesData[label].versionText : 'in'
5252
labelDetails.text = [labelDetails.text, joinText, labelDetails.data.version].join(' ')
5353
}

src/js/data/rolesData.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,12 @@
140140
"labelCategory": "version",
141141
"displayText": "Beta"
142142
},
143+
"beta-until":{
144+
"description": "The feature or function was in beta until the version specified",
145+
"labelCategory": "version",
146+
"displayText": "Beta",
147+
"versionText": "until"
148+
},
143149
"deprecated":{
144150
"labelCategory": "version",
145151
"displayText": "Deprecated"

0 commit comments

Comments
 (0)