@trackunit/react-components 0.0.49 → 0.0.50

package/layout/helper/MinTopFullContentLayout.d.ts

@@ -8,5 +8,11 @@ import { CommonProps } from "../../common/CommonProps";
 interface IMinTopFullContentLayoutProps extends CommonProps {
     children: ReactNode;
 }
+/**
+ * The MinTopFullContentLayout component.
+ *
+ * @param {IMinTopFullContentLayoutProps} props - The props for the MinTopFullContentLayout component
+ * @returns {JSX.Element} MinTopFullContentLayout component
+ */
 export declare const MinTopFullContentLayout: ({ children, className, dataTestId }: IMinTopFullContentLayoutProps) => JSX.Element;
 export {};

package/layout/responsive/FilterListMapLayout.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
+interface IProps {
+    children: React.ReactNode;
+}
 /**
  * Responsive layout component setting up three grid areas
  * one for filtering, (result-)list and (result-map)
@@ -11,9 +14,9 @@
  *  - map
  * on screens < mediaQuery.xxl
  *
+ *
+ * @param {IProps} props - The props for the FilterListMapLayout component
+ * @returns {JSX.Element} FilterListMapLayout component
  */
-interface IProps {
-    children: React.ReactNode;
-}
 export declare const FilterListMapLayout: ({ children }: IProps) => JSX.Element;
 export {};

package/layout/responsive/FullWidthRepeatingLayout.d.ts

@@ -1,9 +1,4 @@
 /// <reference types="react" />
-/**
- * Layout component with repeating full width areas, default one height fraction each but option to use content height instead
- * Row min height can optionally be set here or managed by children
- * Scrolling happens if/when children's a min-height is reached
- */
 declare type RowSizing = "Equal" | "MinContent" | "Unmanaged";
 interface IFullWidthRepeatingLayoutProps {
     children: React.ReactNode;
@@ -12,5 +7,13 @@ interface IFullWidthRepeatingLayoutProps {
     dataTestId?: string;
     className?: string;
 }
+/**
+ * Layout component with repeating full width areas, default one height fraction each but option to use content height instead
+ * Row min height can optionally be set here or managed by children
+ * Scrolling happens if/when children's a min-height is reached
+ *
+ * @param {IFullWidthRepeatingLayoutProps} props - The props for the FullWidthRepeatingLayout component
+ * @returns {JSX.Element} FullWidthRepeatingLayout component
+ */
 export declare const FullWidthRepeatingLayout: ({ children, rowSizing, rowMinHeight, dataTestId, className, }: IFullWidthRepeatingLayoutProps) => JSX.Element;
 export {};

package/layout/responsive/GridArea.d.ts

@@ -6,7 +6,9 @@ interface GridAreaProps extends CommonProps {
 }
 /**
  * Simply applies a Grid Area to the element
- * @param {string} area
+ *
+ * @param {GridAreaProps} props - The props for the GridArea component
+ * @returns {JSX.Element} GridArea component
  */
 export declare const GridArea: ({ area, dataTestId, className, children }: GridAreaProps) => JSX.Element;
 export {};

package/layout/responsive/IntrinsicallyResponsiveGrid.d.ts

@@ -4,23 +4,27 @@ declare type ColumnWidth = "slim" | "narrow" | "normal" | "wide";
 declare type Space = "inherit" | "auto" | "none" | "tiny" | "mini" | "small" | "medium" | "large" | "giant" | "enormous";
 declare type Occupation = "auto-fill" | "auto-fit";
 interface IIntrinsicallyResponsiveGridProps extends CommonProps {
+    /**
+     * The children to be laid out
+     */
     children: React.ReactNode;
+    /**
+     * Default "auto-fill" stretch a little, till there's room for another column.
+     * Optionally set "auto-fit" to stretch children to fit entire container width,
+     */
     occupation?: Occupation;
     minColumnWidth?: ColumnWidth;
+    /**
+     * The gap size between children
+     */
     gap?: Space;
 }
 /**
  * A grid container that has a flexible number of columns.
  * Adds more columns if constraints allow it, otherwise wraps to next row
  *
- *   @component
- *   @prop children - the children to be laid out,
- *   @prop occupation = "auto-fill" - stretch a little, till there's room for another column. Optionally set "auto-fit" to stretch children to fit entire container width,
- *   @prop minColumnWidth = "normal" - "small" | "normal" | "large"
- *   @prop gap = "auto" - the gap size between children,
- *   @prop dataTestId,
- *   @prop className ,
-
+ * @param {IIntrinsicallyResponsiveGridProps} props - The props for the IntrinsicallyResponsiveGrid component
+ * @returns {JSX.Element} IntrinsicallyResponsiveGrid component
  */
 export declare const IntrinsicallyResponsiveGrid: ({ children, occupation, minColumnWidth, gap, dataTestId, className, }: IIntrinsicallyResponsiveGridProps) => JSX.Element;
 export {};

package/layout/responsive/TitleNavContentLayout.d.ts

@@ -1,6 +1,12 @@
 /// <reference types="react" />
-interface IProps {
+interface TitleNavContentLayoutProps {
     children: React.ReactNode;
 }
-export declare const TitleNavContentLayout: ({ children }: IProps) => JSX.Element;
+/**
+ * The TitleNavContentLayout.
+ *
+ * @param {TitleNavContentLayoutProps} props - The props for the TitleNavContentLayout component
+ * @returns {JSX.Element} TitleNavContentLayout component
+ */
+export declare const TitleNavContentLayout: ({ children }: TitleNavContentLayoutProps) => JSX.Element;
 export {};

package/layout/responsive/TwoColumnLayout.d.ts

@@ -1,6 +1,12 @@
 /// <reference types="react" />
-interface IProps {
+interface TwoColumnLayoutProps {
     children: React.ReactNode;
 }
-export declare const TwoColumnLayout: ({ children }: IProps) => JSX.Element;
+/**
+ * TwoColumnLayout.
+ *
+ * @param {TwoColumnLayoutProps} props - The props for the TwoColumnLayout component
+ * @returns {JSX.Element} TwoColumnLayout component
+ */
+export declare const TwoColumnLayout: ({ children }: TwoColumnLayoutProps) => JSX.Element;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-components",
-  "version": "0.0.49",
+  "version": "0.0.50",
   "repository": "https://github.com/Trackunit/manager",
   "license": "MIT",
   "dependencies": {