Compare commits
10
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
65f0881504 | ||
|
|
2b9aa0fdf1 | ||
|
|
45368e11fc | ||
|
|
3f9b024020 | ||
|
|
6197c8e505 | ||
|
|
6316fa5407 | ||
|
|
7acff56abb | ||
|
|
389a99a203 | ||
|
|
91b916f015 | ||
|
|
769204ca3b |
No files matched your search
@@ -8,13 +8,28 @@ Homarr has the following keyboard shortcuts:
|
|||||||
|
|
||||||
| Shortcut | Description |
|
| Shortcut | Description |
|
||||||
| --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
| --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `MOD` + `K` | Opens the search bar |
|
| `MOD` + `K` | Opens search, including local apps, boards, integrations, pages, commands, and preferences |
|
||||||
|
| `MOD` + `P` | Opens app search |
|
||||||
|
| `MOD` + `/` | Opens Homarr Assistant inside search |
|
||||||
|
| `MOD` + `Shift` + `/` (`MOD` + `?`) | Opens preference search |
|
||||||
|
| `Shift` + `A` | Opens the full Homarr Assistant |
|
||||||
| `MOD` + `J` | Toggles Dark Mode |
|
| `MOD` + `J` | Toggles Dark Mode |
|
||||||
| `MOD` + `E` | Toggles Edit Mode |
|
| `MOD` + `E` | Toggles Edit Mode |
|
||||||
| Hold `Shift` for 500 ms over a supported widget | Opens its temporary advanced view |
|
| Hold `Shift` for 500 ms over a supported widget | Opens its temporary advanced view |
|
||||||
| Hold `Shift` + `Ctrl`/`Cmd` over a supported widget | Keeps its advanced view open until it is closed |
|
| Hold `Shift` + `Ctrl`/`Cmd` over a supported widget | Keeps its advanced view open until it is closed |
|
||||||
| `Esc` | Stops keyboard tile editing, cancels an active pointer or touch move/resize, or closes an open advanced view or board menu |
|
| `Esc` | Stops keyboard tile editing, cancels an active pointer or touch move/resize, or closes an open advanced view or board menu |
|
||||||
|
|
||||||
|
## Search and commands
|
||||||
|
|
||||||
|
Search is designed as the fastest route to Homarr. Start typing after `MOD` + `K` to find local apps, boards,
|
||||||
|
integrations, pages, commands, and preferences without entering a separate mode first. Local Homarr results appear
|
||||||
|
before configured search-engine actions and Assistant fallbacks. Commands include opening the board switcher without
|
||||||
|
leaving the keyboard. Type `!` to enter Web mode when you want to browse configured engine shortcuts or discover
|
||||||
|
DuckDuckGo bangs; bang discovery is excluded from ordinary Search results.
|
||||||
|
|
||||||
|
Use the dedicated shortcuts above to start in apps, Assistant, or preferences. Inside search, choose a mode to narrow
|
||||||
|
the same query when needed. Media request search is available only when a supported Seerr integration is configured.
|
||||||
|
|
||||||
## Widget advanced view
|
## Widget advanced view
|
||||||
|
|
||||||
Supported widgets open a temporary advanced view when you hold `Shift` over them for 500 ms. Hold `Shift` plus `Ctrl`
|
Supported widgets open a temporary advanced view when you hold `Shift` over them for 500 ms. Hold `Shift` plus `Ctrl`
|
||||||
|
|||||||
@@ -38,7 +38,7 @@ host gateway address.
|
|||||||
## Use it
|
## Use it
|
||||||
|
|
||||||
- Select **Assistant** in the user menu or press `Shift + A`.
|
- Select **Assistant** in the user menu or press `Shift + A`.
|
||||||
- Ask from `Cmd/Ctrl + K`.
|
- Press `Cmd/Ctrl + /` to ask from search, or use `Cmd/Ctrl + K` and choose the Assistant fallback.
|
||||||
- Add the [Assistant widget](../widgets/assistant) to a board.
|
- Add the [Assistant widget](../widgets/assistant) to a board.
|
||||||
|
|
||||||
The assistant can work with boards, apps, integrations, widgets, Custom Widgets, and connected services. Use `@` to
|
The assistant can work with boards, apps, integrations, widgets, Custom Widgets, and connected services. Use `@` to
|
||||||
|
|||||||
@@ -7,9 +7,13 @@ tags:
|
|||||||
|
|
||||||
# Search Engines
|
# Search Engines
|
||||||
|
|
||||||
Using the search engines, terms can be quickly searched simply by opening the search bar at the top or using the keyboard shortcut `CTRL + K`.
|
Using the search engines, terms can be quickly searched simply by opening the search bar at the top or using the keyboard shortcut `MOD + K`.
|
||||||
The management page provides a searchable list with the shortcut, URL template, source, and available row actions for each engine.
|
The management page provides a searchable list with the shortcut, URL template, source, and available row actions for each engine.
|
||||||
|
|
||||||
|
The default **Search** mode lists every configured search engine as a fallback action for the current query. To discover
|
||||||
|
engines by shortcut, switch to **Web** with `!`. DuckDuckGo bang discovery is intentionally limited to Web mode so an
|
||||||
|
ordinary search term never expands into similarly named bang providers.
|
||||||
|
|
||||||
You can add any search engine that has a search URL that accepts a search term as a parameter.
|
You can add any search engine that has a search URL that accepts a search term as a parameter.
|
||||||
|
|
||||||
## Create search engine
|
## Create search engine
|
||||||
@@ -26,6 +30,8 @@ The name can be chosen freely. It will be displayed in the search box popover.
|
|||||||
|
|
||||||
Prefix that is used to choose the search engine in the popover using the keyboard.
|
Prefix that is used to choose the search engine in the popover using the keyboard.
|
||||||
It is recommended that this value is kept short (for example `g` for Google and `e` for Ecosia).
|
It is recommended that this value is kept short (for example `g` for Google and `e` for Ecosia).
|
||||||
|
Type `!` in Spotlight to browse these shortcuts and, when DuckDuckGo bangs are enabled in preferences, discover
|
||||||
|
additional bang providers.
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
|
||||||
|
|||||||
@@ -11,6 +11,7 @@ import { useI18n } from "@homarr/translation/client";
|
|||||||
import { FloatingTip } from "@homarr/ui";
|
import { FloatingTip } from "@homarr/ui";
|
||||||
|
|
||||||
import { BoardAdvancedFocusProvider } from "~/components/board/advanced-focus/context";
|
import { BoardAdvancedFocusProvider } from "~/components/board/advanced-focus/context";
|
||||||
|
import { BoardAppsSpotlightRegistrar } from "~/components/board/board-apps-spotlight-registrar";
|
||||||
import { BoardEmptyState } from "~/components/board/board-empty-state";
|
import { BoardEmptyState } from "~/components/board/board-empty-state";
|
||||||
import { BoardSetupChecklist } from "~/components/board/board-setup-checklist";
|
import { BoardSetupChecklist } from "~/components/board/board-setup-checklist";
|
||||||
import {
|
import {
|
||||||
@@ -79,6 +80,7 @@ export const ClientBoard = () => {
|
|||||||
<BoardSelectionGridProvider>
|
<BoardSelectionGridProvider>
|
||||||
<BoardAdvancedFocusProvider>
|
<BoardAdvancedFocusProvider>
|
||||||
<Box h="100%" pos="relative" data-homarr-dev-benchmark-board>
|
<Box h="100%" pos="relative" data-homarr-dev-benchmark-board>
|
||||||
|
<BoardAppsSpotlightRegistrar />
|
||||||
<BoardBackgroundVideo />
|
<BoardBackgroundVideo />
|
||||||
<BoardEmptyState />
|
<BoardEmptyState />
|
||||||
<BoardSetupChecklist />
|
<BoardSetupChecklist />
|
||||||
|
|||||||
@@ -856,6 +856,7 @@ const EnabledAssistantProvider = ({ children }: PropsWithChildren) => {
|
|||||||
: t("busy.description"),
|
: t("busy.description"),
|
||||||
unavailable: !canSend,
|
unavailable: !canSend,
|
||||||
alwaysVisible: true,
|
alwaysVisible: true,
|
||||||
|
placement: "fallback" as const,
|
||||||
interaction: (query: string) =>
|
interaction: (query: string) =>
|
||||||
createAssistantPromptInteraction({
|
createAssistantPromptInteraction({
|
||||||
sendPrompt,
|
sendPrompt,
|
||||||
|
|||||||
@@ -19,6 +19,7 @@ export const useRegisterAssistantSpotlightPlaceholder = (description: string) =>
|
|||||||
description,
|
description,
|
||||||
unavailable: true,
|
unavailable: true,
|
||||||
alwaysVisible: true,
|
alwaysVisible: true,
|
||||||
|
placement: "fallback" as const,
|
||||||
interaction: (_query: string) => ({ type: "none" as const }),
|
interaction: (_query: string) => ({ type: "none" as const }),
|
||||||
}),
|
}),
|
||||||
[description, t],
|
[description, t],
|
||||||
|
|||||||
@@ -0,0 +1,70 @@
|
|||||||
|
"use client";
|
||||||
|
|
||||||
|
import { useEffect, useMemo, useState } from "react";
|
||||||
|
|
||||||
|
import { clientApi } from "@homarr/api/client";
|
||||||
|
import { useRequiredBoard } from "@homarr/boards/context";
|
||||||
|
import { getSafeAppHref } from "@homarr/common";
|
||||||
|
import type { ContextSpecificItem } from "@homarr/spotlight";
|
||||||
|
import { useRegisterSpotlightContextResults } from "@homarr/spotlight";
|
||||||
|
import { hasPendingSpotlightOpen, spotlightOpenEvent } from "@homarr/spotlight/open";
|
||||||
|
|
||||||
|
export const BoardAppsSpotlightRegistrar = () => {
|
||||||
|
const board = useRequiredBoard();
|
||||||
|
const [isSpotlightActivated, setIsSpotlightActivated] = useState(() => hasPendingSpotlightOpen());
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
if (isSpotlightActivated) return;
|
||||||
|
|
||||||
|
const activateSpotlightQueries = () => setIsSpotlightActivated(true);
|
||||||
|
window.addEventListener(spotlightOpenEvent, activateSpotlightQueries);
|
||||||
|
|
||||||
|
if (hasPendingSpotlightOpen()) activateSpotlightQueries();
|
||||||
|
|
||||||
|
return () => window.removeEventListener(spotlightOpenEvent, activateSpotlightQueries);
|
||||||
|
}, [isSpotlightActivated]);
|
||||||
|
|
||||||
|
const openInNewTabByAppId = useMemo(() => {
|
||||||
|
const result = new Map<string, boolean>();
|
||||||
|
|
||||||
|
for (const item of board.items) {
|
||||||
|
if (item.kind !== "app" || typeof item.options.appId !== "string" || item.options.appId.length === 0) continue;
|
||||||
|
|
||||||
|
const existingOpenInNewTab = result.get(item.options.appId) ?? false;
|
||||||
|
result.set(item.options.appId, existingOpenInNewTab || item.options.openInNewTab === true);
|
||||||
|
}
|
||||||
|
|
||||||
|
return result;
|
||||||
|
}, [board.items]);
|
||||||
|
const appIds = useMemo(() => Array.from(openInNewTabByAppId.keys()), [openInNewTabByAppId]);
|
||||||
|
const activeAppIds = isSpotlightActivated ? appIds : [];
|
||||||
|
const appQueries = clientApi.useQueries((trpc) => activeAppIds.map((id) => trpc.app.byId({ id })));
|
||||||
|
const apps = appQueries.flatMap((query) => query.data ?? []);
|
||||||
|
const spotlightItems = useMemo<ContextSpecificItem[]>(() => {
|
||||||
|
return apps.flatMap((app) => {
|
||||||
|
const href = getSafeAppHref(app.href);
|
||||||
|
if (!href) return [];
|
||||||
|
|
||||||
|
return [
|
||||||
|
{
|
||||||
|
id: app.id,
|
||||||
|
dedupeKey: `app:${app.id}`,
|
||||||
|
name: app.name,
|
||||||
|
icon: app.iconUrl,
|
||||||
|
interaction() {
|
||||||
|
return {
|
||||||
|
type: "link" as const,
|
||||||
|
href,
|
||||||
|
// Opening a new tab wins if any widget instance requests it.
|
||||||
|
newTab: openInNewTabByAppId.get(app.id) ?? false,
|
||||||
|
};
|
||||||
|
},
|
||||||
|
},
|
||||||
|
];
|
||||||
|
});
|
||||||
|
}, [apps, openInNewTabByAppId]);
|
||||||
|
|
||||||
|
useRegisterSpotlightContextResults("board-apps", spotlightItems, [spotlightItems]);
|
||||||
|
|
||||||
|
return null;
|
||||||
|
};
|
||||||
@@ -26,6 +26,7 @@ import { IconDeviceMobile, IconHomeFilled, IconLayoutBoard, IconSearch } from "@
|
|||||||
import type { RouterOutputs } from "@homarr/api";
|
import type { RouterOutputs } from "@homarr/api";
|
||||||
import { clientApi } from "@homarr/api/client";
|
import { clientApi } from "@homarr/api/client";
|
||||||
import { useOptionalBoard } from "@homarr/boards/context";
|
import { useOptionalBoard } from "@homarr/boards/context";
|
||||||
|
import { useRegisterSpotlightContextActions } from "@homarr/spotlight";
|
||||||
import { useI18n } from "@homarr/translation/client";
|
import { useI18n } from "@homarr/translation/client";
|
||||||
import { Link, UserAvatar } from "@homarr/ui";
|
import { Link, UserAvatar } from "@homarr/ui";
|
||||||
|
|
||||||
@@ -41,6 +42,7 @@ interface BoardSwitcherProps {
|
|||||||
|
|
||||||
export const BoardSwitcher = ({ children }: BoardSwitcherProps) => {
|
export const BoardSwitcher = ({ children }: BoardSwitcherProps) => {
|
||||||
const t = useI18n("board.action.switcher");
|
const t = useI18n("board.action.switcher");
|
||||||
|
const tBoard = useI18n("board");
|
||||||
const manageBoardsT = useI18n("management.page.board");
|
const manageBoardsT = useI18n("management.page.board");
|
||||||
const currentBoard = useOptionalBoard();
|
const currentBoard = useOptionalBoard();
|
||||||
const [isOpen, setIsOpen] = useState(false);
|
const [isOpen, setIsOpen] = useState(false);
|
||||||
@@ -85,6 +87,20 @@ export const BoardSwitcher = ({ children }: BoardSwitcherProps) => {
|
|||||||
}, []);
|
}, []);
|
||||||
const preloadBoards = () => void utils.board.getManageOverview.prefetch({ fullPreview: true });
|
const preloadBoards = () => void utils.board.getManageOverview.prefetch({ fullPreview: true });
|
||||||
|
|
||||||
|
const spotlightAction = useMemo(
|
||||||
|
() => ({
|
||||||
|
id: "open-board-switcher",
|
||||||
|
name: tBoard("action.switch"),
|
||||||
|
icon: IconLayoutBoard,
|
||||||
|
interaction: () => ({
|
||||||
|
type: "javaScript" as const,
|
||||||
|
onSelect: openSwitcher,
|
||||||
|
}),
|
||||||
|
}),
|
||||||
|
[openSwitcher, tBoard],
|
||||||
|
);
|
||||||
|
useRegisterSpotlightContextActions("board-switcher", [spotlightAction], [spotlightAction]);
|
||||||
|
|
||||||
useHotkeys([[boardSwitcherHotkey, openSwitcher, { preventDefault: true }]]);
|
useHotkeys([[boardSwitcherHotkey, openSwitcher, { preventDefault: true }]]);
|
||||||
|
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
|
|||||||
@@ -2,6 +2,7 @@
|
|||||||
|
|
||||||
import { useEffect, useState } from "react";
|
import { useEffect, useState } from "react";
|
||||||
import dynamic from "next/dynamic";
|
import dynamic from "next/dynamic";
|
||||||
|
import type { HotkeyItem } from "@mantine/hooks";
|
||||||
import { useHotkeys } from "@mantine/hooks";
|
import { useHotkeys } from "@mantine/hooks";
|
||||||
|
|
||||||
import { hotkeys } from "@homarr/definitions";
|
import { hotkeys } from "@homarr/definitions";
|
||||||
@@ -13,23 +14,18 @@ const Spotlight = dynamic(() => loadSpotlight().then(({ Spotlight: Component })
|
|||||||
loading: () => null,
|
loading: () => null,
|
||||||
});
|
});
|
||||||
|
|
||||||
|
const spotlightHotkeys: HotkeyItem[] = [
|
||||||
|
[hotkeys.openSpotlight, () => openSpotlight(), { preventDefault: true }],
|
||||||
|
[hotkeys.openSpotlightApps, () => openSpotlight({ mode: "apps" }), { preventDefault: true }],
|
||||||
|
[hotkeys.openSpotlightAssistant, () => openSpotlight({ mode: "assistant" }), { preventDefault: true }],
|
||||||
|
[hotkeys.openSpotlightPreferences, () => openSpotlight({ mode: "preferences" }), { preventDefault: true }],
|
||||||
|
];
|
||||||
|
|
||||||
export const LazySpotlight = () => {
|
export const LazySpotlight = () => {
|
||||||
const [isMounted, setIsMounted] = useState(false);
|
const [isMounted, setIsMounted] = useState(false);
|
||||||
const [isPreloaded, setIsPreloaded] = useState(false);
|
const [isPreloaded, setIsPreloaded] = useState(false);
|
||||||
|
|
||||||
useHotkeys(
|
useHotkeys(spotlightHotkeys, [], true);
|
||||||
isMounted
|
|
||||||
? []
|
|
||||||
: [
|
|
||||||
[
|
|
||||||
hotkeys.openSpotlight,
|
|
||||||
() => {
|
|
||||||
setIsMounted(true);
|
|
||||||
openSpotlight();
|
|
||||||
},
|
|
||||||
],
|
|
||||||
],
|
|
||||||
);
|
|
||||||
|
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
let isActive = true;
|
let isActive = true;
|
||||||
@@ -61,12 +57,8 @@ export const LazySpotlight = () => {
|
|||||||
return isMounted || isPreloaded ? (
|
return isMounted || isPreloaded ? (
|
||||||
<>
|
<>
|
||||||
{isPreloaded && <span hidden data-homarr-dev-benchmark-spotlight-preloaded />}
|
{isPreloaded && <span hidden data-homarr-dev-benchmark-spotlight-preloaded />}
|
||||||
{isMounted && (
|
{isMounted && <span hidden data-homarr-dev-benchmark-spotlight-mounted />}
|
||||||
<>
|
<Spotlight />
|
||||||
<span hidden data-homarr-dev-benchmark-spotlight-mounted />
|
|
||||||
<Spotlight />
|
|
||||||
</>
|
|
||||||
)}
|
|
||||||
</>
|
</>
|
||||||
) : null;
|
) : null;
|
||||||
};
|
};
|
||||||
@@ -20,7 +20,7 @@ export const DesktopSearchInput = () => {
|
|||||||
w={400}
|
w={400}
|
||||||
size="sm"
|
size="sm"
|
||||||
leftSection={<IconSearch size={20} stroke={1.5} />}
|
leftSection={<IconSearch size={20} stroke={1.5} />}
|
||||||
onClick={openSpotlight}
|
onClick={() => openSpotlight()}
|
||||||
radius="xl"
|
radius="xl"
|
||||||
>
|
>
|
||||||
{`${t("search.placeholder")}...`}
|
{`${t("search.placeholder")}...`}
|
||||||
@@ -32,7 +32,7 @@ export const MobileSearchButton = () => {
|
|||||||
return (
|
return (
|
||||||
<HeaderButton
|
<HeaderButton
|
||||||
data-homarr-dev-benchmark-interaction="search"
|
data-homarr-dev-benchmark-interaction="search"
|
||||||
onClick={openSpotlight}
|
onClick={() => openSpotlight()}
|
||||||
className={classes.mobileSearch}
|
className={classes.mobileSearch}
|
||||||
>
|
>
|
||||||
<IconSearch size={20} stroke={1.5} />
|
<IconSearch size={20} stroke={1.5} />
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ import { TRPCError } from "@trpc/server";
|
|||||||
import superjson from "superjson";
|
import superjson from "superjson";
|
||||||
import { z } from "zod/v4";
|
import { z } from "zod/v4";
|
||||||
|
|
||||||
|
import type { Session } from "@homarr/auth";
|
||||||
import { constructBoardPermissions } from "@homarr/auth/shared";
|
import { constructBoardPermissions } from "@homarr/auth/shared";
|
||||||
import { createId, generateResponsiveGridFor } from "@homarr/common";
|
import { createId, generateResponsiveGridFor } from "@homarr/common";
|
||||||
import type { GridAlgorithmItem } from "@homarr/common";
|
import type { GridAlgorithmItem } from "@homarr/common";
|
||||||
@@ -123,6 +124,78 @@ const findFirstAvailableBoardItemPosition = (
|
|||||||
return null;
|
return null;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
const searchAccessibleBoardsAsync = async (
|
||||||
|
ctx: { db: Database; session: Session | null },
|
||||||
|
query: string,
|
||||||
|
limit?: number,
|
||||||
|
) => {
|
||||||
|
const userId = ctx.session?.user.id;
|
||||||
|
const permissionsOfCurrentUserWhenPresent = await ctx.db.query.boardUserPermissions.findMany({
|
||||||
|
where: eq(boardUserPermissions.userId, userId ?? ""),
|
||||||
|
});
|
||||||
|
|
||||||
|
const permissionsOfCurrentUserGroupsWhenPresent = await ctx.db.query.groupMembers.findMany({
|
||||||
|
where: eq(groupMembers.userId, userId ?? ""),
|
||||||
|
with: {
|
||||||
|
group: {
|
||||||
|
with: {
|
||||||
|
boardPermissions: {},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
const boardIds = permissionsOfCurrentUserWhenPresent
|
||||||
|
.map((permission) => permission.boardId)
|
||||||
|
.concat(
|
||||||
|
permissionsOfCurrentUserGroupsWhenPresent
|
||||||
|
.map((groupMember) => groupMember.group.boardPermissions.map((permission) => permission.boardId))
|
||||||
|
.flat(),
|
||||||
|
);
|
||||||
|
|
||||||
|
const currentUserWhenPresent = await ctx.db.query.users.findFirst({
|
||||||
|
where: eq(users.id, userId ?? ""),
|
||||||
|
});
|
||||||
|
|
||||||
|
const foundBoards = await ctx.db.query.boards.findMany({
|
||||||
|
where: and(
|
||||||
|
like(boards.name, `%${query}%`),
|
||||||
|
ctx.session?.user.permissions.includes("board-view-all")
|
||||||
|
? undefined
|
||||||
|
: or(
|
||||||
|
eq(boards.isPublic, true),
|
||||||
|
eq(boards.creatorId, ctx.session?.user.id ?? ""),
|
||||||
|
inArray(boards.id, boardIds),
|
||||||
|
),
|
||||||
|
),
|
||||||
|
limit,
|
||||||
|
orderBy: asc(boards.name),
|
||||||
|
columns: {
|
||||||
|
id: true,
|
||||||
|
name: true,
|
||||||
|
creatorId: true,
|
||||||
|
isPublic: true,
|
||||||
|
logoImageUrl: true,
|
||||||
|
},
|
||||||
|
with: {
|
||||||
|
userPermissions: {
|
||||||
|
where: eq(boardUserPermissions.userId, ctx.session?.user.id ?? ""),
|
||||||
|
},
|
||||||
|
groupPermissions: {
|
||||||
|
where: getBoardGroupPermissionWhere(permissionsOfCurrentUserGroupsWhenPresent),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
return foundBoards.map((board) => ({
|
||||||
|
id: board.id,
|
||||||
|
name: board.name,
|
||||||
|
logoImageUrl: board.logoImageUrl,
|
||||||
|
permissions: constructBoardPermissions(board, ctx.session),
|
||||||
|
isHome: currentUserWhenPresent?.homeBoardId === board.id,
|
||||||
|
isMobileHome: currentUserWhenPresent?.mobileHomeBoardId === board.id,
|
||||||
|
}));
|
||||||
|
};
|
||||||
|
|
||||||
export const boardRouter = createTRPCRouter({
|
export const boardRouter = createTRPCRouter({
|
||||||
exists: permissionRequiredProcedure
|
exists: permissionRequiredProcedure
|
||||||
.requiresPermission("board-create")
|
.requiresPermission("board-create")
|
||||||
@@ -482,80 +555,18 @@ export const boardRouter = createTRPCRouter({
|
|||||||
};
|
};
|
||||||
});
|
});
|
||||||
}),
|
}),
|
||||||
|
catalog: publicProcedure
|
||||||
|
.meta({ mcp: { enabled: true, description: "List every board the current user can access." } })
|
||||||
|
.query(async ({ ctx }) => searchAccessibleBoardsAsync(ctx, "")),
|
||||||
search: publicProcedure
|
search: publicProcedure
|
||||||
|
.meta({
|
||||||
|
mcp: {
|
||||||
|
enabled: true,
|
||||||
|
description: "Search accessible boards by name. REQUIRED: query (string). OPTIONAL: limit (number).",
|
||||||
|
},
|
||||||
|
})
|
||||||
.input(z.object({ query: z.string(), limit: z.number().min(1).max(100).default(10) }))
|
.input(z.object({ query: z.string(), limit: z.number().min(1).max(100).default(10) }))
|
||||||
.query(async ({ ctx, input }) => {
|
.query(async ({ ctx, input }) => searchAccessibleBoardsAsync(ctx, input.query, input.limit)),
|
||||||
const userId = ctx.session?.user.id;
|
|
||||||
const permissionsOfCurrentUserWhenPresent = await ctx.db.query.boardUserPermissions.findMany({
|
|
||||||
where: eq(boardUserPermissions.userId, userId ?? ""),
|
|
||||||
});
|
|
||||||
|
|
||||||
const permissionsOfCurrentUserGroupsWhenPresent = await ctx.db.query.groupMembers.findMany({
|
|
||||||
where: eq(groupMembers.userId, userId ?? ""),
|
|
||||||
with: {
|
|
||||||
group: {
|
|
||||||
with: {
|
|
||||||
boardPermissions: {},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
});
|
|
||||||
const boardIds = permissionsOfCurrentUserWhenPresent
|
|
||||||
.map((permission) => permission.boardId)
|
|
||||||
.concat(
|
|
||||||
permissionsOfCurrentUserGroupsWhenPresent
|
|
||||||
.map((groupMember) => groupMember.group.boardPermissions.map((permission) => permission.boardId))
|
|
||||||
.flat(),
|
|
||||||
);
|
|
||||||
|
|
||||||
const currentUserWhenPresent = await ctx.db.query.users.findFirst({
|
|
||||||
where: eq(users.id, userId ?? ""),
|
|
||||||
});
|
|
||||||
|
|
||||||
const foundBoards = await ctx.db.query.boards.findMany({
|
|
||||||
where: and(
|
|
||||||
like(boards.name, `%${input.query}%`),
|
|
||||||
ctx.session?.user.permissions.includes("board-view-all")
|
|
||||||
? undefined
|
|
||||||
: or(
|
|
||||||
eq(boards.isPublic, true),
|
|
||||||
eq(boards.creatorId, ctx.session?.user.id ?? ""),
|
|
||||||
inArray(boards.id, boardIds),
|
|
||||||
),
|
|
||||||
),
|
|
||||||
limit: input.limit,
|
|
||||||
columns: {
|
|
||||||
id: true,
|
|
||||||
name: true,
|
|
||||||
creatorId: true,
|
|
||||||
isPublic: true,
|
|
||||||
logoImageUrl: true,
|
|
||||||
},
|
|
||||||
with: {
|
|
||||||
userPermissions: {
|
|
||||||
where: eq(boardUserPermissions.userId, ctx.session?.user.id ?? ""),
|
|
||||||
},
|
|
||||||
groupPermissions: {
|
|
||||||
where:
|
|
||||||
permissionsOfCurrentUserGroupsWhenPresent.length >= 1
|
|
||||||
? inArray(
|
|
||||||
boardGroupPermissions.groupId,
|
|
||||||
permissionsOfCurrentUserGroupsWhenPresent.map((groupMember) => groupMember.groupId),
|
|
||||||
)
|
|
||||||
: undefined,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
return foundBoards.map((board) => ({
|
|
||||||
id: board.id,
|
|
||||||
name: board.name,
|
|
||||||
logoImageUrl: board.logoImageUrl,
|
|
||||||
permissions: constructBoardPermissions(board, ctx.session),
|
|
||||||
isHome: currentUserWhenPresent?.homeBoardId === board.id,
|
|
||||||
isMobileHome: currentUserWhenPresent?.mobileHomeBoardId === board.id,
|
|
||||||
}));
|
|
||||||
}),
|
|
||||||
createBoard: permissionRequiredProcedure
|
createBoard: permissionRequiredProcedure
|
||||||
.requiresPermission("board-create")
|
.requiresPermission("board-create")
|
||||||
.meta({
|
.meta({
|
||||||
|
|||||||
@@ -130,6 +130,28 @@ export const searchEngineRouter = createTRPCRouter({
|
|||||||
|
|
||||||
return null;
|
return null;
|
||||||
}),
|
}),
|
||||||
|
catalog: publicProcedure
|
||||||
|
.meta({
|
||||||
|
mcp: {
|
||||||
|
enabled: true,
|
||||||
|
description: "List search engines available to the current user.",
|
||||||
|
},
|
||||||
|
})
|
||||||
|
.query(async ({ ctx }) => {
|
||||||
|
return await ctx.db.query.searchEngines.findMany({
|
||||||
|
where: ctx.session?.user ? undefined : eq(searchEngines.type, "generic"),
|
||||||
|
orderBy: asc(searchEngines.name),
|
||||||
|
with: {
|
||||||
|
integration: {
|
||||||
|
columns: {
|
||||||
|
kind: true,
|
||||||
|
url: true,
|
||||||
|
id: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}),
|
||||||
search: publicProcedure.input(searchSchema).query(async ({ ctx, input }) => {
|
search: publicProcedure.input(searchSchema).query(async ({ ctx, input }) => {
|
||||||
return await ctx.db.query.searchEngines.findMany({
|
return await ctx.db.query.searchEngines.findMany({
|
||||||
// Public dashboards have no session: restrict anonymous users to generic
|
// Public dashboards have no session: restrict anonymous users to generic
|
||||||
|
|||||||
@@ -19,8 +19,10 @@ const MCP_TOOL_ALLOWLIST = {
|
|||||||
"beszel_getAlerts",
|
"beszel_getAlerts",
|
||||||
"beszel_getSystems",
|
"beszel_getSystems",
|
||||||
"beszel_getSystemStats",
|
"beszel_getSystemStats",
|
||||||
|
"board_catalog",
|
||||||
"board_getAllBoards",
|
"board_getAllBoards",
|
||||||
"board_getBoardSettings",
|
"board_getBoardSettings",
|
||||||
|
"board_search",
|
||||||
"calendar_findAllEvents",
|
"calendar_findAllEvents",
|
||||||
"customWidget_get",
|
"customWidget_get",
|
||||||
"customWidget_getAuthoringPrompt",
|
"customWidget_getAuthoringPrompt",
|
||||||
|
|||||||
@@ -3,5 +3,8 @@ export const hotkeys = {
|
|||||||
toggleColorScheme: "mod+j",
|
toggleColorScheme: "mod+j",
|
||||||
saveNotebook: "mod+s",
|
saveNotebook: "mod+s",
|
||||||
openSpotlight: "mod+k",
|
openSpotlight: "mod+k",
|
||||||
|
openSpotlightApps: "mod+p",
|
||||||
|
openSpotlightAssistant: "mod+/",
|
||||||
|
openSpotlightPreferences: "mod+shift+?",
|
||||||
openAssistant: "shift+a",
|
openAssistant: "shift+a",
|
||||||
};
|
};
|
||||||
@@ -1,22 +1,32 @@
|
|||||||
import { Center, Loader } from "@mantine/core";
|
import { Center } from "@mantine/core";
|
||||||
import { useWindowEvent } from "@mantine/hooks";
|
|
||||||
|
|
||||||
import type { TranslationObject } from "@homarr/translation";
|
|
||||||
import { useI18n } from "@homarr/translation/client";
|
import { useI18n } from "@homarr/translation/client";
|
||||||
|
|
||||||
import type { SearchGroup } from "../../lib/group";
|
import type { SearchGroup } from "../../lib/group";
|
||||||
import type { inferSearchInteractionOptions } from "../../lib/interaction";
|
import type { inferSearchInteractionOptions } from "../../lib/interaction";
|
||||||
import { SpotlightNoResults } from "../no-results";
|
import type { SpotlightMode } from "../../open";
|
||||||
import { SpotlightGroupActionItem } from "./items/group-action-item";
|
import { SpotlightGroupActionItem } from "./items/group-action-item";
|
||||||
|
|
||||||
interface GroupActionsProps<TOption extends Record<string, unknown>> {
|
interface GroupActionsProps<TOption extends Record<string, unknown>> {
|
||||||
group: SearchGroup<TOption>;
|
group: SearchGroup<TOption>;
|
||||||
query: string;
|
query: string;
|
||||||
setQuery: (query: string) => void;
|
setQuery: (query: string) => void;
|
||||||
setMode: (mode: keyof TranslationObject["search"]["mode"]) => void;
|
setMode: (mode: SpotlightMode) => void;
|
||||||
setChildrenOptions: (options: inferSearchInteractionOptions<"children">) => 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>>({
|
export const SpotlightGroupActions = <TOption extends Record<string, unknown>>({
|
||||||
group,
|
group,
|
||||||
query,
|
query,
|
||||||
@@ -30,28 +40,26 @@ export const SpotlightGroupActions = <TOption extends Record<string, unknown>>({
|
|||||||
const options = useOptions(query);
|
const options = useOptions(query);
|
||||||
const t = useI18n();
|
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 (Array.isArray(options)) {
|
||||||
if (options.length === 0) {
|
if (options.length === 0) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
const filteredOptions = options
|
const filteredOptions = getUniqueOptions(
|
||||||
.filter((option) => ("filter" in group ? group.filter(query, option) : false))
|
options
|
||||||
.sort((optionA, optionB) => {
|
.filter((option) => ("filter" in group ? group.filter(query, option) : false))
|
||||||
if ("sort" in group) {
|
.sort((optionA, optionB) => {
|
||||||
return group.sort?.(query, [optionA, optionB]) ?? 0;
|
if ("sort" in group) {
|
||||||
}
|
return group.sort?.(query, [optionA, optionB]) ?? 0;
|
||||||
|
}
|
||||||
|
|
||||||
return 0;
|
return 0;
|
||||||
});
|
}),
|
||||||
|
group.keyPath,
|
||||||
|
);
|
||||||
|
|
||||||
if (filteredOptions.length === 0) {
|
if (filteredOptions.length === 0) {
|
||||||
return <SpotlightNoResults />;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
return filteredOptions.map((option) => (
|
return filteredOptions.map((option) => (
|
||||||
@@ -68,15 +76,15 @@ export const SpotlightGroupActions = <TOption extends Record<string, unknown>>({
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (options.isLoading) {
|
if (options.isLoading) {
|
||||||
return (
|
return <span hidden data-search-pending />;
|
||||||
<Center w="100%" py="sm">
|
|
||||||
<Loader size="sm" />
|
|
||||||
</Center>
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if (options.isError) {
|
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) {
|
if (!options.data) {
|
||||||
@@ -84,10 +92,10 @@ export const SpotlightGroupActions = <TOption extends Record<string, unknown>>({
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (options.data.length === 0) {
|
if (options.data.length === 0) {
|
||||||
return <SpotlightNoResults />;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
return options.data.map((option) => (
|
return getUniqueOptions(options.data, group.keyPath).map((option) => (
|
||||||
<SpotlightGroupActionItem
|
<SpotlightGroupActionItem
|
||||||
key={option[group.keyPath] as never}
|
key={option[group.keyPath] as never}
|
||||||
option={option}
|
option={option}
|
||||||
|
|||||||
@@ -1,18 +1,18 @@
|
|||||||
import { Spotlight } from "@mantine/spotlight";
|
import { Spotlight } from "@mantine/spotlight";
|
||||||
|
|
||||||
import type { TranslationObject } from "@homarr/translation";
|
|
||||||
import { translateIfNecessary } from "@homarr/translation";
|
import { translateIfNecessary } from "@homarr/translation";
|
||||||
import { useI18n } from "@homarr/translation/client";
|
import { useI18n } from "@homarr/translation/client";
|
||||||
|
|
||||||
import type { SearchGroup } from "../../../lib/group";
|
import type { SearchGroup } from "../../../lib/group";
|
||||||
import type { inferSearchInteractionOptions } from "../../../lib/interaction";
|
import type { inferSearchInteractionOptions } from "../../../lib/interaction";
|
||||||
|
import type { SpotlightMode } from "../../../open";
|
||||||
import { SpotlightGroupActions } from "../group-actions";
|
import { SpotlightGroupActions } from "../group-actions";
|
||||||
|
|
||||||
interface SpotlightActionGroupsProps {
|
interface SpotlightActionGroupsProps {
|
||||||
groups: SearchGroup[];
|
groups: SearchGroup[];
|
||||||
query: string;
|
query: string;
|
||||||
setQuery: (query: string) => void;
|
setQuery: (query: string) => void;
|
||||||
setMode: (mode: keyof TranslationObject["search"]["mode"]) => void;
|
setMode: (mode: SpotlightMode) => void;
|
||||||
setChildrenOptions: (options: inferSearchInteractionOptions<"children">) => void;
|
setChildrenOptions: (options: inferSearchInteractionOptions<"children">) => void;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -23,6 +23,8 @@ export const SpotlightActionGroups = ({ groups, ...others }: SpotlightActionGrou
|
|||||||
<Spotlight.ActionsGroup
|
<Spotlight.ActionsGroup
|
||||||
key={`${translateIfNecessary(t, group.title)}::${String(group.keyPath)}`}
|
key={`${translateIfNecessary(t, group.title)}::${String(group.keyPath)}`}
|
||||||
label={translateIfNecessary(t, group.title)}
|
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 */}
|
{/*eslint-disable-next-line @typescript-eslint/no-explicit-any */}
|
||||||
<SpotlightGroupActions<any> group={group} {...others} />
|
<SpotlightGroupActions<any> group={group} {...others} />
|
||||||
|
|||||||
@@ -1,11 +1,11 @@
|
|||||||
import { Spotlight } from "@mantine/spotlight";
|
import { Spotlight } from "@mantine/spotlight";
|
||||||
|
|
||||||
import { getSafeAppHref, SAFE_NEW_TAB_REL } from "@homarr/common";
|
import { getSafeAppHref, SAFE_NEW_TAB_REL } from "@homarr/common";
|
||||||
import type { TranslationObject } from "@homarr/translation";
|
|
||||||
import { Link } from "@homarr/ui";
|
import { Link } from "@homarr/ui";
|
||||||
|
|
||||||
import type { SearchGroup } from "../../../lib/group";
|
import type { SearchGroup } from "../../../lib/group";
|
||||||
import type { inferSearchInteractionOptions } from "../../../lib/interaction";
|
import type { inferSearchInteractionOptions } from "../../../lib/interaction";
|
||||||
|
import type { SpotlightMode } from "../../../open";
|
||||||
import { selectAction, spotlightStore } from "../../../spotlight-store";
|
import { selectAction, spotlightStore } from "../../../spotlight-store";
|
||||||
import classes from "./action-item.module.css";
|
import classes from "./action-item.module.css";
|
||||||
|
|
||||||
@@ -13,7 +13,7 @@ interface SpotlightGroupActionItemProps<TOption extends Record<string, unknown>>
|
|||||||
option: TOption;
|
option: TOption;
|
||||||
query: string;
|
query: string;
|
||||||
setQuery: (query: string) => void;
|
setQuery: (query: string) => void;
|
||||||
setMode: (mode: keyof TranslationObject["search"]["mode"]) => void;
|
setMode: (mode: SpotlightMode) => void;
|
||||||
setChildrenOptions: (options: inferSearchInteractionOptions<"children">) => void;
|
setChildrenOptions: (options: inferSearchInteractionOptions<"children">) => void;
|
||||||
group: SearchGroup<TOption>;
|
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 safeHref = interaction.type === "link" ? getSafeAppHref(interaction.href) : undefined;
|
||||||
const renderRoot =
|
const renderRoot =
|
||||||
interaction.type === "link" && safeHref
|
interaction.type === "link" && safeHref && !unavailable
|
||||||
? (props: Record<string, unknown>) => {
|
? (props: Record<string, unknown>) => {
|
||||||
return (
|
return (
|
||||||
<Link
|
<Link
|
||||||
@@ -48,6 +48,8 @@ export const SpotlightGroupActionItem = <TOption extends Record<string, unknown>
|
|||||||
: undefined;
|
: undefined;
|
||||||
|
|
||||||
const handleClickAsync = async () => {
|
const handleClickAsync = async () => {
|
||||||
|
if (unavailable) return;
|
||||||
|
|
||||||
if (interaction.type === "javaScript") {
|
if (interaction.type === "javaScript") {
|
||||||
await interaction.onSelect();
|
await interaction.onSelect();
|
||||||
} else if (interaction.type === "setQuery") {
|
} else if (interaction.type === "setQuery") {
|
||||||
@@ -76,6 +78,7 @@ export const SpotlightGroupActionItem = <TOption extends Record<string, unknown>
|
|||||||
}
|
}
|
||||||
className={classes.spotlightAction}
|
className={classes.spotlightAction}
|
||||||
aria-disabled={unavailable || undefined}
|
aria-disabled={unavailable || undefined}
|
||||||
|
disabled={unavailable}
|
||||||
>
|
>
|
||||||
<group.Component {...(optionProps as TOption)} />
|
<group.Component {...(optionProps as TOption)} />
|
||||||
</Spotlight.Action>
|
</Spotlight.Action>
|
||||||
|
|||||||
@@ -0,0 +1,80 @@
|
|||||||
|
import { Group, Kbd, ScrollArea, Text, UnstyledButton } from "@mantine/core";
|
||||||
|
import {
|
||||||
|
IconApps,
|
||||||
|
IconCommand,
|
||||||
|
IconMovie,
|
||||||
|
IconRobot,
|
||||||
|
IconSearch,
|
||||||
|
IconSettings,
|
||||||
|
IconUsers,
|
||||||
|
IconWorldSearch,
|
||||||
|
} from "@tabler/icons-react";
|
||||||
|
|
||||||
|
import { useSession } from "@homarr/auth/client";
|
||||||
|
|
||||||
|
import type { SpotlightMode } from "../open";
|
||||||
|
import classes from "./spotlight.module.css";
|
||||||
|
|
||||||
|
interface ModeRailEntry {
|
||||||
|
ariaLabel: string;
|
||||||
|
character?: string;
|
||||||
|
label: string;
|
||||||
|
mode: SpotlightMode;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SpotlightModeRailProps {
|
||||||
|
activeMode: SpotlightMode;
|
||||||
|
entries: ModeRailEntry[];
|
||||||
|
navigationLabel: string;
|
||||||
|
onModeChange: (mode: SpotlightMode) => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
const modeIcons: Record<SpotlightMode, typeof IconSearch> = {
|
||||||
|
search: IconSearch,
|
||||||
|
apps: IconApps,
|
||||||
|
command: IconCommand,
|
||||||
|
preferences: IconSettings,
|
||||||
|
assistant: IconRobot,
|
||||||
|
external: IconWorldSearch,
|
||||||
|
media: IconMovie,
|
||||||
|
userGroup: IconUsers,
|
||||||
|
};
|
||||||
|
|
||||||
|
export const SpotlightModeRail = ({ activeMode, entries, navigationLabel, onModeChange }: SpotlightModeRailProps) => {
|
||||||
|
const { data: session } = useSession();
|
||||||
|
const canManageUsers = session?.user.permissions.includes("admin") ?? false;
|
||||||
|
|
||||||
|
return (
|
||||||
|
<ScrollArea type="never" scrollbarSize={0} className={classes.modeRailViewport}>
|
||||||
|
<Group component="nav" aria-label={navigationLabel} wrap="nowrap" gap={4} className={classes.modeRail}>
|
||||||
|
{entries.map((entry) => {
|
||||||
|
if (entry.mode === "userGroup" && !canManageUsers) return null;
|
||||||
|
const Icon = modeIcons[entry.mode];
|
||||||
|
const active = entry.mode === activeMode;
|
||||||
|
|
||||||
|
return (
|
||||||
|
<UnstyledButton
|
||||||
|
type="button"
|
||||||
|
key={entry.mode}
|
||||||
|
className={classes.modeButton}
|
||||||
|
data-active={active || undefined}
|
||||||
|
aria-pressed={active}
|
||||||
|
aria-label={entry.ariaLabel}
|
||||||
|
onClick={() => onModeChange(entry.mode)}
|
||||||
|
>
|
||||||
|
<Icon size={15} stroke={1.7} />
|
||||||
|
<Text component="span" size="xs" fw={600} className={classes.modeLabel}>
|
||||||
|
{entry.label}
|
||||||
|
</Text>
|
||||||
|
{entry.character ? (
|
||||||
|
<Kbd size="xs" className={classes.modeKey}>
|
||||||
|
{entry.character}
|
||||||
|
</Kbd>
|
||||||
|
) : null}
|
||||||
|
</UnstyledButton>
|
||||||
|
);
|
||||||
|
})}
|
||||||
|
</Group>
|
||||||
|
</ScrollArea>
|
||||||
|
);
|
||||||
|
};
|
||||||
@@ -2,8 +2,8 @@ import { Spotlight } from "@mantine/spotlight";
|
|||||||
|
|
||||||
import { useI18n } from "@homarr/translation/client";
|
import { useI18n } from "@homarr/translation/client";
|
||||||
|
|
||||||
export const SpotlightNoResults = () => {
|
export const SpotlightNoResults = ({ className }: { className?: string }) => {
|
||||||
const t = useI18n();
|
const t = useI18n();
|
||||||
|
|
||||||
return <Spotlight.Empty>{t("search.nothingFound")}</Spotlight.Empty>;
|
return <Spotlight.Empty className={className}>{t("search.nothingFound")}</Spotlight.Empty>;
|
||||||
};
|
};
|
||||||
@@ -0,0 +1,106 @@
|
|||||||
|
.content {
|
||||||
|
overflow: hidden;
|
||||||
|
border: 1px solid light-dark(var(--mantine-color-gray-3), var(--mantine-color-dark-4));
|
||||||
|
box-shadow: var(--mantine-shadow-xl);
|
||||||
|
}
|
||||||
|
|
||||||
|
.search {
|
||||||
|
border-bottom: 1px solid light-dark(var(--mantine-color-gray-2), var(--mantine-color-dark-5));
|
||||||
|
}
|
||||||
|
|
||||||
|
.modeRailViewport {
|
||||||
|
border-bottom: 1px solid light-dark(var(--mantine-color-gray-2), var(--mantine-color-dark-5));
|
||||||
|
}
|
||||||
|
|
||||||
|
.modeRail {
|
||||||
|
min-width: max-content;
|
||||||
|
padding: var(--mantine-spacing-xs);
|
||||||
|
}
|
||||||
|
|
||||||
|
.modeButton {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 4px;
|
||||||
|
min-height: 30px;
|
||||||
|
padding-inline: 6px;
|
||||||
|
border-radius: var(--mantine-radius-sm);
|
||||||
|
color: var(--mantine-color-dimmed);
|
||||||
|
transition:
|
||||||
|
color 100ms ease,
|
||||||
|
background-color 100ms ease;
|
||||||
|
}
|
||||||
|
|
||||||
|
.modeKey {
|
||||||
|
min-width: 0;
|
||||||
|
padding: 0;
|
||||||
|
border: 0;
|
||||||
|
background: transparent;
|
||||||
|
color: inherit;
|
||||||
|
font-size: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.modeButton:hover {
|
||||||
|
color: var(--mantine-color-text);
|
||||||
|
background: light-dark(var(--mantine-color-gray-1), var(--mantine-color-dark-6));
|
||||||
|
}
|
||||||
|
|
||||||
|
.modeButton[data-active] {
|
||||||
|
color: var(--mantine-primary-color-filled);
|
||||||
|
background: var(--mantine-primary-color-light);
|
||||||
|
}
|
||||||
|
|
||||||
|
.modeButton:focus-visible {
|
||||||
|
outline: 2px solid var(--mantine-primary-color-filled);
|
||||||
|
outline-offset: -2px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.actionsList {
|
||||||
|
padding-block: 4px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.actionsList [data-search-source="fallback"] {
|
||||||
|
margin-top: var(--mantine-spacing-xs);
|
||||||
|
padding-top: var(--mantine-spacing-xs);
|
||||||
|
border-top: 1px dashed light-dark(var(--mantine-color-gray-3), var(--mantine-color-dark-4));
|
||||||
|
}
|
||||||
|
|
||||||
|
.actionsList > [data-search-source="fallback"]:first-child {
|
||||||
|
margin-top: 0;
|
||||||
|
padding-top: 0;
|
||||||
|
border-top: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.actionsList:has([data-action]) .emptyState,
|
||||||
|
.actionsList:has([data-search-pending]) .emptyState,
|
||||||
|
.actionsList:has([data-search-status]) .emptyState {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.actionsList [data-search-source]:has([data-search-pending]) {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.footer {
|
||||||
|
min-height: 42px;
|
||||||
|
border-top: 1px solid light-dark(var(--mantine-color-gray-2), var(--mantine-color-dark-5));
|
||||||
|
}
|
||||||
|
|
||||||
|
.footerHint {
|
||||||
|
color: light-dark(var(--mantine-color-gray-7), var(--mantine-color-gray-4));
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (max-width: 48em) {
|
||||||
|
.modeLabel {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.footerSecondary {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (prefers-reduced-motion: reduce) {
|
||||||
|
.modeButton {
|
||||||
|
transition: none;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -2,13 +2,12 @@
|
|||||||
|
|
||||||
import type { Dispatch, SetStateAction } from "react";
|
import type { Dispatch, SetStateAction } from "react";
|
||||||
import { useCallback, useEffect, useMemo, useRef, useState } from "react";
|
import { useCallback, useEffect, useMemo, useRef, useState } from "react";
|
||||||
import { ActionIcon, Center, Group, Kbd } from "@mantine/core";
|
import { ActionIcon, Center, Group, Kbd, Text } from "@mantine/core";
|
||||||
import { Spotlight as MantineSpotlight } from "@mantine/spotlight";
|
import { Spotlight as MantineSpotlight } from "@mantine/spotlight";
|
||||||
import { IconArrowLeft, IconSearch, IconX } from "@tabler/icons-react";
|
import { IconArrowDown, IconArrowLeft, IconArrowUp, IconCornerDownLeft, IconSearch, IconX } from "@tabler/icons-react";
|
||||||
import { useSetAtom } from "jotai";
|
import { useSetAtom } from "jotai";
|
||||||
|
|
||||||
import { hotkeys } from "@homarr/definitions";
|
import { translateIfNecessary } from "@homarr/translation";
|
||||||
import type { TranslationObject } from "@homarr/translation";
|
|
||||||
import { useI18n } from "@homarr/translation/client";
|
import { useI18n } from "@homarr/translation/client";
|
||||||
|
|
||||||
import {
|
import {
|
||||||
@@ -17,74 +16,142 @@ import {
|
|||||||
mediaRequestSearchEvent,
|
mediaRequestSearchEvent,
|
||||||
spotlightOpenEvent,
|
spotlightOpenEvent,
|
||||||
} from "../open";
|
} from "../open";
|
||||||
import type { OpenMediaRequestSearchOptions } from "../open";
|
import type { OpenMediaRequestSearchOptions, SpotlightMode, SpotlightOpenIntent } from "../open";
|
||||||
import type { inferSearchInteractionOptions } from "../lib/interaction";
|
import type { inferSearchInteractionOptions } from "../lib/interaction";
|
||||||
import type { SearchMode } from "../lib/mode";
|
import type { SearchMode } from "../lib/mode";
|
||||||
|
import { useSpotlightCatalogs } from "../lib/catalog";
|
||||||
import { searchModes } from "../modes";
|
import { searchModes } from "../modes";
|
||||||
import { useHomeEmptyGroupsWithPreferences } from "../modes/help/home-empty-groups";
|
|
||||||
import { contextSpecificSearchGroups } from "../modes/home/context-specific-group";
|
|
||||||
import { mediaRequestSearchScopeAtom, selectAction, spotlightActions, spotlightStore } from "../spotlight-store";
|
import { mediaRequestSearchScopeAtom, selectAction, spotlightActions, spotlightStore } from "../spotlight-store";
|
||||||
import { SpotlightChildrenActions } from "./actions/children-actions";
|
import { SpotlightChildrenActions } from "./actions/children-actions";
|
||||||
import { SpotlightActionGroups } from "./actions/groups/action-group";
|
import { SpotlightActionGroups } from "./actions/groups/action-group";
|
||||||
|
import { SpotlightModeRail } from "./mode-rail";
|
||||||
|
import { SpotlightNoResults } from "./no-results";
|
||||||
|
import classes from "./spotlight.module.css";
|
||||||
|
|
||||||
type SearchModeKey = keyof TranslationObject["search"]["mode"];
|
|
||||||
type ChildrenOptions = inferSearchInteractionOptions<"children">;
|
type ChildrenOptions = inferSearchInteractionOptions<"children">;
|
||||||
|
|
||||||
const defaultMode = "home";
|
const defaultMode: SpotlightMode = "search";
|
||||||
export const Spotlight = () => {
|
|
||||||
const searchModeState = useState<SearchModeKey>(defaultMode);
|
|
||||||
const queryState = useState("");
|
|
||||||
const mode = searchModeState[0];
|
|
||||||
const activeMode = useMemo(() => searchModes.find((searchMode) => searchMode.modeKey === mode), [mode]);
|
|
||||||
|
|
||||||
if (!activeMode) {
|
const resetSelection = () => {
|
||||||
return null;
|
requestAnimationFrame(() => selectAction(0, spotlightStore));
|
||||||
}
|
};
|
||||||
|
|
||||||
|
export const Spotlight = () => {
|
||||||
|
useSpotlightCatalogs();
|
||||||
|
|
||||||
|
const [mode, setMode] = useState<SpotlightMode>(defaultMode);
|
||||||
|
const [query, setQuery] = useState("");
|
||||||
|
const setMediaRequestSearchScope = useSetAtom(mediaRequestSearchScopeAtom);
|
||||||
|
const activeMode = useMemo(() => searchModes.find((searchMode) => searchMode.mode === mode), [mode]);
|
||||||
|
|
||||||
|
const applyOpenOptions = useCallback(
|
||||||
|
(options: SpotlightOpenIntent) => {
|
||||||
|
setMode(options.mode);
|
||||||
|
setQuery(options.query ?? "");
|
||||||
|
if (options.mode !== "media") setMediaRequestSearchScope({});
|
||||||
|
spotlightActions.open();
|
||||||
|
resetSelection();
|
||||||
|
},
|
||||||
|
[setMediaRequestSearchScope],
|
||||||
|
);
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
const handleOpen = (event: Event) => {
|
||||||
|
const pendingOptions = consumePendingSpotlightOpen();
|
||||||
|
const eventOptions = (event as CustomEvent<SpotlightOpenIntent>).detail;
|
||||||
|
applyOpenOptions(eventOptions ?? pendingOptions ?? { mode: defaultMode });
|
||||||
|
};
|
||||||
|
|
||||||
|
window.addEventListener(spotlightOpenEvent, handleOpen);
|
||||||
|
const pendingOptions = consumePendingSpotlightOpen();
|
||||||
|
if (pendingOptions) applyOpenOptions(pendingOptions);
|
||||||
|
return () => window.removeEventListener(spotlightOpenEvent, handleOpen);
|
||||||
|
}, [applyOpenOptions]);
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
const applyMediaRequestSearch = ({ integrationIds, query: mediaQuery }: OpenMediaRequestSearchOptions) => {
|
||||||
|
setMediaRequestSearchScope({ integrationIds });
|
||||||
|
applyOpenOptions({ mode: "media", query: mediaQuery });
|
||||||
|
};
|
||||||
|
|
||||||
|
const handleMediaRequestSearch = (event: Event) => {
|
||||||
|
const pendingOptions = consumePendingMediaRequestSearch();
|
||||||
|
const eventOptions = (event as CustomEvent<OpenMediaRequestSearchOptions>).detail;
|
||||||
|
applyMediaRequestSearch(eventOptions ?? pendingOptions ?? {});
|
||||||
|
};
|
||||||
|
|
||||||
|
window.addEventListener(mediaRequestSearchEvent, handleMediaRequestSearch);
|
||||||
|
const pendingOptions = consumePendingMediaRequestSearch();
|
||||||
|
if (pendingOptions) applyMediaRequestSearch(pendingOptions);
|
||||||
|
return () => window.removeEventListener(mediaRequestSearchEvent, handleMediaRequestSearch);
|
||||||
|
}, [applyOpenOptions, setMediaRequestSearchScope]);
|
||||||
|
|
||||||
|
if (!activeMode) return null;
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<SpotlightWithActiveMode key={mode} modeState={searchModeState} queryState={queryState} activeMode={activeMode} />
|
<SpotlightWithActiveMode
|
||||||
|
key={mode}
|
||||||
|
mode={mode}
|
||||||
|
setMode={setMode}
|
||||||
|
query={query}
|
||||||
|
setQuery={setQuery}
|
||||||
|
activeMode={activeMode}
|
||||||
|
/>
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
interface SpotlightWithActiveModeProps {
|
interface SpotlightWithActiveModeProps {
|
||||||
modeState: [SearchModeKey, Dispatch<SetStateAction<SearchModeKey>>];
|
mode: SpotlightMode;
|
||||||
queryState: [string, Dispatch<SetStateAction<string>>];
|
setMode: Dispatch<SetStateAction<SpotlightMode>>;
|
||||||
|
query: string;
|
||||||
|
setQuery: Dispatch<SetStateAction<string>>;
|
||||||
activeMode: SearchMode;
|
activeMode: SearchMode;
|
||||||
}
|
}
|
||||||
|
|
||||||
const SpotlightWithActiveMode = ({ modeState, queryState, activeMode }: SpotlightWithActiveModeProps) => {
|
const SpotlightWithActiveMode = ({ mode, setMode, query, setQuery, activeMode }: SpotlightWithActiveModeProps) => {
|
||||||
const [query, setQuery] = queryState;
|
|
||||||
const [mode, setMode] = modeState;
|
|
||||||
const [childrenStack, setChildrenStack] = useState<ChildrenOptions[]>([]);
|
const [childrenStack, setChildrenStack] = useState<ChildrenOptions[]>([]);
|
||||||
const childrenOptions = childrenStack.at(-1) ?? null;
|
const childrenOptions = childrenStack.at(-1) ?? null;
|
||||||
const t = useI18n();
|
const t = useI18n();
|
||||||
const inputRef = useRef<HTMLInputElement>(null);
|
const inputRef = useRef<HTMLInputElement>(null);
|
||||||
const setMediaRequestSearchScope = useSetAtom(mediaRequestSearchScopeAtom);
|
|
||||||
const useGroups = "groups" in activeMode ? () => activeMode.groups : activeMode.useGroups;
|
const useGroups = "groups" in activeMode ? () => activeMode.groups : activeMode.useGroups;
|
||||||
const groups = useGroups();
|
const groups = useGroups();
|
||||||
const homeEmptyGroups = useHomeEmptyGroupsWithPreferences();
|
const hasModeCharacter = activeMode.character !== undefined;
|
||||||
const hasModeCharacter = activeMode.modeKey !== defaultMode && activeMode.character !== undefined;
|
const activeModeLabel = translateIfNecessary(t, activeMode.label) ?? activeMode.mode;
|
||||||
|
const placeholder = translateIfNecessary(t, activeMode.placeholder) ?? t("search.placeholder");
|
||||||
|
const modeRailEntries = searchModes.map((searchMode) => {
|
||||||
|
const label = translateIfNecessary(t, searchMode.label) ?? searchMode.mode;
|
||||||
|
return {
|
||||||
|
mode: searchMode.mode,
|
||||||
|
character: searchMode.character,
|
||||||
|
label,
|
||||||
|
ariaLabel: t("search.modePicker.modeAriaLabel", { mode: label }),
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
const handleOpen = () => {
|
requestAnimationFrame(() => inputRef.current?.focus());
|
||||||
consumePendingSpotlightOpen();
|
|
||||||
spotlightActions.open();
|
|
||||||
};
|
|
||||||
|
|
||||||
window.addEventListener(spotlightOpenEvent, handleOpen);
|
|
||||||
if (consumePendingSpotlightOpen()) spotlightActions.open();
|
|
||||||
return () => window.removeEventListener(spotlightOpenEvent, handleOpen);
|
|
||||||
}, []);
|
}, []);
|
||||||
|
|
||||||
const clearChildrenStack = useCallback(() => {
|
const clearChildrenStack = useCallback(() => {
|
||||||
setChildrenStack([]);
|
setChildrenStack([]);
|
||||||
}, []);
|
}, []);
|
||||||
|
|
||||||
|
const changeMode = useCallback(
|
||||||
|
(nextMode: SpotlightMode, preserveQuery = true) => {
|
||||||
|
setMode(nextMode);
|
||||||
|
clearChildrenStack();
|
||||||
|
if (!preserveQuery) setQuery("");
|
||||||
|
resetSelection();
|
||||||
|
requestAnimationFrame(() => inputRef.current?.focus());
|
||||||
|
},
|
||||||
|
[clearChildrenStack, setMode, setQuery],
|
||||||
|
);
|
||||||
|
|
||||||
const pushChildrenOptions = useCallback(
|
const pushChildrenOptions = useCallback(
|
||||||
(options: ChildrenOptions) => {
|
(options: ChildrenOptions) => {
|
||||||
setChildrenStack((currentStack) => [...currentStack, options]);
|
setChildrenStack((currentStack) => [...currentStack, options]);
|
||||||
setQuery("");
|
setQuery("");
|
||||||
setTimeout(() => selectAction(0, spotlightStore));
|
resetSelection();
|
||||||
},
|
},
|
||||||
[setQuery],
|
[setQuery],
|
||||||
);
|
);
|
||||||
@@ -92,44 +159,19 @@ const SpotlightWithActiveMode = ({ modeState, queryState, activeMode }: Spotligh
|
|||||||
const popChildrenOptions = useCallback(() => {
|
const popChildrenOptions = useCallback(() => {
|
||||||
setChildrenStack((currentStack) => currentStack.slice(0, -1));
|
setChildrenStack((currentStack) => currentStack.slice(0, -1));
|
||||||
setQuery("");
|
setQuery("");
|
||||||
setTimeout(() => selectAction(0, spotlightStore));
|
resetSelection();
|
||||||
}, [setQuery]);
|
}, [setQuery]);
|
||||||
|
|
||||||
useEffect(() => {
|
|
||||||
const applyMediaRequestSearch = ({ integrationIds, query: searchQuery }: OpenMediaRequestSearchOptions) => {
|
|
||||||
setMediaRequestSearchScope({ integrationIds });
|
|
||||||
setMode("media");
|
|
||||||
clearChildrenStack();
|
|
||||||
setQuery(searchQuery ?? "");
|
|
||||||
spotlightActions.open();
|
|
||||||
setTimeout(() => selectAction(0, spotlightStore));
|
|
||||||
};
|
|
||||||
|
|
||||||
const handleMediaRequestSearch = (event: Event) => {
|
|
||||||
consumePendingMediaRequestSearch();
|
|
||||||
const { integrationIds, query: searchQuery } = (event as CustomEvent<OpenMediaRequestSearchOptions>).detail ?? {};
|
|
||||||
applyMediaRequestSearch({ integrationIds, query: searchQuery });
|
|
||||||
};
|
|
||||||
|
|
||||||
window.addEventListener(mediaRequestSearchEvent, handleMediaRequestSearch);
|
|
||||||
const pendingSearch = consumePendingMediaRequestSearch();
|
|
||||||
if (pendingSearch) applyMediaRequestSearch(pendingSearch);
|
|
||||||
return () => {
|
|
||||||
window.removeEventListener(mediaRequestSearchEvent, handleMediaRequestSearch);
|
|
||||||
};
|
|
||||||
}, [setMediaRequestSearchScope, setMode, setQuery, clearChildrenStack]);
|
|
||||||
|
|
||||||
useEffect(() => {
|
|
||||||
if (mode !== "media") {
|
|
||||||
setMediaRequestSearchScope({});
|
|
||||||
}
|
|
||||||
}, [mode, setMediaRequestSearchScope]);
|
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<MantineSpotlight.Root
|
<MantineSpotlight.Root
|
||||||
shortcut={hotkeys.openSpotlight}
|
shortcut={null}
|
||||||
yOffset={8}
|
size={760}
|
||||||
overlayProps={{ blur: 2, backgroundOpacity: 0.2 }}
|
yOffset={64}
|
||||||
|
scrollable
|
||||||
|
maxHeight="min(62vh, 560px)"
|
||||||
|
overlayProps={{ blur: 3, backgroundOpacity: 0.24 }}
|
||||||
|
attributes={{ content: { "aria-label": t("search.modePicker.dialogAriaLabel", { mode: activeModeLabel }) } }}
|
||||||
|
classNames={{ content: classes.content }}
|
||||||
onSpotlightOpen={() => {
|
onSpotlightOpen={() => {
|
||||||
requestAnimationFrame(() => inputRef.current?.focus());
|
requestAnimationFrame(() => inputRef.current?.focus());
|
||||||
}}
|
}}
|
||||||
@@ -143,22 +185,24 @@ const SpotlightWithActiveMode = ({ modeState, queryState, activeMode }: Spotligh
|
|||||||
const sanitizedQuery = mode === "external" && nextQuery.startsWith("!") ? nextQuery.slice(1) : nextQuery;
|
const sanitizedQuery = mode === "external" && nextQuery.startsWith("!") ? nextQuery.slice(1) : nextQuery;
|
||||||
setQuery(sanitizedQuery);
|
setQuery(sanitizedQuery);
|
||||||
|
|
||||||
if (sanitizedQuery.length !== 1) return;
|
if (sanitizedQuery.length === 1) {
|
||||||
|
const modeToActivate = searchModes.find((searchMode) => searchMode.character === sanitizedQuery);
|
||||||
|
if (modeToActivate) {
|
||||||
|
changeMode(modeToActivate.mode, false);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
const modeToActivate = searchModes.find((searchMode) => searchMode.character === sanitizedQuery);
|
resetSelection();
|
||||||
if (!modeToActivate) return;
|
|
||||||
|
|
||||||
setMode(modeToActivate.modeKey);
|
|
||||||
clearChildrenStack();
|
|
||||||
setQuery("");
|
|
||||||
setTimeout(() => selectAction(0, spotlightStore));
|
|
||||||
}}
|
}}
|
||||||
store={spotlightStore}
|
store={spotlightStore}
|
||||||
>
|
>
|
||||||
<MantineSpotlight.Search
|
<MantineSpotlight.Search
|
||||||
data-homarr-dev-benchmark-spotlight
|
data-homarr-dev-benchmark-spotlight
|
||||||
placeholder={`${t("search.placeholder")}...`}
|
aria-label={placeholder}
|
||||||
|
placeholder={placeholder}
|
||||||
ref={inputRef}
|
ref={inputRef}
|
||||||
|
className={classes.search}
|
||||||
leftSectionWidth={hasModeCharacter ? 80 : 48}
|
leftSectionWidth={hasModeCharacter ? 80 : 48}
|
||||||
leftSection={
|
leftSection={
|
||||||
<Group align="center" wrap="nowrap" gap="xs" w="100%" h="100%">
|
<Group align="center" wrap="nowrap" gap="xs" w="100%" h="100%">
|
||||||
@@ -168,11 +212,7 @@ const SpotlightWithActiveMode = ({ modeState, queryState, activeMode }: Spotligh
|
|||||||
{hasModeCharacter ? <Kbd size="sm">{activeMode.character}</Kbd> : null}
|
{hasModeCharacter ? <Kbd size="sm">{activeMode.character}</Kbd> : null}
|
||||||
</Group>
|
</Group>
|
||||||
}
|
}
|
||||||
styles={{
|
styles={{ section: { pointerEvents: "all" } }}
|
||||||
section: {
|
|
||||||
pointerEvents: "all",
|
|
||||||
},
|
|
||||||
}}
|
|
||||||
rightSection={
|
rightSection={
|
||||||
mode === defaultMode && childrenStack.length === 0 ? null : (
|
mode === defaultMode && childrenStack.length === 0 ? null : (
|
||||||
<ActionIcon
|
<ActionIcon
|
||||||
@@ -188,9 +228,7 @@ const SpotlightWithActiveMode = ({ modeState, queryState, activeMode }: Spotligh
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
setMode(defaultMode);
|
changeMode(defaultMode, true);
|
||||||
clearChildrenStack();
|
|
||||||
inputRef.current?.focus();
|
|
||||||
}}
|
}}
|
||||||
variant="subtle"
|
variant="subtle"
|
||||||
aria-label={
|
aria-label={
|
||||||
@@ -212,20 +250,28 @@ const SpotlightWithActiveMode = ({ modeState, queryState, activeMode }: Spotligh
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (mode !== defaultMode) {
|
if (mode !== defaultMode) changeMode(defaultMode, true);
|
||||||
setMode(defaultMode);
|
|
||||||
clearChildrenStack();
|
|
||||||
}
|
|
||||||
}}
|
}}
|
||||||
/>
|
/>
|
||||||
|
|
||||||
|
<SpotlightModeRail
|
||||||
|
activeMode={mode}
|
||||||
|
entries={modeRailEntries}
|
||||||
|
navigationLabel={t("search.modePicker.navigationLabel")}
|
||||||
|
onModeChange={changeMode}
|
||||||
|
/>
|
||||||
|
|
||||||
{childrenOptions ? (
|
{childrenOptions ? (
|
||||||
<Group key={childrenStack.length}>
|
<Group key={childrenStack.length}>
|
||||||
<childrenOptions.DetailComponent options={childrenOptions.option as never} />
|
<childrenOptions.DetailComponent options={childrenOptions.option as never} />
|
||||||
</Group>
|
</Group>
|
||||||
) : null}
|
) : null}
|
||||||
|
|
||||||
<MantineSpotlight.ActionsList>
|
<MantineSpotlight.ActionsList
|
||||||
|
component="section"
|
||||||
|
className={classes.actionsList}
|
||||||
|
aria-label={t("search.modePicker.resultsAriaLabel", { mode: activeModeLabel })}
|
||||||
|
>
|
||||||
{childrenOptions ? (
|
{childrenOptions ? (
|
||||||
<SpotlightChildrenActions
|
<SpotlightChildrenActions
|
||||||
key={childrenStack.length}
|
key={childrenStack.length}
|
||||||
@@ -236,21 +282,46 @@ const SpotlightWithActiveMode = ({ modeState, queryState, activeMode }: Spotligh
|
|||||||
) : (
|
) : (
|
||||||
<SpotlightActionGroups
|
<SpotlightActionGroups
|
||||||
setQuery={setQuery}
|
setQuery={setQuery}
|
||||||
setMode={(nextMode) => {
|
setMode={(nextMode) => changeMode(nextMode, true)}
|
||||||
setMode(nextMode);
|
setChildrenOptions={pushChildrenOptions}
|
||||||
clearChildrenStack();
|
|
||||||
setTimeout(() => selectAction(0, spotlightStore));
|
|
||||||
}}
|
|
||||||
setChildrenOptions={(options) => {
|
|
||||||
pushChildrenOptions(options);
|
|
||||||
}}
|
|
||||||
query={query}
|
query={query}
|
||||||
groups={
|
groups={groups}
|
||||||
mode === defaultMode && query.length === 0 ? [...homeEmptyGroups, contextSpecificSearchGroups] : groups
|
|
||||||
}
|
|
||||||
/>
|
/>
|
||||||
)}
|
)}
|
||||||
|
<SpotlightNoResults className={classes.emptyState} />
|
||||||
</MantineSpotlight.ActionsList>
|
</MantineSpotlight.ActionsList>
|
||||||
|
|
||||||
|
<MantineSpotlight.Footer className={classes.footer} px="md" py="xs">
|
||||||
|
<Group justify="space-between" wrap="nowrap">
|
||||||
|
<Group gap="xs" wrap="nowrap">
|
||||||
|
<Group gap={4} wrap="nowrap">
|
||||||
|
<Kbd size="xs">
|
||||||
|
<IconArrowUp size={11} />
|
||||||
|
</Kbd>
|
||||||
|
<Kbd size="xs">
|
||||||
|
<IconArrowDown size={11} />
|
||||||
|
</Kbd>
|
||||||
|
<Text size="xs" className={classes.footerHint}>
|
||||||
|
{t("search.modePicker.footer.navigate")}
|
||||||
|
</Text>
|
||||||
|
</Group>
|
||||||
|
<Group gap={4} wrap="nowrap">
|
||||||
|
<Kbd size="xs">
|
||||||
|
<IconCornerDownLeft size={11} />
|
||||||
|
</Kbd>
|
||||||
|
<Text size="xs" className={classes.footerHint}>
|
||||||
|
{t("search.modePicker.footer.open")}
|
||||||
|
</Text>
|
||||||
|
</Group>
|
||||||
|
</Group>
|
||||||
|
<Group gap={4} wrap="nowrap" className={classes.footerSecondary}>
|
||||||
|
<Kbd size="xs">esc</Kbd>
|
||||||
|
<Text size="xs" className={classes.footerHint}>
|
||||||
|
{t("search.modePicker.footer.close")}
|
||||||
|
</Text>
|
||||||
|
</Group>
|
||||||
|
</Group>
|
||||||
|
</MantineSpotlight.Footer>
|
||||||
</MantineSpotlight.Root>
|
</MantineSpotlight.Root>
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
@@ -6,3 +6,4 @@ export {
|
|||||||
useRegisterSpotlightContextResults,
|
useRegisterSpotlightContextResults,
|
||||||
useRegisterSpotlightContextActions,
|
useRegisterSpotlightContextActions,
|
||||||
} from "./modes/home/context";
|
} from "./modes/home/context";
|
||||||
|
export type { ContextSpecificItem } from "./modes/home/context";
|
||||||
@@ -0,0 +1,96 @@
|
|||||||
|
"use client";
|
||||||
|
|
||||||
|
import { useEffect } from "react";
|
||||||
|
|
||||||
|
import { clientApi } from "@homarr/api/client";
|
||||||
|
import { queryCacheDefaultStaleTimeMs } from "@homarr/api/query-cache";
|
||||||
|
import { useSession } from "@homarr/auth/client";
|
||||||
|
|
||||||
|
import { spotlightOpenEvent } from "../open";
|
||||||
|
|
||||||
|
const catalogQueryOptions = (enabled = true) => ({
|
||||||
|
enabled,
|
||||||
|
refetchOnWindowFocus: false,
|
||||||
|
staleTime: queryCacheDefaultStaleTimeMs,
|
||||||
|
});
|
||||||
|
|
||||||
|
export const useAppsCatalogQuery = (enabled = true) => {
|
||||||
|
const { status } = useSession();
|
||||||
|
return clientApi.app.selectable.useQuery(undefined, catalogQueryOptions(enabled && status === "authenticated"));
|
||||||
|
};
|
||||||
|
|
||||||
|
export const useBoardsCatalogQuery = () => {
|
||||||
|
const { status } = useSession();
|
||||||
|
return clientApi.board.catalog.useQuery(undefined, catalogQueryOptions(status !== "loading"));
|
||||||
|
};
|
||||||
|
|
||||||
|
export const useIntegrationsCatalogQuery = (enabled = true) => {
|
||||||
|
const { status } = useSession();
|
||||||
|
return clientApi.integration.all.useQuery(undefined, catalogQueryOptions(enabled && status === "authenticated"));
|
||||||
|
};
|
||||||
|
|
||||||
|
export const useSearchEnginesCatalogQuery = () => {
|
||||||
|
const { status } = useSession();
|
||||||
|
return clientApi.searchEngine.catalog.useQuery(undefined, catalogQueryOptions(status !== "loading"));
|
||||||
|
};
|
||||||
|
|
||||||
|
export const useSpotlightCatalogs = () => {
|
||||||
|
const { data: session, status } = useSession();
|
||||||
|
const isAuthenticated = status === "authenticated";
|
||||||
|
const isSessionResolved = status !== "loading";
|
||||||
|
const canBrowseApps =
|
||||||
|
session?.user.permissions.includes("board-modify-all") === true ||
|
||||||
|
session?.user.permissions.includes("app-modify-all") === true;
|
||||||
|
|
||||||
|
const appsQuery = useAppsCatalogQuery(isAuthenticated && canBrowseApps);
|
||||||
|
const boardsQuery = useBoardsCatalogQuery();
|
||||||
|
const integrationsQuery = useIntegrationsCatalogQuery(isAuthenticated);
|
||||||
|
const searchEnginesQuery = useSearchEnginesCatalogQuery();
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
const refreshCatalogs = () => {
|
||||||
|
if (canBrowseApps) void appsQuery.refetch();
|
||||||
|
if (isSessionResolved) void boardsQuery.refetch();
|
||||||
|
if (isAuthenticated) void integrationsQuery.refetch();
|
||||||
|
if (isSessionResolved) void searchEnginesQuery.refetch();
|
||||||
|
};
|
||||||
|
|
||||||
|
window.addEventListener(spotlightOpenEvent, refreshCatalogs);
|
||||||
|
return () => window.removeEventListener(spotlightOpenEvent, refreshCatalogs);
|
||||||
|
}, [
|
||||||
|
appsQuery,
|
||||||
|
boardsQuery,
|
||||||
|
canBrowseApps,
|
||||||
|
integrationsQuery,
|
||||||
|
isAuthenticated,
|
||||||
|
isSessionResolved,
|
||||||
|
searchEnginesQuery,
|
||||||
|
]);
|
||||||
|
};
|
||||||
|
|
||||||
|
export const filterCatalog = <TOption>(
|
||||||
|
options: TOption[],
|
||||||
|
query: string,
|
||||||
|
getSearchableValues: (option: TOption) => string[],
|
||||||
|
limit = 8,
|
||||||
|
) => {
|
||||||
|
const normalizedQuery = query.trim().toLowerCase();
|
||||||
|
if (normalizedQuery.length === 0) return options.slice(0, limit);
|
||||||
|
|
||||||
|
return options
|
||||||
|
.map((option, index) => {
|
||||||
|
const values = getSearchableValues(option).map((value) => value.toLowerCase());
|
||||||
|
const score = values.reduce((currentScore, value) => {
|
||||||
|
if (value === normalizedQuery) return Math.min(currentScore, 0);
|
||||||
|
if (value.startsWith(normalizedQuery)) return Math.min(currentScore, 1);
|
||||||
|
if (value.includes(normalizedQuery)) return Math.min(currentScore, 2);
|
||||||
|
return currentScore;
|
||||||
|
}, Number.POSITIVE_INFINITY);
|
||||||
|
|
||||||
|
return { option, index, score };
|
||||||
|
})
|
||||||
|
.filter(({ score }) => Number.isFinite(score))
|
||||||
|
.toSorted((first, second) => first.score - second.score || first.index - second.index)
|
||||||
|
.slice(0, limit)
|
||||||
|
.map(({ option }) => option);
|
||||||
|
};
|
||||||
@@ -2,26 +2,34 @@ import type { JSX } from "react";
|
|||||||
|
|
||||||
import type { stringOrTranslation } from "@homarr/translation";
|
import type { stringOrTranslation } from "@homarr/translation";
|
||||||
|
|
||||||
import type { inferSearchInteractionDefinition, inferSearchInteractionOptions, SearchInteraction } from "./interaction";
|
import type { inferSearchInteractionDefinition, SearchInteraction } from "./interaction";
|
||||||
|
|
||||||
type CommonSearchGroup<TOption extends Record<string, unknown>, TOptionProps extends Record<string, unknown>> = {
|
export type RemoteSearchSource =
|
||||||
|
| "apps"
|
||||||
|
| "boards"
|
||||||
|
| "integrations"
|
||||||
|
| "users"
|
||||||
|
| "groups"
|
||||||
|
| "search-engines"
|
||||||
|
| "integration-search"
|
||||||
|
| "media";
|
||||||
|
|
||||||
|
export type SearchGroupSource =
|
||||||
|
| { kind: "local" }
|
||||||
|
| { kind: "remote"; source: RemoteSearchSource }
|
||||||
|
| { kind: "fallback" };
|
||||||
|
|
||||||
|
type CommonSearchGroup<TOption extends object, TOptionProps extends object> = {
|
||||||
// key path is used to define the path to a unique key in the option object
|
// key path is used to define the path to a unique key in the option object
|
||||||
keyPath: keyof TOption;
|
keyPath: keyof TOption;
|
||||||
title: stringOrTranslation;
|
title: stringOrTranslation;
|
||||||
|
source?: SearchGroupSource;
|
||||||
Component: (option: TOption) => JSX.Element;
|
Component: (option: TOption) => JSX.Element;
|
||||||
useInteraction: (option: TOption, query: string) => inferSearchInteractionDefinition<SearchInteraction>;
|
useInteraction: (option: TOption, query: string) => inferSearchInteractionDefinition<SearchInteraction>;
|
||||||
onKeyDown?: (
|
|
||||||
event: KeyboardEvent,
|
|
||||||
options: TOption[],
|
|
||||||
query: string,
|
|
||||||
actions: {
|
|
||||||
setChildrenOptions: (options: inferSearchInteractionOptions<"children">) => void;
|
|
||||||
},
|
|
||||||
) => void;
|
|
||||||
} & TOptionProps;
|
} & TOptionProps;
|
||||||
|
|
||||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||||
export type SearchGroup<TOption extends Record<string, unknown> = any> =
|
export type SearchGroup<TOption extends object = any> =
|
||||||
| CommonSearchGroup<TOption, { filter: (query: string, option: TOption) => boolean; options: TOption[] }>
|
| CommonSearchGroup<TOption, { filter: (query: string, option: TOption) => boolean; options: TOption[] }>
|
||||||
| CommonSearchGroup<
|
| CommonSearchGroup<
|
||||||
TOption,
|
TOption,
|
||||||
@@ -36,4 +44,4 @@ export type SearchGroup<TOption extends Record<string, unknown> = any> =
|
|||||||
{ useQueryOptions: (query: string) => { data: TOption[] | undefined; isLoading: boolean; isError: boolean } }
|
{ useQueryOptions: (query: string) => { data: TOption[] | undefined; isLoading: boolean; isError: boolean } }
|
||||||
>;
|
>;
|
||||||
|
|
||||||
export const createGroup = <TOption extends Record<string, unknown>>(group: SearchGroup<TOption>) => group;
|
export const createGroup = <TOption extends object>(group: SearchGroup<TOption>) => group;
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
import type { MaybePromise } from "@homarr/common/types";
|
import type { MaybePromise } from "@homarr/common/types";
|
||||||
import type { TranslationObject } from "@homarr/translation";
|
|
||||||
|
|
||||||
import type { CreateChildrenOptionsProps } from "./children";
|
import type { CreateChildrenOptionsProps } from "./children";
|
||||||
|
import type { SpotlightMode } from "../open";
|
||||||
|
|
||||||
const createSearchInteraction = <TType extends string>(type: TType) => ({
|
const createSearchInteraction = <TType extends string>(type: TType) => ({
|
||||||
optionsType: <TOption extends Record<string, unknown> | undefined>() => ({ type, _inferOptions: {} as TOption }),
|
optionsType: <TOption extends Record<string, unknown> | undefined>() => ({ type, _inferOptions: {} as TOption }),
|
||||||
@@ -15,7 +15,7 @@ const searchInteractions = [
|
|||||||
closeSpotlightOnTrigger?: boolean;
|
closeSpotlightOnTrigger?: boolean;
|
||||||
}>(),
|
}>(),
|
||||||
createSearchInteraction("setQuery").optionsType<{ query: string }>(),
|
createSearchInteraction("setQuery").optionsType<{ query: string }>(),
|
||||||
createSearchInteraction("mode").optionsType<{ mode: keyof TranslationObject["search"]["mode"]; query?: string }>(),
|
createSearchInteraction("mode").optionsType<{ mode: SpotlightMode; query?: string }>(),
|
||||||
createSearchInteraction("children").optionsType<{
|
createSearchInteraction("children").optionsType<{
|
||||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||||
useActions: CreateChildrenOptionsProps<any>["useActions"];
|
useActions: CreateChildrenOptionsProps<any>["useActions"];
|
||||||
|
|||||||
@@ -1,10 +1,13 @@
|
|||||||
import type { TranslationObject } from "@homarr/translation";
|
import type { stringOrTranslation } from "@homarr/translation";
|
||||||
|
|
||||||
import type { SearchGroup } from "./group";
|
import type { SearchGroup } from "./group";
|
||||||
|
import type { SpotlightMode } from "../open";
|
||||||
|
|
||||||
export type SearchMode = {
|
export type SearchMode = {
|
||||||
modeKey: keyof TranslationObject["search"]["mode"];
|
mode: SpotlightMode;
|
||||||
character: string | undefined;
|
character: string | undefined;
|
||||||
|
label: stringOrTranslation;
|
||||||
|
placeholder: stringOrTranslation;
|
||||||
} & (
|
} & (
|
||||||
| {
|
| {
|
||||||
groups: SearchGroup[];
|
groups: SearchGroup[];
|
||||||
|
|||||||
@@ -0,0 +1,46 @@
|
|||||||
|
"use client";
|
||||||
|
|
||||||
|
import { useDebouncedValue } from "@mantine/hooks";
|
||||||
|
|
||||||
|
import type { RemoteSearchSource } from "./group";
|
||||||
|
|
||||||
|
const remoteSearchPolicy: Record<RemoteSearchSource, { delay: number; minimumLength: number }> = {
|
||||||
|
apps: { delay: 140, minimumLength: 1 },
|
||||||
|
boards: { delay: 140, minimumLength: 1 },
|
||||||
|
integrations: { delay: 160, minimumLength: 1 },
|
||||||
|
users: { delay: 180, minimumLength: 1 },
|
||||||
|
groups: { delay: 180, minimumLength: 1 },
|
||||||
|
"search-engines": { delay: 160, minimumLength: 1 },
|
||||||
|
"integration-search": { delay: 220, minimumLength: 1 },
|
||||||
|
media: { delay: 220, minimumLength: 1 },
|
||||||
|
};
|
||||||
|
|
||||||
|
interface RemoteQueryOptions {
|
||||||
|
minimumLength?: number;
|
||||||
|
trim?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface RemoteQuery {
|
||||||
|
enabled: boolean;
|
||||||
|
query: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Keeps every network-backed spotlight provider on the same query cadence. Local providers still
|
||||||
|
* receive the immediate query and therefore render before remote results can replace the selection.
|
||||||
|
*/
|
||||||
|
export const useRemoteQuery = (
|
||||||
|
query: string,
|
||||||
|
source: RemoteSearchSource,
|
||||||
|
options: RemoteQueryOptions = {},
|
||||||
|
): RemoteQuery => {
|
||||||
|
const policy = remoteSearchPolicy[source];
|
||||||
|
const minimumLength = options.minimumLength ?? policy.minimumLength;
|
||||||
|
const normalizedQuery = options.trim === false ? query : query.trim();
|
||||||
|
const [debouncedQuery] = useDebouncedValue(normalizedQuery, policy.delay);
|
||||||
|
|
||||||
|
return {
|
||||||
|
enabled: debouncedQuery.length >= minimumLength,
|
||||||
|
query: debouncedQuery,
|
||||||
|
};
|
||||||
|
};
|
||||||
@@ -1,12 +1,13 @@
|
|||||||
import { Avatar, Group, Stack, Text } from "@mantine/core";
|
import { Avatar, Group, Stack, Text } from "@mantine/core";
|
||||||
import { IconExternalLink, IconEye } from "@tabler/icons-react";
|
import { IconExternalLink, IconEye } from "@tabler/icons-react";
|
||||||
|
|
||||||
import { clientApi } from "@homarr/api/client";
|
|
||||||
import { useI18n } from "@homarr/translation/client";
|
import { useI18n } from "@homarr/translation/client";
|
||||||
|
|
||||||
import { createChildrenOptions } from "../../lib/children";
|
import { createChildrenOptions } from "../../lib/children";
|
||||||
|
import { filterCatalog, useAppsCatalogQuery } from "../../lib/catalog";
|
||||||
import { createGroup } from "../../lib/group";
|
import { createGroup } from "../../lib/group";
|
||||||
import { interaction } from "../../lib/interaction";
|
import { interaction } from "../../lib/interaction";
|
||||||
|
import { useSpotlightContextResults } from "../home/context";
|
||||||
|
|
||||||
// This has to be type so it can be interpreted as Record<string, unknown>.
|
// This has to be type so it can be interpreted as Record<string, unknown>.
|
||||||
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
|
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
|
||||||
@@ -58,6 +59,7 @@ const appChildrenOptions = createChildrenOptions<App>({
|
|||||||
<Avatar
|
<Avatar
|
||||||
size="sm"
|
size="sm"
|
||||||
src={options.iconUrl}
|
src={options.iconUrl}
|
||||||
|
alt=""
|
||||||
radius={0}
|
radius={0}
|
||||||
styles={{
|
styles={{
|
||||||
image: {
|
image: {
|
||||||
@@ -75,11 +77,13 @@ const appChildrenOptions = createChildrenOptions<App>({
|
|||||||
export const appsSearchGroup = createGroup<App>({
|
export const appsSearchGroup = createGroup<App>({
|
||||||
keyPath: "id",
|
keyPath: "id",
|
||||||
title: (t) => t("common.entity.apps"),
|
title: (t) => t("common.entity.apps"),
|
||||||
|
source: { kind: "remote", source: "apps" },
|
||||||
Component: (app) => (
|
Component: (app) => (
|
||||||
<Group px="md" py="sm">
|
<Group px="md" py="sm">
|
||||||
<Avatar
|
<Avatar
|
||||||
size="sm"
|
size="sm"
|
||||||
src={app.iconUrl}
|
src={app.iconUrl}
|
||||||
|
alt=""
|
||||||
radius={0}
|
radius={0}
|
||||||
styles={{
|
styles={{
|
||||||
image: {
|
image: {
|
||||||
@@ -92,6 +96,16 @@ export const appsSearchGroup = createGroup<App>({
|
|||||||
),
|
),
|
||||||
useInteraction: interaction.children(appChildrenOptions),
|
useInteraction: interaction.children(appChildrenOptions),
|
||||||
useQueryOptions(query) {
|
useQueryOptions(query) {
|
||||||
return clientApi.app.search.useQuery({ query, limit: 5 });
|
const catalogQuery = useAppsCatalogQuery();
|
||||||
|
const localAppKeys = new Set(
|
||||||
|
useSpotlightContextResults().flatMap((item) => (item.dedupeKey ? [item.dedupeKey] : [])),
|
||||||
|
);
|
||||||
|
const apps = (catalogQuery.data ?? []).filter((app) => !localAppKeys.has(`app:${app.id}`));
|
||||||
|
|
||||||
|
return {
|
||||||
|
data: filterCatalog(apps, query, (app) => [app.name]),
|
||||||
|
isLoading: catalogQuery.isLoading,
|
||||||
|
isError: catalogQuery.isError,
|
||||||
|
};
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
@@ -1,13 +1,14 @@
|
|||||||
import { Group, Stack, Text } from "@mantine/core";
|
import { Group, Stack, Text } from "@mantine/core";
|
||||||
import { IconDeviceMobile, IconHome, IconLayoutDashboard, IconLink, IconSettings } from "@tabler/icons-react";
|
import { IconDeviceMobile, IconHome, IconLayoutDashboard, IconLink, IconSettings } from "@tabler/icons-react";
|
||||||
|
|
||||||
import { clientApi } from "@homarr/api/client";
|
|
||||||
import { useI18n } from "@homarr/translation/client";
|
import { useI18n } from "@homarr/translation/client";
|
||||||
|
|
||||||
import type { ChildrenAction } from "../../lib/children";
|
import type { ChildrenAction } from "../../lib/children";
|
||||||
|
import { filterCatalog, useBoardsCatalogQuery } from "../../lib/catalog";
|
||||||
import { createChildrenOptions } from "../../lib/children";
|
import { createChildrenOptions } from "../../lib/children";
|
||||||
import { createGroup } from "../../lib/group";
|
import { createGroup } from "../../lib/group";
|
||||||
import { interaction } from "../../lib/interaction";
|
import { interaction } from "../../lib/interaction";
|
||||||
|
import { clientApi } from "@homarr/api/client";
|
||||||
|
|
||||||
// This has to be type so it can be interpreted as Record<string, unknown>.
|
// This has to be type so it can be interpreted as Record<string, unknown>.
|
||||||
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
|
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
|
||||||
@@ -126,6 +127,7 @@ const boardChildrenOptions = createChildrenOptions<Board>({
|
|||||||
export const boardsSearchGroup = createGroup<Board>({
|
export const boardsSearchGroup = createGroup<Board>({
|
||||||
keyPath: "id",
|
keyPath: "id",
|
||||||
title: (t) => t("common.entity.boards"),
|
title: (t) => t("common.entity.boards"),
|
||||||
|
source: { kind: "remote", source: "boards" },
|
||||||
Component: (board) => (
|
Component: (board) => (
|
||||||
<Group px="md" py="sm">
|
<Group px="md" py="sm">
|
||||||
{board.logoImageUrl ? (
|
{board.logoImageUrl ? (
|
||||||
@@ -139,6 +141,11 @@ export const boardsSearchGroup = createGroup<Board>({
|
|||||||
),
|
),
|
||||||
useInteraction: interaction.children(boardChildrenOptions),
|
useInteraction: interaction.children(boardChildrenOptions),
|
||||||
useQueryOptions(query) {
|
useQueryOptions(query) {
|
||||||
return clientApi.board.search.useQuery({ query, limit: 5 });
|
const catalogQuery = useBoardsCatalogQuery();
|
||||||
|
return {
|
||||||
|
data: filterCatalog(catalogQuery.data ?? [], query, (board) => [board.name]),
|
||||||
|
isLoading: catalogQuery.isLoading,
|
||||||
|
isError: catalogQuery.isError,
|
||||||
|
};
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
@@ -2,19 +2,22 @@ import { useSession } from "@homarr/auth/client";
|
|||||||
|
|
||||||
import type { SearchGroup } from "../../lib/group";
|
import type { SearchGroup } from "../../lib/group";
|
||||||
import type { SearchMode } from "../../lib/mode";
|
import type { SearchMode } from "../../lib/mode";
|
||||||
|
import { contextSpecificAppsSearchGroup } from "../home/context-specific-group";
|
||||||
import { appsSearchGroup } from "./apps-search-group";
|
import { appsSearchGroup } from "./apps-search-group";
|
||||||
import { boardsSearchGroup } from "./boards-search-group";
|
import { boardsSearchGroup } from "./boards-search-group";
|
||||||
import { integrationsSearchGroup } from "./integrations-search-group";
|
import { integrationsSearchGroup } from "./integrations-search-group";
|
||||||
|
|
||||||
export const appIntegrationBoardMode = {
|
export const appIntegrationBoardMode = {
|
||||||
modeKey: "appIntegrationBoard",
|
mode: "apps",
|
||||||
character: "#",
|
character: "#",
|
||||||
|
label: (t) => t("search.modePicker.apps.label"),
|
||||||
|
placeholder: (t) => t("search.modePicker.apps.placeholder"),
|
||||||
useGroups() {
|
useGroups() {
|
||||||
const { data: session } = useSession();
|
const { data: session } = useSession();
|
||||||
const groups: SearchGroup[] = [boardsSearchGroup];
|
const groups: SearchGroup[] = [contextSpecificAppsSearchGroup];
|
||||||
|
|
||||||
if (!session?.user) {
|
if (!session?.user) {
|
||||||
return groups;
|
return groups.concat(boardsSearchGroup);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Mirrors the gate on app.search: either permission may browse the app catalogue, so an app
|
// Mirrors the gate on app.search: either permission may browse the app catalogue, so an app
|
||||||
@@ -22,6 +25,10 @@ export const appIntegrationBoardMode = {
|
|||||||
const canSearchApps =
|
const canSearchApps =
|
||||||
session.user.permissions.includes("board-modify-all") || session.user.permissions.includes("app-modify-all");
|
session.user.permissions.includes("board-modify-all") || session.user.permissions.includes("app-modify-all");
|
||||||
|
|
||||||
return groups.concat(canSearchApps ? [appsSearchGroup, integrationsSearchGroup] : [integrationsSearchGroup]);
|
if (canSearchApps) {
|
||||||
|
return groups.concat(appsSearchGroup, boardsSearchGroup, integrationsSearchGroup);
|
||||||
|
}
|
||||||
|
|
||||||
|
return groups.concat(boardsSearchGroup, integrationsSearchGroup);
|
||||||
},
|
},
|
||||||
} satisfies SearchMode;
|
} satisfies SearchMode;
|
||||||
@@ -1,15 +1,16 @@
|
|||||||
import { Group, Text } from "@mantine/core";
|
import { Group, Text } from "@mantine/core";
|
||||||
|
|
||||||
import { clientApi } from "@homarr/api/client";
|
|
||||||
import type { IntegrationKind } from "@homarr/definitions";
|
import type { IntegrationKind } from "@homarr/definitions";
|
||||||
import { IntegrationAvatar } from "@homarr/ui";
|
import { IntegrationAvatar } from "@homarr/ui";
|
||||||
|
|
||||||
|
import { filterCatalog, useIntegrationsCatalogQuery } from "../../lib/catalog";
|
||||||
import { createGroup } from "../../lib/group";
|
import { createGroup } from "../../lib/group";
|
||||||
import { interaction } from "../../lib/interaction";
|
import { interaction } from "../../lib/interaction";
|
||||||
|
|
||||||
export const integrationsSearchGroup = createGroup<{ id: string; kind: IntegrationKind; name: string }>({
|
export const integrationsSearchGroup = createGroup<{ id: string; kind: IntegrationKind; name: string }>({
|
||||||
keyPath: "id",
|
keyPath: "id",
|
||||||
title: (t) => t("common.entity.integrations"),
|
title: (t) => t("common.entity.integrations"),
|
||||||
|
source: { kind: "remote", source: "integrations" },
|
||||||
Component: (integration) => (
|
Component: (integration) => (
|
||||||
<Group px="md" py="sm">
|
<Group px="md" py="sm">
|
||||||
<IntegrationAvatar size="sm" kind={integration.kind} />
|
<IntegrationAvatar size="sm" kind={integration.kind} />
|
||||||
@@ -19,6 +20,11 @@ export const integrationsSearchGroup = createGroup<{ id: string; kind: Integrati
|
|||||||
),
|
),
|
||||||
useInteraction: interaction.link(({ id }) => ({ href: `/manage/integrations/edit/${id}` })),
|
useInteraction: interaction.link(({ id }) => ({ href: `/manage/integrations/edit/${id}` })),
|
||||||
useQueryOptions(query) {
|
useQueryOptions(query) {
|
||||||
return clientApi.integration.search.useQuery({ query, limit: 5 });
|
const catalogQuery = useIntegrationsCatalogQuery();
|
||||||
|
return {
|
||||||
|
data: filterCatalog(catalogQuery.data ?? [], query, (integration) => [integration.name, integration.kind]),
|
||||||
|
isLoading: catalogQuery.isLoading,
|
||||||
|
isError: catalogQuery.isError,
|
||||||
|
};
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
import type { SearchMode } from "../../lib/mode";
|
||||||
|
import { contextSpecificFallbackSearchGroup } from "../home/context-specific-group";
|
||||||
|
|
||||||
|
export const assistantMode = {
|
||||||
|
mode: "assistant",
|
||||||
|
character: undefined,
|
||||||
|
label: (t) => t("search.modePicker.assistant.label"),
|
||||||
|
placeholder: (t) => t("search.modePicker.assistant.placeholder"),
|
||||||
|
groups: [contextSpecificFallbackSearchGroup],
|
||||||
|
} satisfies SearchMode;
|
||||||
@@ -2,10 +2,10 @@
|
|||||||
|
|
||||||
import { Group, Stack, Switch, Text } from "@mantine/core";
|
import { Group, Stack, Switch, Text } from "@mantine/core";
|
||||||
import type { DayOfWeek } from "@mantine/dates";
|
import type { DayOfWeek } from "@mantine/dates";
|
||||||
|
import { IconChevronRight } from "@tabler/icons-react";
|
||||||
import dayjs from "dayjs";
|
import dayjs from "dayjs";
|
||||||
import localeData from "dayjs/plugin/localeData";
|
import localeData from "dayjs/plugin/localeData";
|
||||||
|
|
||||||
import { clientApi } from "@homarr/api/client";
|
|
||||||
import { useSession } from "@homarr/auth/client";
|
import { useSession } from "@homarr/auth/client";
|
||||||
import type { ColorScheme } from "@homarr/definitions";
|
import type { ColorScheme } from "@homarr/definitions";
|
||||||
import { visiblePreferenceDefinitions } from "@homarr/settings";
|
import { visiblePreferenceDefinitions } from "@homarr/settings";
|
||||||
@@ -47,15 +47,19 @@ const BooleanRow = ({
|
|||||||
</Group>
|
</Group>
|
||||||
);
|
);
|
||||||
|
|
||||||
const SelectRow = ({ label, Icon, valueLabel }: { label: string; Icon: TablerIcon; valueLabel: string }) => (
|
const SelectRow = ({ label, Icon, valueLabel }: { label: string; Icon: TablerIcon; valueLabel?: string }) => (
|
||||||
<Group mx="md" my="sm" wrap="nowrap" justify="space-between" w="100%">
|
<Group mx="md" my="sm" wrap="nowrap" justify="space-between" w="100%">
|
||||||
<Group wrap="nowrap" gap="sm">
|
<Group wrap="nowrap" gap="sm">
|
||||||
<Icon stroke={1.5} size={20} />
|
<Icon stroke={1.5} size={20} />
|
||||||
<Text>{label}</Text>
|
<Text>{label}</Text>
|
||||||
</Group>
|
</Group>
|
||||||
<Text size="sm" c="dimmed">
|
{valueLabel ? (
|
||||||
{valueLabel}
|
<Text size="sm" c="dimmed">
|
||||||
</Text>
|
{valueLabel}
|
||||||
|
</Text>
|
||||||
|
) : (
|
||||||
|
<IconChevronRight aria-hidden size={16} />
|
||||||
|
)}
|
||||||
</Group>
|
</Group>
|
||||||
);
|
);
|
||||||
|
|
||||||
@@ -68,7 +72,7 @@ const LinkRow = ({ label, Icon }: { label: string; Icon: TablerIcon }) => (
|
|||||||
|
|
||||||
const SELECT_KINDS = new Set(["select", "searchEngine", "board"]);
|
const SELECT_KINDS = new Set(["select", "searchEngine", "board"]);
|
||||||
|
|
||||||
const useSettingsActions = (_: Record<string, unknown>, query: string): SettingsAction[] => {
|
export const useSettingsActions = (_: Record<string, unknown>, query: string): SettingsAction[] => {
|
||||||
const t = useI18n("search.mode.command.group.preferences.option");
|
const t = useI18n("search.mode.command.group.preferences.option");
|
||||||
const tUserField = useI18n("user.field");
|
const tUserField = useI18n("user.field");
|
||||||
const tColorScheme = useI18n("common.colorScheme.options");
|
const tColorScheme = useI18n("common.colorScheme.options");
|
||||||
@@ -77,25 +81,13 @@ const useSettingsActions = (_: Record<string, unknown>, query: string): Settings
|
|||||||
const normalizedQuery = query.trim().toLowerCase();
|
const normalizedQuery = query.trim().toLowerCase();
|
||||||
const preferences = useUserPreferences();
|
const preferences = useUserPreferences();
|
||||||
|
|
||||||
const boardsQuery = clientApi.board.getAllBoards.useQuery(undefined, { enabled: isAuthenticated });
|
|
||||||
const searchEnginesQuery = clientApi.searchEngine.getSelectable.useQuery(undefined, { enabled: isAuthenticated });
|
|
||||||
|
|
||||||
const valueLabelResolvers: Record<string, () => string> = {
|
const valueLabelResolvers: Record<string, () => string> = {
|
||||||
colorScheme: () => tColorScheme(preferences.getPreference("colorScheme").value as ColorScheme),
|
colorScheme: () => tColorScheme(preferences.getPreference("colorScheme").value as ColorScheme),
|
||||||
locale: () => {
|
locale: () => {
|
||||||
const val = preferences.getPreference("locale").value;
|
const val = preferences.getPreference("locale").value;
|
||||||
return localeConfigurations[val as keyof typeof localeConfigurations]?.name ?? String(val);
|
return localeConfigurations[val as keyof typeof localeConfigurations]?.name ?? String(val);
|
||||||
},
|
},
|
||||||
defaultSearchEngineId: () =>
|
|
||||||
searchEnginesQuery.data?.find((e) => e.value === preferences.getPreference("defaultSearchEngineId").value)
|
|
||||||
?.label ?? t("searchEngine.none" as never),
|
|
||||||
firstDayOfWeek: () => dayjs.weekdays(false)[preferences.getPreference("firstDayOfWeek").value as DayOfWeek] ?? "",
|
firstDayOfWeek: () => dayjs.weekdays(false)[preferences.getPreference("firstDayOfWeek").value as DayOfWeek] ?? "",
|
||||||
homeBoardId: () =>
|
|
||||||
boardsQuery.data?.find((b) => b.id === preferences.getPreference("homeBoardId").value)?.name ??
|
|
||||||
t("board.none" as never),
|
|
||||||
mobileHomeBoardId: () =>
|
|
||||||
boardsQuery.data?.find((b) => b.id === preferences.getPreference("mobileHomeBoardId").value)?.name ??
|
|
||||||
t("board.none" as never),
|
|
||||||
};
|
};
|
||||||
|
|
||||||
return visiblePreferenceDefinitions(isAuthenticated)
|
return visiblePreferenceDefinitions(isAuthenticated)
|
||||||
@@ -134,9 +126,7 @@ const useSettingsActions = (_: Record<string, unknown>, query: string): Settings
|
|||||||
if (!children) return null;
|
if (!children) return null;
|
||||||
return {
|
return {
|
||||||
key: definition.key,
|
key: definition.key,
|
||||||
Component: () => (
|
Component: () => <SelectRow label={label} Icon={Icon} valueLabel={valueLabelResolvers[definition.key]?.()} />,
|
||||||
<SelectRow label={label} Icon={Icon} valueLabel={valueLabelResolvers[definition.key]?.() ?? ""} />
|
|
||||||
),
|
|
||||||
useInteraction: interaction.children(children),
|
useInteraction: interaction.children(children),
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ import { useSpotlightContextActions } from "../home/context";
|
|||||||
export const contextSpecificActionsSearchGroups = createGroup<ContextSpecificItem>({
|
export const contextSpecificActionsSearchGroups = createGroup<ContextSpecificItem>({
|
||||||
title: (t) => t("search.mode.command.group.localCommand.title"),
|
title: (t) => t("search.mode.command.group.localCommand.title"),
|
||||||
keyPath: "id",
|
keyPath: "id",
|
||||||
|
source: { kind: "local" },
|
||||||
Component(option) {
|
Component(option) {
|
||||||
const icon =
|
const icon =
|
||||||
typeof option.icon !== "string" ? (
|
typeof option.icon !== "string" ? (
|
||||||
|
|||||||
@@ -36,7 +36,8 @@ type Command<TSearchInteraction extends SearchInteraction = SearchInteraction> =
|
|||||||
|
|
||||||
export const globalCommandGroup = createGroup<Command>({
|
export const globalCommandGroup = createGroup<Command>({
|
||||||
keyPath: "commandKey",
|
keyPath: "commandKey",
|
||||||
title: "Global commands",
|
title: (t) => t("search.mode.command.group.globalCommand.title"),
|
||||||
|
source: { kind: "local" },
|
||||||
useInteraction: (option, query) => option.useInteraction(option, query),
|
useInteraction: (option, query) => option.useInteraction(option, query),
|
||||||
Component: ({ icon: Icon, name }) => (
|
Component: ({ icon: Icon, name }) => (
|
||||||
<Group px="md" py="sm">
|
<Group px="md" py="sm">
|
||||||
|
|||||||
@@ -4,7 +4,9 @@ import { globalCommandGroup } from "./global-group";
|
|||||||
import { preferencesGroup } from "../preferences/groups";
|
import { preferencesGroup } from "../preferences/groups";
|
||||||
|
|
||||||
export const commandMode = {
|
export const commandMode = {
|
||||||
modeKey: "command",
|
mode: "command",
|
||||||
character: ">",
|
character: ">",
|
||||||
groups: [contextSpecificActionsSearchGroups, preferencesGroup, globalCommandGroup],
|
label: (t) => t("search.modePicker.command.label"),
|
||||||
|
placeholder: (t) => t("search.modePicker.command.placeholder"),
|
||||||
|
groups: [contextSpecificActionsSearchGroups, globalCommandGroup, preferencesGroup],
|
||||||
} satisfies SearchMode;
|
} satisfies SearchMode;
|
||||||
+3
-1
@@ -2,7 +2,9 @@ import type { SearchMode } from "../../lib/mode";
|
|||||||
import { searchEnginesSearchGroups } from "./search-engines-search-group";
|
import { searchEnginesSearchGroups } from "./search-engines-search-group";
|
||||||
|
|
||||||
export const externalMode = {
|
export const externalMode = {
|
||||||
modeKey: "external",
|
mode: "external",
|
||||||
character: "!",
|
character: "!",
|
||||||
|
label: (t) => t("search.modePicker.external.label"),
|
||||||
|
placeholder: (t) => t("search.modePicker.external.placeholder"),
|
||||||
groups: [searchEnginesSearchGroups],
|
groups: [searchEnginesSearchGroups],
|
||||||
} satisfies SearchMode;
|
} satisfies SearchMode;
|
||||||
+188
-165
@@ -1,7 +1,5 @@
|
|||||||
import { Group, Image, Kbd, Stack, Text } from "@mantine/core";
|
import { Group, Image, Kbd, Stack, Text } from "@mantine/core";
|
||||||
import { useDebouncedValue } from "@mantine/hooks";
|
|
||||||
import { IconDownload, IconSearch } from "@tabler/icons-react";
|
import { IconDownload, IconSearch } from "@tabler/icons-react";
|
||||||
import { keepPreviousData } from "@tanstack/react-query";
|
|
||||||
|
|
||||||
import type { RouterOutputs } from "@homarr/api";
|
import type { RouterOutputs } from "@homarr/api";
|
||||||
import { clientApi } from "@homarr/api/client";
|
import { clientApi } from "@homarr/api/client";
|
||||||
@@ -13,11 +11,13 @@ import { useSettings } from "@homarr/settings";
|
|||||||
import { useI18n } from "@homarr/translation/client";
|
import { useI18n } from "@homarr/translation/client";
|
||||||
|
|
||||||
import { createChildrenOptions } from "../../lib/children";
|
import { createChildrenOptions } from "../../lib/children";
|
||||||
|
import { filterCatalog, useSearchEnginesCatalogQuery } from "../../lib/catalog";
|
||||||
import { createGroup } from "../../lib/group";
|
import { createGroup } from "../../lib/group";
|
||||||
import type { inferSearchInteractionDefinition } from "../../lib/interaction";
|
import type { inferSearchInteractionDefinition } from "../../lib/interaction";
|
||||||
import { interaction } from "../../lib/interaction";
|
import { interaction } from "../../lib/interaction";
|
||||||
|
import { useRemoteQuery } from "../../lib/remote-query";
|
||||||
|
|
||||||
type SearchEngine = RouterOutputs["searchEngine"]["search"][number];
|
type SearchEngine = RouterOutputs["searchEngine"]["catalog"][number];
|
||||||
type FromIntegrationSearchResult = RouterOutputs["integration"]["searchInIntegration"][number];
|
type FromIntegrationSearchResult = RouterOutputs["integration"]["searchInIntegration"][number];
|
||||||
type DuckDuckGoBang = RouterOutputs["bangs"]["search"][number];
|
type DuckDuckGoBang = RouterOutputs["bangs"]["search"][number];
|
||||||
|
|
||||||
@@ -187,7 +187,7 @@ export const mediaRequestsChildrenOptions = createChildrenOptions<MediaRequestCh
|
|||||||
return (
|
return (
|
||||||
<Group mx="md" my="sm" wrap="nowrap">
|
<Group mx="md" my="sm" wrap="nowrap">
|
||||||
{options.result.image ? (
|
{options.result.image ? (
|
||||||
<Image src={options.result.image} w={35} h={50} fit="cover" radius={"md"} />
|
<Image src={options.result.image} alt="" w={35} h={50} fit="cover" radius={"md"} />
|
||||||
) : (
|
) : (
|
||||||
<IconSearch stroke={1.5} size={35} />
|
<IconSearch stroke={1.5} size={35} />
|
||||||
)}
|
)}
|
||||||
@@ -206,11 +206,12 @@ export const mediaRequestsChildrenOptions = createChildrenOptions<MediaRequestCh
|
|||||||
|
|
||||||
export const searchEnginesChildrenOptions = createChildrenOptions<SearchEngine>({
|
export const searchEnginesChildrenOptions = createChildrenOptions<SearchEngine>({
|
||||||
useActions: (searchEngine, query) => {
|
useActions: (searchEngine, query) => {
|
||||||
|
const remoteQuery = useRemoteQuery(query, "integration-search");
|
||||||
const { data } = clientApi.integration.searchInIntegration.useQuery(
|
const { data } = clientApi.integration.searchInIntegration.useQuery(
|
||||||
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
|
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
|
||||||
{ integrationId: searchEngine.integrationId!, query },
|
{ integrationId: searchEngine.integrationId!, query: remoteQuery.query },
|
||||||
{
|
{
|
||||||
enabled: searchEngine.type === "fromIntegration" && searchEngine.integrationId !== null && query.length > 0,
|
enabled: remoteQuery.enabled && searchEngine.type === "fromIntegration" && searchEngine.integrationId !== null,
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
const { openSearchInNewTab } = useSettings();
|
const { openSearchInNewTab } = useSettings();
|
||||||
@@ -244,7 +245,7 @@ export const searchEnginesChildrenOptions = createChildrenOptions<SearchEngine>(
|
|||||||
return (
|
return (
|
||||||
<Group mx="md" my="sm" wrap="nowrap">
|
<Group mx="md" my="sm" wrap="nowrap">
|
||||||
{searchResult.image ? (
|
{searchResult.image ? (
|
||||||
<Image src={searchResult.image} w={35} h={50} fit="cover" radius={"md"} />
|
<Image src={searchResult.image} alt="" w={35} h={50} fit="cover" radius={"md"} />
|
||||||
) : (
|
) : (
|
||||||
<IconSearch stroke={1.5} size={35} />
|
<IconSearch stroke={1.5} size={35} />
|
||||||
)}
|
)}
|
||||||
@@ -270,7 +271,7 @@ export const searchEnginesChildrenOptions = createChildrenOptions<SearchEngine>(
|
|||||||
<Stack mx="md" my="sm">
|
<Stack mx="md" my="sm">
|
||||||
<Text>{options.type === "generic" ? tChildren("detail.title") : tChildren("searchResults.title")}</Text>
|
<Text>{options.type === "generic" ? tChildren("detail.title") : tChildren("searchResults.title")}</Text>
|
||||||
<Group>
|
<Group>
|
||||||
<img height={24} width={24} src={options.iconUrl} alt={options.name} />
|
<img height={24} width={24} src={options.iconUrl} alt="" />
|
||||||
<Text>{options.name}</Text>
|
<Text>{options.name}</Text>
|
||||||
</Group>
|
</Group>
|
||||||
</Stack>
|
</Stack>
|
||||||
@@ -287,7 +288,7 @@ const parseBangQuery = (query: string) => {
|
|||||||
return { bangToken, searchText, locked };
|
return { bangToken, searchText, locked };
|
||||||
};
|
};
|
||||||
|
|
||||||
const buildSearchUrl = (template: string, query: string) => {
|
export const buildSearchUrl = (template: string, query: string) => {
|
||||||
const encoded = encodeURIComponent(query);
|
const encoded = encodeURIComponent(query);
|
||||||
if (template.includes("{{{s}}}")) {
|
if (template.includes("{{{s}}}")) {
|
||||||
return template.replaceAll("{{{s}}}", encoded);
|
return template.replaceAll("{{{s}}}", encoded);
|
||||||
@@ -296,36 +297,23 @@ const buildSearchUrl = (template: string, query: string) => {
|
|||||||
return template.replaceAll("%s", encoded);
|
return template.replaceAll("%s", encoded);
|
||||||
};
|
};
|
||||||
|
|
||||||
export const searchEnginesSearchGroups = createGroup<ExternalOption>({
|
interface SearchEngineGroupOptions {
|
||||||
keyPath: "key",
|
minimumLength: number;
|
||||||
title: (t) => t("common.entity.searchEngines"),
|
showEmptyHint: boolean;
|
||||||
Component: (option) => {
|
source: "focused" | "fallback";
|
||||||
if (option.kind === "hint") {
|
}
|
||||||
return (
|
|
||||||
<Group w="100%" wrap="nowrap" align="center" px="md" py="xs">
|
|
||||||
<IconSearch stroke={1.5} />
|
|
||||||
<Stack gap={0}>
|
|
||||||
<Text size="sm">{option.label}</Text>
|
|
||||||
{option.description ? (
|
|
||||||
<Text size="xs" c="gray.6">
|
|
||||||
{option.description}
|
|
||||||
</Text>
|
|
||||||
) : null}
|
|
||||||
</Stack>
|
|
||||||
</Group>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (option.kind === "search") {
|
const createSearchEnginesSearchGroup = ({ minimumLength, showEmptyHint, source }: SearchEngineGroupOptions) =>
|
||||||
return (
|
createGroup<ExternalOption>({
|
||||||
<Group w="100%" wrap="nowrap" justify="space-between" align="center" px="md" py="xs">
|
keyPath: "key",
|
||||||
<Group wrap="nowrap">
|
title: (t) => t("common.entity.searchEngines"),
|
||||||
{option.iconUrl ? (
|
source: source === "focused" ? { kind: "remote", source: "search-engines" } : { kind: "fallback" },
|
||||||
<img height={24} width={24} src={option.iconUrl} alt={option.label} />
|
Component: (option) => {
|
||||||
) : (
|
if (option.kind === "hint") {
|
||||||
<IconSearch stroke={1.5} />
|
return (
|
||||||
)}
|
<Group w="100%" wrap="nowrap" align="center" px="md" py="xs">
|
||||||
<Stack gap={0} justify="center">
|
<IconSearch stroke={1.5} />
|
||||||
|
<Stack gap={0}>
|
||||||
<Text size="sm">{option.label}</Text>
|
<Text size="sm">{option.label}</Text>
|
||||||
{option.description ? (
|
{option.description ? (
|
||||||
<Text size="xs" c="gray.6">
|
<Text size="xs" c="gray.6">
|
||||||
@@ -334,22 +322,61 @@ export const searchEnginesSearchGroups = createGroup<ExternalOption>({
|
|||||||
) : null}
|
) : null}
|
||||||
</Stack>
|
</Stack>
|
||||||
</Group>
|
</Group>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
<Kbd size="sm">!{option.bang}</Kbd>
|
if (option.kind === "search") {
|
||||||
</Group>
|
return (
|
||||||
);
|
<Group w="100%" wrap="nowrap" justify="space-between" align="center" px="md" py="xs">
|
||||||
}
|
<Group wrap="nowrap">
|
||||||
|
{option.iconUrl ? (
|
||||||
|
<img height={24} width={24} src={option.iconUrl} alt="" />
|
||||||
|
) : (
|
||||||
|
<IconSearch stroke={1.5} />
|
||||||
|
)}
|
||||||
|
<Stack gap={0} justify="center">
|
||||||
|
<Text size="sm">{option.label}</Text>
|
||||||
|
{option.description ? (
|
||||||
|
<Text size="xs" c="gray.6">
|
||||||
|
{option.description}
|
||||||
|
</Text>
|
||||||
|
) : null}
|
||||||
|
</Stack>
|
||||||
|
</Group>
|
||||||
|
|
||||||
if (option.kind === "engine") {
|
<Kbd size="sm">!{option.bang}</Kbd>
|
||||||
const { iconUrl, name, short, description } = option.engine;
|
</Group>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (option.kind === "engine") {
|
||||||
|
const { iconUrl, name, short, description } = option.engine;
|
||||||
|
return (
|
||||||
|
<Group w="100%" wrap="nowrap" justify="space-between" align="center" px="md" py="xs">
|
||||||
|
<Group wrap="nowrap">
|
||||||
|
<img height={24} width={24} src={iconUrl} alt="" />
|
||||||
|
<Stack gap={0} justify="center">
|
||||||
|
<Text size="sm">{name}</Text>
|
||||||
|
<Text size="xs" c="gray.6">
|
||||||
|
{description}
|
||||||
|
</Text>
|
||||||
|
</Stack>
|
||||||
|
</Group>
|
||||||
|
|
||||||
|
<Kbd size="sm">!{short}</Kbd>
|
||||||
|
</Group>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const { s: name, t: short, d: domain } = option.bang;
|
||||||
return (
|
return (
|
||||||
<Group w="100%" wrap="nowrap" justify="space-between" align="center" px="md" py="xs">
|
<Group w="100%" wrap="nowrap" justify="space-between" align="center" px="md" py="xs">
|
||||||
<Group wrap="nowrap">
|
<Group wrap="nowrap">
|
||||||
<img height={24} width={24} src={iconUrl} alt={name} />
|
<IconSearch stroke={1.5} />
|
||||||
<Stack gap={0} justify="center">
|
<Stack gap={0} justify="center">
|
||||||
<Text size="sm">{name}</Text>
|
<Text size="sm">{name}</Text>
|
||||||
<Text size="xs" c="gray.6">
|
<Text size="xs" c="gray.6">
|
||||||
{description}
|
{domain ?? "DuckDuckGo bang"}
|
||||||
</Text>
|
</Text>
|
||||||
</Stack>
|
</Stack>
|
||||||
</Group>
|
</Group>
|
||||||
@@ -357,138 +384,134 @@ export const searchEnginesSearchGroups = createGroup<ExternalOption>({
|
|||||||
<Kbd size="sm">!{short}</Kbd>
|
<Kbd size="sm">!{short}</Kbd>
|
||||||
</Group>
|
</Group>
|
||||||
);
|
);
|
||||||
}
|
},
|
||||||
|
useInteraction(option, query) {
|
||||||
|
const { openSearchInNewTab } = useSettings();
|
||||||
|
const { bangToken, searchText } = parseBangQuery(query);
|
||||||
|
|
||||||
const { s: name, t: short, d: domain } = option.bang;
|
if (option.kind === "search") {
|
||||||
return (
|
return {
|
||||||
<Group w="100%" wrap="nowrap" justify="space-between" align="center" px="md" py="xs">
|
type: "link",
|
||||||
<Group wrap="nowrap">
|
href: buildSearchUrl(option.urlTemplate, option.searchText),
|
||||||
<IconSearch stroke={1.5} />
|
newTab: openSearchInNewTab,
|
||||||
<Stack gap={0} justify="center">
|
};
|
||||||
<Text size="sm">{name}</Text>
|
}
|
||||||
<Text size="xs" c="gray.6">
|
|
||||||
{domain ?? "DuckDuckGo bang"}
|
|
||||||
</Text>
|
|
||||||
</Stack>
|
|
||||||
</Group>
|
|
||||||
|
|
||||||
<Kbd size="sm">!{short}</Kbd>
|
if (option.kind === "engine") {
|
||||||
</Group>
|
const nextBang = option.engine.short;
|
||||||
);
|
const nextQuery = `${`${nextBang} ${searchText}`.trimEnd()} `;
|
||||||
},
|
return { type: "setQuery", query: bangToken === nextBang && query.endsWith(" ") ? query : nextQuery };
|
||||||
useInteraction(option, query) {
|
}
|
||||||
const { openSearchInNewTab } = useSettings();
|
|
||||||
const { bangToken, searchText } = parseBangQuery(query);
|
|
||||||
|
|
||||||
if (option.kind === "search") {
|
if (option.kind === "ddg") {
|
||||||
return {
|
const nextBang = option.bang.t;
|
||||||
type: "link",
|
const nextQuery = `${`${nextBang} ${searchText}`.trimEnd()} `;
|
||||||
href: buildSearchUrl(option.urlTemplate, option.searchText),
|
return { type: "setQuery", query: bangToken === nextBang && query.endsWith(" ") ? query : nextQuery };
|
||||||
newTab: openSearchInNewTab,
|
}
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
if (option.kind === "engine") {
|
return { type: "none" };
|
||||||
const nextBang = option.engine.short;
|
},
|
||||||
const nextQuery = `${`${nextBang} ${searchText}`.trimEnd()} `;
|
useQueryOptions(query) {
|
||||||
return { type: "setQuery", query: bangToken === nextBang && query.endsWith(" ") ? query : nextQuery };
|
const tExternal = useI18n("search.mode.external.group.searchEngine");
|
||||||
}
|
const { ddgBangs } = useSettings();
|
||||||
|
const { bangToken, searchText, locked } = parseBangQuery(query);
|
||||||
|
const remoteQuery = useRemoteQuery(bangToken, "search-engines", { minimumLength });
|
||||||
|
const ddgQueryEnabled = remoteQuery.enabled && ddgBangs && remoteQuery.query.length >= 1;
|
||||||
|
const enginesQuery = useSearchEnginesCatalogQuery();
|
||||||
|
|
||||||
if (option.kind === "ddg") {
|
const ddgQuery = clientApi.bangs.search.useQuery(
|
||||||
const nextBang = option.bang.t;
|
{ query: remoteQuery.query, limit: 10 },
|
||||||
const nextQuery = `${`${nextBang} ${searchText}`.trimEnd()} `;
|
{
|
||||||
return { type: "setQuery", query: bangToken === nextBang && query.endsWith(" ") ? query : nextQuery };
|
enabled: ddgQueryEnabled,
|
||||||
}
|
placeholderData: (previousData) => previousData,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
return { type: "none" };
|
const engineCatalog = enginesQuery.data ?? [];
|
||||||
},
|
const engineData = filterCatalog(engineCatalog, bangToken, (engine) => [engine.short, engine.name], 10);
|
||||||
useQueryOptions(query) {
|
const ddgData = ddgQueryEnabled && bangToken.length > 0
|
||||||
const tExternal = useI18n("search.mode.external.group.searchEngine");
|
? (ddgQuery.data ?? []).filter((bang) => bang.t.toLowerCase().startsWith(bangToken.toLowerCase()))
|
||||||
const { ddgBangs } = useSettings();
|
: [];
|
||||||
const { bangToken, searchText, locked } = parseBangQuery(query);
|
const isWaitingForDdgResults =
|
||||||
const [debouncedBangToken] = useDebouncedValue(bangToken, 150);
|
ddgBangs &&
|
||||||
|
bangToken.length > 0 &&
|
||||||
|
engineData.length === 0 &&
|
||||||
|
(remoteQuery.query !== bangToken || (ddgQueryEnabled && ddgQuery.isFetching && ddgData.length === 0));
|
||||||
|
const isLoading = enginesQuery.isLoading || isWaitingForDdgResults;
|
||||||
|
const isError = enginesQuery.isError || (ddgQuery.isError && ddgQueryEnabled && bangToken.length > 0);
|
||||||
|
|
||||||
const enginesQuery = clientApi.searchEngine.search.useQuery(
|
const engineOptions = engineData.map(
|
||||||
{ query: debouncedBangToken, limit: 10 },
|
(engine): ExternalOption => ({
|
||||||
{ placeholderData: keepPreviousData },
|
key: `engine-${engine.short}`,
|
||||||
);
|
kind: "engine",
|
||||||
|
engine,
|
||||||
const ddgQuery = clientApi.bangs.search.useQuery(
|
|
||||||
{ query: debouncedBangToken, limit: 10 },
|
|
||||||
{
|
|
||||||
enabled: ddgBangs && debouncedBangToken.length >= 1,
|
|
||||||
placeholderData: keepPreviousData,
|
|
||||||
},
|
|
||||||
);
|
|
||||||
|
|
||||||
const isLoading = enginesQuery.isLoading || ddgQuery.isLoading;
|
|
||||||
const isError = enginesQuery.isError || ddgQuery.isError;
|
|
||||||
|
|
||||||
const engineOptions = (enginesQuery.data ?? []).map(
|
|
||||||
(engine): ExternalOption => ({
|
|
||||||
key: `engine-${engine.short}`,
|
|
||||||
kind: "engine",
|
|
||||||
engine,
|
|
||||||
}),
|
|
||||||
);
|
|
||||||
|
|
||||||
const ddgOptions = (ddgQuery.data ?? [])
|
|
||||||
.filter((bang) => !engineOptions.some((option) => option.kind === "engine" && option.engine.short === bang.t))
|
|
||||||
.map(
|
|
||||||
(bang): ExternalOption => ({
|
|
||||||
key: `ddg-${bang.t}`,
|
|
||||||
kind: "ddg",
|
|
||||||
bang,
|
|
||||||
}),
|
}),
|
||||||
);
|
);
|
||||||
|
|
||||||
const searchActions: ExternalOption[] = [];
|
const ddgOptions = ddgData
|
||||||
if (locked && bangToken.length > 0) {
|
.filter((bang) => !engineOptions.some((option) => option.kind === "engine" && option.engine.short === bang.t))
|
||||||
const matchedEngine = (enginesQuery.data ?? []).find((engine) => engine.short === bangToken);
|
.map(
|
||||||
const matchedDdg = (ddgQuery.data ?? []).find((bang) => bang.t === bangToken);
|
(bang): ExternalOption => ({
|
||||||
|
key: `ddg-${bang.t}`,
|
||||||
|
kind: "ddg",
|
||||||
|
bang,
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
const label = matchedEngine?.name ?? matchedDdg?.s;
|
const searchActions: ExternalOption[] = [];
|
||||||
const iconUrl = matchedEngine?.iconUrl;
|
if (locked && bangToken.length > 0) {
|
||||||
const urlTemplate = matchedEngine?.type === "generic" ? matchedEngine.urlTemplate : matchedDdg?.u;
|
const matchedEngine = engineCatalog.find((engine) => engine.short === bangToken);
|
||||||
|
const matchedDdg = ddgData.find((bang) => bang.t === bangToken);
|
||||||
|
|
||||||
if (label && urlTemplate) {
|
const genericEngine = matchedEngine?.type === "generic" ? matchedEngine : undefined;
|
||||||
if (searchText.trim().length > 0) {
|
const label = genericEngine?.name ?? matchedDdg?.s;
|
||||||
searchActions.push({
|
const iconUrl = genericEngine?.iconUrl;
|
||||||
key: "search-action",
|
const urlTemplate = genericEngine?.urlTemplate ?? matchedDdg?.u;
|
||||||
kind: "search",
|
|
||||||
label: tExternal("bang.searchWithQuery", {
|
if (label && urlTemplate) {
|
||||||
query: searchText.trim(),
|
if (searchText.trim().length > 0) {
|
||||||
label,
|
searchActions.push({
|
||||||
}),
|
key: "search-action",
|
||||||
description: tExternal("bang.pressEnterToOpen"),
|
kind: "search",
|
||||||
bang: bangToken,
|
label: tExternal("bang.searchWithQuery", {
|
||||||
iconUrl,
|
query: searchText.trim(),
|
||||||
urlTemplate,
|
label,
|
||||||
searchText: searchText.trim(),
|
}),
|
||||||
});
|
description: tExternal("bang.pressEnterToOpen"),
|
||||||
} else {
|
bang: bangToken,
|
||||||
searchActions.push({
|
iconUrl,
|
||||||
key: "search-hint",
|
urlTemplate,
|
||||||
kind: "hint",
|
searchText: searchText.trim(),
|
||||||
label: tExternal("bang.engineSelected", { label, bang: bangToken }),
|
});
|
||||||
description: tExternal("bang.typeQueryToContinue"),
|
} else {
|
||||||
});
|
searchActions.push({
|
||||||
|
key: "search-hint",
|
||||||
|
kind: "hint",
|
||||||
|
label: tExternal("bang.engineSelected", { label, bang: bangToken }),
|
||||||
|
description: tExternal("bang.typeQueryToContinue"),
|
||||||
|
});
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
if (showEmptyHint && bangToken.length === 0) {
|
||||||
if (query.length === 0) {
|
searchActions.push({
|
||||||
searchActions.push({
|
key: "hint",
|
||||||
key: "hint",
|
kind: "hint",
|
||||||
kind: "hint",
|
label: tExternal("bang.emptyBangHint"),
|
||||||
label: tExternal("bang.emptyBangHint"),
|
description: ddgBangs ? tExternal("tipDdgBangs") : undefined,
|
||||||
description: ddgBangs ? tExternal("tipDdgBangs") : undefined,
|
});
|
||||||
});
|
}
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
return {
|
||||||
isLoading,
|
isLoading,
|
||||||
isError,
|
isError,
|
||||||
data: [...searchActions, ...engineOptions, ...ddgOptions].slice(0, 10),
|
data: [...searchActions, ...engineOptions, ...ddgOptions].slice(0, 10),
|
||||||
};
|
};
|
||||||
},
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
export const searchEnginesSearchGroups = createSearchEnginesSearchGroup({
|
||||||
|
minimumLength: 0,
|
||||||
|
showEmptyHint: true,
|
||||||
|
source: "focused",
|
||||||
});
|
});
|
||||||
@@ -1,138 +0,0 @@
|
|||||||
import { Group, Kbd, Text } from "@mantine/core";
|
|
||||||
import {
|
|
||||||
IconBook2,
|
|
||||||
IconBrandDiscord,
|
|
||||||
IconBrandGithub,
|
|
||||||
IconLayoutDashboard,
|
|
||||||
IconSearch,
|
|
||||||
IconSettings,
|
|
||||||
} from "@tabler/icons-react";
|
|
||||||
|
|
||||||
import { useSession } from "@homarr/auth/client";
|
|
||||||
import { createDocumentationLink } from "@homarr/definitions";
|
|
||||||
import { useI18n } from "@homarr/translation/client";
|
|
||||||
import type { TablerIcon } from "@homarr/ui";
|
|
||||||
|
|
||||||
import { createGroup } from "../../lib/group";
|
|
||||||
import { interaction } from "../../lib/interaction";
|
|
||||||
import type { SearchMode } from "../../lib/mode";
|
|
||||||
import { appIntegrationBoardMode } from "../app-integration-board";
|
|
||||||
import { commandMode } from "../command";
|
|
||||||
import { externalMode } from "../external";
|
|
||||||
import { mediaMode } from "../media";
|
|
||||||
import { pageMode } from "../page";
|
|
||||||
import { preferencesGroup } from "../preferences/groups";
|
|
||||||
import { userGroupMode } from "../user-group";
|
|
||||||
|
|
||||||
type QuickLinkOption = {
|
|
||||||
key: string;
|
|
||||||
icon: TablerIcon;
|
|
||||||
name: string;
|
|
||||||
path: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
export const useHomeEmptyGroups = () => {
|
|
||||||
const { data: session } = useSession();
|
|
||||||
const tPages = useI18n("search.mode.page.group.page.option");
|
|
||||||
const tHelp = useI18n("management.navbar.items.help.items");
|
|
||||||
const visibleSearchModes: SearchMode[] = [appIntegrationBoardMode, externalMode, mediaMode, commandMode, pageMode];
|
|
||||||
|
|
||||||
if (session?.user.permissions.includes("admin")) {
|
|
||||||
visibleSearchModes.unshift(userGroupMode);
|
|
||||||
}
|
|
||||||
|
|
||||||
return [
|
|
||||||
createGroup({
|
|
||||||
keyPath: "key",
|
|
||||||
title: () => "Quick links",
|
|
||||||
options: (() => {
|
|
||||||
const quickLinks: QuickLinkOption[] = [];
|
|
||||||
|
|
||||||
quickLinks.push({
|
|
||||||
key: "manageBoards",
|
|
||||||
icon: IconLayoutDashboard,
|
|
||||||
path: "/manage/boards",
|
|
||||||
name: tPages("manageBoard.label"),
|
|
||||||
});
|
|
||||||
|
|
||||||
if (session?.user.permissions.includes("admin")) {
|
|
||||||
quickLinks.push({
|
|
||||||
key: "manageSettings",
|
|
||||||
icon: IconSettings,
|
|
||||||
path: "/manage/settings",
|
|
||||||
name: tPages("manageSettings.label"),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
if (session) {
|
|
||||||
quickLinks.push({
|
|
||||||
key: "manageSearchEngines",
|
|
||||||
icon: IconSearch,
|
|
||||||
path: "/manage/search-engines",
|
|
||||||
name: tPages("manageSearchEngine.label"),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
return quickLinks;
|
|
||||||
})(),
|
|
||||||
Component: ({ name, icon: Icon }) => (
|
|
||||||
<Group px="md" py="xs" w="100%" wrap="nowrap" align="center">
|
|
||||||
<Icon stroke={1.5} />
|
|
||||||
<Text>{name}</Text>
|
|
||||||
</Group>
|
|
||||||
),
|
|
||||||
filter: () => true,
|
|
||||||
useInteraction: interaction.link(({ path }) => ({ href: path })),
|
|
||||||
}),
|
|
||||||
createGroup({
|
|
||||||
keyPath: "modeKey",
|
|
||||||
title: (t) => t("search.mode.help.group.mode.title"),
|
|
||||||
options: visibleSearchModes.map(({ character, modeKey }) => ({ character, modeKey })),
|
|
||||||
Component: ({ modeKey, character }) => {
|
|
||||||
const t = useI18n(`search.mode.${modeKey}`);
|
|
||||||
|
|
||||||
return (
|
|
||||||
<Group px="md" py="xs" w="100%" wrap="nowrap" align="center" justify="space-between">
|
|
||||||
<Text>{t("help")}</Text>
|
|
||||||
{character && <Kbd size="sm">{character}</Kbd>}
|
|
||||||
</Group>
|
|
||||||
);
|
|
||||||
},
|
|
||||||
filter: () => true,
|
|
||||||
useInteraction: interaction.mode(({ modeKey }) => ({ mode: modeKey })),
|
|
||||||
}),
|
|
||||||
createGroup({
|
|
||||||
keyPath: "href",
|
|
||||||
title: (t) => t("management.navbar.items.help.label"),
|
|
||||||
useOptions() {
|
|
||||||
return [
|
|
||||||
{
|
|
||||||
href: createDocumentationLink("/docs/getting-started"),
|
|
||||||
icon: IconBook2,
|
|
||||||
label: tHelp("documentation"),
|
|
||||||
},
|
|
||||||
{
|
|
||||||
href: "https://github.com/homarr-labs/homarr/issues/new/choose",
|
|
||||||
icon: IconBrandGithub,
|
|
||||||
label: tHelp("submitIssue"),
|
|
||||||
},
|
|
||||||
{
|
|
||||||
href: "https://discord.com/invite/aCsmEV5RgA",
|
|
||||||
icon: IconBrandDiscord,
|
|
||||||
label: tHelp("discord"),
|
|
||||||
},
|
|
||||||
];
|
|
||||||
},
|
|
||||||
Component: (props) => (
|
|
||||||
<Group px="md" py="xs" w="100%" wrap="nowrap" align="center">
|
|
||||||
<props.icon stroke={1.5} />
|
|
||||||
<Text>{props.label}</Text>
|
|
||||||
</Group>
|
|
||||||
),
|
|
||||||
filter: () => true,
|
|
||||||
useInteraction: interaction.link(({ href }) => ({ href, newTab: true })),
|
|
||||||
}),
|
|
||||||
] as const;
|
|
||||||
};
|
|
||||||
|
|
||||||
export const useHomeEmptyGroupsWithPreferences = () => [preferencesGroup, ...useHomeEmptyGroups()];
|
|
||||||
@@ -7,39 +7,89 @@ import { useSpotlightContextResults } from "./context";
|
|||||||
export const shouldShowContextSpecificResult = (query: string, option: ContextSpecificItem) => {
|
export const shouldShowContextSpecificResult = (query: string, option: ContextSpecificItem) => {
|
||||||
if (option.alwaysVisible) return true;
|
if (option.alwaysVisible) return true;
|
||||||
if (query.length === 0) return false;
|
if (query.length === 0) return false;
|
||||||
return option.name.toLowerCase().includes(query.toLowerCase());
|
const normalizedQuery = query.trim().toLowerCase();
|
||||||
|
const searchableValues = [option.name, option.description ?? "", ...(option.aliases ?? [])];
|
||||||
|
return searchableValues.some((value) => value.toLowerCase().includes(normalizedQuery));
|
||||||
|
};
|
||||||
|
|
||||||
|
const localResultSort = (query: string, [first, second]: [ContextSpecificItem, ContextSpecificItem]) => {
|
||||||
|
const normalizedQuery = query.trim().toLowerCase();
|
||||||
|
const score = (option: ContextSpecificItem) => {
|
||||||
|
const normalizedName = option.name.toLowerCase();
|
||||||
|
if (normalizedName === normalizedQuery) return 0;
|
||||||
|
if (normalizedName.startsWith(normalizedQuery)) return 1;
|
||||||
|
return 2;
|
||||||
|
};
|
||||||
|
|
||||||
|
return score(first) - score(second);
|
||||||
|
};
|
||||||
|
|
||||||
|
const renderContextSpecificItem = (option: ContextSpecificItem) => {
|
||||||
|
const icon =
|
||||||
|
typeof option.icon !== "string" ? (
|
||||||
|
<option.icon size={24} />
|
||||||
|
) : (
|
||||||
|
<img width={24} height={24} src={option.icon} alt="" />
|
||||||
|
);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Group w="100%" wrap="nowrap" align="center" px="md" py="xs" opacity={option.unavailable ? 0.55 : 1}>
|
||||||
|
{icon}
|
||||||
|
<Stack gap={0}>
|
||||||
|
<Text>{option.name}</Text>
|
||||||
|
{option.description ? (
|
||||||
|
<Text size="xs" c="dimmed">
|
||||||
|
{option.description}
|
||||||
|
</Text>
|
||||||
|
) : null}
|
||||||
|
</Stack>
|
||||||
|
</Group>
|
||||||
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
export const contextSpecificSearchGroups = createGroup<ContextSpecificItem>({
|
export const contextSpecificSearchGroups = createGroup<ContextSpecificItem>({
|
||||||
title: (t) => t("search.mode.home.group.local.title"),
|
title: (t) => t("search.mode.home.group.local.title"),
|
||||||
keyPath: "id",
|
keyPath: "id",
|
||||||
Component(option) {
|
source: { kind: "local" },
|
||||||
const icon =
|
Component: renderContextSpecificItem,
|
||||||
typeof option.icon !== "string" ? (
|
|
||||||
<option.icon size={24} />
|
|
||||||
) : (
|
|
||||||
<img width={24} height={24} src={option.icon} alt={option.name} />
|
|
||||||
);
|
|
||||||
|
|
||||||
return (
|
|
||||||
<Group w="100%" wrap="nowrap" align="center" px="md" py="xs" opacity={option.unavailable ? 0.55 : 1}>
|
|
||||||
{icon}
|
|
||||||
<Stack gap={0}>
|
|
||||||
<Text>{option.name}</Text>
|
|
||||||
{option.description && (
|
|
||||||
<Text size="xs" c="dimmed">
|
|
||||||
{option.description}
|
|
||||||
</Text>
|
|
||||||
)}
|
|
||||||
</Stack>
|
|
||||||
</Group>
|
|
||||||
);
|
|
||||||
},
|
|
||||||
useInteraction(option, query) {
|
useInteraction(option, query) {
|
||||||
return option.interaction(query);
|
return option.interaction(query);
|
||||||
},
|
},
|
||||||
filter: shouldShowContextSpecificResult,
|
filter: shouldShowContextSpecificResult,
|
||||||
|
sort: localResultSort,
|
||||||
useOptions() {
|
useOptions() {
|
||||||
return useSpotlightContextResults();
|
return useSpotlightContextResults().filter((item) => item.placement !== "fallback");
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
export const contextSpecificAppsSearchGroup = createGroup<ContextSpecificItem>({
|
||||||
|
title: (t) => t("search.mode.home.group.local.title"),
|
||||||
|
keyPath: "id",
|
||||||
|
source: { kind: "local" },
|
||||||
|
Component: renderContextSpecificItem,
|
||||||
|
useInteraction(option, query) {
|
||||||
|
return option.interaction(query);
|
||||||
|
},
|
||||||
|
filter(query, option) {
|
||||||
|
return query.trim().length === 0 || shouldShowContextSpecificResult(query, option);
|
||||||
|
},
|
||||||
|
sort: localResultSort,
|
||||||
|
useOptions() {
|
||||||
|
return useSpotlightContextResults().filter((item) => item.placement !== "fallback");
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
export const contextSpecificFallbackSearchGroup = createGroup<ContextSpecificItem>({
|
||||||
|
title: (t) => t("search.modePicker.continueWith"),
|
||||||
|
keyPath: "id",
|
||||||
|
source: { kind: "fallback" },
|
||||||
|
Component: renderContextSpecificItem,
|
||||||
|
useInteraction(option, query) {
|
||||||
|
return option.interaction(query);
|
||||||
|
},
|
||||||
|
filter: shouldShowContextSpecificResult,
|
||||||
|
sort: localResultSort,
|
||||||
|
useOptions() {
|
||||||
|
return useSpotlightContextResults().filter((item) => item.placement === "fallback");
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
@@ -11,10 +11,13 @@ export type ContextSpecificItem = {
|
|||||||
name: string;
|
name: string;
|
||||||
icon: TablerIcon | string;
|
icon: TablerIcon | string;
|
||||||
interaction: (query: string) => inferSearchInteractionDefinition<SearchInteraction>;
|
interaction: (query: string) => inferSearchInteractionDefinition<SearchInteraction>;
|
||||||
|
aliases?: string[];
|
||||||
|
placement?: "primary" | "fallback";
|
||||||
disabled?: boolean;
|
disabled?: boolean;
|
||||||
description?: string;
|
description?: string;
|
||||||
unavailable?: boolean;
|
unavailable?: boolean;
|
||||||
alwaysVisible?: boolean;
|
alwaysVisible?: boolean;
|
||||||
|
dedupeKey?: string;
|
||||||
};
|
};
|
||||||
|
|
||||||
interface SpotlightContextProps {
|
interface SpotlightContextProps {
|
||||||
@@ -60,7 +63,22 @@ const createSpotlightContext = (displayName: string) => {
|
|||||||
});
|
});
|
||||||
}, []);
|
}, []);
|
||||||
|
|
||||||
const items = useMemo(() => Array.from(itemsMap.values()).flatMap(({ items }) => items), [itemsMap]);
|
const items = useMemo(() => {
|
||||||
|
const uniqueItems: ContextSpecificItem[] = [];
|
||||||
|
const itemKeys = new Set<string>();
|
||||||
|
|
||||||
|
for (const registration of itemsMap.values()) {
|
||||||
|
for (const item of registration.items) {
|
||||||
|
const itemKey = item.dedupeKey ?? item.id;
|
||||||
|
if (itemKeys.has(itemKey)) continue;
|
||||||
|
|
||||||
|
itemKeys.add(itemKey);
|
||||||
|
uniqueItems.push(item);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return uniqueItems;
|
||||||
|
}, [itemsMap]);
|
||||||
const itemsContext = useMemo(() => ({ items }), [items]);
|
const itemsContext = useMemo(() => ({ items }), [items]);
|
||||||
const registration = useMemo(() => ({ registerItems, unregisterItems }), [registerItems, unregisterItems]);
|
const registration = useMemo(() => ({ registerItems, unregisterItems }), [registerItems, unregisterItems]);
|
||||||
|
|
||||||
|
|||||||
@@ -1,19 +1,21 @@
|
|||||||
import { Box, Group, Stack, Text } from "@mantine/core";
|
import { Box, Group, Stack, Text } from "@mantine/core";
|
||||||
import { IconSearch, IconSearchOff } from "@tabler/icons-react";
|
import { IconSearchOff } from "@tabler/icons-react";
|
||||||
|
|
||||||
import type { RouterOutputs } from "@homarr/api";
|
import type { RouterOutputs } from "@homarr/api";
|
||||||
import { clientApi } from "@homarr/api/client";
|
|
||||||
import type { Session } from "@homarr/auth";
|
|
||||||
import { useSession } from "@homarr/auth/client";
|
import { useSession } from "@homarr/auth/client";
|
||||||
import { useSettings } from "@homarr/settings";
|
import { useSettings } from "@homarr/settings";
|
||||||
import type { TranslationFunction } from "@homarr/translation";
|
import type { TranslationFunction } from "@homarr/translation";
|
||||||
import { useI18n } from "@homarr/translation/client";
|
import { useI18n } from "@homarr/translation/client";
|
||||||
import type { TablerIcon } from "@homarr/ui";
|
import type { TablerIcon } from "@homarr/ui";
|
||||||
|
|
||||||
|
import { useSearchEnginesCatalogQuery } from "../../lib/catalog";
|
||||||
import { createGroup } from "../../lib/group";
|
import { createGroup } from "../../lib/group";
|
||||||
import type { inferSearchInteractionDefinition, SearchInteraction } from "../../lib/interaction";
|
import type { inferSearchInteractionDefinition, SearchInteraction } from "../../lib/interaction";
|
||||||
import { useFromIntegrationSearchInteraction } from "../external/search-engines-search-group";
|
import { buildSearchUrl } from "../external/search-engines-search-group";
|
||||||
|
|
||||||
|
type SearchEngine = RouterOutputs["searchEngine"]["catalog"][number];
|
||||||
|
|
||||||
|
// This has to be type so it can be interpreted as Record<string, unknown>.
|
||||||
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
|
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
|
||||||
type GroupItem = {
|
type GroupItem = {
|
||||||
id: string;
|
id: string;
|
||||||
@@ -21,19 +23,20 @@ type GroupItem = {
|
|||||||
description?: string;
|
description?: string;
|
||||||
icon: TablerIcon | string;
|
icon: TablerIcon | string;
|
||||||
disabled?: boolean;
|
disabled?: boolean;
|
||||||
useInteraction: (query: string) => inferSearchInteractionDefinition<SearchInteraction>;
|
interaction: inferSearchInteractionDefinition<SearchInteraction>;
|
||||||
};
|
};
|
||||||
|
|
||||||
export const homeSearchEngineGroup = createGroup<GroupItem>({
|
export const homeSearchEngineGroup = createGroup<GroupItem>({
|
||||||
title: (t) => t("search.mode.home.group.search.title"),
|
title: (t) => t("search.mode.home.group.search.title"),
|
||||||
keyPath: "id",
|
keyPath: "id",
|
||||||
|
source: { kind: "fallback" },
|
||||||
Component(item) {
|
Component(item) {
|
||||||
const icon =
|
const icon =
|
||||||
typeof item.icon !== "string" ? (
|
typeof item.icon !== "string" ? (
|
||||||
<item.icon size={24} />
|
<item.icon size={24} />
|
||||||
) : (
|
) : (
|
||||||
<Box w={24} h={24}>
|
<Box w={24} h={24}>
|
||||||
<img src={item.icon} alt={item.name} style={{ maxWidth: 24 }} />
|
<img src={item.icon} alt="" style={{ maxWidth: 24 }} />
|
||||||
</Box>
|
</Box>
|
||||||
);
|
);
|
||||||
|
|
||||||
@@ -42,121 +45,95 @@ export const homeSearchEngineGroup = createGroup<GroupItem>({
|
|||||||
{icon}
|
{icon}
|
||||||
<Stack gap={0}>
|
<Stack gap={0}>
|
||||||
<Text>{item.name}</Text>
|
<Text>{item.name}</Text>
|
||||||
{item.description && (
|
{item.description ? (
|
||||||
<Text c="gray.6" size="sm">
|
<Text c="gray.6" size="sm">
|
||||||
{item.description}
|
{item.description}
|
||||||
</Text>
|
</Text>
|
||||||
)}
|
) : null}
|
||||||
</Stack>
|
</Stack>
|
||||||
</Group>
|
</Group>
|
||||||
);
|
);
|
||||||
},
|
},
|
||||||
useInteraction(item, query) {
|
useInteraction(item) {
|
||||||
return item.useInteraction(query);
|
return item.interaction;
|
||||||
},
|
|
||||||
filter() {
|
|
||||||
return true;
|
|
||||||
},
|
},
|
||||||
useQueryOptions(query) {
|
useQueryOptions(query) {
|
||||||
const t = useI18n();
|
const t = useI18n();
|
||||||
const { data: session, status } = useSession();
|
const { data: session } = useSession();
|
||||||
const { data: defaultSearchEngine, ...defaultSearchEngineQuery } =
|
const { openSearchInNewTab } = useSettings();
|
||||||
clientApi.searchEngine.getDefaultSearchEngine.useQuery(undefined, {
|
const catalogQuery = useSearchEnginesCatalogQuery();
|
||||||
enabled: status !== "loading",
|
|
||||||
});
|
|
||||||
const fromIntegrationEnabled = defaultSearchEngine?.type === "fromIntegration" && query.length > 0;
|
|
||||||
const { data: results, ...resultQuery } = clientApi.integration.searchInIntegration.useQuery(
|
|
||||||
{
|
|
||||||
query,
|
|
||||||
integrationId: defaultSearchEngine?.integrationId ?? "",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
enabled: fromIntegrationEnabled,
|
|
||||||
select: (data) => data.slice(0, 5),
|
|
||||||
},
|
|
||||||
);
|
|
||||||
|
|
||||||
return {
|
return {
|
||||||
isLoading:
|
isLoading: catalogQuery.isLoading,
|
||||||
defaultSearchEngineQuery.isLoading || (resultQuery.isLoading && fromIntegrationEnabled) || status === "loading",
|
isError: catalogQuery.isError,
|
||||||
isError: defaultSearchEngineQuery.isError || (resultQuery.isError && fromIntegrationEnabled),
|
data: createSearchEntries(
|
||||||
data: createDefaultSearchEntries(defaultSearchEngine, results, session, query, t),
|
catalogQuery.data ?? [],
|
||||||
|
session?.user.permissions.includes("search-engine-create") === true,
|
||||||
|
query,
|
||||||
|
openSearchInNewTab,
|
||||||
|
t,
|
||||||
|
),
|
||||||
};
|
};
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
const createDefaultSearchEntries = (
|
const createSearchEntries = (
|
||||||
defaultSearchEngine: RouterOutputs["searchEngine"]["getDefaultSearchEngine"] | null,
|
searchEngines: SearchEngine[],
|
||||||
results: RouterOutputs["integration"]["searchInIntegration"] | undefined,
|
canCreateSearchEngine: boolean,
|
||||||
session: Session | null,
|
|
||||||
query: string,
|
query: string,
|
||||||
|
openInNewTab: boolean,
|
||||||
t: TranslationFunction,
|
t: TranslationFunction,
|
||||||
): GroupItem[] => {
|
): GroupItem[] => {
|
||||||
if (!session?.user && !defaultSearchEngine) return [];
|
if (searchEngines.length === 0) {
|
||||||
|
|
||||||
if (!defaultSearchEngine) {
|
|
||||||
return [
|
return [
|
||||||
{
|
{
|
||||||
id: "no-default",
|
id: "no-search-engines",
|
||||||
name: t("search.mode.home.group.search.option.no-default.label"),
|
name: t("search.mode.home.group.search.option.no-engines.label"),
|
||||||
description: t("search.mode.home.group.search.option.no-default.description"),
|
description: canCreateSearchEngine
|
||||||
|
? t("search.mode.home.group.search.option.no-engines.descriptionCreate")
|
||||||
|
: t("search.mode.home.group.search.option.no-engines.descriptionUnavailable"),
|
||||||
icon: IconSearchOff,
|
icon: IconSearchOff,
|
||||||
useInteraction() {
|
disabled: !canCreateSearchEngine,
|
||||||
return {
|
interaction: canCreateSearchEngine ? { type: "link", href: "/manage/search-engines/new" } : { type: "none" },
|
||||||
type: "link",
|
|
||||||
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
|
|
||||||
href: `/manage/users/${session!.user.id}/general`,
|
|
||||||
};
|
|
||||||
},
|
|
||||||
},
|
},
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
if (defaultSearchEngine.type === "generic") {
|
const normalizedQuery = query.trim();
|
||||||
return [
|
return searchEngines.map((searchEngine) => {
|
||||||
{
|
const name =
|
||||||
id: "search",
|
normalizedQuery.length === 0
|
||||||
name: t("search.mode.home.group.search.option.search.label", {
|
? searchEngine.name
|
||||||
query,
|
: t("search.mode.home.group.search.option.search.label", {
|
||||||
name: defaultSearchEngine.name,
|
query: normalizedQuery,
|
||||||
}),
|
name: searchEngine.name,
|
||||||
icon: defaultSearchEngine.iconUrl,
|
});
|
||||||
useInteraction(query) {
|
|
||||||
const { openSearchInNewTab } = useSettings();
|
|
||||||
return {
|
|
||||||
type: "link",
|
|
||||||
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
|
|
||||||
href: defaultSearchEngine.urlTemplate!.replace("%s", query),
|
|
||||||
newTab: openSearchInNewTab,
|
|
||||||
};
|
|
||||||
},
|
|
||||||
},
|
|
||||||
];
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!results) {
|
if (searchEngine.type === "generic") {
|
||||||
return [
|
return {
|
||||||
{
|
id: `search-${searchEngine.id}`,
|
||||||
id: "from-integration",
|
name,
|
||||||
name: defaultSearchEngine.name,
|
description: searchEngine.description ?? undefined,
|
||||||
icon: defaultSearchEngine.iconUrl,
|
icon: searchEngine.iconUrl,
|
||||||
description: t("search.mode.home.group.search.option.from-integration.description"),
|
interaction: {
|
||||||
useInteraction() {
|
type: "link",
|
||||||
return {
|
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
|
||||||
type: "none",
|
href: buildSearchUrl(searchEngine.urlTemplate!, normalizedQuery),
|
||||||
};
|
newTab: openInNewTab,
|
||||||
},
|
},
|
||||||
},
|
};
|
||||||
];
|
}
|
||||||
}
|
|
||||||
|
|
||||||
return results.map((result) => ({
|
return {
|
||||||
id: `search-${result.id}`,
|
id: `search-${searchEngine.id}`,
|
||||||
name: result.name,
|
name,
|
||||||
description: result.text,
|
description: searchEngine.description ?? undefined,
|
||||||
icon: result.image ?? IconSearch,
|
icon: searchEngine.iconUrl,
|
||||||
useInteraction() {
|
interaction: {
|
||||||
return useFromIntegrationSearchInteraction(defaultSearchEngine, result);
|
type: "mode",
|
||||||
},
|
mode: "external",
|
||||||
}));
|
query: `${searchEngine.short} ${normalizedQuery}`.trimEnd(),
|
||||||
|
},
|
||||||
|
};
|
||||||
|
});
|
||||||
};
|
};
|
||||||
@@ -1,10 +1,38 @@
|
|||||||
import type { SearchMode } from "../../lib/mode";
|
import type { SearchMode } from "../../lib/mode";
|
||||||
import { preferencesGroup } from "../preferences/groups";
|
import { appIntegrationBoardMode } from "../app-integration-board";
|
||||||
import { contextSpecificSearchGroups } from "./context-specific-group";
|
import { contextSpecificActionsSearchGroups } from "../command/context-specific-group";
|
||||||
|
import { globalCommandGroup } from "../command/global-group";
|
||||||
import { homeSearchEngineGroup } from "./home-search-engine-group";
|
import { homeSearchEngineGroup } from "./home-search-engine-group";
|
||||||
|
import {
|
||||||
|
contextSpecificAppsSearchGroup,
|
||||||
|
contextSpecificFallbackSearchGroup,
|
||||||
|
contextSpecificSearchGroups,
|
||||||
|
} from "./context-specific-group";
|
||||||
|
import { mediaFallbackGroup } from "../media/media-fallback-group";
|
||||||
|
import { pagesSearchGroup } from "../page/pages-search-group";
|
||||||
|
import { preferencesGroup } from "../preferences/groups";
|
||||||
|
import { userGroupMode } from "../user-group";
|
||||||
|
|
||||||
export const homeMode = {
|
export const homeMode = {
|
||||||
character: undefined,
|
mode: "search",
|
||||||
modeKey: "home",
|
character: "/",
|
||||||
groups: [preferencesGroup, homeSearchEngineGroup, contextSpecificSearchGroups],
|
label: (t) => t("search.modePicker.search.label"),
|
||||||
|
placeholder: (t) => t("search.modePicker.search.placeholder"),
|
||||||
|
useGroups() {
|
||||||
|
const appGroups = appIntegrationBoardMode.useGroups().filter((group) => group !== contextSpecificAppsSearchGroup);
|
||||||
|
const directoryGroups = userGroupMode.useGroups();
|
||||||
|
|
||||||
|
return [
|
||||||
|
contextSpecificSearchGroups,
|
||||||
|
pagesSearchGroup,
|
||||||
|
contextSpecificActionsSearchGroups,
|
||||||
|
globalCommandGroup,
|
||||||
|
preferencesGroup,
|
||||||
|
...appGroups,
|
||||||
|
...directoryGroups,
|
||||||
|
homeSearchEngineGroup,
|
||||||
|
contextSpecificFallbackSearchGroup,
|
||||||
|
mediaFallbackGroup,
|
||||||
|
];
|
||||||
|
},
|
||||||
} satisfies SearchMode;
|
} satisfies SearchMode;
|
||||||
@@ -1,17 +1,19 @@
|
|||||||
import { appIntegrationBoardMode } from "./app-integration-board";
|
import { appIntegrationBoardMode } from "./app-integration-board";
|
||||||
|
import { assistantMode } from "./assistant";
|
||||||
import { commandMode } from "./command";
|
import { commandMode } from "./command";
|
||||||
import { externalMode } from "./external";
|
import { externalMode } from "./external";
|
||||||
import { homeMode } from "./home";
|
import { homeMode } from "./home";
|
||||||
import { mediaMode } from "./media";
|
import { mediaMode } from "./media";
|
||||||
import { pageMode } from "./page";
|
import { preferencesMode } from "./preferences";
|
||||||
import { userGroupMode } from "./user-group";
|
import { userGroupMode } from "./user-group";
|
||||||
|
|
||||||
export const searchModes = [
|
export const searchModes = [
|
||||||
userGroupMode,
|
|
||||||
appIntegrationBoardMode,
|
|
||||||
externalMode,
|
|
||||||
commandMode,
|
|
||||||
pageMode,
|
|
||||||
mediaMode,
|
|
||||||
homeMode,
|
homeMode,
|
||||||
|
appIntegrationBoardMode,
|
||||||
|
commandMode,
|
||||||
|
preferencesMode,
|
||||||
|
assistantMode,
|
||||||
|
externalMode,
|
||||||
|
mediaMode,
|
||||||
|
userGroupMode,
|
||||||
] as const;
|
] as const;
|
||||||
@@ -2,7 +2,9 @@ import type { SearchMode } from "../../lib/mode";
|
|||||||
import { mediaRequestSearchGroup } from "./media-request-search-group";
|
import { mediaRequestSearchGroup } from "./media-request-search-group";
|
||||||
|
|
||||||
export const mediaMode = {
|
export const mediaMode = {
|
||||||
modeKey: "media",
|
mode: "media",
|
||||||
character: undefined,
|
character: undefined,
|
||||||
|
label: (t) => t("search.modePicker.media.label"),
|
||||||
|
placeholder: (t) => t("search.modePicker.media.placeholder"),
|
||||||
groups: [mediaRequestSearchGroup],
|
groups: [mediaRequestSearchGroup],
|
||||||
} satisfies SearchMode;
|
} satisfies SearchMode;
|
||||||
@@ -0,0 +1,87 @@
|
|||||||
|
import { Group, Stack, Text } from "@mantine/core";
|
||||||
|
import { IconMovie } from "@tabler/icons-react";
|
||||||
|
|
||||||
|
import { clientApi } from "@homarr/api/client";
|
||||||
|
import { useSession } from "@homarr/auth/client";
|
||||||
|
import { useI18n } from "@homarr/translation/client";
|
||||||
|
|
||||||
|
import { createGroup } from "../../lib/group";
|
||||||
|
import { useRemoteQuery } from "../../lib/remote-query";
|
||||||
|
|
||||||
|
type MediaFallbackOption = {
|
||||||
|
key: string;
|
||||||
|
label: string;
|
||||||
|
description: string;
|
||||||
|
query: string;
|
||||||
|
unavailable?: boolean;
|
||||||
|
};
|
||||||
|
|
||||||
|
/** Discovers whether media search is usable, but intentionally never performs a media search. */
|
||||||
|
export const mediaFallbackGroup = createGroup<MediaFallbackOption>({
|
||||||
|
keyPath: "key",
|
||||||
|
title: (t) => t("search.modePicker.continueWith"),
|
||||||
|
source: { kind: "fallback" },
|
||||||
|
Component(option) {
|
||||||
|
return (
|
||||||
|
<Group w="100%" wrap="nowrap" align="center" px="md" py="xs" opacity={option.unavailable ? 0.5 : 1}>
|
||||||
|
<IconMovie stroke={1.5} />
|
||||||
|
<Stack gap={0}>
|
||||||
|
<Text>{option.label}</Text>
|
||||||
|
<Text size="xs" c="dimmed">
|
||||||
|
{option.description}
|
||||||
|
</Text>
|
||||||
|
</Stack>
|
||||||
|
</Group>
|
||||||
|
);
|
||||||
|
},
|
||||||
|
useInteraction(option) {
|
||||||
|
if (option.unavailable) return { type: "none" };
|
||||||
|
return { type: "mode", mode: "media", query: option.query };
|
||||||
|
},
|
||||||
|
useQueryOptions(query) {
|
||||||
|
const t = useI18n();
|
||||||
|
const remoteQuery = useRemoteQuery(query, "media");
|
||||||
|
const { data: session, status } = useSession();
|
||||||
|
const canDiscoverTargets = remoteQuery.enabled && Boolean(session?.user);
|
||||||
|
const targets = clientApi.integration.mediaRequestSearchTargets.useQuery(undefined, {
|
||||||
|
enabled: canDiscoverTargets,
|
||||||
|
staleTime: 60_000,
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!remoteQuery.enabled) return { data: [], isLoading: false, isError: false };
|
||||||
|
if (status === "loading") return { data: [], isLoading: true, isError: false };
|
||||||
|
if (!session?.user) {
|
||||||
|
return {
|
||||||
|
data: [
|
||||||
|
{
|
||||||
|
key: "media-fallback",
|
||||||
|
label: t("search.modePicker.media.fallback", { query: remoteQuery.query }),
|
||||||
|
description: t("search.mode.media.action.search.disabled.signInRequired"),
|
||||||
|
query: remoteQuery.query,
|
||||||
|
unavailable: true,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
isLoading: false,
|
||||||
|
isError: false,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
if (!targets.data) return { data: [], isLoading: targets.isLoading, isError: targets.isError };
|
||||||
|
|
||||||
|
const unavailable = targets.data.length === 0;
|
||||||
|
return {
|
||||||
|
isLoading: targets.isLoading,
|
||||||
|
isError: targets.isError,
|
||||||
|
data: [
|
||||||
|
{
|
||||||
|
key: "media-fallback",
|
||||||
|
label: t("search.modePicker.media.fallback", { query: remoteQuery.query }),
|
||||||
|
description: unavailable
|
||||||
|
? t("search.mode.media.action.search.disabled.noIntegration")
|
||||||
|
: t("search.mode.media.action.search.description"),
|
||||||
|
query: remoteQuery.query,
|
||||||
|
unavailable,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
},
|
||||||
|
});
|
||||||
@@ -1,17 +1,17 @@
|
|||||||
import { Badge, Group, Image, Stack, Text } from "@mantine/core";
|
import { Badge, Group, Image, Stack, Text } from "@mantine/core";
|
||||||
import { useDebouncedValue } from "@mantine/hooks";
|
|
||||||
import { IconMovie, IconSearch } from "@tabler/icons-react";
|
import { IconMovie, IconSearch } from "@tabler/icons-react";
|
||||||
import { keepPreviousData } from "@tanstack/react-query";
|
|
||||||
import { useAtomValue } from "jotai";
|
import { useAtomValue } from "jotai";
|
||||||
|
|
||||||
import type { RouterOutputs } from "@homarr/api";
|
import type { RouterOutputs } from "@homarr/api";
|
||||||
import { clientApi } from "@homarr/api/client";
|
import { clientApi } from "@homarr/api/client";
|
||||||
|
import { useSession } from "@homarr/auth/client";
|
||||||
import { getIntegrationName } from "@homarr/definitions";
|
import { getIntegrationName } from "@homarr/definitions";
|
||||||
import type { MediaAvailability } from "@homarr/integrations/types";
|
import type { MediaAvailability } from "@homarr/integrations/types";
|
||||||
import { mediaAvailabilityConfiguration } from "@homarr/integrations/types";
|
import { mediaAvailabilityConfiguration } from "@homarr/integrations/types";
|
||||||
import { useI18n } from "@homarr/translation/client";
|
import { useI18n } from "@homarr/translation/client";
|
||||||
|
|
||||||
import { createGroup } from "../../lib/group";
|
import { createGroup } from "../../lib/group";
|
||||||
|
import { useRemoteQuery } from "../../lib/remote-query";
|
||||||
import { mediaRequestSearchScopeAtom } from "../../spotlight-store";
|
import { mediaRequestSearchScopeAtom } from "../../spotlight-store";
|
||||||
import { useMediaRequestSearchInteraction } from "../external/search-engines-search-group";
|
import { useMediaRequestSearchInteraction } from "../external/search-engines-search-group";
|
||||||
|
|
||||||
@@ -23,7 +23,14 @@ type MediaRequestSearchResult = RouterOutputs["integration"]["searchMediaRequest
|
|||||||
type MediaRequestSearchOption =
|
type MediaRequestSearchOption =
|
||||||
| {
|
| {
|
||||||
key: string;
|
key: string;
|
||||||
kind: "disabled" | "hint";
|
kind: "disabled";
|
||||||
|
label: string;
|
||||||
|
description: string;
|
||||||
|
unavailable: true;
|
||||||
|
}
|
||||||
|
| {
|
||||||
|
key: string;
|
||||||
|
kind: "hint";
|
||||||
label: string;
|
label: string;
|
||||||
description: string;
|
description: string;
|
||||||
}
|
}
|
||||||
@@ -36,6 +43,7 @@ type MediaRequestSearchOption =
|
|||||||
export const mediaRequestSearchGroup = createGroup<MediaRequestSearchOption>({
|
export const mediaRequestSearchGroup = createGroup<MediaRequestSearchOption>({
|
||||||
keyPath: "key",
|
keyPath: "key",
|
||||||
title: (t) => t("search.mode.media.group.title"),
|
title: (t) => t("search.mode.media.group.title"),
|
||||||
|
source: { kind: "remote", source: "media" },
|
||||||
Component(option) {
|
Component(option) {
|
||||||
const tMedia = useI18n("search.mode.media");
|
const tMedia = useI18n("search.mode.media");
|
||||||
|
|
||||||
@@ -66,7 +74,7 @@ export const mediaRequestSearchGroup = createGroup<MediaRequestSearchOption>({
|
|||||||
return (
|
return (
|
||||||
<Group w="100%" wrap="nowrap" align="center" px="md" py="xs">
|
<Group w="100%" wrap="nowrap" align="center" px="md" py="xs">
|
||||||
{result.image ? (
|
{result.image ? (
|
||||||
<Image src={result.image} w={35} h={50} fit="cover" radius="md" />
|
<Image src={result.image} alt="" w={35} h={50} fit="cover" radius="md" />
|
||||||
) : (
|
) : (
|
||||||
<IconSearch stroke={1.5} size={35} />
|
<IconSearch stroke={1.5} size={35} />
|
||||||
)}
|
)}
|
||||||
@@ -98,21 +106,24 @@ export const mediaRequestSearchGroup = createGroup<MediaRequestSearchOption>({
|
|||||||
useQueryOptions(query) {
|
useQueryOptions(query) {
|
||||||
const tMedia = useI18n("search.mode.media");
|
const tMedia = useI18n("search.mode.media");
|
||||||
const scope = useAtomValue(mediaRequestSearchScopeAtom);
|
const scope = useAtomValue(mediaRequestSearchScopeAtom);
|
||||||
const [debouncedQuery] = useDebouncedValue(query.trim(), 150);
|
const remoteQuery = useRemoteQuery(query, "media");
|
||||||
const targetsQuery = clientApi.integration.mediaRequestSearchTargets.useQuery();
|
const { data: session, status } = useSession();
|
||||||
|
const targetsQuery = clientApi.integration.mediaRequestSearchTargets.useQuery(undefined, {
|
||||||
|
enabled: status !== "loading" && Boolean(session?.user),
|
||||||
|
staleTime: 60_000,
|
||||||
|
});
|
||||||
|
|
||||||
const scopedTargets = (targetsQuery.data ?? []).filter((target) =>
|
const scopedTargets = (targetsQuery.data ?? []).filter((target) =>
|
||||||
scope.integrationIds ? scope.integrationIds.includes(target.id) : true,
|
scope.integrationIds ? scope.integrationIds.includes(target.id) : true,
|
||||||
);
|
);
|
||||||
const hasScopedTargets = scopedTargets.length > 0;
|
const hasScopedTargets = scopedTargets.length > 0;
|
||||||
const shouldSearch = debouncedQuery.length > 0 && hasScopedTargets;
|
const shouldSearch = remoteQuery.enabled && hasScopedTargets;
|
||||||
const integrationIds = scope.integrationIds ? scopedTargets.map((target) => target.id) : undefined;
|
const integrationIds = scope.integrationIds ? scopedTargets.map((target) => target.id) : undefined;
|
||||||
|
|
||||||
const resultsQuery = clientApi.integration.searchMediaRequests.useQuery(
|
const resultsQuery = clientApi.integration.searchMediaRequests.useQuery(
|
||||||
{ query: debouncedQuery, integrationIds },
|
{ query: remoteQuery.query, integrationIds },
|
||||||
{
|
{
|
||||||
enabled: shouldSearch,
|
enabled: shouldSearch,
|
||||||
placeholderData: keepPreviousData,
|
|
||||||
select: (data) => data.slice(0, 10),
|
select: (data) => data.slice(0, 10),
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
@@ -120,6 +131,26 @@ export const mediaRequestSearchGroup = createGroup<MediaRequestSearchOption>({
|
|||||||
const isLoading = targetsQuery.isLoading || (shouldSearch && resultsQuery.isLoading);
|
const isLoading = targetsQuery.isLoading || (shouldSearch && resultsQuery.isLoading);
|
||||||
const isError = targetsQuery.isError || (shouldSearch && resultsQuery.isError);
|
const isError = targetsQuery.isError || (shouldSearch && resultsQuery.isError);
|
||||||
|
|
||||||
|
if (status === "loading") {
|
||||||
|
return { data: [], isLoading: true, isError: false };
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!session?.user) {
|
||||||
|
return {
|
||||||
|
data: [
|
||||||
|
{
|
||||||
|
key: "disabled",
|
||||||
|
kind: "disabled",
|
||||||
|
label: tMedia("action.search.label"),
|
||||||
|
description: tMedia("action.search.disabled.signInRequired"),
|
||||||
|
unavailable: true,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
isLoading: false,
|
||||||
|
isError: false,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
if (!targetsQuery.data) {
|
if (!targetsQuery.data) {
|
||||||
return {
|
return {
|
||||||
isLoading,
|
isLoading,
|
||||||
@@ -140,12 +171,13 @@ export const mediaRequestSearchGroup = createGroup<MediaRequestSearchOption>({
|
|||||||
description: scope.integrationIds
|
description: scope.integrationIds
|
||||||
? tMedia("action.search.disabled.scoped")
|
? tMedia("action.search.disabled.scoped")
|
||||||
: tMedia("action.search.disabled.noIntegration"),
|
: tMedia("action.search.disabled.noIntegration"),
|
||||||
|
unavailable: true,
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
if (debouncedQuery.length === 0) {
|
if (!remoteQuery.enabled) {
|
||||||
return {
|
return {
|
||||||
isLoading,
|
isLoading,
|
||||||
isError,
|
isError,
|
||||||
|
|||||||
@@ -1,8 +0,0 @@
|
|||||||
import type { SearchMode } from "../../lib/mode";
|
|
||||||
import { pagesSearchGroup } from "./pages-search-group";
|
|
||||||
|
|
||||||
export const pageMode = {
|
|
||||||
modeKey: "page",
|
|
||||||
character: "/",
|
|
||||||
groups: [pagesSearchGroup],
|
|
||||||
} satisfies SearchMode;
|
|
||||||
@@ -30,6 +30,7 @@ export const pagesSearchGroup = createGroup<{
|
|||||||
}>({
|
}>({
|
||||||
keyPath: "path",
|
keyPath: "path",
|
||||||
title: (t) => t("search.mode.page.group.page.title"),
|
title: (t) => t("search.mode.page.group.page.title"),
|
||||||
|
source: { kind: "local" },
|
||||||
Component: ({ name, icon: Icon }) => (
|
Component: ({ name, icon: Icon }) => (
|
||||||
<Group px="md" py="sm">
|
<Group px="md" py="sm">
|
||||||
<Icon stroke={1.5} />
|
<Icon stroke={1.5} />
|
||||||
|
|||||||
@@ -1,90 +1,22 @@
|
|||||||
import { Group, Text } from "@mantine/core";
|
|
||||||
import { IconSettings } from "@tabler/icons-react";
|
|
||||||
|
|
||||||
import { useSession } from "@homarr/auth/client";
|
|
||||||
import { colorSchemes } from "@homarr/definitions";
|
|
||||||
import type { UserPreferenceKey } from "@homarr/settings";
|
|
||||||
import { visiblePreferenceDefinitions } from "@homarr/settings";
|
|
||||||
import { useI18n } from "@homarr/translation/client";
|
|
||||||
|
|
||||||
import { createGroup } from "../../lib/group";
|
import { createGroup } from "../../lib/group";
|
||||||
import {
|
import type { ChildrenAction } from "../../lib/children";
|
||||||
preferenceChildrenOptionsByKey,
|
import { useSettingsActions } from "../command/children/preferences/settings-children";
|
||||||
preferenceIcons,
|
|
||||||
userFieldPreferenceLabels,
|
|
||||||
} from "../../preferences/preference-registry";
|
|
||||||
import { settingsChildrenOptions } from "../command/children/preferences/settings-children";
|
|
||||||
|
|
||||||
type PreferencesGroupOption =
|
type PreferenceAction = ChildrenAction<Record<string, unknown>>;
|
||||||
| { key: "settings"; preferenceKey: null }
|
|
||||||
| { key: UserPreferenceKey; preferenceKey: UserPreferenceKey };
|
|
||||||
|
|
||||||
const settingsOption: PreferencesGroupOption = { key: "settings", preferenceKey: null };
|
/** Preferences are normal command-menu actions, not a gateway into another hidden list. */
|
||||||
|
export const preferencesGroup = createGroup<PreferenceAction>({
|
||||||
export const preferencesGroup = createGroup<PreferencesGroupOption>({
|
|
||||||
keyPath: "key",
|
keyPath: "key",
|
||||||
title: (t) => t("search.mode.command.group.preferences.title"),
|
title: (t) => t("search.mode.command.group.preferences.title"),
|
||||||
|
source: { kind: "local" },
|
||||||
useOptions(query) {
|
useOptions(query) {
|
||||||
const t = useI18n();
|
return useSettingsActions({}, query);
|
||||||
const tColorScheme = useI18n("common.colorScheme.options");
|
|
||||||
const tUserField = useI18n("user.field");
|
|
||||||
const { data: session } = useSession();
|
|
||||||
const definitions = visiblePreferenceDefinitions(Boolean(session?.user));
|
|
||||||
const q = query.trim().toLowerCase();
|
|
||||||
|
|
||||||
if (q.length === 0) return [settingsOption];
|
|
||||||
|
|
||||||
const matching = definitions.flatMap((def): PreferencesGroupOption[] => {
|
|
||||||
if (!preferenceChildrenOptionsByKey[def.key]) return [];
|
|
||||||
const userFieldKey = userFieldPreferenceLabels[def.key];
|
|
||||||
const label = userFieldKey
|
|
||||||
? tUserField(`${userFieldKey}.label` as never)
|
|
||||||
: t(`search.mode.command.group.preferences.option.${def.key}.label` as never);
|
|
||||||
const searchValues = [
|
|
||||||
label,
|
|
||||||
...def.aliases,
|
|
||||||
...(def.key === "colorScheme" ? colorSchemes.map((s) => tColorScheme(s)) : []),
|
|
||||||
];
|
|
||||||
if (!searchValues.some((v) => v.toLowerCase().includes(q))) return [];
|
|
||||||
return [{ key: def.key, preferenceKey: def.key }];
|
|
||||||
});
|
|
||||||
|
|
||||||
if (matching.length > 0) return matching;
|
|
||||||
|
|
||||||
const allSearchValues = [
|
|
||||||
t("search.mode.command.group.preferences.title"),
|
|
||||||
...definitions.flatMap((d) => d.aliases),
|
|
||||||
];
|
|
||||||
return allSearchValues.some((v) => v.toLowerCase().includes(q)) ? [settingsOption] : [];
|
|
||||||
},
|
},
|
||||||
Component: (option) => {
|
Component(option) {
|
||||||
const t = useI18n("search.mode.command.group.preferences");
|
return <option.Component />;
|
||||||
const tOption = useI18n("search.mode.command.group.preferences.option");
|
},
|
||||||
const tUserField = useI18n("user.field");
|
useInteraction(option, query) {
|
||||||
const Icon = option.preferenceKey
|
return option.useInteraction({}, query);
|
||||||
? preferenceIcons[option.preferenceKey as keyof typeof preferenceIcons]
|
|
||||||
: IconSettings;
|
|
||||||
let label = t("title");
|
|
||||||
if (option.preferenceKey) {
|
|
||||||
const userFieldKey = userFieldPreferenceLabels[option.preferenceKey];
|
|
||||||
label = userFieldKey
|
|
||||||
? tUserField(`${userFieldKey}.label` as never)
|
|
||||||
: tOption(`${option.preferenceKey}.label` as never);
|
|
||||||
}
|
|
||||||
|
|
||||||
return (
|
|
||||||
<Group px="md" py="sm" wrap="nowrap" gap="sm">
|
|
||||||
<Icon stroke={1.5} />
|
|
||||||
<Text>{label}</Text>
|
|
||||||
</Group>
|
|
||||||
);
|
|
||||||
},
|
},
|
||||||
filter: () => true,
|
filter: () => true,
|
||||||
useInteraction: (option) => ({
|
|
||||||
type: "children",
|
|
||||||
...(option.preferenceKey
|
|
||||||
? (preferenceChildrenOptionsByKey[option.preferenceKey as keyof typeof preferenceChildrenOptionsByKey]?.({}) ??
|
|
||||||
settingsChildrenOptions({}))
|
|
||||||
: settingsChildrenOptions({})),
|
|
||||||
}),
|
|
||||||
});
|
});
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
import type { SearchMode } from "../../lib/mode";
|
||||||
|
import { preferencesGroup } from "./groups";
|
||||||
|
|
||||||
|
export const preferencesMode = {
|
||||||
|
mode: "preferences",
|
||||||
|
character: "?",
|
||||||
|
label: (t) => t("search.modePicker.preferences.label"),
|
||||||
|
placeholder: (t) => t("search.modePicker.preferences.placeholder"),
|
||||||
|
groups: [preferencesGroup],
|
||||||
|
} satisfies SearchMode;
|
||||||
@@ -7,6 +7,7 @@ import { useI18n } from "@homarr/translation/client";
|
|||||||
import { createChildrenOptions } from "../../lib/children";
|
import { createChildrenOptions } from "../../lib/children";
|
||||||
import { createGroup } from "../../lib/group";
|
import { createGroup } from "../../lib/group";
|
||||||
import { interaction } from "../../lib/interaction";
|
import { interaction } from "../../lib/interaction";
|
||||||
|
import { useRemoteQuery } from "../../lib/remote-query";
|
||||||
|
|
||||||
// This has to be type so it can be interpreted as Record<string, unknown>.
|
// This has to be type so it can be interpreted as Record<string, unknown>.
|
||||||
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
|
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
|
||||||
@@ -71,6 +72,7 @@ const groupChildrenOptions = createChildrenOptions<Group>({
|
|||||||
export const groupsSearchGroup = createGroup<Group>({
|
export const groupsSearchGroup = createGroup<Group>({
|
||||||
keyPath: "id",
|
keyPath: "id",
|
||||||
title: (t) => t("common.entity.groups"),
|
title: (t) => t("common.entity.groups"),
|
||||||
|
source: { kind: "remote", source: "groups" },
|
||||||
Component: ({ name }) => (
|
Component: ({ name }) => (
|
||||||
<Group px="md" py="sm">
|
<Group px="md" py="sm">
|
||||||
<Text>{name}</Text>
|
<Text>{name}</Text>
|
||||||
@@ -78,6 +80,7 @@ export const groupsSearchGroup = createGroup<Group>({
|
|||||||
),
|
),
|
||||||
useInteraction: interaction.children(groupChildrenOptions),
|
useInteraction: interaction.children(groupChildrenOptions),
|
||||||
useQueryOptions(query) {
|
useQueryOptions(query) {
|
||||||
return clientApi.group.search.useQuery({ query, limit: 5 });
|
const remoteQuery = useRemoteQuery(query, "groups");
|
||||||
|
return clientApi.group.search.useQuery({ query: remoteQuery.query, limit: 8 }, { enabled: remoteQuery.enabled });
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
@@ -1,9 +1,17 @@
|
|||||||
|
import { useSession } from "@homarr/auth/client";
|
||||||
|
|
||||||
import type { SearchMode } from "../../lib/mode";
|
import type { SearchMode } from "../../lib/mode";
|
||||||
import { groupsSearchGroup } from "./groups-search-group";
|
import { groupsSearchGroup } from "./groups-search-group";
|
||||||
import { usersSearchGroup } from "./users-search-group";
|
import { usersSearchGroup } from "./users-search-group";
|
||||||
|
|
||||||
export const userGroupMode = {
|
export const userGroupMode = {
|
||||||
modeKey: "userGroup",
|
mode: "userGroup",
|
||||||
character: "@",
|
character: "@",
|
||||||
groups: [usersSearchGroup, groupsSearchGroup],
|
label: (t) => t("search.modePicker.userGroup.label"),
|
||||||
|
placeholder: (t) => t("search.modePicker.userGroup.placeholder"),
|
||||||
|
useGroups() {
|
||||||
|
const { data: session } = useSession();
|
||||||
|
if (!session?.user.permissions.includes("admin")) return [];
|
||||||
|
return [usersSearchGroup, groupsSearchGroup];
|
||||||
|
},
|
||||||
} satisfies SearchMode;
|
} satisfies SearchMode;
|
||||||
@@ -8,6 +8,7 @@ import { UserAvatar } from "@homarr/ui";
|
|||||||
import { createChildrenOptions } from "../../lib/children";
|
import { createChildrenOptions } from "../../lib/children";
|
||||||
import { createGroup } from "../../lib/group";
|
import { createGroup } from "../../lib/group";
|
||||||
import { interaction } from "../../lib/interaction";
|
import { interaction } from "../../lib/interaction";
|
||||||
|
import { useRemoteQuery } from "../../lib/remote-query";
|
||||||
|
|
||||||
// This has to be type so it can be interpreted as Record<string, unknown>.
|
// This has to be type so it can be interpreted as Record<string, unknown>.
|
||||||
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
|
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
|
||||||
@@ -49,6 +50,7 @@ const userChildrenOptions = createChildrenOptions<User>({
|
|||||||
export const usersSearchGroup = createGroup<User>({
|
export const usersSearchGroup = createGroup<User>({
|
||||||
keyPath: "id",
|
keyPath: "id",
|
||||||
title: (t) => t("common.entity.users"),
|
title: (t) => t("common.entity.users"),
|
||||||
|
source: { kind: "remote", source: "users" },
|
||||||
Component: (user) => (
|
Component: (user) => (
|
||||||
<Group px="md" py="sm">
|
<Group px="md" py="sm">
|
||||||
<UserAvatar user={user} size="sm" />
|
<UserAvatar user={user} size="sm" />
|
||||||
@@ -57,6 +59,7 @@ export const usersSearchGroup = createGroup<User>({
|
|||||||
),
|
),
|
||||||
useInteraction: interaction.children(userChildrenOptions),
|
useInteraction: interaction.children(userChildrenOptions),
|
||||||
useQueryOptions(query) {
|
useQueryOptions(query) {
|
||||||
return clientApi.user.search.useQuery({ query, limit: 5 });
|
const remoteQuery = useRemoteQuery(query, "users");
|
||||||
|
return clientApi.user.search.useQuery({ query: remoteQuery.query, limit: 8 }, { enabled: remoteQuery.enabled });
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
@@ -20,19 +20,22 @@ describe("lazy Spotlight open bridge", () => {
|
|||||||
const listener = vi.fn();
|
const listener = vi.fn();
|
||||||
window.addEventListener(spotlightOpenEvent, listener);
|
window.addEventListener(spotlightOpenEvent, listener);
|
||||||
|
|
||||||
openSpotlight();
|
openSpotlight({ mode: "apps", query: "rada" });
|
||||||
|
|
||||||
expect(listener).toHaveBeenCalledOnce();
|
expect(listener).toHaveBeenCalledOnce();
|
||||||
expect(consumePendingSpotlightOpen()).toBe(true);
|
expect(listener.mock.calls[0]?.[0]).toMatchObject({
|
||||||
expect(consumePendingSpotlightOpen()).toBe(false);
|
detail: { mode: "apps", query: "rada" },
|
||||||
|
});
|
||||||
|
expect(consumePendingSpotlightOpen()).toEqual({ mode: "apps", query: "rada" });
|
||||||
|
expect(consumePendingSpotlightOpen()).toBeNull();
|
||||||
window.removeEventListener(spotlightOpenEvent, listener);
|
window.removeEventListener(spotlightOpenEvent, listener);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("lets a listener installed after the request discover the pending open", () => {
|
it("defaults to search and lets a listener installed after the request discover the pending intent", () => {
|
||||||
openSpotlight();
|
openSpotlight();
|
||||||
|
|
||||||
expect(hasPendingSpotlightOpen()).toBe(true);
|
expect(hasPendingSpotlightOpen()).toBe(true);
|
||||||
expect(consumePendingSpotlightOpen()).toBe(true);
|
expect(consumePendingSpotlightOpen()).toEqual({ mode: "search" });
|
||||||
expect(hasPendingSpotlightOpen()).toBe(false);
|
expect(hasPendingSpotlightOpen()).toBe(false);
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -45,8 +48,11 @@ describe("lazy Spotlight open bridge", () => {
|
|||||||
openMediaRequestSearch({ integrationIds: ["integration-a"], query: "movie" });
|
openMediaRequestSearch({ integrationIds: ["integration-a"], query: "movie" });
|
||||||
|
|
||||||
expect(openListener).toHaveBeenCalledOnce();
|
expect(openListener).toHaveBeenCalledOnce();
|
||||||
|
expect(openListener.mock.calls[0]?.[0]).toMatchObject({
|
||||||
|
detail: { mode: "media", query: "movie" },
|
||||||
|
});
|
||||||
expect(mediaListener).toHaveBeenCalledOnce();
|
expect(mediaListener).toHaveBeenCalledOnce();
|
||||||
expect(consumePendingSpotlightOpen()).toBe(true);
|
expect(consumePendingSpotlightOpen()).toEqual({ mode: "media", query: "movie" });
|
||||||
expect(consumePendingMediaRequestSearch()).toEqual({ integrationIds: ["integration-a"], query: "movie" });
|
expect(consumePendingMediaRequestSearch()).toEqual({ integrationIds: ["integration-a"], query: "movie" });
|
||||||
window.removeEventListener(spotlightOpenEvent, openListener);
|
window.removeEventListener(spotlightOpenEvent, openListener);
|
||||||
window.removeEventListener(mediaRequestSearchEvent, mediaListener);
|
window.removeEventListener(mediaRequestSearchEvent, mediaListener);
|
||||||
|
|||||||
@@ -3,30 +3,58 @@
|
|||||||
export const spotlightOpenEvent = "homarr:spotlight:open";
|
export const spotlightOpenEvent = "homarr:spotlight:open";
|
||||||
export const mediaRequestSearchEvent = "homarr:spotlight:media-request-search";
|
export const mediaRequestSearchEvent = "homarr:spotlight:media-request-search";
|
||||||
|
|
||||||
|
export type SpotlightMode =
|
||||||
|
| "search"
|
||||||
|
| "apps"
|
||||||
|
| "command"
|
||||||
|
| "preferences"
|
||||||
|
| "assistant"
|
||||||
|
| "external"
|
||||||
|
| "media"
|
||||||
|
| "userGroup";
|
||||||
|
|
||||||
|
export interface OpenSpotlightOptions {
|
||||||
|
mode?: SpotlightMode;
|
||||||
|
query?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface SpotlightOpenIntent {
|
||||||
|
mode: SpotlightMode;
|
||||||
|
query?: string;
|
||||||
|
}
|
||||||
|
|
||||||
export interface OpenMediaRequestSearchOptions {
|
export interface OpenMediaRequestSearchOptions {
|
||||||
integrationIds?: string[];
|
integrationIds?: string[];
|
||||||
query?: string;
|
query?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
let pendingMediaRequestSearch: OpenMediaRequestSearchOptions | null = null;
|
let pendingMediaRequestSearch: OpenMediaRequestSearchOptions | null = null;
|
||||||
let pendingSpotlightOpen = false;
|
let pendingSpotlightOpen: SpotlightOpenIntent | null = null;
|
||||||
|
|
||||||
const requestSpotlightMount = () => {
|
const requestSpotlightMount = (intent: SpotlightOpenIntent) => {
|
||||||
if (typeof window !== "undefined") window.dispatchEvent(new Event(spotlightOpenEvent));
|
if (typeof window !== "undefined") {
|
||||||
|
window.dispatchEvent(new CustomEvent<SpotlightOpenIntent>(spotlightOpenEvent, { detail: intent }));
|
||||||
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
export const openSpotlight = () => {
|
export const openSpotlight = (options: OpenSpotlightOptions = {}) => {
|
||||||
pendingSpotlightOpen = true;
|
const intent: SpotlightOpenIntent = {
|
||||||
requestSpotlightMount();
|
mode: options.mode ?? "search",
|
||||||
|
};
|
||||||
|
if (options.query !== undefined) intent.query = options.query;
|
||||||
|
|
||||||
|
if (intent.mode !== "media") pendingMediaRequestSearch = null;
|
||||||
|
pendingSpotlightOpen = intent;
|
||||||
|
requestSpotlightMount(intent);
|
||||||
};
|
};
|
||||||
|
|
||||||
export const consumePendingSpotlightOpen = () => {
|
export const consumePendingSpotlightOpen = () => {
|
||||||
const pending = pendingSpotlightOpen;
|
const pending = pendingSpotlightOpen;
|
||||||
pendingSpotlightOpen = false;
|
pendingSpotlightOpen = null;
|
||||||
return pending;
|
return pending;
|
||||||
};
|
};
|
||||||
|
|
||||||
export const hasPendingSpotlightOpen = () => pendingSpotlightOpen;
|
export const hasPendingSpotlightOpen = () => pendingSpotlightOpen !== null;
|
||||||
|
|
||||||
export const consumePendingMediaRequestSearch = () => {
|
export const consumePendingMediaRequestSearch = () => {
|
||||||
const pending = pendingMediaRequestSearch;
|
const pending = pendingMediaRequestSearch;
|
||||||
@@ -36,7 +64,7 @@ export const consumePendingMediaRequestSearch = () => {
|
|||||||
|
|
||||||
export const openMediaRequestSearch = (options: OpenMediaRequestSearchOptions = {}) => {
|
export const openMediaRequestSearch = (options: OpenMediaRequestSearchOptions = {}) => {
|
||||||
pendingMediaRequestSearch = options;
|
pendingMediaRequestSearch = options;
|
||||||
openSpotlight();
|
openSpotlight({ mode: "media", query: options.query });
|
||||||
|
|
||||||
if (typeof window !== "undefined") {
|
if (typeof window !== "undefined") {
|
||||||
window.dispatchEvent(new CustomEvent<OpenMediaRequestSearchOptions>(mediaRequestSearchEvent, { detail: options }));
|
window.dispatchEvent(new CustomEvent<OpenMediaRequestSearchOptions>(mediaRequestSearchEvent, { detail: options }));
|
||||||
|
|||||||
@@ -6314,6 +6314,9 @@
|
|||||||
"toggleColorScheme": "Toggle light/dark mode",
|
"toggleColorScheme": "Toggle light/dark mode",
|
||||||
"saveNotebook": "Save notebook (only inside notebook widget)",
|
"saveNotebook": "Save notebook (only inside notebook widget)",
|
||||||
"openSpotlight": "Open search",
|
"openSpotlight": "Open search",
|
||||||
|
"openSpotlightApps": "Open app search",
|
||||||
|
"openSpotlightAssistant": "Open Assistant mode",
|
||||||
|
"openSpotlightPreferences": "Open preferences mode",
|
||||||
"openAssistant": "Open Homarr Assistant"
|
"openAssistant": "Open Homarr Assistant"
|
||||||
},
|
},
|
||||||
"note": "Tip: Mod refers to both Ctrl key and ⌘ key on macOS"
|
"note": "Tip: Mod refers to both Ctrl key and ⌘ key on macOS"
|
||||||
@@ -6779,6 +6782,51 @@
|
|||||||
"search": {
|
"search": {
|
||||||
"placeholder": "Search for anything",
|
"placeholder": "Search for anything",
|
||||||
"nothingFound": "Nothing found",
|
"nothingFound": "Nothing found",
|
||||||
|
"modePicker": {
|
||||||
|
"search": {
|
||||||
|
"label": "Search",
|
||||||
|
"placeholder": "Search apps, boards, pages, commands, and preferences"
|
||||||
|
},
|
||||||
|
"apps": {
|
||||||
|
"label": "Apps",
|
||||||
|
"placeholder": "Search apps, boards, and integrations"
|
||||||
|
},
|
||||||
|
"command": {
|
||||||
|
"label": "Commands",
|
||||||
|
"placeholder": "Search actions and commands"
|
||||||
|
},
|
||||||
|
"preferences": {
|
||||||
|
"label": "Preferences",
|
||||||
|
"placeholder": "Search and change preferences"
|
||||||
|
},
|
||||||
|
"assistant": {
|
||||||
|
"label": "Assistant",
|
||||||
|
"placeholder": "Ask Homarr Assistant"
|
||||||
|
},
|
||||||
|
"external": {
|
||||||
|
"label": "Web",
|
||||||
|
"placeholder": "Search with an external search engine"
|
||||||
|
},
|
||||||
|
"media": {
|
||||||
|
"label": "Media",
|
||||||
|
"placeholder": "Search for a movie or show",
|
||||||
|
"fallback": "Search media for \"{query}\""
|
||||||
|
},
|
||||||
|
"userGroup": {
|
||||||
|
"label": "People",
|
||||||
|
"placeholder": "Search users and groups"
|
||||||
|
},
|
||||||
|
"continueWith": "Continue with",
|
||||||
|
"dialogAriaLabel": "{mode} command menu",
|
||||||
|
"navigationLabel": "Search modes",
|
||||||
|
"modeAriaLabel": "{mode} mode",
|
||||||
|
"resultsAriaLabel": "{mode} results",
|
||||||
|
"footer": {
|
||||||
|
"navigate": "Navigate",
|
||||||
|
"open": "Open",
|
||||||
|
"close": "Close"
|
||||||
|
}
|
||||||
|
},
|
||||||
"error": {
|
"error": {
|
||||||
"fetch": "An error occurred while fetching data"
|
"fetch": "An error occurred while fetching data"
|
||||||
},
|
},
|
||||||
@@ -7000,6 +7048,7 @@
|
|||||||
"description": "Start typing to search your media request integrations",
|
"description": "Start typing to search your media request integrations",
|
||||||
"disabled": {
|
"disabled": {
|
||||||
"noIntegration": "Add an Overseerr, Jellyseerr, or Seerr integration to enable media search.",
|
"noIntegration": "Add an Overseerr, Jellyseerr, or Seerr integration to enable media search.",
|
||||||
|
"signInRequired": "Sign in to search media request integrations.",
|
||||||
"scoped": "This widget does not have an accessible media request integration."
|
"scoped": "This widget does not have an accessible media request integration."
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -7077,9 +7126,10 @@
|
|||||||
"other": {
|
"other": {
|
||||||
"label": "Search with another search engine"
|
"label": "Search with another search engine"
|
||||||
},
|
},
|
||||||
"no-default": {
|
"no-engines": {
|
||||||
"label": "No default search engine",
|
"label": "No search engines configured",
|
||||||
"description": "Set a default search engine in preferences"
|
"descriptionCreate": "Add a search engine to search from the command menu",
|
||||||
|
"descriptionUnavailable": "Ask an administrator to configure a search engine"
|
||||||
},
|
},
|
||||||
"search": {
|
"search": {
|
||||||
"label": "Search for \"{query}\" with {name}"
|
"label": "Search for \"{query}\" with {name}"
|
||||||
|
|||||||
@@ -9,7 +9,6 @@ import combineClasses from "clsx";
|
|||||||
import { clientApi } from "@homarr/api/client";
|
import { clientApi } from "@homarr/api/client";
|
||||||
import { useRequiredBoard } from "@homarr/boards/context";
|
import { useRequiredBoard } from "@homarr/boards/context";
|
||||||
import { useSettings } from "@homarr/settings";
|
import { useSettings } from "@homarr/settings";
|
||||||
import { useRegisterSpotlightContextResults } from "@homarr/spotlight";
|
|
||||||
import { useI18n } from "@homarr/translation/client";
|
import { useI18n } from "@homarr/translation/client";
|
||||||
import { MaskedOrNormalImage } from "@homarr/ui";
|
import { MaskedOrNormalImage } from "@homarr/ui";
|
||||||
|
|
||||||
@@ -29,26 +28,6 @@ export default function AppWidget({ options, isEditMode, height, width }: Widget
|
|||||||
const appQuery = clientApi.app.byId.useQuery({ id: options.appId }, { enabled: Boolean(options.appId) });
|
const appQuery = clientApi.app.byId.useQuery({ id: options.appId }, { enabled: Boolean(options.appId) });
|
||||||
const app = getUsableWidgetQueryData(appQuery);
|
const app = getUsableWidgetQueryData(appQuery);
|
||||||
const href = getSafeAppHref(app?.href);
|
const href = getSafeAppHref(app?.href);
|
||||||
useRegisterSpotlightContextResults(
|
|
||||||
`app-${app?.id ?? options.appId}`,
|
|
||||||
app && href
|
|
||||||
? [
|
|
||||||
{
|
|
||||||
id: app.id,
|
|
||||||
name: app.name,
|
|
||||||
icon: app.iconUrl,
|
|
||||||
interaction() {
|
|
||||||
return {
|
|
||||||
type: "link",
|
|
||||||
href,
|
|
||||||
newTab: options.openInNewTab,
|
|
||||||
};
|
|
||||||
},
|
|
||||||
},
|
|
||||||
]
|
|
||||||
: [],
|
|
||||||
[app, href, options.openInNewTab],
|
|
||||||
);
|
|
||||||
|
|
||||||
if (!options.appId) return <WidgetEmptyState />;
|
if (!options.appId) return <WidgetEmptyState />;
|
||||||
if (isInitialWidgetQueryPending(appQuery)) return <WidgetQueryLoadingState />;
|
if (isInitialWidgetQueryPending(appQuery)) return <WidgetQueryLoadingState />;
|
||||||
|
|||||||
@@ -73,6 +73,7 @@ export default function BookmarksWidget({
|
|||||||
return [
|
return [
|
||||||
{
|
{
|
||||||
id: bookmark.id,
|
id: bookmark.id,
|
||||||
|
dedupeKey: appsById.has(bookmark.id) ? `app:${bookmark.id}` : undefined,
|
||||||
name: bookmark.name,
|
name: bookmark.name,
|
||||||
icon: bookmark.iconUrl ?? IconLink,
|
icon: bookmark.iconUrl ?? IconLink,
|
||||||
interaction() {
|
interaction() {
|
||||||
@@ -148,10 +149,7 @@ export default function BookmarksWidget({
|
|||||||
</Stack>
|
</Stack>
|
||||||
</Center>
|
</Center>
|
||||||
) : (
|
) : (
|
||||||
<ScrollArea
|
<ScrollArea scrollbars={plan.horizontalScroll ? "x" : "y"} style={{ flex: 1, minHeight: 0 }}>
|
||||||
scrollbars={plan.horizontalScroll ? "x" : "y"}
|
|
||||||
style={{ flex: 1, minHeight: 0 }}
|
|
||||||
>
|
|
||||||
<Box miw="100%" mih="100%" pb={2}>
|
<Box miw="100%" mih="100%" pb={2}>
|
||||||
{plan.horizontalScroll ? (
|
{plan.horizontalScroll ? (
|
||||||
<Group gap={options.spacing} wrap="nowrap" mih="100%" align="stretch">
|
<Group gap={options.spacing} wrap="nowrap" mih="100%" align="stretch">
|
||||||
|
|||||||
Reference in new issue
Block a user