Skip to content

文本输入框 (TextField)

文本输入框用于接收用户输入的字符串数据。

基本用法

python
gui_config.add_argument(
    "name",
    metavar="文本输入框",
    help="输入字符串",
    default="小云",
    widget="TextField",
    validate="customize_verify",
    gooey_options={
        "placeholder": "请输入您的名称",  # 占位文本
        "maxlength": 50,  # 最大长度
        "minlength": 2,  # 最小长度
        "readonly": False,  # 是否只读
        "disabled": False,  # 是否禁用
        "clearable": True,  # 是否可清空
        "showWordLimit": True,  # 是否显示字数限制
        "prefixIcon": "User",  # 前缀图标
        "size": "large"  # 大小 large/default/small
    }
)

属性

属性名说明类型默认值
placeholder输入框占位文本string-
maxlength最大输入长度number-
minlength最小输入长度number-
readonly是否只读booleanfalse
disabled是否禁用booleanfalse
clearable是否可清空booleantrue
showWordLimit是否显示字数限制booleantrue
prefixIcon前缀图标string-
size输入框大小string'default'

使用场景

文本输入框适用于需要用户输入文本内容的场景,例如:

  • 用户名、密码输入
  • 表单中的文本字段
  • 搜索框
  • 标题、描述等内容输入

最佳实践

  1. 始终为输入框提供清晰的标签和帮助文本
  2. 适当设置最大长度限制,避免用户输入过长的内容
  3. 对于敏感信息,可以配合验证功能使用
  4. 根据实际需要设置 placeholder 提示用户输入内容的格式

基于MIT许可证发布