mirror of
https://github.com/blakeblackshear/frigate.git
synced 2026-05-08 14:35:26 +03:00
add more docs links
- display docs link for main sections on collapsible fields
This commit is contained in:
parent
b1d5b12aeb
commit
37e37b21c4
@ -31,6 +31,8 @@ const ffmpeg: SectionConfigOverrides = {
|
|||||||
"inputs.output_args": "/configuration/ffmpeg_presets#output-args-presets",
|
"inputs.output_args": "/configuration/ffmpeg_presets#output-args-presets",
|
||||||
"output_args.record": "/configuration/ffmpeg_presets#output-args-presets",
|
"output_args.record": "/configuration/ffmpeg_presets#output-args-presets",
|
||||||
"inputs.roles": "/configuration/cameras/#setting-up-camera-inputs",
|
"inputs.roles": "/configuration/cameras/#setting-up-camera-inputs",
|
||||||
|
apple_compatibility:
|
||||||
|
"/configuration/camera_specific#h265-cameras-via-safari",
|
||||||
},
|
},
|
||||||
restartRequired: [],
|
restartRequired: [],
|
||||||
fieldOrder: [
|
fieldOrder: [
|
||||||
|
|||||||
@ -27,10 +27,12 @@ const lpr: SectionConfigOverrides = {
|
|||||||
],
|
],
|
||||||
fieldDocs: {
|
fieldDocs: {
|
||||||
enhancement: "/configuration/license_plate_recognition#enhancement",
|
enhancement: "/configuration/license_plate_recognition#enhancement",
|
||||||
|
debug_save_plates:
|
||||||
|
"/configuration/license_plate_recognition/#how-do-i-debug-lpr-issues",
|
||||||
},
|
},
|
||||||
restartRequired: [],
|
restartRequired: [],
|
||||||
fieldOrder: ["enabled", "min_area", "enhancement", "expire_time"],
|
fieldOrder: ["enabled", "min_area", "enhancement", "expire_time"],
|
||||||
hiddenFields: [],
|
hiddenFields: ["expire_time"],
|
||||||
advancedFields: ["expire_time", "enhancement"],
|
advancedFields: ["expire_time", "enhancement"],
|
||||||
overrideFields: ["enabled", "min_area", "enhancement"],
|
overrideFields: ["enabled", "min_area", "enhancement"],
|
||||||
},
|
},
|
||||||
|
|||||||
@ -3,6 +3,11 @@ import type { SectionConfigOverrides } from "./types";
|
|||||||
const onvif: SectionConfigOverrides = {
|
const onvif: SectionConfigOverrides = {
|
||||||
base: {
|
base: {
|
||||||
sectionDocs: "/configuration/cameras#setting-up-camera-ptz-controls",
|
sectionDocs: "/configuration/cameras#setting-up-camera-ptz-controls",
|
||||||
|
fieldDocs: {
|
||||||
|
autotracking: "/configuration/autotracking",
|
||||||
|
"autotracking.calibrate_on_startup":
|
||||||
|
"/configuration/autotracking#calibration",
|
||||||
|
},
|
||||||
fieldOrder: [
|
fieldOrder: [
|
||||||
"host",
|
"host",
|
||||||
"port",
|
"port",
|
||||||
|
|||||||
@ -45,6 +45,10 @@ const review: SectionConfigOverrides = {
|
|||||||
fieldDocs: {
|
fieldDocs: {
|
||||||
"alerts.labels": "/configuration/review/#alerts-and-detections",
|
"alerts.labels": "/configuration/review/#alerts-and-detections",
|
||||||
"detections.labels": "/configuration/review/#alerts-and-detections",
|
"detections.labels": "/configuration/review/#alerts-and-detections",
|
||||||
|
genai: "/configuration/genai/genai_review",
|
||||||
|
"genai.image_source": "/configuration/genai/genai_review#image-source",
|
||||||
|
"genai.additional_concerns":
|
||||||
|
"/configuration/genai/genai_review#additional-concerns",
|
||||||
},
|
},
|
||||||
restartRequired: [],
|
restartRequired: [],
|
||||||
fieldOrder: ["alerts", "detections", "genai", "genai.enabled"],
|
fieldOrder: ["alerts", "detections", "genai", "genai.enabled"],
|
||||||
|
|||||||
@ -9,11 +9,13 @@ import {
|
|||||||
import { Children, useState, useEffect, useRef } from "react";
|
import { Children, useState, useEffect, useRef } from "react";
|
||||||
import type { ReactNode } from "react";
|
import type { ReactNode } from "react";
|
||||||
import RestartRequiredIndicator from "@/components/indicators/RestartRequiredIndicator";
|
import RestartRequiredIndicator from "@/components/indicators/RestartRequiredIndicator";
|
||||||
import { LuChevronDown, LuChevronRight } from "react-icons/lu";
|
import { LuChevronDown, LuChevronRight, LuExternalLink } from "react-icons/lu";
|
||||||
import { useTranslation } from "react-i18next";
|
import { useTranslation } from "react-i18next";
|
||||||
|
import { Link } from "react-router-dom";
|
||||||
import { cn } from "@/lib/utils";
|
import { cn } from "@/lib/utils";
|
||||||
import { getTranslatedLabel } from "@/utils/i18n";
|
import { getTranslatedLabel } from "@/utils/i18n";
|
||||||
import { requiresRestartForFieldPath } from "@/utils/configUtil";
|
import { requiresRestartForFieldPath } from "@/utils/configUtil";
|
||||||
|
import { useDocDomain } from "@/hooks/use-doc-domain";
|
||||||
import { ConfigFormContext } from "@/types/configForm";
|
import { ConfigFormContext } from "@/types/configForm";
|
||||||
import {
|
import {
|
||||||
buildTranslationPath,
|
buildTranslationPath,
|
||||||
@ -178,6 +180,7 @@ export function ObjectFieldTemplate(props: ObjectFieldTemplateProps) {
|
|||||||
"views/settings",
|
"views/settings",
|
||||||
"common",
|
"common",
|
||||||
]);
|
]);
|
||||||
|
const { getLocaleDocUrl } = useDocDomain();
|
||||||
const objectRequiresRestart = requiresRestartForFieldPath(
|
const objectRequiresRestart = requiresRestartForFieldPath(
|
||||||
fieldPath,
|
fieldPath,
|
||||||
restartRequired,
|
restartRequired,
|
||||||
@ -300,6 +303,17 @@ export function ObjectFieldTemplate(props: ObjectFieldTemplateProps) {
|
|||||||
schemaDescription;
|
schemaDescription;
|
||||||
inferredDescription = inferredDescription ?? fallbackDescription;
|
inferredDescription = inferredDescription ?? fallbackDescription;
|
||||||
|
|
||||||
|
const pathStringSegments =
|
||||||
|
path?.filter((segment): segment is string => typeof segment === "string") ??
|
||||||
|
[];
|
||||||
|
const fieldDocsKey = translationPath || pathStringSegments.join(".");
|
||||||
|
const fieldDocsPath = fieldDocsKey
|
||||||
|
? formContext?.fieldDocs?.[fieldDocsKey]
|
||||||
|
: undefined;
|
||||||
|
const fieldDocsUrl = fieldDocsPath
|
||||||
|
? getLocaleDocUrl(fieldDocsPath)
|
||||||
|
: undefined;
|
||||||
|
|
||||||
const renderGroupedFields = (items: (typeof properties)[number][]) => {
|
const renderGroupedFields = (items: (typeof properties)[number][]) => {
|
||||||
if (!items.length) {
|
if (!items.length) {
|
||||||
return null;
|
return null;
|
||||||
@ -466,6 +480,20 @@ export function ObjectFieldTemplate(props: ObjectFieldTemplateProps) {
|
|||||||
{inferredDescription}
|
{inferredDescription}
|
||||||
</p>
|
</p>
|
||||||
)}
|
)}
|
||||||
|
{fieldDocsUrl && (
|
||||||
|
<div className="mt-1 flex items-center text-xs text-primary-variant">
|
||||||
|
<Link
|
||||||
|
to={fieldDocsUrl}
|
||||||
|
target="_blank"
|
||||||
|
rel="noopener noreferrer"
|
||||||
|
className="inline"
|
||||||
|
onClick={(e) => e.stopPropagation()}
|
||||||
|
>
|
||||||
|
{t("readTheDocumentation", { ns: "common" })}
|
||||||
|
<LuExternalLink className="ml-2 inline-flex size-3" />
|
||||||
|
</Link>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
</div>
|
</div>
|
||||||
{isOpen ? (
|
{isOpen ? (
|
||||||
<LuChevronDown className="h-4 w-4 shrink-0" />
|
<LuChevronDown className="h-4 w-4 shrink-0" />
|
||||||
|
|||||||
@ -487,7 +487,7 @@ export default function TriggerView({
|
|||||||
<>
|
<>
|
||||||
<div className="mb-5 flex flex-row items-center justify-between gap-2">
|
<div className="mb-5 flex flex-row items-center justify-between gap-2">
|
||||||
<div className="flex flex-col items-start">
|
<div className="flex flex-col items-start">
|
||||||
<Heading as="h4" className="mb-2">
|
<Heading as="h4" className="mb-1">
|
||||||
{t("triggers.management.title")}
|
{t("triggers.management.title")}
|
||||||
</Heading>
|
</Heading>
|
||||||
<p className="text-sm text-muted-foreground">
|
<p className="text-sm text-muted-foreground">
|
||||||
@ -495,6 +495,17 @@ export default function TriggerView({
|
|||||||
camera: cameraName,
|
camera: cameraName,
|
||||||
})}
|
})}
|
||||||
</p>
|
</p>
|
||||||
|
<div className="mt-1 flex items-center text-sm text-primary-variant">
|
||||||
|
<Link
|
||||||
|
to={getLocaleDocUrl("configuration/semantic_search")}
|
||||||
|
target="_blank"
|
||||||
|
rel="noopener noreferrer"
|
||||||
|
className="inline"
|
||||||
|
>
|
||||||
|
{t("readTheDocumentation", { ns: "common" })}{" "}
|
||||||
|
<LuExternalLink className="ml-2 inline-flex size-3" />
|
||||||
|
</Link>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<Button
|
<Button
|
||||||
className="flex items-center gap-2 self-start sm:self-auto"
|
className="flex items-center gap-2 self-start sm:self-auto"
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user