@prosekit/react 0.6.0 → 0.6.1

package/src/components/table-handle/table-handle-popover-content.gen.ts

@@ -0,0 +1,34 @@
+import {
+  type TableHandlePopoverContentElement,
+  type TableHandlePopoverContentProps as Props,
+  type TableHandlePopoverContentEvents as Events,
+  tableHandlePopoverContentProps,
+  tableHandlePopoverContentEvents,
+} from '@prosekit/web/table-handle'
+import type {
+  ForwardRefExoticComponent,
+  HTMLAttributes,
+  RefAttributes,
+} from 'react'
+
+import { createComponent } from '../create-component'
+import type { CreateProps } from '../create-props'
+
+/**
+ * Props for the {@link TableHandlePopoverContent} component.
+ */
+export interface TableHandlePopoverContentProps extends Partial<CreateProps<Props, Events>> {}
+ 
+export const TableHandlePopoverContent: ForwardRefExoticComponent<
+  TableHandlePopoverContentProps &
+  RefAttributes<TableHandlePopoverContentElement> &
+  HTMLAttributes<TableHandlePopoverContentElement>
+> = createComponent<
+  TableHandlePopoverContentProps, 
+  TableHandlePopoverContentElement
+>(
+  'prosekit-table-handle-popover-content',
+  'TableHandlePopoverContent',
+  Object.keys(tableHandlePopoverContentProps),
+  Object.keys(tableHandlePopoverContentEvents),
+)

package/src/components/table-handle/table-handle-popover-item.gen.ts

@@ -0,0 +1,34 @@
+import {
+  type TableHandlePopoverItemElement,
+  type TableHandlePopoverItemProps as Props,
+  type TableHandlePopoverItemEvents as Events,
+  tableHandlePopoverItemProps,
+  tableHandlePopoverItemEvents,
+} from '@prosekit/web/table-handle'
+import type {
+  ForwardRefExoticComponent,
+  HTMLAttributes,
+  RefAttributes,
+} from 'react'
+
+import { createComponent } from '../create-component'
+import type { CreateProps } from '../create-props'
+
+/**
+ * Props for the {@link TableHandlePopoverItem} component.
+ */
+export interface TableHandlePopoverItemProps extends Partial<CreateProps<Props, Events>> {}
+ 
+export const TableHandlePopoverItem: ForwardRefExoticComponent<
+  TableHandlePopoverItemProps &
+  RefAttributes<TableHandlePopoverItemElement> &
+  HTMLAttributes<TableHandlePopoverItemElement>
+> = createComponent<
+  TableHandlePopoverItemProps, 
+  TableHandlePopoverItemElement
+>(
+  'prosekit-table-handle-popover-item',
+  'TableHandlePopoverItem',
+  Object.keys(tableHandlePopoverItemProps),
+  Object.keys(tableHandlePopoverItemEvents),
+)

package/src/components/table-handle/table-handle-root.gen.ts

@@ -0,0 +1,34 @@
+import {
+  type TableHandleRootElement,
+  type TableHandleRootProps as Props,
+  type TableHandleRootEvents as Events,
+  tableHandleRootProps,
+  tableHandleRootEvents,
+} from '@prosekit/web/table-handle'
+import type {
+  ForwardRefExoticComponent,
+  HTMLAttributes,
+  RefAttributes,
+} from 'react'
+
+import { createComponent } from '../create-component'
+import type { CreateProps } from '../create-props'
+
+/**
+ * Props for the {@link TableHandleRoot} component.
+ */
+export interface TableHandleRootProps extends Partial<CreateProps<Props, Events>> {}
+ 
+export const TableHandleRoot: ForwardRefExoticComponent<
+  TableHandleRootProps &
+  RefAttributes<TableHandleRootElement> &
+  HTMLAttributes<TableHandleRootElement>
+> = createComponent<
+  TableHandleRootProps, 
+  TableHandleRootElement
+>(
+  'prosekit-table-handle-root',
+  'TableHandleRoot',
+  Object.keys(tableHandleRootProps),
+  Object.keys(tableHandleRootEvents),
+)

package/src/components/table-handle/table-handle-row-root.gen.ts

@@ -0,0 +1,34 @@
+import {
+  type TableHandleRowRootElement,
+  type TableHandleRowRootProps as Props,
+  type TableHandleRowRootEvents as Events,
+  tableHandleRowRootProps,
+  tableHandleRowRootEvents,
+} from '@prosekit/web/table-handle'
+import type {
+  ForwardRefExoticComponent,
+  HTMLAttributes,
+  RefAttributes,
+} from 'react'
+
+import { createComponent } from '../create-component'
+import type { CreateProps } from '../create-props'
+
+/**
+ * Props for the {@link TableHandleRowRoot} component.
+ */
+export interface TableHandleRowRootProps extends Partial<CreateProps<Props, Events>> {}
+ 
+export const TableHandleRowRoot: ForwardRefExoticComponent<
+  TableHandleRowRootProps &
+  RefAttributes<TableHandleRowRootElement> &
+  HTMLAttributes<TableHandleRowRootElement>
+> = createComponent<
+  TableHandleRowRootProps, 
+  TableHandleRowRootElement
+>(
+  'prosekit-table-handle-row-root',
+  'TableHandleRowRoot',
+  Object.keys(tableHandleRowRootProps),
+  Object.keys(tableHandleRowRootEvents),
+)

package/src/components/table-handle/table-handle-row-trigger.gen.ts

@@ -0,0 +1,34 @@
+import {
+  type TableHandleRowTriggerElement,
+  type TableHandleRowTriggerProps as Props,
+  type TableHandleRowTriggerEvents as Events,
+  tableHandleRowTriggerProps,
+  tableHandleRowTriggerEvents,
+} from '@prosekit/web/table-handle'
+import type {
+  ForwardRefExoticComponent,
+  HTMLAttributes,
+  RefAttributes,
+} from 'react'
+
+import { createComponent } from '../create-component'
+import type { CreateProps } from '../create-props'
+
+/**
+ * Props for the {@link TableHandleRowTrigger} component.
+ */
+export interface TableHandleRowTriggerProps extends Partial<CreateProps<Props, Events>> {}
+ 
+export const TableHandleRowTrigger: ForwardRefExoticComponent<
+  TableHandleRowTriggerProps &
+  RefAttributes<TableHandleRowTriggerElement> &
+  HTMLAttributes<TableHandleRowTriggerElement>
+> = createComponent<
+  TableHandleRowTriggerProps, 
+  TableHandleRowTriggerElement
+>(
+  'prosekit-table-handle-row-trigger',
+  'TableHandleRowTrigger',
+  Object.keys(tableHandleRowTriggerProps),
+  Object.keys(tableHandleRowTriggerEvents),
+)

package/src/components/tooltip/index.gen.ts

@@ -0,0 +1,5 @@
+export { TooltipContent, type TooltipContentProps } from './tooltip-content.gen'
+
+export { TooltipRoot, type TooltipRootProps } from './tooltip-root.gen'
+
+export { TooltipTrigger, type TooltipTriggerProps } from './tooltip-trigger.gen'

package/src/components/tooltip/tooltip-content.gen.ts

@@ -0,0 +1,34 @@
+import {
+  type TooltipContentElement,
+  type TooltipContentProps as Props,
+  type TooltipContentEvents as Events,
+  tooltipContentProps,
+  tooltipContentEvents,
+} from '@prosekit/web/tooltip'
+import type {
+  ForwardRefExoticComponent,
+  HTMLAttributes,
+  RefAttributes,
+} from 'react'
+
+import { createComponent } from '../create-component'
+import type { CreateProps } from '../create-props'
+
+/**
+ * Props for the {@link TooltipContent} component.
+ */
+export interface TooltipContentProps extends Partial<CreateProps<Props, Events>> {}
+ 
+export const TooltipContent: ForwardRefExoticComponent<
+  TooltipContentProps &
+  RefAttributes<TooltipContentElement> &
+  HTMLAttributes<TooltipContentElement>
+> = createComponent<
+  TooltipContentProps, 
+  TooltipContentElement
+>(
+  'prosekit-tooltip-content',
+  'TooltipContent',
+  Object.keys(tooltipContentProps),
+  Object.keys(tooltipContentEvents),
+)

package/src/components/tooltip/tooltip-root.gen.ts

@@ -0,0 +1,34 @@
+import {
+  type TooltipRootElement,
+  type TooltipRootProps as Props,
+  type TooltipRootEvents as Events,
+  tooltipRootProps,
+  tooltipRootEvents,
+} from '@prosekit/web/tooltip'
+import type {
+  ForwardRefExoticComponent,
+  HTMLAttributes,
+  RefAttributes,
+} from 'react'
+
+import { createComponent } from '../create-component'
+import type { CreateProps } from '../create-props'
+
+/**
+ * Props for the {@link TooltipRoot} component.
+ */
+export interface TooltipRootProps extends Partial<CreateProps<Props, Events>> {}
+ 
+export const TooltipRoot: ForwardRefExoticComponent<
+  TooltipRootProps &
+  RefAttributes<TooltipRootElement> &
+  HTMLAttributes<TooltipRootElement>
+> = createComponent<
+  TooltipRootProps, 
+  TooltipRootElement
+>(
+  'prosekit-tooltip-root',
+  'TooltipRoot',
+  Object.keys(tooltipRootProps),
+  Object.keys(tooltipRootEvents),
+)

package/src/components/tooltip/tooltip-trigger.gen.ts

@@ -0,0 +1,34 @@
+import {
+  type TooltipTriggerElement,
+  type TooltipTriggerProps as Props,
+  type TooltipTriggerEvents as Events,
+  tooltipTriggerProps,
+  tooltipTriggerEvents,
+} from '@prosekit/web/tooltip'
+import type {
+  ForwardRefExoticComponent,
+  HTMLAttributes,
+  RefAttributes,
+} from 'react'
+
+import { createComponent } from '../create-component'
+import type { CreateProps } from '../create-props'
+
+/**
+ * Props for the {@link TooltipTrigger} component.
+ */
+export interface TooltipTriggerProps extends Partial<CreateProps<Props, Events>> {}
+ 
+export const TooltipTrigger: ForwardRefExoticComponent<
+  TooltipTriggerProps &
+  RefAttributes<TooltipTriggerElement> &
+  HTMLAttributes<TooltipTriggerElement>
+> = createComponent<
+  TooltipTriggerProps, 
+  TooltipTriggerElement
+>(
+  'prosekit-tooltip-trigger',
+  'TooltipTrigger',
+  Object.keys(tooltipTriggerProps),
+  Object.keys(tooltipTriggerEvents),
+)

package/src/contexts/editor-context.ts

@@ -0,0 +1,23 @@
+import type {
+  Editor,
+  Extension,
+} from '@prosekit/core'
+import {
+  createContext,
+  useContext,
+  type Provider,
+} from 'react'
+
+const editorContext = createContext<Editor | null>(null)
+
+/**
+ * @internal
+ */
+export function useEditorContext<E extends Extension>(): Editor<E> | null {
+  return useContext(editorContext)
+}
+
+/**
+ * @internal
+ */
+export const EditorContextProvider: Provider<Editor | null> = editorContext.Provider

package/src/extensions/react-mark-view.ts

@@ -0,0 +1,93 @@
+import {
+  defineMarkViewComponent,
+  defineMarkViewFactory,
+  type Extension,
+} from '@prosekit/core'
+import type { MarkViewConstructor } from '@prosekit/pm/view'
+import type { CoreMarkViewUserOptions } from '@prosemirror-adapter/core'
+import {
+  useMarkViewContext,
+  useMarkViewFactory,
+  type MarkViewContext,
+  type ReactMarkViewUserOptions,
+} from '@prosemirror-adapter/react'
+import {
+  createElement,
+  useMemo,
+  type ComponentType,
+  type FC,
+} from 'react'
+
+import { useExtension } from '../hooks/use-extension'
+
+/**
+ * @public
+ */
+export interface ReactMarkViewProps extends MarkViewContext {}
+
+/**
+ * @public
+ */
+export type ReactMarkViewComponent = ComponentType<ReactMarkViewProps>
+
+/**
+ * Options for {@link defineReactMarkView}.
+ *
+ * @public
+ */
+export interface ReactMarkViewOptions extends CoreMarkViewUserOptions<ReactMarkViewComponent> {
+  /**
+   * The name of the mark type.
+   */
+  name: string
+}
+
+function withMarkViewProps(component: ReactMarkViewComponent) {
+  return function MarkViewPropsWrapper() {
+    const props: ReactMarkViewProps = useMarkViewContext()
+    return createElement(component, props)
+  }
+}
+
+/**
+ * @internal
+ */
+export const ReactMarkViewConsumer: FC = () => {
+  const markViewFactory = useMarkViewFactory()
+  const extension = useMemo(
+    () => defineReactMarkViewFactory(markViewFactory),
+    [markViewFactory],
+  )
+  useExtension(extension)
+
+  return null
+}
+
+/**
+ * Defines a mark view using a React component.
+ *
+ * @public
+ */
+export function defineReactMarkView(options: ReactMarkViewOptions): Extension {
+  const { name, component, ...userOptions } = options
+
+  const args: ReactMarkViewUserOptions = {
+    ...userOptions,
+    component: withMarkViewProps(component),
+  }
+
+  return defineMarkViewComponent<ReactMarkViewUserOptions>({
+    group: 'react',
+    name,
+    args,
+  })
+}
+
+function defineReactMarkViewFactory(
+  factory: (options: ReactMarkViewUserOptions) => MarkViewConstructor,
+) {
+  return defineMarkViewFactory<ReactMarkViewUserOptions>({
+    group: 'react',
+    factory,
+  })
+}

package/src/extensions/react-node-view.ts

@@ -0,0 +1,93 @@
+import {
+  defineNodeViewComponent,
+  defineNodeViewFactory,
+  type Extension,
+} from '@prosekit/core'
+import type { NodeViewConstructor } from '@prosekit/pm/view'
+import type { CoreNodeViewUserOptions } from '@prosemirror-adapter/core'
+import {
+  useNodeViewContext,
+  useNodeViewFactory,
+  type NodeViewContext,
+  type ReactNodeViewUserOptions,
+} from '@prosemirror-adapter/react'
+import {
+  createElement,
+  useMemo,
+  type ComponentType,
+  type FC,
+} from 'react'
+
+import { useExtension } from '../hooks/use-extension'
+
+/**
+ * @public
+ */
+export interface ReactNodeViewProps extends NodeViewContext {}
+
+/**
+ * @public
+ */
+export type ReactNodeViewComponent = ComponentType<ReactNodeViewProps>
+
+/**
+ * Options for {@link defineReactNodeView}.
+ *
+ * @public
+ */
+export interface ReactNodeViewOptions extends CoreNodeViewUserOptions<ReactNodeViewComponent> {
+  /**
+   * The name of the node type.
+   */
+  name: string
+}
+
+function withNodeViewProps(component: ReactNodeViewComponent) {
+  return function NodeViewPropsWrapper() {
+    const props: ReactNodeViewProps = useNodeViewContext()
+    return createElement(component, props)
+  }
+}
+
+/**
+ * @internal
+ */
+export const ReactNodeViewConsumer: FC = () => {
+  const nodeViewFactory = useNodeViewFactory()
+  const extension = useMemo(
+    () => defineReactNodeViewFactory(nodeViewFactory),
+    [nodeViewFactory],
+  )
+  useExtension(extension)
+
+  return null
+}
+
+/**
+ * Defines a node view using a React component.
+ *
+ * @public
+ */
+export function defineReactNodeView(options: ReactNodeViewOptions): Extension {
+  const { name, component, ...userOptions } = options
+
+  const args: ReactNodeViewUserOptions = {
+    ...userOptions,
+    component: withNodeViewProps(component),
+  }
+
+  return defineNodeViewComponent<ReactNodeViewUserOptions>({
+    group: 'react',
+    name,
+    args,
+  })
+}
+
+function defineReactNodeViewFactory(
+  factory: (options: ReactNodeViewUserOptions) => NodeViewConstructor,
+) {
+  return defineNodeViewFactory<ReactNodeViewUserOptions>({
+    group: 'react',
+    factory,
+  })
+}

package/src/hooks/use-doc-change.ts

@@ -0,0 +1,24 @@
+import { defineDocChangeHandler } from '@prosekit/core'
+import type { ProseMirrorNode } from '@prosekit/pm/model'
+import { useMemo } from 'react'
+
+import {
+  useExtension,
+  type UseExtensionOptions,
+} from './use-extension'
+
+/**
+ * Calls the given handler whenever the editor document changes.
+ *
+ * @public
+ */
+export function useDocChange(
+  handler: (doc: ProseMirrorNode) => void,
+  options?: UseExtensionOptions,
+): void {
+  const extension = useMemo(
+    () => defineDocChangeHandler((view) => handler(view.state.doc)),
+    [handler],
+  )
+  useExtension(extension, options)
+}

package/src/hooks/use-editor-derived-value.ts

@@ -0,0 +1,83 @@
+import {
+  defineMountHandler,
+  defineUpdateHandler,
+  EditorNotFoundError,
+  union,
+  type Editor,
+  type Extension,
+} from '@prosekit/core'
+import {
+  useMemo,
+  useSyncExternalStore,
+} from 'react'
+
+import { useEditorContext } from '../contexts/editor-context'
+
+export interface UseEditorDerivedOptions<E extends Extension = any> {
+  /**
+   * The editor to add the extension to. If not provided, it will use the
+   * editor from the nearest `ProseKit` component.
+   */
+  editor?: Editor<E>
+}
+
+/**
+ * A hook that runs a function to derive a value from the editor instance after
+ * editor state changes.
+ *
+ * This is useful when you need to render something based on the editor state,
+ * for example, whether the selected text is wrapped in an italic mark.
+ *
+ * @public
+ */
+export function useEditorDerivedValue<E extends Extension, Derived>(
+  /**
+   * A function that receives the editor instance and returns a derived value.
+   *
+   * It will be called whenever the editor's document state changes, or when it
+   * mounts.
+   *
+   * This function should be memoized.
+   */
+  derive: (editor: Editor<E>) => Derived,
+  options?: UseEditorDerivedOptions<E>,
+): Derived {
+  const editorContext = useEditorContext<E>()
+  const editor = options?.editor ?? editorContext
+  if (!editor) {
+    throw new EditorNotFoundError()
+  }
+
+  const [subscribe, getSnapshot] = useMemo(() => {
+    return createEditorStore(editor, derive)
+  }, [editor, derive])
+
+  return useSyncExternalStore(subscribe, getSnapshot)
+}
+
+function createEditorStore<Derived, E extends Extension = any>(editor: Editor<E>, derive: (editor: Editor<E>) => Derived) {
+  let dirty = true
+  let derived: Derived
+
+  const subscribe = (onChange: VoidFunction): VoidFunction => {
+    const handleChange = () => {
+      dirty = true
+      onChange()
+    }
+    const extension = union(
+      defineUpdateHandler(handleChange),
+      defineMountHandler(handleChange),
+    )
+    return editor.use(extension)
+  }
+
+  const getSnapshot = () => {
+    if (dirty) {
+      dirty = false
+      derived = derive(editor)
+    }
+    return derived
+  }
+
+  return [subscribe, getSnapshot] as const
+}

package/src/hooks/use-editor-extension.ts

@@ -0,0 +1,24 @@
+import {
+  EditorNotFoundError,
+  type Editor,
+  type Extension,
+} from '@prosekit/core'
+import { useEffect } from 'react'
+
+/**
+ * @internal
+ */
+export function useEditorExtension(
+  editor: Editor | null | undefined,
+  extension: Extension | null,
+): void {
+  if (!editor) {
+    throw new EditorNotFoundError()
+  }
+
+  useEffect(() => {
+    if (extension) {
+      return editor.use(extension)
+    }
+  }, [editor, extension])
+}

package/src/hooks/use-editor.ts

@@ -0,0 +1,62 @@
+import {
+  defineMountHandler,
+  defineUpdateHandler,
+  ProseKitError,
+  union,
+  type Editor,
+  type Extension,
+} from '@prosekit/core'
+import {
+  useEffect,
+  useReducer,
+} from 'react'
+
+import { useEditorContext } from '../contexts/editor-context'
+
+/**
+ * Retrieves the editor instance from the nearest ProseKit component.
+ *
+ * @public
+ */
+export function useEditor<E extends Extension = any>(options?: {
+  /**
+   * Whether to update the component when the editor is mounted or editor state
+   * is updated.
+   *
+   * Note this this option doesn't work with [React
+   * compiler](https://react.dev/learn/react-compiler) because the returned
+   * editor will be the same instance after state updates. If you're using React
+   * compiler, you should use {@link useEditorDerivedValue} instead.
+   *
+   * @default false
+   */
+  update?: boolean
+}): Editor<E> {
+  const update = options?.update ?? false
+
+  const editor = useEditorContext<E>()
+  if (!editor) {
+    throw new ProseKitError(
+      'useEditor must be used within the ProseKit component',
+    )
+  }
+
+  const forceUpdate = useForceUpdate()
+
+  useEffect(() => {
+    if (update) {
+      const extension = union(
+        defineMountHandler(forceUpdate),
+        defineUpdateHandler(forceUpdate),
+      )
+      return editor.use(extension)
+    }
+  }, [editor, update, forceUpdate])
+
+  return editor
+}
+
+function useForceUpdate() {
+  const [, dispatch] = useReducer((x: number) => x + 1, 0)
+  return dispatch
+}