Wizarding Addon

The Wizarding Addon is responsible for displaying wizards in OpenSCD. Wizarding could be made in many ways. Libraries allow plug-in editors to choose their own experiences. Plug-in authors can use the OSCD wizard component to make life easier.

Principles:

Allow multiple types of wizards
Wizards should be framework independent

Some wizards that are could be frequently used:

Form wizard

Webforms to enter/modify information.

SCL wizard

Can generate wizards based on the SCL XSD schema (not build yet).

Code wizard

Could be used to display plain SCL files

Overview of the different aspects

Technical working

The Wizarding Addon listens to the oscd-wizard CustomEvent.

The oscd-wizard events contains the OscdWizard reference.

oscd-wizard

export interface OscdWizardEventDetail {
    wizard: OscdWizard;
}

export interface OscdWizardEvent extends Event {
    detail: OscdWizardEventDetail;
}

The OscdWizard must be an HTMLElement that contains the open() and close() functions.

The OscdWizard can be viewed below

OscdWizard

export type OscdWizard = HTMLElement & { open(): Promise<void>, close(): Promise<void> }

If you want to create your own wizard, you must adhere to this API.

Wizarding flows from OpenSCD-Core plug-in en OpenSCD-Core plug.

Page tree

Wizarding Addon