web-features 2.15.0 → 2.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -3
- package/data.json +1 -1
- package/data.schema.json +22 -0
- package/index.d.ts +26 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
# Curated list of Web platform features
|
|
2
2
|
|
|
3
|
-
This package is experimental, expect frequent breaking changes!
|
|
4
|
-
|
|
5
3
|
## Usage
|
|
6
4
|
|
|
7
5
|
```sh
|
|
@@ -27,13 +25,18 @@ import schema from "web-features/data.schema.json" with { type: "json" };
|
|
|
27
25
|
|
|
28
26
|
## Rendering Baseline statuses with `web-features`
|
|
29
27
|
|
|
30
|
-
If you're using `web-features` to render Baseline iconography or browser logos with support markers, then you must follow
|
|
28
|
+
If you're using `web-features` to render Baseline iconography or browser logos with support markers, then you must follow the [name and logo usage guidelines](https://web-platform-dx.github.io/web-features/name-and-logo-usage-guidelines/).
|
|
31
29
|
|
|
32
30
|
For Baseline iconography, follow this procedure for each feature:
|
|
33
31
|
|
|
34
32
|
1. If `status.baseline` is `"high"`, then show an affirmative "widely available" icon.
|
|
35
33
|
1. If `status.baseline` is `"low"`, then show an affirmative "newly available" icon.
|
|
36
34
|
1. If `status.baseline` is `false`, then show a "limited availability" non-Baseline icon.
|
|
35
|
+
|
|
36
|
+
**Note**: All features that have the `discouraged` property are, by definition, non-Baseline, and `status.baseline` will be `false`.
|
|
37
|
+
If a feature has the `discouraged` property, consider showing a message describing the feature's discouraged status instead of Baseline iconography.
|
|
38
|
+
Showing Baseline iconography for discouraged features may confuse readers.
|
|
39
|
+
|
|
37
40
|
1. If `status.baseline` is `undefined`, then **do not** show any Baseline or non-Baseline badge.
|
|
38
41
|
|
|
39
42
|
For browser support iconography (that is, browser logos and checkmarks and Xs), follow this procedure for each browser:
|