@voicenter-team/voicenter-ui-plus 0.2.8 → 0.2.9
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 +25 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -53,7 +53,7 @@ Such configuration will append to the document element the CSS variables from on
|
|
|
53
53
|
- **themeName**
|
|
54
54
|
- The name of the theme to be injected
|
|
55
55
|
- **onSetupCallback**
|
|
56
|
-
- The function which will be called right after the variables will be injected into the document element
|
|
56
|
+
- The function which will be called right after the variables will be injected into the document element. First parameter of which is the theme object which was set up
|
|
57
57
|
|
|
58
58
|
### Remote
|
|
59
59
|
**Config:**
|
|
@@ -80,10 +80,33 @@ Such configuration will initiate the call to the specified apiUrl in order to re
|
|
|
80
80
|
- **apiUrl**
|
|
81
81
|
- The API url to which the POST request will be initiated
|
|
82
82
|
- **onSetupCallback**
|
|
83
|
-
- The function which will be called right after the variables will be injected into the document element
|
|
83
|
+
- The function which will be called right after the variables will be injected into the document element. First parameter of which is the theme object which was set up
|
|
84
84
|
- **brandingSectionName**
|
|
85
85
|
- [Optional] The payload data that will be sent to the request
|
|
86
86
|
|
|
87
|
+
### Custom JSON
|
|
88
|
+
**Config:**
|
|
89
|
+
```js
|
|
90
|
+
{
|
|
91
|
+
type: 'customJson'
|
|
92
|
+
config: {
|
|
93
|
+
black: '#000000'
|
|
94
|
+
}
|
|
95
|
+
onSetupCallback: () => {
|
|
96
|
+
console.log('Loaded!')
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
```
|
|
100
|
+
**Description:**
|
|
101
|
+
|
|
102
|
+
Such configuration will initiate the styling with custom provided theme
|
|
103
|
+
|
|
104
|
+
**Params:**
|
|
105
|
+
- **config**
|
|
106
|
+
- The object where the key is the variable to be set and the value is the variable value. Check the [themes object](https://github.com/VoicenterTeam/voicenter-ui-plus/blob/master/src/theme/themes.json) to check existing variables
|
|
107
|
+
- **onSetupCallback**
|
|
108
|
+
- The function which will be called right after the variables will be injected into the document element. First parameter of which is the theme object which was set up
|
|
109
|
+
|
|
87
110
|
## Documentation
|
|
88
111
|
|
|
89
112
|
Visit [documentation](https://voicenter-ui.netlify.app/) for detailed info
|