Skip to content

CHANGELOG.md

Latest commit

 

History

History
100 lines (86 loc) · 5.92 KB

CHANGELOG.md

File metadata and controls

100 lines (86 loc) · 5.92 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[2.1.3]

Internal

  • Added CI (build, lint, and a pack dry-run) plus bug/feature issue templates and a PR template.
  • Added an ESLint flat config and enabled the lint script; typed away two no-explicit-any in the Lexical plugin.
  • Slimmed down .gitignore to the essentials.

[2.1.2]

Docs

  • README: add notice at the top recommending payload-better-editor as the successor — it covers the same hover / click-to-edit / admin↔preview-sync surface as this plugin and additionally provides a full side-by-side editor (live-preview iframe, native-field sidebar, viewport switching, undo/redo).

[2.1.1]

Change

  • made some repo adjustments

[2.1.0]

Added

  • RichText (Lexical) block sync — full bi-directional sync for blocks embedded inside Lexical richText fields
  • BetterPreviewLexicalFeature — server feature that stamps data-block-id onto every block decorator element in the Lexical editor DOM; exported from payload-better-preview
  • BetterPreviewClientFeature — client feature exported from payload-better-preview/lexical
  • data-preview-ignore attribute — add to any element (in preview or in admin custom block components) to prevent clicks on it from triggering scroll sync in either direction
  • New message types: scroll-to-richtext-block, focus-richtext-block, scroll-to-richtext-nested-block; optional richTextBlockId field on FocusBlockMessage

Fixed

  • Fixed live preview iframe detection for Payload 3.81+ which no longer sets the live-preview-iframe class on the iframe element; selector now checks ID first (iframe#live-preview-iframe) with fallbacks for older versions

Compatibility

  • BetterPreviewLexicalFeature requires Payload 3.81+ — on older versions the plugin component is rendered outside of the LexicalComposerContext during SSR and throws. The core block sync (hover, layout blocks, Admin ↔ Preview sync) still works on Payload ^3.0.0; only the new richText-block sync is gated on 3.81+.

[2.0.0] 2026-03-23

Added

  • Nested block support — bi-directional sync works at any block nesting depth, ancestor rows are automatically expanded
  • Customizable accent color via accentColor option (plugin config and <BetterPreview /> prop)
  • Scroll alignment via scrollAlign option ('start' | 'center' | 'end')
  • Scroll offset via scrollOffset option (px) — accounts for fixed headers or admin toolbar
  • Toggle button in the preview iframe to enable/disable block sync
  • showToggle prop to hide the built-in toggle button
  • toggleComponent prop for rendering a custom toggle UI
  • ToggleProps type export from payload-better-preview/client
  • Origin validation on postMessage — messages are only accepted from the preview iframe

Changed

  • BREAKING: Block wrapper elements now require a data-block-field attribute containing the Payload field path (e.g. "layout")
  • BREAKING: Message protocol now includes a mandatory field property in scroll-to-block and focus-block messages
  • Replaced hardcoded ROW_ID_PREFIX with generic regex-based row ID parsing — supports arbitrary field names
  • Colors are now generated dynamically via makeColors() using color-mix() instead of static RGBA values
  • Plugin options are passed as clientProps to AdminBlockSyncProvider instead of using a plain string provider path

Fixed

  • Clicking the collapse toggle in the admin no longer triggers a scroll-to-block message

[1.0.1] 2026-02-27

Fixed

  • Fixed exports in package.json pointing to src/ instead of dist/, causing "Module not found" errors when installed from npm

[1.0.0] 2026-02-27

Changed

  • BREAKING: Renamed PreviewToolbar to BetterPreview — update imports to import { BetterPreview } from 'payload-better-preview/client'

Fixed

  • Added .d.ts type declarations to published package

[0.3.2] 2026-02-27

Changed

  • Prepared npm publish

[0.3.1] 2026-02-26

Changed

  • Flattened src/ structure: removed components/, exports/, shared/ subdirectories
  • Extracted shared constants (COLORS, FLASH_DURATION, attribute names) into constants.ts
  • Extracted DOM helper functions (createOverlay, createLabel, positionOverlay, etc.) into overlay.ts
  • Replaced hardcoded color values in AdminBlockSyncProvider with shared COLORS constants
  • Removed unused refs (overlayRef, parentOverlayRef, labelRef) from PreviewToolbar

[0.3.0] 2026-02-26

Added

  • Preview → Admin sync: clicking a block in the preview scrolls the admin editor to the corresponding block row
  • Auto-expand collapsed blocks when focused from preview
  • Flash highlight on the admin block row (blue box-shadow, 1.5s fade-out)
  • cursor: pointer on hoverable blocks in preview
  • FocusBlockMessage type and isFocusBlockMessage() type guard in shared message protocol

[0.2.0] 2026-02-26

Added

  • Admin → Preview sync: clicking a block row in the admin editor scrolls the preview to that block
  • Flash highlight effect on synced block (blue overlay, 1.5s fade-out)
  • AdminBlockSyncProvider component, auto-injected into admin UI
  • Shared message protocol (better-preview:scroll-to-block) via postMessage

[0.1.0] 2026-02-26

Added

  • Hover highlighting with blue overlay on blocks
  • Block label badge showing #N BlockType (e.g. #3 Headline)
  • Named block support, label includes block name: #3 Headline "My Title"
  • Nested block detection with parent dashed overlay and breadcrumb label (#2 Columns › #1 Text)
  • Scroll and resize tracking, overlay follows block position smoothly
  • Draft-only rendering, zero impact on published pages
  • Plugin config with disabled option
  • <PreviewToolbar /> client component with event-delegation-based interaction