Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weโ€™ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: deprecate legacy navigation frames #1597

Merged
merged 31 commits into from
Dec 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
a772890
feat: map navigation story
jul-lam Nov 27, 2024
1dbb8e4
fix: map overlay story
danielleroux Nov 27, 2024
a9a8cac
feat: add basic navigation story
jul-lam Nov 28, 2024
8c71ad7
feat: add context menu dropdown
jul-lam Nov 28, 2024
8414843
Merge branch 'main' into feat/deprecate-legacy-navigation-frames
jul-lam Nov 28, 2024
c019b5b
fix(story/map-navigation): update context menu dropdown
jul-lam Nov 28, 2024
69d184c
fix(story/map-navigation): remove context menu dropdown
jul-lam Nov 29, 2024
e3b57a8
docs(application): refactor examples
jul-lam Dec 3, 2024
be58f4d
docs(application): remove avatar and dropdown from basic example
jul-lam Dec 3, 2024
81e23e0
docs: fix links
jul-lam Dec 3, 2024
29135c4
docs(map-navigation): refactor examples
jul-lam Dec 3, 2024
8c258d0
docs(application): fix react property names
jul-lam Dec 3, 2024
ad97f89
docs(map-navigation): add migration examples
jul-lam Dec 3, 2024
d6e13a3
Merge branch 'main' into feat/deprecate-legacy-navigation-frames
jul-lam Dec 3, 2024
111bfb0
refactor(playgroundV3): fix spelling and remove unused imports
jul-lam Dec 4, 2024
603f45f
docs(playgroundV3): add keep functionality for comments
jul-lam Dec 4, 2024
981de4d
docs(map-navigation): add keep keywords to relevant comments in migraโ€ฆ
jul-lam Dec 4, 2024
8311049
docs(map-navigation): add migration section
jul-lam Dec 4, 2024
9ea4249
docs(basic-navigation): add migration examples
jul-lam Dec 4, 2024
f705077
docs(basic-navigation): add migration section
jul-lam Dec 4, 2024
4af2d17
docs: add reusable note block component
jul-lam Dec 4, 2024
0d449e6
docs(map-navigation): update style guide
jul-lam Dec 4, 2024
65c861d
docs(map-navigation): add note block
jul-lam Dec 4, 2024
bcbf9dd
Merge remote-tracking branch 'origin/release-3.0.0' into feat/deprecaโ€ฆ
jul-lam Dec 4, 2024
20be277
docs: change note block props to readonly
jul-lam Dec 4, 2024
e0626b7
docs: revert unwanted angular test app changes
jul-lam Dec 4, 2024
58e0418
docs: revert unwanted angular test app changes
jul-lam Dec 4, 2024
5d06b85
docs: add redirect urls for deprecated navigation frames
jul-lam Dec 5, 2024
a2d9ec7
docs: rename legacy component examples to legacy examples
jul-lam Dec 9, 2024
8d38e8b
Merge branch 'release-3.0.0' into feat/deprecate-legacy-navigation-frโ€ฆ
jul-lam Dec 9, 2024
d98c5ab
Update app.module.ts
nuke-ellington Dec 11, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 14 additions & 8 deletions packages/angular-test-app/src/app/app-routing.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,12 @@ import Loading from '../preview-examples/loading';
import MapNavigation from '../preview-examples/map-navigation';
import MapNavigationOverlay from '../preview-examples/map-navigation-overlay';
import MenuCategory from '../preview-examples/menu-category';
import MenuWithBottomTabs from '../preview-examples/menu-with-bottom-tabs';
import Message from '../preview-examples/message';
import MessageBar from '../preview-examples/message-bar';
import ModalByInstance from '../preview-examples/modal-by-instance';
import ModalByInstanceContent from '../preview-examples/modal-by-instance-content';
import ModalByTemplate from '../preview-examples/modal-by-template';
import ModalSizes from '../preview-examples/modal-sizes';
import NumberInput from '../preview-examples/number-input';
import NumberInputDisabled from '../preview-examples/number-input-disabled';
Expand All @@ -156,6 +160,7 @@ import NumberInputReadonly from '../preview-examples/number-input-readonly';
import NumberInputStepperButton from '../preview-examples/number-input-stepper-button';
import NumberInputValidation from '../preview-examples/number-input-validation';
import Pagination from '../preview-examples/pagination';
import PaginationAdvanced from '../preview-examples/pagination-advanced';
import Pane from '../preview-examples/pane';
import PaneLayout from '../preview-examples/pane-layout';
import Pill from '../preview-examples/pill';
Expand Down Expand Up @@ -204,8 +209,10 @@ import ToggleButtonPrimaryOutline from '../preview-examples/toggle-button-primar
import ToggleButtonSecondary from '../preview-examples/toggle-button-secondary';
import ToggleButtonSecondaryGhost from '../preview-examples/toggle-button-secondary-ghost';
import ToggleButtonSecondaryOutline from '../preview-examples/toggle-button-secondary-outline';
import ToggleChecked from '../preview-examples/toggle-checked';
import ToggleCustomLabel from '../preview-examples/toggle-custom-label';
import ToggleDisabled from '../preview-examples/toggle-disabled';
import ToggleIndeterminate from '../preview-examples/toggle-indeterminate';
import ToggleNgModel from '../preview-examples/toggle-ng-model';
import Tooltip from '../preview-examples/tooltip';
import Tree from '../preview-examples/tree';
Expand All @@ -217,14 +224,8 @@ import VerticalTabs from '../preview-examples/vertical-tabs';
import VerticalTabsWithAvatar from '../preview-examples/vertical-tabs-with-avatar';
import Workflow from '../preview-examples/workflow';
import WorkflowVertical from '../preview-examples/workflow-vertical';

import MenuWithBottomTabs from '../preview-examples/menu-with-bottom-tabs';
import Message from '../preview-examples/message';
import ModalByInstanceContent from '../preview-examples/modal-by-instance-content';
import ModalByTemplate from '../preview-examples/modal-by-template';
import PaginationAdvanced from '../preview-examples/pagination-advanced';
import ToggleChecked from '../preview-examples/toggle-checked';
import ToggleIndeterminate from '../preview-examples/toggle-indeterminate';
import MapNavigationMigration from '../preview-examples/map-navigation-migration';
import BasicNavigationMigration from '../preview-examples/basic-navigation-migration';

const routes: Routes = [
{
Expand Down Expand Up @@ -298,6 +299,10 @@ const routes: Routes = [
path: 'basic-navigation',
component: BasicNavigation,
},
{
path: 'basic-navigation-migration',
component: BasicNavigationMigration,
},
{
path: 'blind-header-actions',
component: BlindHeaderActions,
Expand Down Expand Up @@ -893,6 +898,7 @@ const routes: Routes = [
{ path: 'workflow-vertical', component: WorkflowVertical },
{ path: 'map-navigation', component: MapNavigation },
{ path: 'map-navigation-overlay', component: MapNavigationOverlay },
{ path: 'map-navigation-migration', component: MapNavigationMigration },
{ path: 'number-input', component: NumberInput },
{ path: 'number-input-disabled', component: NumberInputDisabled },
{ path: 'number-input-label', component: NumberInputLabel },
Expand Down
4 changes: 4 additions & 0 deletions packages/angular-test-app/src/app/app.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ import Avatar from '../preview-examples/avatar';
import AvatarImage from '../preview-examples/avatar-image';
import AvatarInitials from '../preview-examples/avatar-initials';
import BasicNavigation from '../preview-examples/basic-navigation';
import BasicNavigationMigration from '../preview-examples/basic-navigation-migration';
import BasicNavigationWithoutHeader from '../preview-examples/basic-navigation-without-header';
import Blind from '../preview-examples/blind';
import BlindHeaderActions from '../preview-examples/blind-header-actions';
Expand Down Expand Up @@ -233,6 +234,7 @@ import VerticalTabs from '../preview-examples/vertical-tabs';
import VerticalTabsWithAvatar from '../preview-examples/vertical-tabs-with-avatar';
import Workflow from '../preview-examples/workflow';
import WorkflowVertical from '../preview-examples/workflow-vertical';
import MapNavigationMigration from '../preview-examples/map-navigation-migration';

@NgModule({
declarations: [
Expand All @@ -253,6 +255,7 @@ import WorkflowVertical from '../preview-examples/workflow-vertical';
Avatar,
BasicNavigationWithoutHeader,
BasicNavigation,
BasicNavigationMigration,
BlindHeaderActions,
BlindVariants,
Blind,
Expand Down Expand Up @@ -445,6 +448,7 @@ import WorkflowVertical from '../preview-examples/workflow-vertical';
WorkflowVertical,
MapNavigation,
MapNavigationOverlay,
MapNavigationMigration,
NumberInput,
NumberInputDisabled,
NumberInputLabel,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,20 @@
<ix-application [appSwitchConfig]="appSwitchConfig">
<ix-application-header name="My Application">
<div class="placeholder-logo" slot="logo"></div>

<ix-dropdown-button variant="secondary" label="Select config" ghost>
<ix-dropdown-item label="Config 1"></ix-dropdown-item>
<ix-dropdown-item label="Config 2"></ix-dropdown-item>
<ix-dropdown-item label="Config 3"></ix-dropdown-item>
</ix-dropdown-button>

<ix-avatar>
<ix-dropdown-item label="Action 1"></ix-dropdown-item>
<ix-dropdown-item label="Action 2"></ix-dropdown-item>
<ix-dropdown-item label="Action 3"></ix-dropdown-item>
</ix-avatar>
</ix-application-header>

<ix-menu>
<ix-menu-item>Item 1</ix-menu-item>
<ix-menu-item>Item 2</ix-menu-item>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
<ix-menu-item>Item 1</ix-menu-item>
<ix-menu-item>Item 2</ix-menu-item>
</ix-menu>

<ix-content>
<ix-content-header slot="header" header-title="Choose breakpoint">
</ix-content-header>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
<ix-application-header name="My Application">
<div class="placeholder-logo" slot="logo"></div>
</ix-application-header>

<ix-menu>
<ix-menu-item>Item 1</ix-menu-item>
<ix-menu-item>Item 2</ix-menu-item>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
/*
* SPDX-FileCopyrightText: 2024 Siemens AG
*
* SPDX-License-Identifier: MIT
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
/*
* Styles get overwritten by html-test-app css files each build or dev task.
* If you want to modify the example styles do this only inside the html-test-app
*/

ix-application {
width: 100vw;
height: 100vh;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!--
SPDX-FileCopyrightText: 2024 Siemens AG

SPDX-License-Identifier: MIT

This source code is licensed under the MIT license found in the
LICENSE file in the root directory of this source tree.
-->

<ix-application>
<!--{KEEP} Compare hideHeader property -->
<ix-application-header name="My Application">
<div class="placeholder-logo" slot="logo"></div>
</ix-application-header>

<ix-menu>
<ix-menu-item>Item 1</ix-menu-item>
<ix-menu-item>Item 2</ix-menu-item>
</ix-menu>
</ix-application>
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
/*
* SPDX-FileCopyrightText: 2024 Siemens AG
*
* SPDX-License-Identifier: MIT
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

import { Component } from '@angular/core';

@Component({
selector: 'app-example',
templateUrl: './basic-navigation-migration.html',
styleUrls: ['./basic-navigation-migration.css'],
})
export default class BasicNavigationMigration {}
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
/*
* SPDX-FileCopyrightText: 2024 Siemens AG
*
* SPDX-License-Identifier: MIT
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
/*
* Styles get overwritten by html-test-app css files each build or dev task.
* If you want to modify the example styles do this only inside the html-test-app
*/

.application {
height: 100vh;
width: 100vw;

.overlay {
position: absolute;
right: 0;
z-index: 1;
}

.content {
box-sizing: border-box;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
<ix-application class="application">
<ix-application-header name="My Application">
<div class="placeholder-logo" slot="logo"></div>

<!--{KEEP} Compare context menu -->
<ix-dropdown-button variant="secondary" label="Select config" ghost>
<ix-dropdown-item label="Config 1"></ix-dropdown-item>
<ix-dropdown-item label="Config 2"></ix-dropdown-item>
<ix-dropdown-item label="Config 3"></ix-dropdown-item>
</ix-dropdown-button>
</ix-application-header>

<ix-menu>
<ix-menu-item>Item 1</ix-menu-item>
<ix-menu-item>Item 2</ix-menu-item>
</ix-menu>

<!--{KEEP} Compare overlay -->
<ix-pane
class="overlay"
composition="right"
heading="Custom overlay"
icon="bulb"
size="320px"
variant="floating"
hide-on-collapse
[expanded]="expanded"
(expandedChanged)="resetExpanded($event)"
>
Overlay content
</ix-pane>

<ix-pane-layout>
<!--{KEEP} Compare sidebar -->
<ix-pane slot="left" heading="Navigation title" size="320px" expanded>
Sidebar content
</ix-pane>

<ix-content class="content">
<ix-content-header slot="header" header-title="My Content Page">
</ix-content-header>

<ix-button (click)="toggleOverlay()">Open overlay</ix-button>
</ix-content>
</ix-pane-layout>
</ix-application>
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/*
* SPDX-FileCopyrightText: 2024 Siemens AG
*
* SPDX-License-Identifier: MIT
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

import { Component } from '@angular/core';

@Component({
selector: 'app-example',
templateUrl: './map-navigation-migration.html',
styleUrls: ['./map-navigation-migration.css'],
})
export default class MapNavigationMigration {
expanded = false;

resetExpanded(event: Event) {
requestAnimationFrame(() => {
this.expanded = (event as CustomEvent).detail.expanded;
});
}

toggleOverlay() {
this.expanded = !this.expanded;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -13,24 +13,37 @@ import { Component } from '@angular/core';
selector: 'app-example',
template: `
<ix-map-navigation
application-name="Test Application"
navigation-title="Some other content"
application-name="My Application"
navigation-title="Navigation title"
hide-context-menu="false"
>
<div class="placeholder-logo" slot="logo"></div>

<ix-menu>
<ix-menu-item>Item 1</ix-menu-item>
<ix-menu-item>Item 2</ix-menu-item>
<ix-menu-item>Item 3</ix-menu-item>
</ix-menu>
<div slot="sidebar-content">Sidebar content</div>
<ix-button (click)="showOverlay = true">Show overlay</ix-button>

<ix-content slot="sidebar-content">Sidebar content</ix-content>

<ix-content>
<ix-content-header
slot="header"
header-title="My Content Page"
></ix-content-header>

<ix-button (click)="showOverlay = true">Show overlay</ix-button>
</ix-content>

<ix-map-navigation-overlay
*ngIf="showOverlay"
name="Custom overlay title"
icon="bulb"
slot="overlay"
name="Custom overlay"
icon="bulb"
(closeClick)="showOverlay = false"
></ix-map-navigation-overlay>
>
<ix-content>Overlay content</ix-content>
</ix-map-navigation-overlay>
</ix-map-navigation>
`,
})
Expand Down
18 changes: 13 additions & 5 deletions packages/angular-test-app/src/preview-examples/map-navigation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,25 @@ import { Component } from '@angular/core';
selector: 'app-example',
template: `
<ix-map-navigation
application-name="Test Application"
navigation-title="Some other content"
application-name="My Application"
navigation-title="Navigation title"
hide-context-menu="false"
>
<div class="placeholder-logo" slot="logo"></div>

<ix-menu>
<ix-menu-item>Item 1</ix-menu-item>
<ix-menu-item>Item 2</ix-menu-item>
<ix-menu-item>Item 3</ix-menu-item>
</ix-menu>
<div slot="sidebar-content">Sidebar content</div>
<div>Content</div>

<ix-content slot="sidebar-content">Sidebar content</ix-content>

<ix-content>
<ix-content-header
slot="header"
header-title="My Content Page"
></ix-content-header>
</ix-content>
</ix-map-navigation>
`,
})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,6 @@ Interactive items can take one of four states: Default, hover, active and focuse
### Related patterns:

- [Dropdown](dropdown.md)
- [Basic navigation](application-frame/basic-navigation.md)
- [Map navigation](application-frame/map-navigation.md)
- [Basic navigation](../legacy/basic-navigation.md)
- [Map navigation](../legacy/map-navigation.md)
- [Workflow](workflow.md)
Loading
Loading