@meowdown/react 0.76.4 → 0.77.0

package/README.md

@@ -17,17 +17,17 @@ Import both stylesheets and render the editor:
 ```tsx
 import '@meowdown/core/style.css'
 import '@meowdown/react/style.css'
-import { MeowdownEditor } from '@meowdown/react'
+import { MarkdownEditor } from '@meowdown/react'
 
 export function App() {
-  return <MeowdownEditor initialMarkdown="# Hello" />
+  return <MarkdownEditor initialMarkdown="# Hello" />
 }
 ```
 
 ## Usage
 
 ```tsx
-import { MeowdownEditor, type EditorHandle } from '@meowdown/react'
+import { MarkdownEditor, type EditorHandle } from '@meowdown/react'
 import { useRef, useCallback } from 'react'
 
 export function App() {
@@ -37,7 +37,7 @@ export function App() {
   }, [])
 
   return (
-    <MeowdownEditor
+    <MarkdownEditor
       handleRef={ref}
       mode="focus"
       initialMarkdown="# Hello"
@@ -51,12 +51,12 @@ export function App() {
 
 | Component                                                            | Description                                                                                                                                                                                                                                                                          |
 | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `MeowdownEditor`                                                     | The editor. Callbacks and resolvers must be stable; pass them via `useCallback`.                                                                                                                                                                                                     |
+| `MarkdownEditor`                                                     | The editor. Callbacks and resolvers must be stable; pass them via `useCallback`.                                                                                                                                                                                                     |
 | `MarkdownView`                                                       | Read-only Markdown renderer. `interactive={false}` renders passive content for previews.                                                                                                                                                                                             |
-| `WikilinkHoverCard`                                                  | Mount inside `MeowdownEditor`; renders host content for the hovered wiki link's `target`. Return `null` to render no card.                                                                                                                                                           |
+| `WikilinkHoverCard`                                                  | Mount inside `MarkdownEditor`; renders host content for the hovered wiki link's `target`. Return `null` to render no card.                                                                                                                                                           |
 | `LightboxRoot` / `LightboxImage` / `LightboxVideo` / `LightboxFrame` | Full-window image, video, and embedded player preview driven by `useLightbox()`. Compose your own close controls inside `LightboxRoot`, and call `lightbox.open(item, element)` from `onImageClick`, `onXPostMediaClick`, or `onYouTubeVideoClick` to zoom from the clicked element. |
 
-Common `MeowdownEditor` props:
+Common `MarkdownEditor` props:
 
 | Prop                                                                                                                            | What it does                                                                       |
 | ------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |

package/dist/index.d.ts

@@ -1,174 +1,7 @@
-import { AcceptPendingReplacementOptions, EditorConfig, ExitBoundaryHandler, FileClickHandler, FileInfoResolver, FileLinkResolver, FilePasteOptions, FileViewOptions, ImageClickHandler, ImageOptions, ImageUrlResolver, LinkClickHandler, LinkCopyHandler, LinkPreview, LinkPreviewResolver, LinkPreviewResolver as LinkPreviewResolver$1, ListMarker, MarkMode, PendingReplacement, PendingReplacementOutcome, PlaceholderOptions, ReferenceDefinitions, SearchStatusHandler, StartPendingReplacementOptions, TagClickHandler, TypedEditor, WikiEmbedResolver, WikilinkClickHandler, WikilinkHoverHit, WikilinkResolver, XPostMediaClickHandler, XPostResolver, XPostResolver as XPostResolver$1, YouTubeVideoClickHandler, YouTubeVideoResolver, YouTubeVideoResolver as YouTubeVideoResolver$1 } from "@meowdown/core";
 import { ComponentProps, ReactElement, ReactNode, Ref } from "react";
+import { AcceptPendingReplacementOptions, EditorConfig, ExitBoundaryHandler, FileClickHandler, FileInfoResolver, FileLinkResolver, FilePasteOptions, FileViewOptions, ImageClickHandler, ImageOptions, ImageUrlResolver, LinkClickHandler, LinkCopyHandler, LinkPreview, LinkPreviewResolver, LinkPreviewResolver as LinkPreviewResolver$1, ListMarker, MarkMode, PendingReplacement, PendingReplacementOutcome, PlaceholderOptions, ReferenceDefinitions, SearchStatusHandler, StartPendingReplacementOptions, TagClickHandler, TypedEditor, WikiEmbedResolver, WikilinkClickHandler, WikilinkHoverHit, WikilinkResolver, XPostMediaClickHandler, XPostResolver, XPostResolver as XPostResolver$1, YouTubeVideoClickHandler, YouTubeVideoResolver, YouTubeVideoResolver as YouTubeVideoResolver$1 } from "@meowdown/core";
 import { SelectionJSON, SelectionJSON as SelectionJSON$1 } from "@prosekit/core";
 import { ReactNodeViewComponent, ReactNodeViewComponent as ReactNodeViewComponent$1, useEditor, useExtension, useKeymap } from "@prosekit/react";
-//#region src/components/markdown-view.d.ts
-/**
- * Payload for {@link TaskClickHandler}.
- */
-interface TaskClickPayload {
-  /**
-   * Zero-based position of the clicked checkbox among all the checkboxes this
-   * view renders, in document order. Stable for a given `markdown`, so a host
-   * can map it back to the corresponding task item in its own parse of the
-   * same source.
-   */
-  index: number;
-  /**
-   * The checkbox's rendered state. The view never flips it — see the handler doc.
-   */
-  checked: boolean;
-  /**
-   * The item's list marker as written (`+` renders a circle checkbox, `-`/`*` a square).
-   */
-  marker: ListMarker;
-  /**
-   * First line of the item's own inline content, exactly as it appears in the
-   * source after the `[ ]`/`[x]` marker and one space. A host locating the task
-   * by {@link index} can cross-check this against its own parse and refuse a
-   * mismatch instead of toggling the wrong item.
-   */
-  text: string;
-  /**
-   * The originating click. Read modifier keys or position a popover from it.
-   */
-  event: globalThis.MouseEvent;
-}
-/**
- * Called when a rendered task checkbox is clicked. The view is a pure render
- * of `markdown` and never flips the box itself: apply the toggle to the
- * source and re-render, exactly like the other click handlers.
- */
-type TaskClickHandler = (payload: TaskClickPayload) => void;
-interface MarkdownViewProps {
-  /**
-   * The Markdown to render. Live: changing it re-renders the content.
-   */
-  markdown: string;
-  /**
-   * Interpret content as one paragraph, without block syntax.
-   */
-  inline?: boolean;
-  /**
-   * Reference definitions available outside this fragment.
-   */
-  referenceDefinitions?: ReferenceDefinitions;
-  /**
-   * Mark mode for the read-only view. Defaults to `'hide'`.
-   */
-  markMode?: MarkMode;
-  /**
-   * Peel a leading YAML frontmatter block before rendering. Off by default.
-   */
-  frontmatter?: boolean;
-  /**
-   * Whether rendered links, images, file pills, and task checkboxes can be activated.
-   * Defaults to `true`. When `false`, callbacks are ignored, the rendered tree
-   * contains no anchors or focusable task controls, and recognized tweet and
-   * YouTube embeds are omitted before any image resolver runs.
-   */
-  interactive?: boolean;
-  /**
-   * Render collapsed (`+`) bullets expanded, ignoring their fold state at any
-   * depth. Off by default. For views that show slices of a note (e.g. a
-   * backlinks panel), where the source's fold state must not hide the content
-   * the view exists to show.
-   */
-  expandCollapsed?: boolean;
-  /**
-   * Map an image `src` to a displayable URL, or `undefined` to skip it. May
-   * return a `Promise`; the image appears once it resolves, in a box of its
-   * persisted size when both dimensions are known.
-   */
-  resolveImageUrl?: ImageUrlResolver;
-  /**
-   * Claim a `[label](url)` link as a file pill instead of a regular link.
-   * Must be pure; return `false` for links that should render normally.
-   */
-  resolveFileLink?: FileLinkResolver;
-  /**
-   * Classify `![[target]]` as an image, file, or note; unresolved source stays literal.
-   */
-  resolveWikiEmbed?: WikiEmbedResolver;
-  /**
-   * Resolve a `[[...]]` wikilink into its target and chip label; the bracketed
-   * text is both by default. Must be pure.
-   */
-  resolveWikilink?: WikilinkResolver;
-  /**
-   * Resolve metadata shown on a file pill.
-   */
-  resolveFileInfo?: FileInfoResolver;
-  /**
-   * Resolve the data behind an X post URL, rendered as a `meowdown-embed-x`
-   * card. Defaults to `defaultResolveXPost`.
-   */
-  resolveXPost?: XPostResolver$1;
-  /**
-   * Additional trusted protocols for X media URLs, such as `reflect-asset:`.
-   */
-  mediaUrlProtocols?: string[];
-  /**
-   * Resolve the data behind a YouTube video URL, rendered as a
-   * `meowdown-embed-youtube` card. Defaults to `defaultResolveYouTubeVideo`.
-   */
-  resolveYouTubeVideo?: YouTubeVideoResolver$1;
-  /**
-   * Called when a rendered wikilink is clicked. Pass a stable function.
-   */
-  onWikilinkClick?: WikilinkClickHandler;
-  /**
-   * Called when a rendered Markdown link is clicked. Pass a stable function.
-   */
-  onLinkClick?: LinkClickHandler;
-  /**
-   * Called when a rendered image is clicked. Pass a stable function.
-   */
-  onImageClick?: ImageClickHandler;
-  /**
-   * Called when a photo or video inside an X post card is activated. Call
-   * `event.preventDefault()` to stop the card from opening the photo URL or
-   * playing the video in place.
-   */
-  onXPostMediaClick?: XPostMediaClickHandler;
-  /**
-   * Called when the poster of a YouTube card is activated. Call
-   * `event.preventDefault()` to stop the card from playing the video in place.
-   */
-  onYouTubeVideoClick?: YouTubeVideoClickHandler;
-  /**
-   * Called when a rendered file pill is clicked. Pass a stable function.
-   */
-  onFileClick?: FileClickHandler;
-  /**
-   * Called when a rendered task checkbox is clicked. Pass a stable function.
-   */
-  onTaskClick?: TaskClickHandler;
-  /**
-   * Extra class on the content root (alongside `ProseMirror meowdown-content`).
-   */
-  className?: string;
-}
-/**
- * Render Markdown to a read-only React tree that looks exactly like the editor
- * in `hide` mark mode: inline marks, wikilink chips, images, tweet/YouTube
- * embeds, and syntax-highlighted code. No editor, no ProseMirror view; just a
- * walk over `markdownToDoc`'s document reusing meowdown's own parse, mark logic,
- * and CSS (the root carries `ProseMirror` + `data-mark-mode` so the existing
- * stylesheet applies). Requires a DOM environment.
- *
- * Callbacks (`onWikilinkClick`, etc.) and resolvers should be stable; pass them via
- * `useCallback` to avoid re-rendering the whole tree.
- */
-export declare function MarkdownView({ markdown, inline, referenceDefinitions: suppliedDefinitions, markMode, frontmatter, interactive, expandCollapsed, resolveImageUrl, resolveFileLink, resolveWikiEmbed, resolveWikilink, resolveFileInfo, resolveXPost, mediaUrlProtocols, resolveYouTubeVideo, onWikilinkClick, onLinkClick, onImageClick, onXPostMediaClick, onYouTubeVideoClick, onFileClick, onTaskClick, className }: MarkdownViewProps): ReactElement;
-//#endregion
-//#region src/components/markdown-inline-view.d.ts
-type MarkdownInlineViewProps = Omit<MarkdownViewProps, 'inline' | 'frontmatter' | 'onTaskClick'>;
-/**
- * Render paragraph content using the shared inline marks and link handlers.
- */
-export declare function MarkdownInlineView(props: MarkdownInlineViewProps): ReactElement;
-//#endregion
 //#region src/utils/date-format.d.ts
 type TimeFormat = '12' | '24';
 //#endregion
@@ -744,7 +577,167 @@ interface EditorProps {
  *
  * Callbacks and resolvers should be stable; pass them via `useCallback`.
  */
-export declare function MeowdownEditor({ mode, initialMarkdown, singleParagraph, referenceDefinitions, onDocChange, onSlashMenuSearch, onTagSearch, onWikilinkSearch, onSelectionMenuSearch, selectionMenuAffordance, pendingReplacementActions, onPendingReplacementResolve, onWikilinkClick, onLinkClick, onLinkCopy, resolveLinkPreview, onTagClick, onExitBoundary, resolveImageUrl, resolveFileLink, resolveWikiEmbed, resolveWikilink, resolveFileInfo, resolveXPost, mediaUrlProtocols, resolveYouTubeVideo, onFileClick, onFilePaste, onFileSaveError, onImageClick, onXPostMediaClick, onYouTubeVideoClick, embedPaste, linkPaste, bulletAfterHeading, substitution, frontmatter, blockHandle, caretGlide, placeholder, readOnly, spellCheck, searchQuery, onSearchChange, timeFormat, editorClassName, wrapperClassName, CodeBlockView, handleRef, children }: EditorProps): ReactElement;
+export declare function MarkdownEditor({ mode, initialMarkdown, singleParagraph, referenceDefinitions, onDocChange, onSlashMenuSearch, onTagSearch, onWikilinkSearch, onSelectionMenuSearch, selectionMenuAffordance, pendingReplacementActions, onPendingReplacementResolve, onWikilinkClick, onLinkClick, onLinkCopy, resolveLinkPreview, onTagClick, onExitBoundary, resolveImageUrl, resolveFileLink, resolveWikiEmbed, resolveWikilink, resolveFileInfo, resolveXPost, mediaUrlProtocols, resolveYouTubeVideo, onFileClick, onFilePaste, onFileSaveError, onImageClick, onXPostMediaClick, onYouTubeVideoClick, embedPaste, linkPaste, bulletAfterHeading, substitution, frontmatter, blockHandle, caretGlide, placeholder, readOnly, spellCheck, searchQuery, onSearchChange, timeFormat, editorClassName, wrapperClassName, CodeBlockView, handleRef, children }: EditorProps): ReactElement;
+//#endregion
+//#region src/components/markdown-view.d.ts
+/**
+ * Payload for {@link TaskClickHandler}.
+ */
+interface TaskClickPayload {
+  /**
+   * Zero-based position of the clicked checkbox among all the checkboxes this
+   * view renders, in document order. Stable for a given `markdown`, so a host
+   * can map it back to the corresponding task item in its own parse of the
+   * same source.
+   */
+  index: number;
+  /**
+   * The checkbox's rendered state. The view never flips it — see the handler doc.
+   */
+  checked: boolean;
+  /**
+   * The item's list marker as written (`+` renders a circle checkbox, `-`/`*` a square).
+   */
+  marker: ListMarker;
+  /**
+   * First line of the item's own inline content, exactly as it appears in the
+   * source after the `[ ]`/`[x]` marker and one space. A host locating the task
+   * by {@link index} can cross-check this against its own parse and refuse a
+   * mismatch instead of toggling the wrong item.
+   */
+  text: string;
+  /**
+   * The originating click. Read modifier keys or position a popover from it.
+   */
+  event: globalThis.MouseEvent;
+}
+/**
+ * Called when a rendered task checkbox is clicked. The view is a pure render
+ * of `markdown` and never flips the box itself: apply the toggle to the
+ * source and re-render, exactly like the other click handlers.
+ */
+type TaskClickHandler = (payload: TaskClickPayload) => void;
+interface MarkdownViewProps {
+  /**
+   * The Markdown to render. Live: changing it re-renders the content.
+   */
+  markdown: string;
+  /**
+   * Interpret content as one paragraph, without block syntax.
+   */
+  inline?: boolean;
+  /**
+   * Reference definitions available outside this fragment.
+   */
+  referenceDefinitions?: ReferenceDefinitions;
+  /**
+   * Mark mode for the read-only view. Defaults to `'hide'`.
+   */
+  markMode?: MarkMode;
+  /**
+   * Peel a leading YAML frontmatter block before rendering. Off by default.
+   */
+  frontmatter?: boolean;
+  /**
+   * Whether rendered links, images, file pills, and task checkboxes can be activated.
+   * Defaults to `true`. When `false`, callbacks are ignored, the rendered tree
+   * contains no anchors or focusable task controls, and recognized tweet and
+   * YouTube embeds are omitted before any image resolver runs.
+   */
+  interactive?: boolean;
+  /**
+   * Render collapsed (`+`) bullets expanded, ignoring their fold state at any
+   * depth. Off by default. For views that show slices of a note (e.g. a
+   * backlinks panel), where the source's fold state must not hide the content
+   * the view exists to show.
+   */
+  expandCollapsed?: boolean;
+  /**
+   * Map an image `src` to a displayable URL, or `undefined` to skip it. May
+   * return a `Promise`; the image appears once it resolves, in a box of its
+   * persisted size when both dimensions are known.
+   */
+  resolveImageUrl?: ImageUrlResolver;
+  /**
+   * Claim a `[label](url)` link as a file pill instead of a regular link.
+   * Must be pure; return `false` for links that should render normally.
+   */
+  resolveFileLink?: FileLinkResolver;
+  /**
+   * Classify `![[target]]` as an image, file, or note; unresolved source stays literal.
+   */
+  resolveWikiEmbed?: WikiEmbedResolver;
+  /**
+   * Resolve a `[[...]]` wikilink into its target and chip label; the bracketed
+   * text is both by default. Must be pure.
+   */
+  resolveWikilink?: WikilinkResolver;
+  /**
+   * Resolve metadata shown on a file pill.
+   */
+  resolveFileInfo?: FileInfoResolver;
+  /**
+   * Resolve the data behind an X post URL, rendered as a `meowdown-embed-x`
+   * card. Defaults to `defaultResolveXPost`.
+   */
+  resolveXPost?: XPostResolver$1;
+  /**
+   * Additional trusted protocols for X media URLs, such as `reflect-asset:`.
+   */
+  mediaUrlProtocols?: string[];
+  /**
+   * Resolve the data behind a YouTube video URL, rendered as a
+   * `meowdown-embed-youtube` card. Defaults to `defaultResolveYouTubeVideo`.
+   */
+  resolveYouTubeVideo?: YouTubeVideoResolver$1;
+  /**
+   * Called when a rendered wikilink is clicked. Pass a stable function.
+   */
+  onWikilinkClick?: WikilinkClickHandler;
+  /**
+   * Called when a rendered Markdown link is clicked. Pass a stable function.
+   */
+  onLinkClick?: LinkClickHandler;
+  /**
+   * Called when a rendered image is clicked. Pass a stable function.
+   */
+  onImageClick?: ImageClickHandler;
+  /**
+   * Called when a photo or video inside an X post card is activated. Call
+   * `event.preventDefault()` to stop the card from opening the photo URL or
+   * playing the video in place.
+   */
+  onXPostMediaClick?: XPostMediaClickHandler;
+  /**
+   * Called when the poster of a YouTube card is activated. Call
+   * `event.preventDefault()` to stop the card from playing the video in place.
+   */
+  onYouTubeVideoClick?: YouTubeVideoClickHandler;
+  /**
+   * Called when a rendered file pill is clicked. Pass a stable function.
+   */
+  onFileClick?: FileClickHandler;
+  /**
+   * Called when a rendered task checkbox is clicked. Pass a stable function.
+   */
+  onTaskClick?: TaskClickHandler;
+  /**
+   * Extra class on the content root (alongside `ProseMirror meowdown-content`).
+   */
+  className?: string;
+}
+/**
+ * Render Markdown to a read-only React tree that looks exactly like the editor
+ * in `hide` mark mode: inline marks, wikilink chips, images, tweet/YouTube
+ * embeds, and syntax-highlighted code. No editor, no ProseMirror view; just a
+ * walk over `markdownToDoc`'s document reusing meowdown's own parse, mark logic,
+ * and CSS (the root carries `ProseMirror` + `data-mark-mode` so the existing
+ * stylesheet applies). Requires a DOM environment.
+ *
+ * Callbacks (`onWikilinkClick`, etc.) and resolvers should be stable; pass them via
+ * `useCallback` to avoid re-rendering the whole tree.
+ */
+export declare function MarkdownView({ markdown, inline, referenceDefinitions: suppliedDefinitions, markMode, frontmatter, interactive, expandCollapsed, resolveImageUrl, resolveFileLink, resolveWikiEmbed, resolveWikilink, resolveFileInfo, resolveXPost, mediaUrlProtocols, resolveYouTubeVideo, onWikilinkClick, onLinkClick, onImageClick, onXPostMediaClick, onYouTubeVideoClick, onFileClick, onTaskClick, className }: MarkdownViewProps): ReactElement;
 //#endregion
 //#region src/hooks/use-lightbox.d.ts
 /**
@@ -931,4 +924,10 @@ interface WikilinkHoverCardProps {
  */
 export declare function WikilinkHoverCard({ children, className }: WikilinkHoverCardProps): ReactNode;
 //#endregion
-export { type EditorHandle, type EditorMode, type EditorProps, type EditorStateSnapshot, type LightboxCloseOptions, type LightboxController, type LightboxFrameItem, type LightboxFrameProps, type LightboxImageItem, type LightboxImageProps, type LightboxItem, type LightboxRootProps, type LightboxVideoItem, type LightboxVideoProps, type LinkPreview, type LinkPreviewResolver, type MarkdownInlineViewProps, type MarkdownViewProps, type PendingReplacementResolveHandler, type ReactNodeViewComponent, type SelectionHint, type SelectionJSON, type SelectionMenuContext, type SelectionMenuItem, type SelectionMenuSearchHandler, type SlashMenuItem, type SlashMenuSearchHandler, type TagItem, type TagSearchHandler, type TaskClickHandler, type TaskClickPayload, type TimeFormat, type WikilinkHoverCardProps, type WikilinkItem, type WikilinkSearchHandler, type XPostResolver, type YouTubeVideoResolver, useEditor, useExtension, useKeymap };
+//#region src/index.d.ts
+/**
+ * @deprecated Use `MarkdownEditor` instead.
+ */
+export declare const MeowdownEditor: typeof MarkdownEditor;
+//#endregion
+export { type EditorHandle, type EditorMode, type EditorProps, type EditorStateSnapshot, type LightboxCloseOptions, type LightboxController, type LightboxFrameItem, type LightboxFrameProps, type LightboxImageItem, type LightboxImageProps, type LightboxItem, type LightboxRootProps, type LightboxVideoItem, type LightboxVideoProps, type LinkPreview, type LinkPreviewResolver, type MarkdownViewProps, type PendingReplacementResolveHandler, type ReactNodeViewComponent, type SelectionHint, type SelectionJSON, type SelectionMenuContext, type SelectionMenuItem, type SelectionMenuSearchHandler, type SlashMenuItem, type SlashMenuSearchHandler, type TagItem, type TagSearchHandler, type TaskClickHandler, type TaskClickPayload, type TimeFormat, type WikilinkHoverCardProps, type WikilinkItem, type WikilinkSearchHandler, type XPostResolver, type YouTubeVideoResolver, useEditor, useExtension, useKeymap };