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.

Sign up for GitHub

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

Jump to bottom

Update POS render function to use createRoot #2353

Open
wants to merge 3 commits into
base: unstable
Choose a base branch
from
Open

Update POS render function to use createRoot #2353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7fa8faf
js-update-pos-render-to-createroot
js-goupil Sep 17, 2024
547404d
Pulled the new createRoot logic into util function
js-goupil Sep 18, 2024
0c8f546
Implemented remote root render for admin
js-goupil Sep 19, 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
26 changes: 7 additions & 19 deletions packages/ui-extensions-react/src/surfaces/admin/render.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import type {ReactElement} from 'react';
import {render as remoteRender} from '@remote-ui/react';

import {extension} from '@shopify/ui-extensions/admin';
import type {
Expand All @@ -9,6 +8,7 @@ import type {
} from '@shopify/ui-extensions/admin';

import {ExtensionApiContext} from './context';
import {remoteRootRender} from '../../utilities/remoteRootRender';

/**
* Registers your React-based UI Extension to run for the selected extension point.
Expand Down Expand Up @@ -36,24 +36,12 @@ export function reactExtension<ExtensionTarget extends RenderExtensionTarget>(
return extension<'Playground'>(target as any, async (root, api) => {
const element = await render(api as ApiForRenderExtension<ExtensionTarget>);

await new Promise<void>((resolve, reject) => {
try {
remoteRender(
<ExtensionApiContext.Provider value={api}>
{element}
</ExtensionApiContext.Provider>,
root,
() => {
resolve();
},
);
} catch (error) {
// Workaround for https://github.com/Shopify/ui-extensions/issues/325
// eslint-disable-next-line no-console
console.error(error);
reject(error);
}
});
return remoteRootRender(
<ExtensionApiContext.Provider value={api}>
{element}
</ExtensionApiContext.Provider>,
root,
);
}) as any;
}

Expand Down
27 changes: 7 additions & 20 deletions packages/ui-extensions-react/src/surfaces/point-of-sale/render.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import type {ReactElement, PropsWithChildren} from 'react';
import {Component} from 'react';
import {render as remoteRender} from '@remote-ui/react';
import {extension} from '@shopify/ui-extensions/point-of-sale';
import type {
ExtensionTargets,
Expand All @@ -9,6 +8,7 @@ import type {
} from '@shopify/ui-extensions/point-of-sale';

import {ExtensionApiContext} from './context';
import {remoteRootRender} from '../../utilities/remoteRootRender';

/**
* Registers your React-based UI Extension to run for the selected extension target.
Expand Down Expand Up @@ -38,25 +38,12 @@ export function reactExtension<Target extends RenderExtensionTarget>(
// shape (`RenderExtension`).
return extension<'pos.home.tile.render'>(target as any, async (root, api) => {
const element = await render(api as ApiForRenderExtension<Target>);

await new Promise<void>((resolve, reject) => {
try {
remoteRender(
<ExtensionApiContext.Provider value={api}>
<ErrorBoundary>{element}</ErrorBoundary>
</ExtensionApiContext.Provider>,
root,
() => {
resolve();
},
);
} catch (error) {
// Workaround for https://github.com/Shopify/ui-extensions/issues/325
// eslint-disable-next-line no-console
console.error(error);
reject(error);
}
});
return remoteRootRender(
<ExtensionApiContext.Provider value={api}>
<ErrorBoundary>{element}</ErrorBoundary>
</ExtensionApiContext.Provider>,
root,
);
}) as any;
}

Expand Down
18 changes: 18 additions & 0 deletions packages/ui-extensions-react/src/utilities/remoteRootRender.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import {ReactNode} from 'react';
import {RemoteRoot, createRoot} from '@remote-ui/react';

export const remoteRootRender = (node: ReactNode, root: RemoteRoot) => {
return new Promise<() => void>((resolve, reject) => {
try {
const remoteRoot = createRoot(root);
remoteRoot.render(node);

resolve(remoteRoot.unmount);
} catch (error) {
// Workaround for https://github.com/Shopify/ui-extensions/issues/325
// eslint-disable-next-line no-console
console.error(error);
reject(error);
}
});
};
8 changes: 4 additions & 4 deletions packages/ui-extensions/src/extension.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ export interface RenderExtensionWithRemoteRoot<
any
> = RemoteComponentType<any, any, any>,
> {
(
root: RemoteRoot<AllowedComponents, AllowedComponents>,
api: Api,
): void | Promise<void>;
(root: RemoteRoot<AllowedComponents, AllowedComponents>, api: Api):
| void
| Promise<void>
| Promise<() => void>;
}

export interface RunnableExtension<Api, Output> {
Expand Down
Loading