@prosekit/web 0.7.3 → 0.7.4

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 }

package/src/components/block-handle/block-handle-popover/pointer-move.ts

@@ -0,0 +1,243 @@
+import type { VirtualElement } from '@floating-ui/dom'
+import {
+  isElement,
+  isHTMLElement,
+  isTextNode,
+} from '@ocavue/utils'
+import {
+  defineDOMEventHandler,
+  union,
+  type PlainExtension,
+} from '@prosekit/core'
+import type { ProseMirrorNode } from '@prosekit/pm/model'
+import type { EditorView } from '@prosekit/pm/view'
+
+import { getClientRect } from '../../../utils/get-client-rect'
+import { throttle } from '../../../utils/throttle'
+import type { HoverState } from '../context'
+
+export type ElementHoverHandler = (
+  reference: VirtualElement | null,
+  hoverState: HoverState | null,
+) => void
+
+export function defineElementHoverHandler(handler: ElementHoverHandler): PlainExtension {
+  const handleElement = (
+    node: ProseMirrorNode,
+    pos: number,
+    element: HTMLElement,
+    parentElement?: Node | null,
+  ) => {
+    const reference: VirtualElement = {
+      contextElement: element,
+
+      getBoundingClientRect: () => {
+        const rect = findFirstLineRect(parentElement, element)
+        return rect ? fulfillRect(rect) : fallbackRect
+      },
+    }
+
+    handler(reference, { node, pos })
+  }
+
+  const handlePointerEvent = (view: EditorView, event: PointerEvent) => {
+    const { x, y } = event
+    const block = findBlockByCoords(view, x, y)
+    if (!block) {
+      handler(null, null)
+      return
+    }
+
+    const { node, pos } = block
+    const element = view.nodeDOM(pos)
+    if (!element || !isHTMLElement(element)) {
+      handler(null, null)
+      return
+    }
+
+    // If `node` is the first child of another non-doc block node, for example a
+    // list node or a blockquote node, we want to put the block handle agains
+    // the parent node.
+    const $pos = view.state.doc.resolve(pos)
+    if ($pos.depth > 0 && $pos.index($pos.depth) === 0) {
+      const parentPos = $pos.before($pos.depth)
+      const parentNode = $pos.parent
+      const parentElement = view.nodeDOM(parentPos)
+      handleElement(parentNode, parentPos, element, parentElement)
+    } else {
+      handleElement(node, pos, element)
+    }
+  }
+
+  return union(
+    defineDOMEventHandler('pointermove', throttle(handlePointerEvent, 200)),
+    defineDOMEventHandler('pointerout', handlePointerEvent),
+    defineDOMEventHandler('keypress', () => handler(null, null)),
+  )
+}
+
+function findBlockByCoords(view: EditorView, x: number, y: number): { node: ProseMirrorNode; pos: number } | undefined {
+  const rect = getClientRect(view.dom)
+  if (!isWithinRect(rect, x, y)) {
+    return
+  }
+
+  let parent: ProseMirrorNode | undefined = view.state.doc
+  let pos = -1
+
+  while (parent) {
+    if (parent.isBlock && (parent.isTextblock || parent.isAtom || parent.type.spec.isolating)) {
+      return { node: parent, pos }
+    }
+
+    // Collect all children and their positions
+    const children: ProseMirrorNode[] = []
+    const positions: number[] = []
+    parent.forEach((child, offset) => {
+      children.push(child)
+      positions.push(offset + pos + 1)
+    })
+
+    let lo = 0
+    let hi = children.length - 1
+
+    while (lo <= hi) {
+      const i = hi - ((hi - lo) >> 1)
+      const childDOM = view.nodeDOM(positions[i])
+      const childRect = getNodeRect(childDOM)
+      if (!childRect) {
+        console.warn(`[prosekit] Unable to get rect at position: ${positions[i]}`)
+        return
+      }
+      if (childRect.top > y) {
+        hi = i - 1
+      } else if (childRect.bottom < y) {
+        lo = i + 1
+      } else {
+        lo = i
+        break
+      }
+    }
+
+    if (lo > hi) {
+      return
+    }
+
+    parent = children[lo]
+    pos = positions[lo]
+  }
+}
+
+function getNodeRect(node: Node | null | undefined): Rect | undefined {
+  if (node && isElement(node) && node.isConnected) {
+    return getClientRect(node)
+  }
+}
+
+function isWithinRect(rect: Rect, x: number, y: number) {
+  return x >= rect.left && x <= rect.right && y >= rect.top && y <= rect.bottom
+}
+
+interface Rect {
+  top: number
+  right: number
+  bottom: number
+  left: number
+}
+
+function findFirstLineRect(outer?: Node | null, inner?: Node | null): Rect | undefined {
+  if (outer && !outer.isConnected) {
+    return
+  }
+  if (inner && !inner.isConnected) {
+    return
+  }
+
+  if (outer && inner) {
+    const outerRect = findOuterRect(outer)
+    const innerRect = findFirstLineRectInNode(inner)
+    if (outerRect && innerRect) {
+      const { top, bottom } = innerRect
+      const { left, right } = outerRect
+      return { top, bottom, left, right }
+    } else {
+      return outerRect || innerRect
+    }
+  } else if (outer) {
+    return findFirstLineRectInNode(outer)
+  } else if (inner) {
+    return findFirstLineRectInNode(inner)
+  }
+}
+
+function findOuterRect(node: Node): Rect | undefined {
+  if (!isElement(node)) {
+    return
+  }
+
+  const rect = getClientRect(node)
+  const style = node.ownerDocument.defaultView?.getComputedStyle(node)
+  const marginLeft = style && Number.parseInt(style.marginLeft, 10) || 0
+  const marginRight = style && Number.parseInt(style.marginRight, 10) || 0
+  const left = rect.left - marginLeft
+  const right = rect.right + marginRight
+
+  return { top: rect.top, bottom: rect.bottom, left, right }
+}
+
+function findFirstLineRectInNode(node: Node): Rect | undefined {
+  if (isElement(node)) {
+    return findFirstLineRectInElement(node)
+  } else if (isTextNode(node)) {
+    return findFirstLineRectInTextNode(node)
+  }
+}
+
+function findFirstLineRectInTextNode(node: Text): Rect | undefined {
+  const ownerDocument = node.ownerDocument
+  if (!ownerDocument) {
+    return
+  }
+  const range = ownerDocument.createRange()
+  range.setStart(node, 0)
+  range.setEnd(node, 0)
+  const rects = range.getClientRects()
+  return rects[0]
+}
+
+function findFirstLineRectInElement(element: Element): Rect | undefined {
+  if (element.nodeName === 'BR') {
+    return element.getBoundingClientRect()
+  }
+
+  const rect = getClientRect(element)
+  const style = element.ownerDocument.defaultView?.getComputedStyle(element)
+  const marginLeft = style && Number.parseInt(style.marginLeft, 10) || 0
+  const marginRight = style && Number.parseInt(style.marginRight, 10) || 0
+  const left = rect.left - marginLeft
+  const right = rect.right + marginRight
+
+  const lineHeight = style && Number.parseInt(style.lineHeight, 10) || 24
+  const paddingTop = style && Number.parseInt(style.paddingTop, 10) || 0
+  const borderTop = style && Number.parseInt(style.borderTopWidth, 10) || 0
+  const top = rect.top + paddingTop + borderTop
+  const bottom = top + lineHeight
+
+  return { top, bottom, left, right }
+}
+
+function fulfillRect({ top, right, bottom, left }: Rect) {
+  return { top, right, bottom, left, width: right - left, height: bottom - top, x: left, y: top }
+}
+
+// A fallback rect that is far away from the screen. It should not be used through.
+const fallbackRect = Object.freeze({
+  top: -9999,
+  right: -9999,
+  bottom: -9999,
+  left: -9999,
+  width: 0,
+  height: 0,
+  x: -9999,
+  y: -9999,
+})

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

@@ -0,0 +1,88 @@
+import {
+  createComputed,
+  createSignal,
+  useAttribute,
+  type ConnectableElement,
+  type ReadonlySignal,
+  type SetupOptions,
+} from '@aria-ui/core'
+import { useOverlayPositionerState } from '@aria-ui/overlay/elements'
+import { usePresence } from '@aria-ui/presence'
+import type { VirtualElement } from '@floating-ui/dom'
+import type { Editor } from '@prosekit/core'
+
+import { useEditorExtension } from '../../../hooks/use-editor-extension'
+import { useScrolling } from '../../../hooks/use-scrolling'
+import {
+  blockPopoverContext,
+  draggingContext,
+  type BlockPopoverContext,
+  type HoverState,
+} from '../context'
+
+import {
+  defineElementHoverHandler,
+  type ElementHoverHandler,
+} from './pointer-move'
+import type {
+  BlockHandlePopoverEvents,
+  BlockHandlePopoverProps,
+} from './types'
+
+/**
+ * @internal
+ */
+export function useBlockHandlePopover(
+  host: ConnectableElement,
+  { state, emit }: SetupOptions<BlockHandlePopoverProps, BlockHandlePopoverEvents>,
+): void {
+  const { editor, ...overlayState } = state
+  const reference = createSignal<VirtualElement | null>(null)
+  useOverlayPositionerState(host, overlayState, { reference })
+
+  const context = createSignal<BlockPopoverContext>(null)
+  blockPopoverContext.provide(host, context)
+
+  const dragging = createSignal(false)
+  draggingContext.provide(host, dragging)
+
+  const scrolling = useScrolling(host)
+  const open = createComputed(() => {
+    return !!context.get() && !scrolling.get()
+  })
+
+  useHoverExtension(host, editor, (referenceValue, hoverState) => {
+    reference.set(referenceValue)
+    context.set(hoverState)
+    const stateChangeDetails = hoverState ? { node: hoverState.node, pos: hoverState.pos } : null
+    emit('stateChange', stateChangeDetails)
+  })
+
+  useAttribute(host, 'data-state', () => (open.get() ? 'open' : 'closed'))
+  usePresence(host, open)
+}
+
+function useHoverExtension(
+  host: ConnectableElement,
+  editor: ReadonlySignal<Editor | null>,
+  handler: ElementHoverHandler,
+) {
+  let prevHoverState: HoverState | null = null
+
+  const extension = defineElementHoverHandler((reference, hoverState) => {
+    if (isHoverStateEqual(prevHoverState, hoverState)) {
+      return
+    }
+
+    prevHoverState = hoverState
+    handler(reference, hoverState)
+  })
+
+  useEditorExtension(host, editor, extension)
+}
+
+function isHoverStateEqual(a: HoverState | null, b: HoverState | null) {
+  if (!a && !b) return true
+  if (!a || !b) return false
+  return a.pos === b.pos && a.node.eq(b.node)
+}

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

@@ -0,0 +1,84 @@
+import type {
+  EventDeclarations,
+  PropDeclarations,
+} from '@aria-ui/core'
+import {
+  overlayPositionerEvents,
+  overlayPositionerProps,
+  type OverlayPositionerEvents,
+  type OverlayPositionerProps,
+} from '@aria-ui/overlay/elements'
+import type { Placement } from '@floating-ui/dom'
+import type { Editor } from '@prosekit/core'
+import type { ProseMirrorNode } from '@prosekit/pm/model'
+
+export interface BlockHandlePopoverProps extends Omit<OverlayPositionerProps, 'placement' | 'hoist' | 'flip' | 'shift' | 'hide'> {
+  /**
+   * The ProseKit editor instance.
+   *
+   * @default null
+   * @hidden
+   */
+  editor: Editor | null
+
+  /**
+   * The placement of the popover, relative to the hovered block.
+   *
+   * @default "left"
+   */
+  placement: Placement
+
+  /**
+   * Whether to use the browser [Popover API](https://developer.mozilla.org/en-US/docs/Web/API/Popover_API)
+   * to place the floating element on top of other page content.
+   *
+   * @default false
+   */
+  hoist: boolean
+
+  /**
+   * @default false
+   * @hidden
+   */
+  flip: boolean
+
+  /**
+   * @default false
+   * @hidden
+   */
+  shift: boolean
+
+  /**
+   * @default true
+   * @hidden
+   */
+  hide: boolean
+}
+
+/** @internal */
+export const blockHandlePopoverProps: PropDeclarations<BlockHandlePopoverProps> = {
+  ...overlayPositionerProps,
+  editor: { default: null },
+  placement: { default: 'left' },
+
+  // Enabling `hoist` will cause the popover to have a small delay when
+  // scrolling the page.
+  hoist: { default: false },
+
+  flip: { default: false },
+  shift: { default: false },
+  hide: { default: true },
+}
+
+export interface BlockHandlePopoverEvents extends OverlayPositionerEvents {
+  /**
+   * Fired when the hovered block changes.
+   */
+  stateChange: CustomEvent<{ node: ProseMirrorNode; pos: number } | null>
+}
+
+/** @internal */
+export const blockHandlePopoverEvents: EventDeclarations<BlockHandlePopoverEvents> = {
+  ...overlayPositionerEvents,
+  stateChange: {},
+}