ButtonFormData.md

sapi-pro

---

sapi-pro / ButtonFormData

Interface: ButtonFormData<U, TData>

Extends

• CommonFormData<ActionFormData, U>

Type Parameters

U

U extends contextArgs = contextArgs

TData

TData = void

Properties

body?

optional body?: TextType

body

---

buttonGenerator?

optional buttonGenerator?: (player, args, t) => Iterable<FuncButton<U, TData>>

按钮生成器

Parameters

player

Player

args

U

t

UniversalTranslator

Returns

Iterable<FuncButton<U, TData>>

---

buttons?

optional buttons?: FuncButton<U, TData>[]

按钮列表(顶部的固定按钮)

---

footerButtons?

optional footerButtons?: FuncButton<U, TData>[]

按钮列表(底部的固定按钮)

---

generator?

optional generator?: formGenerator<ActionFormData, U>

自定义生成器

Inherited from

CommonFormData.generator

---

handler?

optional handler?: (ctx, button, index) => void | Promise<void>

列表处理(若点击的按钮已有func，则不会调用此函数处理)

Parameters

ctx

SAPIProFormContext<ActionFormData, U>

button

[TData] extends [void] ? object : object

按下的按钮 data为构造时附带的数据,btnIndex为排除func按钮后的下标

index

number

表单选择的下标

Returns

void | Promise<void>

---

oncancel?

optional oncancel?: formHandler<ActionFormData, U>

取消事件

---

title?

optional title?: TextType

标题

Inherited from

CommonFormData.title

---

validator?

optional validator?: formBeforeBuild<ActionFormData, U>

表单验证器，验证失败则不打开表单