@genesislcap/foundation-header 14.140.0 → 14.141.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.
Files changed (50) hide show
  1. package/dist/custom-elements.json +555 -25
  2. package/dist/dts/components/zero-components.d.ts +6 -0
  3. package/dist/dts/components/zero-components.d.ts.map +1 -0
  4. package/dist/dts/config/config.d.ts +33 -0
  5. package/dist/dts/config/config.d.ts.map +1 -0
  6. package/dist/dts/config/configure.d.ts +27 -0
  7. package/dist/dts/config/configure.d.ts.map +1 -0
  8. package/dist/dts/config/index.d.ts +2 -0
  9. package/dist/dts/config/index.d.ts.map +1 -1
  10. package/dist/dts/config/templates.d.ts +34 -0
  11. package/dist/dts/config/templates.d.ts.map +1 -0
  12. package/dist/dts/main/index.d.ts +1 -1
  13. package/dist/dts/main/index.d.ts.map +1 -1
  14. package/dist/dts/main/main.d.ts +64 -22
  15. package/dist/dts/main/main.d.ts.map +1 -1
  16. package/dist/dts/main/main.styles.d.ts.map +1 -1
  17. package/dist/dts/main/main.template.d.ts.map +1 -1
  18. package/dist/dts/tags/index.d.ts +2 -0
  19. package/dist/dts/tags/index.d.ts.map +1 -0
  20. package/dist/dts/tags/tags.d.ts +36 -0
  21. package/dist/dts/tags/tags.d.ts.map +1 -0
  22. package/dist/esm/components/zero-components.js +48 -0
  23. package/dist/esm/config/config.js +18 -0
  24. package/dist/esm/config/configure.js +56 -0
  25. package/dist/esm/config/index.js +2 -0
  26. package/dist/esm/config/templates.js +14 -0
  27. package/dist/esm/main/index.js +1 -1
  28. package/dist/esm/main/main.js +57 -22
  29. package/dist/esm/main/main.styles.js +56 -133
  30. package/dist/esm/main/main.template.js +32 -28
  31. package/dist/esm/tags/index.js +1 -0
  32. package/dist/esm/tags/tags.js +39 -0
  33. package/dist/foundation-header.api.json +219 -0
  34. package/dist/foundation-header.d.ts +200 -24
  35. package/docs/api/foundation-header.configure.md +46 -0
  36. package/docs/api/foundation-header.defaultheaderconfig.md +13 -0
  37. package/docs/api/foundation-header.foundationheader.md +39 -0
  38. package/docs/api/foundation-header.headerconfig.md +21 -0
  39. package/docs/api/foundation-header.headerconfig.templateoptions.md +18 -0
  40. package/docs/api/foundation-header.md +14 -0
  41. package/docs/api/foundation-header.navigation.headerconfig.md +11 -0
  42. package/docs/api/foundation-header.navigation.md +1 -0
  43. package/docs/api-report.md +46 -2
  44. package/package.json +14 -12
  45. package/dist/dts/components/components.d.ts +0 -9
  46. package/dist/dts/components/components.d.ts.map +0 -1
  47. package/dist/dts/components/index.d.ts +0 -2
  48. package/dist/dts/components/index.d.ts.map +0 -1
  49. package/dist/esm/components/components.js +0 -42
  50. package/dist/esm/components/index.js +0 -1
@@ -8,12 +8,26 @@
8
8
 
9
9
  | Class | Description |
10
10
  | --- | --- |
11
+ | [FoundationHeader](./foundation-header.foundationheader.md) | FoundationHeader is a zero version of the header micro-frontend. |
11
12
  | [Navigation](./foundation-header.navigation.md) | Navigation micro-frontend includes navigation bar and flyout menu |
12
13
 
14
+ ## Functions
15
+
16
+ | Function | Description |
17
+ | --- | --- |
18
+ | [configure(config)](./foundation-header.configure.md) | A function that allows configuring the header micro-frontend with name and templateOptions. |
19
+
20
+ ## Interfaces
21
+
22
+ | Interface | Description |
23
+ | --- | --- |
24
+ | [HeaderConfig](./foundation-header.headerconfig.md) | HeaderConfig DI interface. |
25
+
13
26
  ## Variables
14
27
 
15
28
  | Variable | Description |
16
29
  | --- | --- |
30
+ | [defaultHeaderConfig](./foundation-header.defaultheaderconfig.md) | Default HeaderConfig DI implementation. |
17
31
  | [MainStyles](./foundation-header.mainstyles.md) | Base styles for the foundation-header |
18
32
  | [NavTemplate](./foundation-header.navtemplate.md) | Template for Navigation class |
19
33
 
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-header](./foundation-header.md) &gt; [Navigation](./foundation-header.navigation.md) &gt; [headerConfig](./foundation-header.navigation.headerconfig.md)
4
+
5
+ ## Navigation.headerConfig property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ headerConfig: HeaderConfig;
11
+ ```
@@ -23,6 +23,7 @@ export declare class Navigation extends Navigation_base
23
23
  | --- | --- | --- | --- |
24
24
  | [auth](./foundation-header.navigation.auth.md) | | Auth | |
25
25
  | [credentialManager](./foundation-header.navigation.credentialmanager.md) | | CredentialManager | |
26
+ | [headerConfig](./foundation-header.navigation.headerconfig.md) | | [HeaderConfig](./foundation-header.headerconfig.md) | |
26
27
  | [hideSideBar](./foundation-header.navigation.hidesidebar.md) | | boolean | Boolean attribute which controls whether to include the sideNav component Control via<code>hide-side-bar</code> |
27
28
  | [i18next](./foundation-header.navigation.i18next.md) | | I18next | |
28
29
  | [languageOptions](./foundation-header.navigation.languageoptions.md) | | [LanguageOptions](./foundation-header.languageoptions.md) | |
@@ -12,11 +12,45 @@ import { EmitOptions } from '@genesislcap/foundation-events';
12
12
  import { EmitReturn } from '@genesislcap/foundation-events';
13
13
  import type { FoundationRouteNavItem } from '@genesislcap/foundation-ui';
14
14
  import { I18next } from '@genesislcap/foundation-i18n';
15
+ import { InterfaceSymbol } from '@microsoft/fast-foundation';
16
+ import { PartialFASTElementDefinition } from '@microsoft/fast-element';
17
+ import { SyntheticViewTemplate } from '@microsoft/fast-element';
18
+ import { TemplateElementDependency } from '@genesislcap/foundation-ui';
15
19
  import { ViewTemplate } from '@microsoft/fast-element';
16
20
 
21
+ // @public
22
+ export function configure(config: Partial<HeaderConfig>): Promise<Navigation>;
23
+
24
+ // @public
25
+ export const defaultHeaderConfig: HeaderConfig;
26
+
27
+ // Warning: (ae-internal-missing-underscore) The name "DynamicTemplate" should be prefixed with an underscore because the declaration is marked as @internal
28
+ //
29
+ // @internal
30
+ export const DynamicTemplate: ViewTemplate<Navigation>;
31
+
17
32
  // @public
18
33
  export type ElementTargetId = HeaderTargetId | NavTargetId | SideNavTargetId;
19
34
 
35
+ // @public
36
+ export class FoundationHeader extends Navigation {
37
+ // @internal (undocumented)
38
+ connectedCallback(): Promise<void>;
39
+ // @internal (undocumented)
40
+ loadRemotes(): Promise<void>;
41
+ }
42
+
43
+ // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "HeaderConfig" because one of its declarations is marked as @internal
44
+ //
45
+ // @public
46
+ export interface HeaderConfig extends PartialFASTElementDefinition {
47
+ // Warning: (ae-forgotten-export) The symbol "TemplateOptions" needs to be exported by the entry point index.d.ts
48
+ templateOptions: TemplateOptions;
49
+ }
50
+
51
+ // @internal
52
+ export const HeaderConfig: InterfaceSymbol<HeaderConfig>;
53
+
20
54
  // @public
21
55
  export type HeaderTargetId = 'header-start' | 'header' | 'header-end';
22
56
 
@@ -26,9 +60,19 @@ export type LanguageOptions = {
26
60
  selectedLanguage: string;
27
61
  };
28
62
 
63
+ // Warning: (ae-internal-missing-underscore) The name "LoadingTemplate" should be prefixed with an underscore because the declaration is marked as @internal
64
+ //
65
+ // @internal
66
+ export const LoadingTemplate: ViewTemplate<Navigation>;
67
+
29
68
  // @public
30
69
  export const MainStyles: ElementStyles;
31
70
 
71
+ // Warning: (ae-internal-missing-underscore) The name "MainTemplate" should be prefixed with an underscore because the declaration is marked as @internal
72
+ //
73
+ // @internal
74
+ export const MainTemplate: ViewTemplate<Navigation>;
75
+
32
76
  // @public
33
77
  export type NavEventDetailMap = {
34
78
  'luminance-icon-clicked': void;
@@ -48,13 +92,13 @@ export class Navigation extends Navigation_base {
48
92
  connectedCallback(): Promise<void>;
49
93
  // (undocumented)
50
94
  credentialManager: CredentialManager;
95
+ // (undocumented)
96
+ headerConfig: HeaderConfig;
51
97
  hideSideBar: boolean;
52
98
  // (undocumented)
53
99
  i18next: I18next;
54
100
  // (undocumented)
55
101
  languageOptions: LanguageOptions;
56
- // @internal
57
- loadRemotes(): Promise<void>;
58
102
  logoSrc: any;
59
103
  logout(): Promise<void>;
60
104
  // @internal
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/foundation-header",
3
3
  "description": "Genesis Foundation Header",
4
- "version": "14.140.0",
4
+ "version": "14.141.1",
5
5
  "license": "SEE LICENSE IN license.txt",
6
6
  "main": "dist/esm/index.js",
7
7
  "types": "dist/foundation-header.d.ts",
@@ -28,7 +28,7 @@
28
28
  },
29
29
  "./config": {
30
30
  "types": "./dist/dts/config/index.d.ts",
31
- "default": "./dist/esm/esm/config/index.js"
31
+ "default": "./dist/esm/config/index.js"
32
32
  },
33
33
  "./e2e": {
34
34
  "default": "./test/e2e/index.ts"
@@ -68,21 +68,23 @@
68
68
  "test:debug": "genx test --debug"
69
69
  },
70
70
  "devDependencies": {
71
- "@genesislcap/foundation-testing": "14.140.0",
72
- "@genesislcap/genx": "14.140.0",
71
+ "@genesislcap/foundation-testing": "14.141.1",
72
+ "@genesislcap/genx": "14.141.1",
73
73
  "rimraf": "^3.0.2"
74
74
  },
75
75
  "dependencies": {
76
- "@genesislcap/foundation-comms": "14.140.0",
77
- "@genesislcap/foundation-events": "14.140.0",
78
- "@genesislcap/foundation-i18n": "14.140.0",
79
- "@genesislcap/foundation-logger": "14.140.0",
80
- "@genesislcap/foundation-shell": "14.140.0",
81
- "@genesislcap/foundation-ui": "14.140.0",
82
- "@genesislcap/foundation-zero": "14.140.0",
76
+ "@genesislcap/foundation-comms": "14.141.1",
77
+ "@genesislcap/foundation-events": "14.141.1",
78
+ "@genesislcap/foundation-i18n": "14.141.1",
79
+ "@genesislcap/foundation-logger": "14.141.1",
80
+ "@genesislcap/foundation-shell": "14.141.1",
81
+ "@genesislcap/foundation-ui": "14.141.1",
82
+ "@genesislcap/foundation-utils": "14.141.1",
83
+ "@genesislcap/foundation-zero": "14.141.1",
83
84
  "@microsoft/fast-colors": "^5.3.1",
84
85
  "@microsoft/fast-components": "^2.30.6",
85
86
  "@microsoft/fast-element": "^1.12.0",
87
+ "@microsoft/fast-foundation": "^2.49.4",
86
88
  "@microsoft/fast-router": "^0.4.8",
87
89
  "tslib": "^2.3.1"
88
90
  },
@@ -95,5 +97,5 @@
95
97
  "access": "public"
96
98
  },
97
99
  "customElements": "dist/custom-elements.json",
98
- "gitHead": "219aed4b34d2df90cbf2003e9a4d84a8a627495e"
100
+ "gitHead": "25fd8b62107c27f17a668eaba2182a4a2176966b"
99
101
  }
@@ -1,9 +0,0 @@
1
- export declare const loadZeroDesignSystem: () => Promise<any>;
2
- /**
3
- * Load the wp5 module federation remote versions, or fallback to code split bundled versions.
4
- * You would really be targeting the client's design system, components etc here. For now just targeting zero.
5
- */
6
- export declare const loadRemotes: () => Promise<{
7
- ZeroDesignSystem: any;
8
- }>;
9
- //# sourceMappingURL=components.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"components.d.ts","sourceRoot":"","sources":["../../../src/components/components.ts"],"names":[],"mappings":"AAqBA,eAAO,MAAM,oBAAoB,oBAWhC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,WAAW;;EAKvB,CAAC"}
@@ -1,2 +0,0 @@
1
- export * from './components';
2
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC"}
@@ -1,42 +0,0 @@
1
- import { __awaiter } from "tslib";
2
- /**
3
- * These DS / Component imports will be replaced with an import from the local alpha design system.
4
- * We're just fixing something on our side to allow you to extend zero.
5
- */
6
- import { allComponents, provideFASTDesignSystem } from '@microsoft/fast-components';
7
- import { logger } from '../utils';
8
- provideFASTDesignSystem().register(allComponents);
9
- var ResourceType;
10
- (function (ResourceType) {
11
- ResourceType["local"] = "local";
12
- ResourceType["remote"] = "remote";
13
- })(ResourceType || (ResourceType = {}));
14
- function loadZeroFallback() {
15
- return import(
16
- /* webpackMode: "lazy" */
17
- '@genesislcap/foundation-zero');
18
- }
19
- export const loadZeroDesignSystem = () => __awaiter(void 0, void 0, void 0, function* () {
20
- let type = ResourceType.remote;
21
- try {
22
- // @ts-ignore
23
- return yield import('foundationZero/ZeroDesignSystem');
24
- }
25
- catch (e) {
26
- type = ResourceType.local;
27
- return yield loadZeroFallback();
28
- }
29
- finally {
30
- logger.debug(`Using '${type}' version of foundationZero/DesignSystem`);
31
- }
32
- });
33
- /**
34
- * Load the wp5 module federation remote versions, or fallback to code split bundled versions.
35
- * You would really be targeting the client's design system, components etc here. For now just targeting zero.
36
- */
37
- export const loadRemotes = () => __awaiter(void 0, void 0, void 0, function* () {
38
- const { registerZeroDesignSystem } = yield loadZeroDesignSystem();
39
- return {
40
- ZeroDesignSystem: registerZeroDesignSystem(),
41
- };
42
- });
@@ -1 +0,0 @@
1
- export * from './components';