@ni/ok-components 1.4.1 → 1.4.2

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.
Files changed (7) hide show
  1. package/dist/all-components-bundle.js +1 -1
  2. package/dist/all-components-bundle.js.map +1 -1
  3. package/dist/all-components-bundle.min.js +1 -1
  4. package/dist/all-components-bundle.min.js.map +1 -1
  5. package/dist/custom-elements.json +217 -217
  6. package/dist/custom-elements.md +56 -56
  7. package/package.json +2 -2
package/dist/custom-elements.json CHANGED
@@ -683,6 +683,223 @@
683
683
  }
684
684
  ]
685
685
  },
686
+ {
687
+ "kind": "javascript-module",
688
+ "path": "src/fv/context-help/index.ts",
689
+ "declarations": [
690
+ {
691
+ "kind": "class",
692
+ "description": "An info trigger with an attached tooltip for lightweight contextual guidance.",
693
+ "name": "FvContextHelp",
694
+ "members": [
695
+ {
696
+ "kind": "field",
697
+ "name": "text",
698
+ "type": {
699
+ "text": "string"
700
+ },
701
+ "privacy": "public",
702
+ "default": "''"
703
+ },
704
+ {
705
+ "kind": "field",
706
+ "name": "triggerLabel",
707
+ "type": {
708
+ "text": "string"
709
+ },
710
+ "privacy": "public",
711
+ "default": "'Show help'"
712
+ },
713
+ {
714
+ "kind": "field",
715
+ "name": "severity",
716
+ "type": {
717
+ "text": "FvContextHelpSeverity"
718
+ },
719
+ "privacy": "public"
720
+ },
721
+ {
722
+ "kind": "field",
723
+ "name": "iconVisible",
724
+ "type": {
725
+ "text": "boolean"
726
+ },
727
+ "privacy": "public",
728
+ "default": "false"
729
+ }
730
+ ],
731
+ "attributes": [
732
+ {
733
+ "name": "text",
734
+ "type": {
735
+ "text": "string"
736
+ },
737
+ "default": "''",
738
+ "fieldName": "text"
739
+ },
740
+ {
741
+ "name": "trigger-label",
742
+ "type": {
743
+ "text": "string"
744
+ },
745
+ "default": "'Show help'",
746
+ "fieldName": "triggerLabel"
747
+ },
748
+ {
749
+ "name": "severity",
750
+ "type": {
751
+ "text": "FvContextHelpSeverity"
752
+ },
753
+ "fieldName": "severity"
754
+ },
755
+ {
756
+ "name": "icon-visible",
757
+ "type": {
758
+ "text": "boolean"
759
+ },
760
+ "default": "false",
761
+ "fieldName": "iconVisible"
762
+ }
763
+ ],
764
+ "superclass": {
765
+ "name": "FoundationElement",
766
+ "package": "@ni/fast-foundation"
767
+ }
768
+ },
769
+ {
770
+ "kind": "variable",
771
+ "name": "fvContextHelpTag",
772
+ "type": {
773
+ "text": "string"
774
+ },
775
+ "default": "'ok-fv-context-help'"
776
+ }
777
+ ],
778
+ "exports": [
779
+ {
780
+ "kind": "js",
781
+ "name": "FvContextHelpSeverity",
782
+ "declaration": {
783
+ "name": "FvContextHelpSeverity",
784
+ "module": "src/fv/context-help/index.ts"
785
+ }
786
+ },
787
+ {
788
+ "kind": "js",
789
+ "name": "FvContextHelp",
790
+ "declaration": {
791
+ "name": "FvContextHelp",
792
+ "module": "src/fv/context-help/index.ts"
793
+ }
794
+ },
795
+ {
796
+ "kind": "js",
797
+ "name": "fvContextHelpTag",
798
+ "declaration": {
799
+ "name": "fvContextHelpTag",
800
+ "module": "src/fv/context-help/index.ts"
801
+ }
802
+ }
803
+ ]
804
+ },
805
+ {
806
+ "kind": "javascript-module",
807
+ "path": "src/fv/context-help/types.ts",
808
+ "declarations": [],
809
+ "exports": []
810
+ },
811
+ {
812
+ "kind": "javascript-module",
813
+ "path": "src/fv/search-input/index.ts",
814
+ "declarations": [
815
+ {
816
+ "kind": "class",
817
+ "description": "A compact search input with a built-in clear affordance.",
818
+ "name": "FvSearchInput",
819
+ "members": [
820
+ {
821
+ "kind": "field",
822
+ "name": "appearance",
823
+ "type": {
824
+ "text": "FvSearchInputAppearanceType"
825
+ },
826
+ "privacy": "public"
827
+ }
828
+ ],
829
+ "events": [
830
+ {
831
+ "name": "input",
832
+ "type": {
833
+ "text": "Event"
834
+ }
835
+ }
836
+ ],
837
+ "attributes": [
838
+ {
839
+ "name": "appearance",
840
+ "type": {
841
+ "text": "FvSearchInputAppearanceType"
842
+ },
843
+ "fieldName": "appearance"
844
+ }
845
+ ],
846
+ "superclass": {
847
+ "name": "FoundationTextField",
848
+ "package": "@ni/fast-foundation"
849
+ }
850
+ },
851
+ {
852
+ "kind": "variable",
853
+ "name": "fvSearchInputTag",
854
+ "type": {
855
+ "text": "string"
856
+ },
857
+ "default": "'ok-fv-search-input'"
858
+ }
859
+ ],
860
+ "exports": [
861
+ {
862
+ "kind": "js",
863
+ "name": "FvSearchInput",
864
+ "declaration": {
865
+ "name": "FvSearchInput",
866
+ "module": "src/fv/search-input/index.ts"
867
+ }
868
+ },
869
+ {
870
+ "kind": "js",
871
+ "name": "fvSearchInputTag",
872
+ "declaration": {
873
+ "name": "fvSearchInputTag",
874
+ "module": "src/fv/search-input/index.ts"
875
+ }
876
+ }
877
+ ]
878
+ },
879
+ {
880
+ "kind": "javascript-module",
881
+ "path": "src/fv/search-input/types.ts",
882
+ "declarations": [
883
+ {
884
+ "kind": "variable",
885
+ "name": "FvSearchInputAppearance",
886
+ "type": {
887
+ "text": "{\n block: 'block',\n outline: 'outline',\n underline: 'underline',\n frameless: 'frameless'\n}"
888
+ },
889
+ "default": "{ block: 'block', outline: 'outline', underline: 'underline', frameless: 'frameless' }"
890
+ }
891
+ ],
892
+ "exports": [
893
+ {
894
+ "kind": "js",
895
+ "name": "FvSearchInputAppearance",
896
+ "declaration": {
897
+ "name": "FvSearchInputAppearance",
898
+ "module": "src/fv/search-input/types.ts"
899
+ }
900
+ }
901
+ ]
902
+ },
686
903
  {
687
904
  "kind": "javascript-module",
688
905
  "path": "src/fv/split-button/index.ts",
@@ -1183,223 +1400,6 @@
1183
1400
  }
1184
1401
  ]
1185
1402
  },
1186
- {
1187
- "kind": "javascript-module",
1188
- "path": "src/fv/search-input/index.ts",
1189
- "declarations": [
1190
- {
1191
- "kind": "class",
1192
- "description": "A compact search input with a built-in clear affordance.",
1193
- "name": "FvSearchInput",
1194
- "members": [
1195
- {
1196
- "kind": "field",
1197
- "name": "appearance",
1198
- "type": {
1199
- "text": "FvSearchInputAppearanceType"
1200
- },
1201
- "privacy": "public"
1202
- }
1203
- ],
1204
- "events": [
1205
- {
1206
- "name": "input",
1207
- "type": {
1208
- "text": "Event"
1209
- }
1210
- }
1211
- ],
1212
- "attributes": [
1213
- {
1214
- "name": "appearance",
1215
- "type": {
1216
- "text": "FvSearchInputAppearanceType"
1217
- },
1218
- "fieldName": "appearance"
1219
- }
1220
- ],
1221
- "superclass": {
1222
- "name": "FoundationTextField",
1223
- "package": "@ni/fast-foundation"
1224
- }
1225
- },
1226
- {
1227
- "kind": "variable",
1228
- "name": "fvSearchInputTag",
1229
- "type": {
1230
- "text": "string"
1231
- },
1232
- "default": "'ok-fv-search-input'"
1233
- }
1234
- ],
1235
- "exports": [
1236
- {
1237
- "kind": "js",
1238
- "name": "FvSearchInput",
1239
- "declaration": {
1240
- "name": "FvSearchInput",
1241
- "module": "src/fv/search-input/index.ts"
1242
- }
1243
- },
1244
- {
1245
- "kind": "js",
1246
- "name": "fvSearchInputTag",
1247
- "declaration": {
1248
- "name": "fvSearchInputTag",
1249
- "module": "src/fv/search-input/index.ts"
1250
- }
1251
- }
1252
- ]
1253
- },
1254
- {
1255
- "kind": "javascript-module",
1256
- "path": "src/fv/search-input/types.ts",
1257
- "declarations": [
1258
- {
1259
- "kind": "variable",
1260
- "name": "FvSearchInputAppearance",
1261
- "type": {
1262
- "text": "{\n block: 'block',\n outline: 'outline',\n underline: 'underline',\n frameless: 'frameless'\n}"
1263
- },
1264
- "default": "{ block: 'block', outline: 'outline', underline: 'underline', frameless: 'frameless' }"
1265
- }
1266
- ],
1267
- "exports": [
1268
- {
1269
- "kind": "js",
1270
- "name": "FvSearchInputAppearance",
1271
- "declaration": {
1272
- "name": "FvSearchInputAppearance",
1273
- "module": "src/fv/search-input/types.ts"
1274
- }
1275
- }
1276
- ]
1277
- },
1278
- {
1279
- "kind": "javascript-module",
1280
- "path": "src/fv/context-help/index.ts",
1281
- "declarations": [
1282
- {
1283
- "kind": "class",
1284
- "description": "An info trigger with an attached tooltip for lightweight contextual guidance.",
1285
- "name": "FvContextHelp",
1286
- "members": [
1287
- {
1288
- "kind": "field",
1289
- "name": "text",
1290
- "type": {
1291
- "text": "string"
1292
- },
1293
- "privacy": "public",
1294
- "default": "''"
1295
- },
1296
- {
1297
- "kind": "field",
1298
- "name": "triggerLabel",
1299
- "type": {
1300
- "text": "string"
1301
- },
1302
- "privacy": "public",
1303
- "default": "'Show help'"
1304
- },
1305
- {
1306
- "kind": "field",
1307
- "name": "severity",
1308
- "type": {
1309
- "text": "FvContextHelpSeverity"
1310
- },
1311
- "privacy": "public"
1312
- },
1313
- {
1314
- "kind": "field",
1315
- "name": "iconVisible",
1316
- "type": {
1317
- "text": "boolean"
1318
- },
1319
- "privacy": "public",
1320
- "default": "false"
1321
- }
1322
- ],
1323
- "attributes": [
1324
- {
1325
- "name": "text",
1326
- "type": {
1327
- "text": "string"
1328
- },
1329
- "default": "''",
1330
- "fieldName": "text"
1331
- },
1332
- {
1333
- "name": "trigger-label",
1334
- "type": {
1335
- "text": "string"
1336
- },
1337
- "default": "'Show help'",
1338
- "fieldName": "triggerLabel"
1339
- },
1340
- {
1341
- "name": "severity",
1342
- "type": {
1343
- "text": "FvContextHelpSeverity"
1344
- },
1345
- "fieldName": "severity"
1346
- },
1347
- {
1348
- "name": "icon-visible",
1349
- "type": {
1350
- "text": "boolean"
1351
- },
1352
- "default": "false",
1353
- "fieldName": "iconVisible"
1354
- }
1355
- ],
1356
- "superclass": {
1357
- "name": "FoundationElement",
1358
- "package": "@ni/fast-foundation"
1359
- }
1360
- },
1361
- {
1362
- "kind": "variable",
1363
- "name": "fvContextHelpTag",
1364
- "type": {
1365
- "text": "string"
1366
- },
1367
- "default": "'ok-fv-context-help'"
1368
- }
1369
- ],
1370
- "exports": [
1371
- {
1372
- "kind": "js",
1373
- "name": "FvContextHelpSeverity",
1374
- "declaration": {
1375
- "name": "FvContextHelpSeverity",
1376
- "module": "src/fv/context-help/index.ts"
1377
- }
1378
- },
1379
- {
1380
- "kind": "js",
1381
- "name": "FvContextHelp",
1382
- "declaration": {
1383
- "name": "FvContextHelp",
1384
- "module": "src/fv/context-help/index.ts"
1385
- }
1386
- },
1387
- {
1388
- "kind": "js",
1389
- "name": "fvContextHelpTag",
1390
- "declaration": {
1391
- "name": "fvContextHelpTag",
1392
- "module": "src/fv/context-help/index.ts"
1393
- }
1394
- }
1395
- ]
1396
- },
1397
- {
1398
- "kind": "javascript-module",
1399
- "path": "src/fv/context-help/types.ts",
1400
- "declarations": [],
1401
- "exports": []
1402
- },
1403
1403
  {
1404
1404
  "kind": "javascript-module",
1405
1405
  "path": "src/fv/summary-panel/index.ts",
package/dist/custom-elements.md CHANGED
@@ -108,6 +108,62 @@
108
108
 
109
109
  <hr/>
110
110
 
111
+ ## class: `FvContextHelp`
112
+
113
+ ### Superclass
114
+
115
+ | Name | Module | Package |
116
+ | ------------------- | ------ | ------------------- |
117
+ | `FoundationElement` | | @ni/fast-foundation |
118
+
119
+ ### Fields
120
+
121
+ | Name | Privacy | Type | Default | Description | Inherited From |
122
+ | -------------- | ------- | ----------------------- | ------------- | ----------- | -------------- |
123
+ | `text` | public | `string` | `''` | | |
124
+ | `triggerLabel` | public | `string` | `'Show help'` | | |
125
+ | `severity` | public | `FvContextHelpSeverity` | | | |
126
+ | `iconVisible` | public | `boolean` | `false` | | |
127
+
128
+ ### Attributes
129
+
130
+ | Name | Field | Inherited From |
131
+ | --------------- | ------------ | -------------- |
132
+ | `text` | text | |
133
+ | `trigger-label` | triggerLabel | |
134
+ | `severity` | severity | |
135
+ | `icon-visible` | iconVisible | |
136
+
137
+ <hr/>
138
+
139
+ ## class: `FvSearchInput`
140
+
141
+ ### Superclass
142
+
143
+ | Name | Module | Package |
144
+ | --------------------- | ------ | ------------------- |
145
+ | `FoundationTextField` | | @ni/fast-foundation |
146
+
147
+ ### Fields
148
+
149
+ | Name | Privacy | Type | Default | Description | Inherited From |
150
+ | ------------ | ------- | ----------------------------- | ------- | ----------- | -------------- |
151
+ | `appearance` | public | `FvSearchInputAppearanceType` | | | |
152
+
153
+ ### Events
154
+
155
+ | Name | Type | Description | Inherited From |
156
+ | ------- | ------- | ----------- | -------------- |
157
+ | `input` | `Event` | | |
158
+
159
+ ### Attributes
160
+
161
+ | Name | Field | Inherited From |
162
+ | ------------ | ---------- | -------------- |
163
+ | `appearance` | appearance | |
164
+
165
+ <hr/>
166
+
111
167
  ## class: `FvSplitButton`
112
168
 
113
169
  ### Superclass
@@ -190,62 +246,6 @@
190
246
 
191
247
  <hr/>
192
248
 
193
- ## class: `FvSearchInput`
194
-
195
- ### Superclass
196
-
197
- | Name | Module | Package |
198
- | --------------------- | ------ | ------------------- |
199
- | `FoundationTextField` | | @ni/fast-foundation |
200
-
201
- ### Fields
202
-
203
- | Name | Privacy | Type | Default | Description | Inherited From |
204
- | ------------ | ------- | ----------------------------- | ------- | ----------- | -------------- |
205
- | `appearance` | public | `FvSearchInputAppearanceType` | | | |
206
-
207
- ### Events
208
-
209
- | Name | Type | Description | Inherited From |
210
- | ------- | ------- | ----------- | -------------- |
211
- | `input` | `Event` | | |
212
-
213
- ### Attributes
214
-
215
- | Name | Field | Inherited From |
216
- | ------------ | ---------- | -------------- |
217
- | `appearance` | appearance | |
218
-
219
- <hr/>
220
-
221
- ## class: `FvContextHelp`
222
-
223
- ### Superclass
224
-
225
- | Name | Module | Package |
226
- | ------------------- | ------ | ------------------- |
227
- | `FoundationElement` | | @ni/fast-foundation |
228
-
229
- ### Fields
230
-
231
- | Name | Privacy | Type | Default | Description | Inherited From |
232
- | -------------- | ------- | ----------------------- | ------------- | ----------- | -------------- |
233
- | `text` | public | `string` | `''` | | |
234
- | `triggerLabel` | public | `string` | `'Show help'` | | |
235
- | `severity` | public | `FvContextHelpSeverity` | | | |
236
- | `iconVisible` | public | `boolean` | `false` | | |
237
-
238
- ### Attributes
239
-
240
- | Name | Field | Inherited From |
241
- | --------------- | ------------ | -------------- |
242
- | `text` | text | |
243
- | `trigger-label` | triggerLabel | |
244
- | `severity` | severity | |
245
- | `icon-visible` | iconVisible | |
246
-
247
- <hr/>
248
-
249
249
  ## class: `FvSummaryPanel`
250
250
 
251
251
  ### Superclass
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ni/ok-components",
3
- "version": "1.4.1",
3
+ "version": "1.4.2",
4
4
  "description": "NI Ok Components",
5
5
  "scripts": {
6
6
  "build": "npm run build:components && npm run build:cem",
@@ -43,7 +43,7 @@
43
43
  "@ni/fast-foundation": "^10.2.3",
44
44
  "@ni/fast-web-utilities": "^10.0.0",
45
45
  "@ni/nimble-components": "^35.10.0",
46
- "@ni/spright-components": "^6.20.1",
46
+ "@ni/spright-components": "^6.20.2",
47
47
  "tslib": "^2.2.0"
48
48
  },
49
49
  "devDependencies": {