Class CustomForm`Beta`

A customizable form that lets you put buttons, labels, toggles, dropdowns, sliders, and more into a form! Built on top of Observable, the form will update when the Observables' value changes.

Index

Constructors

constructor

Methods

button close closeButton divider dropdown header isShowing label show slider spacer textField toggle create

Constructors

constructor

new CustomForm(): CustomForm
Returns CustomForm

Methods

button

button(
    label:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
    onClick: () => void,
    options?: ButtonOptions,
): CustomForm
Parameters
- label: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
- onClick: () => void
- Optionaloptions: ButtonOptions
Returns CustomForm
Remarks
Inserts a button into the Custom form. onClick is called when the button is pressed.
- Defined in @minecraft/server-ui.d.ts:210

close

close(): void
Returns void
Remarks
Tell the client to close the form. Throws an error if the form is not open.
- Defined in @minecraft/server-ui.d.ts:221

closeButton

closeButton(): CustomForm
Returns CustomForm
Remarks
Adds a close "X" button to the form.
- Defined in @minecraft/server-ui.d.ts:227

divider

divider(options?: DividerOptions): CustomForm
Parameters
- Optionaloptions: DividerOptions
Returns CustomForm
Remarks
Inserts a divider (i.e. a line) into the Custom form.
- Defined in @minecraft/server-ui.d.ts:233

dropdown(
    label:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
    value: Observable<number>,
    items: DropdownItem[],
    options?: DropdownOptions,
): CustomForm
Parameters
- label: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
- value: Observable<number>
- items: DropdownItem[]
- Optionaloptions: DropdownOptions
Returns CustomForm
Remarks
Inserts a dropdown into the Custom form with the provided items. The value is based on the items value that selected.
- Defined in @minecraft/server-ui.d.ts:240

header(
    text:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
    options?: TextOptions,
): CustomForm
Parameters
- text: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
- Optionaloptions: TextOptions
Returns CustomForm
Remarks
Inserts a header (i.e. large sized text) into the Custom form.
- Defined in @minecraft/server-ui.d.ts:252

isShowing

isShowing(): boolean
Returns boolean
Remarks
Returns true if the form is currently being shown to the player.
- Defined in @minecraft/server-ui.d.ts:262

label

label(
    text:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
    options?: TextOptions,
): CustomForm
Parameters
- text: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
- Optionaloptions: TextOptions
Returns CustomForm
Remarks
Inserts a label (i.e. medium sized text) into the Custom form.
- Defined in @minecraft/server-ui.d.ts:269

show

show(): Promise<DataDrivenScreenClosedReason>
Returns Promise<DataDrivenScreenClosedReason>
Remarks
Shows the form to the player. Will return false if the client was busy (i.e. in another menu or this one is open). Will throw if the user disconnects.
Throws
- Defined in @minecraft/server-ui.d.ts:282

slider

slider(
    label:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
    value: Observable<number>,
    minValue: number | Observable<number>,
    maxValue: number | Observable<number>,
    options?: SliderOptions,
): CustomForm
Parameters
- label: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
- value: Observable<number>
- minValue: number | Observable<number>
- maxValue: number | Observable<number>
- Optionaloptions: SliderOptions
Returns CustomForm
Remarks
Creates a slider that lets players pick a number between minValue and maxValue. value must be client writable.
- Defined in @minecraft/server-ui.d.ts:289

spacer

spacer(options?: SpacingOptions): CustomForm
Parameters
- Optionaloptions: SpacingOptions
Returns CustomForm
Remarks
Inserts a space into the Custom form.
- Defined in @minecraft/server-ui.d.ts:301

textField

textField(
    label:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
    text: Observable<string>,
    options?: TextFieldOptions,
): CustomForm
Parameters
- label: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
- text: Observable<string>
- Optionaloptions: TextFieldOptions
Returns CustomForm
Remarks
Inserts a text field into the Custom for that players can enter text into.
- Defined in @minecraft/server-ui.d.ts:308

toggle

toggle(
    label:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
    toggled: Observable<boolean>,
    options?: ToggleOptions,
): CustomForm
Parameters
- label: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
- toggled: Observable<boolean>
- Optionaloptions: ToggleOptions
Returns CustomForm
Remarks
Inserts an on/off toggle that players can interact with into the Custom form.
- Defined in @minecraft/server-ui.d.ts:319

`Static`create

create(
    player: Player,
    title:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
): CustomForm
Parameters
- player: Player
- title: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
Returns CustomForm
Remarks
Creates a Custom form to show to the player. Use this instead of a constructor.
- Defined in @minecraft/server-ui.d.ts:330

Class CustomFormBeta

Index

Constructors

Methods

Constructors

constructor

Returns CustomForm

Methods

button

Parameters

Returns CustomForm

Remarks

close

Returns void

Remarks

closeButton

Returns CustomForm

Remarks

divider

Parameters

Returns CustomForm

Remarks

dropdown

Parameters

Returns CustomForm

Remarks

header

Parameters

Returns CustomForm

Remarks

isShowing

Returns boolean

Remarks

label

Parameters

Returns CustomForm

Remarks

show

Returns Promise<DataDrivenScreenClosedReason>

Remarks

Throws

slider

Parameters

Returns CustomForm

Remarks

spacer

Parameters

Returns CustomForm

Remarks

textField

Parameters

Returns CustomForm

Remarks

toggle

Parameters

Returns CustomForm

Remarks

Staticcreate

Parameters

Returns CustomForm

Remarks

Settings

On This Page

Class CustomForm`Beta`

`Static`create