mirror of
https://github.com/pybricks/pybricks-code.git
synced 2026-09-15 02:54:07 +00:00
31 lines
943 B
TypeScript
31 lines
943 B
TypeScript
// SPDX-License-Identifier: MIT
|
|
// Copyright (c) 2021-2023 The Pybricks Authors
|
|
|
|
import type { ToastProps, Toaster } from '@blueprintjs/core';
|
|
|
|
/**
|
|
* Template type alert callbacks.
|
|
*
|
|
* This is called when an alert is dismissed.
|
|
*
|
|
* @param action: The action that the user selected. This is usually 'dismiss'.
|
|
*/
|
|
export type ToastActionHandler<A extends string> = (action: A) => void;
|
|
|
|
/**
|
|
* Template type for all toast creation functions for alert components.
|
|
*
|
|
* @param onAction A callback that is called when the toast is dismissed.
|
|
* @param props Additional properties required by this toast, if any (usually
|
|
* replacements for translations).
|
|
*/
|
|
export type CreateToast<
|
|
P extends Record<string, unknown> = never,
|
|
A extends string = 'dismiss',
|
|
> = (onAction: ToastActionHandler<A>, props: P) => ToastProps;
|
|
|
|
/**
|
|
* Type compatible with React.RefObject<Toaster>.
|
|
*/
|
|
export type ToasterRef = { current: Toaster | null };
|