@companion-module/base
    Preparing search index...

    Interface CompanionSimplePresetDefinition<TManifest>

    interface CompanionSimplePresetDefinition<
        TManifest extends InstanceTypes = InstanceTypes,
    > {
        feedbacks: CompanionPresetFeedback<TManifest["feedbacks"]>[];
        keywords?: string[];
        localVariables?: CompanionSimplePresetLocalVariable[];
        name: string;
        options?: CompanionSimplePresetOptions;
        previewStyle?: Partial<CompanionButtonStyleProps>;
        steps: CompanionButtonStepActions<TManifest>[];
        style: CompanionButtonStyleProps;
        type: "simple";
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    feedbacks keywords? localVariables? name options? previewStyle? steps style type

    Properties

    feedbacks: CompanionPresetFeedback<TManifest["feedbacks"]>[]

    The feedbacks on the button

    keywords?: string[]

    Keywords for the preset This is extra search terms to allow users to find the right preset

    localVariables?: CompanionSimplePresetLocalVariable[]

    Local variables on this button

    name: string

    A name for this preset This is typically shown as a tooltip

    options?: CompanionSimplePresetOptions

    Options for the button produced by this preset

    previewStyle?: Partial<CompanionButtonStyleProps>

    Preview style for preset, will be used in GUI for preview

    steps: CompanionButtonStepActions<TManifest>[]

    The steps of actions for this preset

    style: CompanionButtonStyleProps

    The base style of this preset, this will be copied to the button

    type: "simple"

    The type of the preset

    Settings

    Member Visibility

    On This Page

    Properties