chore(deps): update github-actions

* refactor: icon buttons implicit loading

* chore: cleanup

* feat: ui color override

* feat: column button

* feat: ui menu item (#29266)

Co-authored-by: shenlong-tanwen <139912620+shalong-tanwen@users.noreply.github.com>

---------

Co-authored-by: shenlong-tanwen <139912620+shalong-tanwen@users.noreply.github.com>

.github/workflows/build-mobile.yml

@@ -103,7 +103,7 @@ jobs:
         working-directory: ./mobile
         run: printf "%s" $KEY_JKS | base64 -d > android/key.jks
 
-      - uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 # v5.2.0
+      - uses: actions/setup-java@ad2b38190b15e4d6bdf0c97fb4fca8412226d287 # v5.3.0
         with:
           distribution: 'zulu'
           java-version: '17'

.github/workflows/check-openapi.yml

@@ -25,7 +25,7 @@ jobs:
           persist-credentials: false
 
       - name: Check for breaking API changes
-        uses: oasdiff/oasdiff-action/breaking@3530478ec30f84adedbfeb28f0d9527a290f50a9 # v0.0.57
+        uses: oasdiff/oasdiff-action/breaking@e24529087d93f837b28b50bb66ba9016380a7fcc # v0.1.2
         with:
           base: https://raw.githubusercontent.com/${{ github.repository }}/main/open-api/immich-openapi-specs.json
           revision: open-api/immich-openapi-specs.json

.github/workflows/test.yml

@@ -406,7 +406,7 @@ jobs:
           token: ${{ steps.token.outputs.token }}
 
       - name: Setup pnpm
-        uses: pnpm/action-setup@0e279bb959325dab635dd2c09392533439d90093 # v6.0.8
+        uses: pnpm/action-setup@0ebf47130e4866e96fce0953f49152a61190b271 # v6.0.9
 
       - name: Setup Node
         uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
@@ -483,7 +483,7 @@ jobs:
           token: ${{ steps.token.outputs.token }}
 
       - name: Setup pnpm
-        uses: pnpm/action-setup@0e279bb959325dab635dd2c09392533439d90093 # v6.0.8
+        uses: pnpm/action-setup@0ebf47130e4866e96fce0953f49152a61190b271 # v6.0.9
 
       - name: Setup Node
         uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0

mobile/packages/ui/lib/immich_ui.dart

@@ -1,7 +1,9 @@
 export 'src/components/close_button.dart';
+export 'src/components/column_button.dart';
 export 'src/components/form.dart';
 export 'src/components/formatted_text.dart';
 export 'src/components/icon_button.dart';
+export 'src/components/menu_item.dart';
 export 'src/components/password_input.dart';
 export 'src/components/text_button.dart';
 export 'src/components/text_input.dart';

mobile/packages/ui/lib/src/components/column_button.dart

@@ -0,0 +1,78 @@
+import 'dart:async';
+
+import 'package:flutter/material.dart';
+import 'package:immich_ui/src/constants.dart';
+import 'package:immich_ui/src/internal.dart';
+
+class ImmichColumnButton extends StatefulWidget {
+  final IconData icon;
+  final String label;
+  final FutureOr<void> Function() onPressed;
+  final bool disabled;
+  final bool? loading;
+
+  const ImmichColumnButton({
+    super.key,
+    required this.icon,
+    required this.label,
+    required this.onPressed,
+    this.disabled = false,
+    this.loading,
+  });
+
+  @override
+  State<ImmichColumnButton> createState() => _ImmichColumnButtonState();
+}
+
+class _ImmichColumnButtonState extends State<ImmichColumnButton> {
+  bool _loading = false;
+  bool get _isLoading => widget.loading ?? _loading;
+
+  Future<void> _onPressed() async {
+    setState(() => _loading = true);
+    try {
+      await widget.onPressed();
+    } finally {
+      if (mounted) {
+        setState(() => _loading = false);
+      }
+    }
+  }
+
+  @override
+  Widget build(BuildContext context) {
+    final foreground = context.colorOverride ?? Theme.of(context).colorScheme.onSurface;
+
+    return TextButton(
+      onPressed: widget.disabled || _isLoading ? null : _onPressed,
+      style: TextButton.styleFrom(
+        foregroundColor: foreground,
+        padding: const .symmetric(horizontal: ImmichSpacing.sm, vertical: ImmichSpacing.md),
+        tapTargetSize: .shrinkWrap,
+        shape: const RoundedRectangleBorder(borderRadius: .all(.circular(ImmichRadius.xl))),
+      ),
+      child: ConstrainedBox(
+        constraints: const .new(maxWidth: 90),
+        child: Column(
+          mainAxisSize: .min,
+          children: [
+            _isLoading
+                ? const SizedBox.square(
+                    dimension: ImmichIconSize.md,
+                    child: CircularProgressIndicator(strokeWidth: ImmichBorderWidth.lg),
+                  )
+                : Icon(widget.icon, size: ImmichIconSize.md),
+            const SizedBox(height: ImmichSpacing.sm),
+            Text(
+              widget.label,
+              maxLines: 2,
+              textAlign: .center,
+              overflow: .ellipsis,
+              style: const .new(fontSize: ImmichTextSize.label, fontWeight: .w500),
+            ),
+          ],
+        ),
+      ),
+    );
+  }
+}

mobile/packages/ui/lib/src/components/menu_item.dart

@@ -0,0 +1,100 @@
+import 'dart:async';
+
+import 'package:flutter/material.dart';
+import 'package:immich_ui/src/constants.dart';
+import 'package:immich_ui/src/internal.dart';
+
+class ImmichMenu extends StatefulWidget {
+  final List<Widget> children;
+  final MenuAnchorChildBuilder builder;
+  final MenuStyle? style;
+  final bool consumeOutsideTap;
+  final Widget? child;
+
+  const ImmichMenu({
+    super.key,
+    required this.children,
+    required this.builder,
+    this.style,
+    this.consumeOutsideTap = false,
+    this.child,
+  });
+
+  @override
+  State<ImmichMenu> createState() => _ImmichMenuState();
+}
+
+class _ImmichMenuState extends State<ImmichMenu> {
+  final _controller = MenuController();
+
+  @override
+  Widget build(BuildContext context) {
+    return _ImmichMenuScope(
+      controller: _controller,
+      child: MenuAnchor(
+        controller: _controller,
+        style: widget.style,
+        consumeOutsideTap: widget.consumeOutsideTap,
+        menuChildren: widget.children,
+        builder: widget.builder,
+        child: widget.child,
+      ),
+    );
+  }
+}
+
+class _ImmichMenuScope extends InheritedWidget {
+  final MenuController controller;
+
+  const _ImmichMenuScope({required this.controller, required super.child});
+
+  static MenuController? maybeOf(BuildContext context) =>
+      context.dependOnInheritedWidgetOfExactType<_ImmichMenuScope>()?.controller;
+
+  @override
+  bool updateShouldNotify(_ImmichMenuScope oldWidget) => controller != oldWidget.controller;
+}
+
+class ImmichMenuItem extends StatefulWidget {
+  final IconData icon;
+  final String label;
+  final FutureOr<void> Function() onPressed;
+  final bool disabled;
+
+  const ImmichMenuItem({
+    super.key,
+    required this.icon,
+    required this.label,
+    required this.onPressed,
+    this.disabled = false,
+  });
+
+  @override
+  State<ImmichMenuItem> createState() => _ImmichMenuItemState();
+}
+
+class _ImmichMenuItemState extends State<ImmichMenuItem> {
+  Future<void> _onPressed(MenuController? controller) async {
+    try {
+      await widget.onPressed();
+    } finally {
+      controller?.close();
+    }
+  }
+
+  @override
+  Widget build(BuildContext context) {
+    final controller = _ImmichMenuScope.maybeOf(context);
+    return MenuItemButton(
+      onPressed: widget.disabled ? null : () => _onPressed(controller),
+      closeOnActivate: controller == null,
+      style: MenuItemButton.styleFrom(
+        foregroundColor: context.colorOverride,
+        alignment: .centerLeft,
+        padding: const .symmetric(horizontal: ImmichSpacing.lg, vertical: ImmichSpacing.md),
+      ),
+      leadingIcon: Icon(widget.icon, size: ImmichIconSize.sm),
+      child: Text(widget.label, style: const .new(fontSize: ImmichTextSize.body)),
+    );
+  }
+}

mobile/packages/ui/lib/src/previews/column_button.dart

@@ -0,0 +1,27 @@
+import 'package:flutter/material.dart';
+import 'package:immich_ui/src/components/column_button.dart';
+import 'package:immich_ui/src/previews.dart';
+
+void _previewNoop() {}
+
+@ImmichPreview(group: 'ColumnButton', name: 'Default')
+Widget previewColumnButtonDefault() => const Wrap(
+  spacing: 12,
+  runSpacing: 12,
+  children: [
+    ImmichColumnButton(onPressed: _previewNoop, icon: Icons.favorite_border_rounded, label: 'Favorite'),
+    ImmichColumnButton(onPressed: _previewNoop, icon: Icons.archive_outlined, label: 'Archive'),
+    ImmichColumnButton(onPressed: _previewNoop, icon: Icons.delete_outline_rounded, label: 'Delete'),
+  ],
+);
+
+@ImmichPreview(group: 'ColumnButton', name: 'Loading')
+Widget previewColumnButtonLoading() => ImmichColumnButton(
+  onPressed: () => Future<void>.delayed(const .new(seconds: 2)),
+  icon: Icons.download,
+  label: 'Download',
+);
+
+@ImmichPreview(group: 'ColumnButton', name: 'Disabled')
+Widget previewColumnButtonDisabled() =>
+    const ImmichColumnButton(onPressed: _previewNoop, icon: Icons.ios_share_rounded, label: 'Share', disabled: true);

mobile/packages/ui/lib/src/previews/menu_item.dart

@@ -0,0 +1,19 @@
+import 'package:flutter/material.dart';
+import 'package:immich_ui/src/components/menu_item.dart';
+import 'package:immich_ui/src/previews.dart';
+
+void _previewNoop() {}
+
+@ImmichPreview(group: 'MenuItem', name: 'Default')
+Widget previewMenuItemDefault() => const Column(
+  mainAxisSize: MainAxisSize.min,
+  children: [
+    ImmichMenuItem(onPressed: _previewNoop, icon: Icons.info_outline, label: 'Info'),
+    ImmichMenuItem(onPressed: _previewNoop, icon: Icons.help_outline_rounded, label: 'Troubleshoot'),
+    ImmichMenuItem(onPressed: _previewNoop, icon: Icons.cast_rounded, label: 'Cast'),
+  ],
+);
+
+@ImmichPreview(group: 'MenuItem', name: 'Disabled')
+Widget previewMenuItemDisabled() =>
+    const ImmichMenuItem(onPressed: _previewNoop, icon: Icons.delete_outline_rounded, label: 'Delete', disabled: true);

packages/plugin-core/manifest.json

@@ -278,9 +278,7 @@
             "title": "Album IDs",
             "array": true,
             "description": "Target album IDs",
-            "uiHint": {
-              "type": "AlbumId"
-            }
+            "uiHint": "AlbumId"
           },
           "albumName": {
             "type": "string",
@@ -370,20 +368,14 @@
             "type": "string",
             "title": "Album ID",
             "description": "Target album ID",
-            "uiHint": {
-              "type": "AlbumId",
-              "order": 1
-            }
+            "uiHint": "AlbumId"
           },
           "albumIds": {
             "type": "string",
             "title": "Album IDs",
             "description": "Target album IDs",
             "array": true,
-            "uiHint": {
-              "type": "AlbumId",
-              "order": 2
-            }
+            "uiHint": "AlbumId"
           }
         }
       }

server/src/dtos/json-schema.dto.ts

@@ -14,12 +14,7 @@ const JsonSchemaPropertySchema = z
     enum: z.array(z.string()).optional().describe('Valid choices for enum types'),
     array: z.boolean().optional().describe('Type is an array type'),
     required: z.array(z.string()).optional().describe('A list of required properties'),
-    uiHint: z
-      .object({
-        type: z.string().optional(),
-        order: z.int().optional(),
-      })
-      .optional(),
+    uiHint: z.string().optional(),
     get properties() {
       return z.record(z.string(), JsonSchemaPropertySchema).optional();
     },

web/src/lib/components/SchemaConfiguration.svelte

@@ -51,8 +51,6 @@
   };
 
   const setUiHintValue = (values: string[]) => setValue(schema.array ? values : values[0]);
-  const getSchemaProperties = (schema: JSONSchemaProperty) =>
-    Object.entries(schema.properties ?? {}).sort((a, b) => (a[1].uiHint?.order ?? 0) - (b[1].uiHint?.order ?? 0));
 
   const getBoolean = (defaultValue = false) => getValue<boolean>(defaultValue);
   const getString = () => getValue<string>();
@@ -74,11 +72,11 @@
     </div>
   {/if}
   <div class="flex flex-col gap-4 {root ? '' : 'border-l-4 border-gray-200 ps-2'}">
-    {#each getSchemaProperties(schema) as [childKey, childSchema] (childKey)}
+    {#each Object.entries(schema.properties ?? {}) as [childKey, childSchema] (childKey)}
       <Self schema={childSchema} key={childKey} bind:config={getValue, setValue} />
     {/each}
   </div>
-{:else if schema.uiHint?.type === 'AlbumId'}
+{:else if schema.uiHint === 'AlbumId'}
   <SchemaAlbumPicker {label} {description} array={schema.array} bind:albumIds={getUiHintValue, setUiHintValue} />
 {:else if schema.enum && schema.array}
   <Field {label} {description}>

web/src/lib/types.ts

@@ -96,10 +96,7 @@ export type JSONSchemaProperty = {
   array?: boolean;
   properties?: Record<string, JSONSchemaProperty>;
   required?: string[];
-  uiHint?: {
-    type?: 'AlbumId' | 'AssetId' | 'PersonId';
-    order?: number;
-  };
+  uiHint?: 'AlbumId' | 'AssetId' | 'PersonId';
 };
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any

web/src/routes/(user)/workflows/[workflowId]/WorkflowStepCard.svelte

@@ -55,7 +55,7 @@
   );
   const isGhost = $derived(step.id === 'ghost');
 
-  const getUiHint = (key: string) => schema?.properties?.[key]?.uiHint?.type;
+  const getUiHint = (key: string) => schema?.properties?.[key]?.uiHint;
   const toIds = (value: unknown): string[] => (Array.isArray(value) ? value.map(String) : [String(value)]);
   let dragImage = $state<Element>();
   let isDropTarget = $state(false);