diff --git a/compass/components/Table/ResourceIndex.tsx b/compass/components/Table/ResourceIndex.tsx index 085a14d..6737dc4 100644 --- a/compass/components/Table/ResourceIndex.tsx +++ b/compass/components/Table/ResourceIndex.tsx @@ -8,6 +8,10 @@ import TagsInput from "@/components/TagsInput/Index"; import Resource from "@/utils/models/Resource"; import { DataPoint } from "@/components/Table/Table"; +/** + * Table componenet used for displaying resources + * @param props.resources List of resources to be displayed by the table + */ export default function ResourceTable({ resources }: { resources: Resource[] }) { const columnHelper = createColumnHelper(); const [data, setData] = useState([...resources]); diff --git a/compass/components/Table/ServiceIndex.tsx b/compass/components/Table/ServiceIndex.tsx index 15e8769..a4b8d66 100644 --- a/compass/components/Table/ServiceIndex.tsx +++ b/compass/components/Table/ServiceIndex.tsx @@ -8,6 +8,10 @@ import TagsInput from "@/components/TagsInput/Index"; import Service from "@/utils/models/Service"; import { DataPoint } from "@/components/Table/Table"; +/** + * Table componenet used for displaying services + * @param props.services List of services to be displayed by the table + */ export default function ServiceTable({ services }: { services: Service[] }) { const columnHelper = createColumnHelper(); const [data, setData] = useState([...services]); diff --git a/compass/components/Table/Table.tsx b/compass/components/Table/Table.tsx index af798c2..4bd5d1c 100644 --- a/compass/components/Table/Table.tsx +++ b/compass/components/Table/Table.tsx @@ -47,7 +47,13 @@ const fuzzyFilter = ( return itemRank.passed; }; -export const Table = ({ data, columns, setData }: TableProps) => { +/** + * General componenet that holds shared functionality for any data table component + * @param props.data List of data, managed through state, to be held in the table + * @param props.setData State setter to be used for data manipulation methods + * @param props.columns Column definitions made with Tanstack columnHelper + */ +export const Table = ({ data, setData, columns }: TableProps) => { const columnHelper = createColumnHelper(); useEffect(() => { const sortedData = [...data].sort((a, b) => diff --git a/compass/components/Table/UserIndex.tsx b/compass/components/Table/UserIndex.tsx index 5b02a4d..30ec363 100644 --- a/compass/components/Table/UserIndex.tsx +++ b/compass/components/Table/UserIndex.tsx @@ -8,6 +8,10 @@ import TagsInput from "@/components/TagsInput/Index"; import User from "@/utils/models/User"; import { DataPoint } from "@/components/Table/Table"; +/** + * Table componenet used for displaying users + * @param props.users List of users to be displayed by the table + */ export default function UserTable({ users }: { users: User[] }) { const columnHelper = createColumnHelper(); const [data, setData] = useState([...users]);