io.input.boolean

Represents a checkbox component.

Usage

JavaScript/TypeScript

const value = await io.input.boolean(
  "Do you enjoy using Forge?",
  defaultValue = true,
)

Python

value = await io.input.boolean("Do you enjoy using Forge?", default_value=True),

Props

defaultValue Required

Default value for the input.

disabled Optional

boolean
Whether the input is disabled, preventing edits to the defaultValue.

helpText Optional

string
Optional label providing additional context. Supports inline markdown elements like bold, italics, and links.

Returns

boolean