@ni/ok-components 0.2.13 → 0.2.15

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.
@@ -0,0 +1,121 @@
1
+ {
2
+ "schemaVersion": "1.0.0",
3
+ "readme": "",
4
+ "modules": [
5
+ {
6
+ "kind": "javascript-module",
7
+ "path": "src/all-components.ts",
8
+ "declarations": [],
9
+ "exports": []
10
+ },
11
+ {
12
+ "kind": "javascript-module",
13
+ "path": "src/button/index.ts",
14
+ "declarations": [
15
+ {
16
+ "kind": "class",
17
+ "description": "A Ok demo component (not for production use)",
18
+ "name": "Button",
19
+ "superclass": {
20
+ "name": "FoundationElement",
21
+ "package": "@ni/fast-foundation"
22
+ }
23
+ },
24
+ {
25
+ "kind": "variable",
26
+ "name": "buttonTag",
27
+ "type": {
28
+ "text": "string"
29
+ },
30
+ "default": "'ok-button'"
31
+ }
32
+ ],
33
+ "exports": [
34
+ {
35
+ "kind": "js",
36
+ "name": "Button",
37
+ "declaration": {
38
+ "name": "Button",
39
+ "module": "src/button/index.ts"
40
+ }
41
+ },
42
+ {
43
+ "kind": "js",
44
+ "name": "buttonTag",
45
+ "declaration": {
46
+ "name": "buttonTag",
47
+ "module": "src/button/index.ts"
48
+ }
49
+ }
50
+ ]
51
+ },
52
+ {
53
+ "kind": "javascript-module",
54
+ "path": "src/icon-dynamic/index.ts",
55
+ "declarations": [
56
+ {
57
+ "kind": "class",
58
+ "description": "Base class for dynamic icons. Not intended to be used directly, instead use to register dynamic icons:\n```\ncustomElements.get('ok-icon-dynamic').registerIconDynamic('ok-icon-dynamic-awesome', '<img data uri or arbitrary url>');\n```\nAfter calling successfully, the icon can be used like any other icon:\n```\n<ok-icon-dynamic-awesome></ok-icon-dynamic-awesome>\n<nimble-mapping-icon icon=\"ok-icon-dynamic-awesome\"></nimble-mapping-icon>\n```",
59
+ "name": "IconDynamic",
60
+ "members": [
61
+ {
62
+ "kind": "method",
63
+ "name": "registerIconDynamic",
64
+ "privacy": "public",
65
+ "static": true,
66
+ "return": {
67
+ "type": {
68
+ "text": "void"
69
+ }
70
+ },
71
+ "parameters": [
72
+ {
73
+ "name": "tagName",
74
+ "type": {
75
+ "text": "string"
76
+ }
77
+ },
78
+ {
79
+ "name": "url",
80
+ "type": {
81
+ "text": "string"
82
+ }
83
+ }
84
+ ]
85
+ }
86
+ ],
87
+ "superclass": {
88
+ "name": "Icon",
89
+ "package": "@ni/nimble-components/dist/esm/icon-base"
90
+ }
91
+ },
92
+ {
93
+ "kind": "variable",
94
+ "name": "iconDynamicTag",
95
+ "type": {
96
+ "text": "string"
97
+ },
98
+ "default": "'ok-icon-dynamic'"
99
+ }
100
+ ],
101
+ "exports": [
102
+ {
103
+ "kind": "js",
104
+ "name": "IconDynamic",
105
+ "declaration": {
106
+ "name": "IconDynamic",
107
+ "module": "src/icon-dynamic/index.ts"
108
+ }
109
+ },
110
+ {
111
+ "kind": "js",
112
+ "name": "iconDynamicTag",
113
+ "declaration": {
114
+ "name": "iconDynamicTag",
115
+ "module": "src/icon-dynamic/index.ts"
116
+ }
117
+ }
118
+ ]
119
+ }
120
+ ]
121
+ }
@@ -0,0 +1,25 @@
1
+ ## class: `Button`
2
+
3
+ ### Superclass
4
+
5
+ | Name | Module | Package |
6
+ | ------------------- | ------ | ------------------- |
7
+ | `FoundationElement` | | @ni/fast-foundation |
8
+
9
+ <hr/>
10
+
11
+ ## class: `IconDynamic`
12
+
13
+ ### Superclass
14
+
15
+ | Name | Module | Package |
16
+ | ------ | ------ | ---------------------------------------- |
17
+ | `Icon` | | @ni/nimble-components/dist/esm/icon-base |
18
+
19
+ ### Static Methods
20
+
21
+ | Name | Privacy | Description | Parameters | Return | Inherited From |
22
+ | --------------------- | ------- | ----------- | ------------------------------ | ------ | -------------- |
23
+ | `registerIconDynamic` | public | | `tagName: string, url: string` | `void` | |
24
+
25
+ <hr/>
package/package.json CHANGED
@@ -1,14 +1,18 @@
1
1
  {
2
2
  "name": "@ni/ok-components",
3
- "version": "0.2.13",
3
+ "version": "0.2.15",
4
4
  "description": "NI Ok Components",
5
5
  "scripts": {
6
- "build": "tsc -p ./tsconfig.json",
6
+ "build": "npm run build:components && npm run build:cem",
7
7
  "build-bundle": "rollup --config",
8
8
  "lint": "eslint .",
9
9
  "format": "eslint . --fix",
10
10
  "pack": "npm pack",
11
11
  "invoke-publish": "npm publish",
12
+ "build:components": "tsc -p ./tsconfig.json",
13
+ "build:cem": "npm run build:cem:config && npm run build:cem:markdown",
14
+ "build:cem:config": "cem analyze --config ./custom-elements-manifest.config.mjs",
15
+ "build:cem:markdown": "node build/generate-markdown.mjs",
12
16
  "test-chrome-debugger": "karma start karma.conf.cjs --browsers=ChromeDebugging --skip-tags SkipChrome",
13
17
  "test-chrome": "karma start karma.conf.headless.cjs --browsers=ChromeHeadlessOpt --single-run --skip-tags SkipChrome",
14
18
  "test-firefox-debugger": "karma start karma.conf.cjs --browsers=FirefoxDebugging --skip-tags SkipFirefox",
@@ -33,15 +37,18 @@
33
37
  "url": "https://github.com/ni/nimble/issues"
34
38
  },
35
39
  "homepage": "https://github.com/ni/nimble#readme",
40
+ "customElements": "dist/custom-elements.json",
36
41
  "dependencies": {
37
42
  "@ni/fast-element": "^10.1.0",
38
- "@ni/fast-foundation": "^10.1.5",
43
+ "@ni/fast-foundation": "^10.2.1",
39
44
  "@ni/fast-web-utilities": "^10.0.0",
40
- "@ni/nimble-components": "^35.3.0",
41
- "@ni/spright-components": "^6.10.0",
45
+ "@ni/nimble-components": "^35.3.2",
46
+ "@ni/spright-components": "^6.10.2",
42
47
  "tslib": "^2.2.0"
43
48
  },
44
49
  "devDependencies": {
50
+ "@custom-elements-manifest/analyzer": "^0.11.0",
51
+ "@custom-elements-manifest/to-markdown": "^0.1.0",
45
52
  "@ni-private/eslint-config-nimble": "*",
46
53
  "@ni-private/jasmine-extensions": "^0.0.1",
47
54
  "@ni/jasmine-parameterized": "^1.0.9",