@dxos/plugin-presenter 0.8.4-main.c1de068 → 0.8.4-main.c4373fc

package/src/components/Markdown/Slide.tsx

@@ -4,19 +4,20 @@
 
 import { h } from 'hastscript';
 import React from 'react';
-import ReactMarkdown from 'react-markdown';
-import addClasses from 'rehype-add-classes';
-import highlight from 'rehype-highlight';
+import ReactMarkdown, { type Options as ReactMarkdownOptions } from 'react-markdown';
+import rehypeAddClasses from 'rehype-add-classes';
+import rehypeHighlight from 'rehype-highlight';
 import remarkFrontmatter from 'remark-frontmatter';
 import remarkParseFrontmatter from 'remark-parse-frontmatter';
 
 import 'highlight.js/styles/github.css';
 
+import styles from './styles.css?raw';
 import { theme } from './theme';
 
 export type SlideProps = {
   content?: string;
-  classes?: { [selector: string]: string };
+  classes?: Record<string, string>;
 };
 
 export const Slide = ({ content = '', classes = theme.nodes }: SlideProps) => {
@@ -24,132 +25,13 @@ export const Slide = ({ content = '', classes = theme.nodes }: SlideProps) => {
   //  configurable. Find a way to remove the literal stylesheet here.
   return (
     <>
-      <style>{`
-.dark pre code.hljs {
-  display: block;
-  overflow-x: auto;
-  padding: 1em
-}
-.dark code.hljs {
-  padding: 3px 5px
-}
-/*!
-  Theme: GitHub Dark
-  Description: Dark theme as seen on github.com
-  Author: github.com
-  Maintainer: @Hirse
-  Updated: 2021-05-15
-
-  Outdated base version: https://github.com/primer/github-syntax-dark
-  Current colors taken from GitHub's CSS
-*/
-.dark .hljs {
-  color: #c9d1d9;
-  background: #0d1117
-}
-.dark .hljs-doctag,
-.dark .hljs-keyword,
-.dark .hljs-meta .hljs-keyword,
-.dark .hljs-template-tag,
-.dark .hljs-template-variable,
-.dark .hljs-type,
-.dark .hljs-variable.language_ {
-  /* prettylights-syntax-keyword */
-  color: #ff7b72
-}
-.dark .hljs-title,
-.dark .hljs-title.class_,
-.dark .hljs-title.class_.inherited__,
-.dark .hljs-title.function_ {
-  /* prettylights-syntax-entity */
-  color: #d2a8ff
-}
-.dark .hljs-attr,
-.dark .hljs-attribute,
-.dark .hljs-literal,
-.dark .hljs-meta,
-.dark .hljs-number,
-.dark .hljs-operator,
-.dark .hljs-variable,
-.dark .hljs-selector-attr,
-.dark .hljs-selector-class,
-.dark .hljs-selector-id {
-  /* prettylights-syntax-constant */
-  color: #79c0ff
-}
-.dark .hljs-regexp,
-.dark .hljs-string,
-.dark .hljs-meta .hljs-string {
-  /* prettylights-syntax-string */
-  color: #a5d6ff
-}
-.dark .hljs-built_in,
-.dark .hljs-symbol {
-  /* prettylights-syntax-variable */
-  color: #ffa657
-}
-.dark .hljs-comment,
-.dark .hljs-code,
-.dark .hljs-formula {
-  /* prettylights-syntax-comment */
-  color: #8b949e
-}
-.dark .hljs-name,
-.dark .hljs-quote,
-.dark .hljs-selector-tag,
-.dark .hljs-selector-pseudo {
-  /* prettylights-syntax-entity-tag */
-  color: #7ee787
-}
-.dark .hljs-subst {
-  /* prettylights-syntax-storage-modifier-import */
-  color: #c9d1d9
-}
-.dark .hljs-section {
-  /* prettylights-syntax-markup-heading */
-  color: #1f6feb;
-  font-weight: bold
-}
-.dark .hljs-bullet {
-  /* prettylights-syntax-markup-list */
-  color: #f2cc60
-}
-.dark .hljs-emphasis {
-  /* prettylights-syntax-markup-italic */
-  color: #c9d1d9;
-  font-style: italic
-}
-.dark .hljs-strong {
-  /* prettylights-syntax-markup-bold */
-  color: #c9d1d9;
-  font-weight: bold
-}
-.dark .hljs-addition {
-  /* prettylights-syntax-markup-inserted */
-  color: #aff5b4;
-  background-color: #033a16
-}
-.dark .hljs-deletion {
-  /* prettylights-syntax-markup-deleted */
-  color: #ffdcd7;
-  background-color: #67060c
-}
-.dark .hljs-char.escape_,
-.dark .hljs-link,
-.dark .hljs-params,
-.dark .hljs-property,
-.dark .hljs-punctuation,
-.dark .hljs-tag {
-  /* purposely ignored */
-  
-}
-      `}</style>
+      <style>{styles}</style>
       <ReactMarkdown
         components={components}
         // Markdown to HTML.
         remarkPlugins={[[remarkFrontmatter, 'yaml'], remarkParseFrontmatter as any]}
         // HTML processing.
-        rehypePlugins={[highlight, [addClasses, classes], slideLayout]}
+        rehypePlugins={[[rehypeAddClasses, classes], rehypeHighlight as any, slideLayout]}
       >
         {content}
       </ReactMarkdown>
@@ -164,7 +46,7 @@ export const Slide = ({ content = '', classes = theme.nodes }: SlideProps) => {
  *  E.g., layout image from front-matter.
  */
 const slideLayout =
-  (options = {}) =>
+  (_options = {}) =>
   (tree: any, file: any) => {
     const {
       data: { frontmatter = {} },
@@ -210,9 +92,11 @@ const slideLayout =
     tree.children = [root];
   };
 
-const ImageWrapper = ({ node, ...props }: { node: any }) => {
+const ImageWrapper = ({ node: _, ...props }: { node: any }) => {
   const { alt = '', src } = props as { alt: string; src: string };
   return <img alt={alt} src={src} />;
 };
 
-const components = { img: ImageWrapper };
+const components: ReactMarkdownOptions['components'] = {
+  img: ({ node, ...props }) => <ImageWrapper node={node} {...props} />,
+};

package/src/components/Markdown/styles.css

@@ -0,0 +1,104 @@
+/*!
+  Theme: GitHub Dark
+  Description: Dark theme as seen on github.com
+  Author: github.com
+  Maintainer: @Hirse
+  Updated: 2021-05-15
+  Outdated base version: https://github.com/primer/github-syntax-dark
+  Current colors taken from GitHub's CSS
+*/
+/* TODO(burdon): Use tokens. */
+.dark pre code.hljs {
+  display: block;
+  overflow-x: auto;
+  padding: 1em;
+}
+.dark code.hljs {
+  padding: 3px 5px;
+}
+.dark .hljs {
+  color: #c9d1d9;
+  background: #0d1117;
+}
+.dark .hljs-doctag,
+.dark .hljs-keyword,
+.dark .hljs-meta .hljs-keyword,
+.dark .hljs-template-tag,
+.dark .hljs-template-variable,
+.dark .hljs-type,
+.dark .hljs-variable.language_ {
+  color: #ff7b72;
+}
+.dark .hljs-title,
+.dark .hljs-title.class_,
+.dark .hljs-title.class_.inherited__,
+.dark .hljs-title.function_ {
+  color: #d2a8ff;
+}
+.dark .hljs-attr,
+.dark .hljs-attribute,
+.dark .hljs-literal,
+.dark .hljs-meta,
+.dark .hljs-number,
+.dark .hljs-operator,
+.dark .hljs-variable,
+.dark .hljs-selector-attr,
+.dark .hljs-selector-class,
+.dark .hljs-selector-id {
+  color: #79c0ff;
+}
+.dark .hljs-regexp,
+.dark .hljs-string,
+.dark .hljs-meta .hljs-string {
+  color: #a5d6ff;
+}
+.dark .hljs-built_in,
+.dark .hljs-symbol {
+  color: #ffa657;
+}
+.dark .hljs-comment,
+.dark .hljs-code,
+.dark .hljs-formula {
+  color: #8b949e;
+}
+.dark .hljs-name,
+.dark .hljs-quote,
+.dark .hljs-selector-tag,
+.dark .hljs-selector-pseudo {
+  color: #7ee787;
+}
+.dark .hljs-subst {
+  color: #c9d1d9;
+}
+.dark .hljs-section {
+  color: #1f6feb;
+  font-weight: bold;
+}
+.dark .hljs-bullet {
+  color: #f2cc60;
+}
+.dark .hljs-emphasis {
+  color: #c9d1d9;
+  font-style: italic;
+}
+.dark .hljs-strong {
+  color: #c9d1d9;
+  font-weight: bold;
+}
+.dark .hljs-addition {
+  color: #aff5b4;
+  background-color: #033a16;
+}
+.dark .hljs-deletion {
+  color: #ffdcd7;
+  background-color: #67060c;
+}
+.dark .hljs-char.escape_,
+.dark .hljs-link,
+.dark .hljs-params,
+.dark .hljs-property,
+.dark .hljs-punctuation,
+.dark .hljs-tag {
+  /* purposely ignored */
+  all: unset;
+}

package/src/components/Markdown/typings.d.ts

@@ -0,0 +1,8 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+declare module '*.css?raw' {
+  const content: string;
+  export default content;
+}

package/src/components/MarkdownSlide.tsx

@@ -4,11 +4,11 @@
 
 import React, { type FC } from 'react';
 
-import { type DocumentType } from '@dxos/plugin-markdown/types';
+import { type Markdown } from '@dxos/plugin-markdown/types';
 
 import { Container, Slide } from './Markdown';
 
-const MarkdownSlide: FC<{ document: DocumentType }> = ({ document }) => {
+const MarkdownSlide: FC<{ document: Markdown.Document }> = ({ document }) => {
   const content = document.content.target?.content;
   if (!content) {
     return null;

package/src/components/Presenter/Pager.stories.tsx

@@ -2,12 +2,10 @@
 // Copyright 2023 DXOS.org
 //
 
-import '@dxos-theme';
-
-import { type Meta } from '@storybook/react-vite';
+import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React, { useState } from 'react';
 
-import { withTheme } from '@dxos/storybook-utils';
+import { withTheme } from '@dxos/react-ui/testing';
 
 import { PageNumber, Pager, type PagerProps, StartButton } from './Pager';
 
@@ -24,15 +22,17 @@ const DefaultStory = ({ count = 20 }: PagerProps) => {
   );
 };
 
-export const Default = {};
-
-const meta: Meta<PagerProps> = {
+const meta = {
   title: 'plugins/plugin-presenter/Pager',
   render: DefaultStory,
   decorators: [withTheme],
   parameters: {
     layout: 'centered',
   },
-};
+} satisfies Meta<typeof DefaultStory>;
 
 export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {};

package/src/components/Presenter/Pager.tsx

@@ -4,7 +4,7 @@
 
 import React, { useEffect } from 'react';
 
-import { Button, useControlledState, Icon } from '@dxos/react-ui';
+import { Button, Icon, useControlledState } from '@dxos/react-ui';
 
 export type PagerProps = {
   index?: number;
@@ -14,8 +14,8 @@ export type PagerProps = {
   onExit?: () => void;
 };
 
-export const Pager = ({ index: controlledIndex = 0, count = 0, keys, onChange, onExit }: PagerProps) => {
-  const [index, setIndex] = useControlledState(controlledIndex);
+export const Pager = ({ index: indexParam = 0, count = 0, keys, onChange, onExit }: PagerProps) => {
+  const [index, setIndex] = useControlledState(indexParam);
   useEffect(() => {
     onChange?.(index);
   }, [index]);

package/src/components/PresenterSettings.tsx

@@ -5,22 +5,26 @@
 import React from 'react';
 
 import { Input, useTranslation } from '@dxos/react-ui';
-import { DeprecatedFormContainer, DeprecatedFormInput } from '@dxos/react-ui-form';
+import { ControlGroup, ControlItemInput, ControlPage, ControlSection } from '@dxos/react-ui-form';
 
-import { PRESENTER_PLUGIN } from '../meta';
+import { meta } from '../meta';
 import { type PresenterSettingsProps } from '../types';
 
 export const PresenterSettings = ({ settings }: { settings: PresenterSettingsProps }) => {
-  const { t } = useTranslation(PRESENTER_PLUGIN);
+  const { t } = useTranslation(meta.id);
 
   return (
-    <DeprecatedFormContainer>
-      <DeprecatedFormInput label={t('present collections label')}>
-        <Input.Switch
-          checked={settings.presentCollections}
-          onCheckedChange={(checked) => (settings.presentCollections = !!checked)}
-        />
-      </DeprecatedFormInput>
-    </DeprecatedFormContainer>
+    <ControlPage>
+      <ControlSection title={t('settings title', { ns: meta.id })}>
+        <ControlGroup>
+          <ControlItemInput title={t('present collections label')}>
+            <Input.Switch
+              checked={settings.presentCollections}
+              onCheckedChange={(checked) => (settings.presentCollections = !!checked)}
+            />
+          </ControlItemInput>
+        </ControlGroup>
+      </ControlSection>
+    </ControlPage>
   );
 };

package/src/components/RevealPlayer/RevealPlayer.stories.tsx

@@ -2,14 +2,15 @@
 // Copyright 2023 DXOS.org
 //
 
-import '@dxos-theme';
-
 import { type Meta } from '@storybook/react-vite';
 
-import { RevealPlayer } from './RevealPlayer';
+import { withTheme } from '@dxos/react-ui/testing';
+
 import CONTENT from '../../../testing/deck.md?raw';
 import { translations } from '../../translations';
 
+import { RevealPlayer } from './RevealPlayer';
+
 // https://revealjs.com/markdown
 // https://developer.mozilla.org/en-US/docs/Web/CSS/background-position
 // https://colorhunt.co/palettes/dark
@@ -18,14 +19,15 @@ import { translations } from '../../translations';
 // https://fontsource.org/fonts
 // https://fonts.google.com
 
-const meta: Meta<typeof RevealPlayer> = {
+const meta = {
   title: 'plugins/plugin-presenter/RevealPlayer',
   component: RevealPlayer,
+  decorators: [withTheme],
   parameters: {
     layout: 'fullscreen',
     translations,
   },
-};
+} satisfies Meta<typeof RevealPlayer>;
 
 export default meta;
 

package/src/components/RevealPlayer/RevealPlayer.tsx

@@ -2,9 +2,8 @@
 // Copyright 2024 DXOS.org
 //
 
-// eslint-disable-next-line no-restricted-imports
 import 'reveal.js/dist/reveal.css';
-// eslint-disable-next-line no-restricted-imports
+
 import 'reveal.js/dist/theme/black.css';
 
 // https://github.com/highlightjs/highlight.js/tree/main/src/styles
@@ -13,12 +12,12 @@ import 'highlight.js/styles/tokyo-night-dark.css';
 
 import hljs from 'highlight.js';
 import typescript from 'highlight.js/lib/languages/typescript';
-import React, { useEffect, useRef } from 'react';
+import React, { useRef } from 'react';
 import Reveal from 'reveal.js';
 import RevealHighlight from 'reveal.js/plugin/highlight/highlight';
 import RevealMarkdown from 'reveal.js/plugin/markdown/plugin.js';
 
-import { type ThemedClassName } from '@dxos/react-ui';
+import { type ThemedClassName, useAsyncEffect } from '@dxos/react-ui';
 import { mx } from '@dxos/react-ui-theme';
 
 const styles = `
@@ -72,7 +71,8 @@ export type RevealProps = ThemedClassName<{
 export const RevealPlayer = ({ classNames, content, slide, fullscreen = true, onExit }: RevealProps) => {
   const deckDivRef = useRef<HTMLDivElement>(null);
   const deckRef = useRef<Reveal.Api | null>(null);
-  useEffect(() => {
+
+  useAsyncEffect(async () => {
     if (deckRef.current) {
       return;
     }
@@ -80,66 +80,63 @@ export const RevealPlayer = ({ classNames, content, slide, fullscreen = true, on
     // Required for syntax highlighting.
     hljs.registerLanguage('typescript', typescript);
 
-    const t = setTimeout(async () => {
-      // https://revealjs.com/react
-      // https://revealjs.com/config
-      // https://github.com/hakimel/reveal.js
-      // TODO(burdon): Fragments and scroll view steps 2 at a time (safe mode?)
-      deckRef.current = new Reveal(deckDivRef.current!, {
-        // view: 'scroll',
-        progress: false,
-        transition: 'none',
-        slideNumber: false,
-        embedded: true,
-
-        // TODO(burdon): Speaker view requires server to serve popout window.
-        // https://revealjs.com/speaker-view
-        showNotes: false,
-
-        // width: 1600,
-        // height: 900,
-        margin: 0.1,
-        // center: false,
-        // minScale: 0.1,
-        // maxScale: 1.4,
-
-        // https://revealjs.com/markdown
-        // TODO(burdon): Requires server to serve popout window.
-        plugins: [RevealMarkdown, RevealHighlight],
-
-        // See https://marked.js.org/using_advanced#options
-        markdown: {
-          gfm: true,
-          smartypants: true,
-          highlight: (code, language) => {
-            if (language) {
-              return hljs.highlight(code, { language }).value;
-            }
-
-            return hljs.highlightAuto(code).value;
-          },
+    // https://revealjs.com/react
+    // https://revealjs.com/config
+    // https://github.com/hakimel/reveal.js
+    // TODO(burdon): Fragments and scroll view steps 2 at a time (safe mode?)
+    deckRef.current = new Reveal(deckDivRef.current!, {
+      // view: 'scroll',
+      progress: false,
+      transition: 'none',
+      slideNumber: false,
+      embedded: true,
+
+      // TODO(burdon): Speaker view requires server to serve popout window.
+      // https://revealjs.com/speaker-view
+      showNotes: false,
+
+      // width: 1600,
+      // height: 900,
+      margin: 0.1,
+      // center: false,
+      // minScale: 0.1,
+      // maxScale: 1.4,
+
+      // https://revealjs.com/markdown
+      // TODO(burdon): Requires server to serve popout window.
+      plugins: [RevealMarkdown, RevealHighlight],
+
+      // See https://marked.js.org/using_advanced#options
+      markdown: {
+        gfm: true,
+        smartypants: true,
+        highlight: (code, language) => {
+          if (language) {
+            return hljs.highlight(code, { language }).value;
+          }
+
+          return hljs.highlightAuto(code).value;
         },
-      });
+      },
+    });
 
-      await deckRef.current.initialize();
+    await deckRef.current.initialize();
 
-      if (slide !== undefined) {
-        deckRef.current.slide(slide < 0 ? deckRef.current?.getTotalSlides() + slide : slide - 1);
-      }
+    if (slide !== undefined) {
+      deckRef.current.slide(slide < 0 ? deckRef.current?.getTotalSlides() + slide : slide - 1);
+    }
 
-      deckRef.current.addKeyBinding({ keyCode: 27, key: 'Escape', description: 'Exit full screen' }, () => {
-        onExit?.();
-      });
+    deckRef.current.addKeyBinding({ keyCode: 27, key: 'Escape', description: 'Exit full screen' }, () => {
+      onExit?.();
     });
 
     return () => {
       try {
-        clearTimeout(t);
         if (deckRef.current) {
           deckRef.current.destroy();
           deckRef.current = null;
         }
-      } catch (err) {
+      } catch {
         // Ignore.
       }
     };

package/src/meta.ts

@@ -4,10 +4,8 @@
 
 import { type PluginMeta } from '@dxos/app-framework';
 
-export const PRESENTER_PLUGIN = 'dxos.org/plugin/presenter';
-
 export const meta: PluginMeta = {
-  id: PRESENTER_PLUGIN,
+  id: 'dxos.org/plugin/presenter',
   name: 'Presenter',
   description: 'Present documents as slideshows.',
   icon: 'ph--presentation--regular',

package/src/translations.ts

@@ -11,6 +11,7 @@ export const translations = [
     'en-US': {
       [meta.id]: {
         'plugin name': 'Presenter',
+        'settings title': 'Presenter settings',
         'toggle presentation label': 'Present',
         'present collections label': 'Present collections (experimental)',
       },

package/src/types.ts

@@ -2,22 +2,22 @@
 // Copyright 2023 DXOS.org
 //
 
-import { Schema } from 'effect';
+import * as Schema from 'effect/Schema';
 import { type Context, createContext } from 'react';
 
-import { DocumentType } from '@dxos/plugin-markdown/types';
+import { Markdown } from '@dxos/plugin-markdown/types';
 import { DataType } from '@dxos/schema';
 
-import { PRESENTER_PLUGIN } from './meta';
+import { meta } from './meta';
 
 export namespace PresenterAction {
-  const PRESENTER_ACTION = `${PRESENTER_PLUGIN}/action`;
+  const PRESENTER_ACTION = `${meta.id}/action`;
 
   export class TogglePresentation extends Schema.TaggedClass<TogglePresentation>()(
     `${PRESENTER_ACTION}/toggle-presentation`,
     {
       input: Schema.Struct({
-        object: Schema.Union(DocumentType, DataType.Collection),
+        object: Schema.Union(Markdown.Document, DataType.Collection),
         state: Schema.optional(Schema.Boolean),
       }),
       output: Schema.Void,

package/src/useExitPresenter.ts

@@ -4,7 +4,7 @@
 
 import { useCallback } from 'react';
 
-import { createIntent, LayoutAction, useCapability, useIntentDispatcher } from '@dxos/app-framework';
+import { LayoutAction, createIntent, useCapability, useIntentDispatcher } from '@dxos/app-framework';
 import { type Live } from '@dxos/live-object';
 import { DeckCapabilities } from '@dxos/plugin-deck';
 import { DeckAction } from '@dxos/plugin-deck/types';