Druid-Extension/api/components/custom/rich_input_api.md

druid.rich_input API

at /druid/custom/rich_input/rich_input.lua

The component that handles a rich text input field, it's a wrapper around the druid.input component

Functions

• init
• set_placeholder
• select
• set_text
• set_font
• get_text
• set_allowed_characters

Fields

• root
• input
• cursor
• cursor_text
• cursor_position
• druid
• is_lshift
• is_lctrl
• is_button_input_enabled
• drag
• placeholder
• text_position

init

---

rich_input:init(template, nodes)

• Parameters:
  • template (string): The template string name
  • nodes (table): Nodes table from gui.clone_tree

set_placeholder

---

rich_input:set_placeholder(placeholder_text)

Set placeholder text

• Parameters:

  • placeholder_text (string): The placeholder text

• Returns:

  • self (druid.rich_input): Current instance

select

---

rich_input:select()

Select input field

• Returns:
  • self (druid.rich_input): Current instance

set_text

---

rich_input:set_text(text)

Set input field text

• Parameters:

  • text (string): The input text

• Returns:

  • self (druid.rich_input): Current instance

set_font

---

rich_input:set_font(font)

Set input field font

• Parameters:

  • font (hash): The font hash

• Returns:

  • self (druid.rich_input): Current instance

get_text

---

rich_input:get_text()

Set input field text

• Returns:
  • `` (string):

set_allowed_characters

---

rich_input:set_allowed_characters(characters)

Set allowed charaters for input field. See: https://defold.com/ref/stable/string/ ex: [%a%d] for alpha and numeric

• Parameters:

  • characters (string): Regular expression for validate user input

• Returns:

  • self (druid.rich_input): Current instance

Fields

• root (node): The root node of the rich input

• input (druid.input): The input component

• cursor (node): The cursor node

• cursor_text (node): The cursor text node

• cursor_position (vector3): The position of the cursor

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

• is_lshift (boolean)

• is_lctrl (boolean)

• is_button_input_enabled (unknown)

• drag (druid.drag): A component that allows you to subscribe to drag events over a node

• placeholder (druid.text): Basic Druid text component. Text components by default have the text size adjusting.

• text_position (unknown)