docs: consolidate docs (#2182)

Signed-off-by: Philip Molares <philip.molares@udo.edu>
This commit is contained in:
Philip Molares 2022-07-21 22:36:46 +02:00 committed by GitHub
parent 8d46d7e39e
commit ecffebc43c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
307 changed files with 1474 additions and 487 deletions

View file

@ -1,5 +1,5 @@
/*
* SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
* SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file)
*
* SPDX-License-Identifier: AGPL-3.0-only
*/
@ -25,6 +25,20 @@ export interface UiNotificationProps extends UiNotification {
notificationId: number
}
/**
* Renders a single notification.
*
* @param titleI18nKey The i18n key for the title
* @param contentI18nKey The i18n key for the content
* @param titleI18nOptions The i18n options for the title
* @param contentI18nOptions The i18n options for the content
* @param createdAtTimestamp The timestamp, when this notification was created.
* @param icon The optional icon to be used
* @param dismissed If the notification is already dismissed
* @param notificationId The notification id
* @param durationInSecond How long the notification should be shown
* @param buttons A list of {@link UiNotificationButton UiNotificationButtons} to be displayed
*/
export const UiNotificationToast: React.FC<UiNotificationProps> = ({
titleI18nKey,
contentI18nKey,