gotosocial/web/source/settings/lib/form/text.tsx

/*
	GoToSocial
	Copyright (C) GoToSocial Authors admin@gotosocial.org
	SPDX-License-Identifier: AGPL-3.0-or-later

	This program is free software: you can redistribute it and/or modify
	it under the terms of the GNU Affero General Public License as published by
	the Free Software Foundation, either version 3 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU Affero General Public License for more details.

	You should have received a copy of the GNU Affero General Public License
	along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

import React, {
	useState,
	useRef,
	useTransition,
	useEffect,
} from "react";

import type {
	CreateHookNames,
	HookOpts,
	TextFormInputHook,
} from "./types";

const _default = "";

export default function useTextInput(
	{ name, Name }: CreateHookNames,
	{
		initialValue = _default,
		dontReset = false,
		validator,
		showValidation = true,
		initValidation
	}: HookOpts<string>
): TextFormInputHook {
	const [text, setText] = useState(initialValue);
	const textRef = useRef<HTMLInputElement>(null);

	const [validation, setValidation] = useState(initValidation ?? "");
	const [_isValidating, startValidation] = useTransition();
	const valid = validation == "";

	function onChange(e: React.ChangeEvent<HTMLInputElement>) {
		const input = e.target.value;
		setText(input);

		if (validator) {
			startValidation(() => {
				setValidation(validator(input));
			});
		}
	}

	function reset() {
		if (!dontReset) {
			setText(initialValue);
		}
	}

	useEffect(() => {
		if (validator && textRef.current) {
			if (showValidation) {
				textRef.current.setCustomValidity(validation);
			} else {
				textRef.current.setCustomValidity("");
			}
		}
	}, [validation, validator, showValidation]);

	// Array / Object hybrid, for easier access in different contexts
	return Object.assign([
		onChange,
		reset,
		{
			[name]: text,
			[`${name}Ref`]: textRef,
			[`set${Name}`]: setText,
			[`${name}Valid`]: valid,
		}
	], {
		onChange,
		reset,
		name,
		Name: "", // Will be set by inputHook function.
		value: text,
		ref: textRef,
		setter: setText,
		valid,
		validate: () => setValidation(validator ? validator(text): ""),
		hasChanged: () => text != initialValue,
		_default
	});
}