Files
SCM-Manager/scm-ui/ui-syntaxhighlighting/src/SyntaxHighlighter.stories.tsx
Matthias Thieroff a0737a2c90 Fix freezing browser if syntax highlighting large files (#2010)
We unified syntax highlighting and extracted it into a low level module. Syntax highlighting from now on takes place in a web worker, so that the user interface stays responsive. The web worker stops automatically if the number of nodes which should be highlighted exceeds the defined limit we believe the browser can handle.

Co-authored-by: Sebastian Sdorra <sebastian.sdorra@cloudogu.com>
Co-authored-by: Konstantin Schaper <konstantin.schaper@cloudogu.com>
2022-04-25 16:34:40 +02:00

226 lines
6.1 KiB
TypeScript

/*
* MIT License
*
* Copyright (c) 2020-present Cloudogu GmbH and Contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
import React, { FC, Fragment, useEffect, useState } from "react";
import SyntaxHighlighter, { Props } from "./SyntaxHighlighter";
import { ComponentMeta, ComponentStory } from "@storybook/react";
import HttpServerGo from "./__resources__/HttpServer.go";
import HttpServerJava from "./__resources__/HttpServer.java";
import HttpServerJs from "./__resources__/HttpServer.js";
import HttpServerPy from "./__resources__/HttpServer.py";
import HttpServerWithMarkerJs from "./__resources__/HttpServerWithMarker.js";
import LogbackXml from "./__resources__/Logback.xml";
import ReadmeMd from "./__resources__/Readme.md";
export default {
title: "SyntaxHighlighter",
component: SyntaxHighlighter,
argTypes: {
lineWrapper: {
table: {
disable: true,
},
},
markerConfig: {
table: {
disable: true,
},
},
renderer: {
table: {
disable: true,
},
},
},
} as ComponentMeta<typeof SyntaxHighlighter>;
const Template: ComponentStory<typeof SyntaxHighlighter> = (args: Props) => <SyntaxHighlighter {...args} />;
export const Go = Template.bind({});
Go.args = {
language: "go",
value: HttpServerGo,
};
export const Java = Template.bind({});
Java.args = {
language: "java",
value: HttpServerJava,
};
export const JavaScript = Template.bind({});
JavaScript.args = {
language: "javascript",
value: HttpServerJs,
};
export const Python = Template.bind({});
Python.args = {
language: "python",
value: HttpServerPy,
};
const LineWrapper: FC<{ lineNumber: number }> = ({ lineNumber, children }) => (
<div>
<span style={{ width: "2rem", display: "inline-block" }}>{lineNumber}</span>
{children}
</div>
);
export const LineNumbers = Template.bind({});
LineNumbers.args = {
language: "go",
value: HttpServerGo,
lineWrapper: LineWrapper,
};
export const LargeCss: ComponentStory<typeof SyntaxHighlighter> = () => {
const [isLoading, setIsLoading] = useState(false);
const [content, setContent] = useState<string>();
useEffect(() => {
setIsLoading(true);
fetch("/large.css")
.then((r) => r.text())
.then((text) => setContent(text))
.finally(() => setIsLoading(false));
}, []);
if (isLoading || !content) {
return <p>Loading ...</p>;
}
return <SyntaxHighlighter language="css" value={content} lineWrapper={LineWrapper} />;
};
export const HugeCss: ComponentStory<typeof SyntaxHighlighter> = () => {
const [isLoading, setIsLoading] = useState(false);
const [content, setContent] = useState<string>();
useEffect(() => {
setIsLoading(true);
fetch("/next.css")
.then((r) => r.text())
.then((text) => setContent(text))
.finally(() => setIsLoading(false));
}, []);
if (isLoading || !content) {
return <p>Loading ...</p>;
}
return <SyntaxHighlighter language="css" value={content} lineWrapper={LineWrapper} />;
};
const Mark: FC = ({ children }) => <mark>{children}</mark>;
const markerConfig = {
start: "<|[[--",
end: "--]]|>",
wrapper: Mark,
};
export const Marker = Template.bind({});
Marker.args = {
language: "javascript",
value: HttpServerWithMarkerJs,
markerConfig,
};
export const MarkerWithLineNumbers = Template.bind({});
MarkerWithLineNumbers.args = {
language: "javascript",
value: HttpServerWithMarkerJs,
lineWrapper: LineWrapper,
markerConfig,
};
export const MarkerWithLineNumbersAndLimit = Template.bind({});
MarkerWithLineNumbersAndLimit.args = {
language: "javascript",
value: HttpServerWithMarkerJs,
nodeLimit: 10,
lineWrapper: LineWrapper,
markerConfig: {
start: "<|[[--",
end: "--]]|>",
wrapper: Mark,
},
};
export const WithRenderer = Template.bind({});
WithRenderer.args = {
language: "javascript",
value: HttpServerJs,
renderer: ({ children }) => (
<table>
<tbody>
{children.map((child, i) => (
<tr key={i}>
<td style={{ border: "1px solid black" }}>{i + 1}</td>
<td style={{ border: "1px solid black" }}>{child}</td>
</tr>
))}
</tbody>
</table>
),
};
export const WithRendererWithLimit = Template.bind({});
WithRendererWithLimit.args = {
language: "javascript",
value: HttpServerJs,
nodeLimit: 10,
renderer: ({ children }) => (
<table style={{ border: 1 }}>
<tbody>
{children.map((child, i) => (
<tr key={i}>
<td style={{ border: "1px solid black" }}>{i + 1}</td>
<td style={{ border: "1px solid black" }}>{child}</td>
</tr>
))}
</tbody>
</table>
),
};
export const XmlAsMarkup = Template.bind({});
XmlAsMarkup.args = {
language: "xml",
value: LogbackXml,
};
export const RenderAsFragment: ComponentStory<typeof SyntaxHighlighter> = () => (
<>
<h2>This is rendered as fragment without code or pre tags</h2>
<SyntaxHighlighter value={HttpServerGo} language="go" as={Fragment} />
</>
);
export const MarkdownWithFrontmatter = Template.bind({});
MarkdownWithFrontmatter.args = {
language: "markdown",
value: ReadmeMd,
};