Rename domElement to canvasElement

This commit is contained in:
Tom Coleman 2022-11-04 14:08:45 +11:00
parent 91fa988940
commit 5a4698acbc
9 changed files with 14 additions and 17 deletions

View File

@ -62,7 +62,7 @@ function render(options: OptionsArgs, el: EmberFramework['canvasElement']) {
export function renderToCanvas(
{ storyFn, kind, name, showMain, showError }: Store_RenderContext<EmberFramework>,
domElement: EmberFramework['canvasElement']
canvasElement: EmberFramework['canvasElement']
) {
const element = storyFn();

View File

@ -1,4 +1,3 @@
/* eslint-disable no-param-reassign */
import global from 'global';
import { dedent } from 'ts-dedent';
@ -42,7 +41,7 @@ export const render: ArgsStoryFn<HtmlFramework> = (args, context) => {
export function renderToCanvas(
{ storyFn, kind, name, showMain, showError, forceRemount }: Store_RenderContext<HtmlFramework>,
domElement: HtmlFramework['canvasElement']
canvasElement: HtmlFramework['canvasElement']
) {
const element = storyFn();
showMain();

View File

@ -22,7 +22,7 @@ export const render: ArgsStoryFn<PreactFramework> = (args, context) => {
let renderedStory: Element;
function preactRender(story: StoryFnPreactReturnType | null, domElement: Element): void {
function preactRender(story: StoryFnPreactReturnType | null, canvasElement: Element): void {
// @ts-expect-error (Converted from ts-ignore)
if (preact.Fragment) {
// Preact 10 only:
@ -37,7 +37,7 @@ const StoryHarness: preact.FunctionalComponent<{
title: string;
showError: Store_RenderContext<PreactFramework>['showError'];
storyFn: () => any;
domElement: PreactFramework['canvasElement'];
canvasElement: PreactFramework['canvasElement'];
}> = ({ showError, name, title, storyFn, domElement }) => {
const content = preact.h(storyFn as any, null);
if (!content) {
@ -55,7 +55,7 @@ const StoryHarness: preact.FunctionalComponent<{
export function renderToCanvas(
{ storyFn, title, name, showMain, showError, forceRemount }: Store_RenderContext<PreactFramework>,
domElement: PreactFramework['canvasElement']
canvasElement: PreactFramework['canvasElement']
) {
if (forceRemount) {
preactRender(null, domElement);

View File

@ -136,7 +136,7 @@ export async function renderToCanvas(
showException,
forceRemount,
}: Store_RenderContext<ReactFramework>,
domElement: ReactFramework['canvasElement']
canvasElement: ReactFramework['canvasElement']
) {
const Story = unboundStoryFn as FC<StoryContext<ReactFramework>>;

View File

@ -1,4 +1,3 @@
/* eslint-disable no-param-reassign */
// @ts-expect-error (Converted from ts-ignore)
import global from 'global';
@ -56,7 +55,7 @@ export async function renderToCanvas(
storyContext,
storyContext: { parameters, args, argTypes },
}: Store_RenderContext<ServerFramework>,
domElement: ServerFramework['canvasElement']
canvasElement: ServerFramework['canvasElement']
) {
// Some addons wrap the storyFn so we need to call it even though Server doesn't need the answer
storyFn();

View File

@ -7,14 +7,13 @@ import type { SvelteFramework } from './types';
const componentsByDomElement = new Map<SvelteFramework['canvasElement'], SvelteComponentTyped>();
function teardown(domElement: SvelteFramework['canvasElement']) {
function teardown(canvasElement: SvelteFramework['canvasElement']) {
if (!componentsByDomElement.has(domElement)) {
return;
}
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- we know it exists because we just checked
componentsByDomElement.get(domElement)!.$destroy();
// eslint-disable-next-line no-param-reassign -- this is on purpose
domElement.innerHTML = '';
componentsByDomElement.delete(domElement);
}
@ -29,7 +28,7 @@ export function renderToCanvas(
storyContext,
forceRemount,
}: Store_RenderContext<SvelteFramework>,
domElement: SvelteFramework['canvasElement']
canvasElement: SvelteFramework['canvasElement']
) {
const existingComponent = componentsByDomElement.get(domElement);

View File

@ -20,7 +20,7 @@ type Instance = CombinedVueInstance<
Record<never, any>
>;
const getRoot = (domElement: VueFramework['canvasElement']): Instance => {
const getRoot = (canvasElement: VueFramework['canvasElement']): Instance => {
const cachedInstance = map.get(domElement);
if (cachedInstance != null) return cachedInstance;
@ -92,7 +92,7 @@ export function renderToCanvas(
showException,
forceRemount,
}: Store_RenderContext<VueFramework>,
domElement: VueFramework['canvasElement']
canvasElement: VueFramework['canvasElement']
) {
const root = getRoot(domElement);
Vue.config.errorHandler = showException;

View File

@ -24,7 +24,7 @@ const map = new Map<VueFramework['canvasElement'], ReturnType<typeof createApp>>
export function renderToCanvas(
{ title, name, storyFn, showMain, showError, showException }: Store_RenderContext<VueFramework>,
domElement: VueFramework['canvasElement']
canvasElement: VueFramework['canvasElement']
) {
// TODO: explain cyclical nature of these app => story => mount
let element: StoryFnVueReturnType;

View File

@ -1,5 +1,5 @@
/* eslint-disable @typescript-eslint/ban-ts-comment */
/* eslint-disable no-param-reassign */
import global from 'global';
import { dedent } from 'ts-dedent';
@ -38,7 +38,7 @@ export function renderToCanvas(
showError,
forceRemount,
}: Store_RenderContext<WebComponentsFramework>,
domElement: WebComponentsFramework['canvasElement']
canvasElement: WebComponentsFramework['canvasElement']
) {
const element = storyFn();