From 5764a4861d5a27465fdbc829b47567bf39299455 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Loi=CC=88c=20Correnson?= <loic.correnson@cea.fr>
Date: Fri, 4 Sep 2020 12:10:13 +0200
Subject: [PATCH] [dome] hook-based typed forms

---
 ivette/src/dome/src/renderer/layout/form.tsx | 191 +++++++++++++++++++
 1 file changed, 191 insertions(+)
 create mode 100644 ivette/src/dome/src/renderer/layout/form.tsx

diff --git a/ivette/src/dome/src/renderer/layout/form.tsx b/ivette/src/dome/src/renderer/layout/form.tsx
new file mode 100644
index 00000000000..165b1e54e96
--- /dev/null
+++ b/ivette/src/dome/src/renderer/layout/form.tsx
@@ -0,0 +1,191 @@
+// --------------------------------------------------------------------------
+// --- Forms Layout
+// --------------------------------------------------------------------------
+
+/**
+   @packageDocumentation
+   @module dome/layout/form
+ */
+
+import { debounce } from 'lodash';
+import React from 'react';
+import * as Utils from 'dome/utils';
+
+export type Error = undefined | string;
+export type Setter<A> = (value: A) => void;
+export type Checker<A> = (value: A) => true | Error;
+export type State<A> = [A, Setter<A>]
+export type Callback<A> = (value: A, valid: boolean) => void;
+
+/* --------------------------------------------------------------------------*/
+/* --- State Utilities                                                    ---*/
+/* --------------------------------------------------------------------------*/
+
+export function inRange(
+  a: number,
+  b: number,
+  msg?: string,
+): Checker<number> {
+  return (v: number) => (a <= v && v <= b) || msg || 'Invalid Range';
+}
+
+export function validate<A>(value: A, checker?: Checker<A>): Error {
+  if (checker) {
+    const r = checker(value);
+    return r === true ? undefined : r;
+  }
+  return undefined;
+}
+
+export function isValid(err: Error): boolean { return !err; }
+
+export function useCallback<A>(
+  value: A,
+  error: Error,
+  onChange?: Callback<A>,
+) {
+  React.useMemo(
+    () => { if (onChange) onChange(value, isValid(error)); },
+    [value, error, onChange],
+  );
+}
+
+export function useProperty<A, K extends keyof A>(
+  state: State<A>,
+  property: K,
+): State<A[K]> {
+  const [value, setValue] = state;
+  const update = React.useCallback((newProp: A[K]) => {
+    const newValue = { ...value, [property]: newProp };
+    setValue(newValue);
+  }, [value, property, setValue]);
+  return [value[property], update];
+}
+
+export function useIndex<A>(
+  state: State<A[]>,
+  index: number,
+): State<A> {
+  const [array, setValue] = state;
+  const update = React.useCallback((newItem: A) => {
+    const newArray = array.slice();
+    newArray[index] = newItem;
+    setValue(newArray);
+  }, [array, index, setValue]);
+  return [array[index], update];
+}
+
+/* --------------------------------------------------------------------------*/
+/* --- Form Context                                                       ---*/
+/* --------------------------------------------------------------------------*/
+
+export interface FilterProps {
+  /** default is false. */
+  hidden?: boolean;
+  /** default is true. */
+  visible?: boolean;
+  /** default is true. */
+  enabled?: boolean;
+  /** default is false. */
+  disabled?: boolean;
+}
+
+interface FormContext {
+  disabled: boolean;
+  hidden: boolean;
+}
+
+const CONTEXT = React.createContext<FormContext | undefined>(undefined);
+
+const HIDDEN =
+  ({ hidden = false, visible = true }: FilterProps) => hidden || !visible;
+
+const DISABLED =
+  ({ disabled = false, enabled = true }: FilterProps) => disabled || !enabled;
+
+function useContext(props: FilterProps): FormContext {
+  const Parent = React.useContext(CONTEXT);
+  return {
+    hidden: HIDDEN(props) || (Parent?.hidden ?? false),
+    disabled: DISABLED(props) || (Parent?.disabled ?? false),
+  }
+}
+
+export interface Children { children: React.ReactNode; }
+
+export function Filter(props: FilterProps & Children) {
+  const context = useContext(props);
+  if (context.hidden) return null;
+  return (
+    <CONTEXT.Provider value={context}>
+      {props.children}
+    </CONTEXT.Provider>
+  );
+}
+
+/* --------------------------------------------------------------------------*/
+/* --- Value Filter                                                      --- */
+/* --------------------------------------------------------------------------*/
+
+export interface FieldProps<A> {
+  state: State<A>;
+  checker?: Checker<A>;
+  onChange?: Callback<A>;
+  latency?: number;
+}
+
+type FilterState<A> = [A, Setter<A>, Error];
+
+export function useField<A>(props: FieldProps<A>): FilterState<A> {
+  const { checker, latency = 0, onChange } = props;
+  const [value, setValue] = props.state;
+  const [current, setCurrent] = React.useState<A>(value);
+  const [error, setError] = React.useState<Error>(undefined);
+  const update = React.useMemo(() => {
+    if (!latency)
+      return (newValue: A) => {
+        const newError = validate(newValue, checker);
+        setCurrent(newValue);
+        setValue(newValue);
+        setError(newError);
+        if (onChange) onChange(newValue, isValid(newError));
+      };
+    const propagate = debounce((newValue) => {
+      const newError = validate(newValue);
+      setValue(newValue);
+      setError(newError);
+      if (onChange) onChange(newValue, isValid(newError));
+    });
+    return (newValue: A) => {
+      setCurrent(newValue);
+      propagate(newValue);
+    }
+  }, [checker, latency, onChange, setValue, setError]);
+  return [current, update, error];
+};
+
+// --------------------------------------------------------------------------
+// --- Form Container
+// --------------------------------------------------------------------------
+
+export interface FormProps extends FilterProps, Children {
+  /** Additional container class. */
+  className?: string;
+  /** Additional container style. */
+  style?: React.CSSProperties;
+}
+
+/** Form Container. */
+export const Form = (props: FormProps) => {
+  const { className, style, children, ...filter } = props;
+  const css = Utils.classes('dome-xForm-grid', className);
+  return (
+    <div className={css} style={style}>
+      <Filter {...filter}>
+        {children}
+      </Filter>
+    </div>
+  );
+}
+
+// --------------------------------------------------------------------------
-- 
GitLab