Feature/user widgets

[gitworkflows]

Category:

One of: Bugfix / Feature / Code style update / Refactoring Only / Build related changes / Documentation / Other (please specify)

Overview

Briefly outline your new changes...

Issue Number (if applicable) #00

New Vars (if applicable)

If you've added any new build scripts, environmental variables, config file options, dependency or devDependency, please outline here

Screenshot (if applicable)

If you've introduced any significant UI changes, please include a screenshot

Code Quality Checklist (Please complete)

• All changes are backwards compatible
• All lint checks and tests are passing
• There are no (new) build warnings or errors
• (If a new config option is added) Attribute is outlined in the schema and documented
• (If a new dependency is added) Package is essential, and has been checked out for security or performance
• (If significant change) Bumps version in package.json

Summary by Sourcery

Add support for user-defined custom widgets in the application by allowing users to append their custom components to the existing widget list. Clean up the WidgetBase.vue component by removing unused imports.

New Features:

• Introduce the ability for users to append custom widgets to the existing widget list in the application.

Enhancements:

• Remove unused import statements from the WidgetBase.vue component.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces a new feature for user widgets, enhancing the flexibility of the widget system. The main changes include the addition of custom user-defined widgets and some minor adjustments to the Docker configuration.

Sequence diagram for appending user custom components

sequenceDiagram
    participant User
    participant WidgetBase
    participant AppConfig
    participant COMPAT

    User->>WidgetBase: Load widget
    WidgetBase->>WidgetBase: appendUserCustomComponents()
    WidgetBase->>AppConfig: Check for customWidgets
    alt customWidgets exist
        AppConfig-->>WidgetBase: Return customWidgets
        WidgetBase->>COMPAT: Add custom widgets to COMPAT
    else
        AppConfig-->>WidgetBase: Return null
    end
    WidgetBase-->>User: Display widget

Loading

Class diagram for WidgetBase.vue modifications

classDiagram
    class WidgetBase {
        - ErrorHandler errorHandler
        - Button button
        - UpdateIcon updateIcon
        + appendUserCustomComponents()
        + component()
    }
    note for WidgetBase "appendUserCustomComponents method added to handle custom widgets"

Loading

File-Level Changes

Change	Details	Files
Added support for custom user-defined widgets	Implemented a new method 'appendUserCustomComponents' to add custom widgets to the COMPAT object Modified the 'component' computed property to call 'appendUserCustomComponents' before determining the widget type Added logic to check for custom widgets in the appConfig and append them to the COMPAT object	src/components/Widgets/WidgetBase.vue
Removed unnecessary comment and adjusted Docker configuration	Removed a comment about importing form elements, icons, and utils Removed the 'version' field from the docker-compose.yml file	src/components/Widgets/WidgetBase.vue docker-compose.yml

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.