Druid-Extension/api/components/widgets/properties_panel/property_checkbox_api.md

druid.widget.property_checkbox API

at /druid/widget/properties_panel/properties/property_checkbox.lua

Functions

• init
• set_value
• get_value
• on_click
• set_text_property
• on_change

Fields

• root
• druid
• text_name
• button
• selected
• icon
• container
• on_change_value

init

---

property_checkbox:init()

set_value

---

property_checkbox:set_value(value, [is_instant])

• Parameters:
  • value (boolean):
  • [is_instant] (any):

get_value

---

property_checkbox:get_value()

• Returns:
  • `` (boolean):

on_click

---

property_checkbox:on_click()

set_text_property

---

property_checkbox:set_text_property(text)

Set the text property of the checkbox

• Parameters:
  • text (string):

on_change

---

property_checkbox:on_change(callback)

Set the callback function for when the checkbox value changes

• Parameters:
  • callback (function):

Fields

• root (node)

• druid (druid.instance): The Druid Factory used to create components

• text_name (druid.text): The component to handle text behaviour over a GUI Text node, mainly used to automatically adjust text size to fit the text area

• button (druid.button): Druid component to make clickable node with various interaction callbacks

• selected (node)

• icon (node)

• container (druid.container): The component used for managing the size and positions with other containers relations to create a adaptable layouts

• on_change_value (unknown)