File size: 3,008 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 |
import * as React from 'react';
import type { FormInstance as RcFormInstance } from 'rc-field-form';
import { useForm as useRcForm } from 'rc-field-form';
import { getDOM } from 'rc-util/lib/Dom/findDOMNode';
import scrollIntoView from 'scroll-into-view-if-needed';
import type { InternalNamePath, NamePath, ScrollOptions } from '../interface';
import { getFieldId, toArray } from '../util';
export interface FormInstance<Values = any> extends RcFormInstance<Values> {
scrollToField: (name: NamePath, options?: ScrollOptions) => void;
focusField: (name: NamePath) => void;
/** @internal: This is an internal usage. Do not use in your prod */
__INTERNAL__: {
/** No! Do not use this in your code! */
name?: string;
/** No! Do not use this in your code! */
itemRef: (name: InternalNamePath) => (node: React.ReactElement) => void;
};
getFieldInstance: (name: NamePath) => any;
}
export function toNamePathStr(name: NamePath) {
const namePath = toArray(name);
return namePath.join('_');
}
function getFieldDOMNode(name: NamePath, wrapForm: FormInstance) {
const field = wrapForm.getFieldInstance(name);
const fieldDom = getDOM(field);
if (fieldDom) {
return fieldDom;
}
const fieldId = getFieldId(toArray(name), wrapForm.__INTERNAL__.name);
if (fieldId) {
return document.getElementById(fieldId);
}
}
export default function useForm<Values = any>(form?: FormInstance<Values>): [FormInstance<Values>] {
const [rcForm] = useRcForm();
const itemsRef = React.useRef<Record<string, React.ReactElement>>({});
const wrapForm: FormInstance<Values> = React.useMemo(
() =>
form ?? {
...rcForm,
__INTERNAL__: {
itemRef: (name: InternalNamePath) => (node: React.ReactElement) => {
const namePathStr = toNamePathStr(name);
if (node) {
itemsRef.current[namePathStr] = node;
} else {
delete itemsRef.current[namePathStr];
}
},
},
scrollToField: (name: NamePath, options: ScrollOptions = {}) => {
const { focus, ...restOpt } = options;
const node = getFieldDOMNode(name, wrapForm);
if (node) {
scrollIntoView(node, {
scrollMode: 'if-needed',
block: 'nearest',
...restOpt,
} as any);
// Focus if scroll success
if (focus) {
wrapForm.focusField(name);
}
}
},
focusField: (name: NamePath) => {
const itemRef = wrapForm.getFieldInstance(name);
if (typeof itemRef?.focus === 'function') {
itemRef.focus();
} else {
getFieldDOMNode(name, wrapForm)?.focus?.();
}
},
getFieldInstance: (name: NamePath) => {
const namePathStr = toNamePathStr(name);
return itemsRef.current[namePathStr];
},
},
[form, rcForm],
);
return [wrapForm];
}
|