Parameters refactor (#738)

* refactor attachment code into its own file * Add getters * Remove custom models for each type of attachment * Refactor existing widgets * Fix double camera open bug * Add check for modern parameter API * Add generic parameter type * Remove old code * Remove dead code * Refactor previous widget * Remove unused imports * Refactor common code * format * Update release notes * Helper func to render parameters list tile * Display parameters on part page * parameters for company * Supplier more model types: - ManufacturerPart - SupplierPart - PurchaseOrder - SalesOrder * dart format * Fix image prefix * Remove unused import * Adjust API version
2025-12-16 09:08:05 +00:00 · 2025-12-04 18:34:05 +11:00
parent 346b1a150f
commit 864c3eea76
12 changed files with 378 additions and 129 deletions
--- a/lib/widget/parameter_widget.dart
+++ b/lib/widget/parameter_widget.dart
@@ -0,0 +1,192 @@
+import "package:flutter/material.dart";
+import "package:flutter_tabler_icons/flutter_tabler_icons.dart";
+import "package:inventree/api.dart";
+import "package:inventree/app_colors.dart";
+import "package:inventree/inventree/model.dart";
+import "package:inventree/inventree/parameter.dart";
+
+import "package:inventree/l10.dart";
+import "package:inventree/widget/link_icon.dart";
+import "package:inventree/widget/paginator.dart";
+import "package:inventree/widget/progress.dart";
+import "package:inventree/widget/refreshable_state.dart";
+
+/*
+ * Widget for displaying a list of parameters associated with a given Part instance
+ */
+class ParameterWidget extends StatefulWidget {
+  const ParameterWidget(this.modelType, this.modelId, this.editable) : super();
+
+  final String modelType;
+  final int modelId;
+  final bool editable;
+
+  @override
+  _ParameterWidgetState createState() => _ParameterWidgetState();
+}
+
+class _ParameterWidgetState extends RefreshableState<ParameterWidget> {
+  _ParameterWidgetState();
+
+  @override
+  String getAppBarTitle() {
+    return L10().parameters;
+  }
+
+  @override
+  List<Widget> appBarActions(BuildContext context) {
+    return [];
+  }
+
+  @override
+  Widget getBody(BuildContext context) {
+    Map<String, String> filters = {
+      "model_type": widget.modelType,
+      "model_id": widget.modelId.toString(),
+    };
+
+    return Column(
+      children: [
+        Expanded(child: PaginatedParameterList(filters, widget.editable)),
+      ],
+    );
+  }
+}
+
+/*
+ * Widget for displaying a paginated list of Part parameters
+ */
+class PaginatedParameterList extends PaginatedSearchWidget {
+  const PaginatedParameterList(Map<String, String> filters, this.editable)
+    : super(filters: filters);
+
+  final bool editable;
+
+  @override
+  String get searchTitle => L10().parameters;
+
+  @override
+  _PaginatedParameterState createState() => _PaginatedParameterState();
+}
+
+class _PaginatedParameterState
+    extends PaginatedSearchState<PaginatedParameterList> {
+  _PaginatedParameterState() : super();
+
+  @override
+  String get prefix => "parameters_";
+
+  @override
+  Map<String, String> get orderingOptions => {};
+
+  @override
+  Map<String, Map<String, dynamic>> get filterOptions => {
+    // TODO
+  };
+
+  @override
+  Future<InvenTreePageResponse?> requestPage(
+    int limit,
+    int offset,
+    Map<String, String> params,
+  ) async {
+    final page = await InvenTreeParameter().listPaginated(
+      limit,
+      offset,
+      filters: params,
+    );
+
+    return page;
+  }
+
+  Future<void> editParameter(InvenTreeParameter parameter) async {
+    // Checkbox values are handled separately
+    if (parameter.is_checkbox) {
+      return;
+    } else {
+      parameter.editForm(
+        context,
+        L10().editParameter,
+        onSuccess: (data) async {
+          updateSearchTerm();
+        },
+      );
+    }
+  }
+
+  @override
+  Widget buildItem(BuildContext context, InvenTreeModel model) {
+    InvenTreeParameter parameter = model as InvenTreeParameter;
+
+    String title = parameter.name;
+
+    if (parameter.units.isNotEmpty) {
+      title += " [${parameter.units}]";
+    }
+
+    return ListTile(
+      title: Text(title),
+      subtitle: Text(parameter.description),
+      trailing: parameter.is_checkbox
+          ? Switch(
+              value: parameter.as_bool,
+              onChanged: (bool value) {
+                if (widget.editable) {
+                  showLoadingOverlay();
+                  parameter.update(values: {"data": value.toString()}).then((
+                    value,
+                  ) async {
+                    hideLoadingOverlay();
+                    updateSearchTerm();
+                  });
+                }
+              },
+            )
+          : Text(parameter.value),
+      onTap: parameter.is_checkbox
+          ? null
+          : () async {
+              if (widget.editable) {
+                editParameter(parameter);
+              }
+            },
+    );
+  }
+}
+
+/*
+ * Return a ListTile to display parameters for the specified model
+ */
+ListTile? ShowParametersItem(
+  BuildContext context,
+  String modelType,
+  int modelId,
+  int parameterCount,
+  bool editable,
+) {
+  // Note: Currently cannot add parameters from the app,
+  // So, if there are no parameters, do not show the item
+  if (parameterCount == 0) {
+    return null;
+  }
+
+  if (!InvenTreeAPI().supportsModernParameters) {
+    return null;
+  }
+
+  return ListTile(
+    title: Text(L10().parameters),
+    leading: Icon(TablerIcons.list_details, color: COLOR_ACTION),
+    trailing: LinkIcon(
+      text: parameterCount > 0 ? parameterCount.toString() : null,
+    ),
+    onTap: () {
+      Navigator.push(
+        context,
+        MaterialPageRoute(
+          builder: (context) => ParameterWidget(modelType, modelId, editable),
+        ),
+      );
+    },
+  );
+}