1
0
Fork 0

[react] feat: Added docs for components/Table

This commit is contained in:
joostdecock 2025-05-29 13:19:47 +02:00
parent f92a182992
commit 88d0c92a6d
4 changed files with 84 additions and 6 deletions

View file

@ -1,9 +1,32 @@
import React from 'react'
/*
/**
* A component set CSS classes to make your tables look better
*
* @component
* @param {object} props - All component props
* @param {JSX.Element} props.children - The table children, same as for a table HTML tag
* @returns {JSX.Element}
*/
export const Table = ({ children }) => (
<TableWrapper>
<table className="tw:table tw:table-auto">{children}</table>
</TableWrapper>
)
/**
* A component to help embed tables into a page
*
* Tables on mobile will almost always break the layout
* unless we set the overflow behaviour explicitly
* unless we set the overflow behaviour explicitly.
* This component takes care of that.
*
* @component
* @param {object} props - All component props
* @param {object} [props.js = undefined] - An optional Javascript Object to highlight
* @param {JSX.Element} props.children - The component children, will be rendered if props.js is not set
* @returns {JSX.Element}
*/
export const TableWrapper = ({ children }) => (
<div className="max-w-full overflow-x-auto">{children}</div>
<div className="tw:max-w-full tw:overflow-x-auto">{children}</div>
)

View file

@ -37,3 +37,4 @@ jsdoc -c jsdoc.json components/SignUp/* > ../../sites/dev/prebuild/jsdoc/react/c
jsdoc -c jsdoc.json components/Spinner/* > ../../sites/dev/prebuild/jsdoc/react/components/spinner.json
jsdoc -c jsdoc.json components/Stats/* > ../../sites/dev/prebuild/jsdoc/react/components/stats.json
jsdoc -c jsdoc.json components/Tab/* > ../../sites/dev/prebuild/jsdoc/react/components/tab.json
jsdoc -c jsdoc.json components/Table/* > ../../sites/dev/prebuild/jsdoc/react/components/table.json