GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-04 20:51:07 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #19489 from storybookjs/deprecate/onBeforeRender

Browse Source 
remove onBeforeRender
This commit is contained in:
Norbert de Langen 2022-10-14 20:57:43 +03:00 committed by GitHub
commit 33c6f25f8a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
code/renderers/react/src/docs/jsxDecorator.test.tsx
View File

@ -229,22 +229,6 @@ describe('jsxDecorator', () => {
expect(mockChannel.emit).not.toHaveBeenCalled();
});
// This is deprecated, but still test it
it('allows the snippet output to be modified by onBeforeRender', async () => {
const storyFn = (args: any) => <div>args story</div>;
const onBeforeRender = (dom: string) => `<p>${dom}</p>`;
const jsx = { onBeforeRender };
const context = makeContext('args', { __isArgsStory: true, jsx }, {});
jsxDecorator(storyFn, context);
await new Promise((r) => setTimeout(r, 0));
expect(mockChannel.emit).toHaveBeenCalledWith(
SNIPPET_RENDERED,
'jsx-test--args',
'<p><div>\n args story\n</div></p>'
);
});
it('allows the snippet output to be modified by transformSource', async () => {
const storyFn = (args: any) => <div>args story</div>;
const transformSource = (dom: string) => `<p>${dom}</p>`;

26
code/renderers/react/src/docs/jsxDecorator.tsx
View File

@ -1,8 +1,6 @@
/* eslint-disable no-underscore-dangle */
import React, { createElement, ReactElement } from 'react';
import reactElementToJSXString, { Options } from 'react-element-to-jsx-string';
import { dedent } from 'ts-dedent';
import deprecate from 'util-deprecate';
import { addons, useEffect } from '@storybook/addons';
import { StoryContext, ArgsStoryFn, PartialStoryFn } from '@storybook/csf';
@ -22,30 +20,10 @@ type JSXOptions = Options & {
enableBeautify?: boolean;
/** Override the display name used for a component */
displayName?: string | Options['displayName'];
/** Deprecated: A function ran after the story is rendered */
onBeforeRender?(dom: string): string;
/** A function ran after a story is rendered (prefer this over `onBeforeRender`) */
/** A function ran after a story is rendered */
transformSource?(dom: string, context?: StoryContext<ReactFramework>): string;
};
/** Run the user supplied onBeforeRender function if it exists */
const applyBeforeRender = (domString: string, options: JSXOptions) => {
if (typeof options.onBeforeRender !== 'function') {
return domString;
}
const deprecatedOnBeforeRender = deprecate(
options.onBeforeRender,
dedent`
StoryFn.parameters.jsx.onBeforeRender was deprecated.
Prefer StoryFn.parameters.jsx.transformSource instead.
See https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#deprecated-onbeforerender for details.
`
);
return deprecatedOnBeforeRender(domString);
};
/** Run the user supplied transformSource function if it exists */
const applyTransformSource = (
domString: string,
@ -127,7 +105,7 @@ export const renderJsx = (code: React.ReactElement, options: JSXOptions) => {
? reactElementToJSXString
: // @ts-expect-error (Converted from ts-ignore)
reactElementToJSXString.default;
let string = applyBeforeRender(toJSXString(child, opts as Options), options);
let string: string = toJSXString(child, opts as Options);
if (string.indexOf('&quot;') > -1) {
const matches = string.match(/\S+=\\"([^"]*)\\"/g);