Add JSDoc comments to all ui components

This commit is contained in:
Alex Gleason
2022-04-30 23:39:58 -05:00
parent 999d5bd9f4
commit b7d4411627
26 changed files with 168 additions and 9 deletions

View File

@ -22,13 +22,18 @@ const alignItemsOptions = {
center: 'items-center',
};
interface IStack extends React.HTMLAttributes<HTMLDivElement > {
interface IStack extends React.HTMLAttributes<HTMLDivElement> {
/** Size of the gap between elements. */
space?: SIZES,
/** Horizontal alignment of children. */
alignItems?: 'center',
/** Vertical alignment of children. */
justifyContent?: 'center',
/** Extra class names on the <div> element. */
className?: string,
}
/** Vertical stack of child elements. */
const Stack: React.FC<IStack> = (props) => {
const { space, alignItems, justifyContent, className, ...filteredProps } = props;