You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 5
Next »
The Wizarding Addon is responsible for displaying wizards in OpenSCD. Wizarding could be made in may ways. Libraries allow plug-in editors to choose their own experiences. Plug-in authors can use the OSCD wizard component to make life more easy.
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.
Code wizard
Could be used to display plain SCL files
![](/download/attachments/69764370/image2023-6-30_10-31-54.png?version=1&modificationDate=1688113914498&api=v2)
Overview of the different aspects
eyJleHRTcnZJbnRlZ1R5cGUiOiIiLCJnQ2xpZW50SWQiOiIiLCJjcmVhdG9yTmFtZSI6IlBhc2NhbCBXaWxicmluayIsIm91dHB1dFR5cGUiOiJibG9jayIsImxhc3RNb2RpZmllck5hbWUiOiJQYXNjYWwgV2lsYnJpbmsiLCJsYW5ndWFnZSI6ImVuIiwiZGlhZ3JhbURpc3BsYXlOYW1lIjoiIiwic0ZpbGVJZCI6IiIsImF0dElkIjoiNjk3NjQ3NjEiLCJkaWFncmFtTmFtZSI6Ik9zY2QtV2l6YXJkaW5nIiwiYXNwZWN0IjoiIiwibGlua3MiOiJhdXRvIiwiY2VvTmFtZSI6IldpemFyZGluZyBBZGRvbiIsInRic3R5bGUiOiJ0b3AiLCJjYW5Db21tZW50IjpmYWxzZSwiZGlhZ3JhbVVybCI6IiIsImNzdkZpbGVVcmwiOiIiLCJib3JkZXIiOnRydWUsIm1heFNjYWxlIjoiMSIsIm93bmluZ1BhZ2VJZCI6Njk3NjQzNzAsImVkaXRhYmxlIjpmYWxzZSwiY2VvSWQiOjY5NzY0ODg2LCJwYWdlSWQiOiIiLCJsYm94Ijp0cnVlLCJzZXJ2ZXJDb25maWciOnsiZW1haWxwcmV2aWV3IjoiMSJ9LCJvZHJpdmVJZCI6IiIsInJldmlzaW9uIjoxLCJtYWNyb0lkIjoiNzk2MzQ0ZGMtMjRjMC00YjFmLWE0MTctMDhjZGEwZWZmY2MxIiwicHJldmlld05hbWUiOiJPc2NkLVdpemFyZGluZy5wbmciLCJsaWNlbnNlU3RhdHVzIjoiT0siLCJzZXJ2aWNlIjoiIiwiaXNUZW1wbGF0ZSI6IiIsIndpZHRoIjoiNzgxIiwic2ltcGxlVmlld2VyIjpmYWxzZSwibGFzdE1vZGlmaWVkIjoxNjg4MTEzMzcxMjEzLCJleGNlZWRQYWdlV2lkdGgiOmZhbHNlLCJvQ2xpZW50SWQiOiIifQ==
Technical working
The Wizarding Addon listens to the oscd-wizard
CustomEvent.
The oscd-wizard
events contains the OscdWizard
reference.
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
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.
eyJleHRTcnZJbnRlZ1R5cGUiOiIiLCJnQ2xpZW50SWQiOiIiLCJjcmVhdG9yTmFtZSI6IlBhc2NhbCBXaWxicmluayIsIm91dHB1dFR5cGUiOiJibG9jayIsImxhc3RNb2RpZmllck5hbWUiOiJQYXNjYWwgV2lsYnJpbmsiLCJsYW5ndWFnZSI6ImVuIiwiZGlhZ3JhbURpc3BsYXlOYW1lIjoiIiwic0ZpbGVJZCI6IiIsImF0dElkIjoiNjk3NjQ4MzgiLCJkaWFncmFtTmFtZSI6Ik9zY2QtV2l6YXJkIEFjdGlvbnMiLCJhc3BlY3QiOiIiLCJsaW5rcyI6ImF1dG8iLCJjZW9OYW1lIjoiV2l6YXJkaW5nIEFkZG9uIiwidGJzdHlsZSI6InRvcCIsImNhbkNvbW1lbnQiOmZhbHNlLCJkaWFncmFtVXJsIjoiIiwiY3N2RmlsZVVybCI6IiIsImJvcmRlciI6dHJ1ZSwibWF4U2NhbGUiOiIxIiwib3duaW5nUGFnZUlkIjo2OTc2NDM3MCwiZWRpdGFibGUiOmZhbHNlLCJjZW9JZCI6Njk3NjQ4ODYsInBhZ2VJZCI6IiIsImxib3giOnRydWUsInNlcnZlckNvbmZpZyI6eyJlbWFpbHByZXZpZXciOiIxIn0sIm9kcml2ZUlkIjoiIiwicmV2aXNpb24iOjIsIm1hY3JvSWQiOiIxZmQzYzNhNS0xNWU5LTQ0MmYtYjg5ZS1lYjBjOTNhNTlhNjEiLCJwcmV2aWV3TmFtZSI6Ik9zY2QtV2l6YXJkIEFjdGlvbnMucG5nIiwibGljZW5zZVN0YXR1cyI6Ik9LIiwic2VydmljZSI6IiIsImlzVGVtcGxhdGUiOiIiLCJ3aWR0aCI6IjkyMSIsInNpbXBsZVZpZXdlciI6ZmFsc2UsImxhc3RNb2RpZmllZCI6MTY4ODExNDIwNDY5MiwiZXhjZWVkUGFnZVdpZHRoIjpmYWxzZSwib0NsaWVudElkIjoiIn0=