page

package
v0.2.3 Latest Latest
Warning

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

Go to latest
Published: Sep 25, 2026 License: MIT Imports: 2 Imported by: 0

Documentation

Overview

Package page registers the built-in `page` type: the plain document.

Hidden, no properties, one part — `body` — whose dataset is the editor module's shared collection, so an object of type `page` holds `editor_blocks` (docs/03-api.md § Parts and modules). Every object has exactly one type; `page` is the answer for a plain document, a client's own document types with an editor part share the same collection. Nothing stamps it: a client decides the type of each object it creates.

Registered, not a bundle: the id is reserved and the declaration static, so every space has it by construction and no install can fork. The price is the registered-type freeze — no properties, no weight, no layout; a client that needs those declares a user type.

Index

Constants

View Source
const (
	// TypeId is reserved — content-addressable user type ids never
	// produce it, and the xKey guard refuses user types claiming it.
	TypeId      = "page"
	Name        = "Page"
	Description = "A document: one body in the shared editor collection"

	// PartBody is the type's single part; its dataset is the editor's
	// canonical collection.
	PartBody = "body"
)

Variables

This section is empty.

Functions

func NewType

func NewType() handler.Type

NewType returns the handler.Type to add to config.Config.Types (see internal/server/sdk.go). The SDK compiles the static part into ownership of the editor's canonical collection on every space: the write gate, discovery (`owners` of `editor_blocks`) and the parts read follow from the declaration.

Types

This section is empty.

Jump to

Keyboard shortcuts

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