jprdonnelly/nebula.js
1
0
Fork 0
mirror of https://github.com/qlik-oss/nebula.js.git synced 2025-12-19 09:48:18 -05:00
Code Issues Projects Releases Wiki Activity

docs: add missing context in createconfiguration (#767)

Browse Source 
* docs: add missing context in createconfiguration

* feat: update the type definition
This commit is contained in:
Li Kang
2022-02-25 11:12:05 +01:00
committed by GitHub
parent 86f21c4b05
commit d554999f81
5 changed files with 33 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
apis/nucleus/src/index.js
View File

@@ -440,7 +440,9 @@ function nuked(configuration = {}) {
* // create an alternate config with dark theme
* // and inherit the config from the previous
* const d = m.createConfiguration({
* theme: 'dark'
* context: {
* theme: 'dark'
* }
* });
*
* m(app).render({ type: 'mekko' }); // will render the object with default theme

20
apis/stardust/api-spec/spec.json
View File

@@ -43,7 +43,7 @@
"type": "#/entries/embed"
},
"examples": [
"import { embed } from '@nebula.js/stardust';\n// create a 'master' config which registers all types\nconst m = embed.createConfiguration({\n types: [{\n name: 'mekko',\n version: '1.0.0',\n load: () => Promise.resolve(mekko)\n }],\n});\n\n// create an alternate config with dark theme\n// and inherit the config from the previous\nconst d = m.createConfiguration({\n theme: 'dark'\n});\n\nm(app).render({ type: 'mekko' }); // will render the object with default theme\nd(app).render({ type: 'mekko' }); // will render the object with 'dark' theme\nembed(app).render({ type: 'mekko' }); // will throw error since 'mekko' is not a register type on the default instance"
"import { embed } from '@nebula.js/stardust';\n// create a 'master' config which registers all types\nconst m = embed.createConfiguration({\n types: [{\n name: 'mekko',\n version: '1.0.0',\n load: () => Promise.resolve(mekko)\n }],\n});\n\n// create an alternate config with dark theme\n// and inherit the config from the previous\nconst d = m.createConfiguration({\n context: {\n theme: 'dark'\n }\n});\n\nm(app).render({ type: 'mekko' }); // will render the object with default theme\nd(app).render({ type: 'mekko' }); // will render the object with 'dark' theme\nembed(app).render({ type: 'mekko' }); // will throw error since 'mekko' is not a register type on the default instance"
]
}
}
@@ -445,7 +445,7 @@
"type": "#/definitions/Constraints"
},
"examples": [
"// configure embed to disallow active interactions when rendering\nembed(app, {\n constraints: {\n active: true, // do not allow interactions\n }\n}).render({ element, id: 'sdfsdf' });",
"// configure embed to disallow active interactions when rendering\nembed(app, {\n context: {\n constraints: {\n active: true, // do not allow interactions\n }\n }\n}).render({ element, id: 'sdfsdf' });",
"import { useConstraints } from '@nebula.js/stardust';\n// ...\nconst constraints = useConstraints();\nuseEffect(() => {\n if (constraints.active) {\n // do not add any event listener if active constraint is set\n return undefined;\n }\n const listener = () => {};\n element.addEventListener('click', listener);\n return () => {\n element.removeEventListener('click', listener);\n };\n}, [constraints])"
]
},
@@ -790,13 +790,25 @@
"type": "string"
},
"search": {
"description": "To show the search bar",
"description": "Show the search bar",
"optional": true,
"defaultValue": true,
"type": "boolean"
},
"toolbar": {
"description": "To show the toolbar",
"description": "Show the toolbar",
"optional": true,
"defaultValue": true,
"type": "boolean"
},
"checkboxes": {
"description": "Show values as checkboxes instead of as fields",
"optional": true,
"defaultValue": false,
"type": "boolean"
},
"rangeSelect": {
"description": "Enable range selection",
"optional": true,
"defaultValue": true,
"type": "boolean"

2
apis/stardust/types/index.d.ts vendored
View File

@@ -250,6 +250,8 @@ declare namespace stardust {
listLayout?: string;
search?: boolean;
toolbar?: boolean;
checkboxes?: boolean;
rangeSelect?: boolean;
stateName?: boolean;
properties?: object;
sessionModel?: object;

8
apis/supernova/src/hooks.js
View File

@@ -847,9 +847,11 @@ export function useAction(fn, deps) {
* @example
* // configure embed to disallow active interactions when rendering
* embed(app, {
* constraints: {
* active: true, // do not allow interactions
* }
* context: {
* constraints: {
* active: true, // do not allow interactions
* }
* }
* }).render({ element, id: 'sdfsdf' });
*
* @example

10
docs/api-reference.md
View File

@@ -134,7 +134,9 @@ const m = embed.createConfiguration({
// create an alternate config with dark theme
// and inherit the config from the previous
const d = m.createConfiguration({
theme: 'dark',
context: {
theme: 'dark',
},
});
m(app).render({ type: 'mekko' }); // will render the object with default theme
@@ -424,8 +426,10 @@ and should respected by you when implementing the supernova.
```js
// configure embed to disallow active interactions when rendering
embed(app, {
constraints: {
active: true, // do not allow interactions
context: {
constraints: {
active: true, // do not allow interactions
},
},
}).render({ element, id: 'sdfsdf' });
```