sailboat-design
Version:
A simple sailboat simulator
29 lines (28 loc) • 1.12 kB
TypeScript
import React, { ReactElement, InputHTMLAttributes, ChangeEvent } from 'react';
import { IconProp } from '@fortawesome/fontawesome-svg-core';
declare type InputSize = 'lg' | 'sm';
export interface InputProps extends Omit<InputHTMLAttributes<HTMLElement>, 'size'> {
/**是否禁用 Input */
disabled?: boolean;
/**设置 input 大小,支持 lg 或者是 sm */
size?: InputSize;
/**添加图标,在右侧悬浮添加一个图标,用于提示 */
icon?: IconProp;
/**添加前缀 用于配置一些固定组合 */
prepend?: string | ReactElement;
/**添加后缀 用于配置一些固定组合 */
append?: string | ReactElement;
onChange?: (e: ChangeEvent<HTMLInputElement>) => void;
}
/**
* Input 输入框 通过鼠标或键盘输入内容,是最基础的表单域的包装。
*
* ~~~js
* // 这样引用
* import { Input } from 'sailboatship'
* ~~~
*
* 支持 HTMLInput 的所有基本属性
*/
export declare const Input: React.ForwardRefExoticComponent<InputProps & React.RefAttributes<HTMLInputElement>>;
export default Input;