@jobber/components 4.26.7 → 4.26.8

package/dist/DataList/DataList.types.d.ts

@@ -1,7 +1,28 @@
 import { ReactElement, ReactNode } from "react";
 export type DataListItemType<T extends DataListObject[]> = Record<keyof T[number], ReactElement>;
-export type DataListItemTypeFromHeader<T extends DataListHeader<T>> = Record<keyof T, ReactElement>;
-export type DataListObject = Record<string, ReactNode | Date>;
+export type DataListItemTypeFromHeader<TData extends DataListObject, THeader extends DataListHeader<TData>> = Record<keyof THeader, ReactElement>;
+export interface DataListObject {
+    /**
+     * The ID of the data.
+     *
+     * This is used as a key when looping through the data to prevent accidental
+     * rerender when the order of data changes.
+     */
+    readonly id: string | number;
+    /**
+     * Styles the string as an emphasized text that differs from other keys.
+     */
+    readonly label?: string | ReactElement;
+    /**
+     * Creates a styled list of tags that overflows and is truncated with a +N.
+     */
+    readonly tags?: string[];
+    /**
+     * Support any key. The keys in this object are used as way to determine the
+     * keys you can use on the DataList header, layout, etc.
+     */
+    readonly [key: string]: ReactNode | Date;
+}
 export type DataListHeader<T extends DataListObject> = {
     readonly [K in keyof T]?: string;
 };
@@ -9,18 +30,20 @@ export interface DataListProps<T extends DataListObject> {
     readonly data: T[];
     readonly headers: DataListHeader<T>;
     /**
-     * Tell the DataList if the data loading
+     * Shows the loading state of the DataList.
+     *
      * @default false
      */
     readonly loading?: boolean;
     /**
      * Temporary prop for setting default state for if filters are applied
+     *
      * @default false
      */
     readonly filterApplied?: boolean;
     readonly children: ReactElement | ReactElement[];
     /**
-     * The title of the DataList
+     * The title of the DataList.
      */
     readonly title?: string;
     /**

package/dist/DataList/DataList.utils.d.ts

@@ -12,7 +12,7 @@ export declare function generateListItemElements<T extends DataListObject>(data:
 /**
  * Generate the header elements with the default styling
  */
-export declare function generateHeaderElements<T extends DataListObject>(headers: DataListHeader<T>): DataListItemTypeFromHeader<DataListHeader<T>> | undefined;
+export declare function generateHeaderElements<T extends DataListObject>(headers: DataListHeader<T>): DataListItemTypeFromHeader<T, DataListHeader<T>> | undefined;
 interface UseDataListEmptyStateProps {
     readonly children?: ReactElement | ReactElement[];
     readonly isFilterApplied: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jobber/components",
-  "version": "4.26.7",
+  "version": "4.26.8",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -84,5 +84,5 @@
     "> 1%",
     "IE 10"
   ],
-  "gitHead": "c6b61f85327bcde7c60767afaf3dbfc6dc3b9f0e"
+  "gitHead": "535d5a01bbcd69430f027660cb2e2b5de058a31e"
 }