Plugin System

[Anatoly03]

This discussion tracks progress on the Torii plugin system, which will be implemented incrementally. Briefly, the idea is to refactor reoccurring patterns into plugins and make the webapp only work with runtime context, while plugins access it and provide extensions to the context.

The first attempt (#20) is closed because it was simply trying out the plugin system.

Expected Capabilities of a Client-Plugin

• Extend view anchors. Plugins should be able to provide custom Vue components and attach them to predefined anchor points. An anchor point is a component placed by the Torii webapp which invokes active plugins to render itself, being empty per default.
• Provide Localization. Plugins should be able to provide extensions to the localisation.
• Provide Styles. Plugins should be able to provide stylistic extension and themes.
• Provide Settings. Plugins should be able to add plugin-settings from a preset of setting types, for example switches representing boolean datatypes and string types (text fields) with access to pattern matching and character limits.
• Access ProseMirror and TipTap. Plugins should be able to access the underlying ProseMirror and TipTap instances and extend them directly.
• TBA

Development Roadmap

Phase 1: Static plugin in the webapp runtime (finished in #24)

• Move torii-client to torii-client/webapp, add a README in torii-client explaining that this contains the webapp and all plugins, as well as core modules.
• Add anchor component.
• Add anchor welcome-sidebar-top instead of recent components.
• Extract recent components to a separate plugin.

Phase 2: TBA

• TBA