diff --git a/src/frontend/CHANGELOG.md b/src/frontend/CHANGELOG.md index 459d86d289..fdf21517ef 100644 --- a/src/frontend/CHANGELOG.md +++ b/src/frontend/CHANGELOG.md @@ -1,8 +1,42 @@ -## InvenTree UI Components - Changelog +# InvenTree UI Components - Changelog This file contains historical changelog information for the InvenTree UI components library. -### 1.0.0 - April 2025 +## 0.3.0 - July 2025 + +Introduces new types and functions to enhance the InvenTree UI components API. + +### New Types + +- `ModelDict`: A dictionary type for InvenTree models, allowing for easier access to model instances. + +### New Functions + +- `formatCurrencyValue`: A utility function to format currency values consistently across the UI. +- `formatDecimal`: A utility function to format decimal values, ensuring consistent display of numerical data. +- `formatFileSize`: A utility function to format file sizes, making it easier to read large numbers. + +### New UI Components + +- `ActionButton`: A button component build on the Mantine ` component. +- `ButtonMenu`: A menu component that provides a dropdown of icon actions. +- `PassFailButton`: A button component that can be used to indicate pass/fail states, useful for testing or validation scenarios. +- `YesNoButton`: A button component that provides a simple yes/no choice, useful for confirmation dialogs. +- `ProgressBar`: A progress bar component that can be used to indicate loading or processing states. +- `SearchInput`: An input component that provides a search functionality, allowing users to filter data easily. +- `RowViewAction`: A component that provides a row view action in a table. +- `RowDuplicateAction`: A component that provides a row duplicate action in a table. +- `RowEditAction`: A component that provides a row edit action in a table. +- `RowDeleteAction`: A component that provides a row delete action in a table. +- `RowCancelAction`: A component that provides a row cancel action in a table. +- `RowActions`: A component that provides a set of row actions in a table, allowing for multiple actions to be performed on a row. + + +## 0.2.0 - June 2025 + +- Bug fixes and performance improvements. No major changes introduced in this version. + +## 0.1.0 - May 2025 Published the first version of the UI components API. This allows external plugins to hook into the InvenTree user interface, and provides global access to the following objects: @@ -13,3 +47,19 @@ Published the first version of the UI components API. This allows external plugi - `window.MantineNotifications`: The `@mantine/notifications` library All of these components can be "externalized" in the plugin build step. + +### New Types + +- `ApiEndpoints`: An object containing the API endpoints for the InvenTree server. +- `ModelType`: A type representing the available model types in InvenTree. +- `UserRoles`: An object containing the user roles available in InvenTree. +- `UserPermissions`: An object containing the user permissions available in InvenTree. +- `InvenTreePluginContext`: The context object for InvenTree plugins, providing access to the API and other utilities. + +### New Functions + +- `apiUrl`: Construct an API URL for the InvenTree server. +- `getBaseUrl`: Get the base URL for the InvenTree server. +- `getDetailUrl`: Get the detail URL for a specific model type. +- `navigateToLink`: Navigate to a provided link, either internal or external. +- `checkPluginVersion`: Check the version of a plugin against the InvenTree server.