Interface FrameworkPluginConstructor

Framework provider plugin constructor.

interface FrameworkPluginConstructor {
    new FrameworkPluginConstructor<ComponentType>(): FrameworkPlugin<
        ComponentType,
    >;
    new FrameworkPluginConstructor(): Plugin;
    icon: PluginComponent;
    instance: FrameworkPlugin<any>;
    logo?: string;
    menu: PluginComponent;
    name: string;
    prototype: PluginPrototype;
    thumb?: string;
    component(
        component: unknown,
        props?: Record<string, unknown>,
    ): PluginComponent;
    patch<
        Name extends keyof TargetList,
        Base extends AppConstructor | GameConstructor,
        Mixin extends AppConstructor | GameConstructor,
    >(
        name: Name,
        base: Base,
        apply: TargetApply<Base, Mixin>,
    ): Target<Mixin>;
    translations<T extends BasePluginTranslation>(
        data: Record<Locales, T>,
    ): PluginI18n<T>;
}

Hierarchy (View Summary)

PluginConstructor
- FrameworkPluginConstructor

Index

Constructors

Properties

icon instance logo? menu name prototype thumb?

Methods

component patch translations

Constructors

constructor

new FrameworkPluginConstructor<ComponentType>(): FrameworkPlugin<ComponentType>
Type Parameters
- ComponentType
Returns FrameworkPlugin<ComponentType>
Inherited from PluginConstructor.constructor
- Defined in packages/types/src/duplicis.d.ts:300
new FrameworkPluginConstructor(): Plugin
Plugin constructor

Returns Plugin
Inherited from PluginConstructor.constructor
- Defined in packages/types/src/duplicis.d.ts:297

Properties

`Readonly`icon

icon: PluginComponent

Plugin sidebar icon.

instance

instance: FrameworkPlugin<any>

Plugin instance.

`Optional` `Readonly`logo

logo?: string

Logo image.

`Readonly`menu

menu: PluginComponent

Plugin sidebar menu.

`Readonly`name

name: string

Plugin name.

`Readonly`prototype

prototype: PluginPrototype

`Optional` `Readonly`thumb

thumb?: string

Logo image.

Methods

component

component(component: unknown, props?: Record<string, unknown>): PluginComponent
Create framework component.
Parameters
- component: unknown
  Framework component.
- Optionalprops: Record<string, unknown>
  Component props.
Returns PluginComponent
Duplicis plugin component.
Overrides PluginConstructor.component
- Defined in packages/types/src/duplicis.d.ts:308

patch

patch<
    Name extends keyof TargetList,
    Base extends AppConstructor | GameConstructor,
    Mixin extends AppConstructor | GameConstructor,
>(
    name: Name,
    base: Base,
    apply: TargetApply<Base, Mixin>,
): Target<Mixin>
Apply mixin patch.
Type Parameters
- Name extends keyof TargetList
- Base extends AppConstructor | GameConstructor
- Mixin extends AppConstructor | GameConstructor
Parameters
- name: Name
  Target name.
- base: Base
  Base class.
- apply: TargetApply<Base, Mixin>
  Mixin function.
Returns Target<Mixin>
Modified target.
Inherited from PluginConstructor.patch
- Defined in packages/types/src/duplicis.d.ts:241

translations

translations<T extends BasePluginTranslation>(
data: Record<Locales, T>,
): PluginI18n<T>
Generate plugin translations.
Type Parameters
- T extends BasePluginTranslation
Parameters
- data: Record<Locales, T>
  Translation data.
Returns PluginI18n<T>
Plugin translator.
Inherited from PluginConstructor.translations
- Defined in packages/types/src/duplicis.d.ts:256