embeddedplugin

package
v0.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 11, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Overview

Package embeddedplugin is a small structured-outline plugin used by the embedded authoring reference and cross-surface contract tests. Its envelope deliberately differs from a rich-text editor document.

Index

Constants

View Source
const Key = "outline"

Variables

This section is empty.

Functions

func Field

func Field(name string, types ...field.Block) field.PluginField

func Value

func Value(nodes ...store.Value) store.Value

func Widget

func Widget(kind, key string, payload store.Values) store.Value

Types

type Document

type Document[T any] struct {
	Outline []Node[T] `json:"outline"`
}

Document and Node are portable envelope types; T is the generated payload union for this field placement, never a plugin-owned field engine.

type Node

type Node[T any] struct {
	Kind    string    `json:"kind"`
	Items   []Node[T] `json:"items,omitempty"`
	Content *T        `json:"content,omitempty"`
}

type Plugin

type Plugin struct{}

func (Plugin) Descriptor

func (Plugin) Descriptor() ridu.PluginDescriptor

func (Plugin) FieldValidators

func (Plugin) FieldValidators() map[string]ridu.PluginFieldValidator

func (Plugin) Key

func (Plugin) Key() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL