Skip to content

Design clean public API for extension authors to integrate custom widgets with widgetValueStore #9296

@coderabbitai

Description

@coderabbitai

Context

PR #9230 introduces useDomValueBridge to synchronize DOM widget values with the widgetValueStore by intercepting Object.defineProperty on element.value and listening for input events. While this approach works as a bridge for extension-created DOM widgets, it relies on internal value-descriptor patterns that are not part of a supported public API.

Problem

Extension authors currently lack a clean, documented integration point to wire custom widgets to the widgetValueStore. The current value-descriptor pattern is an implementation detail rather than a stable extension API.

Proposed Solution

Design and implement a proper public API that:

  • Provides a clear, documented way for extension authors to integrate custom widgets with the store
  • Replaces the current value-descriptor pattern with a supported integration mechanism
  • Maintains backward compatibility where feasible
  • Includes documentation and migration guidance

References

Acceptance Criteria

  • Public API design documented
  • Extension author documentation created
  • Deprecation path defined for current pattern (if applicable)
  • Implementation plan outlined

┆Issue is synchronized with this Notion page by Unito

Metadata

Metadata

Labels

Public APIAffects or interacts with the public API surface (affecting custom node or extension authors)

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions