4da149e56f
* docs: Update documentation for HistoryVisibleBanner and VM. * docs: Improve documentation for `HistoryVisibleBanner`, second pass. * docs: Move documentation to prop types over FC. Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * fix: Simplify type for `HistoryVisibleBannerViewModel` `threadId`. * docs: Apply suggestions from code review Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> --------- Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
28 lines
1.1 KiB
TypeScript
28 lines
1.1 KiB
TypeScript
/*
|
|
* Copyright (c) 2025 Element Creations Ltd.
|
|
*
|
|
* SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
|
|
* Please see LICENSE files in the repository root for full details.
|
|
*/
|
|
|
|
import { HistoryVisibleBannerView, useCreateAutoDisposedViewModel } from "@element-hq/web-shared-components";
|
|
import React from "react";
|
|
import { type Room } from "matrix-js-sdk/src/matrix";
|
|
|
|
import { HistoryVisibleBannerViewModel } from "../../../viewmodels/composer/HistoryVisibleBannerViewModel";
|
|
|
|
/** Wrapper around {@link HistoryVisibleBannerViewModel} for the creation of an auto-disposed view model. */
|
|
export const HistoryVisibleBanner: React.FC<{
|
|
/** The room instance associated with this banner view model. */
|
|
room: Room;
|
|
|
|
/**
|
|
* If not null, specifies the ID of the thread currently being viewed in the thread timeline side view,
|
|
* where the banner view is displayed as a child of the message composer.
|
|
*/
|
|
threadId: string | null;
|
|
}> = (props) => {
|
|
const vm = useCreateAutoDisposedViewModel(() => new HistoryVisibleBannerViewModel(props));
|
|
return <HistoryVisibleBannerView vm={vm} />;
|
|
};
|