Skip to content

feat: Widgetize app layout skeleton event base #3497

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

Draft
wants to merge 68 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
68 commits
Select commit Hold shift + click to select a range
1c5d6a2
feat: Widgetise app layout skeleton
georgylobko Apr 1, 2025
61aef35
Merge branch 'main' into feat/widgetize-app-layout-skeleton
georgylobko Apr 14, 2025
12dfb0a
chore: Move skeleton elements attributes to a widgetized hook
georgylobko Apr 15, 2025
1b33698
chore: Move skeleton slots to widgets
georgylobko Apr 15, 2025
75cb09e
Merge branch 'main' into feat/widgetize-app-layout-skeleton
georgylobko Apr 15, 2025
282a413
chore: Widgetize all remaining components
georgylobko Apr 15, 2025
e38730e
Merge branch 'main' into feat/widgetize-app-layout-skeleton
georgylobko Apr 16, 2025
a64c3a1
feat: AppLayout state as widget
georgylobko Apr 22, 2025
13f60f0
chore: small fix
georgylobko Apr 22, 2025
c3c8b63
Merge branch 'main' into feat/widgetize-app-layout-skeleton
georgylobko Apr 22, 2025
b0203ed
chore: small fix
georgylobko Apr 22, 2025
d8447e9
Merge remote-tracking branch 'origin/main' into feat/widgetize-app-la…
georgylobko Apr 22, 2025
90d178e
Merge branch 'main' into feat/widgetize-app-layout-skeleton
georgylobko Apr 22, 2025
d1f41c0
chore: Increase package limit size
georgylobko Apr 22, 2025
94ddfd0
Merge remote-tracking branch 'origin/main' into feat/widgetize-app-la…
georgylobko Apr 23, 2025
33e717f
chore: Small refactoring
georgylobko Apr 23, 2025
3beaa8f
chore: Pull react-reverse-portal as src util
georgylobko Apr 23, 2025
262ab1d
Merge branch 'main' into feat/widgetize-app-layout-skeleton
georgylobko Apr 23, 2025
2a4865b
chore: Revert unrelated changes in runtime-drawers.page.tsx
georgylobko Apr 23, 2025
467c88d
fix: SSR tests
georgylobko Apr 23, 2025
a00ad7b
fix: Skeleton part tests
georgylobko Apr 23, 2025
90873fe
feat: Deliver skeleton slots attributes as a widget part
georgylobko Apr 24, 2025
b1b525e
fix: Unit tests
georgylobko Apr 24, 2025
3088384
Merge remote-tracking branch 'origin/main' into feat/widgetize-app-la…
georgylobko Apr 24, 2025
8ef5d18
chore: Update snapshots
georgylobko Apr 24, 2025
cf8254e
chore: Tests for reverse portal
georgylobko Apr 24, 2025
c321d92
chore: Additional tests for reverse portal
georgylobko Apr 25, 2025
5b4e5a4
fix: Integ tests
georgylobko Apr 25, 2025
9431d21
Merge remote-tracking branch 'origin/main' into feat/widgetize-app-la…
georgylobko Apr 25, 2025
c92ba3c
chore: Skip hash for class names in widget contract tests
georgylobko Apr 25, 2025
887e74f
fix: Tests
georgylobko Apr 25, 2025
592817e
chore: Wrap up
georgylobko Apr 25, 2025
2a114b0
Merge branch 'main' into feat/widgetize-app-layout-skeleton
georgylobko Apr 25, 2025
1627182
Merge branch 'main' into feat/widgetize-app-layout-skeleton
georgylobko Apr 28, 2025
2ccd6ed
Merge branch 'main' into feat/widgetize-app-layout-skeleton
georgylobko Apr 29, 2025
89cd1d5
chore: Fallbacks for app layout component when is in loading state (a…
georgylobko Apr 29, 2025
393d2d9
Merge branch 'main' into feat/widgetize-app-layout-skeleton
georgylobko May 2, 2025
19ddb8b
chore: Delay breadcrumbs rendering until app layout state is loaded
georgylobko May 2, 2025
95c2da1
feat: Event-base prop passing
georgylobko May 7, 2025
4c0b2e1
Merge branch 'main' into feat/widgetize-app-layout-skeleton-event-base
georgylobko May 13, 2025
479dd11
Fix u tests and remove unused reverse-portal
georgylobko May 13, 2025
8a15f33
Merge branch 'main' into feat/widgetize-app-layout-skeleton-event-base
georgylobko May 13, 2025
d99928b
feat: Split app layout state into widgetized and built-in parts
georgylobko May 16, 2025
7c3bce7
Merge remote-tracking branch 'origin/main' into feat/widgetize-app-la…
georgylobko May 27, 2025
d1fdfc4
chore: Merge expanded mode
georgylobko May 30, 2025
b19d2e9
Merge remote-tracking branch 'origin/main' into feat/widgetize-app-la…
georgylobko May 30, 2025
42cc432
chore: Merge from main
georgylobko May 30, 2025
a8c0aaa
fix: useMergeRefs import
georgylobko May 30, 2025
052c746
fix: remove unnecessary import
georgylobko May 30, 2025
ef47dd6
fix: Navigation fallback for useMultiAppLayout
georgylobko May 30, 2025
aa1ddbc
chore: Refactoring, fixed tools test
georgylobko May 30, 2025
a19ac0e
chore: Refactoring, fixed skeleton test
georgylobko Jun 2, 2025
b3a90d4
chore: Update snapshots
georgylobko Jun 2, 2025
b7ffeda
fix: header-variant test
georgylobko Jun 2, 2025
c5855a1
fix: toolbar test
georgylobko Jun 2, 2025
22e87d9
fix: multi-layout.test.tsx
georgylobko Jun 2, 2025
a85b3a0
fix: slots.test.tsx
georgylobko Jun 2, 2025
84d7687
fix: desktop.test.tsx
georgylobko Jun 2, 2025
bc89b6a
chore: Update snapshots
georgylobko Jun 3, 2025
07cb663
fix: split-panel.test.tsx
georgylobko Jun 3, 2025
b588832
fix: main.test.tsx
georgylobko Jun 3, 2025
acc4ac9
fix: drawers.test.tsx
georgylobko Jun 3, 2025
f628f82
fix: common.test.tsx
georgylobko Jun 3, 2025
d6809af
fix: analytics-metadata.test.tsx
georgylobko Jun 3, 2025
c30b2eb
chore: Update snapshots
georgylobko Jun 3, 2025
cc2369e
Merge branch 'main' into feat/widgetize-app-layout-skeleton-event-base
georgylobko Jun 3, 2025
aaa2a90
chore: Update snapshots
georgylobko Jun 3, 2025
3b1c67f
Merge branch 'main' into feat/widgetize-app-layout-skeleton-event-base
georgylobko Jun 4, 2025
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
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
import React, { useRef, useState } from 'react';
import React, { useEffect, useRef, useState } from 'react';

import AppLayout from '~components/app-layout';
import BreadcrumbGroup from '~components/breadcrumb-group';
Expand All @@ -18,6 +18,14 @@ import labels from './utils/labels';

function createView(name: string) {
return function View() {
const [count, setCount] = useState(0);

useEffect(() => {
console.log('mount ', name);

return () => console.log('unmount ', name);
}, []);

return (
<AppLayout
data-testid="secondary-layout"
Expand Down Expand Up @@ -45,6 +53,9 @@ function createView(name: string) {
</Link>

<div>Page content: {name}</div>

<button onClick={() => setCount(count + 1)}>increment count</button>
{count}
</SpaceBetween>
}
tools={<Tools>Tools content: {name}</Tools>}
Expand Down
15 changes: 14 additions & 1 deletion pages/app-layout/runtime-drawers.page.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
import React, { useContext, useRef, useState } from 'react';
import React, { useContext, useEffect, useRef, useState } from 'react';

import {
AppLayout,
Expand Down Expand Up @@ -31,6 +31,18 @@ type DemoContext = React.Context<
}>
>;

const CustomContent = () => {
useEffect(() => {
console.log('mount');

return () => {
console.log('unmount');
};
}, []);

return <div>Custom content</div>;
};

export default function WithDrawers() {
const [activeDrawerId, setActiveDrawerId] = useState<string | null>(null);
const [helpPathSlug, setHelpPathSlug] = useState<string>('default');
Expand Down Expand Up @@ -131,6 +143,7 @@ export default function WithDrawers() {
}
>
Content
<CustomContent />
</Header>
<Containers />
</ContentLayout>
Expand Down
56 changes: 29 additions & 27 deletions pages/utils/iframe-wrapper.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -32,35 +32,37 @@ export function IframeWrapper({ id, AppComponent }: { id: string; AppComponent:
const ref = useRef<HTMLDivElement>(null);

useEffect(() => {
const container = ref.current;
if (!container) {
return;
}
const iframeEl = container.ownerDocument.createElement('iframe');
iframeEl.className = styles['full-screen'];
iframeEl.id = id;
iframeEl.title = id;
container.appendChild(iframeEl);
setTimeout(() => {
const container = ref.current;
if (!container) {
return;
}
const iframeEl = container.ownerDocument.createElement('iframe');
iframeEl.className = styles['full-screen'];
iframeEl.id = id;
iframeEl.title = id;
container.appendChild(iframeEl);

const iframeDocument = iframeEl.contentDocument!;
// Prevent iframe document instance from reload
// https://bugzilla.mozilla.org/show_bug.cgi?id=543435
iframeDocument.open();
// set html5 doctype
iframeDocument.writeln('<!DOCTYPE html>');
iframeDocument.close();
const iframeDocument = iframeEl.contentDocument!;
// Prevent iframe document instance from reload
// https://bugzilla.mozilla.org/show_bug.cgi?id=543435
iframeDocument.open();
// set html5 doctype
iframeDocument.writeln('<!DOCTYPE html>');
iframeDocument.close();

const innerAppRoot = iframeDocument.createElement('div');
iframeDocument.body.appendChild(innerAppRoot);
copyStyles(document, iframeDocument);
iframeDocument.dir = document.dir;
const syncClassesCleanup = syncClasses(document.body, iframeDocument.body);
ReactDOM.render(<AppComponent />, innerAppRoot);
return () => {
syncClassesCleanup();
ReactDOM.unmountComponentAtNode(innerAppRoot);
container.removeChild(iframeEl);
};
const innerAppRoot = iframeDocument.createElement('div');
iframeDocument.body.appendChild(innerAppRoot);
copyStyles(document, iframeDocument);
iframeDocument.dir = document.dir;
const syncClassesCleanup = syncClasses(document.body, iframeDocument.body);
ReactDOM.render(<AppComponent />, innerAppRoot);
return () => {
syncClassesCleanup();
ReactDOM.unmountComponentAtNode(innerAppRoot);
container.removeChild(iframeEl);
};
}, 50);
}, [id, AppComponent]);

return <div ref={ref}></div>;
Expand Down
27 changes: 21 additions & 6 deletions src/app-layout-toolbar/__tests__/analytics-metadata.test.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
import React from 'react';
import { act, render } from '@testing-library/react';
import { act, render, waitFor } from '@testing-library/react';

import {
activateAnalyticsMetadata,
Expand Down Expand Up @@ -125,7 +125,7 @@ describe('AppLayoutToolbar renders correct analytics metadata', () => {
});
});
describe('with tools', () => {
test('closed', () => {
test('closed', async () => {
const wrapper = renderToolbar({
tools: <span>tools</span>,
toolsOpen: false,
Expand All @@ -134,6 +134,9 @@ describe('AppLayoutToolbar renders correct analytics metadata', () => {
toolsToggle: 'toggle tools',
},
});
await waitFor(() => {
expect(wrapper.findToolsToggle()).toBeTruthy();
});
const toolsTrigger = wrapper.findToolsToggle().getElement();
validateComponentNameAndLabels(toolsTrigger, {});
expect(getGeneratedAnalyticsMetadata(toolsTrigger)).toEqual({
Expand All @@ -144,7 +147,7 @@ describe('AppLayoutToolbar renders correct analytics metadata', () => {
...getMetadata(),
});
});
test('open', () => {
test('open', async () => {
const wrapper = renderToolbar({
tools: <span>tools</span>,
toolsOpen: true,
Expand All @@ -154,6 +157,9 @@ describe('AppLayoutToolbar renders correct analytics metadata', () => {
toolsClose: 'close tools',
},
});
await waitFor(() => {
expect(wrapper.findToolsToggle()).toBeTruthy();
});
const toolsTrigger = wrapper.findToolsToggle().getElement();
validateComponentNameAndLabels(toolsTrigger, {});
expect(getGeneratedAnalyticsMetadata(toolsTrigger)).toEqual({
Expand All @@ -174,7 +180,7 @@ describe('AppLayoutToolbar renders correct analytics metadata', () => {
});

describe('with local drawer', () => {
test('closed', () => {
test('closed', async () => {
const wrapper = renderToolbar({
drawers: [
{
Expand All @@ -191,6 +197,9 @@ describe('AppLayoutToolbar renders correct analytics metadata', () => {
},
],
});
await waitFor(() => {
expect(wrapper.findDrawerTriggerById('test-drawer')).toBeTruthy();
});
const drawerTrigger = wrapper.findDrawerTriggerById('test-drawer')!.getElement();
validateComponentNameAndLabels(drawerTrigger, {});
expect(getGeneratedAnalyticsMetadata(drawerTrigger)).toEqual({
Expand All @@ -201,7 +210,7 @@ describe('AppLayoutToolbar renders correct analytics metadata', () => {
...getMetadata(),
});
});
test('open', () => {
test('open', async () => {
const wrapper = renderToolbar({
drawers: [
{
Expand Down Expand Up @@ -232,6 +241,9 @@ describe('AppLayoutToolbar renders correct analytics metadata', () => {
activeDrawerId: 'test-drawer',
onDrawerChange: () => {},
});
await waitFor(() => {
expect(wrapper.findDrawerTriggerById('test-drawer')).toBeTruthy();
});
const drawerTrigger = wrapper.findDrawerTriggerById('test-drawer')!.getElement();
validateComponentNameAndLabels(drawerTrigger, {});
expect(getGeneratedAnalyticsMetadata(drawerTrigger)).toEqual({
Expand Down Expand Up @@ -319,7 +331,7 @@ describe('AppLayoutToolbar renders correct analytics metadata', () => {
});

describe('with split panel', () => {
test.each(['open', 'close'])('%s', action => {
test.each(['open', 'close'])('%s', async action => {
const wrapper = renderToolbar({
splitPanel: (
<SplitPanel i18nStrings={{ openButtonAriaLabel: 'open split panel' }} header="Split panel header">
Expand All @@ -329,6 +341,9 @@ describe('AppLayoutToolbar renders correct analytics metadata', () => {
splitPanelOpen: action !== 'open',
onSplitPanelToggle: () => {},
});
await waitFor(() => {
expect(wrapper.findSplitPanelOpenButton()).toBeTruthy();
});
const splitPanelTrigger = wrapper.findSplitPanelOpenButton()!.getElement();
validateComponentNameAndLabels(splitPanelTrigger, {});
expect(getGeneratedAnalyticsMetadata(splitPanelTrigger)).toEqual({
Expand Down
Loading
Loading