@dxos/react-ui-attention 0.8.4-main.ef1bc66f44 → 0.8.4-main.f466a3d56e

package/src/components/AttentionGlyph/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export * from './AttentionGlyph';

package/src/components/{AttentionProvider.stories.tsx → AttentionProvider/AttentionProvider.stories.tsx}

@@ -7,8 +7,7 @@ import React from 'react';
 
 import { withTheme } from '@dxos/react-ui/testing';
 
-import { withAttention } from '../testing';
-
+import { withAttention } from '../../testing';
 import { useAttentionAttributes } from './AttentionProvider';
 
 const Attendable = ({ id }: { id: string }) => {
@@ -16,7 +15,7 @@ const Attendable = ({ id }: { id: string }) => {
 
   return (
     <div {...attentionAttrs}>
-      <textarea className='attention-surface resize-none' placeholder={id} />
+      <textarea className='dx-attention-surface resize-none' placeholder={id} />
     </div>
   );
 };

package/src/components/AttentionProvider/AttentionProvider.tsx

@@ -0,0 +1,176 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { RegistryContext } from '@effect-atom/atom-react';
+import { createContext } from '@radix-ui/react-context';
+import { Primitive } from '@radix-ui/react-primitive';
+import { Slot } from '@radix-ui/react-slot';
+import React, {
+  type ComponentPropsWithRef,
+  type FocusEvent,
+  type PropsWithChildren,
+  forwardRef,
+  useCallback,
+  useContext,
+  useEffect,
+  useMemo,
+  useState,
+} from 'react';
+
+import { log } from '@dxos/log';
+import { useDefaultValue } from '@dxos/react-hooks';
+import { type ThemedClassName } from '@dxos/react-ui';
+import { mx } from '@dxos/ui-theme';
+
+import { type Attention, AttentionManager, getAttendables } from '../../attention';
+
+const ATTENTION_NAME = 'Attention';
+const ATTENDABLE_ATTRIBUTE = 'data-attendable-id';
+const ATTENTION_SOURCE_ATTRIBUTE = 'data-w-attention-source';
+
+type AttentionContextValue = {
+  attention: AttentionManager;
+};
+
+const [AttentionContextProvider, useAttentionContext] = createContext<AttentionContextValue>(ATTENTION_NAME, {
+  attention: undefined as unknown as AttentionManager,
+});
+
+const UNKNOWN_ATTENDABLE = { hasAttention: false, isAncestor: false, isRelated: false } as Attention;
+
+/**
+ * Subscribe to the attention state for a qualified graph ID.
+ */
+// TODO(burdon): Unify with seleciton and change to contextId?
+const useAttention = (attendableId?: string): Attention => {
+  const { attention } = useAttentionContext(ATTENTION_NAME);
+  const [state, setState] = useState<Attention>(UNKNOWN_ATTENDABLE);
+  useEffect(() => {
+    if (!attendableId || !attention) {
+      setState(UNKNOWN_ATTENDABLE);
+      return;
+    }
+
+    const currentState = attention.get(attendableId);
+    setState(currentState);
+
+    return attention.subscribe(attendableId, (newState) => {
+      setState(newState);
+    });
+  }, [attention, attendableId]);
+
+  return state;
+};
+
+const useAttended = () => {
+  const { attention } = useAttentionContext(ATTENTION_NAME);
+  const [current, setCurrent] = useState<readonly string[]>([]);
+  useEffect(() => {
+    if (!attention) {
+      return;
+    }
+
+    setCurrent(attention.getCurrent());
+
+    return attention.subscribeCurrent((newCurrent) => {
+      setCurrent(newCurrent);
+    });
+  }, [attention]);
+
+  return current;
+};
+
+/**
+ * Computes HTML element attributes to apply so the attention system can detect changes.
+ */
+const useAttentionAttributes = (attendableId?: string) => {
+  const { hasAttention } = useAttention(attendableId);
+  return useMemo(() => {
+    const attributes: Record<string, string | undefined> = { [ATTENDABLE_ATTRIBUTE]: attendableId };
+    if (hasAttention) {
+      attributes[ATTENTION_SOURCE_ATTRIBUTE] = 'true';
+    }
+
+    return attributes;
+  }, [attendableId, hasAttention]);
+};
+
+type RootAttentionProviderProps = PropsWithChildren<{
+  attention?: AttentionManager;
+  onChange?: (nextAttended: string[]) => void;
+}>;
+
+const RootAttentionProvider = ({ children, attention: propsAttention, onChange }: RootAttentionProviderProps) => {
+  const registry = useContext(RegistryContext);
+  const attention = useDefaultValue(propsAttention, () => new AttentionManager(registry));
+
+  const handleFocus = useCallback(
+    (event: FocusEvent) => {
+      // NOTE(thure): Use the following to debug focus movement across the app:
+      log('focus', { related: event.relatedTarget, target: event.target });
+
+      const selector = [
+        '[data-attendable-id]',
+        ...Array.from(document.querySelectorAll('[aria-controls]')).map(
+          (el) => `[id="${el.getAttribute('aria-controls')}"]`,
+        ),
+      ].join(',');
+      const prev = attention.getCurrent();
+      const next = getAttendables(selector, event.target);
+      // TODO(wittjosiah): Not allowing empty state means that the attended item is not strictly guaranteed to be in the DOM.
+      //   Currently this depends on the deck in order to ensure that when the attended item is removed something else is attended.
+      // Only update state if the result is different and not empty.
+      if (next.length > 0 && (prev.length !== next.length || !!prev.find((id, index) => next[index] !== id))) {
+        attention.update(next);
+        onChange?.(next);
+      }
+    },
+    [attention, onChange],
+  );
+
+  return (
+    <AttentionContextProvider attention={attention}>
+      <div className='contents' onFocusCapture={handleFocus}>
+        {children}
+      </div>
+    </AttentionContextProvider>
+  );
+};
+
+export type AttendableContainerProps = ThemedClassName<
+  ComponentPropsWithRef<'div'> & { id: string; asChild?: boolean }
+>;
+
+/**
+ * Note that DeckPlugin and StackPlugin both handle attention on their own,
+ * and when rendering content in those cases it is not necessary to also render an `AttendableContainer`.
+ * This component is primarily for Storybook stories and other testing scenarios,
+ * or the rare cases where an attendable entity is rendered outside of either of those plugins.
+ */
+const AttendableContainer = forwardRef<HTMLDivElement, AttendableContainerProps>(
+  ({ id, classNames, children, asChild, ...props }, forwardedRef) => {
+    const attentionAttrs = useAttentionAttributes(id);
+    const Comp = asChild ? Slot : Primitive.div;
+    return (
+      <Comp
+        role='none'
+        {...props}
+        {...attentionAttrs}
+        className={mx('dx-attention-surface', props.tabIndex === 0 && 'dx-focus-ring-inset-over-all', classNames)}
+        ref={forwardedRef}
+      >
+        {children}
+      </Comp>
+    );
+  },
+);
+
+export {
+  RootAttentionProvider,
+  AttendableContainer,
+  useAttentionContext,
+  useAttention,
+  useAttended,
+  useAttentionAttributes,
+};

package/src/components/AttentionProvider/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export * from './AttentionProvider';

package/src/components/{SelectionProvider.tsx → SelectionProvider/SelectionProvider.tsx}

@@ -15,7 +15,7 @@ import {
   type SelectionMode,
   type SelectionResult,
   defaultSelection,
-} from '../selection';
+} from '../../selection';
 
 const SELECTION_NAME = 'Selection';
 
@@ -23,6 +23,11 @@ type SelectionContextValue = {
   selection: SelectionManager;
 };
 
+// Default value lets consumers like `useSelected` render outside a
+// `SelectionProvider` (e.g. isolated stories) without throwing —
+// `selection` reads as `undefined` and the hook falls back to the
+// per-mode default result. Without this default, Radix `createContext`
+// throws "Selection must be used within Selection" on every consumer.
 const [SelectionContextProvider, useSelectionContext] = createContext<SelectionContextValue>(SELECTION_NAME, {
   selection: undefined as unknown as SelectionManager,
 });
@@ -30,20 +35,20 @@ const [SelectionContextProvider, useSelectionContext] = createContext<SelectionC
 /**
  * Manages selection state across the app for multiple contexts.
  */
-// TODO(burdon): When is the selection removed?
 export const SelectionProvider = ({
   children,
-  selection: propsSelection,
+  selection: selectionProp,
 }: PropsWithChildren<{ selection?: SelectionManager }>) => {
   const registry = useContext(RegistryContext);
-  const selection = useDefaultValue(propsSelection, () => new SelectionManager(registry));
+  const selection = useDefaultValue(selectionProp, () => new SelectionManager(registry));
+
   return <SelectionContextProvider selection={selection}>{children}</SelectionContextProvider>;
 };
 
 /**
  * Get the selection contexts.
  */
-export const useSelectionManager = () => {
+export const useSelectionManager = (): SelectionManager => {
   const { selection } = useSelectionContext(SELECTION_NAME);
   return selection;
 };
@@ -101,11 +106,13 @@ export type UseSelectionActions = {
 /**
  * Provides functions to manage the selection state for multiple contexts.
  */
-// TODO(burdon): Mode not used.
-export const useSelectionActions = (contextIds: string[], mode: SelectionMode = 'multi'): UseSelectionActions => {
-  const stableContextIds = useMemo(() => contextIds, [JSON.stringify(contextIds)]); // TODO(burdon): Avoid stringify.
+export const useSelectionActions = (contextIds: string[]): UseSelectionActions => {
+  const stableContextIds = useMemo(() => contextIds, [JSON.stringify(contextIds)]);
   const { selection } = useSelectionContext(SELECTION_NAME);
 
+  // No-op when rendered outside a `SelectionProvider` (e.g. an isolated
+  // story or a test harness) — `selection` is `undefined` from the
+  // context default value. Matches the pre-co-locate behaviour.
   const singleSelect = useCallback(
     (id: string) => {
       if (!selection) {

package/src/components/SelectionProvider/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export * from './SelectionProvider';

package/src/index.ts

@@ -5,4 +5,3 @@
 export * from './attention';
 export * from './components';
 export * from './selection';
-export * from './types';

package/src/selection.ts

@@ -8,15 +8,17 @@ import * as Schema from 'effect/Schema';
 
 import { invariant } from '@dxos/invariant';
 
-// TODO(burdon): Reconcile with @dxos/graph.
-
 export type SelectionMode = 'single' | 'multi' | 'range' | 'multi-range';
 
 export const SelectionSchema = Schema.Union(
-  Schema.Struct({ mode: Schema.Literal('single'), id: Schema.optional(Schema.String) }).pipe(Schema.mutable),
-  Schema.Struct({ mode: Schema.Literal('multi'), ids: Schema.Array(Schema.String).pipe(Schema.mutable) }).pipe(
-    Schema.mutable,
-  ),
+  Schema.Struct({
+    mode: Schema.Literal('single'),
+    id: Schema.optional(Schema.String),
+  }).pipe(Schema.mutable),
+  Schema.Struct({
+    mode: Schema.Literal('multi'),
+    ids: Schema.Array(Schema.String).pipe(Schema.mutable),
+  }).pipe(Schema.mutable),
   Schema.Struct({
     mode: Schema.Literal('range'),
     from: Schema.optional(Schema.String),
@@ -49,7 +51,6 @@ export type SelectionResult<T extends SelectionMode> = T extends 'single'
         ? { from: string; to: string }[]
         : never;
 
-// TODO(burdon): Refactor.
 export const getSelectionSet = (selectionManager: SelectionManager, contextId?: string) => {
   const ids = new Set<string>(contextId ? [contextId] : []);
   for (const context of selectionManager.getSelectionContexts()) {
@@ -125,13 +126,14 @@ export class SelectionManager {
     this._registry.update(this._state, (state) => ({
       selections: { ...state.selections, [contextId]: newSelection },
     }));
+
     return newSelection;
   }
 
-  // TODO(burdon): Disambiguate with getSelection?
   getSelected<T extends SelectionMode>(contextId: string, mode: T = 'multi' as T): SelectionResult<T> {
     const selection = this.getSelection(contextId, mode);
     invariant(selection?.mode === mode, 'Selection mode mismatch');
+
     // Cast required because TypeScript can't infer the relationship between T and the matched result.
     return Match.type<Selection>().pipe(
       Match.when({ mode: 'single' }, (s) => s.id),

package/src/testing/decorators/withAttention.ts

@@ -20,6 +20,7 @@ export const withAttention = (initialAttendedId?: string): Decorator => {
       () => (initialAttendedId ? new AttentionManager(registry, [initialAttendedId]) : undefined),
       [registry],
     );
+
     return createElement(
       RegistryContext.Provider,
       { value: registry },

package/src/types/index.ts

@@ -0,0 +1,9 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+// UI-free re-exports of @dxos/react-ui-attention. Importing from here does not
+// pull in React components, so it is safe to use from operations, schemas, and
+// other non-DOM code that only needs the data model and pure helpers.
+export * from '../attention';
+export * from '../selection';

package/dist/lib/browser/chunk-PAZBZOO2.mjs

@@ -1,7 +0,0 @@
-// src/types.ts
-var ATTENDABLE_PATH_SEPARATOR = "~";
-
-export {
-  ATTENDABLE_PATH_SEPARATOR
-};
-//# sourceMappingURL=chunk-PAZBZOO2.mjs.map

package/dist/lib/browser/chunk-PAZBZOO2.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/types.ts"],
-  "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\n// NOTE: Chosen from RFC 1738's `safe` characters: http://www.faqs.org/rfcs/rfc1738.html\nexport const ATTENDABLE_PATH_SEPARATOR = '~';\n\nexport type Attention = {\n  hasAttention: boolean;\n  isAncestor: boolean;\n  isRelated: boolean;\n};\n\nexport type CurrentState = {\n  current: string[];\n};\n"],
-  "mappings": ";AAKO,IAAMA,4BAA4B;",
-  "names": ["ATTENDABLE_PATH_SEPARATOR"]
-}