@dxos/react-ui-syntax-highlighter 0.8.4-main.f9ba587 → 0.8.4-main.fcc0d83b33

package/src/SyntaxHighlighter/SyntaxHighlighter.tsx

@@ -2,48 +2,116 @@
 // Copyright 2024 DXOS.org
 //
 
-import React from 'react';
-import { type SyntaxHighlighterProps as NativeSyntaxHighlighterProps } from 'react-syntax-highlighter';
-// Using `light-async` version directly from dist to avoid any chance of the heavy one being loaded.
-// Lightweight version will load specific language parsers asynchronously.
-// eslint-disable-next-line no-restricted-imports
-import NativeSyntaxHighlighter from 'react-syntax-highlighter/dist/esm/light-async';
-// eslint-disable-next-line no-restricted-imports
-import { github as light, a11yDark as dark } from 'react-syntax-highlighter/dist/esm/styles/hljs';
-
-import { type ThemedClassName, useThemeContext } from '@dxos/react-ui';
-import { mx } from '@dxos/react-ui-theme';
+import React, { Children } from 'react';
+import { type SyntaxHighlighterProps as NaturalSyntaxHighlighterProps } from 'react-syntax-highlighter';
+import NativeSyntaxHighlighter from 'react-syntax-highlighter/dist/esm/prism-async-light';
+import { coldarkDark as dark, coldarkCold as light } from 'react-syntax-highlighter/dist/esm/styles/prism';
+
+import { Clipboard, useThemeContext } from '@dxos/react-ui';
+import { composable, composableProps } from '@dxos/ui-theme';
 
 const zeroWidthSpace = '\u200b';
 
-export type SyntaxHighlighterProps = ThemedClassName<
-  NativeSyntaxHighlighterProps & {
-    fallback?: string;
-  }
->;
+const languages = {
+  js: 'javascript',
+  ts: 'typescript',
+};
 
-light.hljs.background = '';
-dark.hljs.background = '';
+export type SyntaxHighlighterProps = Pick<
+  NaturalSyntaxHighlighterProps,
+  | 'language'
+  | 'renderer'
+  | 'showLineNumbers'
+  | 'showInlineLineNumbers'
+  | 'startingLineNumber'
+  | 'wrapLines'
+  | 'wrapLongLines'
+  | 'PreTag'
+> & {
+  themeStyle?: NaturalSyntaxHighlighterProps['style'];
+  fallback?: string;
+  copyButton?: boolean;
+};
 
 /**
+ * Inline, non-scrolling wrapper around `react-syntax-highlighter`.
+ *
+ * Use directly for small snippets (e.g. inside markdown code blocks).
+ * For scrollable panels, compose with `Syntax.Viewport`.
+ *
+ * NOTE: Using `light-async` version directly from dist to avoid any chance of the heavy one being loaded.
+ * The lightweight version will load specific language parsers asynchronously.
+ *
  * https://github.com/react-syntax-highlighter/react-syntax-highlighter
+ * https://react-syntax-highlighter.github.io/react-syntax-highlighter/demo/prism.html
  */
-export const SyntaxHighlighter = ({
-  classNames,
-  children,
-  fallback = zeroWidthSpace,
-  ...props
-}: SyntaxHighlighterProps) => {
-  const { themeMode } = useThemeContext();
-
-  return (
-    <NativeSyntaxHighlighter
-      className={mx('w-full p-0 font-thin overflow-auto scrollbar-thin !text-baseText', classNames)}
-      style={themeMode === 'dark' ? dark : light}
-      {...props}
-    >
-      {/* Non-empty fallback prevents collapse. */}
-      {children || fallback}
-    </NativeSyntaxHighlighter>
-  );
-};
+export const SyntaxHighlighter = composable<HTMLDivElement, SyntaxHighlighterProps>(
+  (
+    {
+      classNames,
+      className,
+      children,
+      role,
+      style,
+      themeStyle,
+      language = 'text',
+      fallback = zeroWidthSpace,
+      copyButton,
+      ...nativeProps
+    },
+    forwardedRef,
+  ) => {
+    const { themeMode } = useThemeContext();
+    const source = Children.toArray(children).join('') || fallback;
+
+    const hasCustomTheme = themeStyle && typeof themeStyle === 'object' && Object.keys(themeStyle).length > 0;
+    const prismTheme = hasCustomTheme ? themeStyle : themeMode === 'dark' ? dark : light;
+
+    return (
+      <div
+        {...composableProps(
+          { classNames, className, role, style },
+          {
+            role: 'none',
+            classNames: copyButton && 'relative group',
+          },
+        )}
+        ref={forwardedRef}
+      >
+        <NativeSyntaxHighlighter
+          language={languages[language as keyof typeof languages] || language}
+          style={prismTheme}
+          customStyle={{
+            background: 'unset',
+            border: 'none',
+            boxShadow: 'none',
+            padding: 0,
+            margin: 0,
+          }}
+          {...nativeProps}
+        >
+          {/* Non-empty fallback prevents collapse. */}
+          {source}
+        </NativeSyntaxHighlighter>
+
+        {copyButton && (
+          <div
+            role='none'
+            className='pointer-events-none absolute top-1 right-1 z-10 opacity-0 group-hover:opacity-100 focus-within:opacity-100'
+          >
+            <Clipboard.Provider>
+              <Clipboard.IconButton
+                value={source}
+                variant='ghost'
+                size={4}
+                classNames='pointer-events-auto aspect-square rounded-sm'
+              />
+            </Clipboard.Provider>
+          </div>
+        )}
+      </div>
+    );
+  },
+);
+
+SyntaxHighlighter.displayName = 'SyntaxHighlighter';

package/src/index.ts

@@ -2,5 +2,6 @@
 // Copyright 2024 DXOS.org
 //
 
-export * from './Json';
+export * from './JsonHighlighter';
+export * from './Syntax';
 export * from './SyntaxHighlighter';

package/dist/types/src/Json/Json.d.ts

@@ -1,9 +0,0 @@
-import React from 'react';
-import { type ThemedClassName } from '@dxos/react-ui';
-export type JsonProps = ThemedClassName<{
-    data?: any;
-    testId?: string;
-}>;
-export declare const Json: ({ data, classNames, testId }: JsonProps) => React.JSX.Element;
-export declare const JsonFilter: ({ data: initialData, classNames, testId }: JsonProps) => React.JSX.Element;
-//# sourceMappingURL=Json.d.ts.map

package/dist/types/src/Json/Json.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Json.d.ts","sourceRoot":"","sources":["../../../../src/Json/Json.tsx"],"names":[],"mappings":"AAMA,OAAO,KAA8B,MAAM,OAAO,CAAC;AAEnD,OAAO,EAAS,KAAK,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAK7D,MAAM,MAAM,SAAS,GAAG,eAAe,CAAC;IAAE,IAAI,CAAC,EAAE,GAAG,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAEzE,eAAO,MAAM,IAAI,GAAI,8BAA8B,SAAS,sBAM3D,CAAC;AAEF,eAAO,MAAM,UAAU,GAAI,2CAA2C,SAAS,sBAkC9E,CAAC"}

package/dist/types/src/Json/index.d.ts

@@ -1,2 +0,0 @@
-export * from './Json';
-//# sourceMappingURL=index.d.ts.map

package/dist/types/src/Json/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/Json/index.ts"],"names":[],"mappings":"AAIA,cAAc,QAAQ,CAAC"}

package/src/Json/Json.tsx

@@ -1,58 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-// TODO(burdon): Move to jsonpath-plus.
-import jp from 'jsonpath';
-import React, { useEffect, useState } from 'react';
-
-import { Input, type ThemedClassName } from '@dxos/react-ui';
-import { mx } from '@dxos/react-ui-theme';
-
-import { SyntaxHighlighter } from '../SyntaxHighlighter';
-
-export type JsonProps = ThemedClassName<{ data?: any; testId?: string }>;
-
-export const Json = ({ data, classNames, testId }: JsonProps) => {
-  return (
-    <SyntaxHighlighter language='json' classNames={['w-full', classNames]} data-testid={testId}>
-      {JSON.stringify(data, null, 2)}
-    </SyntaxHighlighter>
-  );
-};
-
-export const JsonFilter = ({ data: initialData, classNames, testId }: JsonProps) => {
-  const [data, setData] = useState(initialData);
-  const [text, setText] = useState('');
-  const [error, setError] = useState<Error | null>(null);
-  useEffect(() => {
-    if (!initialData || !text.trim().length) {
-      setData(initialData);
-    } else {
-      try {
-        setData(jp.query(initialData, text));
-        setError(null);
-      } catch (err) {
-        setData(initialData);
-        setError(err as Error);
-      }
-    }
-  }, [initialData, text]); // TODO(burdon): Need structural diff.
-
-  return (
-    <div className='flex flex-col grow overflow-hidden'>
-      <Input.Root validationValence={error ? 'error' : 'success'}>
-        <Input.TextInput
-          classNames={mx('p-1 px-2 font-mono', error && 'border-red-500')}
-          variant='subdued'
-          value={text}
-          onChange={(event) => setText(event.target.value)}
-          placeholder='JSONPath (e.g., $.graph.nodes)'
-        />
-      </Input.Root>
-      <SyntaxHighlighter language='json' classNames={mx('grow overflow-y-auto', classNames)} data-testid={testId}>
-        {JSON.stringify(data, null, 2)}
-      </SyntaxHighlighter>
-    </div>
-  );
-};