Class NotificationGroup

A base class for anything requiring access to the InstanceApi and instance of Vue app controlled by it.

Export

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

Properties

The instance of RampMap API scoped to a single Vue R4MP application.

Memberof

APIScope

id: string
message: string
messageList: string[] = []
notificationStore: Store<"notification", _UnwrapAll<Pick<{
    addToGroup: ((id, message) => void);
    clearAll: (() => void);
    groups: Ref<{
        [id: string]: NotificationGroup;
    }>;
    notificationNumber: ComputedRef<number>;
    notificationStack: Ref<({
        message: string;
        type: NotificationType;
    } | {
        $element: { version: string; config: { readonly isNativeTag?: ((tag: string) => boolean) | undefined; performance: boolean; optionMergeStrategies: Record<string, OptionMergeFunction>; ... 5 more ...; unwrapInjectedRef?: boolean | undefined; }; ... 14 more ...; filter?: { ...; } | undefined; };
        $iApi: { readonly fixture: { add: (id: string, constructor?: IFixtureBase | undefined) => Promise<FixtureBase>; remove: <T extends FixtureBase = FixtureBase>(fixtureOrId: string | FixtureBase) => T; ... 5 more ...; readonly $element: { ...; }; }; ... 22 more ...; start: () => void; };
        $vApp: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>;
        id: string;
        message: string;
        messageList: string[];
        notificationStore: { $state: { notificationStack: ({ message: string; type: NotificationType; } | { notificationStore: { $state: { notificationStack: ({ message: string; type: NotificationType; } | { ...; })[]; groups: { ...; }; }; ... 14 more ...; clearAll: () => void; }; ... 7 more ...; readonly $element: { ...; }; })[]; groups: { ....;
        type: NotificationType;
        show(message) => void;
    })[]>;
    registerGroup: ((group) => void);
    removeNotification: ((notification) => void);
    showNotification: ((notification) => void);
}, "notificationStack" | "groups">>, Pick<{
    addToGroup: ((id, message) => void);
    clearAll: (() => void);
    groups: Ref<{
        [id: string]: NotificationGroup;
    }>;
    notificationNumber: ComputedRef<number>;
    notificationStack: Ref<({
        message: string;
        type: NotificationType;
    } | {
        $element: { version: string; config: { readonly isNativeTag?: ((tag: string) => boolean) | undefined; performance: boolean; optionMergeStrategies: Record<string, OptionMergeFunction>; ... 5 more ...; unwrapInjectedRef?: boolean | undefined; }; ... 14 more ...; filter?: { ...; } | undefined; };
        $iApi: { readonly fixture: { add: (id: string, constructor?: IFixtureBase | undefined) => Promise<FixtureBase>; remove: <T extends FixtureBase = FixtureBase>(fixtureOrId: string | FixtureBase) => T; ... 5 more ...; readonly $element: { ...; }; }; ... 22 more ...; start: () => void; };
        $vApp: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>;
        id: string;
        message: string;
        messageList: string[];
        notificationStore: { $state: { notificationStack: ({ message: string; type: NotificationType; } | { notificationStore: { $state: { notificationStack: ({ message: string; type: NotificationType; } | { ...; })[]; groups: { ...; }; }; ... 14 more ...; clearAll: () => void; }; ... 7 more ...; readonly $element: { ...; }; })[]; groups: { ....;
        type: NotificationType;
        show(message) => void;
    })[]>;
    registerGroup: ((group) => void);
    removeNotification: ((notification) => void);
    showNotification: ((notification) => void);
}, "notificationNumber">, Pick<{
    addToGroup: ((id, message) => void);
    clearAll: (() => void);
    groups: Ref<{
        [id: string]: NotificationGroup;
    }>;
    notificationNumber: ComputedRef<number>;
    notificationStack: Ref<({
        message: string;
        type: NotificationType;
    } | {
        $element: { version: string; config: { readonly isNativeTag?: ((tag: string) => boolean) | undefined; performance: boolean; optionMergeStrategies: Record<string, OptionMergeFunction>; ... 5 more ...; unwrapInjectedRef?: boolean | undefined; }; ... 14 more ...; filter?: { ...; } | undefined; };
        $iApi: { readonly fixture: { add: (id: string, constructor?: IFixtureBase | undefined) => Promise<FixtureBase>; remove: <T extends FixtureBase = FixtureBase>(fixtureOrId: string | FixtureBase) => T; ... 5 more ...; readonly $element: { ...; }; }; ... 22 more ...; start: () => void; };
        $vApp: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>;
        id: string;
        message: string;
        messageList: string[];
        notificationStore: { $state: { notificationStack: ({ message: string; type: NotificationType; } | { notificationStore: { $state: { notificationStack: ({ message: string; type: NotificationType; } | { ...; })[]; groups: { ...; }; }; ... 14 more ...; clearAll: () => void; }; ... 7 more ...; readonly $element: { ...; }; })[]; groups: { ....;
        type: NotificationType;
        show(message) => void;
    })[]>;
    registerGroup: ((group) => void);
    removeNotification: ((notification) => void);
    showNotification: ((notification) => void);
}, "showNotification" | "removeNotification" | "registerGroup" | "addToGroup" | "clearAll">> = ...

Accessors

  • get $element(): App<Element>
  • Returns App<Element>

  • get $vApp(): ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>
  • The instance of Vue R4MP application controlled by this InstanceAPI. This is just a shorthand for this.$iApi.$vApp.

    Returns ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>

    Memberof

    APIScope

Methods

  • Shows a message under the group

    Parameters

    • message: string

      The message to show

    Returns void

    Memberof

    NotificationGroup

Generated using TypeDoc