使用 React Hooks 定义函数式组件,当需要对外暴露接口方法时,需要结合使用 React.forwardRef
和 React.useImperativeHandle
实现。
在基于 TypeScript 的开发模式下,如何正确的实现相关的类型定义和引用呢?
参考以下示例进行了解:
/** 对外暴露接口的约束类型 */ interface LzwmeInputHandles { focus(): void; } interface LzwmeInputProps extends React.InputHTMLAttributes<HTMLInputElement> {} export const LzwmeInput = React.forwardRef<LzwmeInputHandles, LzwmeInputProps>((props, ref) => { const inputRef = React.useRef<HTMLInputElement>(null); // 通过 React.forwardRef<LzwmeInputHandles> 的类型约束了这里可定义导出的接口方法 React.useImperativeHandle(ref, () => ({ focus: () => inputRef.current?.focus(), })); return <input {...props} ref={inputRef} />; });
上面的示例代码定义了一个基于 React Hooks 的函数式组件 LzwmeInput
,要正确的定义其 ref 实例引用类型,需要借助 React.ElementRef
,示例:
/** 声明 LzwmeInput 的一个实例 */ let el: React.ElementRef<typeof LzwmeInput>; el.focus();
上面通过简单的示例代码展示了基于 TypeScript 开发 React 函数组件导出接口的方法。简单来说,在组件定义时使用 React.forwardRef<IHandlers, Iproprs>
方式指定类型约束,在声明引用变量时,可使用 React.ElementRef
声明正确的类型实例。