Skip to main content

IPluginGroup

API reference

Sometimes we want to group plugins together. For instance, we may want to group the plugins that are related to the same API, or we may want to group the plugins that are related to the same category.

Grouping plugins can be achieved by using the IPluginGroup binding. We've provided a test_plugin_grouop.py file in the tests folder, and here we will break it down for you to understand how IPluginGroup works.

Here's the complete code:

tests/test_plugin_group.py
from cfdraw import *


class Plugin(IFieldsPlugin):
    @property
    def settings(self) -> IPluginSettings:
        return IPluginSettings(
            w=260,
            h=180,
            pluginInfo=IFieldsPluginInfo(
                definitions=dict(foo=ITextField(default="tExT", tooltip="bar"))
            ),
        )

    async def process(self, data: ISocketRequest) -> str:
        return data.extraData["foo"]


class PluginGroup(IPluginGroup):
    @property
    def settings(self) -> IPluginSettings:
        return IPluginSettings(
            w=200,
            h=110,
            pivot=PivotType.RIGHT,
            pluginInfo=IPluginGroupInfo(plugins=dict(bar=Plugin)),
        )


register_plugin("plugins")(PluginGroup)
app = App()

Define Plugin​

In order to use IPluginGroup, we need to define a plugin first. In this example, we utilize the IFieldsPlugin binding to define the Plugin.

tests/test_plugin_group.py
from cfdraw import *


class Plugin(IFieldsPlugin):
    @property
    def settings(self) -> IPluginSettings:
        return IPluginSettings(
            w=260,
            h=180,
            pluginInfo=IFieldsPluginInfo(
                definitions=dict(foo=ITextField(default="tExT", tooltip="bar"))
            ),
        )

    async def process(self, data: ISocketRequest) -> str:
        return data.extraData["foo"]

This plugin is a simple plugin that will always return the user-given foo field.

Define Plugin Group​

Since everything in carefree-drawboard 🎨 is a plugin, IPluginGroup itself is also a plugin. And it is even easier to define an IPluginGroup because it does not contain any Logics, and we only need to specify the Styles. So putting plugins inside a group is pretty straightforward - just specify the corresponding Styles and it will be all set.

tests/test_plugin_group.py
class PluginGroup(IPluginGroup):
    @property
    def settings(self) -> IPluginSettings:
        return IPluginSettings(
            w=200,
            h=110,
            pivot=PivotType.LEFT,
            tooltip="A plugin group",
            pluginInfo=IPluginGroupInfo(plugins=dict(bar=Plugin)),
        )

Here, we specify the Plugin as the only plugin inside the PluginGroup, with the key bar.

tip
  • The key should be unique universally, and it is recommended to use a self-explanatory name.
  • The value of the plugins property should be the class of the plugin, not the instance.

Run​

tests
cfdraw run --module test_plugin_group.py

And here's a demo video of how this plugin / plugin group works:


Last updated on