Rename nickname to friendly_name (#19782)

Better aligns with convention from Home Assistant since many Frigate users are also HA users
This commit is contained in:
Josh Hawkins
2025-08-26 15:29:52 -05:00
committed by GitHub
parent d3af748366
commit 398a3a7b95
18 changed files with 42 additions and 40 deletions

View File

@@ -107,7 +107,7 @@ export default function CameraEditForm({
const cameraInfo = useMemo(() => {
if (!cameraName || !config?.cameras[cameraName]) {
return {
nickname: undefined,
friendly_name: undefined,
name: cameraName || "",
roles: new Set<Role>(),
};
@@ -121,14 +121,14 @@ export default function CameraEditForm({
});
return {
nickname: camera?.nickname || cameraName,
friendly_name: camera?.friendly_name || cameraName,
name: cameraName,
roles,
};
}, [cameraName, config]);
const defaultValues: FormValues = {
cameraName: cameraInfo?.nickname || cameraName || "",
cameraName: cameraInfo?.friendly_name || cameraName || "",
enabled: true,
ffmpeg: {
inputs: [
@@ -169,18 +169,18 @@ export default function CameraEditForm({
const saveCameraConfig = (values: FormValues) => {
setIsLoading(true);
let finalCameraName = values.cameraName;
let nickname: string | undefined = undefined;
let friendly_name: string | undefined = undefined;
const isValidName = /^[a-zA-Z0-9_-]+$/.test(values.cameraName);
if (!isValidName) {
finalCameraName = generateFixedHash(finalCameraName);
nickname = values.cameraName;
friendly_name = values.cameraName;
}
const configData: ConfigSetBody["config_data"] = {
cameras: {
[finalCameraName]: {
enabled: values.enabled,
...(nickname && { nickname }),
...(friendly_name && { friendly_name }),
ffmpeg: {
inputs: values.ffmpeg.inputs.map((input) => ({
path: input.path,
@@ -235,7 +235,7 @@ export default function CameraEditForm({
if (
cameraName &&
values.cameraName !== cameraName &&
values.cameraName !== cameraInfo?.nickname
values.cameraName !== cameraInfo?.friendly_name
) {
// If camera name changed, delete old camera config
const deleteRequestBody: ConfigSetBody = {

View File

@@ -33,7 +33,7 @@ import { Link } from "react-router-dom";
import { LiveStreamMetadata } from "@/types/live";
import { Trans, useTranslation } from "react-i18next";
import { useDocDomain } from "@/hooks/use-doc-domain";
import { useCameraNickname } from "@/hooks/use-camera-nickname";
import { useCameraFriendlyName } from "@/hooks/use-camera-friendly-name";
type CameraStreamingDialogProps = {
camera: string;
@@ -57,7 +57,7 @@ export function CameraStreamingDialog({
const { getLocaleDocUrl } = useDocDomain();
const { data: config } = useSWR<FrigateConfig>("config");
const cameraName = useCameraNickname(camera);
const cameraName = useCameraFriendlyName(camera);
const [isLoading, setIsLoading] = useState(false);