GoToSocial/web/source/settings/components/check-list.tsx

113 lines
3.1 KiB
TypeScript
Raw Normal View History

/*
GoToSocial
2023-03-12 18:49:06 +01:00
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 from "react";
import { memo, useDeferredValue, useCallback, useMemo } from "react";
import { Checkable, ChecklistInputHook } from "../lib/form/types";
interface CheckListProps {
field: ChecklistInputHook;
header: string | React.JSX.Element;
EntryComponent: React.FunctionComponent;
getExtraProps;
}
export default function CheckList({ field, header = "All", EntryComponent, getExtraProps }: CheckListProps) {
return (
<div className="checkbox-list list">
<CheckListHeader toggleAll={field.toggleAll}> {header}</CheckListHeader>
<CheckListEntries
entries={field.value ?? {}}
updateValue={field.onChange}
EntryComponent={EntryComponent}
getExtraProps={getExtraProps}
/>
</div>
);
}
function CheckListHeader({ toggleAll, children }) {
return (
<label className="header entry">
<input
ref={toggleAll.ref}
type="checkbox"
onChange={toggleAll.onChange}
/> {children}
</label>
);
}
interface CheckListEntriesProps {
entries: { [_: string]: Checkable },
updateValue,
EntryComponent,
getExtraProps,
}
const CheckListEntries = memo(
function CheckListEntries({ entries, updateValue, EntryComponent, getExtraProps }: CheckListEntriesProps) {
const deferredEntries = useDeferredValue(entries);
return Object.values(deferredEntries).map((entry) => (
<CheckListEntry
key={entry.key}
entry={entry}
updateValue={updateValue}
EntryComponent={EntryComponent}
getExtraProps={getExtraProps}
/>
));
}
);
interface CheckListEntryProps {
entry: Checkable,
updateValue,
getExtraProps,
EntryComponent,
}
/*
React.memo is a performance optimization that only re-renders a CheckListEntry
when it's props actually change, instead of every time anything
in the list (CheckListEntries) updates
*/
const CheckListEntry = memo(
function CheckListEntry({ entry, updateValue, getExtraProps, EntryComponent }: CheckListEntryProps) {
const onChange = useCallback(
(value) => updateValue(entry.key, value),
[updateValue, entry.key]
);
const extraProps = useMemo(() => getExtraProps?.(entry), [getExtraProps, entry]);
return (
<label className="entry">
<input
type="checkbox"
onChange={(e) => onChange({ checked: e.target.checked })}
checked={entry.checked}
/>
<EntryComponent entry={entry} onChange={onChange} extraProps={extraProps} />
</label>
);
}
);