@prosekit/solid 0.7.0-beta.1 → 0.7.0-beta.2

package/src/components/inline-popover/inline-popover-positioner.gen.ts

@@ -0,0 +1,191 @@
+/**
+ * This file is auto-generated by the "@aria-ui/cli" tool. Do not edit this file directly.
+ */
+
+import { registerInlinePopoverPositionerElement, type InlinePopoverPositionerElement, type InlinePopoverPositionerProps as InlinePopoverPositionerElementProps } from '@prosekit/web/inline-popover';
+import { createEffect, createSignal, mergeProps, splitProps } from 'solid-js';
+import type { Component, JSX } from 'solid-js';
+import h from 'solid-js/h';
+
+/**
+ * Props for the {@link InlinePopoverPositioner} Solid component.
+ *
+ * @public
+ */
+export interface InlinePopoverPositionerProps extends JSX.HTMLAttributes<InlinePopoverPositionerElement> {
+  /**
+   * The initial placement of the floating element
+   *
+   * @default "top"
+   */
+  placement?: InlinePopoverPositionerElementProps['placement'];
+  /**
+   * The distance between the reference and floating element.
+   *
+   * @default 12
+   */
+  offset?: InlinePopoverPositionerElementProps['offset'];
+  /**
+   * Whether to hide the floating element when the reference element or the
+   * floating element is fully clipped.
+   *
+   * @default true
+   */
+  hide?: InlinePopoverPositionerElementProps['hide'];
+  /**
+   * Whether the floating element can overlap the reference element to keep it
+   * in view.
+   *
+   * @default true
+   */
+  overlap?: InlinePopoverPositionerElementProps['overlap'];
+  /**
+   * Whether to improve positioning for inline reference elements that span over
+   * multiple lines.
+   *
+   * @default true
+   */
+  inline?: InlinePopoverPositionerElementProps['inline'];
+  /**
+   * Describes the virtual padding around the boundary to check for overflow.
+   *
+   * @default 8
+   */
+  overflowPadding?: InlinePopoverPositionerElementProps['overflowPadding'];
+  /**
+   * The strategy to use for positioning
+   *
+   * @default "absolute"
+   */
+  strategy?: InlinePopoverPositionerElementProps['strategy'];
+  /**
+   * Options to activate auto-update listeners
+   *
+   * @see https://floating-ui.com/docs/autoUpdate
+   *
+   * @default true
+   */
+  autoUpdate?: InlinePopoverPositionerElementProps['autoUpdate'];
+  /**
+   * Whether to use the browser Popover API to place the floating element on
+   * top of other page content.
+   *
+   * @default true
+   */
+  hoist?: InlinePopoverPositionerElementProps['hoist'];
+  /**
+   * Whether to flip the `placement` in order to keep it in view when the
+   * preferred placement(s) will overflow the clipping boundary. You can also
+   * provide an array of placements to try sequentially if the preferred
+   * `placement` does not fit.
+   *
+   * @default true
+   */
+  flip?: InlinePopoverPositionerElementProps['flip'];
+  /**
+   * Whether the floating element should shift to keep it in view.
+   *
+   * @default true
+   */
+  shift?: InlinePopoverPositionerElementProps['shift'];
+  /**
+   * Whether to constrain the floating element's width and height to not exceed
+   * the viewport.
+   *
+   * @default false
+   */
+  fitViewport?: InlinePopoverPositionerElementProps['fitViewport'];
+  /**
+   * Whether to constrain the floating element's width so that it matches the
+   * reference element.
+   *
+   * @default false
+   */
+  sameWidth?: InlinePopoverPositionerElementProps['sameWidth'];
+  /**
+   * Whether to constrain the floating element's height so that it matches the
+   * reference element.
+   *
+   * @default false
+   */
+  sameHeight?: InlinePopoverPositionerElementProps['sameHeight'];
+  /**
+   * Describes the clipping element(s) or area that overflow will be checked relative to.
+   * Please see https://floating-ui.com/docs/detectoverflow#boundary for more information.
+   *
+   * @default 'clippingAncestors'
+   */
+  boundary?: InlinePopoverPositionerElementProps['boundary'];
+  /**
+   * Describes the root boundary that the element will be checked for overflow relative to.
+   * Please see https://floating-ui.com/docs/detectoverflow#rootboundary for more information.
+   *
+   * @default 'viewport'
+   */
+  rootBoundary?: InlinePopoverPositionerElementProps['rootBoundary'];
+  /**
+   * The element that will be used to check for overflow. Please see
+   * https://floating-ui.com/docs/detectoverflow#elementcontext for more
+   * information.
+   *
+   * @default 'floating'
+   */
+  elementContext?: InlinePopoverPositionerElementProps['elementContext'];
+  /**
+   * Whether to check the alternate elementContext's boundary. Please see
+   * https://floating-ui.com/docs/detectoverflow#altboundary for more
+   * information.
+   *
+   * @default false
+   */
+  altBoundary?: InlinePopoverPositionerElementProps['altBoundary'];
+}
+
+/**
+ * A Solid component that renders an `prosekit-inline-popover-positioner` custom element.
+ *
+ * @public
+ */
+export const InlinePopoverPositioner: Component<InlinePopoverPositionerProps> = (props): any => {
+  registerInlinePopoverPositionerElement();
+
+  const [getElement, setElement] = createSignal<InlinePopoverPositionerElement | null>(null);
+
+  const [elementProps, restProps] = splitProps(props, ['altBoundary', 'autoUpdate', 'boundary', 'elementContext', 'fitViewport', 'flip', 'hide', 'hoist', 'inline', 'offset', 'overflowPadding', 'overlap', 'placement', 'rootBoundary', 'sameHeight', 'sameWidth', 'shift', 'strategy']);
+
+  createEffect(() => {
+    const element = getElement();
+    if (!element) return;
+
+    Object.assign(element, {
+      altBoundary: elementProps.altBoundary,
+      autoUpdate: elementProps.autoUpdate,
+      boundary: elementProps.boundary,
+      elementContext: elementProps.elementContext,
+      fitViewport: elementProps.fitViewport,
+      flip: elementProps.flip,
+      hide: elementProps.hide,
+      hoist: elementProps.hoist,
+      inline: elementProps.inline,
+      offset: elementProps.offset,
+      overflowPadding: elementProps.overflowPadding,
+      overlap: elementProps.overlap,
+      placement: elementProps.placement,
+      rootBoundary: elementProps.rootBoundary,
+      sameHeight: elementProps.sameHeight,
+      sameWidth: elementProps.sameWidth,
+      shift: elementProps.shift,
+      strategy: elementProps.strategy,
+    });
+  });
+
+  return () =>
+    h(
+      'prosekit-inline-popover-positioner',
+      mergeProps(restProps, {
+        ref: (el: InlinePopoverPositionerElement | null) => {
+          setElement(el);
+        },
+      }),
+    );
+};

package/src/components/inline-popover/inline-popover-root.gen.ts

@@ -0,0 +1,106 @@
+/**
+ * This file is auto-generated by the "@aria-ui/cli" tool. Do not edit this file directly.
+ */
+
+import { registerInlinePopoverRootElement, type InlinePopoverRootElement, type InlinePopoverRootEvents, type InlinePopoverRootProps as InlinePopoverRootElementProps } from '@prosekit/web/inline-popover';
+import { createEffect, createSignal, mergeProps, splitProps } from 'solid-js';
+import type { Component, JSX } from 'solid-js';
+import h from 'solid-js/h';
+
+import { useEditorContext } from '../../contexts/editor-context.ts';
+
+/**
+ * Props for the {@link InlinePopoverRoot} Solid component.
+ *
+ * @public
+ */
+export interface InlinePopoverRootProps extends JSX.HTMLAttributes<InlinePopoverRootElement> {
+  /**
+   * The ProseKit editor instance.
+   *
+   * @default null
+   * @hidden
+   */
+  editor?: InlinePopoverRootElementProps['editor'];
+  /**
+   * Whether the popover is open by default when some inline content is
+   * selected.
+   *
+   * @default true
+   */
+  defaultOpen?: InlinePopoverRootElementProps['defaultOpen'];
+  /**
+   * Whether the inline popover should be dismissed when the editor receives an
+   * Escape key press.
+   *
+   * @default true
+   */
+  dismissOnEscape?: InlinePopoverRootElementProps['dismissOnEscape'];
+  /**
+   * Whether the overlay is currently open.
+   * @default null
+   */
+  open?: InlinePopoverRootElementProps['open'];
+  /**
+   * Whether the component should ignore user interaction.
+   * @default false
+   */
+  disabled?: InlinePopoverRootElementProps['disabled'];
+  /** */
+  onOpenChange?: (event: InlinePopoverRootEvents['openChange']) => void;
+}
+
+/**
+ * A Solid component that renders an `prosekit-inline-popover-root` custom element.
+ *
+ * @public
+ */
+export const InlinePopoverRoot: Component<InlinePopoverRootProps> = (props): any => {
+  registerInlinePopoverRootElement();
+
+  const [getElement, setElement] = createSignal<InlinePopoverRootElement | null>(null);
+  const handlers: Array<((event: any) => void) | undefined> = [];
+
+  const [elementProps, eventHandlers, restProps] = splitProps(props, ['defaultOpen', 'disabled', 'dismissOnEscape', 'editor', 'open'], ['onOpenChange']);
+
+  const p3Fallback = useEditorContext();
+
+  createEffect(() => {
+    const element = getElement();
+    if (!element) return;
+
+    Object.assign(element, { defaultOpen: elementProps.defaultOpen, disabled: elementProps.disabled, dismissOnEscape: elementProps.dismissOnEscape, editor: elementProps.editor ?? p3Fallback, open: elementProps.open });
+
+    handlers.length = 0;
+    handlers.push(eventHandlers.onOpenChange);
+  });
+
+  createEffect(() => {
+    const element = getElement();
+    if (!element) return;
+
+    const ac = new AbortController();
+    for (const [index, eventName] of ['openChange'].entries()) {
+      element.addEventListener(
+        eventName,
+        (event) => {
+          handlers[index]?.(event);
+        },
+        { signal: ac.signal },
+      );
+    }
+    return () => ac.abort();
+  });
+
+  return () =>
+    h(
+      'prosekit-inline-popover-root',
+      mergeProps(restProps, {
+        ref: (el: InlinePopoverRootElement | null) => {
+          setElement(el);
+        },
+      }),
+    );
+};
+
+export type { InlinePopoverRootEvents };

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

@@ -0,0 +1,19 @@
+/**
+ * This file is auto-generated by the "@aria-ui/cli" tool. Do not edit this file directly.
+ */
+
+export { MenuItem, type MenuItemProps, type MenuItemEvents } from './menu-item.gen.ts';
+
+export { MenuPopup, type MenuPopupProps } from './menu-popup.gen.ts';
+
+export { MenuPositioner, type MenuPositionerProps } from './menu-positioner.gen.ts';
+
+export { MenuRoot, type MenuRootProps, type MenuRootEvents } from './menu-root.gen.ts';
+
+export { MenuSubmenuRoot, type MenuSubmenuRootProps } from './menu-submenu-root.gen.ts';
+
+export { MenuSubmenuTrigger, type MenuSubmenuTriggerProps } from './menu-submenu-trigger.gen.ts';
+
+export { MenuTrigger, type MenuTriggerProps, type MenuTriggerEvents } from './menu-trigger.gen.ts';
+
+export { OpenChangeEvent, SelectEvent } from '@prosekit/web/menu';

package/src/components/menu/index.ts

@@ -0,0 +1,37 @@
+/**
+
+@module
+
+## Anatomy
+
+```jsx
+import {
+  MenuItem,
+  MenuPopup,
+  MenuPositioner,
+  MenuRoot,
+  MenuSubmenuRoot,
+  MenuSubmenuTrigger,
+  MenuTrigger,
+} from 'prosekit/solid/menu'
+
+<MenuRoot>
+  <MenuTrigger>...</MenuTrigger>
+  <MenuPositioner>
+    <MenuPopup>
+      <MenuItem>...</MenuItem>
+      <MenuSubmenuRoot>
+        <MenuSubmenuTrigger>...</MenuSubmenuTrigger>
+        <MenuPositioner>
+          <MenuPopup>
+            <MenuItem>...</MenuItem>
+          </MenuPopup>
+        </MenuPositioner>
+      </MenuSubmenuRoot>
+    </MenuPopup>
+  </MenuPositioner>
+</MenuRoot>
+```
+*/
+
+export * from './index.gen.ts'

package/src/components/menu/menu-item.gen.ts

@@ -0,0 +1,89 @@
+/**
+ * This file is auto-generated by the "@aria-ui/cli" tool. Do not edit this file directly.
+ */
+
+import { registerMenuItemElement, type MenuItemElement, type MenuItemEvents, type MenuItemProps as MenuItemElementProps } from '@prosekit/web/menu';
+import { createEffect, createSignal, mergeProps, splitProps } from 'solid-js';
+import type { Component, JSX } from 'solid-js';
+import h from 'solid-js/h';
+
+/**
+ * Props for the {@link MenuItem} Solid component.
+ *
+ * @public
+ */
+export interface MenuItemProps extends JSX.HTMLAttributes<MenuItemElement> {
+  /**
+   * The unique value for this menu item.
+   *
+   * @default ""
+   */
+  value?: MenuItemElementProps['value'];
+  /**
+   * Whether this menu item is disabled.
+   *
+   * @default false
+   */
+  disabled?: MenuItemElementProps['disabled'];
+  /**
+   * Whether to close the menu when the item is pressed.
+   *
+   * @default true
+   */
+  closeOnSelect?: MenuItemElementProps['closeOnSelect'];
+  /** Emitted when the the item is selected. */
+  onSelect?: (event: MenuItemEvents['select']) => void;
+}
+
+/**
+ * A Solid component that renders an `prosekit-menu-item` custom element.
+ *
+ * @public
+ */
+export const MenuItem: Component<MenuItemProps> = (props): any => {
+  registerMenuItemElement();
+
+  const [getElement, setElement] = createSignal<MenuItemElement | null>(null);
+  const handlers: Array<((event: any) => void) | undefined> = [];
+
+  const [elementProps, eventHandlers, restProps] = splitProps(props, ['closeOnSelect', 'disabled', 'value'], ['onSelect']);
+
+  createEffect(() => {
+    const element = getElement();
+    if (!element) return;
+
+    Object.assign(element, { closeOnSelect: elementProps.closeOnSelect, disabled: elementProps.disabled, value: elementProps.value });
+
+    handlers.length = 0;
+    handlers.push(eventHandlers.onSelect);
+  });
+
+  createEffect(() => {
+    const element = getElement();
+    if (!element) return;
+
+    const ac = new AbortController();
+    for (const [index, eventName] of ['select'].entries()) {
+      element.addEventListener(
+        eventName,
+        (event) => {
+          handlers[index]?.(event);
+        },
+        { signal: ac.signal },
+      );
+    }
+    return () => ac.abort();
+  });
+
+  return () =>
+    h(
+      'prosekit-menu-item',
+      mergeProps(restProps, {
+        ref: (el: MenuItemElement | null) => {
+          setElement(el);
+        },
+      }),
+    );
+};
+
+export type { MenuItemEvents };

package/src/components/menu/menu-popup.gen.ts

@@ -0,0 +1,53 @@
+/**
+ * This file is auto-generated by the "@aria-ui/cli" tool. Do not edit this file directly.
+ */
+
+import { registerMenuPopupElement, type MenuPopupElement, type MenuPopupProps as MenuPopupElementProps } from '@prosekit/web/menu';
+import { createEffect, createSignal, mergeProps, splitProps } from 'solid-js';
+import type { Component, JSX } from 'solid-js';
+import h from 'solid-js/h';
+
+/**
+ * Props for the {@link MenuPopup} Solid component.
+ *
+ * @public
+ */
+export interface MenuPopupProps extends JSX.HTMLAttributes<MenuPopupElement> {
+  /**
+   * By default, the MenuPopup element will listen for keydown events.
+   * You can pass a different element to listen for keydown events.
+   *
+   * @default null
+   */
+  eventTarget?: MenuPopupElementProps['eventTarget'];
+}
+
+/**
+ * A Solid component that renders an `prosekit-menu-popup` custom element.
+ *
+ * @public
+ */
+export const MenuPopup: Component<MenuPopupProps> = (props): any => {
+  registerMenuPopupElement();
+
+  const [getElement, setElement] = createSignal<MenuPopupElement | null>(null);
+
+  const [elementProps, restProps] = splitProps(props, ['eventTarget']);
+
+  createEffect(() => {
+    const element = getElement();
+    if (!element) return;
+
+    Object.assign(element, { eventTarget: elementProps.eventTarget });
+  });
+
+  return () =>
+    h(
+      'prosekit-menu-popup',
+      mergeProps(restProps, {
+        ref: (el: MenuPopupElement | null) => {
+          setElement(el);
+        },
+      }),
+    );
+};

package/src/components/menu/menu-positioner.gen.ts

@@ -0,0 +1,192 @@
+/**
+ * This file is auto-generated by the "@aria-ui/cli" tool. Do not edit this file directly.
+ */
+
+import { registerMenuPositionerElement, type MenuPositionerElement, type MenuPositionerProps as MenuPositionerElementProps } from '@prosekit/web/menu';
+import { createEffect, createSignal, mergeProps, splitProps } from 'solid-js';
+import type { Component, JSX } from 'solid-js';
+import h from 'solid-js/h';
+
+/**
+ * Props for the {@link MenuPositioner} Solid component.
+ *
+ * @public
+ */
+export interface MenuPositionerProps extends JSX.HTMLAttributes<MenuPositionerElement> {
+  /**
+   * The initial placement of the floating element
+   *
+   * @default "bottom-start"
+   */
+  placement?: MenuPositionerElementProps['placement'];
+  /**
+   * The strategy to use for positioning
+   *
+   * @default "absolute"
+   */
+  strategy?: MenuPositionerElementProps['strategy'];
+  /**
+   * Options to activate auto-update listeners
+   *
+   * @see https://floating-ui.com/docs/autoUpdate
+   *
+   * @default true
+   */
+  autoUpdate?: MenuPositionerElementProps['autoUpdate'];
+  /**
+   * Whether to use the browser Popover API to place the floating element on
+   * top of other page content.
+   *
+   * @default true
+   */
+  hoist?: MenuPositionerElementProps['hoist'];
+  /**
+   * The distance between the reference and floating element.
+   *
+   * @default 6
+   */
+  offset?: MenuPositionerElementProps['offset'];
+  /**
+   * Whether to flip the `placement` in order to keep it in view when the
+   * preferred placement(s) will overflow the clipping boundary. You can also
+   * provide an array of placements to try sequentially if the preferred
+   * `placement` does not fit.
+   *
+   * @default true
+   */
+  flip?: MenuPositionerElementProps['flip'];
+  /**
+   * Whether the floating element should shift to keep it in view.
+   *
+   * @default true
+   */
+  shift?: MenuPositionerElementProps['shift'];
+  /**
+   * Whether the floating element can overlap the reference element to keep it
+   * in view.
+   *
+   * @default false
+   */
+  overlap?: MenuPositionerElementProps['overlap'];
+  /**
+   * Whether to constrain the floating element's width and height to not exceed
+   * the viewport.
+   *
+   * @default false
+   */
+  fitViewport?: MenuPositionerElementProps['fitViewport'];
+  /**
+   * Whether to constrain the floating element's width so that it matches the
+   * reference element.
+   *
+   * @default false
+   */
+  sameWidth?: MenuPositionerElementProps['sameWidth'];
+  /**
+   * Whether to constrain the floating element's height so that it matches the
+   * reference element.
+   *
+   * @default false
+   */
+  sameHeight?: MenuPositionerElementProps['sameHeight'];
+  /**
+   * Whether to improve positioning for inline reference elements that span over
+   * multiple lines.
+   *
+   * @default false
+   */
+  inline?: MenuPositionerElementProps['inline'];
+  /**
+   * Whether to hide the floating element when the reference element or the
+   * floating element is fully clipped.
+   *
+   * @default false
+   */
+  hide?: MenuPositionerElementProps['hide'];
+  /**
+   * Describes the clipping element(s) or area that overflow will be checked relative to.
+   * Please see https://floating-ui.com/docs/detectoverflow#boundary for more information.
+   *
+   * @default 'clippingAncestors'
+   */
+  boundary?: MenuPositionerElementProps['boundary'];
+  /**
+   * Describes the root boundary that the element will be checked for overflow relative to.
+   * Please see https://floating-ui.com/docs/detectoverflow#rootboundary for more information.
+   *
+   * @default 'viewport'
+   */
+  rootBoundary?: MenuPositionerElementProps['rootBoundary'];
+  /**
+   * Describes the virtual padding around the boundary to check for overflow.
+   * Please see https://floating-ui.com/docs/detectoverflow#padding for more information.
+   *
+   * @default 4
+   */
+  overflowPadding?: MenuPositionerElementProps['overflowPadding'];
+  /**
+   * The element that will be used to check for overflow. Please see
+   * https://floating-ui.com/docs/detectoverflow#elementcontext for more
+   * information.
+   *
+   * @default 'floating'
+   */
+  elementContext?: MenuPositionerElementProps['elementContext'];
+  /**
+   * Whether to check the alternate elementContext's boundary. Please see
+   * https://floating-ui.com/docs/detectoverflow#altboundary for more
+   * information.
+   *
+   * @default false
+   */
+  altBoundary?: MenuPositionerElementProps['altBoundary'];
+}
+
+/**
+ * A Solid component that renders an `prosekit-menu-positioner` custom element.
+ *
+ * @public
+ */
+export const MenuPositioner: Component<MenuPositionerProps> = (props): any => {
+  registerMenuPositionerElement();
+
+  const [getElement, setElement] = createSignal<MenuPositionerElement | null>(null);
+
+  const [elementProps, restProps] = splitProps(props, ['altBoundary', 'autoUpdate', 'boundary', 'elementContext', 'fitViewport', 'flip', 'hide', 'hoist', 'inline', 'offset', 'overflowPadding', 'overlap', 'placement', 'rootBoundary', 'sameHeight', 'sameWidth', 'shift', 'strategy']);
+
+  createEffect(() => {
+    const element = getElement();
+    if (!element) return;
+
+    Object.assign(element, {
+      altBoundary: elementProps.altBoundary,
+      autoUpdate: elementProps.autoUpdate,
+      boundary: elementProps.boundary,
+      elementContext: elementProps.elementContext,
+      fitViewport: elementProps.fitViewport,
+      flip: elementProps.flip,
+      hide: elementProps.hide,
+      hoist: elementProps.hoist,
+      inline: elementProps.inline,
+      offset: elementProps.offset,
+      overflowPadding: elementProps.overflowPadding,
+      overlap: elementProps.overlap,
+      placement: elementProps.placement,
+      rootBoundary: elementProps.rootBoundary,
+      sameHeight: elementProps.sameHeight,
+      sameWidth: elementProps.sameWidth,
+      shift: elementProps.shift,
+      strategy: elementProps.strategy,
+    });
+  });
+
+  return () =>
+    h(
+      'prosekit-menu-positioner',
+      mergeProps(restProps, {
+        ref: (el: MenuPositionerElement | null) => {
+          setElement(el);
+        },
+      }),
+    );
+};