bricks/docs/zh/widget.md
2025-11-19 12:30:39 +08:00

203 lines
5.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Tooltip
**控件功能**:用于显示提示信息的浮动文本控件,通常作为鼠标悬停时的工具提示。
**类型**:普通控件
**父类控件**`bricks.Text`
## 初始化参数
| 参数名 | 类型 | 说明 |
|--------|------|------|
| `otext` | String | 显示的原始文本内容,支持国际化 |
| `rate` | Number | 字体缩放比例,默认为 `0.8` |
| `tip` | null | 固定为 `null`,防止继承 tooltip 行为 |
> 注:`Tooltip` 在构造时会自动设置 `rate=0.8` 并添加 `modal` CSS 类,最小宽度设为 `90px`。
## 主要事件
| 事件名 | 触发时机 | 携带参数 |
|--------|----------|---------|
| 无自定义事件 | —— | —— |
> `Tooltip` 本身不派发自定义事件,但可通过 `show(otext, event)` 和 `hide()` 方法控制显隐。
---
# Text
**控件功能**:基础文本显示控件,支持居中对齐、字体大小响应字符尺寸变化。
**类型**:普通控件
**父类控件**`bricks.TextBase`
## 初始化参数
| 参数名 | 类型 | 说明 |
|--------|------|------|
| `text` | String | 要显示的文本内容 |
| `otext` | String | 原始文本,用于国际化支持 |
| `i18n` | Boolean | 是否启用国际化,默认关闭 |
| `halign` | String | 水平对齐方式:`left`, `center`, `right`(默认 `center` |
| `valign` | String | 垂直对齐方式:`top`, `center`, `bottom`(默认 `center` |
| `wrap` | Boolean | 是否允许换行 |
| `css` | String | 自定义 CSS 类名 |
| `rate` | Number | 字体缩放系数,默认为 `1` |
> 字体大小基于全局 `bricks.app.charsize` 动态调整,初始 `cfontsize = 1`。
## 主要事件
| 事件名 | 触发时机 | 携带参数 |
|--------|----------|---------|
| 无 | `Text` 是静态控件,不触发交互事件 | —— |
---
# KeyinText
**控件功能**:可输入文本控件,通过监听键盘事件动态更新显示内容,适用于简易输入场景。
**类型**:普通控件
**父类控件**`bricks.Text`
## 初始化参数
| 参数名 | 类型 | 说明 |
|--------|------|------|
| `name` | String | 数据字段名,默认为 `'data'`,用于 `changed` 事件输出键名 |
| 其他参数继承自 `Text` | —— | 支持所有 `Text` 的参数 |
> 自动绑定全局 `keydown` 事件,接收字母、数字、回车等单字符输入。
## 主要事件
| 事件名 | 触发时机 | 携带参数 |
|--------|----------|---------|
| `changed` | 每当文本发生变化时(包括输入、删除) | 对象格式:`{ [this.name]: 当前文本 }`,例如 `{ data: "abc" }` |
---
# Title1
**控件功能**:一级标题控件,字体加粗,字号较大,用于页面主标题展示。
**类型**:普通控件
**父类控件**`bricks.TextBase`
## 初始化参数
| 参数名 | 类型 | 说明 |
|--------|------|------|
| `text` / `otext` | String | 显示文本或国际化原文 |
| `i18n` | Boolean | 是否启用国际化 |
| `halign` | String | 水平对齐方式 |
| `valign` | String | 垂直对齐方式 |
| `rate` | Number | 缩放比例,默认继承 |
> 内置样式:`fontWeight: bold``cfontsize: 1.96`,响应字符尺寸变化。
## 主要事件
| 事件名 | 触发时机 | 携带参数 |
|--------|----------|---------|
| 无 | 静态文本控件,无交互事件 | —— |
---
# Title2
**控件功能**:二级标题控件,加粗显示,字号略小于 Title1用于章节标题。
**类型**:普通控件
**父类控件**`bricks.TextBase`
## 初始化参数
`Title1`,支持相同参数。
> 内置属性:`cfontsize: 1.80`,其他与 `Title1` 一致。
## 主要事件
| 事件名 | 触发时机 | 携带参数 |
|--------|----------|---------|
| 无 | 静态控件 | —— |
---
# Title3
**控件功能**:三级标题控件,用于子模块或小组块标题。
**类型**:普通控件
**父类控件**`bricks.TextBase`
## 初始化参数
同上。
> `cfontsize: 1.64`
## 主要事件
| 事件名 | 触发时机 | 携带参数 |
|--------|----------|---------|
| 无 | —— | —— |
---
# Title4
**控件功能**:四级标题控件,较小的加粗标题,适合细粒度结构划分。
**类型**:普通控件
**父类控件**`bricks.TextBase`
## 初始化参数
同上。
> `cfontsize: 1.48`
## 主要事件
| 事件名 | 触发时机 | 携带参数 |
|--------|----------|---------|
| 无 | —— | —— |
---
# Title5
**控件功能**:五级标题控件,轻量级标题样式。
**类型**:普通控件
**父类控件**`bricks.TextBase`
## 初始化参数
同上。
> `cfontsize: 1.32`
## 主要事件
| 事件名 | 触发时机 | 携带参数 |
|--------|----------|---------|
| 无 | —— | —— |
---
# Title6
**控件功能**:六级标题控件,最小的一套标题样式,接近正文但加粗。
**类型**:普通控件
**父类控件**`bricks.TextBase`
## 初始化参数
同上。
> `cfontsize: 1.16`
## 主要事件
| 事件名 | 触发时机 | 携带参数 |
|--------|----------|---------|
| 无 | —— | —— |