Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Context


Current problems:

No



Decission


If we want OpenSCD to be extendable, we should allow OpenSCD to support `addons`.  An addon is like a plugin, but without the requirement of needing to extend from `HTMLElement`. An `addon` is a default exported function from a file.
an `addon` function gets the `OpenSCD` class as a parameter. from here, it can fetch the document if needed. it can also subscribe to events dispatched to `open-scd`.
By implementing addons, we can minimize the risk of people forking OpenSCD and adding new functionality. If people want extra functionality on OpenSCD, they can create an addon for it.

...

When `addons` or `background plugins` are supported, it will be possible to migrate current mixins from OpenSCD into `addons` or `background plugins`.

## Pros and Cons


An `addon` is a function that's not depending on anything.
The `addon` function gets the `OpenSCD` instance class as a parameter.



Alternatives

### Background plugin


#### Pros
It can use the current `plugin` mechanism to load.
#### Cons
- A background plugin is extending from `HTMLElement` but it's not rendering anything. This goes against the `CustomElement` principles.
- The dom can get polluted quickly by creating background plugins

### Addons
#### Pros
An `addon` is a function that's not depending on anything.
The `addon` function gets the `OpenSCD` instance class as a parameter.

...


Conserquences

`Addons` need to be loaded apart from `plugins` .