traitify-widgets 3.0.11 → 3.0.12
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 +15 -1
- package/build/traitify.js +1 -1
- package/build/traitify.js.map +1 -1
- package/package.json +5 -1
package/README.md
CHANGED
|
@@ -1,9 +1,21 @@
|
|
|
1
1
|
# Traitify Widgets
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Setup
|
|
4
4
|
|
|
5
5
|
The widgets can be installed through our CDN or npm. Usage through the CDN will maintain backwards compatibility, while the npm library will use semantic versioning.
|
|
6
6
|
|
|
7
|
+
### Requirements
|
|
8
|
+
|
|
9
|
+
Depending on the use-case, different IDs are required to use the widgets.
|
|
10
|
+
|
|
11
|
+
- Single assessment
|
|
12
|
+
- assessmentID
|
|
13
|
+
- Assessment(s) associated with a recommendation
|
|
14
|
+
- benchmarkID or packageID
|
|
15
|
+
- profileID
|
|
16
|
+
|
|
17
|
+
Additionally an `authKey` is required.
|
|
18
|
+
|
|
7
19
|
### CDN
|
|
8
20
|
|
|
9
21
|
```
|
|
@@ -109,6 +121,7 @@ Traitify.render({
|
|
|
109
121
|
- host
|
|
110
122
|
- locale
|
|
111
123
|
- options
|
|
124
|
+
- packageID
|
|
112
125
|
- profileID
|
|
113
126
|
- version
|
|
114
127
|
- If you've set options in a Traitify instance, pass them as props to the Container
|
|
@@ -176,6 +189,7 @@ Traitify.updateLocale("en-us");
|
|
|
176
189
|
```
|
|
177
190
|
|
|
178
191
|
Here is a list of the available locales (`en-us` is the default):
|
|
192
|
+
|
|
179
193
|
- Chinese - `zh-cn`
|
|
180
194
|
- Creole - `ht-us`
|
|
181
195
|
- Dutch - `nl-nl`
|