Skip to content

CHANGELOG.md

Latest commit

 

History

History
73 lines (58 loc) · 3.4 KB

CHANGELOG.md

File metadata and controls

73 lines (58 loc) · 3.4 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.

Unreleased

[1.2.0] - 2026-09-21

Changed

  • sync.fieldUpdate now defaults to true, so live field sync works without opting in; set it to false to keep the save-then-reload flow

Fixed

  • The field-update path no longer logs to the console unless debug is set; these three logs were ungated and are now on by default for every consumer

[1.1.0] - 2026-09-01

Added

  • Scalar list field support (isList updates): String/ID/Enumeration/Int/Float/Boolean/Date/DateTime lists now update live instead of being withheld by Studio
  • data-hygraph-list-index attribute and the listIndex option on createPreviewAttributes, to have each list item patched individually
  • scalarListSync capability in the ready message, which is how Studio decides whether list updates are safe to send
  • preview:field-updated is now emitted after the built-in updater applies a change, and preview:update-failed when it cannot; the update event detail carries componentChain, isList, fieldType, and transformedValue

Changed

  • A whole-list binding renders its items joined with , ; a binding that has child elements is refused (reported via preview:update-failed) rather than having its markup overwritten

[1.0.1] - 2025-11-24

Documentation

  • Enhanced README with comprehensive explanations of data-hygraph-component-chain attribute
  • Added detailed examples for single-level and deeply nested components
  • Clarified the relationship between data-hygraph-entry-id and component chains
  • Added examples for union/modular components with multiple component types
  • Included GraphQL query examples showing how to extract instanceId values
  • Improved component chain documentation with helper function usage examples

1.0.0 - 2024-11-13

Added

  • Initial stable release of Hygraph Preview SDK
  • React component (HygraphPreview) with framework-native refresh support
  • Core JavaScript SDK (Preview) for vanilla JavaScript and custom frameworks
  • Support for Next.js (App Router & Pages Router), Remix, Vue 3, and vanilla JavaScript
  • Data attribute system for marking editable content (data-hygraph-entry-id, data-hygraph-field-api-id)
  • Component chain support for nested and repeatable components
  • Edit button overlays for intuitive content navigation
  • Field focus synchronization with Hygraph Studio
  • Real-time field updates (optional)
  • Event system for save callbacks and content updates
  • TypeScript support with full type definitions
  • Multiple bundle formats (ESM, CommonJS, UMD)
  • Helper functions: createPreviewAttributes, createComponentChainLink, withFieldPath
  • Comprehensive documentation and examples for all supported frameworks

Features

  • Zero-flicker content updates using framework-specific refresh mechanisms
  • Automatic element detection via MutationObserver
  • Dual mode operation (iframe and standalone)
  • Configurable overlay styling and positioning
  • Rich text format preferences (HTML, Markdown, Text)
  • Debug mode for development
  • Customizable allowed origins for security