Input Components

Input components are fully interactive on the editor surface. On the layer surface, they automatically render in a read-only display mode.

Button

A clickable action button.

Props

Prop	Type	Required	Description
label	string	Yes	Button text
onClick	() => void	Yes	Click handler
variant	"default" | "destructive"	No	Visual variant (default: "default")
disabled	boolean	No	Prevents clicks and shows disabled state
style	VisionStyle	No	Additional style

Layer behavior: Not rendered (hidden entirely).

Example

import { Button, useMutation } from "@zaflun/lumio-sdk";

function ActionBar() {
  const { mutate: resetScores, isLoading } = useMutation("resetScores");

  return (
    <>
      <Button
        label="Update scores"
        onClick={() => {/* ... */}}
      />
      <Button
        label="Reset all"
        variant="destructive"
        onClick={() => resetScores()}
        disabled={isLoading}
      />
    </>
  );
}

---

Toggle

A boolean on/off switch with a label.

Props

Prop	Type	Required	Description
label	string	Yes	Label text
checked	boolean	Yes	Current state
onChange	(checked: boolean) => void	Yes	Change handler
disabled	boolean	No	Prevents interaction
style	VisionStyle	No	Additional style

Layer behavior: Shows "On" or "Off" as plain text.

Example

import { Toggle, useExtensionStorage } from "@zaflun/lumio-sdk";

function VisibilityToggle() {
  const [visible, setVisible] = useExtensionStorage("visible", true);

  return (
    <Toggle
      label="Show overlay"
      checked={visible}
      onChange={setVisible}
    />
  );
}

---

TextField

A single-line text input.

Props

Prop	Type	Required	Description
label	string	Yes	Input label
value	string	Yes	Current value
onChange	(value: string) => void	Yes	Change handler
placeholder	string	No	Placeholder text
disabled	boolean	No	Makes the field non-editable
style	VisionStyle	No	Additional style

Layer behavior: Shows current value as plain text.

Example

import { TextField, useExtensionStorage } from "@zaflun/lumio-sdk";

function TeamInput() {
  const [homeTeam, setHomeTeam] = useExtensionStorage("homeTeam", "");

  return (
    <TextField
      label="Home team"
      value={homeTeam}
      placeholder="Enter team name"
      onChange={setHomeTeam}
    />
  );
}

---

TextArea

A multi-line text input.

Props

Prop	Type	Required	Description
label	string	Yes	Input label
value	string	Yes	Current value
onChange	(value: string) => void	Yes	Change handler
placeholder	string	No	Placeholder text
rows	number	No	Number of visible rows (default: 3)
disabled	boolean	No	Makes the field non-editable
style	VisionStyle	No	Additional style

Layer behavior: Shows current value as plain text.

Example

import { TextArea, useExtensionStorage } from "@zaflun/lumio-sdk";

function NotesInput() {
  const [notes, setNotes] = useExtensionStorage("notes", "");

  return (
    <TextArea
      label="Stream notes"
      value={notes}
      placeholder="Add notes for your stream..."
      rows={4}
      onChange={setNotes}
    />
  );
}

---

NumberField

A numeric input with increment/decrement buttons.

Props

Prop	Type	Required	Description
label	string	Yes	Input label
value	number	Yes	Current value
onChange	(value: number) => void	Yes	Change handler
min	number	No	Minimum value
max	number	No	Maximum value
step	number	No	Increment step (default: 1)
disabled	boolean	No	Makes the field non-editable
style	VisionStyle	No	Additional style

Layer behavior: Shows current value as plain text.

Example

import { NumberField, useExtensionStorage } from "@zaflun/lumio-sdk";

function ScoreInput() {
  const [homeScore, setHomeScore] = useExtensionStorage("homeScore", 0);

  return (
    <NumberField
      label="Home score"
      value={homeScore}
      min={0}
      max={99}
      onChange={setHomeScore}
    />
  );
}

---

Dropdown

A select input with a list of options.

Props

Prop	Type	Required	Description
label	string	Yes	Input label
value	string	Yes	Currently selected value
options	{ value: string; label: string }[]	Yes	Available options
onChange	(value: string) => void	Yes	Change handler
disabled	boolean	No	Prevents selection
style	VisionStyle	No	Additional style

Layer behavior: Shows the selected option's label as plain text.

Example

import { Dropdown, useExtensionStorage } from "@zaflun/lumio-sdk";

function PositionSelector() {
  const [position, setPosition] = useExtensionStorage("position", "top-right");

  return (
    <Dropdown
      label="Position"
      value={position}
      options={[
        { value: "top-left", label: "Top left" },
        { value: "top-right", label: "Top right" },
        { value: "bottom-left", label: "Bottom left" },
        { value: "bottom-right", label: "Bottom right" },
      ]}
      onChange={setPosition}
    />
  );
}

---

Slider

A range input for selecting a numeric value within a range.

Props

Prop	Type	Required	Description
label	string	Yes	Input label
value	number	Yes	Current value
min	number	Yes	Minimum value
max	number	Yes	Maximum value
onChange	(value: number) => void	Yes	Change handler
step	number	No	Increment step (default: 1)
showValue	boolean	No	Show current value next to label (default: true)
disabled	boolean	No	Prevents interaction
style	VisionStyle	No	Additional style

Layer behavior: Shows current numeric value as plain text.

Example

import { Slider, useExtensionStorage } from "@zaflun/lumio-sdk";

function OpacitySlider() {
  const [opacity, setOpacity] = useExtensionStorage("opacity", 100);

  return (
    <Slider
      label="Opacity"
      value={opacity}
      min={0}
      max={100}
      step={5}
      onChange={setOpacity}
    />
  );
}