@prosekit/web 0.7.2 → 0.7.4

package/src/components/autocomplete/autocomplete-popover/types.ts

@@ -0,0 +1,103 @@
+import type {
+  EventDeclarations,
+  PropDeclarations,
+} from '@aria-ui/core'
+import {
+  overlayPositionerEvents,
+  overlayPositionerProps,
+  type OverlayPositionerEvents,
+  type OverlayPositionerProps,
+} from '@aria-ui/overlay/elements'
+import type { Editor } from '@prosekit/core'
+
+export interface AutocompletePopoverProps extends OverlayPositionerProps {
+  /**
+   * The ProseKit editor instance.
+   *
+   * @default null
+   * @hidden
+   */
+  editor: Editor | null
+
+  /**
+   * The regular expression to match the query text to autocomplete.
+   *
+   * @default null
+   */
+  regex: RegExp | null
+
+  /**
+   * The placement of the popover, relative to the text cursor.
+   *
+   * @default "bottom-start"
+   */
+  placement: OverlayPositionerProps['placement']
+
+  /**
+   * The distance between the popover and the hovered block.
+   *
+   * @default 4
+   */
+  offset: OverlayPositionerProps['offset']
+
+  /**
+   * @default true
+   */
+  inline: OverlayPositionerProps['inline']
+
+  /**
+   * @default true
+   */
+  hoist: OverlayPositionerProps['hoist']
+
+  /**
+   * @default true
+   */
+  fitViewport: OverlayPositionerProps['fitViewport']
+
+  /**
+   * @default "The body element"
+   */
+  boundary: OverlayPositionerProps['boundary']
+
+  /**
+   * @default 8
+   */
+  overflowPadding: OverlayPositionerProps['overflowPadding']
+}
+
+const body = typeof document !== 'undefined' && document.querySelector('body')
+const defaultBoundary = body || 'clippingAncestors'
+
+/** @internal */
+export const autocompletePopoverProps: PropDeclarations<AutocompletePopoverProps> = {
+  ...overlayPositionerProps,
+  editor: { default: null },
+  regex: { default: null },
+  placement: { default: 'bottom-start' },
+  offset: { default: 4 },
+  inline: { default: true },
+  hoist: { default: true },
+  fitViewport: { default: true },
+  boundary: { default: defaultBoundary },
+  overflowPadding: { default: 8 },
+}
+
+export interface AutocompletePopoverEvents extends OverlayPositionerEvents {
+  /**
+   * Fired when the open state changes.
+   */
+  openChange: CustomEvent<boolean>
+
+  /**
+   * Fired when the query changes.
+   */
+  queryChange: CustomEvent<string>
+}
+
+/** @internal */
+export const autocompletePopoverEvents: EventDeclarations<AutocompletePopoverEvents> = {
+  ...overlayPositionerEvents,
+  openChange: {},
+  queryChange: {},
+}

package/src/components/autocomplete/context.ts

@@ -0,0 +1,19 @@
+import {
+  createContext,
+  type Context,
+} from '@aria-ui/core'
+
+export const queryContext: Context<string> = createContext(
+  'prosekit/autocomplete-popover/query',
+  '',
+)
+
+export const onSubmitContext: Context<VoidFunction | null> = createContext(
+  'prosekit/autocomplete-popover/onSubmit',
+  null,
+)
+
+export const openContext: Context<boolean> = createContext(
+  'prosekit/autocomplete-popover/open',
+  false,
+)

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

@@ -0,0 +1,17 @@
+// This file is generated by packages/dev/src/gen-components.ts
+
+export { AutocompleteEmptyElement } from './autocomplete-empty/element.gen'
+export { autocompleteEmptyEvents, autocompleteEmptyProps, type AutocompleteEmptyEvents, type AutocompleteEmptyProps } from './autocomplete-empty/types'
+export { useAutocompleteEmpty } from './autocomplete-empty/setup'
+
+export { AutocompleteItemElement } from './autocomplete-item/element.gen'
+export { autocompleteItemEvents, autocompleteItemProps, type AutocompleteItemEvents, type AutocompleteItemProps } from './autocomplete-item/types'
+export { useAutocompleteItem } from './autocomplete-item/setup'
+
+export { AutocompleteListElement } from './autocomplete-list/element.gen'
+export { autocompleteListEvents, autocompleteListProps, type AutocompleteListEvents, type AutocompleteListProps } from './autocomplete-list/types'
+export { useAutocompleteList } from './autocomplete-list/setup'
+
+export { AutocompletePopoverElement } from './autocomplete-popover/element.gen'
+export { autocompletePopoverEvents, autocompletePopoverProps, type AutocompletePopoverEvents, type AutocompletePopoverProps } from './autocomplete-popover/types'
+export { useAutocompletePopover } from './autocomplete-popover/setup'

package/src/components/block-handle/block-handle-add/element.gen.ts

@@ -0,0 +1,18 @@
+import { defineCustomElement, registerCustomElement, type BaseElementConstructor } from "@aria-ui/core"
+
+import { useBlockHandleAdd } from "./setup"
+import { blockHandleAddEvents, blockHandleAddProps, type BlockHandleAddEvents, type BlockHandleAddProps } from "./types"
+
+const BlockHandleAddElementBase: BaseElementConstructor<BlockHandleAddProps> = defineCustomElement<
+  BlockHandleAddProps,
+  BlockHandleAddEvents
+>({
+  props: blockHandleAddProps,
+  events: blockHandleAddEvents,
+  setup: useBlockHandleAdd,
+})
+class BlockHandleAddElement extends BlockHandleAddElementBase {}
+
+registerCustomElement('prosekit-block-handle-add', BlockHandleAddElement)
+  
+export { BlockHandleAddElement }

package/src/components/block-handle/block-handle-add/setup.ts

@@ -0,0 +1,37 @@
+import {
+  useEventListener,
+  type ConnectableElement,
+  type SignalState,
+} from '@aria-ui/core'
+import { insertDefaultBlock } from '@prosekit/core'
+
+import { blockPopoverContext } from '../context'
+
+import type { BlockHandleAddProps } from './types'
+
+/**
+ * @internal
+ */
+export function useBlockHandleAdd(
+  host: ConnectableElement,
+  { state }: { state: SignalState<BlockHandleAddProps> },
+): void {
+  const context = blockPopoverContext.consume(host)
+
+  useEventListener(host, 'pointerdown', (event) => {
+    event.preventDefault()
+
+    const editor = state.editor.get()
+    const hoverState = context.get()
+    if (!editor || !hoverState) {
+      return
+    }
+
+    const { node, pos } = hoverState
+    editor.exec(insertDefaultBlock({ pos: pos + node.nodeSize }))
+    editor.focus()
+
+    // Hide the drag handle
+    context.set(null)
+  })
+}

package/src/components/block-handle/block-handle-add/types.ts

@@ -0,0 +1,26 @@
+import type {
+  EventDeclarations,
+  PropDeclarations,
+} from '@aria-ui/core'
+import type { Editor } from '@prosekit/core'
+
+export interface BlockHandleAddProps {
+  /**
+   * The ProseKit editor instance.
+   *
+   * @default null
+   * @hidden
+   */
+  editor: Editor | null
+}
+
+/** @internal */
+export const blockHandleAddProps: PropDeclarations<BlockHandleAddProps> = {
+  editor: { default: null },
+}
+
+/** @internal */
+export interface BlockHandleAddEvents {}
+
+/** @internal */
+export const blockHandleAddEvents: EventDeclarations<BlockHandleAddEvents> = {}

package/src/components/block-handle/block-handle-draggable/element.gen.ts

@@ -0,0 +1,18 @@
+import { defineCustomElement, registerCustomElement, type BaseElementConstructor } from "@aria-ui/core"
+
+import { useBlockHandleDraggable } from "./setup"
+import { blockHandleDraggableEvents, blockHandleDraggableProps, type BlockHandleDraggableEvents, type BlockHandleDraggableProps } from "./types"
+
+const BlockHandleDraggableElementBase: BaseElementConstructor<BlockHandleDraggableProps> = defineCustomElement<
+  BlockHandleDraggableProps,
+  BlockHandleDraggableEvents
+>({
+  props: blockHandleDraggableProps,
+  events: blockHandleDraggableEvents,
+  setup: useBlockHandleDraggable,
+})
+class BlockHandleDraggableElement extends BlockHandleDraggableElementBase {}
+
+registerCustomElement('prosekit-block-handle-draggable', BlockHandleDraggableElement)
+  
+export { BlockHandleDraggableElement }

package/src/components/block-handle/block-handle-draggable/set-drag-preview.ts

@@ -0,0 +1,88 @@
+import { assignStyles } from '../../../utils/assign-styles'
+import { deepCloneElement } from '../../../utils/clone-element'
+import { getClientRect } from '../../../utils/get-client-rect'
+import { injectStyle } from '../../../utils/inject-style'
+import { maxZIndex } from '../../../utils/max-z-index'
+
+/**
+ * Sets a drag preview image for the given element and ensures the preview position
+ * relative to the pointer is correct.
+ *
+ * This function does the following:
+ *
+ * - Creates a temporary container element.
+ * - Puts the container at the end of the document body.
+ * - Sets event's drag image.
+ * - Removes the container from the document body after the next frame.
+ */
+export function setDragPreview(event: DragEvent, element: HTMLElement): void {
+  const { top, bottom, left, right } = getClientRect(element)
+  const width = right - left
+  const height = bottom - top
+  const elementX = left
+  const elementY = top
+
+  const { clientX, clientY } = event
+
+  const document = element.ownerDocument
+
+  const container = document.createElement('div')
+
+  // If outsideX is positive, the point is at the left side of the element.
+  const outsideX = Math.round(elementX - clientX)
+  // If outsideY is positive, the point is above the element.
+  const outsideY = Math.round(elementY - clientY)
+
+  const borderX = Math.max(outsideX, 0)
+  const borderY = Math.max(outsideY, 0)
+  assignStyles(container, {
+    // Ensuring we don't cause reflow when adding the element to the page using
+    // `position:fixed` rather than `position:absolute` so we are positioned on
+    // the current viewport. `position:fixed` also creates a new stacking
+    // context, so we don't need to do that here.
+    // https://github.com/atlassian/pragmatic-drag-and-drop/blob/56276552/packages/core/src/public-utils/element/custom-native-drag-preview/set-custom-native-drag-preview.ts#L60
+    position: 'fixed',
+
+    // The element is positioned off-screen to avoid capturing the content of
+    // the page on Safari when the dragging element has a transparent background
+    // on Safari. See https://github.com/prosekit/prosekit/issues/1153 for more
+    // details.
+    top: '-1000vh',
+    left: '-1000vw',
+
+    // The element should not be interactive.
+    pointerEvents: 'none',
+
+    zIndex: maxZIndex,
+
+    // Only reliable cross browser technique found to push a drag preview away
+    // from the cursor is to use transparent borders on the container.
+    // https://github.com/atlassian/pragmatic-drag-and-drop/blob/56276552/packages/core/src/public-utils/element/custom-native-drag-preview/pointer-outside-of-preview.ts#L13-L18
+    borderLeft: `${borderX}px solid transparent`,
+    borderTop: `${borderY}px solid transparent`,
+
+    boxSizing: 'border-box',
+    width: `${width + borderX}px`,
+    height: `${height + borderY}px`,
+  })
+
+  const [clonedElement, styleText] = deepCloneElement(element, true)
+
+  // A hardcoded opacity.
+  clonedElement.style.setProperty('opacity', '0.5', 'important')
+  // The bounding client rect doesn't include the margin, so we need to remove
+  // the margin too from the cloned element so that it can fit the container.
+  clonedElement.style.setProperty('margin', '0', 'important')
+  // Hide the outline of the cloned element.
+  clonedElement.style.setProperty('outline-color', 'transparent', 'important')
+
+  document.body.appendChild(container)
+  container.appendChild(clonedElement)
+  injectStyle(container, styleText)
+
+  event.dataTransfer?.setDragImage(container, Math.max(-outsideX, 0), Math.max(-outsideY, 0))
+
+  requestAnimationFrame(() => {
+    container.remove()
+  })
+}

package/src/components/block-handle/block-handle-draggable/setup.ts

@@ -0,0 +1,133 @@
+import {
+  useAttribute,
+  useEffect,
+  useEventListener,
+  type ConnectableElement,
+  type ReadonlySignal,
+  type SignalState,
+} from '@aria-ui/core'
+import { isHTMLElement } from '@ocavue/utils'
+import type { Editor } from '@prosekit/core'
+import type { ViewDragging } from '@prosekit/extensions/drop-indicator'
+import {
+  Fragment,
+  Slice,
+} from '@prosekit/pm/model'
+import { NodeSelection } from '@prosekit/pm/state'
+import type { EditorView } from '@prosekit/pm/view'
+
+import { getBoxElement } from '../../../utils/get-box-element'
+import { getSafeEditorView } from '../../../utils/get-safe-editor-view'
+import {
+  blockPopoverContext,
+  draggingContext,
+  type BlockPopoverContext,
+  type HoverState,
+} from '../context'
+
+import { setDragPreview } from './set-drag-preview'
+import type { BlockHandleDraggableProps } from './types'
+
+/**
+ * @internal
+ */
+export function useBlockHandleDraggable(
+  host: ConnectableElement,
+  { state }: { state: SignalState<BlockHandleDraggableProps> },
+): void {
+  const context = blockPopoverContext.consume(host)
+  const dragging = draggingContext.consume(host)
+
+  useEffect(host, () => {
+    host.draggable = true
+  })
+
+  usePointerDownHandler(host, context, state.editor)
+
+  useEventListener(host, 'dragstart', (event) => {
+    dragging.set(true)
+
+    const view = getSafeEditorView(state.editor.get())
+    const hoverState = context.get()
+
+    if (view && hoverState) {
+      view.dom.classList.add('prosekit-dragging')
+      createDraggingPreview(view, hoverState, event)
+      setViewDragging(view, hoverState)
+    }
+  })
+
+  useEventListener(host, 'dragend', () => {
+    dragging.set(false)
+
+    const view = getSafeEditorView(state.editor.get())
+    if (view) {
+      view.dom.classList.remove('prosekit-dragging')
+    }
+  })
+
+  useAttribute(host, 'data-dragging', () => (dragging.get() ? '' : undefined))
+}
+
+function usePointerDownHandler(
+  host: ConnectableElement,
+  context: ReadonlySignal<BlockPopoverContext>,
+  editor: ReadonlySignal<Editor | null>,
+) {
+  useEventListener(host, 'pointerdown', () => {
+    const { pos } = context.get() ?? {}
+    const { view } = editor.get() ?? {}
+
+    if (pos == null || view == null) {
+      return
+    }
+
+    view.dispatch(
+      view.state.tr.setSelection(NodeSelection.create(view.state.doc, pos)),
+    )
+
+    // Clicking the handle will blur the editor, so we need to focus it again.
+    // We cannot call `event.preventDefault()` here to prevent the blur
+    // because it will prevent the drag event from firing.
+    requestAnimationFrame(() => {
+      view.focus()
+    })
+  })
+}
+
+function createDraggingPreview(view: EditorView, hoverState: HoverState, event: DragEvent): void {
+  if (!event.dataTransfer) {
+    return
+  }
+
+  const { pos } = hoverState
+
+  const element = view.nodeDOM(pos)
+  if (!element || !isHTMLElement(element)) {
+    return
+  }
+
+  const boxElement = getBoxElement(element)
+  if (!boxElement || !isHTMLElement(boxElement)) {
+    return
+  }
+
+  event.dataTransfer.clearData()
+  event.dataTransfer.setData('text/html', boxElement.outerHTML)
+  event.dataTransfer.effectAllowed = 'copyMove'
+  setDragPreview(event, boxElement)
+
+  return
+}
+
+function setViewDragging(view: EditorView, hoverState: HoverState): void {
+  const { node, pos } = hoverState
+
+  const dragging: ViewDragging = {
+    slice: new Slice(Fragment.from(node), 0, 0),
+    move: true,
+    node: NodeSelection.create(view.state.doc, pos),
+  }
+
+  view.dragging = dragging
+}

package/src/components/block-handle/block-handle-draggable/types.ts

@@ -0,0 +1,26 @@
+import type {
+  EventDeclarations,
+  PropDeclarations,
+} from '@aria-ui/core'
+import type { Editor } from '@prosekit/core'
+
+export interface BlockHandleDraggableProps {
+  /**
+   * The ProseKit editor instance.
+   *
+   * @default null
+   * @hidden
+   */
+  editor: Editor | null
+}
+
+/** @internal */
+export const blockHandleDraggableProps: PropDeclarations<BlockHandleDraggableProps> = {
+  editor: { default: null },
+}
+
+/** @internal */
+export interface BlockHandleDraggableEvents {}
+
+/** @internal */
+export const blockHandleDraggableEvents: EventDeclarations<BlockHandleDraggableEvents> = {}

package/src/components/block-handle/block-handle-popover/element.gen.ts

@@ -0,0 +1,18 @@
+import { defineCustomElement, registerCustomElement, type BaseElementConstructor } from "@aria-ui/core"
+
+import { useBlockHandlePopover } from "./setup"
+import { blockHandlePopoverEvents, blockHandlePopoverProps, type BlockHandlePopoverEvents, type BlockHandlePopoverProps } from "./types"
+
+const BlockHandlePopoverElementBase: BaseElementConstructor<BlockHandlePopoverProps> = defineCustomElement<
+  BlockHandlePopoverProps,
+  BlockHandlePopoverEvents
+>({
+  props: blockHandlePopoverProps,
+  events: blockHandlePopoverEvents,
+  setup: useBlockHandlePopover,
+})
+class BlockHandlePopoverElement extends BlockHandlePopoverElementBase {}
+
+registerCustomElement('prosekit-block-handle-popover', BlockHandlePopoverElement)
+  
+export { BlockHandlePopoverElement }