Skip to content

improve <Portal/> container, add 2 new properties #2502

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

improve <Portal/> container, add 2 new properties #2502

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 9 additions & 5 deletions packages/solid/web/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ export function Portal<T extends boolean = false, S extends boolean = false>(pro
el: (T extends true ? { readonly shadowRoot: ShadowRoot } : {}) &
(S extends true ? SVGGElement : HTMLDivElement)
) => void);
asElement?: keyof HTMLElementTagNameMap;
class?: string[];
children: JSX.Element;
}) {
const { useShadow } = props,
Expand All @@ -84,11 +86,13 @@ export function Portal<T extends boolean = false, S extends boolean = false>(pro
createRoot(dispose => insert(el, () => (!clean() ? content!() : dispose()), null));
onCleanup(cleanup);
} else {
const container = createElement(props.isSVG ? "g" : "div", props.isSVG),
renderRoot =
useShadow && container.attachShadow
? container.attachShadow({ mode: "open" })
: container;
const container = createElement(props.isSVG ? "g" : props.asElement || "div", props.isSVG);
props.class && container.classList.add(...props.class.flatMap(str => str.split(" ")));

const renderRoot =
useShadow && container.attachShadow
? container.attachShadow({ mode: "open" })
: container;

Object.defineProperty(container, "_$host", {
get() {
Expand Down
50 changes: 50 additions & 0 deletions packages/solid/web/test/portal.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,56 @@ describe("Testing a simple Portal", () => {
});
});

describe("Testing an Portal custom container", () => {
let div = document.createElement("div"),
disposer: () => void;
const testMount = document.createElement("div");
const Component = () => (
<Portal mount={testMount} asElement="section">
Hi
</Portal>
);

test("Create portal control flow", () => {
disposer = render(Component, div);
expect(div.innerHTML).toBe("");
const container = testMount.firstChild as HTMLElement & { _$host: HTMLElement };
expect(container.tagName).toBe("SECTION");
expect(container.innerHTML).toBe("Hi");
expect(container._$host).toBe(div);
});

test("dispose", () => {
disposer();
expect(div.innerHTML).toBe("");
});
});

describe('Testing Portal "class" property', () => {
let div = document.createElement("div"),
disposer: () => void;
const testMount = document.createElement("div");
const Component = () => (
<Portal mount={testMount} class={["flex flex-col", "text-gold bg-red"]}>
★
</Portal>
);

test("Create portal control flow", () => {
disposer = render(Component, div);
expect(div.innerHTML).toBe("");
const container = testMount.firstChild as HTMLElement & { _$host: HTMLElement };
expect(container.classList.toString()).toBe("flex flex-col text-gold bg-red");
expect(container.innerHTML).toBe("★");
expect(container._$host).toBe(div);
});

test("dispose", () => {
disposer();
expect(div.innerHTML).toBe("");
});
});

describe("Testing an SVG Portal", () => {
let div = document.createElement("div"),
disposer: () => void;
Expand Down