Skip to content

Commit 27b11e4

Browse files
committed
docs: Document RoomStatusBarHistoryVisible and props interface.
1 parent 2a9ad6b commit 27b11e4

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

src/components/structures/RoomStatusBarHistoryVisible.tsx

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,20 @@ import { InfoIcon } from "@vector-im/compound-design-tokens/assets/web/icons";
1212
import AccessibleButton from "../views/elements/AccessibleButton";
1313
import { _t } from "../../languageHandler";
1414

15-
interface RoomStatusBarHistoryVisible {
15+
interface RoomStatusBarHistoryVisibleProps {
16+
/**
17+
* Called when the user presses the "dismiss" button.
18+
*/
1619
onClose: () => void;
1720
}
1821

19-
export const RoomStatusBarHistoryVisible = (props: RoomStatusBarHistoryVisible): ReactElement => {
22+
/**
23+
* RoomStatusBarHistoryVisible component.
24+
*
25+
* @param props - Props for the RoomStatusBarHistoryVisible component. See {@link RoomStatusBarHistoryVisibleProps}.
26+
* @returns A ReactElement representing the status bar.
27+
*/
28+
export const RoomStatusBarHistoryVisible = (props: RoomStatusBarHistoryVisibleProps): ReactElement => {
2029
return (
2130
<div className="mx_RoomStatusBar mx_RoomStatusBar_historyVisibility">
2231
<div role="alert">

0 commit comments

Comments
 (0)