@inventreedb/ui 0.11.1 → 0.11.3

package/lib/index.ts

@@ -26,10 +26,18 @@ export type {
   RowViewProps,
   TableColumn,
   TableColumnProps,
+  TableState,
   InvenTreeTableProps,
   InvenTreeTableRenderProps
 } from './types/Tables';
 
+export type {
+  TableFilterChoice,
+  TableFilterType,
+  TableFilter,
+  FilterSetState
+} from './types/Filters';
+
 export type {
   ApiFormFieldChoice,
   ApiFormFieldHeader,
@@ -124,6 +132,13 @@ export {
   type TableStateExtraProps
 } from './hooks/UseTable';
 
+export {
+  type DrawerProps,
+  DetailDrawer,
+  DetailDrawerLink
+} from './components/nav/DetailDrawer';
+export { StylishText } from './components/StylishText';
+
 // State management
 export {
   type StoredTableStateProps,

package/lib/states/LocalLibState.tsx

@@ -0,0 +1,23 @@
+import { create } from 'zustand';
+import { persist } from 'zustand/middleware';
+
+export const useLocalLibState = create<LocalLibStateProps>()(
+  persist(
+    (set, get) => ({
+      detailDrawerStack: 0,
+      addDetailDrawer: (value) => {
+        set({
+          detailDrawerStack:
+            value === false ? 0 : get().detailDrawerStack + value
+        });
+      }
+    }),
+    {
+      name: 'session-settings-inventreedb_lib'
+    }
+  )
+);
+export interface LocalLibStateProps {
+  detailDrawerStack: number;
+  addDetailDrawer: (value: number | false) => void;
+}

package/lib/types/Forms.tsx

@@ -37,7 +37,6 @@ export type ApiFormFieldHeader = {
  * - All other attributes are optional, and may be provided by the API
  * - However, they can be overridden by the user
  *
- * @param name : The name of the field
  * @param label : The label to display for the field
  * @param value : The value of the field
  * @param default : The default value of the field
@@ -46,16 +45,21 @@ export type ApiFormFieldHeader = {
  * @param api_url : The API endpoint to fetch data from (for related fields)
  * @param pk_field : The primary key field for the related field (default = "pk")
  * @param model : The model to use for related fields
+ * @param modelRenderer : Optional function to render the related model instance (for related fields)
  * @param filters : Optional API filters to apply to related fields
+ * @param child: Optional definition of a child field (for nested objects)
+ * @param children: Optional definitions of child fields (for nested objects with multiple fields)
  * @param required : Whether the field is required
- * @param allow_null: Whether the field allows null values
- * @param allow_blank: Whether the field allows blank values
+ * @param error : Optional error message to display
  * @param hidden : Whether the field is hidden
  * @param disabled : Whether the field is disabled
- * @param error : Optional error message to display
+ * @param allow_null: Whether the field allows null values
+ * @param allow_blank: Whether the field allows blank values
  * @param exclude : Whether to exclude the field from the submitted data
+ * @param read_only : Whether the field is read-only
  * @param placeholder : The placeholder text to display
  * @param placeholderAutofill: Whether to allow auto-filling of the placeholder value
+ * @param addCreateFields : Fields to display when creating a new related object (for related fields)
  * @param description : The description to display for the field
  * @param preFieldContent : Content to render before the field
  * @param postFieldContent : Content to render after the field
@@ -63,11 +67,11 @@ export type ApiFormFieldHeader = {
  * @param rightSection : Content to render in the right section of the field
  * @param autoFill: Whether to automatically fill the field with data from the API
  * @param autoFillFilters: Optional filters to apply when auto-filling the field
+ * @param adjustValue : Callback function to adjust the value of the field before it is sent to the API
  * @param onValueChange : Callback function to call when the field value changes
  * @param adjustFilters : Callback function to adjust the filters for a related field before a query is made
- * @param adjustValue : Callback function to adjust the value of the field before it is sent to the API
  * @param addRow : Callback function to add a new row to a table field
- * @param onKeyDown : Callback function to get which key was pressed in the form to handle submission on enter
+ * @param headers : Optional definitions of table headers (for table fields)
  * @param singleFetchFunction : Optional function to fetch a single value for this field (used for fetching the initial value when editing an existing object)
  */
 export type ApiFormFieldType = {
@@ -114,6 +118,7 @@ export type ApiFormFieldType = {
   placeholderAutofill?: boolean;
   placeholderWarningCompare?: string | number;
   placeholderWarning?: string;
+  addCreateFields?: ApiFormFieldSet;
   description?: string;
   preFieldContent?: JSX.Element;
   postFieldContent?: JSX.Element;

package/lib/types/Tables.tsx

@@ -1,5 +1,6 @@
 import type { MantineStyleProp } from '@mantine/core';
 import type { AxiosInstance } from 'axios';
+import type { ShowContextMenuFunction } from 'mantine-contextmenu';
 import type {
   DataTableCellClickHandler,
   DataTableRowExpansionProps
@@ -178,6 +179,7 @@ export type RowViewProps = RowAction & RowModelProps;
  * @param onRowClick : (record: any, index: number, event: any) => void - Callback function when a row is clicked
  * @param onCellClick : (event: any, record: any, index: number, column: any, columnIndex: number) => void - Callback function when a cell is clicked
  * @param modelType: ModelType - The model type for the table
+ * @param height: string | number - Height of the table (default = 'auto')
  * @param minHeight: number - Minimum height of the table (default 300px)
  * @param noHeader: boolean - Hide the table header
  */
@@ -211,6 +213,7 @@ export type InvenTreeTableProps<T = any> = {
   rowStyle?: (record: T, index: number) => MantineStyleProp | undefined;
   modelField?: string;
   onCellContextMenu?: (record: T, event: any) => void;
+  height?: string | number;
   minHeight?: number;
   noHeader?: boolean;
 };
@@ -223,4 +226,9 @@ export type InvenTreeTableRenderProps<T extends Record<string, any>> = {
   props: InvenTreeTableProps<T>;
   api: AxiosInstance;
   navigate: NavigateFunction;
+
+  // The following attributes are for internal use only (plugins should not use these directly)
+  showContextMenu?: ShowContextMenuFunction;
+  searchParams?: URLSearchParams;
+  setSearchParams?: (params: URLSearchParams) => void;
 };

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@inventreedb/ui",
     "description": "UI components for the InvenTree project",
-    "version": "0.11.1",
+    "version": "0.11.3",
     "private": false,
     "type": "module",
     "license": "MIT",
@@ -102,6 +102,7 @@
         "react-window": "1.8.11",
         "recharts": "^3.1.2",
         "styled-components": "^6.1.14",
+        "undici": "^6.24.0",
         "zustand": "^5.0.8"
     },
     "devDependencies": {
@@ -137,6 +138,7 @@
         "vite-plugin-istanbul": "^8.0.0"
     },
     "resolutions": {
-        "undici": "^6.24.0"
+        "undici": "^6.24.0",
+        "vite": "^8.0.5"
     }
 }