@astrolabe/editor

The editor-agnostic authoring kit: createAuthoring, the insert menu, inspector, issues and preview elements, and the textarea adapter.

Classes

AstlInsertMenu

<astl-insert-menu>: what authors can add, in named groups: "Components" (each type with its default template), "Exercises" (the types' named starters, when any) and "Content" ("Picture", which asks for the picture in a dialog). Each button's name is its label and description, as shown; a press inserts at the cursor.

Extends

• AuthoringElement

Constructors

Constructor

new AstlInsertMenu(): AstlInsertMenu;

Returns

AstlInsertMenu

Inherited from

AuthoringElement.constructor

Properties

Property	Type
adapter	EditorAdapter | null
authoring	Authoring | null

Methods

insert()

insert(
   tag,
   template?,
   picture?
): string | null;

Inserts a new element of tag at the cursor: its default template, or the named starter template; with picture, the element takes it (a type whose zones or pins sit on a picture: its picture field's address, its alt text and size). An element whose companion the document lacks brings it at the end (the word bank of a first gap); the cursor stays on the new element. Returns its source HTML, or null without authoring or adapter.

Parameters

Parameter	Type
tag	string
template?	string
picture?	PictureFields

Returns

string | null

insertPicture()

insertPicture(): Promise<string | null>;

Asks for a picture in the dialog and inserts it at the cursor. Resolves with its HTML, or null when cancelled.

Returns

Promise<string | null>

---

AstlInspector

<astl-inspector>: a form for the component at the cursor (answers, alternatives, correct options, whether each statement is true, the category of each card, scoring, points, variant, look), or, with the cursor outside every component, the document's own settings (its look). Every edit goes through authoring.update and the adapter (replaceElement, or setSource for the document), so the editor stays the source of truth.

Extends

• AuthoringElement

Constructors

Constructor

new AstlInspector(): AstlInspector;

Returns

AstlInspector

Inherited from

AuthoringElement.constructor

Properties

Property	Type
adapter	EditorAdapter | null
authoring	Authoring | null

Accessors

model

Get Signature

get model():
  | InspectorModel
  | null;

The inspector model on screen (a component's, or the document's), or null.

Returns

| InspectorModel | null

---

AstlIssues

<astl-issues>: live validation of the whole document in the UI locale, errors first. Selecting an issue moves the editor's cursor to its element (adapter.select).

Extends

• AuthoringElement

Constructors

Constructor

new AstlIssues(): AstlIssues;

Returns

AstlIssues

Inherited from

AuthoringElement.constructor

Properties

Property	Type
adapter	EditorAdapter | null
authoring	Authoring | null

Accessors

issues

Get Signature

get issues(): readonly Issue[] | null;

The issues on screen (null before the first validation).

Returns

readonly Issue[] | null

Methods

validate()

validate(): void;

Validates now instead of waiting for the debounce.

Returns

void

---

AstlPictureDialog

<astl-picture-dialog>: asks for a picture in a modal dialog: a file, uploaded with the host's uploadAsset, or an address (the only way without one, as it says); the alt text, required unless the picture is decorative (alt=""); and, for a new picture, an optional caption. The address must pass the authoring's URL policy, an uploaded one too. ask resolves with the fields, or null when the author cancels.

Extends

• AuthoringElement

Constructors

Constructor

new AstlPictureDialog(): AstlPictureDialog;

Returns

AstlPictureDialog

Inherited from

AuthoringElement.constructor

Properties

Property	Type
adapter	EditorAdapter | null
authoring	Authoring | null

Methods

ask()

ask(request?): Promise<
  | PictureFields
| null>;

Opens the dialog. Resolves with the picture's fields, or null when the author cancels.

Parameters

Parameter	Type
request?	PictureRequest

Returns

Promise< | PictureFields | null>

---

AstlPictureField

<astl-picture-field>: the inspector's picture-regions and picture-points fields. The picture (by address, or uploaded with the host's uploadAsset) with its zones or pins drawn on it in palette colours and numbered; drag on it to draw a zone, click to place a pin; and every value in number fields, so nothing needs a pointer. Changes go to the inspector as astl-field-change events.

Extends

• LitElement

Constructors

Constructor

new AstlPictureField(): AstlPictureField;

Returns

AstlPictureField

Overrides

LitElement.constructor

Properties

Property	Type	Description
authoring	Authoring | null	-
element	string | null	The source id of the element the field belongs to (the inspector sets it).
field	Field | null	-

---

AstlPreview

<astl-preview>: a button that compiles the current source with a throw-away salt and plays it in <astl-player> with local grading and the authoring's style templates, the way a student sees it. Invalid sources show their errors instead. Tokens set on the preview reach the player; the player's events stay inside.

Extends

• AuthoringElement

Constructors

Constructor

new AstlPreview(): AstlPreview;

Returns

AstlPreview

Inherited from

AuthoringElement.constructor

Properties

Property	Type
adapter	EditorAdapter | null
authoring	Authoring | null

Accessors

player

Get Signature

get player(): AstlPlayer | null;

The player, once the first preview started.

Returns

AstlPlayer | null

state

Get Signature

get state(): PreviewState;

idle, loading, ready, invalid (errors shown) or failed.

Returns

PreviewState

Methods

refresh()

refresh(): Promise<void>;

Compiles the current source and plays it. Resolves when the player is ready or the errors are shown.

Returns

Promise<void>

Interfaces

Authoring

Properties

Property	Modifier	Type	Description
descriptors	readonly	readonly EditorDescriptor[]	-
elements	readonly	readonly ElementEntry[]	-
engine	readonly	Engine	-
locale	readonly	string	-
styleTemplates	readonly	readonly StyleTemplate[]	-
uploadAsset	readonly	UploadAsset | null	The host's upload, or null: pictures are added by address only.
urlPolicy	readonly	UrlPolicy	-

Methods

assignIds()

assignIds(source): string;

source with fresh ids on pages and components that lack one (or have an empty one).

Parameters

Parameter	Type
source	string

Returns

string

describe()

describe(issue): string;

An issue as a sentence in the authoring locale.

Parameters

Parameter	Type
issue	Issue

Returns

string

descriptor()

descriptor(tag):
  | EditorDescriptor
  | null;

The descriptor of a component tag, or null.

Parameters

Parameter	Type
tag	string

Returns

| EditorDescriptor | null

inspect()

inspect(elementHtml, source?):
  | InspectorModel
  | null;

The inspector model of one component element (source HTML), or null for elements it does not know. With the whole document (source), fields offer what other elements hold (the words of the bank a drop takes its words from); without it they show the attribute's own control.

Parameters

Parameter	Type
elementHtml	string
source?	string

Returns

| InspectorModel | null

inspectDocument()

inspectDocument(source):
  | InspectorModel
  | null;

The document's own settings (its style template) as an inspector model for <astl-doc>, or null when the source has no <astl-doc> root or there is nothing to set. Apply its changes with update(source, change): the first element of the source is the document, so only its start tag changes.

Parameters

Parameter	Type
source	string

Returns

| InspectorModel | null

instantiate()

instantiate(
   tag,
   source,
   templateId?
): string;

The descriptor's template, or its named starter templateId, ready to insert into source: {{id}} becomes <idPrefix>-<n> with the smallest n whose id source does not use, {{t:key}} an escaped message of the manifest namespace, and other components written without an id get fresh ones too. An element of a type with a companion and an empty attribute names the first such element of the template, else of source, else the one withCompanion adds. Throws for a tag without a descriptor or an unknown starter.

Parameters

Parameter	Type
tag	string
source	string
templateId?	string

Returns

string

outline()

outline(source): Outline;

Pages, their components and issue counts.

Parameters

Parameter	Type
source	string

Returns

Outline

preview()

preview(source): Promise<PreviewResult>;

Compiles with a random per-session salt and grades locally. The source is not stored anywhere.

Parameters

Parameter	Type
source	string

Returns

Promise<PreviewResult>

t()

t(
   namespace,
   key,
   params?
): string;

A message in the authoring locale: kit (astl.editor), descriptor, engine and extra catalogs.

Parameters

Parameter	Type
namespace	string
key	string
params?	Readonly<Record<string, string | number>>

Returns

string

templates()

templates(tag): readonly EditorTemplate[];

The named starters of a component tag (EditorDescriptor.templates); none without a descriptor.

Parameters

Parameter	Type
tag	string

Returns

readonly EditorTemplate[]

update()

update(elementHtml, change): string;

The element HTML with one inspector change applied; everything else stays byte-identical.

Parameters

Parameter	Type
elementHtml	string
change	InspectorChange

Returns

string

validate()

validate(source): ValidationReport;

Parameters

Parameter	Type
source	string

Returns

ValidationReport

withCompanion()

withCompanion(tag, source): string | null;

source (with an inserted tag element) and the template of the descriptor's companion at the end of the document (in the last page), when it has no such element yet; else null.

Parameters

Parameter	Type
tag	string
source	string

Returns

string | null

---

AuthoringOptions

Properties

Property	Modifier	Type	Description
catalogs?	readonly	readonly MessageCatalog[]	More or overriding catalogs (any namespace), e.g. another UI locale.
descriptors	readonly	readonly EditorDescriptor[]	One per component type authors can insert and inspect. Each tag must be registered in the engine.
elements?	readonly	readonly ElementEntry[]	Player elements for <astl-preview>, eager or lazy.
engine	readonly	Engine	-
locale	readonly	string	The author's UI locale: labels, issues, template texts.
styleTemplates?	readonly	readonly StyleTemplate[]	Style templates authors can pick (register the same ones with the engine and the player): the inspector offers them per component and for the whole document, labelled from their catalogs; <astl-preview> renders them.
uploadAsset?	readonly	UploadAsset	Stores a picture file and returns its address (and size): the host's upload, used by the picture dialog, by pictures pasted or dropped into the editor and by picture fields; also by url fields with accept (a video, its captions). The address must pass urlPolicy. Without it, pictures and files are added by address only. signal aborts when the author cancels or picks another file. The file's type is the browser's guess: check type and size on the server, and serve SVG with nosniff.
urlPolicy?	readonly	UrlPolicy	The engine's URL policy (createEngine({ urlPolicy })): the preview's player cleans with it and editors check picture addresses with it before they show them. Default isSafeUrl.

---

CheckboxFieldModel

Extends

• FieldTexts

Properties

Property	Modifier	Type	Description
checked	readonly	boolean	-
control	readonly	"checkbox"	-
help	readonly	string | null	Translated help text, or null.
kind	readonly	"attribute"	-
label	readonly	string	Translated label.
name	readonly	string	-

---

ChildChoiceFieldModel

Extends

• FieldTexts

Properties

Property	Modifier	Type	Description
attribute	readonly	string	-
children	readonly	readonly ChildChoiceModel[]	-
control	readonly	"select" | "radios"	Radios for the enum values of the attribute, a select for the ids of other children (options).
help	readonly	string | null	Translated help text, or null.
kind	readonly	"child-choice"	-
label	readonly	string	Translated label.
tag	readonly	string	-

---

ChildChoiceModel

Properties

Property	Modifier	Type	Description
id	readonly	string | null	-
index	readonly	number	Position among the children with this tag, from 0 (what child-choice changes use).
label	readonly	string	The child's text, or a placeholder when it is empty.
options	readonly	readonly InspectorOption[]	The choices of this child. Enum source: the attribute's values, the same for every child (an absent or unknown value matches none). Child source: each option child's id with its text, plus the "not set" option when the value is absent and the written value itself when it names no option (so the control shows what the source says).
value	readonly	string	The written value; '' when absent.

---

ChildFlagFieldModel

Extends

• FieldTexts

Properties

Property	Modifier	Type	Description
attribute	readonly	string	-
children	readonly	readonly ChildFlagModel[]	-
help	readonly	string | null	Translated help text, or null.
kind	readonly	"child-flag"	-
label	readonly	string	Translated label.
tag	readonly	string	-

---

ChildFlagModel

Properties

Property	Modifier	Type	Description
checked	readonly	boolean	-
id	readonly	string | null	-
index	readonly	number	Position among the children with this tag, from 0 (what child-flag changes use).
label	readonly	string	The child's text, or a placeholder when it is empty.

---

ChildTextFieldModel

Extends

• FieldTexts

Properties

Property	Modifier	Type	Description
attribute	readonly	string	-
children	readonly	readonly ChildTextModel[]	-
help	readonly	string | null	Translated help text, or null.
kind	readonly	"child-text"	-
label	readonly	string	Translated label.
tag	readonly	string	-

---

ChildTextModel

Properties

Property	Modifier	Type	Description
id	readonly	string | null	-
index	readonly	number	Position among the children with this tag, from 0 (what child-attributes changes use).
label	readonly	string	The child's text, or a placeholder when it is empty.
value	readonly	string	The written value; '' when absent.

---

FieldChange

A change of the field, and the source id of the element it is for (an upload may end after the cursor moved).

Properties

Property	Modifier	Type
change	readonly	InspectorChange
element	readonly	string | null

---

InspectorModel

Properties

Property	Modifier	Type	Description
fields	readonly	readonly InspectorFieldModel[]	-
icon	readonly	string | null	Icon name from the descriptor.
id	readonly	string | null	-
label	readonly	string	Translated menu label of the type (the tag when there is no descriptor).
tag	readonly	string	-

---

InspectorOption

Properties

Property	Modifier	Type
label	readonly	string
value	readonly	string

---

NumberFieldModel

Extends

• FieldTexts

Properties

Property	Modifier	Type	Description
control	readonly	"number"	-
help	readonly	string | null	Translated help text, or null.
kind	readonly	"attribute"	-
label	readonly	string	Translated label.
max	readonly	number | null	-
min	readonly	number | null	-
name	readonly	string	-
required	readonly	boolean	-
step	readonly	"any" | "1"	1 for integers.
value	readonly	string	The written value, else the manifest default; '' when neither.

---

Outline

Properties

Property	Modifier	Type	Description
errors	readonly	number	Every issue of the document.
pages	readonly	readonly OutlinePage[]	-
warnings	readonly	number	-

---

OutlineComponent

Properties

Property	Modifier	Type	Description
errors	readonly	number	Issues located on this component or its children.
id	readonly	string | null	-
label	readonly	string	Translated type label (the tag when there is no descriptor).
tag	readonly	string	-
warnings	readonly	number	-

---

OutlinePage

Properties

Property	Modifier	Type	Description
components	readonly	readonly OutlineComponent[]	-
errors	readonly	number	Issues located on the page, its content and its components.
id	readonly	string | null	null for the implicit page of a document without pages.
label	readonly	string | null	-
warnings	readonly	number	-

---

PictureFields

A picture as the picture dialog asks for it: alt is '' for a decorative picture.

Properties

Property	Modifier	Type	Description
alt	readonly	string	-
caption?	readonly	string	A caption makes the picture a figure.
height?	readonly	number	-
src	readonly	string	-
width?	readonly	number	-

---

PicturePointModel

One pin of a picture-points field, in percent of the picture.

Properties

Property	Modifier	Type
id	readonly	string
index	readonly	number
label	readonly	string
x	readonly	number
y	readonly	number

---

PicturePointsFieldModel

Extends

• PictureFieldBase

Properties

Property	Modifier	Type	Description
elementTag	readonly	string	The tag of the element with the picture: the URL policy is asked for its srcAttribute, as the engine does.
help	readonly	string | null	Translated help text, or null.
kind	readonly	"picture-points"	-
label	readonly	string	Translated label.
points	readonly	readonly PicturePointModel[]	-
src	readonly	string	-
srcAttribute	readonly	string	The element's attribute with the picture's address, and its value ('' when absent).
tag	readonly	string	-

---

PictureRegionModel

One zone of a picture-regions field, in percent of the picture (absent or invalid numbers read as 0).

Properties

Property	Modifier	Type	Description
flagged	readonly	boolean	Whether the zone has the field's flag (a right place): drawn solid, the others dashed.
height	readonly	number	-
id	readonly	string	-
index	readonly	number	Position among the children with the field's tag, from 0 (what child-* changes use).
label	readonly	string	-
points	readonly	readonly (readonly [number, number])[]	-
r	readonly	number	-
shape	readonly	PictureShape	-
width	readonly	number	-
x	readonly	number	-
y	readonly	number	-

---

PictureRegionsFieldModel

Extends

• PictureFieldBase

Properties

Property	Modifier	Type	Description
elementTag	readonly	string	The tag of the element with the picture: the URL policy is asked for its srcAttribute, as the engine does.
flag	readonly	string | null	The boolean attribute of a child-flag field on the same child tag (a hotspot's right places), whose zones are drawn solid and the others dashed; null without one (every zone solid).
help	readonly	string | null	Translated help text, or null.
kind	readonly	"picture-regions"	-
label	readonly	string	Translated label.
regions	readonly	readonly PictureRegionModel[]	-
shapes	readonly	readonly PictureShape[]	The shapes a zone may take: the values of the child's shape enum, or rectangles only when it has no shape (then no shape is written).
src	readonly	string	-
srcAttribute	readonly	string	The element's attribute with the picture's address, and its value ('' when absent).
tag	readonly	string	-

---

PictureRequest

What ask opens the dialog with.

Properties

Property	Modifier	Type	Description
altRequired?	readonly	boolean	The picture carries the task (a component's): its alt text is required, with no decorative choice.
caption?	readonly	boolean	Whether to ask for a caption (a new picture). Default: true for a new picture, false for an edit.
current?	readonly	PictureFields	A picture to edit: its address, alt text and size. Absent: a new picture.
decorative?	readonly	boolean	Whether current is decorative; default: when its alt text is empty.
file?	readonly	File	A file to upload first (pasted or dropped), through the authoring's uploadAsset.
target?	readonly	object	The element and attribute the address is for, as the URL policy is asked; default img and src.
target.attribute	readonly	string	-
target.tag	readonly	string	-

---

ScannedElement

A page or a component found by scanElements. Offsets index into the scanned string.

Properties

Property	Modifier	Type	Description
end	readonly	number	-
id	readonly	string | null	The id attribute (entities decoded), or null when absent.
start	readonly	number	-
tag	readonly	string	-

---

SelectFieldModel

Extends

• FieldTexts

Properties

Property	Modifier	Type	Description
control	readonly	"select"	-
help	readonly	string | null	Translated help text, or null.
kind	readonly	"attribute"	-
label	readonly	string	Translated label.
name	readonly	string	-
options	readonly	readonly InspectorOption[]	-
value	readonly	string	The written value, else the default; '' (the "not set" option) when neither.

---

TextareaAdapter

What a WYSIWYG integration must provide so the authoring kit can drive it. Everything is in source HTML (the <astl-doc> format), so an adapter is free to use any internal model.

Extends

• EditorAdapter

Methods

destroy()

destroy(): void;

Removes the textarea listeners and every subscription.

Returns

void

getElement()

getElement(id): string | null;

Source HTML of one component element, or null when the id is not in the document.

Parameters

Parameter	Type
id	string

Returns

string | null

Inherited from

EditorAdapter.getElement

getSelection()

getSelection():
  | EditorSelection
  | null;

The component at the cursor, or null.

Returns

| EditorSelection | null

Inherited from

EditorAdapter.getSelection

getSource()

getSource(): string;

The whole document as source HTML.

Returns

string

Inherited from

EditorAdapter.getSource

insert()

insert(html): void;

Inserts a source snippet (an instantiated template) at the cursor.

Parameters

Parameter	Type
html	string

Returns

void

Inherited from

EditorAdapter.insert

onChange()

onChange(listener): () => void;

Subscribe to document changes. Returns an unsubscribe function.

Parameters

Parameter	Type
listener	() => void

Returns

() => void

Inherited from

EditorAdapter.onChange

onSelectionChange()

onSelectionChange(listener): () => void;

Subscribe to selection changes. Returns an unsubscribe function.

Parameters

Parameter	Type
listener	(selection) => void

Returns

() => void

Inherited from

EditorAdapter.onSelectionChange

replaceElement()

replaceElement(id, html): void;

Replaces one component element in place (inspector edits); the rest of the document is untouched.

Parameters

Parameter	Type
id	string
html	string

Returns

void

Inherited from

EditorAdapter.replaceElement

select()

select(id): void;

Moves the cursor to an element by source id (a component or a page) and focuses the editor.

Parameters

Parameter	Type
id	string

Returns

void

Inherited from

EditorAdapter.select

setSource()

setSource(source): void;

Replaces the whole document.

Parameters

Parameter	Type
source	string

Returns

void

Inherited from

EditorAdapter.setSource

wrap()?

optional wrap(tag): boolean;

Runs the wrap command of the type tag (EditorDescriptor.wrap) on the selection and focuses the editor; returns whether the document changed. Absent: the editor offers no such command.

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

EditorAdapter.wrap

---

TextFieldModel

Extends

• FieldTexts

Properties

Property	Modifier	Type	Description
accept	readonly	string | null	A url attribute's files to upload (the field's accept), or null: the address is typed.
control	readonly	"text"	-
help	readonly	string | null	Translated help text, or null.
kind	readonly	"attribute"	-
label	readonly	string	Translated label.
name	readonly	string	-
required	readonly	boolean	-
value	readonly	string	The written value; '' when absent.

---

TextListFieldModel

Extends

• FieldTexts

Properties

Property	Modifier	Type	Description
help	readonly	string | null	Translated help text, or null.
kind	readonly	"text-list"	-
label	readonly	string	Translated label.
max	readonly	number | null	null = unbounded.
multiline	readonly	boolean	Each value in a text area that keeps its line breaks.
tag	readonly	string	-
values	readonly	readonly string[]	-

---

UploadedAsset

A stored picture, as uploadAsset returns it: its address, and its size in pixels when known.

Properties

Property	Modifier	Type
height?	readonly	number
src	readonly	string
width?	readonly	number

Type Aliases

InspectorChange

type InspectorChange =
  | {
  kind: "attribute";
  name: string;
  value: string | boolean | null;
}
  | {
  kind: "text-list";
  tag: string;
  values: readonly string[];
}
  | {
  attribute: string;
  index: number;
  kind: "child-flag";
  tag: string;
  value: boolean;
}
  | {
  attribute: string;
  index: number;
  kind: "child-choice";
  tag: string;
  value: string | null;
}
  | {
  attributes: Readonly<Record<string, string | null>>;
  index: number;
  kind: "child-attributes";
  tag: string;
}
  | {
  attributes: Readonly<Record<string, string>>;
  kind: "child-add";
  tag: string;
}
  | {
  index: number;
  kind: "child-remove";
  tag: string;
};

What an inspector control changes. Indexes count children with the same tag, from 0.

Union Members

Type Literal

{
  kind: "attribute";
  name: string;
  value: string | boolean | null;
}

Name	Type	Description
kind	"attribute"	-
name	string	-
value	string | boolean | null	A string sets the value, true writes a bare boolean attribute, false or null removes it.

---

Type Literal

{
  kind: "text-list";
  tag: string;
  values: readonly string[];
}

---

Type Literal

{
  attribute: string;
  index: number;
  kind: "child-flag";
  tag: string;
  value: boolean;
}

---

Type Literal

{
  attribute: string;
  index: number;
  kind: "child-choice";
  tag: string;
  value: string | null;
}

Name	Type	Description
attribute	string	-
index	number	-
kind	"child-choice"	-
tag	string	-
value	string | null	The value to write; null removes the attribute.

---

Type Literal

{
  attributes: Readonly<Record<string, string | null>>;
  index: number;
  kind: "child-attributes";
  tag: string;
}

Name	Type	Description
attributes	Readonly<Record<string, string | null>>	-
index	number	-
kind	"child-attributes"	Several attributes of one child (a zone's shape and coordinates): a string sets one, null removes it.
tag	string	-

---

Type Literal

{
  attributes: Readonly<Record<string, string>>;
  kind: "child-add";
  tag: string;
}

A new empty child with these attributes, after the last child of its tag (or at the end).

---

Type Literal

{
  index: number;
  kind: "child-remove";
  tag: string;
}

Removes one child, its content included.

---

InspectorFieldModel

type InspectorFieldModel =
  | TextFieldModel
  | NumberFieldModel
  | CheckboxFieldModel
  | SelectFieldModel
  | TextListFieldModel
  | ChildFlagFieldModel
  | ChildTextFieldModel
  | ChildChoiceFieldModel
  | ChildTableFieldModel
  | PictureRegionsFieldModel
  | PicturePointsFieldModel;

---

PictureShape

type PictureShape = "rect" | "circle" | "polygon";

---

PreviewResult

type PreviewResult =
  | {
  checker: LocalChecker;
  issues: readonly Issue[];
  ok: true;
  view: string;
}
  | {
  issues: readonly Issue[];
  ok: false;
};

A playable preview, or the issues that block compiling.

Union Members

Type Literal

{
  checker: LocalChecker;
  issues: readonly Issue[];
  ok: true;
  view: string;
}

Name	Type	Description
checker	LocalChecker	Local grading for this preview (practice policy).
issues	readonly Issue[]	Warnings.
ok	true	-
view	string	-

---

Type Literal

{
  issues: readonly Issue[];
  ok: false;
}

---

UploadAsset

type UploadAsset = (file, options) => Promise<UploadedAsset>;

Parameters

Parameter	Type
file	File
options	{ signal: AbortSignal; }
options.signal	AbortSignal

Returns

Promise<UploadedAsset>

Variables

EDITOR_NAMESPACE

const EDITOR_NAMESPACE: "astl.editor" = 'astl.editor';

i18n namespace of the authoring kit's own UI (insert menu, inspector, issues, preview).

---

editorMessages

const editorMessages: readonly MessageCatalog[];

---

FIELD_CHANGE

const FIELD_CHANGE: "astl-field-change" = 'astl-field-change';

Fired with a FieldChange for the inspector to apply.

Functions

createAuthoring()

function createAuthoring(options): Authoring;

Parameters

Parameter	Type
options	AuthoringOptions

Returns

Authoring

---

createTextareaAdapter()

function createTextareaAdapter(textarea): TextareaAdapter;

Parameters

Parameter	Type
textarea	HTMLTextAreaElement

Returns

TextareaAdapter

---

defineAuthoringElements()

function defineAuthoringElements(registry?): void;

Defines <astl-insert-menu>, <astl-inspector>, <astl-issues> and <astl-preview>, and the two they use for pictures, <astl-picture-dialog> and <astl-picture-field> (nothing is defined on import). Safe to call again; a tag already defined by another class throws, as two copies of the kit would otherwise mix silently.

Parameters

Parameter	Type	Default value
registry?	CustomElementRegistry	customElements

Returns

void

---

pictureHtml()

function pictureHtml(picture): string;

The source HTML of a picture: an <img> that sits in text, or with a caption a <figure> that stands on its own. Every value is read once and escaped, and only the attributes of the content format are written.

Parameters

Parameter	Type
picture	PictureFields

Returns

string

---

pictureSize()

function pictureSize(value): number | undefined;

A picture's width or height as the content format takes it: a positive whole number of pixels (a safe integer), from a number or its written form; anything else is no size.

Parameters

Parameter	Type
value	unknown

Returns

number | undefined

---

scanElements()

function scanElements(source): ScannedElement[];

Pages (astl-page) and components in document order, with offsets into source, for text-based adapters. An component is any custom element outside another component (so a misspelt tag is found too); custom elements inside a component are its children. Tolerant of messy input: comments, quoted > in attributes, any case, unclosed or self-closed elements.

Parameters

Parameter	Type
source	string

Returns

ScannedElement[]