@genesislcap/foundation-header 14.12.0 → 14.12.1-web-types.1

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.
@@ -335,11 +335,12 @@ declare const Navigation_base: new (...args: any[]) => {
335
335
  * - the control buttons on the right-hand side of the navigation bar can be shown or hidden, and their behaviour controlled via event listeners
336
336
  * - The contents of the flyout menu.
337
337
  *
338
- * @param logo-src - Option attribute which sets the source of the image in the navigation bar and flyout menu. The Genesis logo will be shown if this attribute is not provided.
339
- * @param show-luminance-toggle-button - Boolean attribute which controls whether the navigation bar will display the luminance toggle icon.
340
- * @param show-misc-toggle-button - Boolean attribute which controls whether the navigation bar will display the miscellaneous behaviour icon.
341
- * @param show-misc-toggle-button - Boolean attribute which controls whether the navigation bar will display the show notification icon.
342
- *
338
+ * @attr logo-src - Option attribute which sets the source of the image in the navigation bar and flyout menu. The Genesis logo will be shown if this attribute is not provided.
339
+ * @attr {boolean} show-luminance-toggle-button - Boolean attribute which controls whether the navigation bar will display the luminance toggle icon.
340
+ * @attr {boolean} show-misc-toggle-button - Boolean attribute which controls whether the navigation bar will display the miscellaneous behaviour icon.
341
+ * @attr {boolean} show-notification-button - Boolean attribute which controls whether the navigation bar will display the show notification icon.
342
+ * @attr :routeButtons - If present the defined route buttons will be rendered in the header 'routes' slot.
343
+ * @element foundation-header
343
344
  * @public
344
345
  */
345
346
  export declare class Navigation extends Navigation_base {
@@ -1 +1 @@
1
- {"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../../src/main/main.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,iBAAiB,EAAgB,MAAM,+BAA+B,CAAC;AAYtF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,wBAAwB,EAAE,IAAI,CAAC;IAC/B,mBAAmB,EAAE,IAAI,CAAC;IAC1B,2BAA2B,EAAE,IAAI,CAAC;CACnC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAKF;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAKa,UAAW,SAAQ,eAAmC;IAC3D,IAAI,EAAG,IAAI,CAAC;IACC,iBAAiB,EAAG,iBAAiB,CAAC;IAC7C,QAAQ,EAAG,GAAG,CAAC;IACf,KAAK,EAAE,OAAO,CAAS;IAEnC;;OAEG;IACgB,QAAQ,EAAE,MAAM,CAAC;IAExB,WAAW,UAAS;IAEnB,iBAAiB;IAU9B;;;;;;;OAOG;IAC8B,OAAO,EAAE,GAAG,CAAQ;IAErD;;;;;;;OAOG;IAEH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;;;;;;OAOG;IAC8D,oBAAoB,EAAE,OAAO,CAAC;IAE/F;;;;;;;OAOG;IAEH,uBAAuB,EAAE,OAAO,CAAC;IAEjC;;;;OAIG;IAEH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACS,YAAY,EAAE,KAAK,CAAC;QAC9B,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC,CAAC;IAEH;;;;;;;;OAQG;IACG,WAAW;IAKjB,cAAc;IAId;;;;;;;;;OASG;IACU,MAAM;IAgBnB;;;;;;;;;;OAUG;IACI,UAAU,CAAC,IAAI,EAAE,MAAM;IAS9B;;;;;;;;;OASG;IACH,mBAAmB;IAInB;;;;;;;;;OASG;IACH,kBAAkB;IAIlB;;;;;;;;;OASG;IACH,aAAa;IAIb;;;;;;;;;OASG;IACH,qBAAqB;CAGtB"}
1
+ {"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../../src/main/main.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,iBAAiB,EAAgB,MAAM,+BAA+B,CAAC;AAYtF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,wBAAwB,EAAE,IAAI,CAAC;IAC/B,mBAAmB,EAAE,IAAI,CAAC;IAC1B,2BAA2B,EAAE,IAAI,CAAC;CACnC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAKF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAKa,UAAW,SAAQ,eAAmC;IAC3D,IAAI,EAAG,IAAI,CAAC;IACC,iBAAiB,EAAG,iBAAiB,CAAC;IAC7C,QAAQ,EAAG,GAAG,CAAC;IACf,KAAK,EAAE,OAAO,CAAS;IAEnC;;OAEG;IACgB,QAAQ,EAAE,MAAM,CAAC;IAExB,WAAW,UAAS;IAEnB,iBAAiB;IAU9B;;;;;;;OAOG;IAC8B,OAAO,EAAE,GAAG,CAAQ;IAErD;;;;;;;OAOG;IAEH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;;;;;;OAOG;IAC8D,oBAAoB,EAAE,OAAO,CAAC;IAE/F;;;;;;;OAOG;IAEH,uBAAuB,EAAE,OAAO,CAAC;IAEjC;;;;OAIG;IAEH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACS,YAAY,EAAE,KAAK,CAAC;QAC9B,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC,CAAC;IAEH;;;;;;;;OAQG;IACG,WAAW;IAKjB,cAAc;IAId;;;;;;;;;OASG;IACU,MAAM;IAgBnB;;;;;;;;;;OAUG;IACI,UAAU,CAAC,IAAI,EAAE,MAAM;IAS9B;;;;;;;;;OASG;IACH,mBAAmB;IAInB;;;;;;;;;OASG;IACH,kBAAkB;IAIlB;;;;;;;;;OASG;IACH,aAAa;IAIb;;;;;;;;;OASG;IACH,qBAAqB;CAGtB"}
@@ -21,11 +21,12 @@ const name = 'foundation-header';
21
21
  * - the control buttons on the right-hand side of the navigation bar can be shown or hidden, and their behaviour controlled via event listeners
22
22
  * - The contents of the flyout menu.
23
23
  *
24
- * @param logo-src - Option attribute which sets the source of the image in the navigation bar and flyout menu. The Genesis logo will be shown if this attribute is not provided.
25
- * @param show-luminance-toggle-button - Boolean attribute which controls whether the navigation bar will display the luminance toggle icon.
26
- * @param show-misc-toggle-button - Boolean attribute which controls whether the navigation bar will display the miscellaneous behaviour icon.
27
- * @param show-misc-toggle-button - Boolean attribute which controls whether the navigation bar will display the show notification icon.
28
- *
24
+ * @attr logo-src - Option attribute which sets the source of the image in the navigation bar and flyout menu. The Genesis logo will be shown if this attribute is not provided.
25
+ * @attr {boolean} show-luminance-toggle-button - Boolean attribute which controls whether the navigation bar will display the luminance toggle icon.
26
+ * @attr {boolean} show-misc-toggle-button - Boolean attribute which controls whether the navigation bar will display the miscellaneous behaviour icon.
27
+ * @attr {boolean} show-notification-button - Boolean attribute which controls whether the navigation bar will display the show notification icon.
28
+ * @attr :routeButtons - If present the defined route buttons will be rendered in the header 'routes' slot.
29
+ * @element foundation-header
29
30
  * @public
30
31
  */
31
32
  let Navigation = class Navigation extends EventEmitter(FASTElement) {
package/package.json CHANGED
@@ -1,10 +1,16 @@
1
1
  {
2
2
  "name": "@genesislcap/foundation-header",
3
3
  "description": "Genesis Foundation Header",
4
- "version": "14.12.0",
4
+ "version": "14.12.1-web-types.1",
5
5
  "license": "SEE LICENSE IN license.txt",
6
6
  "main": "dist/esm/index.js",
7
7
  "types": "dist/foundation-header.d.ts",
8
+ "wca": {
9
+ "webtypesConfig": {
10
+ "default-icon": "<svg width='26' height='26' viewBox='0 0 26 26' fill='none' xmlns='http://www.w3.org/2000/svg'><path d='M18.7702 23.0437C18.7702 22.4675 18.8526 21.8089 19.0995 21.3149C19.3465 20.7386 19.6758 20.2447 20.0874 19.833C20.4991 19.4214 20.993 19.0921 21.5693 18.8451C22.1456 18.5982 22.7219 18.5158 23.2981 18.5158H25.9326V11.6828H19.1819V14.3172C19.1819 15.5521 18.6879 16.7047 17.8647 17.5279C17.0414 18.3512 15.8888 18.8451 14.7363 18.9275H6.7507V6.99025H16.4651V0.157227H3.54C2.63442 0.157227 1.72884 0.568855 1.07023 1.22746C0.411628 1.88606 0 2.79165 0 3.77955V22.2205C0 23.1261 0.411628 24.0316 1.07023 24.7726C1.72884 25.4312 2.63442 25.8428 3.54 25.8428H18.7702V23.0437Z' fill='white'/></svg>",
11
+ "description-markup": "markdown"
12
+ }
13
+ },
8
14
  "config": {
9
15
  "PORT": 5010
10
16
  },
@@ -18,11 +24,12 @@
18
24
  },
19
25
  "./package.json": "./package.json"
20
26
  },
27
+ "web-types": "./web-types.json",
21
28
  "scripts": {
22
29
  "api": "npm run api:extract && npm run api:document",
23
30
  "api:extract": "api-extractor run",
24
31
  "api:document": "api-documenter markdown -i dist -o docs/api",
25
- "build": "npm run clean && npm run build:tsc && npm run copy-files && npm run api",
32
+ "build": "npm run clean && npm run build:tsc && npm run copy-files",
26
33
  "build:tsc": "tsc -b ./tsconfig.json",
27
34
  "build:webpack": "cross-env NODE_ENV=production webpack",
28
35
  "build:webpack:make-federated-types": "make-federated-types",
@@ -48,10 +55,14 @@
48
55
  "test:unit:node": "npm run test:unit:node:src && npm run test:unit:node:test",
49
56
  "test:unit:node:src": "uvu -r tsm -r esm -r ./jsdom.setup.ts ./src \".*.test.ts\"",
50
57
  "test:unit:node:test": "uvu -r tsm -r esm -r ./jsdom.setup.ts ./test/unit \".*.test.ts\"",
51
- "test:unit:watch": "watchlist src test -- npm run test:unit"
58
+ "test:unit:watch": "watchlist src test -- npm run test:unit",
59
+ "modify-json": "node ../../../../build/web-types-cleaner.js web-types.json",
60
+ "web-types:analyze": "wca-webtypes analyze src --format webtypes --outFile web-types.json",
61
+ "custom-data:analyze": "wca-webtypes analyze src --format vscode --outFile vscode.html-custom-data.json",
62
+ "all:analyze": "npm run web-types:analyze && npm run custom-data:analyze && npm run modify-json"
52
63
  },
53
64
  "devDependencies": {
54
- "@genesislcap/foundation-testing": "^14.12.0",
65
+ "@genesislcap/foundation-testing": "14.12.1-web-types.1",
55
66
  "@microsoft/api-documenter": "^7.19.13",
56
67
  "@microsoft/api-extractor": "^7.31.1",
57
68
  "@playwright/test": "^1.18.1",
@@ -85,6 +96,7 @@
85
96
  "typescript": "^4.5.5",
86
97
  "uvu": "0.5.4",
87
98
  "watchlist": "^0.3.1",
99
+ "web-component-analyzer-webtypes": "2.0.10",
88
100
  "webpack": "^5.45.1",
89
101
  "webpack-bundle-analyzer": "^4.5.0",
90
102
  "webpack-cli": "^4.5.0",
@@ -92,10 +104,10 @@
92
104
  "webpack-merge": "^5.7.3"
93
105
  },
94
106
  "dependencies": {
95
- "@genesislcap/foundation-comms": "^14.12.0",
96
- "@genesislcap/foundation-events": "^14.12.0",
97
- "@genesislcap/foundation-utils": "^14.12.0",
98
- "@genesislcap/foundation-zero": "^14.12.0",
107
+ "@genesislcap/foundation-comms": "14.12.1-web-types.1",
108
+ "@genesislcap/foundation-events": "14.12.1-web-types.1",
109
+ "@genesislcap/foundation-utils": "14.12.1-web-types.1",
110
+ "@genesislcap/foundation-zero": "14.12.1-web-types.1",
99
111
  "@microsoft/fast-colors": "^5.1.4",
100
112
  "@microsoft/fast-components": "^2.21.3",
101
113
  "@microsoft/fast-element": "^1.7.0",
@@ -106,5 +118,5 @@
106
118
  "publishConfig": {
107
119
  "access": "public"
108
120
  },
109
- "gitHead": "f84b4de93910209defc04617003570694119d368"
121
+ "gitHead": "a4276897a8c2de488adb04a7f2d63bdc7aaae53c"
110
122
  }
@@ -0,0 +1,36 @@
1
+ {
2
+ "version": 1,
3
+ "tags": [
4
+ {
5
+ "name": "foundation-header",
6
+ "description": "Navigation micro-frontend includes navigation bar and flyout menu\n\nAttributes:\n\n * `logo-src` - Option attribute which sets the source of the image in the navigation bar and flyout menu. The Genesis logo will be shown if this attribute is not provided.\n\n * `show-luminance-toggle-button` {boolean} - Boolean attribute which controls whether the navigation bar will display the luminance toggle icon.\n\n * `show-misc-toggle-button` {boolean} - Boolean attribute which controls whether the navigation bar will display the miscellaneous behaviour icon.\n\n * `show-notification-button` {boolean} - Boolean attribute which controls whether the navigation bar will display the show notification icon.\n\n * `:routeButtons` - If present the defined route buttons will be rendered in the header 'routes' slot.\n\nProperties:\n\n * `auth` {`Auth`} - \n\n * `credentialManager` {`CredentialManager`} - \n\n * `provider` - \n\n * `ready` {`boolean`} - \n\n * `userName` {`string`} - Username of the logged in user\n\n * `sideNavOpen` {`boolean`} - \n\n * `logoSrc` - Optional attribute which controls the icon to show on the navigation bar and flyout\nControl via `logo-src`\n\n * `showLuminanceToggleButton` {`boolean`} - Boolean attribute which controls whether to show the luminance (moon) icon on the navigation bar\nControl via`show-luminance-toggle-button`\n\n * `showMiscToggleButton` {`boolean`} - Boolean attribute which controls whether to show the miscellaneous (menu) icon on the navigation bar\nControl via `show-luminance-toggle-button`\n\n * `showNotificationsButton` {`boolean`} - Boolean attribute which controls whether to show the notification (bell) icon on the navigation bar\nControl via `show-notification-button`\n\n * `hideSideBar` {`boolean`} - Boolean attribute which controls whether to include the sideNav component\nControl via`hide-side-bar`\n\n * `routeButtons` {`{ index: number; path: string; title: string; icon: string; variant: string; }[]`} - If present the defined route buttons will be rendered in the header 'routes' slot\n\n * `boundObservables` - \n\n * `behaviors` - \n\n * `needsInitialization` - \n\n * `_template` - \n\n * `_styles` - \n\n * `_isConnected` - \n\n * `element` {`HTMLElement`} - The element being controlled by this controller.\n\n * `definition` - The element definition that instructs this controller\r\nin how to handle rendering and other platform integrations.\n\n * `view` {`ElementView | null`} - The view associated with the custom element.\n\n * `isConnected` {`boolean`} - Indicates whether or not the custom element has been\r\nconnected to the document.\n\n * `setIsConnected` - \n\n * `template` {`ElementViewTemplate | null`} - Gets/sets the template used to render the component.\n\n * `styles` - Gets/sets the primary styles used for the component.\n\n * `finishInitialization` - \n\n * `renderTemplate` - \n\n * `subscribers` - \n\n * `sourceSubscribers` - \n\n * `source` - The source that property changes are being notified for.\n\n * `$fastController` - This allows Observable.getNotifier(...) to return the Controller\r\nwhen the notifier for the Controller itself is being requested. The\r\nresult is that the Observable system does not need to create a separate\r\ninstance of Notifier for observables on the Controller. The component and\r\nthe controller will now share the same notifier, removing one-object construct\r\nper web component instance.",
7
+ "attributes": [
8
+ {
9
+ "name": "logo-src",
10
+ "description": "`logo-src` - Option attribute which sets the source of the image in the navigation bar and flyout menu. The Genesis logo will be shown if this attribute is not provided.\n\n"
11
+ },
12
+ {
13
+ "name": "show-luminance-toggle-button",
14
+ "description": "`show-luminance-toggle-button` {boolean} - Boolean attribute which controls whether the navigation bar will display the luminance toggle icon.\n\n",
15
+ "valueSet": "v"
16
+ },
17
+ {
18
+ "name": "show-misc-toggle-button",
19
+ "description": "`show-misc-toggle-button` {boolean} - Boolean attribute which controls whether the navigation bar will display the miscellaneous behaviour icon.\n\n",
20
+ "valueSet": "v"
21
+ },
22
+ {
23
+ "name": "show-notification-button",
24
+ "description": "`show-notification-button` {boolean} - Boolean attribute which controls whether the navigation bar will display the show notification icon.\n\n",
25
+ "valueSet": "v"
26
+ },
27
+ {
28
+ "name": ":routeButtons",
29
+ "description": "`:routeButtons` - If present the defined route buttons will be rendered in the header 'routes' slot.\n\n"
30
+ }
31
+ ]
32
+ }
33
+ ],
34
+ "globalAttributes": [],
35
+ "valueSets": []
36
+ }
package/web-types.json ADDED
@@ -0,0 +1,98 @@
1
+ {
2
+ "$schema": "http://json.schemastore.org/web-types",
3
+ "name": "@genesislcap/foundation-header",
4
+ "version": "14.12.1",
5
+ "default-icon": "<svg width='26' height='26' viewBox='0 0 26 26' fill='none' xmlns='http://www.w3.org/2000/svg'><path d='M18.7702 23.0437C18.7702 22.4675 18.8526 21.8089 19.0995 21.3149C19.3465 20.7386 19.6758 20.2447 20.0874 19.833C20.4991 19.4214 20.993 19.0921 21.5693 18.8451C22.1456 18.5982 22.7219 18.5158 23.2981 18.5158H25.9326V11.6828H19.1819V14.3172C19.1819 15.5521 18.6879 16.7047 17.8647 17.5279C17.0414 18.3512 15.8888 18.8451 14.7363 18.9275H6.7507V6.99025H16.4651V0.157227H3.54C2.63442 0.157227 1.72884 0.568855 1.07023 1.22746C0.411628 1.88606 0 2.79165 0 3.77955V22.2205C0 23.1261 0.411628 24.0316 1.07023 24.7726C1.72884 25.4312 2.63442 25.8428 3.54 25.8428H18.7702V23.0437Z' fill='white'/></svg>",
6
+ "description-markup": "markdown",
7
+ "contributions": {
8
+ "html": {
9
+ "elements": [
10
+ {
11
+ "name": "foundation-header",
12
+ "description": "Navigation micro-frontend includes navigation bar and flyout menu",
13
+ "source": {
14
+ "module": "./src/main/main.ts",
15
+ "symbol": "Navigation"
16
+ },
17
+ "attributes": [
18
+ {
19
+ "name": "logo-src",
20
+ "required": false,
21
+ "priority": "normal",
22
+ "value": {
23
+ "kind": "plain",
24
+ "type": "",
25
+ "required": true
26
+ },
27
+ "description": "Option attribute which sets the source of the image in the navigation bar and flyout menu. The Genesis logo will be shown if this attribute is not provided.",
28
+ "source": {
29
+ "module": "./src/main/main.ts",
30
+ "symbol": "Navigation.undefined"
31
+ }
32
+ },
33
+ {
34
+ "name": "show-luminance-toggle-button",
35
+ "required": false,
36
+ "priority": "normal",
37
+ "value": {
38
+ "type": "boolean",
39
+ "required": false
40
+ },
41
+ "description": "Boolean attribute which controls whether the navigation bar will display the luminance toggle icon.",
42
+ "source": {
43
+ "module": "./src/main/main.ts",
44
+ "symbol": "Navigation.undefined"
45
+ }
46
+ },
47
+ {
48
+ "name": "show-misc-toggle-button",
49
+ "required": false,
50
+ "priority": "normal",
51
+ "value": {
52
+ "type": "boolean",
53
+ "required": false
54
+ },
55
+ "description": "Boolean attribute which controls whether the navigation bar will display the miscellaneous behaviour icon.",
56
+ "source": {
57
+ "module": "./src/main/main.ts",
58
+ "symbol": "Navigation.undefined"
59
+ }
60
+ },
61
+ {
62
+ "name": "show-notification-button",
63
+ "required": false,
64
+ "priority": "normal",
65
+ "value": {
66
+ "type": "boolean",
67
+ "required": false
68
+ },
69
+ "description": "Boolean attribute which controls whether the navigation bar will display the show notification icon.",
70
+ "source": {
71
+ "module": "./src/main/main.ts",
72
+ "symbol": "Navigation.undefined"
73
+ }
74
+ },
75
+ {
76
+ "name": ":routeButtons",
77
+ "required": false,
78
+ "priority": "normal",
79
+ "value": {
80
+ "kind": "plain",
81
+ "type": "",
82
+ "required": true
83
+ },
84
+ "description": "If present the defined route buttons will be rendered in the header 'routes' slot.",
85
+ "source": {
86
+ "module": "./src/main/main.ts",
87
+ "symbol": "Navigation.undefined"
88
+ }
89
+ }
90
+ ]
91
+ }
92
+ ]
93
+ },
94
+ "css": {
95
+ "properties": []
96
+ }
97
+ }
98
+ }