@dxos/react-ui-thread 0.8.3 → 0.8.4-main.1da679c

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/react-ui-thread",
-  "version": "0.8.3",
+  "version": "0.8.4-main.1da679c",
   "description": "A set of components to use with threads, including comments and messages.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -10,6 +10,7 @@
   "type": "module",
   "exports": {
     ".": {
+      "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs"
     }
@@ -26,32 +27,30 @@
     "@preact-signals/safe-react": "^0.9.0",
     "@radix-ui/react-primitive": "2.0.2",
     "date-fns": "^3.3.1",
-    "@dxos/react-ui-editor": "0.8.3",
-    "@dxos/util": "0.8.3"
+    "@dxos/react-ui-editor": "0.8.4-main.1da679c",
+    "@dxos/util": "0.8.4-main.1da679c"
   },
   "devDependencies": {
-    "@phosphor-icons/react": "^2.1.5",
     "@types/react": "~18.2.0",
     "@types/react-dom": "~18.2.0",
     "react": "~18.2.0",
     "react-dom": "~18.2.0",
-    "vite": "5.4.7",
-    "@dxos/echo-schema": "0.8.3",
-    "@dxos/live-object": "0.8.3",
-    "@dxos/echo-db": "0.8.3",
-    "@dxos/log": "0.8.3",
-    "@dxos/random": "0.8.3",
-    "@dxos/keys": "0.8.3",
-    "@dxos/react-ui": "0.8.3",
-    "@dxos/react-ui-theme": "0.8.3",
-    "@dxos/storybook-utils": "0.8.3"
+    "vite": "7.1.1",
+    "@dxos/echo-db": "0.8.4-main.1da679c",
+    "@dxos/echo-schema": "0.8.4-main.1da679c",
+    "@dxos/keys": "0.8.4-main.1da679c",
+    "@dxos/live-object": "0.8.4-main.1da679c",
+    "@dxos/random": "0.8.4-main.1da679c",
+    "@dxos/react-ui-theme": "0.8.4-main.1da679c",
+    "@dxos/storybook-utils": "0.8.4-main.1da679c",
+    "@dxos/react-ui": "0.8.4-main.1da679c",
+    "@dxos/log": "0.8.4-main.1da679c"
   },
   "peerDependencies": {
-    "@phosphor-icons/react": "^2.1.5",
     "react": "~18.2.0",
     "react-dom": "~18.2.0",
-    "@dxos/react-ui": "0.8.3",
-    "@dxos/react-ui-theme": "0.8.3"
+    "@dxos/react-ui": "0.8.4-main.1da679c",
+    "@dxos/react-ui-theme": "0.8.4-main.1da679c"
   },
   "publishConfig": {
     "access": "public"

package/src/Message/Message.stories.tsx

@@ -4,16 +4,18 @@
 
 import '@dxos-theme';
 
+import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React, { useState } from 'react';
 
 import { PublicKey } from '@dxos/keys';
 import { hoverableControls, hoverableFocusedWithinControls } from '@dxos/react-ui-theme';
 import { withLayout, withTheme } from '@dxos/storybook-utils';
 
+import { type MessageEntity, MessageStoryText } from '../testing';
+import { Thread } from '../Thread';
+import { translations } from '../translations';
+
 import { MessageRoot } from './Message';
-import { threadLayout } from '../Thread';
-import { ThreadStoryContainer, MessageStoryText, type MessageEntity } from '../testing';
-import translations from '../translations';
 
 const DefaultStory = () => {
   const [identityKey] = useState(PublicKey.random());
@@ -25,22 +27,26 @@ const DefaultStory = () => {
   });
 
   return (
-    <ThreadStoryContainer>
-      <div className={threadLayout}>
+    <div className='mli-auto is-96 overflow-y-auto'>
+      <Thread.Root id='t1'>
         <MessageRoot {...message} classNames={[hoverableControls, hoverableFocusedWithinControls]}>
           <MessageStoryText {...message} onDelete={() => console.log('delete')} />
         </MessageRoot>
-      </div>
-    </ThreadStoryContainer>
+      </Thread.Root>
+    </div>
   );
 };
 
-export default {
+const meta = {
   title: 'ui/react-ui-thread/Message',
-  component: MessageRoot,
+  component: MessageRoot as any,
   render: DefaultStory,
   decorators: [withTheme, withLayout({ fullscreen: true })],
   parameters: { translations },
-};
+} satisfies Meta<typeof DefaultStory>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
 
-export const Default = {};
+export const Default: Story = {};

package/src/Message/Message.tsx

@@ -3,7 +3,7 @@
 //
 
 import { formatDistanceToNow } from 'date-fns/formatDistanceToNow';
-import React, { type ComponentPropsWithRef, forwardRef, type ComponentPropsWithoutRef } from 'react';
+import React, { type ComponentPropsWithRef, type ComponentPropsWithoutRef, forwardRef } from 'react';
 
 // TODO(burdon): Remove dep.
 import { Avatar, type ThemedClassName, useTranslation } from '@dxos/react-ui';
@@ -20,6 +20,7 @@ export type MessageRootProps = ThemedClassName<ComponentPropsWithRef<'div'>> &
   MessageMetadata &
   Partial<{ continues: boolean }>;
 
+// TODO(burdon): Show authorName on tooltip.
 export const MessageRoot = forwardRef<HTMLDivElement, MessageRootProps>(
   (
     { authorImgSrc, authorId, authorName, authorAvatarProps, continues = true, children, classNames, ...rootProps },
@@ -35,7 +36,7 @@ export const MessageRoot = forwardRef<HTMLDivElement, MessageRootProps>(
           className={mx('grid grid-cols-subgrid col-span-2', classNames)}
           ref={forwardedRef}
         >
-          <div role='none' className='flex flex-col items-center gap-2 pbs-2'>
+          <div role='none' className='flex flex-col items-center gap-2 pbs-1'>
             <Avatar.Content
               size={avatarSize}
               hue={authorAvatarProps?.hue || hexToHue(authorId ?? '0')}

package/src/Thread/Comments.stories.tsx

@@ -4,7 +4,7 @@
 
 import '@dxos-theme';
 
-import { Check, Trash } from '@phosphor-icons/react';
+import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React, { type FC, useEffect, useMemo, useRef, useState } from 'react';
 
 import { createDocAccessor, createObject } from '@dxos/echo-db';
@@ -13,7 +13,7 @@ import { PublicKey } from '@dxos/keys';
 import { live } from '@dxos/live-object';
 import { log } from '@dxos/log';
 import { faker } from '@dxos/random';
-import { Button, useThemeContext } from '@dxos/react-ui';
+import { Button, Icon, useThemeContext } from '@dxos/react-ui';
 import {
   type Comment,
   type CommentsOptions,
@@ -30,10 +30,11 @@ import {
 import { hoverableControls, hoverableFocusedWithinControls } from '@dxos/react-ui-theme';
 import { withTheme } from '@dxos/storybook-utils';
 
-import { Thread, ThreadFooter, ThreadHeading } from './Thread';
 import { MessageBody, MessageHeading, MessageRoot, MessageTextbox } from '../Message';
 import { type MessageEntity } from '../testing';
-import translations from '../translations';
+import { translations } from '../translations';
+
+import { Thread } from './Thread';
 
 faker.seed(101);
 
@@ -157,17 +158,17 @@ const StoryThread: FC<{
   };
 
   return (
-    <Thread current={selected} onClickCapture={onSelect}>
+    <Thread.Root current={selected} onClickCapture={onSelect}>
       <div className='col-start-2 flex gap-1 text-xs text-description'>
         <span>id:{thread.id.slice(0, 4)}</span>
         <span>y:{thread.yPos}</span>
         <span className='grow' />
-        {!thread.cursor && <Trash />}
+        {!thread.cursor && <Icon icon='ph--trash--regular' />}
       </div>
 
-      <ThreadHeading>
+      <Thread.Header>
         {thread.range?.from} &ndash; {thread.range?.to}
-      </ThreadHeading>
+      </Thread.Header>
 
       {thread.messages.map((message) => (
         <MessageRoot key={message.id} classNames={[hoverableControls, hoverableFocusedWithinControls]} {...message}>
@@ -185,12 +186,12 @@ const StoryThread: FC<{
           onEditorFocus={onSelect}
           onSend={handleCreateMessage}
         />
-        <ThreadFooter />
+        <Thread.Status />
         <Button variant='ghost' classNames='px-1' title='Resolve' onClick={onResolve}>
-          <Check />
+          <Icon icon='ph--check--regular' />
         </Button>
       </div>
-    </Thread>
+    </Thread.Root>
   );
 };
 
@@ -232,7 +233,7 @@ type StoryProps = {
   autoCreate?: boolean;
 };
 
-const Story = ({ text, autoCreate }: StoryProps) => {
+const DefaultStory = ({ text, autoCreate }: StoryProps) => {
   const [item] = useState(createObject(live(Expando, { content: text ?? '' })));
   const [threads, setThreads] = useState<StoryCommentThread[]>([]);
   const [selected, setSelected] = useState<string>();
@@ -349,25 +350,27 @@ const Story = ({ text, autoCreate }: StoryProps) => {
   );
 };
 
-export default {
+const meta = {
   title: 'ui/react-ui-thread/Comments',
-  component: StoryThread,
+  component: StoryThread as any,
+  render: DefaultStory,
   decorators: [withTheme],
-  render: (args: StoryProps) => <Story {...args} />,
   parameters: { translations, layout: 'fullscreen' },
-};
+} satisfies Meta<typeof DefaultStory>;
 
-const str = (...lines: string[]) => lines.join('\n');
+export default meta;
 
-const document = str(
-  '# Comments',
-  '',
-  str(...faker.helpers.multiple(() => [faker.lorem.paragraph({ min: 5, max: 10 }), ''], { count: 20 }).flat()),
-  '',
-);
+type Story = StoryObj<typeof meta>;
+
+const str = (...lines: string[]) => lines.join('\n');
 
-export const Default = {
+export const Default: Story = {
   args: {
-    text: document,
+    text: str(
+      '# Comments',
+      '',
+      str(...faker.helpers.multiple(() => [faker.lorem.paragraph({ min: 5, max: 10 }), ''], { count: 20 }).flat()),
+      '',
+    ),
   },
 };

package/src/Thread/Thread.stories.tsx

@@ -4,6 +4,7 @@
 
 import '@dxos-theme';
 
+import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React, { useMemo, useRef, useState } from 'react';
 
 import { PublicKey } from '@dxos/keys';
@@ -12,10 +13,11 @@ import { createBasicExtensions, createThemeExtensions } from '@dxos/react-ui-edi
 import { hoverableControls, hoverableFocusedWithinControls } from '@dxos/react-ui-theme';
 import { withLayout, withTheme } from '@dxos/storybook-utils';
 
-import { Thread, ThreadFooter } from './Thread';
 import { MessageRoot, MessageTextbox } from '../Message';
-import { ThreadStoryContainer, MessageStoryText, type MessageEntity } from '../testing';
-import translations from '../translations';
+import { type MessageEntity, MessageStoryText } from '../testing';
+import { translations } from '../translations';
+
+import { Thread } from './Thread';
 
 faker.seed(1);
 
@@ -59,13 +61,14 @@ const DefaultStory = () => {
   };
 
   return (
-    <ThreadStoryContainer>
-      <Thread id='t1'>
+    <div className='mli-auto is-96 overflow-y-auto'>
+      <Thread.Root id='t1'>
         {messages.map((message) => (
           <MessageRoot key={message.id} classNames={[hoverableControls, hoverableFocusedWithinControls]} {...message}>
             <MessageStoryText {...message} text={message.text} onDelete={() => console.log('delete')} />
           </MessageRoot>
         ))}
+
         <MessageTextbox
           id={String(_count)}
           authorId={identityKey1.toHex()}
@@ -73,18 +76,23 @@ const DefaultStory = () => {
           extensions={extensions}
           onSend={handleSend}
         />
-        <ThreadFooter activity>Processing...</ThreadFooter>
-      </Thread>
-    </ThreadStoryContainer>
+
+        <Thread.Status activity>Processing...</Thread.Status>
+      </Thread.Root>
+    </div>
   );
 };
 
-export default {
+const meta = {
   title: 'ui/react-ui-thread/Thread',
-  component: Thread,
+  component: Thread.Root,
   render: DefaultStory,
   decorators: [withTheme, withLayout({ fullscreen: true })],
   parameters: { translations },
-};
+} satisfies Meta<typeof Thread.Root>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
 
-export const Default = {};
+export const Default: Story = {};

package/src/Thread/Thread.tsx

@@ -2,20 +2,24 @@
 // Copyright 2023 DXOS.org
 //
 
-import { CaretDoubleRight, Spinner } from '@phosphor-icons/react';
 import React, { type ComponentPropsWithRef, forwardRef } from 'react';
 
-import { type ThemedClassName, useTranslation } from '@dxos/react-ui';
+import { Icon, type ThemedClassName, useTranslation } from '@dxos/react-ui';
 import { hoverableControlItem, hoverableFocusedWithinControls, mx } from '@dxos/react-ui-theme';
 
 import { translationKey } from '../translations';
 import type { ThreadEntity } from '../types';
 
-export type ThreadProps = ThemedClassName<ComponentPropsWithRef<'div'>> & ThreadEntity & { current?: boolean };
-
+// TODO(burdon): Why is this exported?
 export const threadLayout = 'is-full place-self-start grid grid-cols-[var(--rail-size)_1fr]';
 
-export const Thread = forwardRef<HTMLDivElement, ThreadProps>(
+//
+// Root
+//
+
+type ThreadRootProps = ThemedClassName<ComponentPropsWithRef<'div'>> & ThreadEntity & { current?: boolean };
+
+const ThreadRoot = forwardRef<HTMLDivElement, ThreadRootProps>(
   ({ current, children, classNames, ...props }, forwardedRef) => {
     return (
       <div
@@ -26,8 +30,7 @@ export const Thread = forwardRef<HTMLDivElement, ThreadProps>(
         className={mx(
           threadLayout,
           hoverableFocusedWithinControls,
-          'pbs-2 pbe-4 bg-[var(--surface-bg)] border-separator first:border-bs-0 border-be',
-          'current-related attention-surface [--controls-opacity:0]',
+          'bg-[var(--surface-bg)] current-related attention-surface [--controls-opacity:0]',
           classNames,
         )}
         ref={forwardedRef}
@@ -38,14 +41,18 @@ export const Thread = forwardRef<HTMLDivElement, ThreadProps>(
   },
 );
 
-export type ThreadHeadingProps = ThemedClassName<ComponentPropsWithRef<'div'>> & { detached?: boolean };
+//
+// Heading
+//
+
+type ThreadHeaderProps = ThemedClassName<ComponentPropsWithRef<'div'>> & { detached?: boolean };
 
-export const ThreadHeading = forwardRef<HTMLParagraphElement, ThreadHeadingProps>(
+const ThreadHeader = forwardRef<HTMLParagraphElement, ThreadHeaderProps>(
   ({ classNames, children, detached, ...props }, forwardedRef) => {
     return (
       <>
         <div role='none' className='flex items-center justify-center text-description'>
-          <CaretDoubleRight />
+          <Icon icon='ph--caret-double-right--regular' />
         </div>
         <div role='none' className='flex items-center overflow-hidden'>
           <p
@@ -66,11 +73,15 @@ export const ThreadHeading = forwardRef<HTMLParagraphElement, ThreadHeadingProps
   },
 );
 
-export type ThreadFooterProps = ThemedClassName<ComponentPropsWithRef<'div'>> & {
+//
+// Status
+//
+
+type ThreadStatusProps = ThemedClassName<ComponentPropsWithRef<'div'>> & {
   activity?: boolean;
 };
 
-export const ThreadFooter = forwardRef<HTMLDivElement, ThreadFooterProps>(
+const ThreadStatus = forwardRef<HTMLDivElement, ThreadStatusProps>(
   ({ activity, classNames, children, ...props }, forwardedRef) => {
     const { t } = useTranslation(translationKey);
     return (
@@ -82,10 +93,10 @@ export const ThreadFooter = forwardRef<HTMLDivElement, ThreadFooterProps>(
         )}
         ref={forwardedRef}
       >
-        <Spinner
-          weight='bold'
+        <Icon
+          icon='ph--spinner--bold'
+          classNames='is-6 bs-4 invisible data-[visible=show]:visible animate-spin-slow'
           data-visible={activity ? 'show' : 'hide'}
-          className='is-6 bs-4 invisible data-[visible=show]:visible animate-spin-slow'
         />
         <span className='truncate min-is-0' aria-live='polite'>
           {activity ? children : null}
@@ -95,3 +106,11 @@ export const ThreadFooter = forwardRef<HTMLDivElement, ThreadFooterProps>(
     );
   },
 );
+
+export const Thread = {
+  Root: ThreadRoot,
+  Header: ThreadHeader,
+  Status: ThreadStatus,
+};
+
+export type { ThreadRootProps, ThreadHeaderProps as ThreadHeadingProps, ThreadStatusProps };

package/src/index.ts

@@ -2,9 +2,9 @@
 // Copyright 2023 DXOS.org
 //
 
-import translations from './translations';
+import { translations } from './translations';
 
 export * from './Thread';
 export * from './Message';
-export * from './types';
+export type * from './types';
 export { translations };

package/src/testing.tsx

@@ -2,10 +2,9 @@
 // Copyright 2024 DXOS.org
 //
 
-import { X } from '@phosphor-icons/react';
-import React, { type PropsWithChildren } from 'react';
+import React from 'react';
 
-import { Button } from '@dxos/react-ui';
+import { Button, Icon } from '@dxos/react-ui';
 import { hoverableControlItem, hoverableControls, hoverableFocusedWithinControls, mx } from '@dxos/react-ui-theme';
 
 import { MessageBody, MessageHeading } from './Message';
@@ -31,7 +30,7 @@ export const MessageStoryText = ({ text, onDelete, authorName, timestamp }: Mess
             classNames={['p-1.5 min-bs-0 mie-1 items-start transition-opacity', hoverableControlItem]}
             onClick={() => onDelete()}
           >
-            <X />
+            <Icon icon='ph--x--regular' />
           </Button>
         )}
       </MessageHeading>
@@ -56,7 +55,3 @@ export const MessageStoryBlock = <PartValue,>({ part }: MessagePartProps<PartVal
     </div>
   );
 };
-
-export const ThreadStoryContainer = ({ children }: PropsWithChildren) => {
-  return <div className={mx('bg-white dark:bg-black mli-auto is-96 overflow-y-auto')}>{children}</div>;
-};

package/src/translations.ts

@@ -2,9 +2,11 @@
 // Copyright 2023 DXOS.org
 //
 
-export const translationKey = 'thread';
+import { type Resource } from '@dxos/react-ui';
 
-export default [
+export const translationKey = 'react-ui-thread';
+
+export const translations = [
   {
     'en-US': {
       [translationKey]: {
@@ -21,4 +23,4 @@ export default [
       },
     },
   },
-];
+] as const satisfies Resource[];