From af92f4faee6c242fd46881c73ae5867e92f71d93 Mon Sep 17 00:00:00 2001 From: Davenludd Date: Wed, 20 Mar 2024 13:52:58 +0100 Subject: [PATCH] Docs/Comments to BasicWindow component --- frontend/src/Components/BasicWindow.tsx | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/frontend/src/Components/BasicWindow.tsx b/frontend/src/Components/BasicWindow.tsx index d5fd3b6..d53d367 100644 --- a/frontend/src/Components/BasicWindow.tsx +++ b/frontend/src/Components/BasicWindow.tsx @@ -1,6 +1,16 @@ +//info: Basic window component to display content and buttons of a page, inclduing header and footer +//content to insert is placed in the content prop, and buttons in the buttons prop import Header from "./Header"; import Footer from "./Footer"; +/** + * Renders a basic window component with a header, content, and footer. + * + * @param {Object} props - The component props. + * @param {React.ReactNode} props.content - The content to be rendered in the window. + * @param {React.ReactNode} props.buttons - The buttons to be rendered in the footer. + * @returns {JSX.Element} The rendered basic window component. + */ function BasicWindow({ content, buttons,