CommonForm.md

sapi-pro

---

sapi-pro / CommonForm

Class: CommonForm

Methods

BodyInfoForm()

static BodyInfoForm<U>(title, body, onSubmit?): BodyInfoForm<U>

注册一个简单的信息窗口

Type Parameters

U

U extends ButtonFormArgs

Parameters

title

TextType

标题

body

TextType | formGenerator<ActionFormData, U>

内容，可以是生成器

onSubmit?

(ctx) => void

提交后执行

Returns

BodyInfoForm<U>

---

ButtonForm()

static ButtonForm<U, TData>(data): ButtonForm<U, TData>

常用的按钮表单

Type Parameters

U

U extends ButtonFormArgs

TData

TData = void

Parameters

data

ButtonFormData<U, TData>

Returns

ButtonForm<U, TData>

---

ConfigForm()

static ConfigForm<U>(): object

配置表单

Type Parameters

U

U extends InputFormArgs

Returns

object

create

create: <T>(schema, options) => ConfigForm<T, U>

Type Parameters

T

T extends Record<string, AnyConfig<U>>

Parameters

schema

T

options

ConfigFormOptions<T, U>

Returns

ConfigForm<T, U>

---

InputForm()

static InputForm<TResult, U>(data): InputForm<U, TResult>

输入表单

Type Parameters

TResult

TResult extends unknown

U

U extends InputFormArgs = any

Parameters

data

InputFormData<U, TResult>

Returns

InputForm<U, TResult>

---

SimpleMessageForm()

static SimpleMessageForm<U>(data): SimpleMessageForm<U>

一个简单的提示窗口，仅含有两个按钮，

Type Parameters

U

U extends ButtonFormArgs

Parameters

data

SimpleMessageFormData<U>

Returns

SimpleMessageForm<U>