@meowdown/react 0.6.0 → 0.7.0

package/README.md

@@ -5,8 +5,10 @@ React components for Meowdown, a hybrid (live-preview) Markdown editor.
 ## Usage
 
 ```tsx
-import { MeowdownEditor, type EditorHandle } from '@meowdown/react'
+import '@meowdown/core/style.css'
 import '@meowdown/react/style.css'
+
+import { MeowdownEditor, type EditorHandle } from '@meowdown/react'
 import { useRef, useCallback } from 'react'
 
 export function App() {
@@ -44,8 +46,8 @@ The Markdown editor component. Renders inside a `div.meowdown` wrapper that fill
 - `onWikilinkClick?: (payload: { target: string; event: MouseEvent }) => void`: called when a rendered wiki link is clicked. A plain click inside a link the caret already sits in just places the caret; `Mod`-click always fires. Pass a stable function (e.g. from `useCallback`). Ignored in source mode.
 - `resolveImageUrl?: (src: string) => string | undefined`: maps an image `src` to a displayable URL (or `undefined` to skip). Enables inline image rendering: `![alt](src)` stays literal text and the image renders beneath its line. Pass a stable function. Ignored in source mode.
 - `onImagePaste?: (file: File) => Promise<string | undefined>`: persists a pasted or dropped image file and returns its markdown `src` (or `undefined` to decline). Pass a stable function. Ignored in source mode.
-- `onImageSaveError?: (error: Error, file: File) => void`: called when `onImagePaste` throws. Defaults to `console.error`. Ignored in source mode.
-- `placeholder?: string | ((state) => string)`: placeholder text shown in an empty block. Pass a stable function. Ignored in source mode.
+- `onImageSaveError?: (error: unknown, file: File) => void`: called when `onImagePaste` throws. Defaults to `console.error`. Ignored in source mode.
+- `placeholder?: string | ((state) => string)`: placeholder text shown when the whole document is empty. Pass a stable function. Ignored in source mode.
 - `readOnly?: boolean`: makes the editor read-only, in both the rich and source modes.
 - `spellCheck?: boolean`: toggles the browser's native spell checking in the rich modes. Defaults to the browser's behavior. Ignored in source mode.
 - `editorClassName?: string`: class on the editable root (the contenteditable). Rich modes only.
@@ -57,14 +59,6 @@ The Markdown editor component. Renders inside a `div.meowdown` wrapper that fill
 
 Re-exported from `@prosekit/react`. Call it from a component passed as `children` to read the live editor instance.
 
-### `checkRoundTrip`
-
-Re-exported from `@meowdown/core`. `checkRoundTrip(markdown)` returns `'exact' | 'normalizing' | 'lossy'`, for hosts that gate saving markdown files on whether the editor reproduces them faithfully.
-
-### `EDITOR_KEY_BINDINGS`
-
-Re-exported from `@meowdown/core`. A literal (`as const`) object mapping each editor shortcut (e.g. `Mod-b`, `Mod-1`) to its description, for host settings UIs and keybinding-collision checks.
-
 ### `EditorHandle`
 
 Imperative handle for the editor, attached via `handleRef`.
@@ -81,20 +75,9 @@ Imperative handle for the editor, attached via `handleRef`.
 
 Selection positions are in the mounted editor's coordinate space: ProseMirror document positions in the rich modes, character offsets in source mode. They round-trip within one mode but are not portable across a mode switch.
 
-## Keyboard shortcuts
-
-In the rich modes (`focus` / `show` / `hide`), these toggle inline formatting on the selection (`Mod` = Cmd on macOS, Ctrl elsewhere):
-
-| Key           | Action               |
-| ------------- | -------------------- |
-| `Mod-B`       | toggle bold          |
-| `Mod-I`       | toggle italic        |
-| `Mod-E`       | toggle inline code   |
-| `Mod-Shift-X` | toggle strikethrough |
-
 ## Styling
 
-`@meowdown/react/style.css` includes the default theme from [`@meowdown/core`](https://www.npmjs.com/package/@meowdown/core).
+Import both stylesheets: `@meowdown/core/style.css` (the editor theme and variables) and `@meowdown/react/style.css` (the component layout). The core theme is documented in [`@meowdown/core`](https://www.npmjs.com/package/@meowdown/core).
 
 ## License
 

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { ReactNode, Ref } from "react";
-import { EDITOR_KEY_BINDINGS, ImageOptions, MarkMode, MarkMode as MarkMode$1, PlaceholderOptions, RoundTripFidelity, TypedEditor, TypedEditor as TypedEditor$1, WikilinkClickHandler, checkRoundTrip } from "@meowdown/core";
+import { ImageOptions, MarkMode, PlaceholderOptions, TypedEditor, WikilinkClickHandler } from "@meowdown/core";
 import { SelectionJSON, SelectionJSON as SelectionJSON$1 } from "@prosekit/core";
 import { useEditor } from "@prosekit/react";
 
@@ -38,7 +38,7 @@ interface EditorHandle {
   /** Scrolls the selection into view. */
   scrollIntoView: () => void;
   /** Escape hatch: the underlying ProseKit editor, or `undefined` in source mode. */
-  readonly editor: TypedEditor$1 | undefined;
+  readonly editor: TypedEditor | undefined;
 }
 /**
 /** One row in the tag menu. The host ranks the rows; the menu does not re-sort. */
@@ -77,7 +77,7 @@ interface WikilinkItem {
 type WikilinkSearchHandler = (query: string) => WikilinkItem[] | Promise<WikilinkItem[]>;
 //#endregion
 //#region src/components/editor.d.ts
-type EditorMode = MarkMode$1 | 'source';
+type EditorMode = MarkMode | 'source';
 interface EditorProps {
   /**
    * The editor mode. The three rich modes ('focus', 'show', 'hide') render a ProseKit
@@ -131,8 +131,8 @@ interface EditorProps {
   /** Called when persisting a pasted/dropped image throws. Ignored in source mode. */
   onImageSaveError?: ImageOptions['onImageSaveError'];
   /**
-   * Placeholder text shown in an empty block. A function receives the editor
-   * state. Pass a stable function. Ignored in source mode.
+   * Placeholder text shown when the whole document is empty. A function
+   * receives the editor state. Pass a stable function. Ignored in source mode.
    */
   placeholder?: PlaceholderOptions['placeholder'];
   /** Makes the editor read-only, in both the rich and source modes. */
@@ -170,4 +170,4 @@ declare function MeowdownEditor({
   children
 }: EditorProps): import("react").JSX.Element;
 //#endregion
-export { EDITOR_KEY_BINDINGS, type EditorHandle, type EditorMode, type EditorProps, type EditorStateSnapshot, type MarkMode, MeowdownEditor, type RoundTripFidelity, type SelectionHint, type SelectionJSON, type TagItem, type TagSearchHandler, type TypedEditor, type WikilinkItem, type WikilinkSearchHandler, checkRoundTrip, useEditor };
+export { type EditorHandle, type EditorMode, type EditorProps, type EditorStateSnapshot, MeowdownEditor, type SelectionHint, type SelectionJSON, type TagItem, type TagSearchHandler, type WikilinkItem, type WikilinkSearchHandler, useEditor };

package/dist/index.js

@@ -7,7 +7,7 @@ import { Compartment, EditorSelection, EditorState } from "@codemirror/state";
 import { EditorView, keymap } from "@codemirror/view";
 import { clamp } from "@ocavue/utils";
 import { jsx, jsxs } from "react/jsx-runtime";
-import { EDITOR_KEY_BINDINGS, checkRoundTrip, codeBlockLanguages, defineEditorExtension, defineImages, defineMarkMode, definePlaceholder, defineReadonly, defineWikilinkClickHandler, docToMarkdown, markdownToDoc } from "@meowdown/core";
+import { codeBlockLanguages, defineEditorExtension, defineImages, defineMarkMode, definePlaceholder, defineReadonly, defineWikilinkClickHandler, docToMarkdown, markdownToDoc } from "@meowdown/core";
 import { canUseRegexLookbehind, createEditor, defineDocChangeHandler, union } from "@prosekit/core";
 import { Selection, TextSelection } from "@prosekit/pm/state";
 import { ProseKit, defineReactNodeView, useEditor, useEditor as useEditor$1, useExtension } from "@prosekit/react";
@@ -459,7 +459,10 @@ function EditorExtensions({ markMode, onDocChange, onWikilinkClick, resolveImage
 		onImageSaveError
 	]));
 	useExtension(useMemo(() => {
-		return placeholder ? definePlaceholder({ placeholder }) : null;
+		return placeholder ? definePlaceholder({
+			placeholder,
+			strategy: "doc"
+		}) : null;
 	}, [placeholder]));
 	return null;
 }
@@ -866,4 +869,4 @@ function MeowdownEditor({ mode = "focus", initialMarkdown, onDocChange, onTagSea
 }
 
 //#endregion
-export { EDITOR_KEY_BINDINGS, MeowdownEditor, checkRoundTrip, useEditor };
+export { MeowdownEditor, useEditor };

package/dist/style.css

@@ -323,424 +323,6 @@
   flex-shrink: 0;
   font-size: .8125rem;
 }
-.ProseMirror {
-  word-wrap: break-word;
-  white-space: pre-wrap;
-  white-space: break-spaces;
-  -webkit-font-variant-ligatures: none;
-  font-variant-ligatures: none;
-  font-feature-settings: "liga" 0;
-  position: relative;
-}
-
-.ProseMirror pre {
-  white-space: pre-wrap;
-}
-
-.ProseMirror li {
-  position: relative;
-}
-
-.ProseMirror-hideselection ::selection {
-  background: none;
-}
-
-.ProseMirror-hideselection {
-  caret-color: #0000;
-}
-
-.ProseMirror [draggable][contenteditable="false"] {
-  user-select: text;
-}
-
-.ProseMirror-selectednode {
-  outline: 2px solid #8cf;
-}
-
-li.ProseMirror-selectednode {
-  outline: none;
-}
-
-li.ProseMirror-selectednode:after {
-  content: "";
-  pointer-events: none;
-  border: 2px solid #8cf;
-  position: absolute;
-  inset: -2px -2px -2px -32px;
-}
-
-img.ProseMirror-separator {
-  border: none !important;
-  margin: 0 !important;
-  display: inline !important;
-}
-
-:root {
-  --prosekit-list-bullet-icon: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24'%3E%3Ccircle cx='12' cy='12' r='2.5' fill='currentColor'/%3E%3C/svg%3E");
-  --prosekit-list-toggle-open-icon: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24'%3E%3Cpolygon points='8,10 12,14 16,10' fill='currentColor'/%3E%3C/svg%3E");
-  --prosekit-list-toggle-closed-icon: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24'%3E%3Cpolygon points='10,8 14,12 10,16' fill='currentColor'/%3E%3C/svg%3E");
-}
-
-.prosemirror-flat-list {
-  margin: 0;
-  padding: 0;
-  list-style: none;
-  position: relative;
-}
-
-.prosemirror-flat-list > .list-marker {
-  text-align: center;
-  width: 1lh;
-  height: 1lh;
-  position: absolute;
-  inset-inline-start: 0;
-}
-
-.prosemirror-flat-list > .list-content {
-  margin-inline-start: 1lh;
-}
-
-.prosemirror-flat-list[data-list-kind="bullet"] > .list-marker, .prosemirror-flat-list[data-list-kind="toggle"] > .list-marker {
-  background-color: currentColor;
-  mask-position: center;
-  mask-size: contain;
-  mask-repeat: no-repeat;
-}
-
-.prosemirror-flat-list[data-list-kind="bullet"] > .list-marker {
-  mask-image: var(--prosekit-list-bullet-icon);
-}
-
-.prosemirror-flat-list[data-list-kind="toggle"] > .list-marker {
-  mask-image: var(--prosekit-list-toggle-open-icon);
-}
-
-.prosemirror-flat-list[data-list-kind="toggle"][data-list-collapsable][data-list-collapsed] > .list-marker {
-  mask-image: var(--prosekit-list-toggle-closed-icon);
-}
-
-.prosemirror-flat-list[data-list-kind="ordered"] > * {
-  contain: style;
-}
-
-.prosemirror-flat-list[data-list-kind="ordered"]:before {
-  content: counter(prosemirror-flat-list-counter, decimal) ". ";
-  font-variant-numeric: tabular-nums;
-  position: absolute;
-  inset-inline-end: calc(100% - 1lh);
-}
-
-.prosemirror-flat-list[data-list-kind="ordered"] {
-  counter-increment: prosemirror-flat-list-counter;
-}
-
-.prosemirror-flat-list[data-list-kind="ordered"]:first-child, :not(.prosemirror-flat-list[data-list-kind="ordered"]) + .prosemirror-flat-list[data-list-kind="ordered"] {
-  counter-reset: prosemirror-flat-list-counter;
-}
-
-@supports (counter-set: prosemirror-flat-list-counter 1) {
-  :is(.prosemirror-flat-list[data-list-kind="ordered"]:first-child, :not(.prosemirror-flat-list[data-list-kind="ordered"]) + .prosemirror-flat-list[data-list-kind="ordered"])[data-list-order] {
-    counter-set: prosemirror-flat-list-counter var(--prosemirror-flat-list-order);
-  }
-}
-
-@supports not (counter-set: prosemirror-flat-list-counter 1) {
-  :is(.prosemirror-flat-list[data-list-kind="ordered"]:first-child, :not(.prosemirror-flat-list[data-list-kind="ordered"]) + .prosemirror-flat-list[data-list-kind="ordered"])[data-list-order] {
-    counter-increment: prosemirror-flat-list-counter var(--prosemirror-flat-list-order);
-  }
-}
-
-.prosemirror-flat-list[data-list-kind="task"] > .list-marker, .prosemirror-flat-list[data-list-kind="task"] > .list-marker * {
-  cursor: pointer;
-  justify-content: center;
-  align-items: center;
-  margin: 0;
-  padding: 0;
-  display: flex;
-}
-
-.prosemirror-flat-list[data-list-kind="toggle"][data-list-collapsable] > .list-marker {
-  cursor: pointer;
-}
-
-.prosemirror-flat-list[data-list-kind="toggle"]:not([data-list-collapsable]) > .list-marker {
-  opacity: .4;
-  pointer-events: none;
-}
-
-.prosemirror-flat-list[data-list-kind="toggle"][data-list-collapsable][data-list-collapsed] > .list-content > :nth-child(n+2) {
-  display: none;
-}
-
-:root {
-  --meowdown-text: light-dark(#3f3f46, #d4d4d8);
-  --meowdown-heading: light-dark(#18181b, #fafafa);
-  --meowdown-muted: light-dark(#52525b, #a1a1aa);
-  --meowdown-accent: light-dark(#7c3aed, #c084fc);
-  --meowdown-mark: light-dark(#a78bfa, #8b5cf6);
-  --meowdown-border: light-dark(#e4e4e7, #3f3f46);
-  --meowdown-code-bg: light-dark(#f4f4f5, #18181b);
-  --meowdown-table-header-bg: light-dark(#fafafa, #27272a);
-  --meowdown-font-mono: ui-monospace, SFMono-Regular, Menlo, monospace;
-  --meowdown-node-outline: light-dark(#53f, #8870ff);
-  --meowdown-node-selection: light-dark(#5533ff1a, #8870ff1f);
-  --meowdown-selection: light-dark(#5533ff38, #8870ff4d);
-  --meowdown-gutter: 3.5rem;
-}
-
-.ProseMirror {
-  box-sizing: border-box;
-  padding: 1.25rem var(--meowdown-gutter) 1.75rem;
-  color: var(--meowdown-text);
-  caret-color: var(--meowdown-accent);
-  -webkit-font-smoothing: antialiased;
-  outline: none;
-  font-size: 1.0625rem;
-  line-height: 1.7;
-}
-
-.ProseMirror > * + * {
-  margin-top: .85em;
-}
-
-.ProseMirror h1, .ProseMirror h2, .ProseMirror h3, .ProseMirror h4, .ProseMirror h5, .ProseMirror h6 {
-  letter-spacing: -.01em;
-  color: var(--meowdown-heading);
-  font-weight: 600;
-  line-height: 1.25;
-}
-
-.ProseMirror h1 {
-  font-size: 1.75rem;
-}
-
-.ProseMirror h2 {
-  font-size: 1.4rem;
-}
-
-.ProseMirror h3 {
-  font-size: 1.2rem;
-}
-
-.ProseMirror h4 {
-  font-size: 1.1rem;
-}
-
-.ProseMirror h5 {
-  font-size: 1rem;
-}
-
-.ProseMirror h6 {
-  font-size: .95rem;
-}
-
-.ProseMirror a {
-  color: var(--meowdown-accent);
-  text-underline-offset: 2px;
-  text-decoration: underline 1px;
-}
-
-.ProseMirror code {
-  font-family: var(--meowdown-font-mono);
-  background: color-mix(in oklab, var(--meowdown-accent) 10%, transparent);
-  color: color-mix(in oklab, var(--meowdown-accent) 80%, var(--meowdown-heading));
-  border-radius: .35rem;
-  padding: .1em .35em;
-  font-size: .9em;
-}
-
-.ProseMirror blockquote {
-  border-left: 3px solid color-mix(in oklab, var(--meowdown-accent) 35%, transparent);
-  color: var(--meowdown-muted);
-  margin-left: 0;
-  padding-left: 1rem;
-  font-style: italic;
-}
-
-.ProseMirror ul, .ProseMirror ol {
-  padding-left: 1.5rem;
-}
-
-.ProseMirror ul {
-  list-style: outside;
-}
-
-.ProseMirror ol {
-  list-style: decimal;
-}
-
-.ProseMirror li {
-  margin-top: .25em;
-}
-
-.ProseMirror pre {
-  background: var(--meowdown-code-bg);
-  font-family: var(--meowdown-font-mono);
-  border-radius: .6rem;
-  padding: .9rem 1rem;
-  font-size: .9em;
-  line-height: 1.5;
-  overflow-x: auto;
-}
-
-.ProseMirror pre code {
-  color: inherit;
-  background: none;
-  padding: 0;
-}
-
-.ProseMirror pre code .tok-keyword {
-  color: light-dark(#cf222e, #ff7b72);
-}
-
-.ProseMirror pre code .tok-comment {
-  color: light-dark(#6e7781, #8b949e);
-  font-style: italic;
-}
-
-.ProseMirror pre code .tok-string, .ProseMirror pre code .tok-url {
-  color: light-dark(#0a3069, #a5d6ff);
-}
-
-.ProseMirror pre code .tok-number, .ProseMirror pre code .tok-bool, .ProseMirror pre code .tok-atom, .ProseMirror pre code .tok-literal {
-  color: light-dark(#0550ae, #79c0ff);
-}
-
-.ProseMirror pre code .tok-className, .ProseMirror pre code .tok-typeName, .ProseMirror pre code .tok-namespace {
-  color: light-dark(#953800, #ffa657);
-}
-
-.ProseMirror pre code .tok-definition {
-  color: light-dark(#8250df, #d2a8ff);
-}
-
-.ProseMirror pre code .tok-macroName, .ProseMirror pre code .tok-meta, .ProseMirror pre code .tok-inserted {
-  color: light-dark(#116329, #7ee787);
-}
-
-.ProseMirror pre code .tok-invalid, .ProseMirror pre code .tok-deleted {
-  color: light-dark(#82071e, #ffa198);
-}
-
-.ProseMirror pre code .tok-heading {
-  color: light-dark(#0550ae, #79c0ff);
-  font-weight: 600;
-}
-
-.ProseMirror pre code .tok-strong {
-  font-weight: 600;
-}
-
-.ProseMirror pre code .tok-emphasis {
-  font-style: italic;
-}
-
-.ProseMirror pre code .tok-link {
-  text-decoration: underline;
-}
-
-.ProseMirror hr {
-  border: none;
-  border-top: 1px solid var(--meowdown-border);
-  margin: 1.5em 0;
-}
-
-.ProseMirror table {
-  border-collapse: collapse;
-  table-layout: fixed;
-  width: 100%;
-  overflow: hidden;
-}
-
-.ProseMirror td, .ProseMirror th {
-  box-sizing: border-box;
-  border: 1px solid var(--meowdown-border);
-  vertical-align: top;
-  text-align: left;
-  padding: .4rem .75rem;
-}
-
-.ProseMirror th {
-  color: var(--meowdown-heading);
-  background: var(--meowdown-table-header-bg);
-  font-weight: 600;
-}
-
-.ProseMirror table.ProseMirror-selectednode td, .ProseMirror table.ProseMirror-selectednode th {
-  border-color: var(--meowdown-node-outline);
-}
-
-.ProseMirror .selectedCell {
-  border: 1px double var(--meowdown-node-outline);
-  background: var(--meowdown-node-selection);
-  --meowdown-selection: transparent;
-  caret-color: #0000;
-}
-
-.ProseMirror ::selection {
-  background: var(--meowdown-selection);
-}
-
-.ProseMirror .ProseMirror-selectednode {
-  --meowdown-selection: transparent;
-  outline: 1px solid var(--meowdown-node-outline);
-  background: var(--meowdown-node-selection);
-  border-radius: 2px;
-}
-
-.ProseMirror pre.ProseMirror-selectednode {
-  border-radius: .6rem;
-}
-
-.ProseMirror.prosekit-dragging {
-  --meowdown-node-selection: transparent;
-}
-
-.ProseMirror .md-tag {
-  background: color-mix(in oklab, var(--meowdown-accent) 10%, transparent);
-  color: color-mix(in oklab, var(--meowdown-accent) 80%, var(--meowdown-heading));
-  border-radius: .35rem;
-  padding: .1em .35em;
-}
-
-.ProseMirror .md-wikilink {
-  color: var(--meowdown-accent);
-  text-underline-offset: 2px;
-  cursor: pointer;
-  text-decoration: underline 1px dashed;
-}
-
-.ProseMirror .md-image {
-  display: block;
-}
-
-.ProseMirror .md-image img {
-  max-height: var(--meowdown-image-max-height, 24rem);
-  border-radius: var(--meowdown-image-radius, .5rem);
-  max-width: 100%;
-}
-
-.ProseMirror .prosekit-placeholder:before {
-  content: attr(data-placeholder);
-  float: left;
-  pointer-events: none;
-  height: 0;
-  color: var(--meowdown-placeholder, var(--meowdown-muted));
-}
-
-.ProseMirror .md-mark, .ProseMirror .md-link-uri {
-  color: var(--meowdown-mark);
-  opacity: .7;
-}
-
-.ProseMirror[data-mark-mode="hide"] .md-mark, .ProseMirror[data-mark-mode="hide"] .md-link-uri, .ProseMirror[data-mark-mode="focus"] .md-mark, .ProseMirror[data-mark-mode="focus"] .md-link-uri {
-  display: none;
-}
-
-.ProseMirror[data-mark-mode="focus"] .md-mark:has(.show), .ProseMirror[data-mark-mode="focus"] .md-link-uri:has(.show) {
-  display: inline;
-}
-
 .meowdown {
   flex-direction: column;
   flex: 1 0 auto;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@meowdown/react",
   "type": "module",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -28,7 +28,7 @@
     "@prosekit/pm": "^0.1.18",
     "@prosekit/react": "^0.8.0-beta.0",
     "clsx": "^2.1.1",
-    "@meowdown/core": "0.5.0"
+    "@meowdown/core": "0.7.0"
   },
   "peerDependencies": {
     "react": "^19.0.0",