superset-frontend/src/components/MessageToasts/actions.ts
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import { nanoid } from 'nanoid';
import { ToastType, ToastMeta } from './types';
type ToastOptions = Partial<Omit<ToastMeta, 'id' | 'toastType' | 'text'>>;
export function getToastUuid(type: ToastType) {
return `${type}-${nanoid()}`;
}
export const ADD_TOAST = 'ADD_TOAST';
export function addToast({
toastType,
text,
duration = 8000,
noDuplicate = false,
}: Omit<ToastMeta, 'id'>) {
return {
type: ADD_TOAST,
payload: {
id: getToastUuid(toastType),
toastType,
text,
duration,
noDuplicate,
},
};
}
export const REMOVE_TOAST = 'REMOVE_TOAST';
export function removeToast(id: string) {
return {
type: REMOVE_TOAST,
payload: {
id,
},
};
}
// Different types of toasts
export const ADD_INFO_TOAST = 'ADD_INFO_TOAST';
export function addInfoToast(text: string, options?: ToastOptions) {
return addToast({
text,
toastType: ToastType.Info,
duration: 4000,
...options,
});
}
export const ADD_SUCCESS_TOAST = 'ADD_SUCCESS_TOAST';
export function addSuccessToast(text: string, options?: ToastOptions) {
return addToast({
text,
toastType: ToastType.Success,
duration: 4000,
...options,
});
}
export const ADD_WARNING_TOAST = 'ADD_WARNING_TOAST';
export function addWarningToast(text: string, options?: ToastOptions) {
return addToast({
text,
toastType: ToastType.Warning,
duration: 6000,
...options,
});
}
export const ADD_DANGER_TOAST = 'ADD_DANGER_TOAST';
export function addDangerToast(text: string, options?: ToastOptions) {
return addToast({
text,
toastType: ToastType.Danger,
duration: 8000,
...options,
});
}
export const toastActions = {
addInfoToast,
addSuccessToast,
addWarningToast,
addDangerToast,
};