@genesislcap/foundation-zero 14.160.1 → 14.161.0

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 CHANGED
@@ -11,9 +11,30 @@ For the purpose of this POC, Zero is our first design system. In simplistic term
11
11
  [![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
12
12
  [![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](https://www.typescriptlang.org/)
13
13
 
14
+
15
+ ## Installation
16
+
17
+ To enable this module in your application, follow the steps below.
18
+
19
+ 1. Add `@genesislcap/foundation-zero` as a dependency in your `package.json` file. Whenever you change the dependencies of your project, ensure you run the `$ npm run bootstrap` command again. You can find more information in the [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) page.
20
+
21
+ ```json
22
+ {
23
+ ...
24
+ "dependencies": {
25
+ ...
26
+ "@genesislcap/foundation-zero": "latest"
27
+ ...
28
+ },
29
+ ...
30
+ }
31
+ ```
32
+
33
+ ## [API Docs](./docs/api/index.md)
34
+
14
35
  ## License
15
36
 
16
- Note: this project provides front end dependencies and uses licensed components listed in the next section, thus licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details.
37
+ Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details.
17
38
 
18
39
  ### Licensed components
19
40
  Genesis low-code platform
@@ -13141,106 +13141,127 @@
13141
13141
  },
13142
13142
  {
13143
13143
  "kind": "javascript-module",
13144
- "path": "src/error-boundary/error-boundary.ts",
13144
+ "path": "src/error-banner/error-banner.stories.ts",
13145
13145
  "declarations": [
13146
13146
  {
13147
13147
  "kind": "variable",
13148
- "name": "zeroErrorBoundaryShadowOptions",
13148
+ "name": "meta",
13149
13149
  "type": {
13150
- "text": "ShadowRootInit"
13150
+ "text": "Meta"
13151
13151
  },
13152
- "default": "{\n mode: 'open',\n delegatesFocus: true,\n}"
13152
+ "default": "{\n title: 'Error Banner',\n component: 'zero-error-banner',\n}"
13153
+ },
13154
+ {
13155
+ "kind": "variable",
13156
+ "name": "Primary",
13157
+ "type": {
13158
+ "text": "StoryObj"
13159
+ },
13160
+ "default": "{\n args: {\n errorText: 'Lorem ipsum dolor sit amet consectetur adipisicing elit.',\n notifyText: 'Lorem ipsum dolor sit amet consectetur adipisicing elit.',\n },\n render: ({ errorText, notifyText }) => html`\n <div id=\"zero-banner\" style=\"width: 100%;\">\n <zero-button @click=\"${() => showError(errorText)}\">Show Zero Error Banner</zero-button>\n <zero-button @click=\"${() => showNotify(notifyText)}\">\n Show Zero Error Banner - Notification\n </zero-button>\n </div>\n `,\n}"
13161
+ }
13162
+ ],
13163
+ "exports": [
13164
+ {
13165
+ "kind": "js",
13166
+ "name": "default",
13167
+ "declaration": {
13168
+ "name": "meta",
13169
+ "module": "src/error-banner/error-banner.stories.ts"
13170
+ }
13171
+ },
13172
+ {
13173
+ "kind": "js",
13174
+ "name": "Primary",
13175
+ "declaration": {
13176
+ "name": "Primary",
13177
+ "module": "src/error-banner/error-banner.stories.ts"
13178
+ }
13179
+ }
13180
+ ]
13181
+ },
13182
+ {
13183
+ "kind": "javascript-module",
13184
+ "path": "src/error-banner/error-banner.template.ts",
13185
+ "declarations": [
13186
+ {
13187
+ "kind": "variable",
13188
+ "name": "zeroErrorBannerTemplate",
13189
+ "default": "html<ErrorBanner>`\n ${getPrefixedErrorBanner('zero')}\n`"
13190
+ }
13191
+ ],
13192
+ "exports": [
13193
+ {
13194
+ "kind": "js",
13195
+ "name": "zeroErrorBannerTemplate",
13196
+ "declaration": {
13197
+ "name": "zeroErrorBannerTemplate",
13198
+ "module": "src/error-banner/error-banner.template.ts"
13199
+ }
13200
+ }
13201
+ ]
13202
+ },
13203
+ {
13204
+ "kind": "javascript-module",
13205
+ "path": "src/error-banner/error-banner.ts",
13206
+ "declarations": [
13207
+ {
13208
+ "kind": "variable",
13209
+ "name": "zeroErrorBannerShadowOptions",
13210
+ "default": "foundationErrorBannerShadowOptions"
13153
13211
  },
13154
13212
  {
13155
13213
  "kind": "class",
13156
13214
  "description": "",
13157
- "name": "ErrorBoundary",
13215
+ "name": "ErrorBanner",
13158
13216
  "superclass": {
13159
- "name": "FoundationErrorBoundary",
13217
+ "name": "FoundationErrorBanner",
13160
13218
  "package": "@genesislcap/foundation-ui"
13161
13219
  },
13162
- "deprecated": "true",
13163
- "tagName": "%%prefix%%-error-boundary",
13220
+ "tagName": "%%prefix%%-error-banner",
13164
13221
  "customElement": true,
13165
- "attributes": [
13166
- {
13167
- "name": "resource-name",
13168
- "description": "The resource name holding new and existing notifications",
13169
- "fieldName": "resourceName",
13170
- "inheritedFrom": {
13171
- "name": "ErrorBoundary",
13172
- "module": "src/error-boundary/error-boundary.ts"
13173
- }
13174
- },
13175
- {
13176
- "name": "close-timeout",
13177
- "type": {
13178
- "text": "number"
13179
- },
13180
- "default": "0",
13181
- "description": "Number of milliseconds before toast will disappear. Leave empty or set to 0 to keep toast open indefinitely",
13182
- "fieldName": "closeTimeout",
13183
- "inheritedFrom": {
13184
- "name": "ErrorBoundary",
13185
- "module": "src/error-boundary/error-boundary.ts"
13186
- }
13187
- }
13188
- ],
13189
13222
  "members": [
13190
13223
  {
13191
13224
  "kind": "field",
13192
- "name": "logger",
13193
- "privacy": "private",
13194
- "inheritedFrom": {
13195
- "name": "ErrorBoundary",
13196
- "module": "src/error-boundary/error-boundary.ts"
13197
- }
13198
- },
13199
- {
13200
- "kind": "field",
13201
- "name": "errorBoundary",
13225
+ "name": "banner",
13202
13226
  "type": {
13203
- "text": "HTMLElement"
13227
+ "text": "HTMLElement & { dismiss: () => Promise<void> }"
13204
13228
  },
13229
+ "privacy": "public",
13205
13230
  "inheritedFrom": {
13206
- "name": "ErrorBoundary",
13207
- "module": "src/error-boundary/error-boundary.ts"
13231
+ "name": "ErrorBanner",
13232
+ "module": "src/error-banner/error-banner.ts"
13208
13233
  }
13209
13234
  },
13210
13235
  {
13211
13236
  "kind": "field",
13212
- "name": "resourceName",
13213
- "description": "The resource name holding new and existing notifications",
13214
- "privacy": "public",
13237
+ "name": "error",
13238
+ "type": {
13239
+ "text": "ErrorStructure"
13240
+ },
13215
13241
  "inheritedFrom": {
13216
- "name": "ErrorBoundary",
13217
- "module": "src/error-boundary/error-boundary.ts"
13242
+ "name": "ErrorBanner",
13243
+ "module": "src/error-banner/error-banner.ts"
13218
13244
  }
13219
13245
  },
13220
13246
  {
13221
13247
  "kind": "field",
13222
- "name": "closeTimeout",
13248
+ "name": "notification",
13223
13249
  "type": {
13224
- "text": "number"
13250
+ "text": "NotificationStructure"
13225
13251
  },
13226
- "default": "0",
13227
- "description": "Number of milliseconds before toast will disappear. Leave empty or set to 0 to keep toast open indefinitely",
13228
- "privacy": "public",
13229
13252
  "inheritedFrom": {
13230
- "name": "ErrorBoundary",
13231
- "module": "src/error-boundary/error-boundary.ts"
13253
+ "name": "ErrorBanner",
13254
+ "module": "src/error-banner/error-banner.ts"
13232
13255
  }
13233
13256
  },
13234
13257
  {
13235
- "kind": "field",
13236
- "name": "datasource",
13237
- "type": {
13238
- "text": "Datasource"
13239
- },
13240
- "privacy": "private",
13258
+ "kind": "method",
13259
+ "name": "dismiss",
13260
+ "privacy": "public",
13261
+ "description": "Dismiss the Error Banner from display.",
13241
13262
  "inheritedFrom": {
13242
- "name": "ErrorBoundary",
13243
- "module": "src/error-boundary/error-boundary.ts"
13263
+ "name": "ErrorBanner",
13264
+ "module": "src/error-banner/error-banner.ts"
13244
13265
  }
13245
13266
  },
13246
13267
  {
@@ -13358,39 +13379,41 @@
13358
13379
  },
13359
13380
  {
13360
13381
  "kind": "variable",
13361
- "name": "zeroErrorBoundary"
13382
+ "name": "zeroErrorBanner",
13383
+ "description": "The Zero Banner",
13384
+ "privacy": "public"
13362
13385
  }
13363
13386
  ],
13364
13387
  "exports": [
13365
13388
  {
13366
13389
  "kind": "js",
13367
- "name": "zeroErrorBoundaryShadowOptions",
13390
+ "name": "zeroErrorBannerShadowOptions",
13368
13391
  "declaration": {
13369
- "name": "zeroErrorBoundaryShadowOptions",
13370
- "module": "src/error-boundary/error-boundary.ts"
13392
+ "name": "zeroErrorBannerShadowOptions",
13393
+ "module": "src/error-banner/error-banner.ts"
13371
13394
  }
13372
13395
  },
13373
13396
  {
13374
13397
  "kind": "js",
13375
- "name": "ErrorBoundary",
13398
+ "name": "ErrorBanner",
13376
13399
  "declaration": {
13377
- "name": "ErrorBoundary",
13378
- "module": "src/error-boundary/error-boundary.ts"
13400
+ "name": "ErrorBanner",
13401
+ "module": "src/error-banner/error-banner.ts"
13379
13402
  }
13380
13403
  },
13381
13404
  {
13382
13405
  "kind": "js",
13383
- "name": "zeroErrorBoundary",
13406
+ "name": "zeroErrorBanner",
13384
13407
  "declaration": {
13385
- "name": "zeroErrorBoundary",
13386
- "module": "src/error-boundary/error-boundary.ts"
13408
+ "name": "zeroErrorBanner",
13409
+ "module": "src/error-banner/error-banner.ts"
13387
13410
  }
13388
13411
  }
13389
13412
  ]
13390
13413
  },
13391
13414
  {
13392
13415
  "kind": "javascript-module",
13393
- "path": "src/error-boundary/index.ts",
13416
+ "path": "src/error-banner/index.ts",
13394
13417
  "declarations": [],
13395
13418
  "exports": [
13396
13419
  {
@@ -13398,134 +13421,121 @@
13398
13421
  "name": "*",
13399
13422
  "declaration": {
13400
13423
  "name": "*",
13401
- "package": "./error-boundary"
13402
- }
13403
- }
13404
- ]
13405
- },
13406
- {
13407
- "kind": "javascript-module",
13408
- "path": "src/error-banner/error-banner.stories.ts",
13409
- "declarations": [
13410
- {
13411
- "kind": "variable",
13412
- "name": "meta",
13413
- "type": {
13414
- "text": "Meta"
13415
- },
13416
- "default": "{\n title: 'Error Banner',\n component: 'zero-error-banner',\n}"
13417
- },
13418
- {
13419
- "kind": "variable",
13420
- "name": "Primary",
13421
- "type": {
13422
- "text": "StoryObj"
13423
- },
13424
- "default": "{\n args: {\n errorText: 'Lorem ipsum dolor sit amet consectetur adipisicing elit.',\n notifyText: 'Lorem ipsum dolor sit amet consectetur adipisicing elit.',\n },\n render: ({ errorText, notifyText }) => html`\n <div id=\"zero-banner\" style=\"width: 100%;\">\n <zero-button @click=\"${() => showError(errorText)}\">Show Zero Error Banner</zero-button>\n <zero-button @click=\"${() => showNotify(notifyText)}\">\n Show Zero Error Banner - Notification\n </zero-button>\n </div>\n `,\n}"
13425
- }
13426
- ],
13427
- "exports": [
13428
- {
13429
- "kind": "js",
13430
- "name": "default",
13431
- "declaration": {
13432
- "name": "meta",
13433
- "module": "src/error-banner/error-banner.stories.ts"
13424
+ "package": "./error-banner.template"
13434
13425
  }
13435
13426
  },
13436
13427
  {
13437
13428
  "kind": "js",
13438
- "name": "Primary",
13439
- "declaration": {
13440
- "name": "Primary",
13441
- "module": "src/error-banner/error-banner.stories.ts"
13442
- }
13443
- }
13444
- ]
13445
- },
13446
- {
13447
- "kind": "javascript-module",
13448
- "path": "src/error-banner/error-banner.template.ts",
13449
- "declarations": [
13450
- {
13451
- "kind": "variable",
13452
- "name": "zeroErrorBannerTemplate",
13453
- "default": "html<ErrorBanner>`\n ${getPrefixedErrorBanner('zero')}\n`"
13454
- }
13455
- ],
13456
- "exports": [
13457
- {
13458
- "kind": "js",
13459
- "name": "zeroErrorBannerTemplate",
13429
+ "name": "*",
13460
13430
  "declaration": {
13461
- "name": "zeroErrorBannerTemplate",
13462
- "module": "src/error-banner/error-banner.template.ts"
13431
+ "name": "*",
13432
+ "package": "./error-banner"
13463
13433
  }
13464
13434
  }
13465
13435
  ]
13466
13436
  },
13467
13437
  {
13468
13438
  "kind": "javascript-module",
13469
- "path": "src/error-banner/error-banner.ts",
13439
+ "path": "src/error-boundary/error-boundary.ts",
13470
13440
  "declarations": [
13471
13441
  {
13472
13442
  "kind": "variable",
13473
- "name": "zeroErrorBannerShadowOptions",
13474
- "default": "foundationErrorBannerShadowOptions"
13443
+ "name": "zeroErrorBoundaryShadowOptions",
13444
+ "type": {
13445
+ "text": "ShadowRootInit"
13446
+ },
13447
+ "default": "{\n mode: 'open',\n delegatesFocus: true,\n}"
13475
13448
  },
13476
13449
  {
13477
13450
  "kind": "class",
13478
13451
  "description": "",
13479
- "name": "ErrorBanner",
13452
+ "name": "ErrorBoundary",
13480
13453
  "superclass": {
13481
- "name": "FoundationErrorBanner",
13454
+ "name": "FoundationErrorBoundary",
13482
13455
  "package": "@genesislcap/foundation-ui"
13483
13456
  },
13484
- "tagName": "%%prefix%%-error-banner",
13457
+ "deprecated": "true",
13458
+ "tagName": "%%prefix%%-error-boundary",
13485
13459
  "customElement": true,
13486
- "members": [
13460
+ "attributes": [
13487
13461
  {
13488
- "kind": "field",
13489
- "name": "banner",
13462
+ "name": "resource-name",
13463
+ "description": "The resource name holding new and existing notifications",
13464
+ "fieldName": "resourceName",
13465
+ "inheritedFrom": {
13466
+ "name": "ErrorBoundary",
13467
+ "module": "src/error-boundary/error-boundary.ts"
13468
+ }
13469
+ },
13470
+ {
13471
+ "name": "close-timeout",
13490
13472
  "type": {
13491
- "text": "HTMLElement & { dismiss: () => Promise<void> }"
13473
+ "text": "number"
13492
13474
  },
13493
- "privacy": "public",
13475
+ "default": "0",
13476
+ "description": "Number of milliseconds before toast will disappear. Leave empty or set to 0 to keep toast open indefinitely",
13477
+ "fieldName": "closeTimeout",
13494
13478
  "inheritedFrom": {
13495
- "name": "ErrorBanner",
13496
- "module": "src/error-banner/error-banner.ts"
13479
+ "name": "ErrorBoundary",
13480
+ "module": "src/error-boundary/error-boundary.ts"
13481
+ }
13482
+ }
13483
+ ],
13484
+ "members": [
13485
+ {
13486
+ "kind": "field",
13487
+ "name": "logger",
13488
+ "privacy": "private",
13489
+ "inheritedFrom": {
13490
+ "name": "ErrorBoundary",
13491
+ "module": "src/error-boundary/error-boundary.ts"
13497
13492
  }
13498
13493
  },
13499
13494
  {
13500
13495
  "kind": "field",
13501
- "name": "error",
13496
+ "name": "errorBoundary",
13502
13497
  "type": {
13503
- "text": "ErrorStructure"
13498
+ "text": "HTMLElement"
13504
13499
  },
13505
13500
  "inheritedFrom": {
13506
- "name": "ErrorBanner",
13507
- "module": "src/error-banner/error-banner.ts"
13501
+ "name": "ErrorBoundary",
13502
+ "module": "src/error-boundary/error-boundary.ts"
13508
13503
  }
13509
13504
  },
13510
13505
  {
13511
13506
  "kind": "field",
13512
- "name": "notification",
13507
+ "name": "resourceName",
13508
+ "description": "The resource name holding new and existing notifications",
13509
+ "privacy": "public",
13510
+ "inheritedFrom": {
13511
+ "name": "ErrorBoundary",
13512
+ "module": "src/error-boundary/error-boundary.ts"
13513
+ }
13514
+ },
13515
+ {
13516
+ "kind": "field",
13517
+ "name": "closeTimeout",
13513
13518
  "type": {
13514
- "text": "NotificationStructure"
13519
+ "text": "number"
13515
13520
  },
13521
+ "default": "0",
13522
+ "description": "Number of milliseconds before toast will disappear. Leave empty or set to 0 to keep toast open indefinitely",
13523
+ "privacy": "public",
13516
13524
  "inheritedFrom": {
13517
- "name": "ErrorBanner",
13518
- "module": "src/error-banner/error-banner.ts"
13525
+ "name": "ErrorBoundary",
13526
+ "module": "src/error-boundary/error-boundary.ts"
13519
13527
  }
13520
13528
  },
13521
13529
  {
13522
- "kind": "method",
13523
- "name": "dismiss",
13524
- "privacy": "public",
13525
- "description": "Dismiss the Error Banner from display.",
13530
+ "kind": "field",
13531
+ "name": "datasource",
13532
+ "type": {
13533
+ "text": "Datasource"
13534
+ },
13535
+ "privacy": "private",
13526
13536
  "inheritedFrom": {
13527
- "name": "ErrorBanner",
13528
- "module": "src/error-banner/error-banner.ts"
13537
+ "name": "ErrorBoundary",
13538
+ "module": "src/error-boundary/error-boundary.ts"
13529
13539
  }
13530
13540
  },
13531
13541
  {
@@ -13643,41 +13653,39 @@
13643
13653
  },
13644
13654
  {
13645
13655
  "kind": "variable",
13646
- "name": "zeroErrorBanner",
13647
- "description": "The Zero Banner",
13648
- "privacy": "public"
13656
+ "name": "zeroErrorBoundary"
13649
13657
  }
13650
13658
  ],
13651
13659
  "exports": [
13652
13660
  {
13653
13661
  "kind": "js",
13654
- "name": "zeroErrorBannerShadowOptions",
13662
+ "name": "zeroErrorBoundaryShadowOptions",
13655
13663
  "declaration": {
13656
- "name": "zeroErrorBannerShadowOptions",
13657
- "module": "src/error-banner/error-banner.ts"
13664
+ "name": "zeroErrorBoundaryShadowOptions",
13665
+ "module": "src/error-boundary/error-boundary.ts"
13658
13666
  }
13659
13667
  },
13660
13668
  {
13661
13669
  "kind": "js",
13662
- "name": "ErrorBanner",
13670
+ "name": "ErrorBoundary",
13663
13671
  "declaration": {
13664
- "name": "ErrorBanner",
13665
- "module": "src/error-banner/error-banner.ts"
13672
+ "name": "ErrorBoundary",
13673
+ "module": "src/error-boundary/error-boundary.ts"
13666
13674
  }
13667
13675
  },
13668
13676
  {
13669
13677
  "kind": "js",
13670
- "name": "zeroErrorBanner",
13678
+ "name": "zeroErrorBoundary",
13671
13679
  "declaration": {
13672
- "name": "zeroErrorBanner",
13673
- "module": "src/error-banner/error-banner.ts"
13680
+ "name": "zeroErrorBoundary",
13681
+ "module": "src/error-boundary/error-boundary.ts"
13674
13682
  }
13675
13683
  }
13676
13684
  ]
13677
13685
  },
13678
13686
  {
13679
13687
  "kind": "javascript-module",
13680
- "path": "src/error-banner/index.ts",
13688
+ "path": "src/error-boundary/index.ts",
13681
13689
  "declarations": [],
13682
13690
  "exports": [
13683
13691
  {
@@ -13685,15 +13693,7 @@
13685
13693
  "name": "*",
13686
13694
  "declaration": {
13687
13695
  "name": "*",
13688
- "package": "./error-banner.template"
13689
- }
13690
- },
13691
- {
13692
- "kind": "js",
13693
- "name": "*",
13694
- "declaration": {
13695
- "name": "*",
13696
- "package": "./error-banner"
13696
+ "package": "./error-boundary"
13697
13697
  }
13698
13698
  }
13699
13699
  ]
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/foundation-zero",
3
3
  "description": "Genesis Foundation Zero Design System",
4
- "version": "14.160.1",
4
+ "version": "14.161.0",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -67,12 +67,12 @@
67
67
  },
68
68
  "devDependencies": {
69
69
  "@genesiscommunitysuccess/analyzer-import-alias-plugin": "^4.0.0",
70
- "@genesislcap/genx": "14.160.1",
71
- "@genesislcap/rollup-builder": "14.160.1",
72
- "@genesislcap/ts-builder": "14.160.1",
73
- "@genesislcap/uvu-playwright-builder": "14.160.1",
74
- "@genesislcap/vite-builder": "14.160.1",
75
- "@genesislcap/webpack-builder": "14.160.1",
70
+ "@genesislcap/genx": "14.161.0",
71
+ "@genesislcap/rollup-builder": "14.161.0",
72
+ "@genesislcap/ts-builder": "14.161.0",
73
+ "@genesislcap/uvu-playwright-builder": "14.161.0",
74
+ "@genesislcap/vite-builder": "14.161.0",
75
+ "@genesislcap/webpack-builder": "14.161.0",
76
76
  "@storybook/addon-coverage": "^1.0.1",
77
77
  "@storybook/addon-essentials": "^8.0.0",
78
78
  "@storybook/addon-links": "^8.0.0",
@@ -89,10 +89,10 @@
89
89
  "storybook": "^8.0.0"
90
90
  },
91
91
  "dependencies": {
92
- "@genesislcap/foundation-comms": "14.160.1",
93
- "@genesislcap/foundation-logger": "14.160.1",
94
- "@genesislcap/foundation-ui": "14.160.1",
95
- "@genesislcap/foundation-utils": "14.160.1",
92
+ "@genesislcap/foundation-comms": "14.161.0",
93
+ "@genesislcap/foundation-logger": "14.161.0",
94
+ "@genesislcap/foundation-ui": "14.161.0",
95
+ "@genesislcap/foundation-utils": "14.161.0",
96
96
  "@microsoft/fast-colors": "^5.3.1",
97
97
  "@microsoft/fast-components": "^2.30.6",
98
98
  "@microsoft/fast-element": "^1.12.0",
@@ -109,5 +109,5 @@
109
109
  "access": "public"
110
110
  },
111
111
  "customElements": "dist/custom-elements.json",
112
- "gitHead": "598e3599570a21709dfdc8e47adf5c77e5feff80"
112
+ "gitHead": "75ef6861f287624c5efcee0f3ca24d1c167102d3"
113
113
  }