@dxos/plugin-presenter 0.8.4-main.72ec0f3 → 0.8.4-main.74a063c4e0

package/src/components/Markdown/Slide.stories.tsx

@@ -4,16 +4,16 @@
 
 import { type Meta, type StoryObj } from '@storybook/react-vite';
 
-import { withTheme } from '@dxos/react-ui/testing';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
 
-import { createSlide } from '../../testing';
+import { createSlide } from '#testing';
 
 import { Slide } from './Slide';
 
 const meta = {
-  title: 'plugins/plugin-presenter/Slide',
+  title: 'plugins/plugin-presenter/components/Slide',
   component: Slide,
-  decorators: [withTheme],
+  decorators: [withTheme(), withLayout({ layout: 'fullscreen' })],
   parameters: {
     layout: 'fullscreen',
   },

package/src/components/Markdown/Slide.tsx

@@ -2,6 +2,8 @@
 // Copyright 2023 DXOS.org
 //
 
+import 'highlight.js/styles/github.css';
+
 import { h } from 'hastscript';
 import React from 'react';
 import ReactMarkdown, { type Options as ReactMarkdownOptions } from 'react-markdown';
@@ -10,8 +12,6 @@ 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';
 

package/src/components/Markdown/index.ts

@@ -2,5 +2,5 @@
 // Copyright 2022 DXOS.org
 //
 
-export * from './Container';
+export * from './Panel';
 export * from './Slide';

package/src/components/Markdown/theme.ts

@@ -5,14 +5,14 @@
 // TODO(burdon): Create theme type and picker.
 
 export const theme = {
-  root: 'bg-attention leading-relaxed font-mono',
+  root: 'bg-attention-surface leading-relaxed font-mono',
 
-  padding: 'pli-40 plb-16 gap-8',
+  padding: 'px-40 py-16 gap-8',
 
   nodes: {
-    h1: 'text-[80px] text-accentText',
-    h2: 'text-[60px] text-accentText',
-    h3: 'text-[48px] text-accentText',
+    h1: 'text-[80px] text-accent-text',
+    h2: 'text-[60px] text-accent-text',
+    h3: 'text-[48px] text-accent-text',
 
     p: 'text-[48px]',
 
@@ -20,7 +20,7 @@ export const theme = {
     ol: 'my-[16px] ml-24 leading-relaxed list-decimal',
     li: 'pl-6 text-[48px]',
 
-    pre: 'is-full mx-0 my-[32px] p-0 __border-l-[16px] bg-inputSurface p-4 __whitespace-pre-line',
+    pre: 'w-full mx-0 my-[32px] p-4 bg-input-surface',
     code: 'p-0 text-[40px]',
   },
 };

package/src/components/Presenter/Layout.tsx

@@ -4,30 +4,31 @@
 
 import React, { type PropsWithChildren, type ReactNode } from 'react';
 
-import { type ThemedClassName } from '@dxos/react-ui';
-import { mx } from '@dxos/react-ui-theme';
+import { composable, composableProps } from '@dxos/ui-theme';
 
-export type LayoutProps = ThemedClassName<
-  PropsWithChildren<{
-    className?: string;
-    topLeft?: ReactNode;
-    topRight?: ReactNode;
-    bottomLeft?: ReactNode;
-    bottomRight?: ReactNode;
-  }>
->;
+export type LayoutProps = PropsWithChildren<{
+  topLeft?: ReactNode;
+  topRight?: ReactNode;
+  bottomLeft?: ReactNode;
+  bottomRight?: ReactNode;
+}>;
 
-export const Layout = ({ children, classNames, topLeft, topRight, bottomLeft, bottomRight }: LayoutProps) => {
-  return (
-    <div className={mx('flex grow relative overflow-hidden bg-attention', classNames)}>
-      <div className={mx('flex flex-col grow overflow-hidden')}>{children}</div>
+export const Layout = composable<HTMLDivElement, LayoutProps>(
+  ({ children, topLeft, topRight, bottomLeft, bottomRight, ...props }, forwardedRef) => {
+    return (
+      <div
+        {...composableProps(props, { classNames: 'flex grow relative overflow-hidden bg-attention-surface' })}
+        ref={forwardedRef}
+      >
+        <div className='flex flex-col grow overflow-hidden'>{children}</div>
 
-      <div className='z-[200]'>
-        <div className='absolute top-4 left-4'>{topLeft}</div>
-        <div className='absolute top-4 right-4'>{topRight}</div>
-        <div className='absolute bottom-4 left-4'>{bottomLeft}</div>
-        <div className='absolute bottom-4 right-4'>{bottomRight}</div>
+        <div className='z-[200]'>
+          <div className='absolute top-4 left-4'>{topLeft}</div>
+          <div className='absolute top-4 right-4'>{topRight}</div>
+          <div className='absolute bottom-4 left-4'>{bottomLeft}</div>
+          <div className='absolute bottom-4 right-4'>{bottomRight}</div>
+        </div>
       </div>
-    </div>
-  );
-};
+    );
+  },
+);

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

@@ -23,9 +23,9 @@ const DefaultStory = ({ count = 20 }: PagerProps) => {
 };
 
 const meta = {
-  title: 'plugins/plugin-presenter/Pager',
+  title: 'plugins/plugin-presenter/components/Pager',
   render: DefaultStory,
-  decorators: [withTheme],
+  decorators: [withTheme()],
   parameters: {
     layout: 'centered',
   },

package/src/components/Presenter/Pager.tsx

@@ -14,8 +14,8 @@ export type PagerProps = {
   onExit?: () => void;
 };
 
-export const Pager = ({ index: indexParam = 0, count = 0, keys, onChange, onExit }: PagerProps) => {
-  const [index, setIndex] = useControlledState(indexParam);
+export const Pager = ({ index: indexProp = 0, count = 0, keys, onChange, onExit }: PagerProps) => {
+  const [index, setIndex] = useControlledState(indexProp);
   useEffect(() => {
     onChange?.(index);
   }, [index]);

package/src/components/PresenterSettings/PresenterSettings.stories.tsx

@@ -0,0 +1,31 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+
+import { translations } from '../../translations';
+import { PresenterSettings } from './PresenterSettings';
+
+const meta = {
+  title: 'plugins/plugin-presenter/components/PresenterSettings',
+  component: PresenterSettings,
+  decorators: [withTheme(), withLayout({ layout: 'fullscreen' })],
+  tags: ['settings'],
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+} satisfies Meta<typeof PresenterSettings>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  args: {
+    settings: { presentCollections: true },
+  },
+};

package/src/components/PresenterSettings/PresenterSettings.tsx

@@ -0,0 +1,32 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import React from 'react';
+
+import { type AppSurface } from '@dxos/app-toolkit/ui';
+import { Input, useTranslation } from '@dxos/react-ui';
+import { Settings as SettingsForm } from '@dxos/react-ui-form';
+
+import { meta } from '#meta';
+import { type Settings } from '#types';
+
+export type PresenterSettingsProps = AppSurface.SettingsArticleProps<Settings.Settings>;
+
+export const PresenterSettings = ({ settings, onSettingsChange }: PresenterSettingsProps) => {
+  const { t } = useTranslation(meta.id);
+
+  return (
+    <SettingsForm.Viewport>
+      <SettingsForm.Section title={t('settings.title', { ns: meta.id })}>
+        <SettingsForm.Item title={t('present-collections.label')} description={t('present-collections.description')}>
+          <Input.Switch
+            disabled={!onSettingsChange}
+            checked={settings.presentCollections}
+            onCheckedChange={(checked) => onSettingsChange?.((s) => ({ ...s, presentCollections: !!checked }))}
+          />
+        </SettingsForm.Item>
+      </SettingsForm.Section>
+    </SettingsForm.Viewport>
+  );
+};

package/src/components/PresenterSettings/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export { PresenterSettings as default } from './PresenterSettings';

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

@@ -4,11 +4,10 @@
 
 import { type Meta } from '@storybook/react-vite';
 
-import { withTheme } from '@dxos/react-ui/testing';
+import { withLayout, 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
@@ -20,9 +19,9 @@ import { RevealPlayer } from './RevealPlayer';
 // https://fonts.google.com
 
 const meta = {
-  title: 'plugins/plugin-presenter/RevealPlayer',
+  title: 'plugins/plugin-presenter/components/RevealPlayer',
   component: RevealPlayer,
-  decorators: [withTheme],
+  decorators: [withTheme(), withLayout({ layout: 'fullscreen' })],
   parameters: {
     layout: 'fullscreen',
     translations,

package/src/components/RevealPlayer/RevealPlayer.tsx

@@ -3,9 +3,7 @@
 //
 
 import 'reveal.js/dist/reveal.css';
-
 import 'reveal.js/dist/theme/black.css';
-
 // https://github.com/highlightjs/highlight.js/tree/main/src/styles
 // import 'highlight.js/styles/github-dark.css';
 import 'highlight.js/styles/tokyo-night-dark.css';
@@ -17,8 +15,8 @@ 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, useAsyncEffect } from '@dxos/react-ui';
-import { mx } from '@dxos/react-ui-theme';
+import { useAsyncEffect } from '@dxos/react-ui';
+import { composable, composableProps } from '@dxos/ui-theme';
 
 const styles = `
 <style type="text/css">
@@ -61,115 +59,119 @@ const styles = `
 </style>
 `;
 
-export type RevealProps = ThemedClassName<{
+export type RevealProps = {
   content: string;
   slide?: number;
   fullscreen?: boolean;
   onExit?: () => void;
-}>;
-
-export const RevealPlayer = ({ classNames, content, slide, fullscreen = true, onExit }: RevealProps) => {
-  const deckDivRef = useRef<HTMLDivElement>(null);
-  const deckRef = useRef<Reveal.Api | null>(null);
-
-  useAsyncEffect(async () => {
-    if (deckRef.current) {
-      return;
-    }
-
-    // Required for syntax highlighting.
-    hljs.registerLanguage('typescript', typescript);
-
-    // 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;
+export const RevealPlayer = composable<HTMLDivElement, RevealProps>(
+  ({ content, slide, fullscreen = true, onExit, children, ...props }, forwardedRef) => {
+    const deckDivRef = useRef<HTMLDivElement>(null);
+    const deckRef = useRef<Reveal.Api | null>(null);
+
+    useAsyncEffect(async () => {
+      if (deckRef.current) {
+        return;
+      }
+
+      // Required for syntax highlighting.
+      hljs.registerLanguage('typescript', typescript);
+
+      // 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,
+
+        // Disable autoplay to prevent errors in headless environments (e.g., CI).
+        autoPlayMedia: false,
+
+        // 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 {
-        if (deckRef.current) {
-          deckRef.current.destroy();
-          deckRef.current = null;
+      return () => {
+        try {
+          if (deckRef.current) {
+            deckRef.current.destroy();
+            deckRef.current = null;
+          }
+        } catch {
+          // Ignore.
         }
-      } catch {
-        // Ignore.
-      }
-    };
-  });
-
-  // TOOD(burdon): Trap cursor keys (otherwise tabster grabs focus.)
-  return (
-    <div
-      className={mx(
-        'grid place-items-center is-full bs-full overflow-hidden bg-black',
-        fullscreen && 'absolute inset-0',
-        classNames,
-      )}
-    >
-      <div className='relative aspect-video is-full bs-full bs-auto max-bs-full overflow-hidden'>
-        <div ref={deckDivRef} className='absolute inset-0 reveal'>
-          {/* NOTE: Must be in head. */}
-          <style>
-            <link rel='preconnect' href='https://fonts.googleapis.com' />
-            <link rel='preconnect' href='https://fonts.gstatic.com' {...{ crossOrigin: '' }} />
-            <link
-              rel='stylesheet'
-              href='https://fonts.googleapis.com/css2?family=Raleway:ital,wght@0,100..900;1,100..900&display=swap'
-            />
-          </style>
-          <div className='slides'>
-            <div className='!text-center' />
-            <section {...{ 'data-markdown': [] }}>
-              <textarea {...{ 'data-template': true }} defaultValue={[styles, content].join('\n')}></textarea>
-            </section>
+      };
+    });
+
+    // TOOD(burdon): Trap cursor keys (otherwise tabster grabs focus.)
+    return (
+      <div
+        {...composableProps(props, {
+          classNames: ['dx-container grid place-items-center bg-black', fullscreen && 'absolute inset-0'],
+        })}
+        ref={forwardedRef}
+      >
+        <div role='none' className='relative aspect-video h-full w-full h-auto max-h-full overflow-hidden'>
+          <div ref={deckDivRef} className='absolute inset-0 reveal'>
+            {/* NOTE: Must be in head. */}
+            <style>
+              <link rel='preconnect' href='https://fonts.googleapis.com' />
+              <link rel='preconnect' href='https://fonts.gstatic.com' {...{ crossOrigin: '' }} />
+              <link
+                rel='stylesheet'
+                href='https://fonts.googleapis.com/css2?family=Raleway:ital,wght@0,100..900;1,100..900&display=swap'
+              />
+            </style>
+            <div className='slides'>
+              <div className='text-center!' />
+              <section {...{ 'data-markdown': [] }}>
+                <textarea {...{ 'data-template': true }} defaultValue={[styles, content].join('\n')}></textarea>
+              </section>
+            </div>
           </div>
         </div>
       </div>
-    </div>
-  );
-};
+    );
+  },
+);

package/src/components/index.ts

@@ -2,10 +2,10 @@
 // Copyright 2023 DXOS.org
 //
 
-import { lazy } from 'react';
+import { type ComponentType, lazy } from 'react';
 
-export * from './PresenterSettings';
+export * from './Markdown';
+export * from './Presenter';
+export * from './RevealPlayer';
 
-export const MarkdownSlide = lazy(() => import('./MarkdownSlide'));
-export const DocumentPresenterContainer = lazy(() => import('./DocumentPresenterContainer'));
-export const CollectionPresenterContainer = lazy(() => import('./CollectionPresenterContainer'));
+export const PresenterSettings: ComponentType<any> = lazy(() => import('./PresenterSettings'));

package/src/containers/CollectionPresenterContainer/CollectionPresenterContainer.tsx

@@ -0,0 +1,44 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import React, { useContext, useState } from 'react';
+
+import { Surface } from '@dxos/app-framework/ui';
+import { type AppSurface } from '@dxos/app-toolkit/ui';
+import { type Collection } from '@dxos/echo';
+import { Panel } from '@dxos/react-ui';
+
+import { PageNumber, Pager, Layout as PresenterLayout } from '#components';
+import { PresenterContext } from '#types';
+
+import { useExitPresenter } from '../../useExitPresenter';
+
+export type CollectionPresenterContainerProps = AppSurface.ObjectArticleProps<Collection.Collection>;
+
+export const CollectionPresenterContainer = ({ role, subject: collection }: CollectionPresenterContainerProps) => {
+  const [slide, setSlide] = useState(0);
+  const { running } = useContext(PresenterContext);
+  const handleExit = useExitPresenter(collection);
+
+  return (
+    <Panel.Root role={role} classNames='relative'>
+      <Panel.Content asChild>
+        <PresenterLayout
+          bottomRight={<PageNumber index={slide} count={collection.objects.length} />}
+          bottomLeft={
+            <Pager
+              index={slide}
+              count={collection.objects.length}
+              keys={running}
+              onChange={setSlide}
+              onExit={handleExit}
+            />
+          }
+        >
+          <Surface.Surface role='slide' data={{ subject: collection.objects[slide] }} />
+        </PresenterLayout>
+      </Panel.Content>
+    </Panel.Root>
+  );
+};

package/src/containers/CollectionPresenterContainer/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export { CollectionPresenterContainer as default } from './CollectionPresenterContainer';

package/src/containers/DocumentPresenterContainer/DocumentPresenterContainer.tsx

@@ -0,0 +1,24 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import React, { type FC } from 'react';
+
+import { type Markdown } from '@dxos/plugin-markdown/types';
+import { Panel } from '@dxos/react-ui';
+
+import { RevealPlayer } from '#components';
+
+import { useExitPresenter } from '../../useExitPresenter';
+
+export const DocumentPresenterContainer: FC<{ document: Markdown.Document }> = ({ document }) => {
+  const handleExit = useExitPresenter(document);
+
+  return (
+    <Panel.Root classNames='relative'>
+      <Panel.Content asChild>
+        <RevealPlayer content={document.content.target?.content ?? ''} onExit={handleExit} />
+      </Panel.Content>
+    </Panel.Root>
+  );
+};

package/src/containers/DocumentPresenterContainer/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export { DocumentPresenterContainer as default } from './DocumentPresenterContainer';

package/src/{components → containers/MarkdownSlide}/MarkdownSlide.tsx

@@ -2,23 +2,25 @@
 // Copyright 2023 DXOS.org
 //
 
-import React, { type FC } from 'react';
+import React from 'react';
 
 import { type Markdown } from '@dxos/plugin-markdown/types';
 
-import { Container, Slide } from './Markdown';
+import { Panel, Slide } from '#components';
 
-const MarkdownSlide: FC<{ document: Markdown.Document }> = ({ document }) => {
+type MarkdownSlideProps = {
+  document: Markdown.Document;
+};
+
+export const MarkdownSlide = ({ document }: MarkdownSlideProps) => {
   const content = document.content.target?.content;
   if (!content) {
     return null;
   }
 
   return (
-    <Container>
+    <Panel>
       <Slide content={content} />
-    </Container>
+    </Panel>
   );
 };
-
-export default MarkdownSlide;

package/src/containers/MarkdownSlide/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export { MarkdownSlide as default } from './MarkdownSlide';

package/src/containers/index.ts

@@ -0,0 +1,9 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type ComponentType, lazy } from 'react';
+
+export const CollectionPresenterContainer: ComponentType<any> = lazy(() => import('./CollectionPresenterContainer'));
+export const DocumentPresenterContainer: ComponentType<any> = lazy(() => import('./DocumentPresenterContainer'));
+export const MarkdownSlide: ComponentType<any> = lazy(() => import('./MarkdownSlide'));

package/src/meta.ts

@@ -2,11 +2,11 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type PluginMeta } from '@dxos/app-framework';
+import { type Plugin } from '@dxos/app-framework';
 import { trim } from '@dxos/util';
 
-export const meta: PluginMeta = {
-  id: 'dxos.org/plugin/presenter',
+export const meta: Plugin.Meta = {
+  id: 'org.dxos.plugin.presenter',
   name: 'Presenter',
   description: trim`
     Transform markdown documents into interactive presentation slideshows.