fix(internet-header): add self admin url prop to override menu links #4936
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| '@swisspost/internet-header': patch | ||
| --- | ||
|
|
||
| Added a `selfAdminOrigin` prop to the `swisspost-internet-header` component in order to let users override the calculated URL that is currently based on the `logoutURL`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -29,9 +29,13 @@ export namespace Components { | |
| } | ||
| interface PostKlpLoginWidget { | ||
| /** | ||
| * Overrides the logout-url provided by the portal config. | ||
| */ | ||
| "logoutUrl"?: string; | ||
| /** | ||
| * Overrides the self-admin origin for menu links. | ||
| */ | ||
| "selfAdminOrigin"?: string; | ||
| /** | ||
| * Sets the focus on the login button | ||
| */ | ||
|
|
@@ -154,7 +158,7 @@ export namespace Components { | |
| */ | ||
| "login": boolean; | ||
| /** | ||
| * Overrides the logout-url provided by the portal config. | ||
| */ | ||
| "logoutUrl"?: string; | ||
| /** | ||
|
|
@@ -173,6 +177,10 @@ export namespace Components { | |
| * Toggle the search button. | ||
| */ | ||
| "search": boolean; | ||
| /** | ||
| * Overrides the logout-url provided by the portal config. | ||
| */ | ||
| "selfAdminOrigin"?: string; | ||
| /** | ||
| * Toggle skiplinks. They help keyboard users to quickly jump to important sections of the page. | ||
| */ | ||
|
|
@@ -342,9 +350,13 @@ declare namespace LocalJSX { | |
| } | ||
| interface PostKlpLoginWidget { | ||
| /** | ||
| * Overrides the logout-url provided by the portal config. | ||
| */ | ||
| "logoutUrl"?: string; | ||
| /** | ||
| * Overrides the self-admin origin for menu links. | ||
| */ | ||
| "selfAdminOrigin"?: string; | ||
| } | ||
| interface PostLanguageSwitch { | ||
| /** | ||
|
|
@@ -442,7 +454,7 @@ declare namespace LocalJSX { | |
| */ | ||
| "login"?: boolean; | ||
| /** | ||
| * Overrides the logout-url provided by the portal config. | ||
| */ | ||
| "logoutUrl"?: string; | ||
| /** | ||
|
|
@@ -465,6 +477,10 @@ declare namespace LocalJSX { | |
| * Toggle the search button. | ||
| */ | ||
| "search"?: boolean; | ||
| /** | ||
| * Overrides the logout-url provided by the portal config. | ||
| */ | ||
| "selfAdminOrigin"?: string; | ||
| /** | ||
| * Toggle skiplinks. They help keyboard users to quickly jump to important sections of the page. | ||
| */ | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -104,10 +104,15 @@ export class PostInternetHeader { | |
| @Prop() languageLocalStorageKey?: string = 'swisspost-internet-header-language'; | ||
|
|
||
| /** | ||
| * Overrides the logout-url provided by the portal config. | ||
| */ | ||
| @Prop() logoutUrl?: string; | ||
|
|
||
| /** | ||
| * Overrides the logout-url provided by the portal config. | ||
| */ | ||
| @Prop() selfAdminOrigin?: string; | ||
|
Comment on lines
+107
to
+114
There was a problem hiding this comment. Can we be a bit more specific here? These properties don't have the same effect and this comment will show up as type hint in project devs IDEs. |
||
|
|
||
| /** | ||
| * Set the currently activated route. If there is a link matching this URL in the header, it will be highlighted. | ||
| * Will also highlight partly matching URLs. When set to auto, will use current location.href for comparison. | ||
|
|
@@ -182,6 +187,7 @@ export class PostInternetHeader { | |
| try { | ||
| state.projectId = this.project; | ||
| state.stickyness = this.stickyness; | ||
| state.selfAdminOrigin = this.selfAdminOrigin; | ||
| state.environment = this.environment.toLocaleLowerCase() as Environment; | ||
| if (this.language !== undefined) state.currentLanguage = this.language; | ||
| state.languageSwitchOverrides = | ||
|
|
@@ -528,7 +534,10 @@ export class PostInternetHeader { | |
| <post-search onDropdownToggled={e => this.handleDropdownToggled(e)}></post-search> | ||
| </If> | ||
| <If condition={!!renderLogin}> | ||
| <post-klp-login-widget | ||
| logout-url={this.logoutUrl} | ||
| self-admin-origin={this.selfAdminOrigin} | ||
| > | ||
| <slot name="login-widget"></slot> | ||
| </post-klp-login-widget> | ||
| </If> | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,11 +19,12 @@ | |
| | `languageLocalStorageKey` | `language-local-storage-key` | The header uses this local storage key to set the language. Disables automatic language selection. | `string \| undefined` | `'swisspost-internet-header-language'` | | ||
| | `languageSwitchOverrides` | `language-switch-overrides` | Override the language switch links with custom URLs. Helpful when your application contains sub-pages, and you would like to stay on subpages when the user changes language. | `IAvailableLanguage[] \| string \| undefined` | `undefined` | | ||
| | `login` | `login` | Toggle the login link (when logged out) or the user widget (when logged in). | `boolean` | `true` | | ||
| | `logoutUrl` | `logout-url` | Overrides the logout-url provided by the portal config. | `string \| undefined` | `undefined` | | ||
| | `meta` | `meta` | Toggle the meta navigation. | `boolean` | `true` | | ||
| | `osFlyoutOverrides` | `os-flyout-overrides` | Online Services only: Add custom links to the special online service navigation entry | `NavMainEntity \| string \| undefined` | `undefined` | | ||
| | `project` | `project` | Your project id, previously passed as query string parameter serviceId. | `string` | `undefined` | | ||
| | `search` | `search` | Toggle the search button. | `boolean` | `true` | | ||
| | `selfAdminOrigin` | `self-admin-origin` | Overrides the logout-url provided by the portal config. | `string \| undefined` | `undefined` | | ||
| | `skiplinks` | `skiplinks` | Toggle skiplinks. They help keyboard users to quickly jump to important sections of the page. | `boolean` | `true` | | ||
| | `stickyness` | `stickyness` | Sticky behaviour of the header. | `"full" \| "main" \| "minimal" \| "none"` | `'minimal'` | | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,24 +14,34 @@ export class PostKlpLoginWidget implements IsFocusable { | |
| @Element() host: HTMLPostKlpLoginWidgetElement; | ||
|
|
||
| /** | ||
| * Overrides the logout-url provided by the portal config. | ||
| */ | ||
| @Prop() logoutUrl?: string; | ||
|
|
||
| /** | ||
| * Overrides the self-admin origin for menu links. | ||
| */ | ||
| @Prop() selfAdminOrigin?: string; | ||
|
|
||
| async componentDidLoad() { | ||
| if ( | ||
| state.localizedConfig?.header?.showJobsLoginWidget || | ||
| !state.localizedConfig?.header?.loginWidgetOptions | ||
| ) | ||
| return; | ||
| const { initializeKLPLoginWidget } = await import('./klp-widget.controller.js'); | ||
| let { platform, ...widgetOptions } = state.localizedConfig.header.loginWidgetOptions; | ||
| if (this.logoutUrl !== undefined) { | ||
| platform = { ...platform, logoutURL: this.logoutUrl }; | ||
| } | ||
| if (this.selfAdminOrigin !== undefined) { | ||
| platform = { ...platform, selfAdminOrigin: this.selfAdminOrigin }; | ||
| } | ||
|
|
||
| initializeKLPLoginWidget('post-klp-login-widget', { | ||
| ...widgetOptions, | ||
| environment: state.environment, | ||
| platform, | ||
| }); | ||
| } | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,9 +7,10 @@ | |
|
|
||
| ## Properties | ||
|
|
||
| | Property | Attribute | Description | Type | Default | | ||
| | ----------------- | ------------------- | ------------------------------------------------------- | --------------------- | ----------- | | ||
| | `logoutUrl` | `logout-url` | Overrides the logout-url provided by the portal config. | `string \| undefined` | `undefined` | | ||
| | `selfAdminOrigin` | `self-admin-origin` | Overrides the self-admin origin for menu links. | `string \| undefined` | `undefined` | | ||
|
|
||
|
|
||
| ## Methods | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,6 +16,8 @@ export interface HeaderState { | |
| localizedCustomConfig?: ILocalizedCustomConfig; | ||
| osFlyoutOverrides?: NavMainEntity; | ||
| stickyness: StickynessOptions; | ||
| logoutUrl: string | undefined; | ||
| selfAdminOrigin: string | undefined; | ||
| } | ||
|
|
||
| export const { state, reset, dispose } = createStore<HeaderState>({ | ||
|
|
@@ -27,4 +29,6 @@ export const { state, reset, dispose } = createStore<HeaderState>({ | |
| login: true, | ||
| meta: true, | ||
| stickyness: 'minimal', | ||
| logoutUrl: undefined, | ||
| selfAdminOrigin: undefined, | ||
| }); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -52,6 +52,7 @@ export interface ILoginWidgetOptions { | |
| logoutURL: string; | ||
| keepAliveURL: string; | ||
| autoLoginURL: string; | ||
| selfAdminOrigin: string; | ||
| }; | ||
| } | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since the config is not hosted or served by the Design System, we can't alter it. Also, the system serving it is due to be deprecated, so it probably won't make sense to update it there either.