Add word wrap, line numbers, and language override to code blocks.

This commit is contained in:
2026-10-13 03:09:31 +11:00
parent 95d1cb9630
commit 2639982d5b
6 changed files with 335 additions and 21 deletions
+162 -21
View File
@@ -17,7 +17,21 @@ import {
} from 'html-react-parser';
import { MatrixClient } from 'matrix-js-sdk';
import classNames from 'classnames';
import { Box, Chip, config, Header, IconButton, Scroll, Text, toRem } from 'folds';
import {
Box,
Button,
Chip,
config,
Header,
IconButton,
Menu,
MenuItem,
PopOut,
RectCords,
Scroll,
Text,
toRem,
} from 'folds';
import { Icon, Icons } from '../components/icons';
import { IntermediateRepresentation, Opts as LinkifyOpts, OptFn } from 'linkifyjs';
import Linkify from 'linkify-react';
@@ -40,13 +54,22 @@ import {
parseMatrixToUser,
testMatrixTo,
} from './matrix-to';
import { onEnterOrSpace } from '../utils/keyboard';
import { onEnterOrSpace, stopPropagation } from '../utils/keyboard';
import { copyToClipboard, tryDecodeURIComponent } from '../utils/dom';
import { useTimeoutToggle } from '../hooks/useTimeoutToggle';
import { settingsAtom } from '../state/settings';
import { useSetting } from '../state/hooks/settings';
import FocusTrap from 'focus-trap-react';
import {
AUTO_LANGUAGE,
LANGUAGE_OPTIONS,
PLAIN_LANGUAGE,
} from './react-prism/languages';
import { AuthenticatedImg } from '../components/authenticated-media';
import { openExternalUrl } from '../utils/tauri';
const ReactPrism = lazy(() => import('./react-prism/ReactPrism'));
const PrismCode = lazy(() => import('./react-prism/PrismCode'));
/**
* Click handler for external links - uses Tauri shell on desktop/mobile
@@ -242,13 +265,7 @@ const extractTextFromChildren = (nodes: ChildNode[]): string => {
return text;
};
export function CodeBlock({
children,
opts,
}: {
children: ChildNode[];
opts: HTMLReactParserOptions;
}) {
export function CodeBlock({ children }: { children: ChildNode[] }) {
const code = children[0];
const languageClass =
code instanceof Element && code.name === 'code' ? code.attribs.class : undefined;
@@ -257,20 +274,48 @@ export function CodeBlock({
? languageClass.replace('language-', '')
: languageClass;
const text = useMemo(() => extractTextFromChildren(children).replace(/\n$/, ''), [children]);
const LINE_LIMIT = 14;
const largeCodeBlock = useMemo(
() => extractTextFromChildren(children).split('\n').length > LINE_LIMIT,
[children]
);
const largeCodeBlock = useMemo(() => text.split('\n').length > LINE_LIMIT, [text]);
const [expanded, setExpand] = useState(false);
const [copied, setCopied] = useTimeoutToggle();
// Word wrap and line numbers are remembered as preferences, but can be toggled per code block
const [wrapSetting, setWrapSetting] = useSetting(settingsAtom, 'codeWordWrap');
const [lineNumbersSetting, setLineNumbersSetting] = useSetting(settingsAtom, 'codeLineNumbers');
const [wrap, setWrap] = useState(wrapSetting);
const [lineNumbers, setLineNumbers] = useState(lineNumbersSetting);
// Language override for this block (empty means use the language the message declared)
const [override, setOverride] = useState(AUTO_LANGUAGE);
const [menuCords, setMenuCords] = useState<RectCords>();
const activeLanguage =
override === AUTO_LANGUAGE ? language : override === PLAIN_LANGUAGE ? undefined : override;
const languageLabel =
override === AUTO_LANGUAGE
? language ?? 'Code'
: (LANGUAGE_OPTIONS.find((option) => option.value === override)?.label ?? override);
const handleCopy = () => {
copyToClipboard(extractTextFromChildren(children));
copyToClipboard(text);
setCopied();
};
const toggleWrap = () => {
const next = !wrap;
setWrap(next);
setWrapSetting(next);
};
const toggleLineNumbers = () => {
const next = !lineNumbers;
setLineNumbers(next);
setLineNumbersSetting(next);
};
const toggleExpand = () => {
setExpand(!expanded);
};
@@ -279,11 +324,51 @@ export function CodeBlock({
<Text size="T300" as="pre" className={css.CodeBlock}>
<Header variant="Surface" size="400" className={css.CodeBlockHeader}>
<Box grow="Yes">
<Text size="L400" truncate>
{language ?? 'Code'}
</Text>
<Button
variant="Surface"
fill="None"
size="300"
radii="300"
type="button"
aria-haspopup="true"
aria-expanded={!!menuCords}
title="Override language"
after={<Icon size="100" src={Icons.ChevronBottom} />}
onClick={(event) => {
event.stopPropagation();
setMenuCords(event.currentTarget.getBoundingClientRect());
}}
>
<Text size="B300" truncate>
{languageLabel}
</Text>
</Button>
</Box>
<Box shrink="No" gap="200">
<Chip
variant={wrap ? 'Primary' : 'Surface'}
fill="None"
radii="Pill"
outlined
aria-pressed={wrap}
title="Toggle word wrap"
onClick={toggleWrap}
before={<Icon size="50" src={Icons.WrapText} />}
>
<Text size="B300">Wrap</Text>
</Chip>
<Chip
variant={lineNumbers ? 'Primary' : 'Surface'}
fill="None"
radii="Pill"
outlined
aria-pressed={lineNumbers}
title="Toggle line numbers"
onClick={toggleLineNumbers}
before={<Icon size="50" src={Icons.OrderList} />}
>
<Text size="B300">Lines</Text>
</Chip>
<Chip
variant={copied ? 'Success' : 'Surface'}
fill="None"
@@ -315,19 +400,75 @@ export function CodeBlock({
)}
</Box>
</Header>
<PopOut
anchor={menuCords}
offset={5}
position="Bottom"
align="Start"
content={
<FocusTrap
focusTrapOptions={{
initialFocus: false,
onDeactivate: () => setMenuCords(undefined),
clickOutsideDeactivates: true,
isKeyForward: (evt: KeyboardEvent) =>
evt.key === 'ArrowDown' || evt.key === 'ArrowRight',
isKeyBackward: (evt: KeyboardEvent) =>
evt.key === 'ArrowUp' || evt.key === 'ArrowLeft',
escapeDeactivates: stopPropagation,
}}
>
<Scroll
style={{ maxHeight: toRem(320) }}
direction="Vertical"
variant="Surface"
size="300"
visibility="Hover"
hideTrack
>
<Menu>
{LANGUAGE_OPTIONS.map((option) => (
<MenuItem
key={option.value || 'auto'}
size="300"
variant={option.value === override ? 'SurfaceVariant' : 'Surface'}
aria-selected={option.value === override}
radii="300"
onClick={() => {
setMenuCords(undefined);
setOverride(option.value);
}}
>
<Box grow="Yes">
<Text size="T300">{option.label}</Text>
</Box>
</MenuItem>
))}
</Menu>
</Scroll>
</FocusTrap>
}
/>
<Scroll
style={{
maxHeight: largeCodeBlock && !expanded ? toRem(300) : undefined,
paddingBottom: largeCodeBlock ? config.space.S400 : undefined,
}}
direction="Both"
direction={wrap ? 'Vertical' : 'Both'}
variant="SurfaceVariant"
size="300"
visibility="Hover"
hideTrack
>
<div id="code-block-content" className={css.CodeBlockInternal}>
{domToReact(children, opts)}
<div
id="code-block-content"
className={wrap ? css.CodeBlockInternalWrapped : css.CodeBlockInternal}
>
<ErrorBoundary fallback={<code className={css.CodeBlockContent}>{text}</code>}>
<Suspense fallback={<code className={css.CodeBlockContent}>{text}</code>}>
<PrismCode text={text} language={activeLanguage} showLineNumbers={lineNumbers} />
</Suspense>
</ErrorBoundary>
</div>
</Scroll>
{largeCodeBlock && !expanded && <Box className={css.CodeBlockBottomShadow} />}
@@ -444,7 +585,7 @@ export const getReactCustomHtmlParser = (
}
if (name === 'pre') {
return <CodeBlock opts={opts}>{children}</CodeBlock>;
return <CodeBlock>{children}</CodeBlock>;
}
if (name === 'blockquote') {
+86
View File
@@ -0,0 +1,86 @@
import classNames from 'classnames';
import Prism from 'prismjs';
import * as css from '../../styles/CustomHtml.css';
// Side-effect import: registers every prism language grammar and the token colors
// used by the classes below (`token <type>` inside a `code` element).
import './ReactPrism';
export type PrismSegment = {
type?: string;
text: string;
};
export type PrismLine = PrismSegment[];
/**
* Tokenizes `text` with the prism grammar of `language` and splits the result into
* lines. Tokens spanning multiple lines (block comments, multiline strings) are split
* so every line keeps the token type of its segments, which keeps the colors correct
* when lines are rendered one row at a time.
*/
export function tokenizeToLines(text: string, language?: string): PrismLine[] {
const grammar = language ? Prism.languages[language] : undefined;
if (!grammar) return text.split('\n').map((line) => [{ text: line }]);
const lines: PrismLine[] = [[]];
const append = (type: string | undefined, value: string) => {
const parts = value.split('\n');
parts.forEach((part, index) => {
if (index > 0) lines.push([]);
if (part) lines[lines.length - 1].push({ type, text: part });
});
};
const walk = (stream: Prism.TokenStream, type?: string) => {
if (typeof stream === 'string') {
append(type, stream);
return;
}
if (Array.isArray(stream)) {
stream.forEach((child) => walk(child, type));
return;
}
walk(stream.content, stream.type);
};
Prism.tokenize(text, grammar).forEach((token) => walk(token));
return lines;
}
export default function PrismCode({
text,
language,
showLineNumbers,
}: {
text: string;
language?: string;
showLineNumbers: boolean;
}) {
const lines = tokenizeToLines(text, language);
return (
<code className={classNames(css.CodeBlockContent, language)}>
{lines.map((line, lineIndex) => (
<span key={`line-${lineIndex}`} className={css.CodeBlockLine}>
{showLineNumbers && <span className={css.CodeBlockLineNumber}>{lineIndex + 1}</span>}
<span className={css.CodeBlockLineContent}>
{line.map((segment, segmentIndex) =>
segment.type ? (
<span key={`token-${segmentIndex}`} className={`token ${segment.type}`}>
{segment.text}
</span>
) : (
segment.text
),
)}
</span>
</span>
))}
</code>
);
}
+43
View File
@@ -0,0 +1,43 @@
// Languages offered by the code block language override menu.
// Every entry is registered by the prism component imports in ReactPrism.tsx.
export type LanguageOption = {
value: string;
label: string;
};
// Empty value means "use the language the message declared"
export const AUTO_LANGUAGE = '';
export const PLAIN_LANGUAGE = 'plain';
export const LANGUAGE_OPTIONS: LanguageOption[] = [
{ value: AUTO_LANGUAGE, label: 'Auto' },
{ value: PLAIN_LANGUAGE, label: 'Plain text' },
{ value: 'bash', label: 'Bash' },
{ value: 'c', label: 'C' },
{ value: 'cpp', label: 'C++' },
{ value: 'csharp', label: 'C#' },
{ value: 'css', label: 'CSS' },
{ value: 'diff', label: 'Diff' },
{ value: 'docker', label: 'Docker' },
{ value: 'go', label: 'Go' },
{ value: 'graphql', label: 'GraphQL' },
{ value: 'html', label: 'HTML' },
{ value: 'ini', label: 'INI' },
{ value: 'java', label: 'Java' },
{ value: 'javascript', label: 'JavaScript' },
{ value: 'json', label: 'JSON' },
{ value: 'jsx', label: 'JSX' },
{ value: 'kotlin', label: 'Kotlin' },
{ value: 'lua', label: 'Lua' },
{ value: 'markdown', label: 'Markdown' },
{ value: 'properties', label: 'Properties' },
{ value: 'python', label: 'Python' },
{ value: 'rust', label: 'Rust' },
{ value: 'sass', label: 'Sass' },
{ value: 'sql', label: 'SQL' },
{ value: 'toml', label: 'TOML' },
{ value: 'tsx', label: 'TSX' },
{ value: 'typescript', label: 'TypeScript' },
{ value: 'xml', label: 'XML' },
{ value: 'yaml', label: 'YAML' },
];