aboutsummaryrefslogtreecommitdiff
path: root/lib/vnlib.browser/src/toast/index.ts
blob: 054c87ec38a55e33b37b1f52cb58a6967d7b8728 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
// Copyright (c) 2023 Vaughn Nugent
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of
// this software and associated documentation files (the "Software"), to deal in
// the Software without restriction, including without limitation the rights to
// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
// the Software, and to permit persons to whom the Software is furnished to do so,
// subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

import { shallowRef, type MaybeRef } from 'vue'
import { set } from '@vueuse/core'
import { debugLog } from '../util'
import { createFormToaster, createGeneralToaster } from './toaster'
import type { INotifier, CombinedToaster, ToasterNotifier } from './types'

export type * from './types'

class DefaultNotifier implements INotifier {
    notify(config: { title:string, text:string }): void {
        debugLog(`Notification: ${config.title} - ${config.text}`)
    }
    close(id: string): void {
        debugLog(`Notification closed: ${id}`)
    }
}

//Combined toaster impl
const createCombinedToaster = (notifier: MaybeRef<INotifier>) : CombinedToaster => {
    const form = createFormToaster(notifier);
    const general = createGeneralToaster(notifier);
    
    const close = (id?: string) => {
        form.close(id);
        general.close(id);
    }

    return Object.freeze({ form, general, close });
}

// The program handler for the notification
const _global = shallowRef<INotifier>(new DefaultNotifier())

/**
 * Configures the notification handler. 
 * @param {*} notifier The method to call when a notification is to be displayed
 * @returns The notifier
 */
export const configureNotifier = (notifier : INotifier) => set(_global, notifier)

/**
 * Gets the default toaster for general notifications
 * and the form toaster for form notifications
 * @returns {Object} The toaster contianer object
 */
export const useToaster = (notifier?: MaybeRef<INotifier>): CombinedToaster => createCombinedToaster(notifier ?? _global);

/**
 * Gets the default toaster for from notifications
 */
export const useFormToaster = (notifier?: MaybeRef<INotifier>): ToasterNotifier => createFormToaster(notifier ?? _global);

/**
 * Gets the default toaster for general notifications
 * @returns {Object} The toaster contianer object
 */
export const useGeneralToaster = (notifier?: MaybeRef<INotifier>): ToasterNotifier => createGeneralToaster(notifier ?? _global);