feat: rebuild command menu (#6692)

This commit is contained in:
Thomas authored and GitHub committed 2026-08-24 15:40:09 +02:00
1 parent c9a48fa23f
commit 97d8390b20
59 files changed
+1559 -863

No files matched your search

@@ -1,22 +1,32 @@
import { Center, Loader } from "@mantine/core";
import { useWindowEvent } from "@mantine/hooks";
import { Center } from "@mantine/core";
import type { TranslationObject } from "@homarr/translation";
import { useI18n } from "@homarr/translation/client";
import type { SearchGroup } from "../../lib/group";
import type { inferSearchInteractionOptions } from "../../lib/interaction";
import { SpotlightNoResults } from "../no-results";
import type { SpotlightMode } from "../../open";
import { SpotlightGroupActionItem } from "./items/group-action-item";
interface GroupActionsProps<TOption extends Record<string, unknown>> {
group: SearchGroup<TOption>;
query: string;
setQuery: (query: string) => void;
setMode: (mode: keyof TranslationObject["search"]["mode"]) => void;
setMode: (mode: SpotlightMode) => void;
setChildrenOptions: (options: inferSearchInteractionOptions<"children">) => void;
}
const getUniqueOptions = <TOption extends Record<string, unknown>>(options: TOption[], keyPath: keyof TOption) => {
const optionKeys = new Set<unknown>();
return options.filter((option) => {
const optionKey = option[keyPath];
if (optionKeys.has(optionKey)) return false;
optionKeys.add(optionKey);
return true;
});
};
export const SpotlightGroupActions = <TOption extends Record<string, unknown>>({
group,
query,
@@ -30,28 +40,26 @@ export const SpotlightGroupActions = <TOption extends Record<string, unknown>>({
const options = useOptions(query);
const t = useI18n();
useWindowEvent("keydown", (event) => {
const optionsArray = Array.isArray(options) ? options : (options.data ?? []);
group.onKeyDown?.(event, optionsArray, query, { setChildrenOptions });
});
if (Array.isArray(options)) {
if (options.length === 0) {
return null;
}
const filteredOptions = options
.filter((option) => ("filter" in group ? group.filter(query, option) : false))
.sort((optionA, optionB) => {
if ("sort" in group) {
return group.sort?.(query, [optionA, optionB]) ?? 0;
}
const filteredOptions = getUniqueOptions(
options
.filter((option) => ("filter" in group ? group.filter(query, option) : false))
.sort((optionA, optionB) => {
if ("sort" in group) {
return group.sort?.(query, [optionA, optionB]) ?? 0;
}
return 0;
});
return 0;
}),
group.keyPath,
);
if (filteredOptions.length === 0) {
return <SpotlightNoResults />;
return null;
}
return filteredOptions.map((option) => (
@@ -68,15 +76,15 @@ export const SpotlightGroupActions = <TOption extends Record<string, unknown>>({
}
if (options.isLoading) {
return (
<Center w="100%" py="sm">
<Loader size="sm" />
</Center>
);
return <span hidden data-search-pending />;
}
if (options.isError) {
return <Center py="sm">{t("search.error.fetch")}</Center>;
return (
<Center py="sm" data-search-status>
{t("search.error.fetch")}
</Center>
);
}
if (!options.data) {
@@ -84,10 +92,10 @@ export const SpotlightGroupActions = <TOption extends Record<string, unknown>>({
}
if (options.data.length === 0) {
return <SpotlightNoResults />;
return null;
}
return options.data.map((option) => (
return getUniqueOptions(options.data, group.keyPath).map((option) => (
<SpotlightGroupActionItem
key={option[group.keyPath] as never}
option={option}
@@ -1,18 +1,18 @@
import { Spotlight } from "@mantine/spotlight";
import type { TranslationObject } from "@homarr/translation";
import { translateIfNecessary } from "@homarr/translation";
import { useI18n } from "@homarr/translation/client";
import type { SearchGroup } from "../../../lib/group";
import type { inferSearchInteractionOptions } from "../../../lib/interaction";
import type { SpotlightMode } from "../../../open";
import { SpotlightGroupActions } from "../group-actions";
interface SpotlightActionGroupsProps {
groups: SearchGroup[];
query: string;
setQuery: (query: string) => void;
setMode: (mode: keyof TranslationObject["search"]["mode"]) => void;
setMode: (mode: SpotlightMode) => void;
setChildrenOptions: (options: inferSearchInteractionOptions<"children">) => void;
}
@@ -23,6 +23,8 @@ export const SpotlightActionGroups = ({ groups, ...others }: SpotlightActionGrou
<Spotlight.ActionsGroup
key={`${translateIfNecessary(t, group.title)}::${String(group.keyPath)}`}
label={translateIfNecessary(t, group.title)}
data-search-source={group.source?.kind ?? "local"}
data-remote-source={group.source?.kind === "remote" ? group.source.source : undefined}
>
{/*eslint-disable-next-line @typescript-eslint/no-explicit-any */}
<SpotlightGroupActions<any> group={group} {...others} />
@@ -1,11 +1,11 @@
import { Spotlight } from "@mantine/spotlight";
import { getSafeAppHref, SAFE_NEW_TAB_REL } from "@homarr/common";
import type { TranslationObject } from "@homarr/translation";
import { Link } from "@homarr/ui";
import type { SearchGroup } from "../../../lib/group";
import type { inferSearchInteractionOptions } from "../../../lib/interaction";
import type { SpotlightMode } from "../../../open";
import { selectAction, spotlightStore } from "../../../spotlight-store";
import classes from "./action-item.module.css";
@@ -13,7 +13,7 @@ interface SpotlightGroupActionItemProps<TOption extends Record<string, unknown>>
option: TOption;
query: string;
setQuery: (query: string) => void;
setMode: (mode: keyof TranslationObject["search"]["mode"]) => void;
setMode: (mode: SpotlightMode) => void;
setChildrenOptions: (options: inferSearchInteractionOptions<"children">) => void;
group: SearchGroup<TOption>;
}
@@ -34,7 +34,7 @@ export const SpotlightGroupActionItem = <TOption extends Record<string, unknown>
const safeHref = interaction.type === "link" ? getSafeAppHref(interaction.href) : undefined;
const renderRoot =
interaction.type === "link" && safeHref
interaction.type === "link" && safeHref && !unavailable
? (props: Record<string, unknown>) => {
return (
<Link
@@ -48,6 +48,8 @@ export const SpotlightGroupActionItem = <TOption extends Record<string, unknown>
: undefined;
const handleClickAsync = async () => {
if (unavailable) return;
if (interaction.type === "javaScript") {
await interaction.onSelect();
} else if (interaction.type === "setQuery") {
@@ -76,6 +78,7 @@ export const SpotlightGroupActionItem = <TOption extends Record<string, unknown>
}
className={classes.spotlightAction}
aria-disabled={unavailable || undefined}
disabled={unavailable}
>
<group.Component {...(optionProps as TOption)} />
</Spotlight.Action>