From 5a4698acbc95e7c64e2eb7933b041ced0c87e28d Mon Sep 17 00:00:00 2001 From: Tom Coleman Date: Fri, 4 Nov 2022 14:08:45 +1100 Subject: [PATCH] Rename `domElement` to `canvasElement` --- code/frameworks/ember/src/client/preview/render.ts | 2 +- code/renderers/html/src/render.ts | 3 +-- code/renderers/preact/src/render.tsx | 6 +++--- code/renderers/react/src/render.tsx | 2 +- code/renderers/server/src/render.ts | 3 +-- code/renderers/svelte/src/render.ts | 5 ++--- code/renderers/vue/src/render.ts | 4 ++-- code/renderers/vue3/src/render.ts | 2 +- code/renderers/web-components/src/render.ts | 4 ++-- 9 files changed, 14 insertions(+), 17 deletions(-) diff --git a/code/frameworks/ember/src/client/preview/render.ts b/code/frameworks/ember/src/client/preview/render.ts index ed5a7b4b53c..5e6096fa729 100644 --- a/code/frameworks/ember/src/client/preview/render.ts +++ b/code/frameworks/ember/src/client/preview/render.ts @@ -62,7 +62,7 @@ function render(options: OptionsArgs, el: EmberFramework['canvasElement']) { export function renderToCanvas( { storyFn, kind, name, showMain, showError }: Store_RenderContext, - domElement: EmberFramework['canvasElement'] + canvasElement: EmberFramework['canvasElement'] ) { const element = storyFn(); diff --git a/code/renderers/html/src/render.ts b/code/renderers/html/src/render.ts index e18e234d164..c1f5e7556dc 100644 --- a/code/renderers/html/src/render.ts +++ b/code/renderers/html/src/render.ts @@ -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 = (args, context) => { export function renderToCanvas( { storyFn, kind, name, showMain, showError, forceRemount }: Store_RenderContext, - domElement: HtmlFramework['canvasElement'] + canvasElement: HtmlFramework['canvasElement'] ) { const element = storyFn(); showMain(); diff --git a/code/renderers/preact/src/render.tsx b/code/renderers/preact/src/render.tsx index f0381565296..539816cee17 100644 --- a/code/renderers/preact/src/render.tsx +++ b/code/renderers/preact/src/render.tsx @@ -22,7 +22,7 @@ export const render: ArgsStoryFn = (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['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, - domElement: PreactFramework['canvasElement'] + canvasElement: PreactFramework['canvasElement'] ) { if (forceRemount) { preactRender(null, domElement); diff --git a/code/renderers/react/src/render.tsx b/code/renderers/react/src/render.tsx index d564992cbe0..4aa2e8bcd69 100644 --- a/code/renderers/react/src/render.tsx +++ b/code/renderers/react/src/render.tsx @@ -136,7 +136,7 @@ export async function renderToCanvas( showException, forceRemount, }: Store_RenderContext, - domElement: ReactFramework['canvasElement'] + canvasElement: ReactFramework['canvasElement'] ) { const Story = unboundStoryFn as FC>; diff --git a/code/renderers/server/src/render.ts b/code/renderers/server/src/render.ts index 5db111f6b43..d636b63fc8f 100644 --- a/code/renderers/server/src/render.ts +++ b/code/renderers/server/src/render.ts @@ -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, - 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(); diff --git a/code/renderers/svelte/src/render.ts b/code/renderers/svelte/src/render.ts index 94033bcbec6..5265fd92e83 100644 --- a/code/renderers/svelte/src/render.ts +++ b/code/renderers/svelte/src/render.ts @@ -7,14 +7,13 @@ import type { SvelteFramework } from './types'; const componentsByDomElement = new Map(); -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, - domElement: SvelteFramework['canvasElement'] + canvasElement: SvelteFramework['canvasElement'] ) { const existingComponent = componentsByDomElement.get(domElement); diff --git a/code/renderers/vue/src/render.ts b/code/renderers/vue/src/render.ts index 26b23e99ab5..6eac74a27c8 100644 --- a/code/renderers/vue/src/render.ts +++ b/code/renderers/vue/src/render.ts @@ -20,7 +20,7 @@ type Instance = CombinedVueInstance< Record >; -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, - domElement: VueFramework['canvasElement'] + canvasElement: VueFramework['canvasElement'] ) { const root = getRoot(domElement); Vue.config.errorHandler = showException; diff --git a/code/renderers/vue3/src/render.ts b/code/renderers/vue3/src/render.ts index 0766ef975ea..84c8c013e72 100644 --- a/code/renderers/vue3/src/render.ts +++ b/code/renderers/vue3/src/render.ts @@ -24,7 +24,7 @@ const map = new Map> export function renderToCanvas( { title, name, storyFn, showMain, showError, showException }: Store_RenderContext, - domElement: VueFramework['canvasElement'] + canvasElement: VueFramework['canvasElement'] ) { // TODO: explain cyclical nature of these app => story => mount let element: StoryFnVueReturnType; diff --git a/code/renderers/web-components/src/render.ts b/code/renderers/web-components/src/render.ts index 2c3d67149e3..c7576ae85ea 100644 --- a/code/renderers/web-components/src/render.ts +++ b/code/renderers/web-components/src/render.ts @@ -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, - domElement: WebComponentsFramework['canvasElement'] + canvasElement: WebComponentsFramework['canvasElement'] ) { const element = storyFn();