// 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 { defaultTo } from 'lodash-es'; import { useFormToaster } from '../toast' import type { IErrorNotifier } from "../toast"; /** * The message handler interface */ export interface IMessageHandler { setMessage(title: string, text?: string): void; clearMessage(): void; onInput(): void; } /** * Gets the message state subsystem for displaying errors * to the user and clearing them * @param notifier An optional notifier to use instead of the default */ export const useMessage = (notifier?: IErrorNotifier): IMessageHandler =>{ const _notifier = defaultTo(notifier, useFormToaster()) const clearMessage = (): void => _notifier.close() const setMessage = (title: string, text = ''): void => { //Setting a null value will also clear the message title ? _notifier.notifyError(title, text) : clearMessage(); } const onInput = clearMessage; return { setMessage, clearMessage, onInput } }