Merge pull request #233 from Insality/develop

Merge Druid 0.11 to Master

.gitattributes

@@ -0,0 +1,18 @@
+# Defold GLSL Shaders
+*.fp linguist-language=GLSL
+*.vp linguist-language=GLSL
+
+# Defold Lua Files
+*.editor_script linguist-language=Lua
+*.render_script linguist-language=Lua
+*.script linguist-language=Lua
+*.gui_script linguist-language=Lua
+
+# Defold Files
+*.atlas linguist-language=JSON5
+*.collection linguist-language=JSON5
+*.font linguist-language=JSON5
+*.go linguist-language=JSON5
+*.gui linguist-language=JSON5
+*.tilemap linguist-language=JSON5
+*.tilesource linguist-language=JSON5

.github/FUNDING.yml

@@ -0,0 +1,5 @@
+# These are supported funding model platforms
+
+github: insality # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+ko_fi: insality # Replace with a single Ko-fi username
+custom: ['https://www.buymeacoffee.com/insality']

.gitignore

@@ -9,3 +9,5 @@ Thumbs.db
 .cproject
 builtins
 dist
+deployer_version_settings.txt
+.deployer_cache

.luacheckrc

@@ -2,7 +2,7 @@ std = "max"
 files['.luacheckrc'].global = false
 unused_args = false
 
-max_code_line_length = 90
+max_code_line_length = 120
 max_comment_line_length = false
 
 globals = {
@@ -45,7 +45,12 @@ globals = {
   "debug",
   "timer",
   "window",
-  "buffer", 
+  "buffer",
   "resource",
   "defos",
+  "html5",
+  "describe",
+  "before",
+  "after",
+  "it",
 }

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Maxim Tuprikov
+Copyright (c) 2021 Maxim Tuprikov
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,161 +1,153 @@
+
 [![](media/druid_logo.png)](https://insality.github.io/druid/)
 
+[![Github-sponsors](https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#EA4AAA)](https://github.com/sponsors/insality) [![Ko-Fi](https://img.shields.io/badge/Ko--fi-F16061?style=for-the-badge&logo=ko-fi&logoColor=white)](https://ko-fi.com/insality) [![BuyMeACoffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-ffdd00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black)](https://www.buymeacoffee.com/insality)
+
 [![GitHub release (latest by date)](https://img.shields.io/github/v/release/insality/druid)](https://github.com/Insality/druid/releases)
-[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/insality/druid/Run%20tests)](https://github.com/Insality/druid/actions)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/insality/druid/ci-workflow.yml?branch=master)](https://github.com/Insality/druid/actions)
 [![codecov](https://codecov.io/gh/Insality/druid/branch/master/graph/badge.svg)](https://codecov.io/gh/Insality/druid)
 
-**Druid** - powerful Defold component UI library. Use basic and extended **Druid** components or make your own game-specific components to make amazing GUI in your games.
+**Druid** - powerful **Defold** component UI framework that empowers developers to create stunning and customizable GUIs by leveraging a wide range of embedded components or effortlessly designing their own game-specific components.
 
+Try the [**HTML5 version**](https://insality.github.io/druid/druid/) of the **Druid** example app.
 
 ## Setup
 
 ### Dependency
 
-You can use the **Druid** extension in your own project by adding this project as a [Defold library dependency](https://www.defold.com/manuals/libraries/). Open your game.project file and in the dependencies field under project add:
+To integrate the **Druid** extension into your own project, add this project as a [dependency](https://www.defold.com/manuals/libraries/) in your **Defold** game. Open your `game.project` file and add the following line to the dependencies field under the project section:
 
-> [https://github.com/Insality/druid/archive/master.zip](https://github.com/Insality/druid/archive/master.zip)
+**Druid v0.11.0**
 
-Or point to the ZIP file of a [specific release](https://github.com/Insality/druid/releases).
+> [https://github.com/Insality/druid/archive/refs/tags/0.11.0.zip](https://github.com/Insality/druid/archive/refs/tags/0.11.0.zip)
 
-### Input bindings
+Here is a list of [all releases](https://github.com/Insality/druid/releases).
 
-**Druid** requires the following input bindings:
+Size: **67.16 KB**
 
-- Mouse trigger - `Button 1` -> `touch` _For basic input components_
-- Key trigger - `Backspace` -> `key_backspace`  _For back_handler component, input component_
-- Key trigger - `Back` -> `key_back`  _For back_handler component, Android back button, input component_
-- Key trigger - `Enter` -> `key_enter` _For input component, optional_
-- Key trigger - `Esc` -> `key_esc` _For input component, optional_
-- Touch triggers - `Touch multi` -> `multitouch` _For scroll component_
+> The size metrics exlcude the extended components, which are including only on demand.
 
-![](media/input_binding_2.png)
-![](media/input_binding_1.png)
+### Input Bindings
+**Druid** utilizes the `/builtins/input/all.input_binding` input bindings. For custom input bindings, refer to the Input Binding section in the  **_[Advanced Setup](docs_md/advanced-setup.md#input-bindings)_**.
 
 
-### Input capturing [optional]
+## Usage
 
-By default, **Druid** will auto-capture input focus, if any input component will be created. So you don't need to call `msg.post(".", "acquire_input_focus")`
+### Basic usage
 
-If you don't need this behaviour, you can disable it by settings `druid.no_auto_input` field in _game.project_:
-```
-[druid]
-no_auto_input = 1
-```
+To utilize **Druid**, begin by creating a **Druid** instance to instantiate components and include the main functions of **Druid**: *update*, *final*, *on_message*, and *on_input*.
 
-### Code [optional]
+When using **Druid** components, provide a node name string as an argument. If you don't have the node name available in some cases, you can pass `gui.get_node()` instead.
 
-Adjust **Druid** settings, if needed:
-```lua
-local druid = require("druid.druid")
-
--- Used for button component and custom components
--- Callback should play sound by name
-druid.set_sound_function(callback)
-
--- Used for lang_text component
--- Callback should return localized string by locale id
-druid.set_text_function(callback)
-
--- Used for change default druid style
-druid.set_default_style(your_style)
-
--- Call this function on language changing in the game,
--- to retranslate all lang_text components:
-druid.on_language_change()
-
--- Call this function inside window.set_listener
--- to catch game focus lost/gained callbacks:
-druid.on_window_callback(event)
-```
-
-
-## Components
-
-**Druid** provides the following *basic* components:
-
-- **[Button](docs_md/01-components.md#button)** - Basic Druid button input component. Handles all types of interactions (tap, long-tap, hold-tap, double-tap, simple key triggers, etc)
-
-- **[Text](docs_md/01-components.md#text)** - Basic Druid text component. Wrap on gui text node, handle text size adjusting.
-
-- **[Scroll](docs_md/01-components.md#scroll)** - Basic Druid scroll component
-
-- **[Blocker](docs_md/01-components.md#blocker)** - Block input in node zone component
-
-- **[Back Handler](docs_md/01-components.md#back-handler)** - Handle back button (Android back button, backspace key)
-
-- **[Static Grid](docs_md/01-components.md#static-grid)** - Component to manage node positions with equal sizes
-
-- **[Hover](docs_md/01-components.md#hover)** - System Druid component, handle hover node state
-
-- **[Swipe](docs_md/01-components.md#swipe)** - System Druid component, handle swipe gestures on node
-
-- **[Drag](docs_md/01-components.md#drag)** - System Druid component, handle drag input on node 
-
-**Druid** also provides the following *extended* components:
-
-***Note**: In the future, to use extended components, you should register them first. This is required to make **Druid** modular - to exclude unused components from builds*
-
-- **[Checkbox](docs_md/01-components.md#checkbox)** - Checkbox component
-
-- **[Checkbox group](docs_md/01-components.md#checkbox-group)** - Several checkboxes in one group
-
-- **[Dynamic Grid](docs_md/01-components.md#dynamic-grid)** - Component to manage node positions with different sizes. Only in one row or column
-
-- **[Input](docs_md/01-components.md#input)** - User text input component
-
-- **[Lang text](docs_md/01-components.md#lang-text)** - Wrap on Text component to handle localization
-
-- **[Progress](docs_md/01-components.md#progress)** - Progress bar component
-
-- **[Radio group](docs_md/01-components.md#radio-group)** - Several checkboxes in one group with a single choice
-
-- **[Slider](docs_md/01-components.md#slider)** - Slider component
-
-- **[Timer](docs_md/01-components.md#timer)** - Handle timer work on gui text node
-
-For a complete overview, see: _[components.md](docs_md/01-components.md)_.
-
-
-## Basic usage
-
-To use **Druid**, first you should create a Druid instance to spawn components and add Druids main engine functions: *update*, *final*, *on_message* and *on_input*.
-
-All **Druid** components take node name string as arguments, don't do `gui.get_node()` before.
-
-All **Druid** and component methods are called with `:` like `self.druid:new_button()`.
+All **Druid** and component methods are invoked using the `:` operator, such as `self.druid:new_button()`.
 
 ```lua
 local druid = require("druid.druid")
 
-local function button_callback(self)
-    print("Button was clicked!")
+-- All component callbacks pass "self" as first argument
+-- This "self" is a context data passed in `druid.new(context)`
+local function on_button_callback(self)
+    print("The button clicked!")
 end
 
 function init(self)
     self.druid = druid.new(self)
-    self.druid:new_button("button_node_name", button_callback)
+    self.button = self.druid:new_button("button_node_name", on_button_callback)
 end
 
+-- "final" is a required function for the correct Druid workflow
 function final(self)
     self.druid:final()
 end
 
+-- "update" is used in progress bar, scroll, and timer basic components
+function update(self, dt)
+    self.druid:update(dt)
+end
+
+-- "on_message" is used for specific Druid events, like language change or layout change
 function on_message(self, message_id, message, sender)
     self.druid:on_message(message_id, message, sender)
 end
 
-
+-- "on_input" is used in almost all Druid components
+-- The return value from `druid:on_input` is required!
 function on_input(self, action_id, action)
     return self.druid:on_input(action_id, action)
 end
 
 ```
 
-For all **Druid** instance functions, [see here](https://insality.github.io/druid/modules/druid_instance.html).
+For all **Druid** instance functions, [see here](https://insality.github.io/druid/modules/DruidInstance.html).
+
+
+### API Documentation
+
+**Druid** offers a wide range of components and functions. To facilitate usage, **Druid** provides comprehensive API documentation with examples and annotations.
+
+Start reading the API documentation [here](https://insality.github.io/druid/modules/Druid.html).
+
+**Druid** provide the *EmmyLua* annotations to add autocomplete inside your IDE. Check [EmmyLua Setup here](docs_md/advanced-setup.md#emmylua-annotations).
+
+
+### Create custom components
+
+If you want to create your own components, refer to the [Create Custom Components](docs_md/02-creating_custom_components.md) section in the documentation.
+
+Custom components are one of the most powerful features of **Druid**. They allow you to create your own components effortlessly and utilize them in your game.
+
+
+## Druid Components
+
+Here is full **Druid** components list.
+
+### Basic Components
+
+> Basic components always included in the build and available for use.
+
+| Name | Description | Example | <div style="width:200px">Preview</div> |
+|------|-------------|---------|---------|
+| **[Button](https://insality.github.io/druid/modules/Button.html)** | Logic over GUI Node. Handle the user click interactions: click, long click, double click, etc. | [Button Example](https://insality.github.io/druid/druid/?example=general_buttons) | <img src="media/preview/button.gif" width="200" height="100"> |
+| **[Text](https://insality.github.io/druid/modules/Text.html)** | Logic over GUI Text. By default Text component fit the text inside text node size area with different adjust modes. | [Text Example](https://insality.github.io/druid/druid/?example=texts_general) | <img src="media/preview/text.gif" width="200" height="100"> |
+| **[Scroll](https://insality.github.io/druid/modules/Scroll.html)** | Logic over two GUI Nodes: input and content. Provides basic behaviour for scrollable content. | [Scroll Example](https://insality.github.io/druid/druid/?example=general_scroll) | <img src="media/preview/scroll.gif" width="200" height="100"> |
+| **[Blocker](https://insality.github.io/druid/modules/Blocker.html)** | Logic over GUI Node. Don't pass any user input below node area size. | ❌ | |
+| **[Back Handler](https://insality.github.io/druid/modules/BackHandler.html)** | Call callback on user "Back" action. It's a Android back button or keyboard backspace key | ❌ | |
+| **[Static Grid](https://insality.github.io/druid/modules/StaticGrid.html)** | Logic over GUI Node. Component to manage node positions with all equal node sizes. | [Static Gid Example](https://insality.github.io/druid/druid/?example=general_grid) | <img src="media/preview/static_grid.gif" width="200" height="100"> |
+| **[Hover](https://insality.github.io/druid/modules/Hover.html)** | Logic over GUI Node. Handle hover action over node. For both: mobile touch and mouse cursor. | ❌ | <img src="media/preview/hover.gif" width="200" height="100"> |
+| **[Swipe](https://insality.github.io/druid/modules/Swipe.html)** | Logic over GUI Node. Handle swipe gestures over node. | [Swipe Example](https://insality.github.io/druid/druid/?example=general_swipe) | <img src="media/preview/swipe.gif" width="200" height="100"> |
+| **[Drag](https://insality.github.io/druid/modules/Drag.html)** | Logic over GUI Node. Handle drag input actions. Can be useful to make on screen controlls. | [Drag Example](https://insality.github.io/druid/druid/?example=general_drag) | <img src="media/preview/drag.gif" width="200" height="100"> |
+
+
+### Extended components
+
+> Extended components before usage should be registered in **Druid** with [`druid.register()`](https://insality.github.io/druid/modules/Druid.html#druid.register) function.
+> On usage of unregistered **Druid** component the next log will be shown in the console.
+```
+local data_list = require("druid.extended.data_list")
+druid.register("data_list", data_list)
+```
+
+| Name | Description | Example | <div style="width:200px">Preview</div> |
+|------|-------------|---------|---------|
+| **[Checkbox](https://insality.github.io/druid/modules/Checkbox.html)** | Switch node state on click event. | [Checkbox Example](https://insality.github.io/druid/druid/?example=general_checkboxes) | <img src="media/preview/checkbox.gif" width="200" height="100"> |
+| **[Checkbox group](https://insality.github.io/druid/modules/CheckboxGroup.html)** | Group of checkbox components. | [Checkbox group Example](https://insality.github.io/druid/druid/?example=general_checkboxes) | <img src="media/preview/checkbox_group.gif" width="200" height="100"> |
+| **[Radio group](https://insality.github.io/druid/modules/RadioGroup.html)** | Like checkbox group but with single choise only. | [Radio Group Example](https://insality.github.io/druid/druid/?example=general_checkboxes) | <img src="media/preview/radio_group.gif" width="200" height="100"> |
+| **[Dynamic Grid](https://insality.github.io/druid/modules/DynamicGrid.html)** | Logic over GUI Node. Component to manage node positions with all different node sizes. Only one direction: horizontal or vertical. | [Dynamic Grid Example](https://insality.github.io/druid/druid/?example=general_grid) | <img src="media/preview/dynamic_grid.gif" width="200" height="100"> |
+| **[Data List](https://insality.github.io/druid/modules/DataList.html)** | Logic over Scroll and Grid components. Create only visible GUI nodes or components to make "infinity" scroll befaviour | [Data List Example](https://insality.github.io/druid/druid/?example=general_data_list) | <img src="media/preview/data_list.gif" width="200" height="100"> |
+| **[Input](https://insality.github.io/druid/modules/Input.html)** | Logic over GUI Node and GUI Text (or Text component). Provides basic user text input. | [Input Example](https://insality.github.io/druid/druid/?example=general_input) | <img src="media/preview/input.gif" width="200" height="100"> |
+| **[Lang text](https://insality.github.io/druid/modules/LangText.html)** | Logic over Text component to handle localization. Can be translated in real-time with `druid.on_language_change` | ❌ | <img src="media/preview/lang_text.gif" width="200" height="100"> |
+| **[Progress](https://insality.github.io/druid/modules/Progress.html)** | Logic over GUI Node. Handle node size and scale to handle progress node size. | [Progress Example](https://insality.github.io/druid/druid/?example=general_progress_bar) | <img src="media/preview/progress.gif" width="200" height="100"> |
+| **[Slider](https://insality.github.io/druid/modules/Slider.html)** | Logic over GUI Node. Handle draggable node with position restrictions. | [Slider Example](https://insality.github.io/druid/druid/?example=general_sliders) | <img src="media/preview/slider.gif" width="200" height="100"> |
+| **[Timer](https://insality.github.io/druid/modules/Timer.html)** | Logic over GUI Text. Handle basic timer functions. | ❌ | <img src="media/preview/timer.gif" width="200" height="100"> |
+| **[Hotkey](https://insality.github.io/druid/modules/Hotkey.html)** | Allow to set callbacks for keyboard hotkeys with key modificators. | [Hotkey Example](https://insality.github.io/druid/druid/?example=general_hotkey) | <img src="media/preview/hotkey.gif" width="200" height="100"> |
+| **[Layout](https://insality.github.io/druid/modules/Layout.html)** | Logic over GUI Node. Handle node size depends on layout mode and screen aspect ratio. Contains helpers to build more complex UI layout. | [Layout Example](https://insality.github.io/druid/druid/?example=general_layout) | <img src="media/preview/layout.gif" width="200" height="100"> |
+
+For a complete overview, see: **_[components.md](docs_md/01-components.md)_**.
+
 
 ## Druid Events
 
-Any **Druid** components as callbacks use [Druid Events](https://insality.github.io/druid/modules/druid_event.html). In component API ([button example](https://insality.github.io/druid/modules/druid.button.html#Events)) pointed list of component events. You can manually subscribe to those events with the following API:
+Any **Druid** components as callbacks use [Druid Events](https://insality.github.io/druid/modules/DruidEvent.html). In component API ([button example](https://insality.github.io/druid/modules/Button.html#on_click)) pointed list of component events. You can manually subscribe to these events with the following API:
 
 - **event:subscribe**(callback)
 
@@ -165,79 +157,37 @@ Any **Druid** components as callbacks use [Druid Events](https://insality.github
 
 You can subscribe several callbacks to a single event.
 
-## Druid Lifecycle
-
-Here is full Druid lifecycle setup for your ***.gui_script** file:
-```lua
-local druid = require("druid.druid")
-
-function init(self)
-    self.druid = druid.new(self)
-end
-
-function final(self)
-    self.druid:final()
-end
-
-function update(self, dt)
-    self.druid:update(dt)
-end
-
-function on_input(self, action_id, action)
-    return self.druid:on_input(action_id, action)
-end
-
-function on_message(self, message_id, message, sender)
-    self.druid:on_message(message_id, message, sender)
-end
-```
-
-- *final* is a **required** function for a correct Druid lifecycle
-- *on_input* is used in almost all Druid components
-- *update* in used in progress bar, scroll and timer base components
-- *on_message* is used for specific Druid events, like language change or layout change
-
-It is recommended to fully integrate all **Druid** lifecycles functions.
-
-
 ## Details
 
-- Druid input goes as stack. Last created button will checked first. So create your GUI from back
-- Don't forget about `return` in `on_input`: `return self.druid:on_input()`. It is needed if you have more than 1 acquire inputs (several Druid, other input system, etc)
-- By default, Druid will automatically _acquire_input_focus_. So you don't need do it manually. But only if you have components which require _on_input_
-- If you want to delete a node which has a Druid component, don't forget to remove it via `druid:remove(component)`
-
-[See full FAQ here](docs_md/FAQ.md)
+- **Druid** processes input in a stack-based manner. The most recently created button will be checked first. Create your input GUI components from back to front.
+- Remember to include `return` in the `on_input` function: `return self.druid:on_input()`. This is necessary if you have multiple input sources (multiple Druid instances, other input systems, etc.).
+- Druid automatically calls `acquire_input_focus` if you have input components. Therefore, manual calling of `acquire_input_focus` is not required.
+- When deleting a **Druid** component node, make sure to remove it using `druid:remove(component)`.
 
 
 ## Examples
 
-See the [example folder](https://github.com/Insality/druid/tree/develop/example) for examples of how to use **Druid**
+Try the [**HTML5 version**](https://insality.github.io/druid/druid/) of the **Druid** example app.
 
-See the [druid-assets repository](https://github.com/insality/druid-assets) for examples of how to create custom components and styles
+Each example page provides a direct link to the corresponding example code, making it easier for you to understand how to use **Druid**.
 
-Try the [HTML5 version](https://insality.github.io/druid/druid/) of the example app
+Or refer directly to the [**example folder**](https://github.com/Insality/druid/tree/develop/example) for code examples demonstrating how to use **Druid**.
 
+If you want to see examples of GUIs created with Druid, please refer to the [game_examples.md](docs_md/game_examples.md) file.
 
 ## Documentation
 
 To better understand **Druid**, read the following documentation:
+- [How To GUI in Defold](https://forum.defold.com/t/how-to-gui-in-defold/73256)
 - [Druid components](docs_md/01-components.md)
 - [Create custom components](docs_md/02-creating_custom_components.md)
 - [See FAQ article](docs_md/FAQ.md)
 - [Druid styles](docs_md/03-styles.md)
-- [Druid asset store](docs_md/04-druid_assets.md)
 
-You can fund the full **Druid** documentation here:
-https://insality.github.io/druid/
+You can find the full **Druid** [documentation here](https://insality.github.io/druid/modules/Druid.html).
 
 
-## Games powered by Druid
-
-_You published your game and you using Druid? Note me!_
-
-
-## License
+## Licenses
 
 - Developed and supported by [Insality](https://github.com/Insality)
 - Original idea by [AGulev](https://github.com/AGulev)
@@ -247,3 +197,14 @@ _You published your game and you using Druid? Note me!_
 ## Issues and suggestions
 
 If you have any issues, questions or suggestions please [create an issue](https://github.com/Insality/druid/issues) or contact me: [insality@gmail.com](mailto:insality@gmail.com)
+
+
+## History
+For a complete history of the development of **Druid**, please check the [changelog](docs_md/changelog.md).
+
+
+## ❤️ Support project ❤️
+
+Your donation helps me stay engaged in creating valuable projects for **Defold**. If you appreciate what I'm doing, please consider supporting me!
+
+[![Github-sponsors](https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#EA4AAA)](https://github.com/sponsors/insality) [![Ko-Fi](https://img.shields.io/badge/Ko--fi-F16061?style=for-the-badge&logo=ko-fi&logoColor=white)](https://ko-fi.com/insality) [![BuyMeACoffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-ffdd00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black)](https://www.buymeacoffee.com/insality)

config.ld

@@ -1,16 +1,19 @@
 project='Druid'
-title='Defold Druid UI Library'
-description='Documentation for Druid Library'
+title='Defold Druid UI Framework'
+description='Documentation for Druid Framework'
 file={"./druid",
 	exclude = {
 		"./druid/styles/",
-		"./druid/system/middleclass.lua"
+		"./druid/system/middleclass.lua",
+		"./druid/templates/",
+		"./druid/annotations.lua",
+		"./druid/custom/rich_text/module",
 	}
 }
 package='druid'
-sort=false
+sort=true
 dir='./docs'
 style='!fixed'
 topics={}
 use_markdown_titles=true
-no_space_before_args=true
+no_space_before_args=true

deployer_build_stats.csv

@@ -0,0 +1,18 @@
+date,sha,version,build_size,build_time,platform,mode,is_cache_using,commits_count
+2022-02-28T19:06:43Z,3b329f9c25c9672e4030edb039b0225fa46f7ce1,0.8.521,4356,68,armv7-android,debug,true,521
+2022-02-28T19:14:56Z,3b329f9c25c9672e4030edb039b0225fa46f7ce1,0.8.521,4356,51,armv7-android,debug,true,521
+2022-02-28T19:16:23Z,3b329f9c25c9672e4030edb039b0225fa46f7ce1,0.8.521,4356,11,armv7-android,debug,true,521
+2022-02-28T19:19:46Z,3b329f9c25c9672e4030edb039b0225fa46f7ce1,0.8.521,4356,11,armv7-android,debug,true,521
+2022-02-28T19:22:51Z,3b329f9c25c9672e4030edb039b0225fa46f7ce1,0.8.521,4356,11,armv7-android,debug,true,521
+2022-03-12T10:01:30Z,d0f3d6641a08b0d6b719b13017aa85907d1667e5,0.8.564,2200,44,js-web,release,true,564
+2022-08-29T18:27:58Z,b2643ebd268b15884363efd17724e689279946f1,0.9.589,2316,45,js-web,release,true,589
+2022-08-29T18:46:47Z,13003e472169cbd261e703eca7b133adf64a24f7,0.9.592,2316,40,js-web,release,true,592
+2022-09-09T17:55:42Z,072507cc9e715541bdee7636d2e5eeeb3c22a57d,0.10.603,2340,43,js-web,release,true,603
+2022-09-09T18:00:07Z,072507cc9e715541bdee7636d2e5eeeb3c22a57d,0.10.603,2340,5,js-web,release,true,603
+2023-07-05T20:19:22Z,d0062c2a78e618871ebb4c8ee66b1509b763f069,0.10.671,3292,12,x86_64-linux,headless,true,671
+2023-07-13T18:37:07Z,1cbe57376397a8352bbafcc67de0b6f95ae37b35,0.10.682,2496,53,js-web,release,true,682
+2023-07-13T19:31:47Z,ea185622702e6691275187741b1e2ee0c7f079ec,0.11.686,2452,51,js-web,release,true,686
+2023-07-15T12:56:18Z,556e1a9bae620e2df290b10287fa8d0f64d47293,0.11.690,2468,51,js-web,release,true,690
+2023-08-05T16:02:55Z,628723386eb3875f7190d079a2e7c510d044a311,0.11.692,2456,40,js-web,release,true,692
+2023-08-05T16:31:19Z,37fff52aa59feb20f761ef4d340d9f677743d54b,0.11.693,2456,43,js-web,release,true,693
+2023-08-05T16:41:25Z,d7dd4a86b81d73d345ad7e136de9c2c488bc4d8b,0.11.694,2452,43,js-web,release,true,694

docs/druid/archive/archive_files.json

@@ -1 +1 @@
-{"content":[{"name":"game.projectc","size":3432,"pieces":[{"name":"game.projectc0","offset":0}]},{"name":"game.arci","size":10608,"pieces":[{"name":"game.arci0","offset":0}]},{"name":"game.arcd","size":384566,"pieces":[{"name":"game.arcd0","offset":0}]},{"name":"game.dmanifest","size":23386,"pieces":[{"name":"game.dmanifest0","offset":0}]},{"name":"game.public.der","size":162,"pieces":[{"name":"game.public.der0","offset":0}]}]}
+{"content":[{"name":"game.projectc","size":4114,"pieces":[{"name":"game.projectc0","offset":0}]},{"name":"game.arci","size":23008,"pieces":[{"name":"game.arci0","offset":0}]},{"name":"game.arcd","size":607568,"pieces":[{"name":"game.arcd0","offset":0}]},{"name":"game.dmanifest","size":24253,"pieces":[{"name":"game.dmanifest0","offset":0}]},{"name":"game.public.der","size":162,"pieces":[{"name":"game.public.der0","offset":0}]}]}

docs/druid/archive/game.projectc0

@@ -1,23 +1,25 @@
 [project]
 title = druid
-version = 0.6.459
+version = 0.11.694
 write_log = 0
 compress_archive = 1
 publisher = Insality
 developer = Insality
-commit_sha = 015564f5b3e0d5e63e422056c69e53826ed689bf
-build_time = 2021-04-05T21:00:43Z
+commit_sha = d7dd4a86b81d73d345ad7e136de9c2c488bc4d8b
+build_date = 2023-08-05T16:41:25Z
+title_as_file_name = druid
 
 [display]
 width = 600
 height = 900
-high_dpi = 0
+high_dpi = 1
 samples = 0
 fullscreen = 0
 update_frequency = 0
+swap_interval = 1
 vsync = 1
-display_profiles = /builtins/render/default.display_profilesc
-dynamic_orientation = 0
+display_profiles = /example/custom.display_profilesc
+dynamic_orientation = 1
 display_device_info = 0
 
 [render]
@@ -28,6 +30,8 @@ clear_color_alpha = 0
 
 [physics]
 type = 2D
+max_collision_object_count = 128
+use_fixed_timestep = 0
 gravity_y = -10
 debug = 0
 debug_alpha = 0.9
@@ -35,7 +39,7 @@ world_count = 4
 gravity_x = 0
 gravity_z = 0
 scale = 1
-allow_dynamic_transforms = 0
+allow_dynamic_transforms = 1
 debug_scale = 30
 max_collisions = 64
 max_contacts = 128
@@ -43,6 +47,8 @@ contact_impulse_limit = 0
 ray_cast_limit_2d = 64
 ray_cast_limit_3d = 128
 trigger_overlap_capacity = 16
+velocity_threshold = 1
+max_fixed_timesteps = 2
 
 [bootstrap]
 main_collection = /example/example.collectionc
@@ -51,11 +57,11 @@ render = /builtins/render/default.renderc
 [graphics]
 default_texture_min_filter = linear
 default_texture_mag_filter = linear
-max_draw_calls = 1024
+max_draw_calls = 128
 max_characters = 8192
 max_debug_vertices = 10000
 texture_profiles = /example/custom.texture_profiles
-verify_graphics_calls = 1
+verify_graphics_calls = 0
 memory_size = 512
 
 [shader]
@@ -82,17 +88,15 @@ game_binding = /input/game.input_bindingc
 use_accelerometer = 0
 
 [sprite]
-max_count = 128
+max_count = 16
 subpixels = 1
 
-[spine]
-max_count = 128
-
 [model]
-max_count = 128
+max_count = 0
+split_meshes = 0
 
 [mesh]
-max_count = 128
+max_count = 0
 
 [gui]
 max_count = 64
@@ -100,68 +104,79 @@ max_particlefx_count = 64
 max_particle_count = 1024
 
 [collection]
-max_instances = 1024
+max_instances = 128
 max_input_stack_entries = 16
 
 [collection_proxy]
 max_count = 8
 
 [collectionfactory]
-max_count = 128
+max_count = 64
 
 [factory]
-max_count = 128
+max_count = 16
 
 [ios]
 launch_screen = /builtins/manifests/ios/LaunchScreen.storyboardc
 pre_renderered_icons = 0
 bundle_identifier = example.unnamed
+bundle_name = 
 infoplist = /builtins/manifests/ios/Info.plist
 default_language = en
 localizations = en
 
 [android]
-version_code = 459
-minimum_sdk_version = 16
-target_sdk_version = 29
+version_code = 694
+minimum_sdk_version = 19
+target_sdk_version = 33
 package = com.insality.druid
+gcm_sender_id = 
 manifest = /builtins/manifests/android/AndroidManifest.xml
 iap_provider = GooglePlay
 input_method = HiddenInputField
 immersive_mode = 0
 display_cutout = 1
 debuggable = 0
+proguard = 
 
 [osx]
+app_icon = 
 infoplist = /builtins/manifests/osx/Info.plist
 bundle_identifier = example.unnamed
+bundle_name = 
 bundle_version = 1
 default_language = en
 localizations = en
 
 [windows]
+app_icon = 
 
 [html5]
 custom_heap_size = 0
 heap_size = 64
 htmlfile = /builtins/manifests/web/engine_template.html
-cssfile = /builtins/manifests/web/light_theme.css
+cssfile = /example/light_theme.css
+splash_image = /media/druid_logo.png
 archive_location_prefix = archive
+archive_location_suffix = 
+engine_arguments = --verify-graphics-calls=false
+wasm_streaming = 0
 show_fullscreen_button = 0
 show_made_with_defold = 0
+show_console_banner = 1
 scale_mode = fit
-engine_arguments = --verify-graphics-calls=false
-splash_image = /media/druid_logo.png
 
 [particle_fx]
-max_count = 64
-max_particle_count = 1024
+max_count = 0
+max_emitter_count = 0
+max_particle_count = 0
 
 [iap]
 auto_finish_transactions = 1
 
 [network]
 http_timeout = 0
+ssl_certificates = 
 http_thread_count = 4
 http_cache_enabled = 1
 
@@ -172,25 +187,39 @@ include_dirs = druid
 shared_state = 1
 
 [label]
-max_count = 64
+max_count = 0
 subpixels = 1
 
 [profiler]
 track_cpu = 0
+sleep_between_server_updates = 0
 
 [liveupdate]
 settings = /liveupdate.settings
 enabled = 1
 
 [tilemap]
-max_count = 16
-max_tile_count = 2048
+max_count = 0
+max_tile_count = 0
 
 [engine]
 run_while_iconified = 0
+fixed_update_frequency = 60
 
 [druid]
 no_auto_input = 0
+no_stencil_check = 0
+no_auto_template = 0
+input_text = text
+input_touch = touch
+input_marked_text = marked_text
+input_key_esc = key_esc
+input_key_back = key_back
+input_key_enter = key_enter
+input_key_backspace = key_backspace
+input_multitouch = touch_multi
+input_scroll_up = mouse_wheel_up
+input_scroll_down = mouse_wheel_down
 
 [native_extension]
 app_manifest = /example/game.appmanifest

docs/druid/dmloader.js

@@ -30,7 +30,7 @@ var FileLoader = {
                         return;
                     }
                     currentAttempt = currentAttempt + 1;
-                    setTimeout(obj.send, FileLoader.options.retryInterval);
+                    setTimeout(obj.send.bind(obj), FileLoader.options.retryInterval);
                 };
                 xhr.onload = function(e) {
                     if (onload) onload(xhr, e);
@@ -102,20 +102,12 @@ var FileLoader = {
 
 var EngineLoader = {
     wasm_size: 2000000,
-    wasm_from: 0,
-    wasm_to: 40,
-
     wasmjs_size: 250000,
-    wasmjs_from: 40,
-    wasmjs_to: 50,
-
     asmjs_size: 4000000,
-    asmjs_from: 0,
-    asmjs_to: 50,
 
-    // load .wasm and set Module.instantiateWasm to use the loaded .wasm file
-    // https://github.com/emscripten-core/emscripten/blob/master/tests/manual_wasm_instantiate.html#L170
-    loadWasmAsync: function(src, fromProgress, toProgress, callback) {
+    stream_wasm: false,
+
+    loadAndInstantiateWasmAsync: function(src, fromProgress, toProgress, callback) {
         FileLoader.load(src, "arraybuffer", EngineLoader.wasm_size,
             function(loaded, total) { Progress.calculateProgress(fromProgress, toProgress, loaded, total); },
             function(error) { throw error; },
@@ -133,29 +125,79 @@ var EngineLoader = {
             });
     },
 
+    setupWasmStreamAsync: async function(src, fromProgress, toProgress) {
+        // https://stackoverflow.com/a/69179454
+        var fetchFn = fetch;
+        if (typeof TransformStream === "function" && ReadableStream.prototype.pipeThrough) {
+            async function fetchWithProgress(path) {
+                const response = await fetch(path);
+                // May be incorrect if compressed
+                const contentLength = response.headers.get("Content-Length");
+                const total = parseInt(contentLength, 10);
+
+                let bytesLoaded = 0;
+                const ts = new TransformStream({
+                    transform (chunk, controller) {
+                        bytesLoaded += chunk.byteLength;
+                        Progress.calculateProgress(fromProgress, toProgress, bytesLoaded, total);
+                        controller.enqueue(chunk)
+                    }
+                });
+
+                return new Response(response.body.pipeThrough(ts), response);
+            }
+            fetchFn = fetchWithProgress;
+        }
+
+        Module.instantiateWasm = function(imports, successCallback) {
+            WebAssembly.instantiateStreaming(fetchFn(src), imports).then(function(output) {
+                Progress.calculateProgress(fromProgress, toProgress, 1, 1);
+                successCallback(output.instance);
+            }).catch(function(e) {
+                console.log('wasm streaming instantiation failed! ' + e);
+                throw e;
+            });
+            return {}; // Compiling asynchronously, no exports.
+        }
+    },
+
+    // instantiate the .wasm file either by streaming it or first loading and then instantiate it
+    // https://github.com/emscripten-core/emscripten/blob/master/tests/manual_wasm_instantiate.html#L170
+    loadWasmAsync: function(exeName) {
+        if (EngineLoader.stream_wasm && (typeof WebAssembly.instantiateStreaming === "function")) {
+            EngineLoader.setupWasmStreamAsync(exeName + ".wasm", 10, 50);
+            EngineLoader.loadAndRunScriptAsync(exeName + '_wasm.js', EngineLoader.wasmjs_size, 0, 10);
+        }
+        else {
+            EngineLoader.loadAndInstantiateWasmAsync(exeName + ".wasm", 0, 40, function() {
+                EngineLoader.loadAndRunScriptAsync(exeName + '_wasm.js', EngineLoader.wasmjs_size, 40, 50);
+            });
+        }
+    },
+
+    loadAsmJsAsync: function(exeName) {
+        EngineLoader.loadAndRunScriptAsync(exeName + '_asmjs.js', EngineLoader.asmjs_size, 0, 50);
+    },
+
     // load and start engine script (asm.js or wasm.js)
-    loadScriptAsync: function(src, estimatedSize, fromProgress, toProgress) {
+    loadAndRunScriptAsync: function(src, estimatedSize, fromProgress, toProgress) {
         FileLoader.load(src, "text", estimatedSize,
             function(loaded, total) { Progress.calculateProgress(fromProgress, toProgress, loaded, total); },
             function(error) { throw error; },
             function(response) {
                 var tag = document.createElement("script");
                 tag.text = response;
-                document.head.appendChild(tag);
+                document.body.appendChild(tag);
             });
     },
 
     // load engine (asm.js or wasm.js + wasm)
-    // engine load progress goes from 1-50% for ams.js
-    // engine load progress goes from 0-40% for .wasm and 40-50% for wasm.js
     load: function(appCanvasId, exeName) {
         Progress.addProgress(Module.setupCanvas(appCanvasId));
         if (Module['isWASMSupported']) {
-            EngineLoader.loadWasmAsync(exeName + ".wasm", EngineLoader.wasm_from, EngineLoader.wasm_to, function(wasm) {
-                EngineLoader.loadScriptAsync(exeName + '_wasm.js', EngineLoader.wasmjs_size, EngineLoader.wasmjs_from, EngineLoader.wasmjs_to);
-            });
+            EngineLoader.loadWasmAsync(exeName);
         } else {
-            EngineLoader.loadScriptAsync(exeName + '_asmjs.js', EngineLoader.asmjs_size, EngineLoader.asmjs_from, EngineLoader.asmjs_to);
+            EngineLoader.loadAsmJsAsync(exeName);
         }
     }
 }
@@ -457,35 +499,6 @@ var Progress = {
     }
 };
 
-/* ********************************************************************* */
-/* Default input override                                                */
-/* ********************************************************************* */
-
-var CanvasInput = {
-    arrowKeysHandler : function(e) {
-        switch(e.keyCode) {
-            case 37: case 38: case 39:  case 40: // Arrow keys
-            case 32: e.preventDefault(); e.stopPropagation(); // Space
-            default: break; // do not block other keys
-        }
-    },
-
-    onFocusIn : function(e) {
-        window.addEventListener("keydown", CanvasInput.arrowKeysHandler, false);
-    },
-
-    onFocusOut: function(e) {
-        window.removeEventListener("keydown", CanvasInput.arrowKeysHandler, false);
-    },
-
-    addToCanvas : function(canvas) {
-        canvas.addEventListener("focus", CanvasInput.onFocusIn, false);
-        canvas.addEventListener("blur", CanvasInput.onFocusOut, false);
-        canvas.focus();
-        CanvasInput.onFocusIn();
-    }
-};
-
 /* ********************************************************************* */
 /* Module is Emscripten namespace                                        */
 /* ********************************************************************* */
@@ -578,30 +591,6 @@ var Module = {
         return webgl_support;
     },
 
-    handleVisibilityChange: function () {
-        GLFW.onFocusChanged(document[Module.hiddenProperty] ? 0 : 1);
-    },
-
-    getHiddenProperty: function () {
-        if ('hidden' in document) return 'hidden';
-        var prefixes = ['webkit','moz','ms','o'];
-        for (var i = 0; i < prefixes.length; i++) {
-            if ((prefixes[i] + 'Hidden') in document)
-                return prefixes[i] + 'Hidden';
-        }
-        return null;
-    },
-
-    setupVisibilityChangeListener: function() {
-        Module.hiddenProperty = Module.getHiddenProperty();
-        if( Module.hiddenProperty ) {
-            var eventName = Module.hiddenProperty.replace(/[H|h]idden/,'') + 'visibilitychange';
-            document.addEventListener(eventName, Module.handleVisibilityChange, false);
-        } else {
-            console.log("No document.hidden property found. The focus events won't be enabled.")
-        }
-    },
-
     setupCanvas: function(appCanvasId) {
         appCanvasId = (typeof appCanvasId === 'undefined') ? 'canvas' : appCanvasId;
         Module.canvas = document.getElementById(appCanvasId);
@@ -672,10 +661,7 @@ var Module = {
         Module.fullScreenContainer = fullScreenContainer || Module.canvas;
 
         if (Module.hasWebGLSupport()) {
-            // Override game keys
-            CanvasInput.addToCanvas(Module.canvas);
-
-            Module.setupVisibilityChangeListener();
+            Module.canvas.focus();
 
             // Add context menu hide-handler if requested
             if (params["disable_context_menu"])
@@ -730,9 +716,14 @@ var Module = {
     },
 
     preSync: function(done) {
+        if (Module.persistentStorage != true) {
+            Module._syncInitial = true;
+            done();
+            return;
+        }
         // Initial persistent sync before main is called
         FS.syncfs(true, function(err) {
-            if(err) {
+            if (err) {
                 Module._syncTries += 1;
                 console.error("FS syncfs error: " + err);
                 if (Module._syncMaxTries > Module._syncTries) {
@@ -765,6 +756,9 @@ var Module = {
     // It will flag that another one is needed if there is already one sync running.
     persistentSync: function() {
 
+        if (Module.persistentStorage != true) {
+            return;
+        }
         // Need to wait for the initial sync to finish since it
         // will call close on all its file streams which will trigger
         // new persistentSync for each.
@@ -778,27 +772,40 @@ var Module = {
     },
 
     preInit: [function() {
-        /* Mount filesystem on preinit */
+        // Mount filesystem on preinit
         var dir = DMSYS.GetUserPersistentDataRoot();
-        FS.mkdir(dir);
+        try {
+            FS.mkdir(dir);
+        }
+        catch (error) {
+            Module.persistentStorage = false;
+            Module._preloadAndCallMain();
+            return;
+        }
 
         // If IndexedDB is supported we mount the persistent data root as IDBFS,
         // then try to do a IDB->MEM sync before we start the engine to get
         // previously saved data before boot.
-        window.indexedDB = window.indexedDB || window.mozIndexedDB || window.webkitIndexedDB || window.msIndexedDB;
-        if (Module.persistentStorage && window.indexedDB) {
+        try {
             FS.mount(IDBFS, {}, dir);
-
             // Patch FS.close so it will try to sync MEM->IDB
-            var _close = FS.close; FS.close = function(stream) { var r = _close(stream); Module.persistentSync(); return r; }
-
-            // Sync IDB->MEM before calling main()
-            Module.preSync(function() {
-                Module._preloadAndCallMain();
-            });
-        } else {
-            Module._preloadAndCallMain();
+            var _close = FS.close;
+            FS.close = function(stream) {
+                var r = _close(stream);
+                Module.persistentSync();
+                return r;
+            }
         }
+        catch (error) {
+            Module.persistentStorage = false;
+            Module._preloadAndCallMain();
+            return;
+        }
+
+        // Sync IDB->MEM before calling main()
+        Module.preSync(function() {
+            Module._preloadAndCallMain();
+        });
     }],
 
     preRun: [function() {

docs/druid/index.html

@@ -7,7 +7,7 @@
 	<meta name="apple-mobile-web-app-capable" content="yes">
 	<!-- The above 4 meta tags *must* come first in the head; any other head content must come *after* these tags -->
 
-	<title>druid 0.6.459</title>
+	<title>druid 0.11.694</title>
 	<style type='text/css'>
 	/* Disable user selection to avoid strange bug in Chrome on Windows:
 	* Selecting a text outside the canvas, then clicking+draging would
@@ -115,12 +115,19 @@
 	.canvas-app-canvas {
 		background-repeat:no-repeat;
 		background-position: center center;
+		background-size: contain;
 		background-image: url("druid_logo.png");
 	}
+
 	</style>
 </head>
 
 <body>
+	<div id="running-from-file-warning" style="display: none; margin: 3em;">
+		<h1>Running from local file ⚠️</h1>
+		<p>It seems like you have opened this file by double-clicking on it. In order to test your build in a browser <b>you need to load this file from a web server</b>. You can either upload this file and the rest of the files from a Defold HTML5 bundle to a web hosting service OR host them using a local web server on your home network.</p>
+		<p><a href="https://defold.com/manuals/html5/#testing-html5-build" target="_blank">Learn more about running a local web server in the Defold HTML5 manual</a>.</p>
+	</div>
 	<div id="app-container" class="canvas-app-container">
 		<div id="canvas-container" class="canvas-app-canvas-container">
 			<canvas id="canvas" class="canvas-app-canvas" tabindex="1" width="600" height="900"></canvas>
@@ -160,7 +167,8 @@
 
 	var is_iOS = /iPad|iPhone|iPod/.test(navigator.userAgent) && !window.MSStream;
 	var buttonHeight = 0;
-	// Resize on init, screen resize and orientation change
+	var prevInnerWidth = -1;
+	var prevInnerHeight = -1;
 	function resize_game_canvas() {
 		// Hack for iOS when exit from Fullscreen mode
 		if (is_iOS) {
@@ -171,6 +179,12 @@
 		var game_canvas = document.getElementById('canvas');
 		var innerWidth = window.innerWidth;
 		var innerHeight = window.innerHeight - buttonHeight;
+		if (prevInnerWidth == innerWidth && prevInnerHeight == innerHeight)
+		{
+			return;
+		}
+		prevInnerWidth = innerWidth;
+		prevInnerHeight = innerHeight;
 		var width = 600;
 		var height = 900;
 		var targetRatio = width / height;
@@ -201,10 +215,19 @@
 	resize_game_canvas();
 	window.addEventListener('resize', resize_game_canvas, false);
 	window.addEventListener('orientationchange', resize_game_canvas, false);
+	window.addEventListener('focus', resize_game_canvas, false);
 	</script>
 
 	<script id='engine-start' type='text/javascript'>
-		EngineLoader.load("canvas", "druid");
+		var runningFromFileWarning = document.getElementById("running-from-file-warning");
+		if (window.location.href.startsWith("file://")) {
+			runningFromFileWarning.style.display = "block";
+		}
+		else {
+			EngineLoader.stream_wasm = "false" === "true";
+			EngineLoader.load("canvas", "druid");
+			runningFromFileWarning.parentNode.removeChild(runningFromFileWarning);
+		}
 	</script>
 </body>
 </html>

docs/index.html

@@ -3,7 +3,7 @@
 <html>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
 <head>
-    <title>Defold Druid UI Library</title>
+    <title>Defold Druid UI Framework</title>
     <link rel="stylesheet" href="ldoc_fixed.css" type="text/css" />
 </head>
 <body>
@@ -38,22 +38,27 @@
   <li><a href="modules/Hover.html">Hover</a></li>
   <li><a href="modules/Scroll.html">Scroll</a></li>
   <li><a href="modules/StaticGrid.html">StaticGrid</a></li>
-  <li><a href="modules/Swipe.html">Swipe</a></li>
   <li><a href="modules/Text.html">Text</a></li>
   <li><a href="modules/BaseComponent.html">BaseComponent</a></li>
-  <li><a href="modules/druid.html">druid</a></li>
+  <li><a href="modules/PinKnob.html">PinKnob</a></li>
+  <li><a href="modules/RichInput.html">RichInput</a></li>
+  <li><a href="modules/RichText.html">RichText</a></li>
+  <li><a href="modules/Druid.html">Druid</a></li>
   <li><a href="modules/DruidEvent.html">DruidEvent</a></li>
   <li><a href="modules/Checkbox.html">Checkbox</a></li>
   <li><a href="modules/CheckboxGroup.html">CheckboxGroup</a></li>
   <li><a href="modules/DataList.html">DataList</a></li>
   <li><a href="modules/DynamicGrid.html">DynamicGrid</a></li>
+  <li><a href="modules/Hotkey.html">Hotkey</a></li>
   <li><a href="modules/Input.html">Input</a></li>
   <li><a href="modules/LangText.html">LangText</a></li>
+  <li><a href="modules/Layout.html">Layout</a></li>
   <li><a href="modules/Progress.html">Progress</a></li>
   <li><a href="modules/RadioGroup.html">RadioGroup</a></li>
   <li><a href="modules/Slider.html">Slider</a></li>
+  <li><a href="modules/Swipe.html">Swipe</a></li>
   <li><a href="modules/Timer.html">Timer</a></li>
-  <li><a href="modules/druid.helper.html">druid.helper</a></li>
+  <li><a href="modules/Helper.html">Helper</a></li>
   <li><a href="modules/DruidInstance.html">DruidInstance</a></li>
 </ul>
 
@@ -62,21 +67,21 @@
 <div id="content">
 
 
-  <h2>Documentation for Druid Library</h2>
+  <h2>Documentation for Druid Framework</h2>
 
 <h2>Modules</h2>
 <table class="module_list">
 	<tr>
 		<td class="name"  nowrap><a href="modules/BackHandler.html">BackHandler</a></td>
-		<td class="summary">Component to handle back key (android, backspace)</td>
+		<td class="summary">Component with event on back and backspace button.</td>
 	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/Blocker.html">Blocker</a></td>
-		<td class="summary">Component to block input on specify zone by node</td>
+		<td class="summary">Component to consume input in special zone defined by GUI node.</td>
 	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/Button.html">Button</a></td>
-		<td class="summary">Component to handle basic GUI button</td>
+		<td class="summary">Druid Component for Handling User Click Interactions: Click, Long Click, Double Click, and More.</td>
 	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/Drag.html">Drag</a></td>
@@ -92,27 +97,38 @@
 	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/StaticGrid.html">StaticGrid</a></td>
-		<td class="summary">Component to handle placing components by row and columns.</td>
-	</tr>
-	<tr>
-		<td class="name"  nowrap><a href="modules/Swipe.html">Swipe</a></td>
-		<td class="summary">Component to handle swipe gestures on node.</td>
+		<td class="summary">Component to handle component's position by row and columns.</td>
 	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/Text.html">Text</a></td>
-		<td class="summary">Component to handle all GUI texts.</td>
+		<td class="summary">Component for Wrapping GUI Text Nodes: Druid Text
+<p> ## Overview ##
+<p> Druid Text is a component that provides various adjustment modes for text nodes.</td>
 	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/BaseComponent.html">BaseComponent</a></td>
 		<td class="summary">Basic class for all Druid components.</td>
 	</tr>
 	<tr>
-		<td class="name"  nowrap><a href="modules/druid.html">druid</a></td>
-		<td class="summary">Druid UI Library.</td>
+		<td class="name"  nowrap><a href="modules/PinKnob.html">PinKnob</a></td>
+		<td class="summary">Druid pin knob custom component.</td>
+	</tr>
+	<tr>
+		<td class="name"  nowrap><a href="modules/RichInput.html">RichInput</a></td>
+		<td class="summary">Druid Rich Input custom component.</td>
+	</tr>
+	<tr>
+		<td class="name"  nowrap><a href="modules/RichText.html">RichText</a></td>
+		<td class="summary">Druid Rich Text Custom Component.</td>
+	</tr>
+	<tr>
+		<td class="name"  nowrap><a href="modules/Druid.html">Druid</a></td>
+		<td class="summary">Druid UI Component Framework.</td>
 	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/DruidEvent.html">DruidEvent</a></td>
-		<td class="summary">Lua event small library</td>
+		<td class="summary">Druid Event Module
+<p> The Event module provides a simple class for handling callbacks.</td>
 	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/Checkbox.html">Checkbox</a></td>
@@ -130,18 +146,28 @@
 		<td class="name"  nowrap><a href="modules/DynamicGrid.html">DynamicGrid</a></td>
 		<td class="summary">Component to handle placing components in row</td>
 	</tr>
+	<tr>
+		<td class="name"  nowrap><a href="modules/Hotkey.html">Hotkey</a></td>
+		<td class="summary">Druid hotkey component</td>
+	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/Input.html">Input</a></td>
 		<td class="summary">Druid input text component.</td>
 	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/LangText.html">LangText</a></td>
-		<td class="summary">Component to handle all GUI texts
- Good working with localization system</td>
+		<td class="summary">Component to wrap over GUI Text nodes with localization helpers
+<p> <b># Overview #</b>
+<p> • The initialization of druid.set_text_function is required to enable localization
+ using the localization ID.</td>
+	</tr>
+	<tr>
+		<td class="name"  nowrap><a href="modules/Layout.html">Layout</a></td>
+		<td class="summary">Layout management on node</td>
 	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/Progress.html">Progress</a></td>
-		<td class="summary">Basic progress bar component.</td>
+		<td class="summary">Druid component to handle the progress bars.</td>
 	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/RadioGroup.html">RadioGroup</a></td>
@@ -151,25 +177,29 @@
 		<td class="name"  nowrap><a href="modules/Slider.html">Slider</a></td>
 		<td class="summary">Druid slider component</td>
 	</tr>
+	<tr>
+		<td class="name"  nowrap><a href="modules/Swipe.html">Swipe</a></td>
+		<td class="summary">Component to handle swipe gestures on node.</td>
+	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/Timer.html">Timer</a></td>
 		<td class="summary">Component to handle GUI timers.</td>
 	</tr>
 	<tr>
-		<td class="name"  nowrap><a href="modules/druid.helper.html">druid.helper</a></td>
-		<td class="summary">Text node or icon node can be nil</td>
+		<td class="name"  nowrap><a href="modules/Helper.html">Helper</a></td>
+		<td class="summary">Helper module with various usefull GUI functions.</td>
 	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/DruidInstance.html">DruidInstance</a></td>
-		<td class="summary">Instance of Druid.</td>
+		<td class="summary">Druid Instance which you use for component creation.</td>
 	</tr>
 </table>
 
 </div> <!-- id="content" -->
 </div> <!-- id="main" -->
 <div id="about">
-<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-04-06 00:03:14 </i>
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc TESTING</a></i>
+<i style="float:right;">Last updated 2015-01-01 12:00:00 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

docs/ldoc_fixed.css

@@ -195,7 +195,7 @@ table.index td { text-align: left; vertical-align: top; }
     margin-left: 14em;
     padding: 1em;
     padding-left: 2em;
-    width: 700px;
+    width: 900px;
     border-left: 2px solid #cccccc;
    // border-right: 2px solid #cccccc;
     background-color: #ffffff;

docs/modules/BackHandler.html

@@ -3,7 +3,7 @@
 <html>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
 <head>
-    <title>Defold Druid UI Library</title>
+    <title>Defold Druid UI Framework</title>
     <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
 </head>
 <body>
@@ -32,7 +32,6 @@
 
 <h2>Contents</h2>
 <ul>
-<li><a href="#Functions">Functions</a></li>
 <li><a href="#Fields">Fields</a></li>
 </ul>
 
@@ -40,29 +39,34 @@
 <h2>Modules</h2>
 <ul class="nowrap">
   <li><strong>BackHandler</strong></li>
+  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
   <li><a href="../modules/Blocker.html">Blocker</a></li>
   <li><a href="../modules/Button.html">Button</a></li>
-  <li><a href="../modules/Drag.html">Drag</a></li>
-  <li><a href="../modules/Hover.html">Hover</a></li>
-  <li><a href="../modules/Scroll.html">Scroll</a></li>
-  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
-  <li><a href="../modules/Swipe.html">Swipe</a></li>
-  <li><a href="../modules/Text.html">Text</a></li>
-  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
-  <li><a href="../modules/druid.html">druid</a></li>
-  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
   <li><a href="../modules/Checkbox.html">Checkbox</a></li>
   <li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
   <li><a href="../modules/DataList.html">DataList</a></li>
+  <li><a href="../modules/Drag.html">Drag</a></li>
+  <li><a href="../modules/Druid.html">Druid</a></li>
+  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
+  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
   <li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
+  <li><a href="../modules/Helper.html">Helper</a></li>
+  <li><a href="../modules/Hotkey.html">Hotkey</a></li>
+  <li><a href="../modules/Hover.html">Hover</a></li>
   <li><a href="../modules/Input.html">Input</a></li>
   <li><a href="../modules/LangText.html">LangText</a></li>
+  <li><a href="../modules/Layout.html">Layout</a></li>
+  <li><a href="../modules/PinKnob.html">PinKnob</a></li>
   <li><a href="../modules/Progress.html">Progress</a></li>
   <li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
+  <li><a href="../modules/RichInput.html">RichInput</a></li>
+  <li><a href="../modules/RichText.html">RichText</a></li>
+  <li><a href="../modules/Scroll.html">Scroll</a></li>
   <li><a href="../modules/Slider.html">Slider</a></li>
+  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
+  <li><a href="../modules/Swipe.html">Swipe</a></li>
+  <li><a href="../modules/Text.html">Text</a></li>
   <li><a href="../modules/Timer.html">Timer</a></li>
-  <li><a href="../modules/druid.helper.html">druid.helper</a></li>
-  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
 </ul>
 
 </div>
@@ -70,30 +74,33 @@
 <div id="content">
 
 <h1>Module <code>BackHandler</code></h1>
-<p>Component to handle back key (android, backspace)</p>
-<p></p>
+<p>Component with event on back and backspace button.</p>
+<p>
+ <b># Overview #</b>
+<p> Back Handler is recommended to put in every game window to close it
+ or in main screen to call settings window.
+<p> <b># Notes #</b>
+<p> • Back Handler inheritance <a href="../modules/BaseComponent.html#">BaseComponent</a>, you can use all of its methods in addition to those described here.
+<p> • Back Handler react on release action ACTION_BACK or ACTION_BACKSPACE</p>
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example">local callback = function(self, params) ... end
+
+local params = {}
+local back_handler = self.druid:new_back_handler(callback, [params])
+</pre>
+    </ul>
 
 
-<h2><a href="#Functions">Functions</a></h2>
-<table class="function_list">
-	<tr>
-	<td class="name" nowrap><a href="#init">init(self, callback[, params])</a></td>
-	<td class="summary">Component init function</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#on_input">on_input(self, action_id, action)</a></td>
-	<td class="summary">Input handler for component</td>
-	</tr>
-</table>
 <h2><a href="#Fields">Fields</a></h2>
 <table class="function_list">
 	<tr>
 	<td class="name" nowrap><a href="#on_back">on_back</a></td>
-	<td class="summary">On back handler callback(self, params)</td>
+	<td class="summary">The <a href="../modules/DruidEvent.html#">DruidEvent</a> Event on back handler action.</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#params">params</a></td>
-	<td class="summary">Params to back callback</td>
+	<td class="summary">Custom args to pass in the callback</td>
 	</tr>
 </table>
 
@@ -101,69 +108,6 @@
 <br/>
 
 
-    <h2 class="section-header "><a name="Functions"></a>Functions</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "init"></a>
-    <strong>init(self, callback[, params])</strong>
-    </dt>
-    <dd>
-    Component init function
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">BackHandler</span></span>
-
-        </li>
-        <li><span class="parameter">callback</span>
-            <span class="types"><span class="type">callback</span></span>
-         On back button
-        </li>
-        <li><span class="parameter">params</span>
-            <span class="types"><span class="type">any</span></span>
-         Callback argument
-         (<em>optional</em>)
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "on_input"></a>
-    <strong>on_input(self, action_id, action)</strong>
-    </dt>
-    <dd>
-    Input handler for component
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">BackHandler</span></span>
-
-        </li>
-        <li><span class="parameter">action_id</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
-         on_input action id
-        </li>
-        <li><span class="parameter">action</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
-         on_input action
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-</dl>
     <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 
     <dl class="function">
@@ -172,19 +116,25 @@
     <strong>on_back</strong>
     </dt>
     <dd>
-    On back handler callback(self, params)
+    The <a href="../modules/DruidEvent.html#">DruidEvent</a> Event on back handler action.
+<p> Trigger on input action ACTION_BACK or ACTION_BACKSPACE
 
 
     <ul>
         <li><span class="parameter">on_back</span>
-            <span class="types"><span class="type">druid_event</span></span>
-
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
         </li>
     </ul>
 
 
 
 
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example"><span class="comment">-- Subscribe additional callbacks:
+</span>back_handler.on_back:subscribe(callback)</pre>
+    </ul>
 
 </dd>
     <dt>
@@ -192,19 +142,25 @@
     <strong>params</strong>
     </dt>
     <dd>
-    Params to back callback
+    Custom args to pass in the callback
 
 
     <ul>
         <li><span class="parameter">params</span>
             <span class="types"><span class="type">any</span></span>
 
+         (<em>optional</em>)
         </li>
     </ul>
 
 
 
 
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example"><span class="comment">-- Replace params on runtime:
+</span>back_handler.params = { ... }</pre>
+    </ul>
 
 </dd>
 </dl>
@@ -213,8 +169,8 @@
 </div> <!-- id="content" -->
 </div> <!-- id="main" -->
 <div id="about">
-<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-04-06 00:03:14 </i>
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc TESTING</a></i>
+<i style="float:right;">Last updated 2015-01-01 12:00:00 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

docs/modules/BaseComponent.html

@@ -3,7 +3,7 @@
 <html>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
 <head>
-    <title>Defold Druid UI Library</title>
+    <title>Defold Druid UI Framework</title>
     <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
 </head>
 <body>
@@ -33,36 +33,40 @@
 <h2>Contents</h2>
 <ul>
 <li><a href="#Functions">Functions</a></li>
-<li><a href="#Fields">Fields</a></li>
 </ul>
 
 
 <h2>Modules</h2>
 <ul class="nowrap">
   <li><a href="../modules/BackHandler.html">BackHandler</a></li>
+  <li><strong>BaseComponent</strong></li>
   <li><a href="../modules/Blocker.html">Blocker</a></li>
   <li><a href="../modules/Button.html">Button</a></li>
-  <li><a href="../modules/Drag.html">Drag</a></li>
-  <li><a href="../modules/Hover.html">Hover</a></li>
-  <li><a href="../modules/Scroll.html">Scroll</a></li>
-  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
-  <li><a href="../modules/Swipe.html">Swipe</a></li>
-  <li><a href="../modules/Text.html">Text</a></li>
-  <li><strong>BaseComponent</strong></li>
-  <li><a href="../modules/druid.html">druid</a></li>
-  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
   <li><a href="../modules/Checkbox.html">Checkbox</a></li>
   <li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
   <li><a href="../modules/DataList.html">DataList</a></li>
+  <li><a href="../modules/Drag.html">Drag</a></li>
+  <li><a href="../modules/Druid.html">Druid</a></li>
+  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
+  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
   <li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
+  <li><a href="../modules/Helper.html">Helper</a></li>
+  <li><a href="../modules/Hotkey.html">Hotkey</a></li>
+  <li><a href="../modules/Hover.html">Hover</a></li>
   <li><a href="../modules/Input.html">Input</a></li>
   <li><a href="../modules/LangText.html">LangText</a></li>
+  <li><a href="../modules/Layout.html">Layout</a></li>
+  <li><a href="../modules/PinKnob.html">PinKnob</a></li>
   <li><a href="../modules/Progress.html">Progress</a></li>
   <li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
+  <li><a href="../modules/RichInput.html">RichInput</a></li>
+  <li><a href="../modules/RichText.html">RichText</a></li>
+  <li><a href="../modules/Scroll.html">Scroll</a></li>
   <li><a href="../modules/Slider.html">Slider</a></li>
+  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
+  <li><a href="../modules/Swipe.html">Swipe</a></li>
+  <li><a href="../modules/Text.html">Text</a></li>
   <li><a href="../modules/Timer.html">Timer</a></li>
-  <li><a href="../modules/druid.helper.html">druid.helper</a></li>
-  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
 </ul>
 
 </div>
@@ -72,73 +76,90 @@
 <h1>Module <code>BaseComponent</code></h1>
 <p>Basic class for all Druid components.</p>
 <p>
- To create you component, use `component.create`</p>
+ To create you custom component, use static function `component.create`</p>
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example">-- Create your component:
+local component = require(&quot;druid.component&quot;)
+
+local AwesomeComponent = component.create(&quot;awesome_component&quot;)
+
+function AwesomeComponent:init(template, nodes)
+    self:set_template(template)
+    self:set_nodes(nodes)
+    self.druid = self:get_druid()
+end
+
+return AwesomeComponent
+</pre>
+    </ul>
 
 
 <h2><a href="#Functions">Functions</a></h2>
 <table class="function_list">
 	<tr>
-	<td class="name" nowrap><a href="#set_style">set_style(self, druid_style)</a></td>
-	<td class="summary">Set current component style table.</td>
+	<td class="name" nowrap><a href="#component:get_childrens">component:get_childrens(self)</a></td>
+	<td class="summary">Return all children components, recursive</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#set_template">set_template(self, template)</a></td>
-	<td class="summary">Set current component template name</td>
+	<td class="name" nowrap><a href="#component:get_context">component:get_context(self)</a></td>
+	<td class="summary">Context used as first arg in all Druid events</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#set_nodes">set_nodes(self, nodes)</a></td>
-	<td class="summary">Set current component nodes</td>
+	<td class="name" nowrap><a href="#component:get_druid">component:get_druid(self)</a></td>
+	<td class="summary">Get Druid instance for inner component creation.</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#get_context">get_context(self)</a></td>
-	<td class="summary">Get current component context</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#get_node">get_node(self, node_or_name)</a></td>
-	<td class="summary">Get node for component by name.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#get_druid">get_druid(self)</a></td>
-	<td class="summary">Return druid with context of calling component.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#get_name">get_name(self)</a></td>
-	<td class="summary">Return component name</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#get_input_priority">get_input_priority(self)</a></td>
+	<td class="name" nowrap><a href="#component:get_input_priority">component:get_input_priority(self)</a></td>
 	<td class="summary">Return component input priority</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#set_input_priority">set_input_priority(self, value)</a></td>
-	<td class="summary">Set component input priority</td>
+	<td class="name" nowrap><a href="#component:get_name">component:get_name(self)</a></td>
+	<td class="summary">Return component name</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#reset_input_priority">reset_input_priority(self)</a></td>
+	<td class="name" nowrap><a href="#component:get_node">component:get_node(self, node_or_name)</a></td>
+	<td class="summary">Get component node by name.</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#component:get_parent_component">component:get_parent_component(self)</a></td>
+	<td class="summary">Return the parent component if exist</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#component:get_parent_name">component:get_parent_name(self)</a></td>
+	<td class="summary">Return parent component name</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#component:get_template">component:get_template(self)</a></td>
+	<td class="summary">Get current component template name.</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#component:get_uid">component:get_uid(self)</a></td>
+	<td class="summary">Return component UID.</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#component:reset_input_priority">component:reset_input_priority(self)</a></td>
 	<td class="summary">Reset component input priority to default value</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#get_uid">get_uid(self)</a></td>
-	<td class="summary">Return component uid.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#set_input_enabled">set_input_enabled(self, state)</a></td>
+	<td class="name" nowrap><a href="#component:set_input_enabled">component:set_input_enabled(self, state)</a></td>
 	<td class="summary">Set component input state.</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#get_parent_component">get_parent_component(self)</a></td>
-	<td class="summary">Return the parent for current component</td>
+	<td class="name" nowrap><a href="#component:set_input_priority">component:set_input_priority(self, value, is_temporary)</a></td>
+	<td class="summary">Set component input priority</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#setup_component">setup_component(self, druid_instance, context, style)</a></td>
-	<td class="summary">Setup component context and his style table</td>
+	<td class="name" nowrap><a href="#component:set_nodes">component:set_nodes(self, nodes)</a></td>
+	<td class="summary">Set current component nodes.</td>
 	</tr>
-</table>
-<h2><a href="#Fields">Fields</a></h2>
-<table class="function_list">
 	<tr>
-	<td class="name" nowrap><a href="#ALL">ALL</a></td>
-	<td class="summary">Component Interests</td>
+	<td class="name" nowrap><a href="#component:set_style">component:set_style(self, druid_style)</a></td>
+	<td class="summary">Set current component style table.</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#component:set_template">component:set_template(self, template)</a></td>
+	<td class="summary">Set component template name.</td>
 	</tr>
 </table>
 
@@ -150,102 +171,52 @@
 
     <dl class="function">
     <dt>
-    <a name = "set_style"></a>
-    <strong>set_style(self, druid_style)</strong>
+    <a name = "component:get_childrens"></a>
+    <strong>component:get_childrens(self)</strong>
     </dt>
     <dd>
-    Set current component style table.
- Invoke `on_style_change` on component, if exist. BaseComponent should handle
- their style changing and store all style params
+    Return all children components, recursive
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">BaseComponent</span></span>
-
-        </li>
-        <li><span class="parameter">druid_style</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
-         Druid style module
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_template"></a>
-    <strong>set_template(self, template)</strong>
-    </dt>
-    <dd>
-    Set current component template name
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">BaseComponent</span></span>
-
-        </li>
-        <li><span class="parameter">template</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
-         BaseComponent template name
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_nodes"></a>
-    <strong>set_nodes(self, nodes)</strong>
-    </dt>
-    <dd>
-    Set current component nodes
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">BaseComponent</span></span>
-
-        </li>
-        <li><span class="parameter">nodes</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
-         BaseComponent nodes table
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "get_context"></a>
-    <strong>get_context(self)</strong>
-    </dt>
-    <dd>
-    Get current component context
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">BaseComponent</span></span>
-
+         <a href="../modules/BaseComponent.html#">BaseComponent</a>
         </li>
     </ul>
 
     <h3>Returns:</h3>
     <ol>
 
-           <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
+           <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+        Array of childrens if the Druid component instance
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "component:get_context"></a>
+    <strong>component:get_context(self)</strong>
+    </dt>
+    <dd>
+    Context used as first arg in all Druid events  Context is usually self of gui_script.
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">BaseComponent</span></span>
+         <a href="../modules/BaseComponent.html#">BaseComponent</a>
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
         BaseComponent context
     </ol>
 
@@ -254,24 +225,106 @@
 
 </dd>
     <dt>
-    <a name = "get_node"></a>
-    <strong>get_node(self, node_or_name)</strong>
+    <a name = "component:get_druid"></a>
+    <strong>component:get_druid(self)</strong>
     </dt>
     <dd>
-    Get node for component by name.
- If component has nodes, node_or_name should be string
- It auto pick node by template name or from nodes by clone_tree
- if they was setup via component:set_nodes, component:set_template
+    Get Druid instance for inner component creation.
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">BaseComponent</span></span>
+         <a href="../modules/BaseComponent.html#">BaseComponent</a>
+        </li>
+    </ul>
 
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">Druid</span></span>
+        Druid instance with component context
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "component:get_input_priority"></a>
+    <strong>component:get_input_priority(self)</strong>
+    </dt>
+    <dd>
+    Return component input priority
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">BaseComponent</span></span>
+         <a href="../modules/BaseComponent.html#">BaseComponent</a>
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">number</span></span>
+        The component input priority
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "component:get_name"></a>
+    <strong>component:get_name(self)</strong>
+    </dt>
+    <dd>
+    Return component name
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">BaseComponent</span></span>
+         <a href="../modules/BaseComponent.html#">BaseComponent</a>
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+        The component name
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "component:get_node"></a>
+    <strong>component:get_node(self, node_or_name)</strong>
+    </dt>
+    <dd>
+    Get component node by name.
+<p> If component has nodes, node_or_name should be string
+ It autopick node by template name or from nodes by gui.clone_tree
+ if they was setup via component:set_nodes, component:set_template.
+ If node is not found, the exception will fired
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">BaseComponent</span></span>
+         <a href="../modules/BaseComponent.html#">BaseComponent</a>
         </li>
         <li><span class="parameter">node_or_name</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a> or <span class="type">node</span></span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a> or <span class="type">node</span></span>
          Node name or node itself
         </li>
     </ul>
@@ -288,27 +341,26 @@
 
 </dd>
     <dt>
-    <a name = "get_druid"></a>
-    <strong>get_druid(self)</strong>
+    <a name = "component:get_parent_component"></a>
+    <strong>component:get_parent_component(self)</strong>
     </dt>
     <dd>
-    Return druid with context of calling component.
- Use it to create component inside of other components.
+    Return the parent component if exist
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">BaseComponent</span></span>
-
+         <a href="../modules/BaseComponent.html#">BaseComponent</a>
         </li>
     </ul>
 
     <h3>Returns:</h3>
     <ol>
 
-           <span class="types"><span class="type">Druid</span></span>
-        Druid instance with component context
+           <span class="types"><span class="type">BaseComponent</span> or <span class="type">nil</span></span>
+        The druid component instance or nil
     </ol>
 
 
@@ -316,26 +368,26 @@
 
 </dd>
     <dt>
-    <a name = "get_name"></a>
-    <strong>get_name(self)</strong>
+    <a name = "component:get_parent_name"></a>
+    <strong>component:get_parent_name(self)</strong>
     </dt>
     <dd>
-    Return component name
+    Return parent component name
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">BaseComponent</span></span>
-
+         <a href="../modules/BaseComponent.html#">BaseComponent</a>
         </li>
     </ul>
 
     <h3>Returns:</h3>
     <ol>
 
-           <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
-        The component name
+           <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a> or <span class="type">nil</span></span>
+        The parent component name if exist or bil
     </ol>
 
 
@@ -343,26 +395,26 @@
 
 </dd>
     <dt>
-    <a name = "get_input_priority"></a>
-    <strong>get_input_priority(self)</strong>
+    <a name = "component:get_template"></a>
+    <strong>component:get_template(self)</strong>
     </dt>
     <dd>
-    Return component input priority
+    Get current component template name.
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">BaseComponent</span></span>
-
+         <a href="../modules/BaseComponent.html#">BaseComponent</a>
         </li>
     </ul>
 
     <h3>Returns:</h3>
     <ol>
 
-           <span class="types"><span class="type">number</span></span>
-        The component input priority
+           <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+        Component full template name
     </ol>
 
 
@@ -370,76 +422,19 @@
 
 </dd>
     <dt>
-    <a name = "set_input_priority"></a>
-    <strong>set_input_priority(self, value)</strong>
+    <a name = "component:get_uid"></a>
+    <strong>component:get_uid(self)</strong>
     </dt>
     <dd>
-    Set component input priority
+    Return component UID.
+<p> UID generated in component creation order.
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">BaseComponent</span></span>
-
-        </li>
-        <li><span class="parameter">value</span>
-            <span class="types"><span class="type">number</span></span>
-         The new input priority value
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">number</span></span>
-        The component input priority
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "reset_input_priority"></a>
-    <strong>reset_input_priority(self)</strong>
-    </dt>
-    <dd>
-    Reset component input priority to default value
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">BaseComponent</span></span>
-
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">number</span></span>
-        The component input priority
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "get_uid"></a>
-    <strong>get_uid(self)</strong>
-    </dt>
-    <dd>
-    Return component uid.  UID generated in component creation order
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">BaseComponent</span></span>
-
+         <a href="../modules/BaseComponent.html#">BaseComponent</a>
         </li>
     </ul>
 
@@ -455,19 +450,46 @@
 
 </dd>
     <dt>
-    <a name = "set_input_enabled"></a>
-    <strong>set_input_enabled(self, state)</strong>
+    <a name = "component:reset_input_priority"></a>
+    <strong>component:reset_input_priority(self)</strong>
     </dt>
     <dd>
-    Set component input state.  By default it enabled
- You can disable any input of component by this function
+    Reset component input priority to default value
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">BaseComponent</span></span>
+         <a href="../modules/BaseComponent.html#">BaseComponent</a>
+        </li>
+    </ul>
 
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">number</span></span>
+        The component input priority
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "component:set_input_enabled"></a>
+    <strong>component:set_input_enabled(self, state)</strong>
+    </dt>
+    <dd>
+    Set component input state.  By default it enabled
+<p> If input is disabled, the component will not receive input events
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">BaseComponent</span></span>
+         <a href="../modules/BaseComponent.html#">BaseComponent</a>
         </li>
         <li><span class="parameter">state</span>
             <span class="types"><span class="type">bool</span></span>
@@ -487,26 +509,34 @@
 
 </dd>
     <dt>
-    <a name = "get_parent_component"></a>
-    <strong>get_parent_component(self)</strong>
+    <a name = "component:set_input_priority"></a>
+    <strong>component:set_input_priority(self, value, is_temporary)</strong>
     </dt>
     <dd>
-    Return the parent for current component
+    Set component input priority  Default value: 10
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">BaseComponent</span></span>
-
+         <a href="../modules/BaseComponent.html#">BaseComponent</a>
+        </li>
+        <li><span class="parameter">value</span>
+            <span class="types"><span class="type">number</span></span>
+         The new input priority value
+        </li>
+        <li><span class="parameter">is_temporary</span>
+            <span class="types"><span class="type">boolean</span></span>
+         If true, the reset input priority will return to previous value
         </li>
     </ul>
 
     <h3>Returns:</h3>
     <ol>
 
-           <span class="types"><span class="type">druid.base_component</span> or <span class="type">nil</span></span>
-        The druid component instance or nil
+           <span class="types"><span class="type">number</span></span>
+        The component input priority
     </ol>
 
 
@@ -514,29 +544,61 @@
 
 </dd>
     <dt>
-    <a name = "setup_component"></a>
-    <strong>setup_component(self, druid_instance, context, style)</strong>
+    <a name = "component:set_nodes"></a>
+    <strong>component:set_nodes(self, nodes)</strong>
     </dt>
     <dd>
-    Setup component context and his style table
+    Set current component nodes.
+ Use if your component nodes was cloned with `gui.clone_tree` and you got the node tree.
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">BaseComponent</span></span>
+         <a href="../modules/BaseComponent.html#">BaseComponent</a>
+        </li>
+        <li><span class="parameter">nodes</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+         BaseComponent nodes table
+        </li>
+    </ul>
 
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">BaseComponent</span></span>
+        <a href="../modules/BaseComponent.html#">BaseComponent</a>
+    </ol>
+
+
+
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example"><span class="keyword">local</span> nodes = gui.clone_tree(self.prefab)
+... In your component:
+self:set_nodes(nodes)</pre>
+    </ul>
+
+</dd>
+    <dt>
+    <a name = "component:set_style"></a>
+    <strong>component:set_style(self, druid_style)</strong>
+    </dt>
+    <dd>
+    Set current component style table.
+<p> Invoke `on_style_change` on component, if exist. Component should handle
+ their style changing and store all style params
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">BaseComponent</span></span>
+         <a href="../modules/BaseComponent.html#">BaseComponent</a>
         </li>
-        <li><span class="parameter">druid_instance</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
-         The parent druid instance
-        </li>
-        <li><span class="parameter">context</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
-         Druid context. Usually it is self of script
-        </li>
-        <li><span class="parameter">style</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
+        <li><span class="parameter">druid_style</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
          Druid style module
         </li>
     </ul>
@@ -544,27 +606,42 @@
     <h3>Returns:</h3>
     <ol>
 
-           <span class="types"><span class="type">component</span></span>
-        BaseComponent itself
+           <span class="types"><span class="type">BaseComponent</span></span>
+        <a href="../modules/BaseComponent.html#">BaseComponent</a>
     </ol>
 
 
 
 
 </dd>
-</dl>
-    <h2 class="section-header "><a name="Fields"></a>Fields</h2>
-
-    <dl class="function">
     <dt>
-    <a name = "ALL"></a>
-    <strong>ALL</strong>
+    <a name = "component:set_template"></a>
+    <strong>component:set_template(self, template)</strong>
     </dt>
     <dd>
-    Component Interests
+    Set component template name.
+<p> Use on all your custom components with GUI layouts used as templates.
+ It will check parent template name to build full template name in self:get_node()
 
 
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">BaseComponent</span></span>
+         <a href="../modules/BaseComponent.html#">BaseComponent</a>
+        </li>
+        <li><span class="parameter">template</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         BaseComponent template name
+        </li>
+    </ul>
 
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">BaseComponent</span></span>
+        <a href="../modules/BaseComponent.html#">BaseComponent</a>
+    </ol>
 
 
 
@@ -576,8 +653,8 @@
 </div> <!-- id="content" -->
 </div> <!-- id="main" -->
 <div id="about">
-<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-04-06 00:03:14 </i>
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc TESTING</a></i>
+<i style="float:right;">Last updated 2015-01-01 12:00:00 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

docs/modules/Blocker.html

@@ -3,7 +3,7 @@
 <html>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
 <head>
-    <title>Defold Druid UI Library</title>
+    <title>Defold Druid UI Framework</title>
     <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
 </head>
 <body>
@@ -40,29 +40,34 @@
 <h2>Modules</h2>
 <ul class="nowrap">
   <li><a href="../modules/BackHandler.html">BackHandler</a></li>
+  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
   <li><strong>Blocker</strong></li>
   <li><a href="../modules/Button.html">Button</a></li>
-  <li><a href="../modules/Drag.html">Drag</a></li>
-  <li><a href="../modules/Hover.html">Hover</a></li>
-  <li><a href="../modules/Scroll.html">Scroll</a></li>
-  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
-  <li><a href="../modules/Swipe.html">Swipe</a></li>
-  <li><a href="../modules/Text.html">Text</a></li>
-  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
-  <li><a href="../modules/druid.html">druid</a></li>
-  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
   <li><a href="../modules/Checkbox.html">Checkbox</a></li>
   <li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
   <li><a href="../modules/DataList.html">DataList</a></li>
+  <li><a href="../modules/Drag.html">Drag</a></li>
+  <li><a href="../modules/Druid.html">Druid</a></li>
+  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
+  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
   <li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
+  <li><a href="../modules/Helper.html">Helper</a></li>
+  <li><a href="../modules/Hotkey.html">Hotkey</a></li>
+  <li><a href="../modules/Hover.html">Hover</a></li>
   <li><a href="../modules/Input.html">Input</a></li>
   <li><a href="../modules/LangText.html">LangText</a></li>
+  <li><a href="../modules/Layout.html">Layout</a></li>
+  <li><a href="../modules/PinKnob.html">PinKnob</a></li>
   <li><a href="../modules/Progress.html">Progress</a></li>
   <li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
+  <li><a href="../modules/RichInput.html">RichInput</a></li>
+  <li><a href="../modules/RichText.html">RichText</a></li>
+  <li><a href="../modules/Scroll.html">Scroll</a></li>
   <li><a href="../modules/Slider.html">Slider</a></li>
+  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
+  <li><a href="../modules/Swipe.html">Swipe</a></li>
+  <li><a href="../modules/Text.html">Text</a></li>
   <li><a href="../modules/Timer.html">Timer</a></li>
-  <li><a href="../modules/druid.helper.html">druid.helper</a></li>
-  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
 </ul>
 
 </div>
@@ -70,30 +75,42 @@
 <div id="content">
 
 <h1>Module <code>Blocker</code></h1>
-<p>Component to block input on specify zone by node</p>
-<p></p>
+<p>Component to consume input in special zone defined by GUI node.</p>
+<p>
+ <b># Overview #</b>
+<p> <b># Notes #</b>
+<p> Blocker consume input if `gui.pick_node` works on it.
+<p> • Blocker inheritance <a href="../modules/BaseComponent.html#">BaseComponent</a>, you can use all of its methods in addition to those described here.
+<p> • Blocker initial enabled state is `gui.is_enabled(node, true)`
+<p> • The Blocker node should be enabled to capture the input</p>
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example">local node = gui.get_node(&quot;blocker_node&quot;)
+local blocker = self.druid:new_blocker(node)
+</pre>
+    </ul>
 
 
 <h2><a href="#Functions">Functions</a></h2>
 <table class="function_list">
 	<tr>
 	<td class="name" nowrap><a href="#init">init(self, node)</a></td>
-	<td class="summary">Component init function</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#set_enabled">set_enabled(self, state)</a></td>
-	<td class="summary">Set enabled blocker component state</td>
+	<td class="summary"><a href="../modules/Blocker.html#">Blocker</a> constructor</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#is_enabled">is_enabled(self)</a></td>
-	<td class="summary">Return blocked enabled state</td>
+	<td class="summary">Return blocker enabled state</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#set_enabled">set_enabled(self, state)</a></td>
+	<td class="summary">Set enabled blocker component state.</td>
 	</tr>
 </table>
 <h2><a href="#Fields">Fields</a></h2>
 <table class="function_list">
 	<tr>
 	<td class="name" nowrap><a href="#node">node</a></td>
-	<td class="summary">Trigger node</td>
+	<td class="summary">Blocker node</td>
 	</tr>
 </table>
 
@@ -109,14 +126,14 @@
     <strong>init(self, node)</strong>
     </dt>
     <dd>
-    Component init function
+    <a href="../modules/Blocker.html#">Blocker</a> constructor
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Blocker</span></span>
-
+         <a href="../modules/Blocker.html#">Blocker</a>
         </li>
         <li><span class="parameter">node</span>
             <span class="types"><a class="type" href="../modules/Blocker.html#node">node</a></span>
@@ -128,45 +145,20 @@
 
 
 
-</dd>
-    <dt>
-    <a name = "set_enabled"></a>
-    <strong>set_enabled(self, state)</strong>
-    </dt>
-    <dd>
-    Set enabled blocker component state
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">Blocker</span></span>
-
-        </li>
-        <li><span class="parameter">state</span>
-            <span class="types"><span class="type">bool</span></span>
-         Enabled state
-        </li>
-    </ul>
-
-
-
-
-
 </dd>
     <dt>
     <a name = "is_enabled"></a>
     <strong>is_enabled(self)</strong>
     </dt>
     <dd>
-    Return blocked enabled state
+    Return blocker enabled state
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Blocker</span></span>
-
+         <a href="../modules/Blocker.html#">Blocker</a>
         </li>
     </ul>
 
@@ -180,6 +172,32 @@
 
 
 
+</dd>
+    <dt>
+    <a name = "set_enabled"></a>
+    <strong>set_enabled(self, state)</strong>
+    </dt>
+    <dd>
+    Set enabled blocker component state.
+<p> Don't change node enabled state itself.
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Blocker</span></span>
+         <a href="../modules/Blocker.html#">Blocker</a>
+        </li>
+        <li><span class="parameter">state</span>
+            <span class="types"><span class="type">bool</span></span>
+         Enabled state
+        </li>
+    </ul>
+
+
+
+
+
 </dd>
 </dl>
     <h2 class="section-header "><a name="Fields"></a>Fields</h2>
@@ -190,7 +208,7 @@
     <strong>node</strong>
     </dt>
     <dd>
-    Trigger node
+    Blocker node
 
 
     <ul>
@@ -211,8 +229,8 @@
 </div> <!-- id="content" -->
 </div> <!-- id="main" -->
 <div id="about">
-<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-04-06 00:03:14 </i>
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc TESTING</a></i>
+<i style="float:right;">Last updated 2015-01-01 12:00:00 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

docs/modules/Checkbox.html

@@ -3,7 +3,7 @@
 <html>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
 <head>
-    <title>Defold Druid UI Library</title>
+    <title>Defold Druid UI Framework</title>
     <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
 </head>
 <body>
@@ -41,29 +41,34 @@
 <h2>Modules</h2>
 <ul class="nowrap">
   <li><a href="../modules/BackHandler.html">BackHandler</a></li>
+  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
   <li><a href="../modules/Blocker.html">Blocker</a></li>
   <li><a href="../modules/Button.html">Button</a></li>
-  <li><a href="../modules/Drag.html">Drag</a></li>
-  <li><a href="../modules/Hover.html">Hover</a></li>
-  <li><a href="../modules/Scroll.html">Scroll</a></li>
-  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
-  <li><a href="../modules/Swipe.html">Swipe</a></li>
-  <li><a href="../modules/Text.html">Text</a></li>
-  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
-  <li><a href="../modules/druid.html">druid</a></li>
-  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
   <li><strong>Checkbox</strong></li>
   <li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
   <li><a href="../modules/DataList.html">DataList</a></li>
+  <li><a href="../modules/Drag.html">Drag</a></li>
+  <li><a href="../modules/Druid.html">Druid</a></li>
+  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
+  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
   <li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
+  <li><a href="../modules/Helper.html">Helper</a></li>
+  <li><a href="../modules/Hotkey.html">Hotkey</a></li>
+  <li><a href="../modules/Hover.html">Hover</a></li>
   <li><a href="../modules/Input.html">Input</a></li>
   <li><a href="../modules/LangText.html">LangText</a></li>
+  <li><a href="../modules/Layout.html">Layout</a></li>
+  <li><a href="../modules/PinKnob.html">PinKnob</a></li>
   <li><a href="../modules/Progress.html">Progress</a></li>
   <li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
+  <li><a href="../modules/RichInput.html">RichInput</a></li>
+  <li><a href="../modules/RichText.html">RichText</a></li>
+  <li><a href="../modules/Scroll.html">Scroll</a></li>
   <li><a href="../modules/Slider.html">Slider</a></li>
+  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
+  <li><a href="../modules/Swipe.html">Swipe</a></li>
+  <li><a href="../modules/Text.html">Text</a></li>
   <li><a href="../modules/Timer.html">Timer</a></li>
-  <li><a href="../modules/druid.helper.html">druid.helper</a></li>
-  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
 </ul>
 
 </div>
@@ -72,23 +77,23 @@
 
 <h1>Module <code>Checkbox</code></h1>
 <p>Druid checkbox component</p>
-<p></p>
+<p> <a href="https://insality.github.io/druid/druid/index.html?example=general_checkboxes" target="_blank"><b>Example Link</b></a></p>
 
 
 <h2><a href="#Functions">Functions</a></h2>
 <table class="function_list">
 	<tr>
-	<td class="name" nowrap><a href="#init">init(self, node, callback[, click_node=node])</a></td>
+	<td class="name" nowrap><a href="#get_state">get_state(self)</a></td>
+	<td class="summary">Return checkbox state</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#init">init(self, node, callback[, click_node=node[, initial_state=false]])</a></td>
 	<td class="summary">Component init function</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#set_state">set_state(self, state, is_silent)</a></td>
+	<td class="name" nowrap><a href="#set_state">set_state(self, state, is_silent, is_instant)</a></td>
 	<td class="summary">Set checkbox state</td>
 	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#get_state">get_state(self)</a></td>
-	<td class="summary">Return checkbox state</td>
-	</tr>
 </table>
 <h2><a href="#Tables">Tables</a></h2>
 <table class="function_list">
@@ -100,20 +105,20 @@
 <h2><a href="#Fields">Fields</a></h2>
 <table class="function_list">
 	<tr>
-	<td class="name" nowrap><a href="#on_change_state">on_change_state</a></td>
-	<td class="summary">On change state callback(self, state)</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#node">node</a></td>
-	<td class="summary">Visual node</td>
+	<td class="name" nowrap><a href="#button">button</a></td>
+	<td class="summary">Button component from click_node</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#click_node">click_node</a></td>
 	<td class="summary">Button trigger node</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#button">button</a></td>
-	<td class="summary">Button component from click_node</td>
+	<td class="name" nowrap><a href="#node">node</a></td>
+	<td class="summary">Visual node</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#on_change_state">on_change_state</a></td>
+	<td class="summary">On change state callback(self, state)</td>
 	</tr>
 </table>
 
@@ -124,9 +129,36 @@
     <h2 class="section-header "><a name="Functions"></a>Functions</h2>
 
     <dl class="function">
+    <dt>
+    <a name = "get_state"></a>
+    <strong>get_state(self)</strong>
+    </dt>
+    <dd>
+    Return checkbox state
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Checkbox</span></span>
+         <a href="../modules/Checkbox.html#">Checkbox</a>
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">bool</span></span>
+        Checkbox state
+    </ol>
+
+
+
+
+</dd>
     <dt>
     <a name = "init"></a>
-    <strong>init(self, node, callback[, click_node=node])</strong>
+    <strong>init(self, node, callback[, click_node=node[, initial_state=false]])</strong>
     </dt>
     <dd>
     Component init function
@@ -136,7 +168,7 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Checkbox</span></span>
-
+         <a href="../modules/Checkbox.html#">Checkbox</a>
         </li>
         <li><span class="parameter">node</span>
             <span class="types"><a class="type" href="../modules/Checkbox.html#node">node</a></span>
@@ -151,6 +183,11 @@
          Trigger node, by default equals to node
          (<em>default</em> node)
         </li>
+        <li><span class="parameter">initial_state</span>
+            <span class="types"><span class="type">boolean</span></span>
+         The initial state of checkbox, default - false
+         (<em>default</em> false)
+        </li>
     </ul>
 
 
@@ -160,7 +197,7 @@
 </dd>
     <dt>
     <a name = "set_state"></a>
-    <strong>set_state(self, state, is_silent)</strong>
+    <strong>set_state(self, state, is_silent, is_instant)</strong>
     </dt>
     <dd>
     Set checkbox state
@@ -170,7 +207,7 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Checkbox</span></span>
-
+         <a href="../modules/Checkbox.html#">Checkbox</a>
         </li>
         <li><span class="parameter">state</span>
             <span class="types"><span class="type">bool</span></span>
@@ -180,35 +217,12 @@
             <span class="types"><span class="type">bool</span></span>
          Don't trigger on_change_state if true
         </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "get_state"></a>
-    <strong>get_state(self)</strong>
-    </dt>
-    <dd>
-    Return checkbox state
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">Checkbox</span></span>
-
+        <li><span class="parameter">is_instant</span>
+            <span class="types"><span class="type">bool</span></span>
+         If instant checkbox change
         </li>
     </ul>
 
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">bool</span></span>
-        Checkbox state
-    </ol>
 
 
 
@@ -246,37 +260,17 @@
 
     <dl class="function">
     <dt>
-    <a name = "on_change_state"></a>
-    <strong>on_change_state</strong>
+    <a name = "button"></a>
+    <strong>button</strong>
     </dt>
     <dd>
-    On change state callback(self, state)
+    Button component from click_node
 
 
     <ul>
-        <li><span class="parameter">on_change_state</span>
-            <span class="types"><span class="type">druid_event</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "node"></a>
-    <strong>node</strong>
-    </dt>
-    <dd>
-    Visual node
-
-
-    <ul>
-        <li><span class="parameter">node</span>
-            <span class="types"><a class="type" href="../modules/Checkbox.html#node">node</a></span>
-
+        <li><span class="parameter">button</span>
+            <span class="types"><span class="type">Button</span></span>
+         <a href="../modules/Button.html#">Button</a>
         </li>
     </ul>
 
@@ -307,16 +301,16 @@
 
 </dd>
     <dt>
-    <a name = "button"></a>
-    <strong>button</strong>
+    <a name = "node"></a>
+    <strong>node</strong>
     </dt>
     <dd>
-    Button component from click_node
+    Visual node
 
 
     <ul>
-        <li><span class="parameter">button</span>
-            <span class="types"><span class="type">Button</span></span>
+        <li><span class="parameter">node</span>
+            <span class="types"><a class="type" href="../modules/Checkbox.html#node">node</a></span>
 
         </li>
     </ul>
@@ -325,6 +319,26 @@
 
 
 
+</dd>
+    <dt>
+    <a name = "on_change_state"></a>
+    <strong>on_change_state</strong>
+    </dt>
+    <dd>
+    On change state callback(self, state)
+
+
+    <ul>
+        <li><span class="parameter">on_change_state</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
+        </li>
+    </ul>
+
+
+
+
+
 </dd>
 </dl>
 
@@ -332,8 +346,8 @@
 </div> <!-- id="content" -->
 </div> <!-- id="main" -->
 <div id="about">
-<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-04-06 00:03:14 </i>
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc TESTING</a></i>
+<i style="float:right;">Last updated 2015-01-01 12:00:00 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

docs/modules/CheckboxGroup.html

@@ -3,7 +3,7 @@
 <html>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
 <head>
-    <title>Defold Druid UI Library</title>
+    <title>Defold Druid UI Framework</title>
     <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
 </head>
 <body>
@@ -40,29 +40,34 @@
 <h2>Modules</h2>
 <ul class="nowrap">
   <li><a href="../modules/BackHandler.html">BackHandler</a></li>
+  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
   <li><a href="../modules/Blocker.html">Blocker</a></li>
   <li><a href="../modules/Button.html">Button</a></li>
-  <li><a href="../modules/Drag.html">Drag</a></li>
-  <li><a href="../modules/Hover.html">Hover</a></li>
-  <li><a href="../modules/Scroll.html">Scroll</a></li>
-  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
-  <li><a href="../modules/Swipe.html">Swipe</a></li>
-  <li><a href="../modules/Text.html">Text</a></li>
-  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
-  <li><a href="../modules/druid.html">druid</a></li>
-  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
   <li><a href="../modules/Checkbox.html">Checkbox</a></li>
   <li><strong>CheckboxGroup</strong></li>
   <li><a href="../modules/DataList.html">DataList</a></li>
+  <li><a href="../modules/Drag.html">Drag</a></li>
+  <li><a href="../modules/Druid.html">Druid</a></li>
+  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
+  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
   <li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
+  <li><a href="../modules/Helper.html">Helper</a></li>
+  <li><a href="../modules/Hotkey.html">Hotkey</a></li>
+  <li><a href="../modules/Hover.html">Hover</a></li>
   <li><a href="../modules/Input.html">Input</a></li>
   <li><a href="../modules/LangText.html">LangText</a></li>
+  <li><a href="../modules/Layout.html">Layout</a></li>
+  <li><a href="../modules/PinKnob.html">PinKnob</a></li>
   <li><a href="../modules/Progress.html">Progress</a></li>
   <li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
+  <li><a href="../modules/RichInput.html">RichInput</a></li>
+  <li><a href="../modules/RichText.html">RichText</a></li>
+  <li><a href="../modules/Scroll.html">Scroll</a></li>
   <li><a href="../modules/Slider.html">Slider</a></li>
+  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
+  <li><a href="../modules/Swipe.html">Swipe</a></li>
+  <li><a href="../modules/Text.html">Text</a></li>
   <li><a href="../modules/Timer.html">Timer</a></li>
-  <li><a href="../modules/druid.helper.html">druid.helper</a></li>
-  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
 </ul>
 
 </div>
@@ -71,34 +76,34 @@
 
 <h1>Module <code>CheckboxGroup</code></h1>
 <p>Checkbox group module</p>
-<p></p>
+<p> <a href="https://insality.github.io/druid/druid/index.html?example=general_checkboxes" target="_blank"><b>Example Link</b></a></p>
 
 
 <h2><a href="#Functions">Functions</a></h2>
 <table class="function_list">
+	<tr>
+	<td class="name" nowrap><a href="#get_state">get_state(self)</a></td>
+	<td class="summary">Return checkbox group state</td>
+	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#init">init(self, nodes, callback[, click_nodes=node])</a></td>
 	<td class="summary">Component init function</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#set_state">set_state(self, indexes)</a></td>
+	<td class="name" nowrap><a href="#set_state">set_state(self, indexes, is_instant)</a></td>
 	<td class="summary">Set checkbox group state</td>
 	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#get_state">get_state(self)</a></td>
-	<td class="summary">Return checkbox group state</td>
-	</tr>
 </table>
 <h2><a href="#Fields">Fields</a></h2>
 <table class="function_list">
-	<tr>
-	<td class="name" nowrap><a href="#on_checkbox_click">on_checkbox_click</a></td>
-	<td class="summary">On any checkbox click callback(self, index)</td>
-	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#checkboxes">checkboxes</a></td>
 	<td class="summary">Array of checkbox components</td>
 	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#on_checkbox_click">on_checkbox_click</a></td>
+	<td class="summary">On any checkbox click callback(self, index)</td>
+	</tr>
 </table>
 
 <br/>
@@ -108,6 +113,33 @@
     <h2 class="section-header "><a name="Functions"></a>Functions</h2>
 
     <dl class="function">
+    <dt>
+    <a name = "get_state"></a>
+    <strong>get_state(self)</strong>
+    </dt>
+    <dd>
+    Return checkbox group state
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">CheckboxGroup</span></span>
+         <a href="../modules/CheckboxGroup.html#">CheckboxGroup</a>
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">bool[]</span></span>
+        Array if checkboxes state
+    </ol>
+
+
+
+
+</dd>
     <dt>
     <a name = "init"></a>
     <strong>init(self, nodes, callback[, click_nodes=node])</strong>
@@ -120,7 +152,7 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">CheckboxGroup</span></span>
-
+         <a href="../modules/CheckboxGroup.html#">CheckboxGroup</a>
         </li>
         <li><span class="parameter">nodes</span>
             <span class="types"><span class="type">node[]</span></span>
@@ -144,7 +176,7 @@
 </dd>
     <dt>
     <a name = "set_state"></a>
-    <strong>set_state(self, indexes)</strong>
+    <strong>set_state(self, indexes, is_instant)</strong>
     </dt>
     <dd>
     Set checkbox group state
@@ -154,41 +186,18 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">CheckboxGroup</span></span>
-
+         <a href="../modules/CheckboxGroup.html#">CheckboxGroup</a>
         </li>
         <li><span class="parameter">indexes</span>
             <span class="types"><span class="type">bool[]</span></span>
          Array of checkbox state
         </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "get_state"></a>
-    <strong>get_state(self)</strong>
-    </dt>
-    <dd>
-    Return checkbox group state
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">CheckboxGroup</span></span>
-
+        <li><span class="parameter">is_instant</span>
+            <span class="types"><span class="type">boolean</span></span>
+         If instant state change
         </li>
     </ul>
 
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">bool[]</span></span>
-        Array if checkboxes state
-    </ol>
 
 
 
@@ -198,26 +207,6 @@
     <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 
     <dl class="function">
-    <dt>
-    <a name = "on_checkbox_click"></a>
-    <strong>on_checkbox_click</strong>
-    </dt>
-    <dd>
-    On any checkbox click callback(self, index)
-
-
-    <ul>
-        <li><span class="parameter">on_checkbox_click</span>
-            <span class="types"><span class="type">druid_event</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
     <dt>
     <a name = "checkboxes"></a>
     <strong>checkboxes</strong>
@@ -228,8 +217,28 @@
 
     <ul>
         <li><span class="parameter">checkboxes</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+         <a href="../modules/Checkbox.html#">Checkbox</a>
+        </li>
+    </ul>
 
+
+
+
+
+</dd>
+    <dt>
+    <a name = "on_checkbox_click"></a>
+    <strong>on_checkbox_click</strong>
+    </dt>
+    <dd>
+    On any checkbox click callback(self, index)
+
+
+    <ul>
+        <li><span class="parameter">on_checkbox_click</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
         </li>
     </ul>
 
@@ -244,8 +253,8 @@
 </div> <!-- id="content" -->
 </div> <!-- id="main" -->
 <div id="about">
-<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-04-06 00:03:14 </i>
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc TESTING</a></i>
+<i style="float:right;">Last updated 2015-01-01 12:00:00 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

docs/modules/DataList.html

@@ -3,7 +3,7 @@
 <html>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
 <head>
-    <title>Defold Druid UI Library</title>
+    <title>Defold Druid UI Framework</title>
     <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
 </head>
 <body>
@@ -40,29 +40,34 @@
 <h2>Modules</h2>
 <ul class="nowrap">
   <li><a href="../modules/BackHandler.html">BackHandler</a></li>
+  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
   <li><a href="../modules/Blocker.html">Blocker</a></li>
   <li><a href="../modules/Button.html">Button</a></li>
-  <li><a href="../modules/Drag.html">Drag</a></li>
-  <li><a href="../modules/Hover.html">Hover</a></li>
-  <li><a href="../modules/Scroll.html">Scroll</a></li>
-  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
-  <li><a href="../modules/Swipe.html">Swipe</a></li>
-  <li><a href="../modules/Text.html">Text</a></li>
-  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
-  <li><a href="../modules/druid.html">druid</a></li>
-  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
   <li><a href="../modules/Checkbox.html">Checkbox</a></li>
   <li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
   <li><strong>DataList</strong></li>
+  <li><a href="../modules/Drag.html">Drag</a></li>
+  <li><a href="../modules/Druid.html">Druid</a></li>
+  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
+  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
   <li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
+  <li><a href="../modules/Helper.html">Helper</a></li>
+  <li><a href="../modules/Hotkey.html">Hotkey</a></li>
+  <li><a href="../modules/Hover.html">Hover</a></li>
   <li><a href="../modules/Input.html">Input</a></li>
   <li><a href="../modules/LangText.html">LangText</a></li>
+  <li><a href="../modules/Layout.html">Layout</a></li>
+  <li><a href="../modules/PinKnob.html">PinKnob</a></li>
   <li><a href="../modules/Progress.html">Progress</a></li>
   <li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
+  <li><a href="../modules/RichInput.html">RichInput</a></li>
+  <li><a href="../modules/RichText.html">RichText</a></li>
+  <li><a href="../modules/Scroll.html">Scroll</a></li>
   <li><a href="../modules/Slider.html">Slider</a></li>
+  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
+  <li><a href="../modules/Swipe.html">Swipe</a></li>
+  <li><a href="../modules/Text.html">Text</a></li>
   <li><a href="../modules/Timer.html">Timer</a></li>
-  <li><a href="../modules/druid.helper.html">druid.helper</a></li>
-  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
 </ul>
 
 </div>
@@ -72,32 +77,37 @@
 <h1>Module <code>DataList</code></h1>
 <p>Component to manage data for huge dataset in scroll.</p>
 <p>
- It requires Druid Scroll and Druid Grid (Static or Dynamic) components</p>
+ It requires Druid Scroll and Druid Grid (Static or Dynamic) components
+<p> <a href="https://insality.github.io/druid/druid/index.html?example=general_data_list" target="_blank"><b>Example Link</b></a></p>
 
 
 <h2><a href="#Functions">Functions</a></h2>
 <table class="function_list">
-	<tr>
-	<td class="name" nowrap><a href="#init">init(self, scroll, grid, create_function)</a></td>
-	<td class="summary">Data list constructor</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#on_remove">on_remove(self)</a></td>
-	<td class="summary">Druid System on_remove function</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#set_data">set_data(self, data)</a></td>
-	<td class="summary">Set new data set for DataList component</td>
-	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#clear">clear(self)</a></td>
 	<td class="summary">Clear the DataList and refresh visuals</td>
 	</tr>
 	<tr>
+	<td class="name" nowrap><a href="#get_created_components">get_created_components(self)</a></td>
+	<td class="summary">Return all currenly created components in DataList</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#get_created_nodes">get_created_nodes(self)</a></td>
+	<td class="summary">Return all currenly created nodes in DataList</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#get_data">get_data(self)</a></td>
+	<td class="summary">Return current data from DataList component</td>
+	</tr>
+	<tr>
 	<td class="name" nowrap><a href="#get_first_index">get_first_index(self)</a></td>
 	<td class="summary">Return first index from data.</td>
 	</tr>
 	<tr>
+	<td class="name" nowrap><a href="#get_index">get_index(self, data)</a></td>
+	<td class="summary">Return index for data value</td>
+	</tr>
+	<tr>
 	<td class="name" nowrap><a href="#get_last_index">get_last_index(self)</a></td>
 	<td class="summary">Return last index from data</td>
 	</tr>
@@ -106,40 +116,56 @@
 	<td class="summary">Return amount of data</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#get_index">get_index(self, data)</a></td>
-	<td class="summary">Return index for data value</td>
+	<td class="name" nowrap><a href="#init">init(self, scroll, grid, create_function)</a></td>
+	<td class="summary">Data list constructor</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#on_remove">on_remove(self)</a></td>
+	<td class="summary">Druid System on_remove function</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#scroll_to_index">scroll_to_index(self, index)</a></td>
 	<td class="summary">Instant scroll to element with passed index</td>
 	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#set_data">set_data(self, data)</a></td>
+	<td class="summary">Set new data set for DataList component</td>
+	</tr>
 </table>
 <h2><a href="#Fields">Fields</a></h2>
 <table class="function_list">
-	<tr>
-	<td class="name" nowrap><a href="#scroll">scroll</a></td>
-	<td class="summary">The Druid scroll component</td>
-	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#grid">grid</a></td>
 	<td class="summary">The Druid Grid component</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#top_index">top_index</a></td>
-	<td class="summary">The current visual top data index</td>
-	</tr>
-	<tr>
 	<td class="name" nowrap><a href="#last_index">last_index</a></td>
 	<td class="summary">The current visual last data index</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#scroll_progress">scroll_progress</a></td>
-	<td class="summary">The current progress of scroll posititon</td>
+	<td class="name" nowrap><a href="#on_element_add">on_element_add</a></td>
+	<td class="summary">On DataList visual element created Event callback(self, index, node, instance)</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#on_element_remove">on_element_remove</a></td>
+	<td class="summary">On DataList visual element created Event callback(self, index)</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#on_scroll_progress_change">on_scroll_progress_change</a></td>
 	<td class="summary">Event triggered when scroll progress is changed; event(self, progress_value)</td>
 	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#scroll">scroll</a></td>
+	<td class="summary">The Druid scroll component</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#scroll_progress">scroll_progress</a></td>
+	<td class="summary">The current progress of scroll posititon</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#top_index">top_index</a></td>
+	<td class="summary">The current visual top data index</td>
+	</tr>
 </table>
 
 <br/>
@@ -149,6 +175,196 @@
     <h2 class="section-header "><a name="Functions"></a>Functions</h2>
 
     <dl class="function">
+    <dt>
+    <a name = "clear"></a>
+    <strong>clear(self)</strong>
+    </dt>
+    <dd>
+    Clear the DataList and refresh visuals
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">DataList</span></span>
+         <a href="../modules/DataList.html#">DataList</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "get_created_components"></a>
+    <strong>get_created_components(self)</strong>
+    </dt>
+    <dd>
+    Return all currenly created components in DataList
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">DataList</span></span>
+         <a href="../modules/DataList.html#">DataList</a>
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">druid.base_component[]</span></span>
+        List of created nodes
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "get_created_nodes"></a>
+    <strong>get_created_nodes(self)</strong>
+    </dt>
+    <dd>
+    Return all currenly created nodes in DataList
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">DataList</span></span>
+         <a href="../modules/DataList.html#">DataList</a>
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">Node[]</span></span>
+        List of created nodes
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "get_data"></a>
+    <strong>get_data(self)</strong>
+    </dt>
+    <dd>
+    Return current data from DataList component
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">DataList</span></span>
+         <a href="../modules/DataList.html#">DataList</a>
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+        The current data array
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "get_first_index"></a>
+    <strong>get_first_index(self)</strong>
+    </dt>
+    <dd>
+    Return first index from data.  It not always equals to 1
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">DataList</span></span>
+         <a href="../modules/DataList.html#">DataList</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "get_index"></a>
+    <strong>get_index(self, data)</strong>
+    </dt>
+    <dd>
+    Return index for data value
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">DataList</span></span>
+         <a href="../modules/DataList.html#">DataList</a>
+        </li>
+        <li><span class="parameter">data</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "get_last_index"></a>
+    <strong>get_last_index(self)</strong>
+    </dt>
+    <dd>
+    Return last index from data
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">DataList</span></span>
+         <a href="../modules/DataList.html#">DataList</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "get_length"></a>
+    <strong>get_length(self)</strong>
+    </dt>
+    <dd>
+    Return amount of data
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">DataList</span></span>
+         <a href="../modules/DataList.html#">DataList</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
     <dt>
     <a name = "init"></a>
     <strong>init(self, scroll, grid, create_function)</strong>
@@ -161,15 +377,15 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">DataList</span></span>
-
+         <a href="../modules/DataList.html#">DataList</a>
         </li>
         <li><span class="parameter">scroll</span>
-            <span class="types"><span class="type">druid.scroll</span></span>
-         The Scroll instance for Data List component
+            <span class="types"><span class="type">Scroll</span></span>
+         The <a href="../modules/Scroll.html#">Scroll</a> instance for Data List component
         </li>
         <li><span class="parameter">grid</span>
-            <span class="types"><span class="type">druid.grid</span></span>
-         The Grid instance for Data List component
+            <span class="types"><span class="type">StaticGrid</span> or <span class="type">DynamicGrid</span></span>
+         The <a href="../modules/StaticGrid.html#">StaticGrid</a> or <a href="../modules/DynamicGrid.html#">DynamicGrid</a> instance for Data List component
         </li>
         <li><span class="parameter">create_function</span>
             <span class="types"><span class="type">function</span></span>
@@ -194,6 +410,31 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">DataList</span></span>
+         <a href="../modules/DataList.html#">DataList</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "scroll_to_index"></a>
+    <strong>scroll_to_index(self, index)</strong>
+    </dt>
+    <dd>
+    Instant scroll to element with passed index
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">DataList</span></span>
+         <a href="../modules/DataList.html#">DataList</a>
+        </li>
+        <li><span class="parameter">index</span>
+            <span class="types"><span class="type">number</span></span>
 
         </li>
     </ul>
@@ -215,10 +456,10 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">DataList</span></span>
-
+         <a href="../modules/DataList.html#">DataList</a>
         </li>
         <li><span class="parameter">data</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
          The new data array
         </li>
     </ul>
@@ -233,165 +474,11 @@
 
 
 
-</dd>
-    <dt>
-    <a name = "clear"></a>
-    <strong>clear(self)</strong>
-    </dt>
-    <dd>
-    Clear the DataList and refresh visuals
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">DataList</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "get_first_index"></a>
-    <strong>get_first_index(self)</strong>
-    </dt>
-    <dd>
-    Return first index from data.  It not always equals to 1
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">DataList</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "get_last_index"></a>
-    <strong>get_last_index(self)</strong>
-    </dt>
-    <dd>
-    Return last index from data
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">DataList</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "get_length"></a>
-    <strong>get_length(self)</strong>
-    </dt>
-    <dd>
-    Return amount of data
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">DataList</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "get_index"></a>
-    <strong>get_index(self, data)</strong>
-    </dt>
-    <dd>
-    Return index for data value
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">DataList</span></span>
-
-        </li>
-        <li><span class="parameter">data</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "scroll_to_index"></a>
-    <strong>scroll_to_index(self, index)</strong>
-    </dt>
-    <dd>
-    Instant scroll to element with passed index
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">DataList</span></span>
-
-        </li>
-        <li><span class="parameter">index</span>
-            <span class="types"><span class="type">number</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
 </dd>
 </dl>
     <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 
     <dl class="function">
-    <dt>
-    <a name = "scroll"></a>
-    <strong>scroll</strong>
-    </dt>
-    <dd>
-    The Druid scroll component
-
-
-    <ul>
-        <li><span class="parameter">scroll</span>
-            <span class="types"><span class="type">druid.scroll</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
     <dt>
     <a name = "grid"></a>
     <strong>grid</strong>
@@ -402,28 +489,8 @@
 
     <ul>
         <li><span class="parameter">grid</span>
-            <span class="types"><span class="type">druid.static_grid</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "top_index"></a>
-    <strong>top_index</strong>
-    </dt>
-    <dd>
-    The current visual top data index
-
-
-    <ul>
-        <li><span class="parameter">top_index</span>
-            <span class="types"><span class="type">number</span></span>
-
+            <span class="types"><span class="type">StaticGrid</span> or <span class="type">DynamicGrid</span></span>
+         <a href="../modules/StaticGrid.html#">StaticGrid</a>, <a href="../modules/DynamicGrid.html#">DynamicGrid</a>
         </li>
     </ul>
 
@@ -451,6 +518,86 @@
 
 
 
+</dd>
+    <dt>
+    <a name = "on_element_add"></a>
+    <strong>on_element_add</strong>
+    </dt>
+    <dd>
+    On DataList visual element created Event callback(self, index, node, instance)
+
+
+    <ul>
+        <li><span class="parameter">on_element_add</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "on_element_remove"></a>
+    <strong>on_element_remove</strong>
+    </dt>
+    <dd>
+    On DataList visual element created Event callback(self, index)
+
+
+    <ul>
+        <li><span class="parameter">on_element_remove</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "on_scroll_progress_change"></a>
+    <strong>on_scroll_progress_change</strong>
+    </dt>
+    <dd>
+    Event triggered when scroll progress is changed; event(self, progress_value)
+
+
+    <ul>
+        <li><span class="parameter">on_scroll_progress_change</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "scroll"></a>
+    <strong>scroll</strong>
+    </dt>
+    <dd>
+    The Druid scroll component
+
+
+    <ul>
+        <li><span class="parameter">scroll</span>
+            <span class="types"><span class="type">Scroll</span></span>
+         <a href="../modules/Scroll.html#">Scroll</a>
+        </li>
+    </ul>
+
+
+
+
+
 </dd>
     <dt>
     <a name = "scroll_progress"></a>
@@ -473,16 +620,16 @@
 
 </dd>
     <dt>
-    <a name = "on_scroll_progress_change"></a>
-    <strong>on_scroll_progress_change</strong>
+    <a name = "top_index"></a>
+    <strong>top_index</strong>
     </dt>
     <dd>
-    Event triggered when scroll progress is changed; event(self, progress_value)
+    The current visual top data index
 
 
     <ul>
-        <li><span class="parameter">on_scroll_progress_change</span>
-            <span class="types"><span class="type">druid_event</span></span>
+        <li><span class="parameter">top_index</span>
+            <span class="types"><span class="type">number</span></span>
 
         </li>
     </ul>
@@ -498,8 +645,8 @@
 </div> <!-- id="content" -->
 </div> <!-- id="main" -->
 <div id="about">
-<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-04-06 00:03:14 </i>
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc TESTING</a></i>
+<i style="float:right;">Last updated 2015-01-01 12:00:00 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

docs/modules/Drag.html

@@ -3,7 +3,7 @@
 <html>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
 <head>
-    <title>Defold Druid UI Library</title>
+    <title>Defold Druid UI Framework</title>
     <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
 </head>
 <body>
@@ -41,29 +41,34 @@
 <h2>Modules</h2>
 <ul class="nowrap">
   <li><a href="../modules/BackHandler.html">BackHandler</a></li>
+  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
   <li><a href="../modules/Blocker.html">Blocker</a></li>
   <li><a href="../modules/Button.html">Button</a></li>
-  <li><strong>Drag</strong></li>
-  <li><a href="../modules/Hover.html">Hover</a></li>
-  <li><a href="../modules/Scroll.html">Scroll</a></li>
-  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
-  <li><a href="../modules/Swipe.html">Swipe</a></li>
-  <li><a href="../modules/Text.html">Text</a></li>
-  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
-  <li><a href="../modules/druid.html">druid</a></li>
-  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
   <li><a href="../modules/Checkbox.html">Checkbox</a></li>
   <li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
   <li><a href="../modules/DataList.html">DataList</a></li>
+  <li><strong>Drag</strong></li>
+  <li><a href="../modules/Druid.html">Druid</a></li>
+  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
+  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
   <li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
+  <li><a href="../modules/Helper.html">Helper</a></li>
+  <li><a href="../modules/Hotkey.html">Hotkey</a></li>
+  <li><a href="../modules/Hover.html">Hover</a></li>
   <li><a href="../modules/Input.html">Input</a></li>
   <li><a href="../modules/LangText.html">LangText</a></li>
+  <li><a href="../modules/Layout.html">Layout</a></li>
+  <li><a href="../modules/PinKnob.html">PinKnob</a></li>
   <li><a href="../modules/Progress.html">Progress</a></li>
   <li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
+  <li><a href="../modules/RichInput.html">RichInput</a></li>
+  <li><a href="../modules/RichText.html">RichText</a></li>
+  <li><a href="../modules/Scroll.html">Scroll</a></li>
   <li><a href="../modules/Slider.html">Slider</a></li>
+  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
+  <li><a href="../modules/Swipe.html">Swipe</a></li>
+  <li><a href="../modules/Text.html">Text</a></li>
   <li><a href="../modules/Timer.html">Timer</a></li>
-  <li><a href="../modules/druid.helper.html">druid.helper</a></li>
-  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
 </ul>
 
 </div>
@@ -75,7 +80,8 @@
 <p>
  Drag have correct handling for multitouch and swap
  touched while dragging. Drag will be processed even
- the cursor is outside of node, if drag is already started</p>
+ the cursor is outside of node, if drag is already started
+<p> <a href="https://insality.github.io/druid/druid/index.html?example=general_drag" target="_blank"><b>Example Link</b></a></p>
 
 
 <h2><a href="#Functions">Functions</a></h2>
@@ -85,9 +91,17 @@
 	<td class="summary">Drag component constructor</td>
 	</tr>
 	<tr>
+	<td class="name" nowrap><a href="#is_enabled">is_enabled(self)</a></td>
+	<td class="summary">Check if Drag component is enabled</td>
+	</tr>
+	<tr>
 	<td class="name" nowrap><a href="#set_click_zone">set_click_zone(self, node)</a></td>
 	<td class="summary">Strict drag click area.</td>
 	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#set_enabled">set_enabled(self, is_enabled)</a></td>
+	<td class="summary">Set Drag input enabled or disabled</td>
+	</tr>
 </table>
 <h2><a href="#Tables">Tables</a></h2>
 <table class="function_list">
@@ -98,34 +112,6 @@
 </table>
 <h2><a href="#Fields">Fields</a></h2>
 <table class="function_list">
-	<tr>
-	<td class="name" nowrap><a href="#on_touch_start">on_touch_start</a></td>
-	<td class="summary">Event on touch start callback(self)</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#on_touch_end">on_touch_end</a></td>
-	<td class="summary">Event on touch end callback(self)</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#on_drag_start">on_drag_start</a></td>
-	<td class="summary">Event on drag start callback(self)</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#on_drag">on_drag</a></td>
-	<td class="summary">on drag progress callback(self, dx, dy)</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#on_drag_end">on_drag_end</a></td>
-	<td class="summary">Event on drag end callback(self)</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#is_touch">is_touch</a></td>
-	<td class="summary">Is component now touching</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#is_drag">is_drag</a></td>
-	<td class="summary">Is component now dragging</td>
-	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#can_x">can_x</a></td>
 	<td class="summary">Is drag component process vertical dragging.</td>
@@ -135,6 +121,38 @@
 	<td class="summary">Is drag component process horizontal.</td>
 	</tr>
 	<tr>
+	<td class="name" nowrap><a href="#is_drag">is_drag</a></td>
+	<td class="summary">Is component now dragging</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#is_touch">is_touch</a></td>
+	<td class="summary">Is component now touching</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#on_drag">on_drag</a></td>
+	<td class="summary">on drag progress callback(self, dx, dy, total_x, total_y)</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#on_drag_end">on_drag_end</a></td>
+	<td class="summary">Event on drag end callback(self, total_x, total_y)</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#on_drag_start">on_drag_start</a></td>
+	<td class="summary">Event on drag start callback(self)</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#on_touch_end">on_touch_end</a></td>
+	<td class="summary">Event on touch end callback(self)</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#on_touch_start">on_touch_start</a></td>
+	<td class="summary">Event on touch start callback(self)</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#touch_start_pos">touch_start_pos</a></td>
+	<td class="summary">Touch start position</td>
+	</tr>
+	<tr>
 	<td class="name" nowrap><a href="#x">x</a></td>
 	<td class="summary">Current touch x position</td>
 	</tr>
@@ -142,10 +160,6 @@
 	<td class="name" nowrap><a href="#y">y</a></td>
 	<td class="summary">Current touch y position</td>
 	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#touch_start_pos">touch_start_pos</a></td>
-	<td class="summary">Touch start position</td>
-	</tr>
 </table>
 
 <br/>
@@ -167,7 +181,7 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Drag</span></span>
-
+         <a href="../modules/Drag.html#">Drag</a>
         </li>
         <li><span class="parameter">node</span>
             <span class="types"><span class="type">node</span></span>
@@ -183,6 +197,33 @@
 
 
 
+</dd>
+    <dt>
+    <a name = "is_enabled"></a>
+    <strong>is_enabled(self)</strong>
+    </dt>
+    <dd>
+    Check if Drag component is enabled
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Drag</span></span>
+         <a href="../modules/Drag.html#">Drag</a>
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">bool</span></span>
+
+    </ol>
+
+
+
+
 </dd>
     <dt>
     <a name = "set_click_zone"></a>
@@ -197,7 +238,7 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Drag</span></span>
-
+         <a href="../modules/Drag.html#">Drag</a>
         </li>
         <li><span class="parameter">node</span>
             <span class="types"><span class="type">node</span></span>
@@ -209,6 +250,31 @@
 
 
 
+</dd>
+    <dt>
+    <a name = "set_enabled"></a>
+    <strong>set_enabled(self, is_enabled)</strong>
+    </dt>
+    <dd>
+    Set Drag input enabled or disabled
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Drag</span></span>
+         <a href="../modules/Drag.html#">Drag</a>
+        </li>
+        <li><span class="parameter">is_enabled</span>
+            <span class="types"><span class="type">bool</span></span>
+
+        </li>
+    </ul>
+
+
+
+
+
 </dd>
 </dl>
     <h2 class="section-header "><a name="Tables"></a>Tables</h2>
@@ -231,6 +297,11 @@
          Distance in pixels to start dragging
          (<em>default</em> 10)
         </li>
+        <li><span class="parameter">NO_USE_SCREEN_KOEF</span>
+            <span class="types"><span class="type">boolean</span></span>
+         If screen aspect ratio affects on drag values
+         (<em>default</em> false)
+        </li>
     </ul>
 
 
@@ -242,146 +313,6 @@
     <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 
     <dl class="function">
-    <dt>
-    <a name = "on_touch_start"></a>
-    <strong>on_touch_start</strong>
-    </dt>
-    <dd>
-    Event on touch start callback(self)
-
-
-    <ul>
-        <li><span class="parameter">on_touch_start</span>
-            <span class="types"><span class="type">druid_event</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "on_touch_end"></a>
-    <strong>on_touch_end</strong>
-    </dt>
-    <dd>
-    Event on touch end callback(self)
-
-
-    <ul>
-        <li><span class="parameter">on_touch_end</span>
-            <span class="types"><span class="type">druid_event</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "on_drag_start"></a>
-    <strong>on_drag_start</strong>
-    </dt>
-    <dd>
-    Event on drag start callback(self)
-
-
-    <ul>
-        <li><span class="parameter">on_drag_start</span>
-            <span class="types"><span class="type">druid_event</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "on_drag"></a>
-    <strong>on_drag</strong>
-    </dt>
-    <dd>
-    on drag progress callback(self, dx, dy)
-
-
-    <ul>
-        <li><span class="parameter">on_drag</span>
-            <span class="types"><span class="type">druid_event</span></span>
-         Event
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "on_drag_end"></a>
-    <strong>on_drag_end</strong>
-    </dt>
-    <dd>
-    Event on drag end callback(self)
-
-
-    <ul>
-        <li><span class="parameter">on_drag_end</span>
-            <span class="types"><span class="type">druid_event</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "is_touch"></a>
-    <strong>is_touch</strong>
-    </dt>
-    <dd>
-    Is component now touching
-
-
-    <ul>
-        <li><span class="parameter">is_touch</span>
-            <span class="types"><span class="type">bool</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "is_drag"></a>
-    <strong>is_drag</strong>
-    </dt>
-    <dd>
-    Is component now dragging
-
-
-    <ul>
-        <li><span class="parameter">is_drag</span>
-            <span class="types"><span class="type">bool</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
     <dt>
     <a name = "can_x"></a>
     <strong>can_x</strong>
@@ -421,6 +352,166 @@
 
 
 
+</dd>
+    <dt>
+    <a name = "is_drag"></a>
+    <strong>is_drag</strong>
+    </dt>
+    <dd>
+    Is component now dragging
+
+
+    <ul>
+        <li><span class="parameter">is_drag</span>
+            <span class="types"><span class="type">bool</span></span>
+
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "is_touch"></a>
+    <strong>is_touch</strong>
+    </dt>
+    <dd>
+    Is component now touching
+
+
+    <ul>
+        <li><span class="parameter">is_touch</span>
+            <span class="types"><span class="type">bool</span></span>
+
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "on_drag"></a>
+    <strong>on_drag</strong>
+    </dt>
+    <dd>
+    on drag progress callback(self, dx, dy, total_x, total_y)
+
+
+    <ul>
+        <li><span class="parameter">on_drag</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         Event <a href="../modules/DruidEvent.html#">DruidEvent</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "on_drag_end"></a>
+    <strong>on_drag_end</strong>
+    </dt>
+    <dd>
+    Event on drag end callback(self, total_x, total_y)
+
+
+    <ul>
+        <li><span class="parameter">on_drag_end</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "on_drag_start"></a>
+    <strong>on_drag_start</strong>
+    </dt>
+    <dd>
+    Event on drag start callback(self)
+
+
+    <ul>
+        <li><span class="parameter">on_drag_start</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "on_touch_end"></a>
+    <strong>on_touch_end</strong>
+    </dt>
+    <dd>
+    Event on touch end callback(self)
+
+
+    <ul>
+        <li><span class="parameter">on_touch_end</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "on_touch_start"></a>
+    <strong>on_touch_start</strong>
+    </dt>
+    <dd>
+    Event on touch start callback(self)
+
+
+    <ul>
+        <li><span class="parameter">on_touch_start</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "touch_start_pos"></a>
+    <strong>touch_start_pos</strong>
+    </dt>
+    <dd>
+    Touch start position
+
+
+    <ul>
+        <li><span class="parameter">touch_start_pos</span>
+            <span class="types"><span class="type">vector3</span></span>
+
+        </li>
+    </ul>
+
+
+
+
+
 </dd>
     <dt>
     <a name = "x"></a>
@@ -461,26 +552,6 @@
 
 
 
-</dd>
-    <dt>
-    <a name = "touch_start_pos"></a>
-    <strong>touch_start_pos</strong>
-    </dt>
-    <dd>
-    Touch start position
-
-
-    <ul>
-        <li><span class="parameter">touch_start_pos</span>
-            <span class="types"><span class="type">vector3</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
 </dd>
 </dl>
 
@@ -488,8 +559,8 @@
 </div> <!-- id="content" -->
 </div> <!-- id="main" -->
 <div id="about">
-<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-04-06 00:03:14 </i>
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc TESTING</a></i>
+<i style="float:right;">Last updated 2015-01-01 12:00:00 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

docs/modules/DruidEvent.html

@@ -3,7 +3,7 @@
 <html>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
 <head>
-    <title>Defold Druid UI Library</title>
+    <title>Defold Druid UI Framework</title>
     <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
 </head>
 <body>
@@ -39,29 +39,34 @@
 <h2>Modules</h2>
 <ul class="nowrap">
   <li><a href="../modules/BackHandler.html">BackHandler</a></li>
+  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
   <li><a href="../modules/Blocker.html">Blocker</a></li>
   <li><a href="../modules/Button.html">Button</a></li>
-  <li><a href="../modules/Drag.html">Drag</a></li>
-  <li><a href="../modules/Hover.html">Hover</a></li>
-  <li><a href="../modules/Scroll.html">Scroll</a></li>
-  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
-  <li><a href="../modules/Swipe.html">Swipe</a></li>
-  <li><a href="../modules/Text.html">Text</a></li>
-  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
-  <li><a href="../modules/druid.html">druid</a></li>
-  <li><strong>DruidEvent</strong></li>
   <li><a href="../modules/Checkbox.html">Checkbox</a></li>
   <li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
   <li><a href="../modules/DataList.html">DataList</a></li>
+  <li><a href="../modules/Drag.html">Drag</a></li>
+  <li><a href="../modules/Druid.html">Druid</a></li>
+  <li><strong>DruidEvent</strong></li>
+  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
   <li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
+  <li><a href="../modules/Helper.html">Helper</a></li>
+  <li><a href="../modules/Hotkey.html">Hotkey</a></li>
+  <li><a href="../modules/Hover.html">Hover</a></li>
   <li><a href="../modules/Input.html">Input</a></li>
   <li><a href="../modules/LangText.html">LangText</a></li>
+  <li><a href="../modules/Layout.html">Layout</a></li>
+  <li><a href="../modules/PinKnob.html">PinKnob</a></li>
   <li><a href="../modules/Progress.html">Progress</a></li>
   <li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
+  <li><a href="../modules/RichInput.html">RichInput</a></li>
+  <li><a href="../modules/RichText.html">RichText</a></li>
+  <li><a href="../modules/Scroll.html">Scroll</a></li>
   <li><a href="../modules/Slider.html">Slider</a></li>
+  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
+  <li><a href="../modules/Swipe.html">Swipe</a></li>
+  <li><a href="../modules/Text.html">Text</a></li>
   <li><a href="../modules/Timer.html">Timer</a></li>
-  <li><a href="../modules/druid.helper.html">druid.helper</a></li>
-  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
 </ul>
 
 </div>
@@ -69,36 +74,38 @@
 <div id="content">
 
 <h1>Module <code>DruidEvent</code></h1>
-<p>Lua event small library</p>
-<p></p>
+<p>Druid Event Module
+<p> The Event module provides a simple class for handling callbacks.</p>
+<p> It is used in many Druid components.
+<p> You can subscribe to an event using the `:subscribe` method and unsubscribe using the `:unsubscribe` method.</p>
 
 
 <h2><a href="#Functions">Functions</a></h2>
 <table class="function_list">
 	<tr>
-	<td class="name" nowrap><a href="#initialize">initialize(self, initial_callback)</a></td>
-	<td class="summary">Event constructur</td>
+	<td class="name" nowrap><a href="#clear">clear(self)</a></td>
+	<td class="summary">Clear the all event handlers</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#subscribe">subscribe(self, callback, context)</a></td>
-	<td class="summary">Subscribe callback on event</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#unsubscribe">unsubscribe(self, callback, context)</a></td>
-	<td class="summary">Unsubscribe callback on event</td>
+	<td class="name" nowrap><a href="#initialize">initialize(self[, initial_callback])</a></td>
+	<td class="summary">DruidEvent constructor</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#is_exist">is_exist(self)</a></td>
 	<td class="summary">Return true, if event have at lease one handler</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#clear">clear(self)</a></td>
-	<td class="summary">Clear the all event handlers</td>
+	<td class="name" nowrap><a href="#subscribe">subscribe(self, callback[, context])</a></td>
+	<td class="summary">Subscribe callback on event</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#trigger">trigger(self, ...)</a></td>
 	<td class="summary">Trigger the event and call all subscribed callbacks</td>
 	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#unsubscribe">unsubscribe(self, callback[, context])</a></td>
+	<td class="summary">Unsubscribe callback on event</td>
+	</tr>
 </table>
 
 <br/>
@@ -109,87 +116,61 @@
 
     <dl class="function">
     <dt>
-    <a name = "initialize"></a>
-    <strong>initialize(self, initial_callback)</strong>
+    <a name = "clear"></a>
+    <strong>clear(self)</strong>
     </dt>
     <dd>
-    Event constructur
+    Clear the all event handlers
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
+        </li>
+    </ul>
 
+
+
+
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example">button.on_long_click:clear()</pre>
+    </ul>
+
+</dd>
+    <dt>
+    <a name = "initialize"></a>
+    <strong>initialize(self[, initial_callback])</strong>
+    </dt>
+    <dd>
+    DruidEvent constructor
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
         </li>
         <li><span class="parameter">initial_callback</span>
             <span class="types"><span class="type">function</span></span>
          Subscribe the callback on new event, if callback exist
+         (<em>optional</em>)
         </li>
     </ul>
 
 
 
 
-
-</dd>
-    <dt>
-    <a name = "subscribe"></a>
-    <strong>subscribe(self, callback, context)</strong>
-    </dt>
-    <dd>
-    Subscribe callback on event
-
-
-    <h3>Parameters:</h3>
+    <h3>Usage:</h3>
     <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">DruidEvent</span></span>
-
-        </li>
-        <li><span class="parameter">callback</span>
-            <span class="types"><span class="type">function</span></span>
-         Callback itself
-        </li>
-        <li><span class="parameter">context</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
-         Additional context as first param to callback call
-        </li>
+        <pre class="example"><span class="keyword">local</span> Event = <span class="global">require</span>(<span class="string">"druid.event"</span>)
+...
+<span class="keyword">local</span> event = Event(initial_callback)</pre>
     </ul>
 
-
-
-
-
-</dd>
-    <dt>
-    <a name = "unsubscribe"></a>
-    <strong>unsubscribe(self, callback, context)</strong>
-    </dt>
-    <dd>
-    Unsubscribe callback on event
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">DruidEvent</span></span>
-
-        </li>
-        <li><span class="parameter">callback</span>
-            <span class="types"><span class="type">function</span></span>
-         Callback itself
-        </li>
-        <li><span class="parameter">context</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
-         Additional context as first param to callback call
-        </li>
-    </ul>
-
-
-
-
-
 </dd>
     <dt>
     <a name = "is_exist"></a>
@@ -203,7 +184,7 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">DruidEvent</span></span>
-
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
         </li>
     </ul>
 
@@ -216,27 +197,49 @@
 
 
 
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example"><span class="keyword">local</span> is_long_click_handler_exists = button.on_long_click:is_exist()</pre>
+    </ul>
 
 </dd>
     <dt>
-    <a name = "clear"></a>
-    <strong>clear(self)</strong>
+    <a name = "subscribe"></a>
+    <strong>subscribe(self, callback[, context])</strong>
     </dt>
     <dd>
-    Clear the all event handlers
+    Subscribe callback on event
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">DruidEvent</span></span>
-
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
+        </li>
+        <li><span class="parameter">callback</span>
+            <span class="types"><span class="type">function</span></span>
+         Callback itself
+        </li>
+        <li><span class="parameter">context</span>
+            <span class="types"><span class="type">Any</span></span>
+         Additional context as first param to callback call, usually it's self
+         (<em>optional</em>)
         </li>
     </ul>
 
 
 
 
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example"><span class="keyword">local</span> <span class="keyword">function</span> on_long_callback(self)
+    <span class="global">print</span>(<span class="string">"Long click!"</span>)
+<span class="keyword">end</span>
+...
+<span class="keyword">local</span> button = self.druid:new_button(<span class="string">"button"</span>, callback)
+button.on_long_click:subscribe(on_long_callback, self)</pre>
+    </ul>
 
 </dd>
     <dt>
@@ -251,10 +254,10 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">DruidEvent</span></span>
-
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
         </li>
         <li><span class="parameter">...</span>
-            <span class="types"><span class="type">any</span></span>
+            <span class="types"><span class="type">Any</span></span>
          All event params
         </li>
     </ul>
@@ -262,6 +265,51 @@
 
 
 
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example"><span class="keyword">local</span> Event = <span class="global">require</span>(<span class="string">"druid.event"</span>)
+...
+<span class="keyword">local</span> event = Event()
+event:trigger(<span class="string">"Param1"</span>, <span class="string">"Param2"</span>)</pre>
+    </ul>
+
+</dd>
+    <dt>
+    <a name = "unsubscribe"></a>
+    <strong>unsubscribe(self, callback[, context])</strong>
+    </dt>
+    <dd>
+    Unsubscribe callback on event
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
+        </li>
+        <li><span class="parameter">callback</span>
+            <span class="types"><span class="type">function</span></span>
+         Callback itself
+        </li>
+        <li><span class="parameter">context</span>
+            <span class="types"><span class="type">Any</span></span>
+         Additional context as first param to callback call
+         (<em>optional</em>)
+        </li>
+    </ul>
+
+
+
+
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example"><span class="keyword">local</span> <span class="keyword">function</span> on_long_callback(self)
+    <span class="global">print</span>(<span class="string">"Long click!"</span>)
+<span class="keyword">end</span>
+...
+button.on_long_click:unsubscribe(on_long_callback, self)</pre>
+    </ul>
 
 </dd>
 </dl>
@@ -270,8 +318,8 @@
 </div> <!-- id="content" -->
 </div> <!-- id="main" -->
 <div id="about">
-<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-04-06 00:03:14 </i>
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc TESTING</a></i>
+<i style="float:right;">Last updated 2015-01-01 12:00:00 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

docs/modules/Helper.html

@@ -0,0 +1,891 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+<head>
+    <title>Defold Druid UI Framework</title>
+    <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
+</head>
+<body>
+
+<div id="container">
+
+<div id="product">
+	<div id="product_logo"></div>
+	<div id="product_name"><big><b></b></big></div>
+	<div id="product_description"></div>
+</div> <!-- id="product" -->
+
+
+<div id="main">
+
+
+<!-- Menu -->
+
+<div id="navigation">
+<br/>
+<h1>Druid</h1>
+
+<ul>
+  <li><a href="../index.html">Index</a></li>
+</ul>
+
+<h2>Contents</h2>
+<ul>
+<li><a href="#Functions">Functions</a></li>
+</ul>
+
+
+<h2>Modules</h2>
+<ul class="nowrap">
+  <li><a href="../modules/BackHandler.html">BackHandler</a></li>
+  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
+  <li><a href="../modules/Blocker.html">Blocker</a></li>
+  <li><a href="../modules/Button.html">Button</a></li>
+  <li><a href="../modules/Checkbox.html">Checkbox</a></li>
+  <li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
+  <li><a href="../modules/DataList.html">DataList</a></li>
+  <li><a href="../modules/Drag.html">Drag</a></li>
+  <li><a href="../modules/Druid.html">Druid</a></li>
+  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
+  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
+  <li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
+  <li><strong>Helper</strong></li>
+  <li><a href="../modules/Hotkey.html">Hotkey</a></li>
+  <li><a href="../modules/Hover.html">Hover</a></li>
+  <li><a href="../modules/Input.html">Input</a></li>
+  <li><a href="../modules/LangText.html">LangText</a></li>
+  <li><a href="../modules/Layout.html">Layout</a></li>
+  <li><a href="../modules/PinKnob.html">PinKnob</a></li>
+  <li><a href="../modules/Progress.html">Progress</a></li>
+  <li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
+  <li><a href="../modules/RichInput.html">RichInput</a></li>
+  <li><a href="../modules/RichText.html">RichText</a></li>
+  <li><a href="../modules/Scroll.html">Scroll</a></li>
+  <li><a href="../modules/Slider.html">Slider</a></li>
+  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
+  <li><a href="../modules/Swipe.html">Swipe</a></li>
+  <li><a href="../modules/Text.html">Text</a></li>
+  <li><a href="../modules/Timer.html">Timer</a></li>
+</ul>
+
+</div>
+
+<div id="content">
+
+<h1>Module <code>Helper</code></h1>
+<p>Helper module with various usefull GUI functions.</p>
+<p></p>
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example">local helper = require(&quot;druid.helper&quot;)
+helper.centrate_nodes(0, node_1, node_2)
+</pre>
+    </ul>
+
+
+<h2><a href="#Functions">Functions</a></h2>
+<table class="function_list">
+	<tr>
+	<td class="name" nowrap><a href="#helper.add_array">helper.add_array(target[, source])</a></td>
+	<td class="summary">Add all elements from source array to the target array</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#helper.centrate_nodes">helper.centrate_nodes([margin=0], ...)</a></td>
+	<td class="summary">Centerate nodes by x position with margin.</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#helper.clamp">helper.clamp(a, min, max)</a></td>
+	<td class="summary">Clamp value between min and max</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#helper.contains">helper.contains(t, value)</a></td>
+	<td class="summary">Check if value is in array and return index of it</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#helper.deepcopy">helper.deepcopy(orig_table)</a></td>
+	<td class="summary">Make a copy table with all nested tables</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#helper.distance">helper.distance(x1, y1, x2, y2)</a></td>
+	<td class="summary">Calculate distance between two points</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#helper.get_border">helper.get_border(node[, offset])</a></td>
+	<td class="summary">Distance from node position to his borders</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#helper.get_closest_stencil_node">helper.get_closest_stencil_node(node)</a></td>
+	<td class="summary">Return closest non inverted clipping parent node for given node</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#helper.get_gui_scale">helper.get_gui_scale()</a></td>
+	<td class="summary">Get current GUI scale for each side</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#helper.get_pivot_offset">helper.get_pivot_offset(pivot)</a></td>
+	<td class="summary">Get node offset for given GUI pivot.</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#helper.get_scaled_size">helper.get_scaled_size(node)</a></td>
+	<td class="summary">Get node size adjusted by scale</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#helper.get_scene_scale">helper.get_scene_scale(node, include_passed_node_scale)</a></td>
+	<td class="summary">Get cumulative parent's node scale</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#helper.get_screen_aspect_koef">helper.get_screen_aspect_koef()</a></td>
+	<td class="summary">Get current screen stretch multiplier for each side</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#helper.get_text_metrics_from_node">helper.get_text_metrics_from_node(text_node)</a></td>
+	<td class="summary">Get text metric from GUI node.</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#helper.insert_with_shift">helper.insert_with_shift(array, item[, index[, shift_policy]])</a></td>
+	<td class="summary">Add value to array with shift policy</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#helper.is_mobile">helper.is_mobile()</a></td>
+	<td class="summary">Check if device is native mobile (Android or iOS)</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#helper.is_web">helper.is_web()</a></td>
+	<td class="summary">Check if device is HTML5</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#helper.lerp">helper.lerp(a, b, t)</a></td>
+	<td class="summary">Lerp between two values</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#helper.remove_with_shift">helper.remove_with_shift(array[, index[, shift_policy]])</a></td>
+	<td class="summary">Remove value from array with shift policy</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#helper.round">helper.round(num[, num_decimal_places=0])</a></td>
+	<td class="summary">Round number to specified decimal places</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#helper.sign">helper.sign(val)</a></td>
+	<td class="summary">Return sign of value (-1, 0, 1)</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#helper.step">helper.step(current, target, step)</a></td>
+	<td class="summary">Move value from current to target value with step amount</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#helper.table_to_string">helper.table_to_string(t)</a></td>
+	<td class="summary">Simple table to one-line string converter</td>
+	</tr>
+</table>
+
+<br/>
+<br/>
+
+
+    <h2 class="section-header "><a name="Functions"></a>Functions</h2>
+
+    <dl class="function">
+    <dt>
+    <a name = "helper.add_array"></a>
+    <strong>helper.add_array(target[, source])</strong>
+    </dt>
+    <dd>
+    Add all elements from source array to the target array
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">target</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+         Array to put elements from source
+        </li>
+        <li><span class="parameter">source</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+         The source array to get elements from
+         (<em>optional</em>)
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">array</span></span>
+        The target array
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "helper.centrate_nodes"></a>
+    <strong>helper.centrate_nodes([margin=0], ...)</strong>
+    </dt>
+    <dd>
+    Centerate nodes by x position with margin.
+<p> This functions calculate total width of nodes and set position for each node.
+ The centrate will be around 0 x position.
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">margin</span>
+            <span class="types"><span class="type">number</span></span>
+         Offset between nodes
+         (<em>default</em> 0)
+        </li>
+        <li><span class="parameter">...</span>
+         Gui nodes
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "helper.clamp"></a>
+    <strong>helper.clamp(a, min, max)</strong>
+    </dt>
+    <dd>
+    Clamp value between min and max
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">a</span>
+            <span class="types"><span class="type">number</span></span>
+         Value
+        </li>
+        <li><span class="parameter">min</span>
+            <span class="types"><span class="type">number</span></span>
+         Min value
+        </li>
+        <li><span class="parameter">max</span>
+            <span class="types"><span class="type">number</span></span>
+         Max value
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">number</span></span>
+        Clamped value
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "helper.contains"></a>
+    <strong>helper.contains(t, value)</strong>
+    </dt>
+    <dd>
+    Check if value is in array and return index of it
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">t</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+         Array
+        </li>
+        <li><span class="parameter">value</span>
+         Value
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
+        Index of value or nil
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "helper.deepcopy"></a>
+    <strong>helper.deepcopy(orig_table)</strong>
+    </dt>
+    <dd>
+    Make a copy table with all nested tables
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">orig_table</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+         Original table
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+        Copy of original table
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "helper.distance"></a>
+    <strong>helper.distance(x1, y1, x2, y2)</strong>
+    </dt>
+    <dd>
+    Calculate distance between two points
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">x1</span>
+            <span class="types"><span class="type">number</span></span>
+         First point x
+        </li>
+        <li><span class="parameter">y1</span>
+            <span class="types"><span class="type">number</span></span>
+         First point y
+        </li>
+        <li><span class="parameter">x2</span>
+            <span class="types"><span class="type">number</span></span>
+         Second point x
+        </li>
+        <li><span class="parameter">y2</span>
+            <span class="types"><span class="type">number</span></span>
+         Second point y
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">number</span></span>
+        Distance
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "helper.get_border"></a>
+    <strong>helper.get_border(node[, offset])</strong>
+    </dt>
+    <dd>
+    Distance from node position to his borders
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">node</span>
+            <span class="types"><span class="type">node</span></span>
+         GUI node
+        </li>
+        <li><span class="parameter">offset</span>
+            <span class="types"><span class="type">vector3</span></span>
+         Offset from node position. Pass current node position to get non relative border values
+         (<em>optional</em>)
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">vector4</span></span>
+        Vector4 with border values (left, top, right, down)
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "helper.get_closest_stencil_node"></a>
+    <strong>helper.get_closest_stencil_node(node)</strong>
+    </dt>
+    <dd>
+    Return closest non inverted clipping parent node for given node
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">node</span>
+            <span class="types"><span class="type">node</span></span>
+         GUI node
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">node</span> or <span class="type">nil</span></span>
+        The closest stencil node or nil
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "helper.get_gui_scale"></a>
+    <strong>helper.get_gui_scale()</strong>
+    </dt>
+    <dd>
+    Get current GUI scale for each side
+
+
+
+    <h3>Returns:</h3>
+    <ol>
+        <li>
+           <span class="types"><span class="type">number</span></span>
+        scale_x</li>
+        <li>
+           <span class="types"><span class="type">number</span></span>
+        scale_y</li>
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "helper.get_pivot_offset"></a>
+    <strong>helper.get_pivot_offset(pivot)</strong>
+    </dt>
+    <dd>
+    Get node offset for given GUI pivot.
+<p> Offset shown in [-0.5 .. 0.5] range, where -0.5 is left or bottom, 0.5 is right or top.
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">pivot</span>
+            <span class="types"><span class="type">gui.pivot</span></span>
+         The node pivot
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">vector3</span></span>
+        Vector offset with [-0.5..0.5] values
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "helper.get_scaled_size"></a>
+    <strong>helper.get_scaled_size(node)</strong>
+    </dt>
+    <dd>
+    Get node size adjusted by scale
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">node</span>
+            <span class="types"><span class="type">node</span></span>
+         GUI node
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">vector3</span></span>
+        Scaled size
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "helper.get_scene_scale"></a>
+    <strong>helper.get_scene_scale(node, include_passed_node_scale)</strong>
+    </dt>
+    <dd>
+    Get cumulative parent's node scale
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">node</span>
+            <span class="types"><span class="type">node</span></span>
+         Gui node
+        </li>
+        <li><span class="parameter">include_passed_node_scale</span>
+            <span class="types"><span class="type">bool</span></span>
+         True if add current node scale to result
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">vector3</span></span>
+        The scene node scale
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "helper.get_screen_aspect_koef"></a>
+    <strong>helper.get_screen_aspect_koef()</strong>
+    </dt>
+    <dd>
+    Get current screen stretch multiplier for each side
+
+
+
+    <h3>Returns:</h3>
+    <ol>
+        <li>
+           <span class="types"><span class="type">number</span></span>
+        stretch_x</li>
+        <li>
+           <span class="types"><span class="type">number</span></span>
+        stretch_y</li>
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "helper.get_text_metrics_from_node"></a>
+    <strong>helper.get_text_metrics_from_node(text_node)</strong>
+    </dt>
+    <dd>
+    Get text metric from GUI node.
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">text_node</span>
+            <span class="types"><span class="type">Node</span></span>
+
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">GUITextMetrics</span></span>
+
+    </ol>
+
+
+
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example"><span class="global">type</span> GUITextMetrics = {
+  width: number,
+  height: number,
+  max_ascent: number,
+  max_descent: number
+}</pre>
+    </ul>
+
+</dd>
+    <dt>
+    <a name = "helper.insert_with_shift"></a>
+    <strong>helper.insert_with_shift(array, item[, index[, shift_policy]])</strong>
+    </dt>
+    <dd>
+    Add value to array with shift policy  Shift policy can be: left, right, no_shift
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">array</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+         Array
+        </li>
+        <li><span class="parameter">item</span>
+         Item to insert
+        </li>
+        <li><span class="parameter">index</span>
+            <span class="types"><span class="type">number</span></span>
+         Index to insert. If nil, item will be inserted at the end of array
+         (<em>optional</em>)
+        </li>
+        <li><span class="parameter">shift_policy</span>
+            <span class="types"><span class="type">const.SHIFT</span></span>
+         Shift policy
+         (<em>optional</em>)
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">item</span></span>
+        Inserted item
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "helper.is_mobile"></a>
+    <strong>helper.is_mobile()</strong>
+    </dt>
+    <dd>
+    Check if device is native mobile (Android or iOS)
+
+
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">bool</span></span>
+        Is mobile
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "helper.is_web"></a>
+    <strong>helper.is_web()</strong>
+    </dt>
+    <dd>
+    Check if device is HTML5
+
+
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">bool</span></span>
+        Is web
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "helper.lerp"></a>
+    <strong>helper.lerp(a, b, t)</strong>
+    </dt>
+    <dd>
+    Lerp between two values
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">a</span>
+            <span class="types"><span class="type">number</span></span>
+         First value
+        </li>
+        <li><span class="parameter">b</span>
+            <span class="types"><span class="type">number</span></span>
+         Second value
+        </li>
+        <li><span class="parameter">t</span>
+            <span class="types"><span class="type">number</span></span>
+         Lerp amount
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">number</span></span>
+        Lerped value
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "helper.remove_with_shift"></a>
+    <strong>helper.remove_with_shift(array[, index[, shift_policy]])</strong>
+    </dt>
+    <dd>
+    Remove value from array with shift policy  Shift policy can be: left, right, no_shift
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">array</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+         Array
+        </li>
+        <li><span class="parameter">index</span>
+            <span class="types"><span class="type">number</span></span>
+         Index to remove. If nil, item will be removed from the end of array
+         (<em>optional</em>)
+        </li>
+        <li><span class="parameter">shift_policy</span>
+            <span class="types"><span class="type">const.SHIFT</span></span>
+         Shift policy
+         (<em>optional</em>)
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">item</span></span>
+        Removed item
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "helper.round"></a>
+    <strong>helper.round(num[, num_decimal_places=0])</strong>
+    </dt>
+    <dd>
+    Round number to specified decimal places
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">num</span>
+            <span class="types"><span class="type">number</span></span>
+         Number
+        </li>
+        <li><span class="parameter">num_decimal_places</span>
+            <span class="types"><span class="type">number</span></span>
+         Decimal places
+         (<em>default</em> 0)
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">number</span></span>
+        Rounded number
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "helper.sign"></a>
+    <strong>helper.sign(val)</strong>
+    </dt>
+    <dd>
+    Return sign of value (-1, 0, 1)
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">val</span>
+            <span class="types"><span class="type">number</span></span>
+         Value
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">number</span></span>
+        Sign
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "helper.step"></a>
+    <strong>helper.step(current, target, step)</strong>
+    </dt>
+    <dd>
+    Move value from current to target value with step amount
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">current</span>
+            <span class="types"><span class="type">number</span></span>
+         Current value
+        </li>
+        <li><span class="parameter">target</span>
+            <span class="types"><span class="type">number</span></span>
+         Target value
+        </li>
+        <li><span class="parameter">step</span>
+            <span class="types"><span class="type">number</span></span>
+         Step amount
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">number</span></span>
+        New value
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "helper.table_to_string"></a>
+    <strong>helper.table_to_string(t)</strong>
+    </dt>
+    <dd>
+    Simple table to one-line string converter
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">t</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+
+    </ol>
+
+
+
+
+</dd>
+</dl>
+
+
+</div> <!-- id="content" -->
+</div> <!-- id="main" -->
+<div id="about">
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc TESTING</a></i>
+<i style="float:right;">Last updated 2015-01-01 12:00:00 </i>
+</div> <!-- id="about" -->
+</div> <!-- id="container" -->
+</body>
+</html>

docs/modules/Hotkey.html

@@ -0,0 +1,315 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+<head>
+    <title>Defold Druid UI Framework</title>
+    <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
+</head>
+<body>
+
+<div id="container">
+
+<div id="product">
+	<div id="product_logo"></div>
+	<div id="product_name"><big><b></b></big></div>
+	<div id="product_description"></div>
+</div> <!-- id="product" -->
+
+
+<div id="main">
+
+
+<!-- Menu -->
+
+<div id="navigation">
+<br/>
+<h1>Druid</h1>
+
+<ul>
+  <li><a href="../index.html">Index</a></li>
+</ul>
+
+<h2>Contents</h2>
+<ul>
+<li><a href="#Functions">Functions</a></li>
+<li><a href="#Tables">Tables</a></li>
+<li><a href="#Fields">Fields</a></li>
+</ul>
+
+
+<h2>Modules</h2>
+<ul class="nowrap">
+  <li><a href="../modules/BackHandler.html">BackHandler</a></li>
+  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
+  <li><a href="../modules/Blocker.html">Blocker</a></li>
+  <li><a href="../modules/Button.html">Button</a></li>
+  <li><a href="../modules/Checkbox.html">Checkbox</a></li>
+  <li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
+  <li><a href="../modules/DataList.html">DataList</a></li>
+  <li><a href="../modules/Drag.html">Drag</a></li>
+  <li><a href="../modules/Druid.html">Druid</a></li>
+  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
+  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
+  <li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
+  <li><a href="../modules/Helper.html">Helper</a></li>
+  <li><strong>Hotkey</strong></li>
+  <li><a href="../modules/Hover.html">Hover</a></li>
+  <li><a href="../modules/Input.html">Input</a></li>
+  <li><a href="../modules/LangText.html">LangText</a></li>
+  <li><a href="../modules/Layout.html">Layout</a></li>
+  <li><a href="../modules/PinKnob.html">PinKnob</a></li>
+  <li><a href="../modules/Progress.html">Progress</a></li>
+  <li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
+  <li><a href="../modules/RichInput.html">RichInput</a></li>
+  <li><a href="../modules/RichText.html">RichText</a></li>
+  <li><a href="../modules/Scroll.html">Scroll</a></li>
+  <li><a href="../modules/Slider.html">Slider</a></li>
+  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
+  <li><a href="../modules/Swipe.html">Swipe</a></li>
+  <li><a href="../modules/Text.html">Text</a></li>
+  <li><a href="../modules/Timer.html">Timer</a></li>
+</ul>
+
+</div>
+
+<div id="content">
+
+<h1>Module <code>Hotkey</code></h1>
+<p>Druid hotkey component</p>
+<p> <a href="https://insality.github.io/druid/druid/index.html?example=general_hotkey" target="_blank"><b>Example Link</b></a></p>
+
+
+<h2><a href="#Functions">Functions</a></h2>
+<table class="function_list">
+	<tr>
+	<td class="name" nowrap><a href="#add_hotkey">add_hotkey(self, keys[, callback_argument])</a></td>
+	<td class="summary">Add hotkey for component callback</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#init">init(self, keys, callback[, callback_argument])</a></td>
+	<td class="summary">Component init function</td>
+	</tr>
+</table>
+<h2><a href="#Tables">Tables</a></h2>
+<table class="function_list">
+	<tr>
+	<td class="name" nowrap><a href="#style">style</a></td>
+	<td class="summary">Component style params.</td>
+	</tr>
+</table>
+<h2><a href="#Fields">Fields</a></h2>
+<table class="function_list">
+	<tr>
+	<td class="name" nowrap><a href="#button">button</a></td>
+	<td class="summary">Button component from click_node</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#click_node">click_node</a></td>
+	<td class="summary">Button trigger node</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#node">node</a></td>
+	<td class="summary">Visual node</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#on_change_state">on_change_state</a></td>
+	<td class="summary">On change state callback(self, state)</td>
+	</tr>
+</table>
+
+<br/>
+<br/>
+
+
+    <h2 class="section-header "><a name="Functions"></a>Functions</h2>
+
+    <dl class="function">
+    <dt>
+    <a name = "add_hotkey"></a>
+    <strong>add_hotkey(self, keys[, callback_argument])</strong>
+    </dt>
+    <dd>
+    Add hotkey for component callback
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Hotkey</span></span>
+         <a href="../modules/Hotkey.html#">Hotkey</a>
+        </li>
+        <li><span class="parameter">keys</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string[]</a>, <span class="type">hash[]</span>, <a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a> or <span class="type">hash</span></span>
+         that have to be pressed before key pressed to activate
+        </li>
+        <li><span class="parameter">callback_argument</span>
+            <span class="types"><span class="type">value</span></span>
+         The argument to pass into the callback function
+         (<em>optional</em>)
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "init"></a>
+    <strong>init(self, keys, callback[, callback_argument])</strong>
+    </dt>
+    <dd>
+    Component init function
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Hotkey</span></span>
+         <a href="../modules/Hotkey.html#">Hotkey</a>
+        </li>
+        <li><span class="parameter">keys</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string[]</a> or <a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         The keys to be pressed for trigger callback. Should contains one key and any modificator keys
+        </li>
+        <li><span class="parameter">callback</span>
+            <span class="types"><span class="type">function</span></span>
+         The callback function
+        </li>
+        <li><span class="parameter">callback_argument</span>
+            <span class="types"><span class="type">value</span></span>
+         The argument to pass into the callback function
+         (<em>optional</em>)
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+</dl>
+    <h2 class="section-header "><a name="Tables"></a>Tables</h2>
+
+    <dl class="function">
+    <dt>
+    <a name = "style"></a>
+    <strong>style</strong>
+    </dt>
+    <dd>
+    Component style params.
+ You can override this component styles params in druid styles table
+ or create your own style
+
+
+    <h3>Fields:</h3>
+    <ul>
+        <li><span class="parameter">MODIFICATORS</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string[]</a></span>
+         The list of action_id as hotkey modificators
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+</dl>
+    <h2 class="section-header "><a name="Fields"></a>Fields</h2>
+
+    <dl class="function">
+    <dt>
+    <a name = "button"></a>
+    <strong>button</strong>
+    </dt>
+    <dd>
+    Button component from click_node
+
+
+    <ul>
+        <li><span class="parameter">button</span>
+            <span class="types"><span class="type">Button</span></span>
+         <a href="../modules/Button.html#">Button</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "click_node"></a>
+    <strong>click_node</strong>
+    </dt>
+    <dd>
+    Button trigger node
+
+
+    <ul>
+        <li><span class="parameter">click_node</span>
+            <span class="types"><a class="type" href="../modules/Hotkey.html#node">node</a></span>
+
+         (<em>default</em> node)
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "node"></a>
+    <strong>node</strong>
+    </dt>
+    <dd>
+    Visual node
+
+
+    <ul>
+        <li><span class="parameter">node</span>
+            <span class="types"><a class="type" href="../modules/Hotkey.html#node">node</a></span>
+
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "on_change_state"></a>
+    <strong>on_change_state</strong>
+    </dt>
+    <dd>
+    On change state callback(self, state)
+
+
+    <ul>
+        <li><span class="parameter">on_change_state</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+</dl>
+
+
+</div> <!-- id="content" -->
+</div> <!-- id="main" -->
+<div id="about">
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc TESTING</a></i>
+<i style="float:right;">Last updated 2015-01-01 12:00:00 </i>
+</div> <!-- id="about" -->
+</div> <!-- id="container" -->
+</body>
+</html>

docs/modules/Hover.html

@@ -3,7 +3,7 @@
 <html>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
 <head>
-    <title>Defold Druid UI Library</title>
+    <title>Defold Druid UI Framework</title>
     <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
 </head>
 <body>
@@ -40,29 +40,34 @@
 <h2>Modules</h2>
 <ul class="nowrap">
   <li><a href="../modules/BackHandler.html">BackHandler</a></li>
+  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
   <li><a href="../modules/Blocker.html">Blocker</a></li>
   <li><a href="../modules/Button.html">Button</a></li>
-  <li><a href="../modules/Drag.html">Drag</a></li>
-  <li><strong>Hover</strong></li>
-  <li><a href="../modules/Scroll.html">Scroll</a></li>
-  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
-  <li><a href="../modules/Swipe.html">Swipe</a></li>
-  <li><a href="../modules/Text.html">Text</a></li>
-  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
-  <li><a href="../modules/druid.html">druid</a></li>
-  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
   <li><a href="../modules/Checkbox.html">Checkbox</a></li>
   <li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
   <li><a href="../modules/DataList.html">DataList</a></li>
+  <li><a href="../modules/Drag.html">Drag</a></li>
+  <li><a href="../modules/Druid.html">Druid</a></li>
+  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
+  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
   <li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
+  <li><a href="../modules/Helper.html">Helper</a></li>
+  <li><a href="../modules/Hotkey.html">Hotkey</a></li>
+  <li><strong>Hover</strong></li>
   <li><a href="../modules/Input.html">Input</a></li>
   <li><a href="../modules/LangText.html">LangText</a></li>
+  <li><a href="../modules/Layout.html">Layout</a></li>
+  <li><a href="../modules/PinKnob.html">PinKnob</a></li>
   <li><a href="../modules/Progress.html">Progress</a></li>
   <li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
+  <li><a href="../modules/RichInput.html">RichInput</a></li>
+  <li><a href="../modules/RichText.html">RichText</a></li>
+  <li><a href="../modules/Scroll.html">Scroll</a></li>
   <li><a href="../modules/Slider.html">Slider</a></li>
+  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
+  <li><a href="../modules/Swipe.html">Swipe</a></li>
+  <li><a href="../modules/Text.html">Text</a></li>
   <li><a href="../modules/Timer.html">Timer</a></li>
-  <li><a href="../modules/druid.helper.html">druid.helper</a></li>
-  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
 </ul>
 
 </div>
@@ -81,12 +86,16 @@
 	<td class="summary">Component init function</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#set_hover">set_hover(self, state)</a></td>
-	<td class="summary">Set hover state</td>
+	<td class="name" nowrap><a href="#is_enabled">is_enabled(self)</a></td>
+	<td class="summary">Return current hover enabled state</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#set_mouse_hover">set_mouse_hover(self, state)</a></td>
-	<td class="summary">Set mouse hover state</td>
+	<td class="name" nowrap><a href="#is_hovered">is_hovered(self)</a></td>
+	<td class="summary">Return current hover state.</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#is_mouse_hovered">is_mouse_hovered(self)</a></td>
+	<td class="summary">Return current hover state.</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#set_click_zone">set_click_zone(self, zone)</a></td>
@@ -97,19 +106,23 @@
 	<td class="summary">Set enable state of hover component.</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#is_enabled">is_enabled(self)</a></td>
-	<td class="summary">Return current hover enabled state</td>
+	<td class="name" nowrap><a href="#set_hover">set_hover(self, state)</a></td>
+	<td class="summary">Set hover state</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#set_mouse_hover">set_mouse_hover(self, state)</a></td>
+	<td class="summary">Set mouse hover state</td>
 	</tr>
 </table>
 <h2><a href="#Fields">Fields</a></h2>
 <table class="function_list">
 	<tr>
 	<td class="name" nowrap><a href="#on_hover">on_hover</a></td>
-	<td class="summary">On hover callback(self, state)</td>
+	<td class="summary">On hover callback(self, state, hover_instance)</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#on_mouse_hover">on_mouse_hover</a></td>
-	<td class="summary">On mouse hover callback(self, state)</td>
+	<td class="summary">On mouse hover callback(self, state, hover_instance)</td>
 	</tr>
 </table>
 
@@ -132,7 +145,7 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Hover</span></span>
-
+         <a href="../modules/Hover.html#">Hover</a>
         </li>
         <li><span class="parameter">node</span>
             <span class="types"><span class="type">node</span></span>
@@ -150,50 +163,81 @@
 
 </dd>
     <dt>
-    <a name = "set_hover"></a>
-    <strong>set_hover(self, state)</strong>
+    <a name = "is_enabled"></a>
+    <strong>is_enabled(self)</strong>
     </dt>
     <dd>
-    Set hover state
+    Return current hover enabled state
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Hover</span></span>
-
-        </li>
-        <li><span class="parameter">state</span>
-            <span class="types"><span class="type">bool</span></span>
-         The hover state
+         <a href="../modules/Hover.html#">Hover</a>
         </li>
     </ul>
 
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">bool</span></span>
+        The hover enabled state
+    </ol>
 
 
 
 
 </dd>
     <dt>
-    <a name = "set_mouse_hover"></a>
-    <strong>set_mouse_hover(self, state)</strong>
+    <a name = "is_hovered"></a>
+    <strong>is_hovered(self)</strong>
     </dt>
     <dd>
-    Set mouse hover state
+    Return current hover state.  True if touch action was on the node at current time
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Hover</span></span>
-
-        </li>
-        <li><span class="parameter">state</span>
-            <span class="types"><span class="type">bool</span></span>
-         The mouse hover state
+         <a href="../modules/Hover.html#">Hover</a>
         </li>
     </ul>
 
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">bool</span></span>
+        The current hovered state
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "is_mouse_hovered"></a>
+    <strong>is_mouse_hovered(self)</strong>
+    </dt>
+    <dd>
+    Return current hover state.  True if nil action_id (usually desktop mouse) was on the node at current time
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Hover</span></span>
+         <a href="../modules/Hover.html#">Hover</a>
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">bool</span></span>
+        The current hovered state
+    </ol>
 
 
 
@@ -212,7 +256,7 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Hover</span></span>
-
+         <a href="../modules/Hover.html#">Hover</a>
         </li>
         <li><span class="parameter">zone</span>
             <span class="types"><span class="type">node</span></span>
@@ -239,7 +283,7 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Hover</span></span>
-
+         <a href="../modules/Hover.html#">Hover</a>
         </li>
         <li><span class="parameter">state</span>
             <span class="types"><span class="type">bool</span></span>
@@ -253,27 +297,50 @@
 
 </dd>
     <dt>
-    <a name = "is_enabled"></a>
-    <strong>is_enabled(self)</strong>
+    <a name = "set_hover"></a>
+    <strong>set_hover(self, state)</strong>
     </dt>
     <dd>
-    Return current hover enabled state
+    Set hover state
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Hover</span></span>
-
+         <a href="../modules/Hover.html#">Hover</a>
+        </li>
+        <li><span class="parameter">state</span>
+            <span class="types"><span class="type">bool</span></span>
+         The hover state
         </li>
     </ul>
 
-    <h3>Returns:</h3>
-    <ol>
 
-           <span class="types"><span class="type">bool</span></span>
-        The hover enabled state
-    </ol>
+
+
+
+</dd>
+    <dt>
+    <a name = "set_mouse_hover"></a>
+    <strong>set_mouse_hover(self, state)</strong>
+    </dt>
+    <dd>
+    Set mouse hover state
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Hover</span></span>
+         <a href="../modules/Hover.html#">Hover</a>
+        </li>
+        <li><span class="parameter">state</span>
+            <span class="types"><span class="type">bool</span></span>
+         The mouse hover state
+        </li>
+    </ul>
+
 
 
 
@@ -288,13 +355,13 @@
     <strong>on_hover</strong>
     </dt>
     <dd>
-    On hover callback(self, state)
+    On hover callback(self, state, hover_instance)
 
 
     <ul>
         <li><span class="parameter">on_hover</span>
-            <span class="types"><span class="type">druid_event</span></span>
-
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
         </li>
     </ul>
 
@@ -308,13 +375,13 @@
     <strong>on_mouse_hover</strong>
     </dt>
     <dd>
-    On mouse hover callback(self, state)
+    On mouse hover callback(self, state, hover_instance)
 
 
     <ul>
         <li><span class="parameter">on_mouse_hover</span>
-            <span class="types"><span class="type">druid_event</span></span>
-
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
         </li>
     </ul>
 
@@ -329,8 +396,8 @@
 </div> <!-- id="content" -->
 </div> <!-- id="main" -->
 <div id="about">
-<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-04-06 00:03:14 </i>
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc TESTING</a></i>
+<i style="float:right;">Last updated 2015-01-01 12:00:00 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

docs/modules/Input.html

@@ -3,7 +3,7 @@
 <html>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
 <head>
-    <title>Defold Druid UI Library</title>
+    <title>Defold Druid UI Framework</title>
     <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
 </head>
 <body>
@@ -41,29 +41,34 @@
 <h2>Modules</h2>
 <ul class="nowrap">
   <li><a href="../modules/BackHandler.html">BackHandler</a></li>
+  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
   <li><a href="../modules/Blocker.html">Blocker</a></li>
   <li><a href="../modules/Button.html">Button</a></li>
-  <li><a href="../modules/Drag.html">Drag</a></li>
-  <li><a href="../modules/Hover.html">Hover</a></li>
-  <li><a href="../modules/Scroll.html">Scroll</a></li>
-  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
-  <li><a href="../modules/Swipe.html">Swipe</a></li>
-  <li><a href="../modules/Text.html">Text</a></li>
-  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
-  <li><a href="../modules/druid.html">druid</a></li>
-  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
   <li><a href="../modules/Checkbox.html">Checkbox</a></li>
   <li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
   <li><a href="../modules/DataList.html">DataList</a></li>
+  <li><a href="../modules/Drag.html">Drag</a></li>
+  <li><a href="../modules/Druid.html">Druid</a></li>
+  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
+  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
   <li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
+  <li><a href="../modules/Helper.html">Helper</a></li>
+  <li><a href="../modules/Hotkey.html">Hotkey</a></li>
+  <li><a href="../modules/Hover.html">Hover</a></li>
   <li><strong>Input</strong></li>
   <li><a href="../modules/LangText.html">LangText</a></li>
+  <li><a href="../modules/Layout.html">Layout</a></li>
+  <li><a href="../modules/PinKnob.html">PinKnob</a></li>
   <li><a href="../modules/Progress.html">Progress</a></li>
   <li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
+  <li><a href="../modules/RichInput.html">RichInput</a></li>
+  <li><a href="../modules/RichText.html">RichText</a></li>
+  <li><a href="../modules/Scroll.html">Scroll</a></li>
   <li><a href="../modules/Slider.html">Slider</a></li>
+  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
+  <li><a href="../modules/Swipe.html">Swipe</a></li>
+  <li><a href="../modules/Text.html">Text</a></li>
   <li><a href="../modules/Timer.html">Timer</a></li>
-  <li><a href="../modules/druid.helper.html">druid.helper</a></li>
-  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
 </ul>
 
 </div>
@@ -73,7 +78,8 @@
 <h1>Module <code>Input</code></h1>
 <p>Druid input text component.</p>
 <p>
- Carry on user text input</p>
+ Carry on user text input
+<p> <a href="https://insality.github.io/druid/druid/index.html?example=general_input" target="_blank"><b>Example Link</b></a></p>
     <h3>Info:</h3>
     <ul>
         <li><strong>Author</strong>: Part of code from Britzl gooey input component</li>
@@ -83,32 +89,36 @@
 <h2><a href="#Functions">Functions</a></h2>
 <table class="function_list">
 	<tr>
-	<td class="name" nowrap><a href="#set_text">set_text(self, input_text)</a></td>
-	<td class="summary">Set text for input field</td>
+	<td class="name" nowrap><a href="#get_text">get_text(self)</a></td>
+	<td class="summary">Return current input field text</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#init">init(self, click_node, text_node[, keyboard_type])</a></td>
+	<td class="summary">Component init function</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#reset_changes">reset_changes(self)</a></td>
+	<td class="summary">Reset current input selection and return previous value</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#select">select(self)</a></td>
 	<td class="summary">Select input field.</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#unselect">unselect(self)</a></td>
-	<td class="summary">Remove selection from input.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#get_text">get_text(self)</a></td>
-	<td class="summary">Return current input field text</td>
+	<td class="name" nowrap><a href="#set_allowed_characters">set_allowed_characters(self, characters)</a></td>
+	<td class="summary">Set allowed charaters for input field.</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#set_max_length">set_max_length(self, max_length)</a></td>
 	<td class="summary">Set maximum length for input field.</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#set_allowed_characters">set_allowed_characters(self, characters)</a></td>
-	<td class="summary">Set allowed charaters for input field.</td>
+	<td class="name" nowrap><a href="#set_text">set_text(self, input_text)</a></td>
+	<td class="summary">Set text for input field</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#reset_changes">reset_changes(self)</a></td>
-	<td class="summary">Reset current input selection and return previous value</td>
+	<td class="name" nowrap><a href="#unselect">unselect(self)</a></td>
+	<td class="summary">Remove selection from input.</td>
 	</tr>
 </table>
 <h2><a href="#Tables">Tables</a></h2>
@@ -121,16 +131,28 @@
 <h2><a href="#Fields">Fields</a></h2>
 <table class="function_list">
 	<tr>
-	<td class="name" nowrap><a href="#on_input_select">on_input_select</a></td>
-	<td class="summary">On input field select callback(self, button_node)</td>
+	<td class="name" nowrap><a href="#allowerd_characters">allowerd_characters</a></td>
+	<td class="summary">Pattern matching for user input</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#on_input_unselect">on_input_unselect</a></td>
-	<td class="summary">On input field unselect callback(self, button_node)</td>
+	<td class="name" nowrap><a href="#button">button</a></td>
+	<td class="summary">Button component</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#on_input_text">on_input_text</a></td>
-	<td class="summary">On input field text change callback(self, input_text)</td>
+	<td class="name" nowrap><a href="#is_empty">is_empty</a></td>
+	<td class="summary">Is current input is empty now</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#is_selected">is_selected</a></td>
+	<td class="summary">Is current input selected now</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#keyboard_type">keyboard_type</a></td>
+	<td class="summary">Gui keyboard type for input field</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#max_length">max_length</a></td>
+	<td class="summary">Max length for input text</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#on_input_empty">on_input_empty</a></td>
@@ -141,6 +163,18 @@
 	<td class="summary">On input field text change to max length string callback(self, input_text)</td>
 	</tr>
 	<tr>
+	<td class="name" nowrap><a href="#on_input_select">on_input_select</a></td>
+	<td class="summary">On input field select callback(self, button_node)</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#on_input_text">on_input_text</a></td>
+	<td class="summary">On input field text change callback(self, input_text)</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#on_input_unselect">on_input_unselect</a></td>
+	<td class="summary">On input field unselect callback(self, input_text)</td>
+	</tr>
+	<tr>
 	<td class="name" nowrap><a href="#on_input_wrong">on_input_wrong</a></td>
 	<td class="summary">On trying user input with not allowed character callback(self, params, button_instance)</td>
 	</tr>
@@ -148,30 +182,6 @@
 	<td class="name" nowrap><a href="#text">text</a></td>
 	<td class="summary">Text component</td>
 	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#button">button</a></td>
-	<td class="summary">Button component</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#is_selected">is_selected</a></td>
-	<td class="summary">Is current input selected now</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#is_empty">is_empty</a></td>
-	<td class="summary">Is current input is empty now</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#max_length">max_length</a></td>
-	<td class="summary">Max length for input text</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#allowerd_characters">allowerd_characters</a></td>
-	<td class="summary">Pattern matching for user input</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#keyboard_type">keyboard_type</a></td>
-	<td class="summary">Gui keyboard type for input field</td>
-	</tr>
 </table>
 
 <br/>
@@ -182,22 +192,79 @@
 
     <dl class="function">
     <dt>
-    <a name = "set_text"></a>
-    <strong>set_text(self, input_text)</strong>
+    <a name = "get_text"></a>
+    <strong>get_text(self)</strong>
     </dt>
     <dd>
-    Set text for input field
+    Return current input field text
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Input</span></span>
-
+         <a href="../modules/Input.html#">Input</a>
         </li>
-        <li><span class="parameter">input_text</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
-         The string to apply for input field
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+        The current input field text
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "init"></a>
+    <strong>init(self, click_node, text_node[, keyboard_type])</strong>
+    </dt>
+    <dd>
+    Component init function
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Input</span></span>
+         <a href="../modules/Input.html#">Input</a>
+        </li>
+        <li><span class="parameter">click_node</span>
+            <span class="types"><span class="type">node</span></span>
+         Node to enabled input component
+        </li>
+        <li><span class="parameter">text_node</span>
+            <span class="types"><span class="type">node</span> or <span class="type">Text</span></span>
+         Text node what will be changed on user input. You can pass text component instead of text node name <a href="../modules/Text.html#">Text</a>
+        </li>
+        <li><span class="parameter">keyboard_type</span>
+            <span class="types"><span class="type">number</span></span>
+         Gui keyboard type for input field
+         (<em>optional</em>)
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "reset_changes"></a>
+    <strong>reset_changes(self)</strong>
+    </dt>
+    <dd>
+    Reset current input selection and return previous value
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Input</span></span>
+         <a href="../modules/Input.html#">Input</a>
         </li>
     </ul>
 
@@ -218,7 +285,97 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Input</span></span>
+         <a href="../modules/Input.html#">Input</a>
+        </li>
+    </ul>
 
+
+
+
+
+</dd>
+    <dt>
+    <a name = "set_allowed_characters"></a>
+    <strong>set_allowed_characters(self, characters)</strong>
+    </dt>
+    <dd>
+    Set allowed charaters for input field.
+ See: https://defold.com/ref/stable/string/
+ ex: [%a%d] for alpha and numeric
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Input</span></span>
+         <a href="../modules/Input.html#">Input</a>
+        </li>
+        <li><span class="parameter">characters</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         Regulax exp. for validate user input
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">druid.input</span></span>
+        Current input instance
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "set_max_length"></a>
+    <strong>set_max_length(self, max_length)</strong>
+    </dt>
+    <dd>
+    Set maximum length for input field.
+ Pass nil to make input field unliminted (by default)
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Input</span></span>
+         <a href="../modules/Input.html#">Input</a>
+        </li>
+        <li><span class="parameter">max_length</span>
+            <span class="types"><span class="type">number</span></span>
+         Maximum length for input text field
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">druid.input</span></span>
+        Current input instance
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "set_text"></a>
+    <strong>set_text(self, input_text)</strong>
+    </dt>
+    <dd>
+    Set text for input field
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Input</span></span>
+         <a href="../modules/Input.html#">Input</a>
+        </li>
+        <li><span class="parameter">input_text</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         The string to apply for input field
         </li>
     </ul>
 
@@ -239,120 +396,7 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Input</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "get_text"></a>
-    <strong>get_text(self)</strong>
-    </dt>
-    <dd>
-    Return current input field text
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">Input</span></span>
-
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
-        The current input field text
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_max_length"></a>
-    <strong>set_max_length(self, max_length)</strong>
-    </dt>
-    <dd>
-    Set maximum length for input field.
- Pass nil to make input field unliminted (by default)
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">Input</span></span>
-
-        </li>
-        <li><span class="parameter">max_length</span>
-            <span class="types"><span class="type">number</span></span>
-         Maximum length for input text field
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">druid.input</span></span>
-        Current input instance
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_allowed_characters"></a>
-    <strong>set_allowed_characters(self, characters)</strong>
-    </dt>
-    <dd>
-    Set allowed charaters for input field.
- See: https://defold.com/ref/stable/string/
- ex: [%a%d] for alpha and numeric
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">Input</span></span>
-
-        </li>
-        <li><span class="parameter">characters</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
-         Regulax exp. for validate user input
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">druid.input</span></span>
-        Current input instance
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "reset_changes"></a>
-    <strong>reset_changes(self)</strong>
-    </dt>
-    <dd>
-    Reset current input selection and return previous value
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">Input</span></span>
-
+         <a href="../modules/Input.html#">Input</a>
         </li>
     </ul>
 
@@ -383,7 +427,7 @@
          (<em>default</em> false)
         </li>
         <li><span class="parameter">MASK_DEFAULT_CHAR</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
          Default character mask for password input
          (<em>default</em> *)
         </li>
@@ -392,6 +436,11 @@
          If true, call unselect on select selected input
          (<em>default</em> false)
         </li>
+        <li><span class="parameter">NO_CONSUME_INPUT_WHILE_SELECTED</span>
+            <span class="types"><span class="type">bool</span></span>
+         If true, will not consume input while input is selected. It's allow to interact with other components while input is selected (text input still captured)
+         (<em>default</em> false)
+        </li>
         <li><span class="parameter">on_select</span>
             <span class="types"><span class="type">function</span></span>
          (self, button_node) Callback on input field selecting
@@ -405,7 +454,7 @@
          (self, button_node) Callback on wrong user input
         </li>
         <li><span class="parameter">button_style</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
          Custom button style for input node
         </li>
     </ul>
@@ -420,137 +469,18 @@
 
     <dl class="function">
     <dt>
-    <a name = "on_input_select"></a>
-    <strong>on_input_select</strong>
+    <a name = "allowerd_characters"></a>
+    <strong>allowerd_characters</strong>
     </dt>
     <dd>
-    On input field select callback(self, button_node)
+    Pattern matching for user input
 
 
     <ul>
-        <li><span class="parameter">on_input_select</span>
-            <span class="types"><span class="type">druid_event</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "on_input_unselect"></a>
-    <strong>on_input_unselect</strong>
-    </dt>
-    <dd>
-    On input field unselect callback(self, button_node)
-
-
-    <ul>
-        <li><span class="parameter">on_input_unselect</span>
-            <span class="types"><span class="type">druid_event</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "on_input_text"></a>
-    <strong>on_input_text</strong>
-    </dt>
-    <dd>
-    On input field text change callback(self, input_text)
-
-
-    <ul>
-        <li><span class="parameter">on_input_text</span>
-            <span class="types"><span class="type">druid_event</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "on_input_empty"></a>
-    <strong>on_input_empty</strong>
-    </dt>
-    <dd>
-    On input field text change to empty string callback(self, input_text)
-
-
-    <ul>
-        <li><span class="parameter">on_input_empty</span>
-            <span class="types"><span class="type">druid_event</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "on_input_full"></a>
-    <strong>on_input_full</strong>
-    </dt>
-    <dd>
-    On input field text change to max length string callback(self, input_text)
-
-
-    <ul>
-        <li><span class="parameter">on_input_full</span>
-            <span class="types"><span class="type">druid_event</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "on_input_wrong"></a>
-    <strong>on_input_wrong</strong>
-    </dt>
-    <dd>
-    On trying user input with not allowed character callback(self, params, button_instance)
-
-
-    <ul>
-        <li><span class="parameter">on_input_wrong</span>
-            <span class="types"><span class="type">druid_event</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "text"></a>
-    <strong>text</strong>
-    </dt>
-    <dd>
-    Text component
-
-
-    <ul>
-        <li><span class="parameter">text</span>
-            <span class="types"><span class="type">druid.text</span></span>
+        <li><span class="parameter">allowerd_characters</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
 
+         (<em>optional</em>)
         </li>
     </ul>
 
@@ -569,7 +499,27 @@
 
     <ul>
         <li><span class="parameter">button</span>
-            <span class="types"><span class="type">druid.button</span></span>
+            <span class="types"><span class="type">Button</span></span>
+         <a href="../modules/Button.html#">Button</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "is_empty"></a>
+    <strong>is_empty</strong>
+    </dt>
+    <dd>
+    Is current input is empty now
+
+
+    <ul>
+        <li><span class="parameter">is_empty</span>
+            <span class="types"><span class="type">bool</span></span>
 
         </li>
     </ul>
@@ -600,16 +550,16 @@
 
 </dd>
     <dt>
-    <a name = "is_empty"></a>
-    <strong>is_empty</strong>
+    <a name = "keyboard_type"></a>
+    <strong>keyboard_type</strong>
     </dt>
     <dd>
-    Is current input is empty now
+    Gui keyboard type for input field
 
 
     <ul>
-        <li><span class="parameter">is_empty</span>
-            <span class="types"><span class="type">bool</span></span>
+        <li><span class="parameter">keyboard_type</span>
+            <span class="types"><span class="type">number</span></span>
 
         </li>
     </ul>
@@ -641,18 +591,17 @@
 
 </dd>
     <dt>
-    <a name = "allowerd_characters"></a>
-    <strong>allowerd_characters</strong>
+    <a name = "on_input_empty"></a>
+    <strong>on_input_empty</strong>
     </dt>
     <dd>
-    Pattern matching for user input
+    On input field text change to empty string callback(self, input_text)
 
 
     <ul>
-        <li><span class="parameter">allowerd_characters</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
-
-         (<em>optional</em>)
+        <li><span class="parameter">on_input_empty</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
         </li>
     </ul>
 
@@ -662,17 +611,117 @@
 
 </dd>
     <dt>
-    <a name = "keyboard_type"></a>
-    <strong>keyboard_type</strong>
+    <a name = "on_input_full"></a>
+    <strong>on_input_full</strong>
     </dt>
     <dd>
-    Gui keyboard type for input field
+    On input field text change to max length string callback(self, input_text)
 
 
     <ul>
-        <li><span class="parameter">keyboard_type</span>
-            <span class="types"><span class="type">number</span></span>
+        <li><span class="parameter">on_input_full</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
+        </li>
+    </ul>
 
+
+
+
+
+</dd>
+    <dt>
+    <a name = "on_input_select"></a>
+    <strong>on_input_select</strong>
+    </dt>
+    <dd>
+    On input field select callback(self, button_node)
+
+
+    <ul>
+        <li><span class="parameter">on_input_select</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "on_input_text"></a>
+    <strong>on_input_text</strong>
+    </dt>
+    <dd>
+    On input field text change callback(self, input_text)
+
+
+    <ul>
+        <li><span class="parameter">on_input_text</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "on_input_unselect"></a>
+    <strong>on_input_unselect</strong>
+    </dt>
+    <dd>
+    On input field unselect callback(self, input_text)
+
+
+    <ul>
+        <li><span class="parameter">on_input_unselect</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "on_input_wrong"></a>
+    <strong>on_input_wrong</strong>
+    </dt>
+    <dd>
+    On trying user input with not allowed character callback(self, params, button_instance)
+
+
+    <ul>
+        <li><span class="parameter">on_input_wrong</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "text"></a>
+    <strong>text</strong>
+    </dt>
+    <dd>
+    Text component
+
+
+    <ul>
+        <li><span class="parameter">text</span>
+            <span class="types"><span class="type">Text</span></span>
+         <a href="../modules/Text.html#">Text</a>
         </li>
     </ul>
 
@@ -687,8 +736,8 @@
 </div> <!-- id="content" -->
 </div> <!-- id="main" -->
 <div id="about">
-<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-04-06 00:03:14 </i>
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc TESTING</a></i>
+<i style="float:right;">Last updated 2015-01-01 12:00:00 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

docs/modules/LangText.html

@@ -3,7 +3,7 @@
 <html>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
 <head>
-    <title>Defold Druid UI Library</title>
+    <title>Defold Druid UI Framework</title>
     <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
 </head>
 <body>
@@ -40,29 +40,34 @@
 <h2>Modules</h2>
 <ul class="nowrap">
   <li><a href="../modules/BackHandler.html">BackHandler</a></li>
+  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
   <li><a href="../modules/Blocker.html">Blocker</a></li>
   <li><a href="../modules/Button.html">Button</a></li>
-  <li><a href="../modules/Drag.html">Drag</a></li>
-  <li><a href="../modules/Hover.html">Hover</a></li>
-  <li><a href="../modules/Scroll.html">Scroll</a></li>
-  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
-  <li><a href="../modules/Swipe.html">Swipe</a></li>
-  <li><a href="../modules/Text.html">Text</a></li>
-  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
-  <li><a href="../modules/druid.html">druid</a></li>
-  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
   <li><a href="../modules/Checkbox.html">Checkbox</a></li>
   <li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
   <li><a href="../modules/DataList.html">DataList</a></li>
+  <li><a href="../modules/Drag.html">Drag</a></li>
+  <li><a href="../modules/Druid.html">Druid</a></li>
+  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
+  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
   <li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
+  <li><a href="../modules/Helper.html">Helper</a></li>
+  <li><a href="../modules/Hotkey.html">Hotkey</a></li>
+  <li><a href="../modules/Hover.html">Hover</a></li>
   <li><a href="../modules/Input.html">Input</a></li>
   <li><strong>LangText</strong></li>
+  <li><a href="../modules/Layout.html">Layout</a></li>
+  <li><a href="../modules/PinKnob.html">PinKnob</a></li>
   <li><a href="../modules/Progress.html">Progress</a></li>
   <li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
+  <li><a href="../modules/RichInput.html">RichInput</a></li>
+  <li><a href="../modules/RichText.html">RichText</a></li>
+  <li><a href="../modules/Scroll.html">Scroll</a></li>
   <li><a href="../modules/Slider.html">Slider</a></li>
+  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
+  <li><a href="../modules/Swipe.html">Swipe</a></li>
+  <li><a href="../modules/Text.html">Text</a></li>
   <li><a href="../modules/Timer.html">Timer</a></li>
-  <li><a href="../modules/druid.helper.html">druid.helper</a></li>
-  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
 </ul>
 
 </div>
@@ -70,23 +75,33 @@
 <div id="content">
 
 <h1>Module <code>LangText</code></h1>
-<p>Component to handle all GUI texts
- Good working with localization system</p>
-<p></p>
+<p>Component to wrap over GUI Text nodes with localization helpers
+<p> <b># Overview #</b>
+<p> • The initialization of druid.set_text_function is required to enable localization
+ using the localization ID.</p>
+<p>
+<p> • The LangText component supports up to 7 string format parameters.
+ This limitation exists due to certain issues with using ... arguments.
+<p> <b># Notes #</b>
+<p> <a href="https://insality.github.io/druid/druid/index.html?example=texts_lang_text" target="_blank"><b>Example Link</b></a></p>
 
 
 <h2><a href="#Functions">Functions</a></h2>
 <table class="function_list">
 	<tr>
-	<td class="name" nowrap><a href="#init">init(self, node, locale_id, no_adjust)</a></td>
-	<td class="summary">Component init function</td>
+	<td class="name" nowrap><a href="#format">format(self[, a[, b[, c[, d[, e[, f[, g]]]]]]])</a></td>
+	<td class="summary">Format string with new text params on localized text</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#init">init(self, node, locale_id[, adjust_type=downscale])</a></td>
+	<td class="summary">The <a href="../modules/LangText.html#">LangText</a> constructor</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#set_to">set_to(self, text)</a></td>
 	<td class="summary">Setup raw text to lang_text component</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#translate">translate(self, locale_id)</a></td>
+	<td class="name" nowrap><a href="#translate">translate(self, locale_id[, a[, b[, c[, d[, e[, f[, g]]]]]]])</a></td>
 	<td class="summary">Translate the text by locale_id</td>
 	</tr>
 </table>
@@ -110,30 +125,93 @@
 
     <dl class="function">
     <dt>
-    <a name = "init"></a>
-    <strong>init(self, node, locale_id, no_adjust)</strong>
+    <a name = "format"></a>
+    <strong>format(self[, a[, b[, c[, d[, e[, f[, g]]]]]]])</strong>
     </dt>
     <dd>
-    Component init function
+    Format string with new text params on localized text
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">LangText</span></span>
+         <a href="../modules/LangText.html#">LangText</a>
+        </li>
+        <li><span class="parameter">a</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         Optional param to string.format
+         (<em>optional</em>)
+        </li>
+        <li><span class="parameter">b</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         Optional param to string.format
+         (<em>optional</em>)
+        </li>
+        <li><span class="parameter">c</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         Optional param to string.format
+         (<em>optional</em>)
+        </li>
+        <li><span class="parameter">d</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         Optional param to string.format
+         (<em>optional</em>)
+        </li>
+        <li><span class="parameter">e</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         Optional param to string.format
+         (<em>optional</em>)
+        </li>
+        <li><span class="parameter">f</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         Optional param to string.format
+         (<em>optional</em>)
+        </li>
+        <li><span class="parameter">g</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         Optional param to string.format
+         (<em>optional</em>)
+        </li>
+    </ul>
 
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">LangText</span></span>
+        Current instance
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "init"></a>
+    <strong>init(self, node, locale_id[, adjust_type=downscale])</strong>
+    </dt>
+    <dd>
+    The <a href="../modules/LangText.html#">LangText</a> constructor
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">LangText</span></span>
+         <a href="../modules/LangText.html#">LangText</a>
         </li>
         <li><span class="parameter">node</span>
-            <span class="types"><span class="type">node</span></span>
-         The text node
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a> or <span class="type">node</span></span>
+         Node name or GUI Text Node itself
         </li>
         <li><span class="parameter">locale_id</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
-         Default locale id, optional
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         Default locale id or text from node as default
         </li>
-        <li><span class="parameter">no_adjust</span>
-            <span class="types"><span class="type">bool</span></span>
-         If true, will not correct text size
+        <li><span class="parameter">adjust_type</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         Adjust type for text. By default is DOWNSCALE. Look const.TEXT_ADJUST for reference
+         (<em>default</em> downscale)
         </li>
     </ul>
 
@@ -154,14 +232,20 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">LangText</span></span>
-
+         <a href="../modules/LangText.html#">LangText</a>
         </li>
         <li><span class="parameter">text</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
          Text for text node
         </li>
     </ul>
 
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">LangText</span></span>
+        Current instance
+    </ol>
 
 
 
@@ -169,7 +253,7 @@
 </dd>
     <dt>
     <a name = "translate"></a>
-    <strong>translate(self, locale_id)</strong>
+    <strong>translate(self, locale_id[, a[, b[, c[, d[, e[, f[, g]]]]]]])</strong>
     </dt>
     <dd>
     Translate the text by locale_id
@@ -179,14 +263,55 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">LangText</span></span>
-
+         <a href="../modules/LangText.html#">LangText</a>
         </li>
         <li><span class="parameter">locale_id</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
          Locale id
         </li>
+        <li><span class="parameter">a</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         Optional param to string.format
+         (<em>optional</em>)
+        </li>
+        <li><span class="parameter">b</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         Optional param to string.format
+         (<em>optional</em>)
+        </li>
+        <li><span class="parameter">c</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         Optional param to string.format
+         (<em>optional</em>)
+        </li>
+        <li><span class="parameter">d</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         Optional param to string.format
+         (<em>optional</em>)
+        </li>
+        <li><span class="parameter">e</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         Optional param to string.format
+         (<em>optional</em>)
+        </li>
+        <li><span class="parameter">f</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         Optional param to string.format
+         (<em>optional</em>)
+        </li>
+        <li><span class="parameter">g</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         Optional param to string.format
+         (<em>optional</em>)
+        </li>
     </ul>
 
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">LangText</span></span>
+        Current instance
+    </ol>
 
 
 
@@ -206,8 +331,8 @@
 
     <ul>
         <li><span class="parameter">on_change</span>
-            <span class="types"><span class="type">druid_event</span></span>
-
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
         </li>
     </ul>
 
@@ -227,7 +352,7 @@
     <ul>
         <li><span class="parameter">text</span>
             <span class="types"><span class="type">Text</span></span>
-
+         <a href="../modules/Text.html#">Text</a>
         </li>
     </ul>
 
@@ -242,8 +367,8 @@
 </div> <!-- id="content" -->
 </div> <!-- id="main" -->
 <div id="about">
-<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-04-06 00:03:14 </i>
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc TESTING</a></i>
+<i style="float:right;">Last updated 2015-01-01 12:00:00 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

docs/modules/Layout.html

@@ -0,0 +1,498 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+<head>
+    <title>Defold Druid UI Framework</title>
+    <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
+</head>
+<body>
+
+<div id="container">
+
+<div id="product">
+	<div id="product_logo"></div>
+	<div id="product_name"><big><b></b></big></div>
+	<div id="product_description"></div>
+</div> <!-- id="product" -->
+
+
+<div id="main">
+
+
+<!-- Menu -->
+
+<div id="navigation">
+<br/>
+<h1>Druid</h1>
+
+<ul>
+  <li><a href="../index.html">Index</a></li>
+</ul>
+
+<h2>Contents</h2>
+<ul>
+<li><a href="#Functions">Functions</a></li>
+<li><a href="#Fields">Fields</a></li>
+</ul>
+
+
+<h2>Modules</h2>
+<ul class="nowrap">
+  <li><a href="../modules/BackHandler.html">BackHandler</a></li>
+  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
+  <li><a href="../modules/Blocker.html">Blocker</a></li>
+  <li><a href="../modules/Button.html">Button</a></li>
+  <li><a href="../modules/Checkbox.html">Checkbox</a></li>
+  <li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
+  <li><a href="../modules/DataList.html">DataList</a></li>
+  <li><a href="../modules/Drag.html">Drag</a></li>
+  <li><a href="../modules/Druid.html">Druid</a></li>
+  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
+  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
+  <li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
+  <li><a href="../modules/Helper.html">Helper</a></li>
+  <li><a href="../modules/Hotkey.html">Hotkey</a></li>
+  <li><a href="../modules/Hover.html">Hover</a></li>
+  <li><a href="../modules/Input.html">Input</a></li>
+  <li><a href="../modules/LangText.html">LangText</a></li>
+  <li><strong>Layout</strong></li>
+  <li><a href="../modules/PinKnob.html">PinKnob</a></li>
+  <li><a href="../modules/Progress.html">Progress</a></li>
+  <li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
+  <li><a href="../modules/RichInput.html">RichInput</a></li>
+  <li><a href="../modules/RichText.html">RichText</a></li>
+  <li><a href="../modules/Scroll.html">Scroll</a></li>
+  <li><a href="../modules/Slider.html">Slider</a></li>
+  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
+  <li><a href="../modules/Swipe.html">Swipe</a></li>
+  <li><a href="../modules/Text.html">Text</a></li>
+  <li><a href="../modules/Timer.html">Timer</a></li>
+</ul>
+
+</div>
+
+<div id="content">
+
+<h1>Module <code>Layout</code></h1>
+<p>Layout management on node</p>
+<p> <a href="https://insality.github.io/druid/druid/index.html?example=general_layout" target="_blank"><b>Example Link</b></a></p>
+
+
+<h2><a href="#Functions">Functions</a></h2>
+<table class="function_list">
+	<tr>
+	<td class="name" nowrap><a href="#fit_into_node">fit_into_node(self[, node])</a></td>
+	<td class="summary">Set node for layout node to fit inside it.</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#fit_into_size">fit_into_size(self, target_size)</a></td>
+	<td class="summary">Set size for layout node to fit inside it</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#fit_into_window">fit_into_window(self)</a></td>
+	<td class="summary">Set current size for layout node to fit inside it</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#init">init(self, node, mode[, on_size_changed_callback])</a></td>
+	<td class="summary">Component init function</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#set_max_gui_upscale">set_max_gui_upscale(self, max_gui_upscale)</a></td>
+	<td class="summary">Set max gui upscale for FIT adjust mode (or side).</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#set_max_size">set_max_size(self, max_size)</a></td>
+	<td class="summary">Set maximum size of layout node</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#set_min_size">set_min_size(self, min_size)</a></td>
+	<td class="summary">Set minimal size of layout node</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#set_origin_position">set_origin_position(self, new_origin_position)</a></td>
+	<td class="summary">Set new origin position of layout node.</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#set_origin_size">set_origin_size(self, new_origin_size)</a></td>
+	<td class="summary">Set new origin size of layout node.</td>
+	</tr>
+</table>
+<h2><a href="#Fields">Fields</a></h2>
+<table class="function_list">
+	<tr>
+	<td class="name" nowrap><a href="#mode">mode</a></td>
+	<td class="summary">Current layout mode</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#node">node</a></td>
+	<td class="summary">Layout node</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#on_size_changed">on_size_changed</a></td>
+	<td class="summary">On window resize callback(self, new_size)</td>
+	</tr>
+</table>
+
+<br/>
+<br/>
+
+
+    <h2 class="section-header "><a name="Functions"></a>Functions</h2>
+
+    <dl class="function">
+    <dt>
+    <a name = "fit_into_node"></a>
+    <strong>fit_into_node(self[, node])</strong>
+    </dt>
+    <dd>
+    Set node for layout node to fit inside it.  Pass nil to reset
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Layout</span></span>
+         <a href="../modules/Layout.html#">Layout</a>
+        </li>
+        <li><span class="parameter">node</span>
+            <span class="types"><span class="type">Node</span></span>
+
+         (<em>optional</em>)
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">Layout</span></span>
+        <a href="../modules/Layout.html#">Layout</a>
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "fit_into_size"></a>
+    <strong>fit_into_size(self, target_size)</strong>
+    </dt>
+    <dd>
+    Set size for layout node to fit inside it
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Layout</span></span>
+         <a href="../modules/Layout.html#">Layout</a>
+        </li>
+        <li><span class="parameter">target_size</span>
+            <span class="types"><span class="type">vector3</span></span>
+
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">Layout</span></span>
+        <a href="../modules/Layout.html#">Layout</a>
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "fit_into_window"></a>
+    <strong>fit_into_window(self)</strong>
+    </dt>
+    <dd>
+    Set current size for layout node to fit inside it
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Layout</span></span>
+         <a href="../modules/Layout.html#">Layout</a>
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">Layout</span></span>
+        <a href="../modules/Layout.html#">Layout</a>
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "init"></a>
+    <strong>init(self, node, mode[, on_size_changed_callback])</strong>
+    </dt>
+    <dd>
+    Component init function
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Layout</span></span>
+         <a href="../modules/Layout.html#">Layout</a>
+        </li>
+        <li><span class="parameter">node</span>
+            <span class="types"><a class="type" href="../modules/Layout.html#node">node</a></span>
+         Gui node
+        </li>
+        <li><span class="parameter">mode</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         The layout mode (from const.LAYOUT_MODE)
+        </li>
+        <li><span class="parameter">on_size_changed_callback</span>
+            <span class="types"><span class="type">function</span></span>
+         The callback on window resize
+         (<em>optional</em>)
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "set_max_gui_upscale"></a>
+    <strong>set_max_gui_upscale(self, max_gui_upscale)</strong>
+    </dt>
+    <dd>
+    Set max gui upscale for FIT adjust mode (or side).  It happens on bigger render gui screen
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Layout</span></span>
+         <a href="../modules/Layout.html#">Layout</a>
+        </li>
+        <li><span class="parameter">max_gui_upscale</span>
+            <span class="types"><span class="type">number</span></span>
+
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">Layout</span></span>
+        <a href="../modules/Layout.html#">Layout</a>
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "set_max_size"></a>
+    <strong>set_max_size(self, max_size)</strong>
+    </dt>
+    <dd>
+    Set maximum size of layout node
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Layout</span></span>
+         <a href="../modules/Layout.html#">Layout</a>
+        </li>
+        <li><span class="parameter">max_size</span>
+            <span class="types"><span class="type">vector3</span></span>
+
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">Layout</span></span>
+        <a href="../modules/Layout.html#">Layout</a>
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "set_min_size"></a>
+    <strong>set_min_size(self, min_size)</strong>
+    </dt>
+    <dd>
+    Set minimal size of layout node
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Layout</span></span>
+         <a href="../modules/Layout.html#">Layout</a>
+        </li>
+        <li><span class="parameter">min_size</span>
+            <span class="types"><span class="type">vector3</span></span>
+
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">Layout</span></span>
+        <a href="../modules/Layout.html#">Layout</a>
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "set_origin_position"></a>
+    <strong>set_origin_position(self, new_origin_position)</strong>
+    </dt>
+    <dd>
+    Set new origin position of layout node.  You should apply this on node movement
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Layout</span></span>
+         <a href="../modules/Layout.html#">Layout</a>
+        </li>
+        <li><span class="parameter">new_origin_position</span>
+            <span class="types"><span class="type">vector3</span></span>
+
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">Layout</span></span>
+        <a href="../modules/Layout.html#">Layout</a>
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "set_origin_size"></a>
+    <strong>set_origin_size(self, new_origin_size)</strong>
+    </dt>
+    <dd>
+    Set new origin size of layout node.  You should apply this on node manual size change
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Layout</span></span>
+         <a href="../modules/Layout.html#">Layout</a>
+        </li>
+        <li><span class="parameter">new_origin_size</span>
+            <span class="types"><span class="type">vector3</span></span>
+
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">Layout</span></span>
+        <a href="../modules/Layout.html#">Layout</a>
+    </ol>
+
+
+
+
+</dd>
+</dl>
+    <h2 class="section-header "><a name="Fields"></a>Fields</h2>
+
+    <dl class="function">
+    <dt>
+    <a name = "mode"></a>
+    <strong>mode</strong>
+    </dt>
+    <dd>
+    Current layout mode
+
+
+    <ul>
+        <li><span class="parameter">mode</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "node"></a>
+    <strong>node</strong>
+    </dt>
+    <dd>
+    Layout node
+
+
+    <ul>
+        <li><span class="parameter">node</span>
+            <span class="types"><a class="type" href="../modules/Layout.html#node">node</a></span>
+
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "on_size_changed"></a>
+    <strong>on_size_changed</strong>
+    </dt>
+    <dd>
+    On window resize callback(self, new_size)
+
+
+    <ul>
+        <li><span class="parameter">on_size_changed</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+</dl>
+
+
+</div> <!-- id="content" -->
+</div> <!-- id="main" -->
+<div id="about">
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc TESTING</a></i>
+<i style="float:right;">Last updated 2015-01-01 12:00:00 </i>
+</div> <!-- id="about" -->
+</div> <!-- id="container" -->
+</body>
+</html>

docs/modules/PinKnob.html

@@ -0,0 +1,300 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+<head>
+    <title>Defold Druid UI Framework</title>
+    <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
+</head>
+<body>
+
+<div id="container">
+
+<div id="product">
+	<div id="product_logo"></div>
+	<div id="product_name"><big><b></b></big></div>
+	<div id="product_description"></div>
+</div> <!-- id="product" -->
+
+
+<div id="main">
+
+
+<!-- Menu -->
+
+<div id="navigation">
+<br/>
+<h1>Druid</h1>
+
+<ul>
+  <li><a href="../index.html">Index</a></li>
+</ul>
+
+<h2>Contents</h2>
+<ul>
+<li><a href="#Functions">Functions</a></li>
+<li><a href="#Fields">Fields</a></li>
+</ul>
+
+
+<h2>Modules</h2>
+<ul class="nowrap">
+  <li><a href="../modules/BackHandler.html">BackHandler</a></li>
+  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
+  <li><a href="../modules/Blocker.html">Blocker</a></li>
+  <li><a href="../modules/Button.html">Button</a></li>
+  <li><a href="../modules/Checkbox.html">Checkbox</a></li>
+  <li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
+  <li><a href="../modules/DataList.html">DataList</a></li>
+  <li><a href="../modules/Drag.html">Drag</a></li>
+  <li><a href="../modules/Druid.html">Druid</a></li>
+  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
+  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
+  <li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
+  <li><a href="../modules/Helper.html">Helper</a></li>
+  <li><a href="../modules/Hotkey.html">Hotkey</a></li>
+  <li><a href="../modules/Hover.html">Hover</a></li>
+  <li><a href="../modules/Input.html">Input</a></li>
+  <li><a href="../modules/LangText.html">LangText</a></li>
+  <li><a href="../modules/Layout.html">Layout</a></li>
+  <li><strong>PinKnob</strong></li>
+  <li><a href="../modules/Progress.html">Progress</a></li>
+  <li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
+  <li><a href="../modules/RichInput.html">RichInput</a></li>
+  <li><a href="../modules/RichText.html">RichText</a></li>
+  <li><a href="../modules/Scroll.html">Scroll</a></li>
+  <li><a href="../modules/Slider.html">Slider</a></li>
+  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
+  <li><a href="../modules/Swipe.html">Swipe</a></li>
+  <li><a href="../modules/Text.html">Text</a></li>
+  <li><a href="../modules/Timer.html">Timer</a></li>
+</ul>
+
+</div>
+
+<div id="content">
+
+<h1>Module <code>PinKnob</code></h1>
+<p>Druid pin knob custom component.</p>
+<p>
+ It's simple rotating input element</p>
+
+
+<h2><a href="#Functions">Functions</a></h2>
+<table class="function_list">
+	<tr>
+	<td class="name" nowrap><a href="#init">init(self, callback, template, nodes)</a></td>
+	<td class="summary">Component init function</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#set_angle">set_angle(self, cur_value, min, max)</a></td>
+	<td class="summary">Set current and min/max angles for component</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#set_friction">set_friction(self[, value=1])</a></td>
+	<td class="summary">Set current and min/max angles for component</td>
+	</tr>
+</table>
+<h2><a href="#Fields">Fields</a></h2>
+<table class="function_list">
+	<tr>
+	<td class="name" nowrap><a href="#druid">druid</a></td>
+	<td class="summary">The component druid instance</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#is_drag">is_drag</a></td>
+	<td class="summary">Is currently under user control</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#node">node</a></td>
+	<td class="summary">The pin node</td>
+	</tr>
+</table>
+
+<br/>
+<br/>
+
+
+    <h2 class="section-header "><a name="Functions"></a>Functions</h2>
+
+    <dl class="function">
+    <dt>
+    <a name = "init"></a>
+    <strong>init(self, callback, template, nodes)</strong>
+    </dt>
+    <dd>
+    Component init function
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">PinKnob</span></span>
+         <a href="../modules/PinKnob.html#">PinKnob</a>
+        </li>
+        <li><span class="parameter">callback</span>
+            <span class="types"><span class="type">function</span></span>
+         Callback(self, value) on value changed
+        </li>
+        <li><span class="parameter">template</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         The template string name
+        </li>
+        <li><span class="parameter">nodes</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+         Nodes table from gui.clone_tree
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "set_angle"></a>
+    <strong>set_angle(self, cur_value, min, max)</strong>
+    </dt>
+    <dd>
+    Set current and min/max angles for component
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">PinKnob</span></span>
+         <a href="../modules/PinKnob.html#">PinKnob</a>
+        </li>
+        <li><span class="parameter">cur_value</span>
+            <span class="types"><span class="type">number</span></span>
+         The new value for pin knob
+        </li>
+        <li><span class="parameter">min</span>
+            <span class="types"><span class="type">number</span></span>
+         The minimum value for pin knob
+        </li>
+        <li><span class="parameter">max</span>
+            <span class="types"><span class="type">number</span></span>
+         The maximum value for pin knob
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">PinKnob</span></span>
+        <a href="../modules/PinKnob.html#">PinKnob</a>
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "set_friction"></a>
+    <strong>set_friction(self[, value=1])</strong>
+    </dt>
+    <dd>
+    Set current and min/max angles for component
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">PinKnob</span></span>
+         <a href="../modules/PinKnob.html#">PinKnob</a>
+        </li>
+        <li><span class="parameter">value</span>
+            <span class="types"><span class="type">number</span></span>
+         The spin speed multiplier
+         (<em>default</em> 1)
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">PinKnob</span></span>
+        <a href="../modules/PinKnob.html#">PinKnob</a>
+    </ol>
+
+
+
+
+</dd>
+</dl>
+    <h2 class="section-header "><a name="Fields"></a>Fields</h2>
+
+    <dl class="function">
+    <dt>
+    <a name = "druid"></a>
+    <strong>druid</strong>
+    </dt>
+    <dd>
+    The component druid instance
+
+
+    <ul>
+        <li><span class="parameter">druid</span>
+            <span class="types"><span class="type">DruidInstance</span></span>
+         <a href="../modules/DruidInstance.html#">DruidInstance</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "is_drag"></a>
+    <strong>is_drag</strong>
+    </dt>
+    <dd>
+    Is currently under user control
+
+
+    <ul>
+        <li><span class="parameter">is_drag</span>
+            <span class="types"><span class="type">bool</span></span>
+
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "node"></a>
+    <strong>node</strong>
+    </dt>
+    <dd>
+    The pin node
+
+
+    <ul>
+        <li><span class="parameter">node</span>
+            <span class="types"><a class="type" href="../modules/PinKnob.html#node">node</a></span>
+
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+</dl>
+
+
+</div> <!-- id="content" -->
+</div> <!-- id="main" -->
+<div id="about">
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc TESTING</a></i>
+<i style="float:right;">Last updated 2015-01-01 12:00:00 </i>
+</div> <!-- id="about" -->
+</div> <!-- id="container" -->
+</body>
+</html>

docs/modules/Progress.html

@@ -3,7 +3,7 @@
 <html>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
 <head>
-    <title>Defold Druid UI Library</title>
+    <title>Defold Druid UI Framework</title>
     <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
 </head>
 <body>
@@ -41,29 +41,34 @@
 <h2>Modules</h2>
 <ul class="nowrap">
   <li><a href="../modules/BackHandler.html">BackHandler</a></li>
+  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
   <li><a href="../modules/Blocker.html">Blocker</a></li>
   <li><a href="../modules/Button.html">Button</a></li>
-  <li><a href="../modules/Drag.html">Drag</a></li>
-  <li><a href="../modules/Hover.html">Hover</a></li>
-  <li><a href="../modules/Scroll.html">Scroll</a></li>
-  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
-  <li><a href="../modules/Swipe.html">Swipe</a></li>
-  <li><a href="../modules/Text.html">Text</a></li>
-  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
-  <li><a href="../modules/druid.html">druid</a></li>
-  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
   <li><a href="../modules/Checkbox.html">Checkbox</a></li>
   <li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
   <li><a href="../modules/DataList.html">DataList</a></li>
+  <li><a href="../modules/Drag.html">Drag</a></li>
+  <li><a href="../modules/Druid.html">Druid</a></li>
+  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
+  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
   <li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
+  <li><a href="../modules/Helper.html">Helper</a></li>
+  <li><a href="../modules/Hotkey.html">Hotkey</a></li>
+  <li><a href="../modules/Hover.html">Hover</a></li>
   <li><a href="../modules/Input.html">Input</a></li>
   <li><a href="../modules/LangText.html">LangText</a></li>
+  <li><a href="../modules/Layout.html">Layout</a></li>
+  <li><a href="../modules/PinKnob.html">PinKnob</a></li>
   <li><strong>Progress</strong></li>
   <li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
+  <li><a href="../modules/RichInput.html">RichInput</a></li>
+  <li><a href="../modules/RichText.html">RichText</a></li>
+  <li><a href="../modules/Scroll.html">Scroll</a></li>
   <li><a href="../modules/Slider.html">Slider</a></li>
+  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
+  <li><a href="../modules/Swipe.html">Swipe</a></li>
+  <li><a href="../modules/Text.html">Text</a></li>
   <li><a href="../modules/Timer.html">Timer</a></li>
-  <li><a href="../modules/druid.helper.html">druid.helper</a></li>
-  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
 </ul>
 
 </div>
@@ -71,38 +76,49 @@
 <div id="content">
 
 <h1>Module <code>Progress</code></h1>
-<p>Basic progress bar component.</p>
+<p>Druid component to handle the progress bars.</p>
 <p>
- For correct progress bar init it should be in max size from gui</p>
+ <b># Overview #</b>
+<p> <b># Notes #</b>
+<p> • Progress Node should be fully filled in your GUI scene node. It will be the progress maximum size
+<p> • Progress correct working with Slice9 nodes, it trying to set size by _set_size_ first, if it is not possible, it set up sizing via _set_scale_
+<p> • Progress bar can fill only by vertical or horizontal size. If you want make diagonal progress bar, just rotate node in GUI scene
+<p> • If you have glitchy or dark texture bug with progress bar, try to disable mipmaps in your texture profiles
+<p>
+ <a href="https://insality.github.io/druid/druid/index.html?example=general_progress_bar" target="_blank"><b>Example Link</b></a></p>
 
 
 <h2><a href="#Functions">Functions</a></h2>
 <table class="function_list">
 	<tr>
-	<td class="name" nowrap><a href="#init">init(self, node, key[, init_value=1])</a></td>
-	<td class="summary">Component init function</td>
+	<td class="name" nowrap><a href="#empty">empty(self)</a></td>
+	<td class="summary">Empty a progress bar</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#fill">fill(self)</a></td>
 	<td class="summary">Fill a progress bar and stop progress animation</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#empty">empty(self)</a></td>
-	<td class="summary">Empty a progress bar</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#set_to">set_to(self, to)</a></td>
-	<td class="summary">Instant fill progress bar to value</td>
-	</tr>
-	<tr>
 	<td class="name" nowrap><a href="#get">get(self)</a></td>
 	<td class="summary">Return current progress bar value</td>
 	</tr>
 	<tr>
+	<td class="name" nowrap><a href="#init">init(self, node, key[, init_value=1])</a></td>
+	<td class="summary"><a href="../modules/Progress.html#">Progress</a> constructor</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#set_max_size">set_max_size(self, max_size)</a></td>
+	<td class="summary">Set progress bar max node size</td>
+	</tr>
+	<tr>
 	<td class="name" nowrap><a href="#set_steps">set_steps(self, steps, callback)</a></td>
 	<td class="summary">Set points on progress bar to fire the callback</td>
 	</tr>
 	<tr>
+	<td class="name" nowrap><a href="#set_to">set_to(self, to)</a></td>
+	<td class="summary">Instant fill progress bar to value</td>
+	</tr>
+	<tr>
 	<td class="name" nowrap><a href="#to">to(self, to[, callback])</a></td>
 	<td class="summary">Start animation of a progress bar</td>
 	</tr>
@@ -117,16 +133,20 @@
 <h2><a href="#Fields">Fields</a></h2>
 <table class="function_list">
 	<tr>
-	<td class="name" nowrap><a href="#on_change">on_change</a></td>
-	<td class="summary">On progress bar change callback(self, new_value)</td>
+	<td class="name" nowrap><a href="#key">key</a></td>
+	<td class="summary">The progress bar direction.</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#max_size">max_size</a></td>
+	<td class="summary">Maximum size of progress bar</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#node">node</a></td>
 	<td class="summary">Progress bar fill node</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#key">key</a></td>
-	<td class="summary">The progress bar direction</td>
+	<td class="name" nowrap><a href="#on_change">on_change</a></td>
+	<td class="summary">On progress bar change callback(self, new_value)</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#scale">scale</a></td>
@@ -137,10 +157,6 @@
 	<td class="summary">Current progress bar size</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#max_size">max_size</a></td>
-	<td class="summary">Maximum size of progress bar</td>
-	</tr>
-	<tr>
 	<td class="name" nowrap><a href="#slice">slice</a></td>
 	<td class="summary">Progress bar slice9 settings</td>
 	</tr>
@@ -154,31 +170,18 @@
 
     <dl class="function">
     <dt>
-    <a name = "init"></a>
-    <strong>init(self, node, key[, init_value=1])</strong>
+    <a name = "empty"></a>
+    <strong>empty(self)</strong>
     </dt>
     <dd>
-    Component init function
+    Empty a progress bar
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Progress</span></span>
-
-        </li>
-        <li><span class="parameter">node</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a> or <a class="type" href="../modules/Progress.html#node">node</a></span>
-         Progress bar fill node or node name
-        </li>
-        <li><span class="parameter">key</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
-         Progress bar direction: const.SIDE.X or const.SIDE.Y
-        </li>
-        <li><span class="parameter">init_value</span>
-            <span class="types"><span class="type">number</span></span>
-         Initial value of progress bar
-         (<em>default</em> 1)
+         <a href="../modules/Progress.html#">Progress</a>
         </li>
     </ul>
 
@@ -199,53 +202,7 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Progress</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "empty"></a>
-    <strong>empty(self)</strong>
-    </dt>
-    <dd>
-    Empty a progress bar
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">Progress</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_to"></a>
-    <strong>set_to(self, to)</strong>
-    </dt>
-    <dd>
-    Instant fill progress bar to value
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">Progress</span></span>
-
-        </li>
-        <li><span class="parameter">to</span>
-            <span class="types"><span class="type">number</span></span>
-         Progress bar value, from 0 to 1
+         <a href="../modules/Progress.html#">Progress</a>
         </li>
     </ul>
 
@@ -266,7 +223,7 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Progress</span></span>
-
+         <a href="../modules/Progress.html#">Progress</a>
         </li>
     </ul>
 
@@ -274,6 +231,71 @@
 
 
 
+</dd>
+    <dt>
+    <a name = "init"></a>
+    <strong>init(self, node, key[, init_value=1])</strong>
+    </dt>
+    <dd>
+    <a href="../modules/Progress.html#">Progress</a> constructor
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Progress</span></span>
+         <a href="../modules/Progress.html#">Progress</a>
+        </li>
+        <li><span class="parameter">node</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a> or <a class="type" href="../modules/Progress.html#node">node</a></span>
+         Node name or GUI Node itself.
+        </li>
+        <li><span class="parameter">key</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         Progress bar direction: const.SIDE.X or const.SIDE.Y
+        </li>
+        <li><span class="parameter">init_value</span>
+            <span class="types"><span class="type">number</span></span>
+         Initial value of progress bar
+         (<em>default</em> 1)
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "set_max_size"></a>
+    <strong>set_max_size(self, max_size)</strong>
+    </dt>
+    <dd>
+    Set progress bar max node size
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Progress</span></span>
+         <a href="../modules/Progress.html#">Progress</a>
+        </li>
+        <li><span class="parameter">max_size</span>
+            <span class="types"><span class="type">vector3</span></span>
+         The new node maximum (full) size
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">Progress</span></span>
+        <a href="../modules/Progress.html#">Progress</a>
+    </ol>
+
+
+
+
 </dd>
     <dt>
     <a name = "set_steps"></a>
@@ -287,7 +309,7 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Progress</span></span>
-
+         <a href="../modules/Progress.html#">Progress</a>
         </li>
         <li><span class="parameter">steps</span>
             <span class="types"><span class="type">number[]</span></span>
@@ -307,6 +329,31 @@
         <pre class="example">progress:set_steps({<span class="number">0</span>, <span class="number">0.3</span>, <span class="number">0.6</span>, <span class="number">1</span>}, <span class="keyword">function</span>(self, step) <span class="keyword">end</span>)</pre>
     </ul>
 
+</dd>
+    <dt>
+    <a name = "set_to"></a>
+    <strong>set_to(self, to)</strong>
+    </dt>
+    <dd>
+    Instant fill progress bar to value
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Progress</span></span>
+         <a href="../modules/Progress.html#">Progress</a>
+        </li>
+        <li><span class="parameter">to</span>
+            <span class="types"><span class="type">number</span></span>
+         Progress bar value, from 0 to 1
+        </li>
+    </ul>
+
+
+
+
+
 </dd>
     <dt>
     <a name = "to"></a>
@@ -320,7 +367,7 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Progress</span></span>
-
+         <a href="../modules/Progress.html#">Progress</a>
         </li>
         <li><span class="parameter">to</span>
             <span class="types"><span class="type">number</span></span>
@@ -376,16 +423,37 @@
 
     <dl class="function">
     <dt>
-    <a name = "on_change"></a>
-    <strong>on_change</strong>
+    <a name = "key"></a>
+    <strong>key</strong>
     </dt>
     <dd>
-    On progress bar change callback(self, new_value)
+    The progress bar direction.
+<p> The values are: "x" or "y". (const.SIDE.X or const.SIDE.Y)
 
 
     <ul>
-        <li><span class="parameter">on_change</span>
-            <span class="types"><span class="type">druid_event</span></span>
+        <li><span class="parameter">key</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "max_size"></a>
+    <strong>max_size</strong>
+    </dt>
+    <dd>
+    Maximum size of progress bar
+
+
+    <ul>
+        <li><span class="parameter">max_size</span>
+            <span class="types"><span class="type">number</span></span>
 
         </li>
     </ul>
@@ -416,17 +484,17 @@
 
 </dd>
     <dt>
-    <a name = "key"></a>
-    <strong>key</strong>
+    <a name = "on_change"></a>
+    <strong>on_change</strong>
     </dt>
     <dd>
-    The progress bar direction
+    On progress bar change callback(self, new_value)
 
 
     <ul>
-        <li><span class="parameter">key</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
-
+        <li><span class="parameter">on_change</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
         </li>
     </ul>
 
@@ -474,26 +542,6 @@
 
 
 
-</dd>
-    <dt>
-    <a name = "max_size"></a>
-    <strong>max_size</strong>
-    </dt>
-    <dd>
-    Maximum size of progress bar
-
-
-    <ul>
-        <li><span class="parameter">max_size</span>
-            <span class="types"><span class="type">number</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
 </dd>
     <dt>
     <a name = "slice"></a>
@@ -521,8 +569,8 @@
 </div> <!-- id="content" -->
 </div> <!-- id="main" -->
 <div id="about">
-<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-04-06 00:03:14 </i>
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc TESTING</a></i>
+<i style="float:right;">Last updated 2015-01-01 12:00:00 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

docs/modules/RadioGroup.html

@@ -3,7 +3,7 @@
 <html>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
 <head>
-    <title>Defold Druid UI Library</title>
+    <title>Defold Druid UI Framework</title>
     <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
 </head>
 <body>
@@ -40,29 +40,34 @@
 <h2>Modules</h2>
 <ul class="nowrap">
   <li><a href="../modules/BackHandler.html">BackHandler</a></li>
+  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
   <li><a href="../modules/Blocker.html">Blocker</a></li>
   <li><a href="../modules/Button.html">Button</a></li>
-  <li><a href="../modules/Drag.html">Drag</a></li>
-  <li><a href="../modules/Hover.html">Hover</a></li>
-  <li><a href="../modules/Scroll.html">Scroll</a></li>
-  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
-  <li><a href="../modules/Swipe.html">Swipe</a></li>
-  <li><a href="../modules/Text.html">Text</a></li>
-  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
-  <li><a href="../modules/druid.html">druid</a></li>
-  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
   <li><a href="../modules/Checkbox.html">Checkbox</a></li>
   <li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
   <li><a href="../modules/DataList.html">DataList</a></li>
+  <li><a href="../modules/Drag.html">Drag</a></li>
+  <li><a href="../modules/Druid.html">Druid</a></li>
+  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
+  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
   <li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
+  <li><a href="../modules/Helper.html">Helper</a></li>
+  <li><a href="../modules/Hotkey.html">Hotkey</a></li>
+  <li><a href="../modules/Hover.html">Hover</a></li>
   <li><a href="../modules/Input.html">Input</a></li>
   <li><a href="../modules/LangText.html">LangText</a></li>
+  <li><a href="../modules/Layout.html">Layout</a></li>
+  <li><a href="../modules/PinKnob.html">PinKnob</a></li>
   <li><a href="../modules/Progress.html">Progress</a></li>
   <li><strong>RadioGroup</strong></li>
+  <li><a href="../modules/RichInput.html">RichInput</a></li>
+  <li><a href="../modules/RichText.html">RichText</a></li>
+  <li><a href="../modules/Scroll.html">Scroll</a></li>
   <li><a href="../modules/Slider.html">Slider</a></li>
+  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
+  <li><a href="../modules/Swipe.html">Swipe</a></li>
+  <li><a href="../modules/Text.html">Text</a></li>
   <li><a href="../modules/Timer.html">Timer</a></li>
-  <li><a href="../modules/druid.helper.html">druid.helper</a></li>
-  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
 </ul>
 
 </div>
@@ -71,34 +76,34 @@
 
 <h1>Module <code>RadioGroup</code></h1>
 <p>Radio group module</p>
-<p></p>
+<p> <a href="https://insality.github.io/druid/druid/index.html?example=general_checkboxes" target="_blank"><b>Example Link</b></a></p>
 
 
 <h2><a href="#Functions">Functions</a></h2>
 <table class="function_list">
+	<tr>
+	<td class="name" nowrap><a href="#get_state">get_state(self)</a></td>
+	<td class="summary">Return radio group state</td>
+	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#init">init(self, nodes, callback[, click_nodes=node])</a></td>
 	<td class="summary">Component init function</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#set_state">set_state(self, index)</a></td>
+	<td class="name" nowrap><a href="#set_state">set_state(self, index, is_instant)</a></td>
 	<td class="summary">Set radio group state</td>
 	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#get_state">get_state(self)</a></td>
-	<td class="summary">Return radio group state</td>
-	</tr>
 </table>
 <h2><a href="#Fields">Fields</a></h2>
 <table class="function_list">
-	<tr>
-	<td class="name" nowrap><a href="#on_radio_click">on_radio_click</a></td>
-	<td class="summary">On any checkbox click</td>
-	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#checkboxes">checkboxes</a></td>
 	<td class="summary">Array of checkbox components</td>
 	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#on_radio_click">on_radio_click</a></td>
+	<td class="summary">On any checkbox click</td>
+	</tr>
 </table>
 
 <br/>
@@ -108,6 +113,33 @@
     <h2 class="section-header "><a name="Functions"></a>Functions</h2>
 
     <dl class="function">
+    <dt>
+    <a name = "get_state"></a>
+    <strong>get_state(self)</strong>
+    </dt>
+    <dd>
+    Return radio group state
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">RadioGroup</span></span>
+         <a href="../modules/RadioGroup.html#">RadioGroup</a>
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">number</span></span>
+        Index in radio group
+    </ol>
+
+
+
+
+</dd>
     <dt>
     <a name = "init"></a>
     <strong>init(self, nodes, callback[, click_nodes=node])</strong>
@@ -120,7 +152,7 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">RadioGroup</span></span>
-
+         <a href="../modules/RadioGroup.html#">RadioGroup</a>
         </li>
         <li><span class="parameter">nodes</span>
             <span class="types"><span class="type">node[]</span></span>
@@ -144,7 +176,7 @@
 </dd>
     <dt>
     <a name = "set_state"></a>
-    <strong>set_state(self, index)</strong>
+    <strong>set_state(self, index, is_instant)</strong>
     </dt>
     <dd>
     Set radio group state
@@ -154,41 +186,18 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">RadioGroup</span></span>
-
+         <a href="../modules/RadioGroup.html#">RadioGroup</a>
         </li>
         <li><span class="parameter">index</span>
             <span class="types"><span class="type">number</span></span>
          Index in radio group
         </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "get_state"></a>
-    <strong>get_state(self)</strong>
-    </dt>
-    <dd>
-    Return radio group state
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">RadioGroup</span></span>
-
+        <li><span class="parameter">is_instant</span>
+            <span class="types"><span class="type">boolean</span></span>
+         If is instant state change
         </li>
     </ul>
 
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">number</span></span>
-        Index in radio group
-    </ol>
 
 
 
@@ -198,26 +207,6 @@
     <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 
     <dl class="function">
-    <dt>
-    <a name = "on_radio_click"></a>
-    <strong>on_radio_click</strong>
-    </dt>
-    <dd>
-    On any checkbox click
-
-
-    <ul>
-        <li><span class="parameter">on_radio_click</span>
-            <span class="types"><span class="type">druid_event</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
     <dt>
     <a name = "checkboxes"></a>
     <strong>checkboxes</strong>
@@ -237,6 +226,26 @@
 
 
 
+</dd>
+    <dt>
+    <a name = "on_radio_click"></a>
+    <strong>on_radio_click</strong>
+    </dt>
+    <dd>
+    On any checkbox click
+
+
+    <ul>
+        <li><span class="parameter">on_radio_click</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
+        </li>
+    </ul>
+
+
+
+
+
 </dd>
 </dl>
 
@@ -244,8 +253,8 @@
 </div> <!-- id="content" -->
 </div> <!-- id="main" -->
 <div id="about">
-<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-04-06 00:03:14 </i>
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc TESTING</a></i>
+<i style="float:right;">Last updated 2015-01-01 12:00:00 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

docs/modules/RichInput.html

@@ -0,0 +1,270 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+<head>
+    <title>Defold Druid UI Framework</title>
+    <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
+</head>
+<body>
+
+<div id="container">
+
+<div id="product">
+	<div id="product_logo"></div>
+	<div id="product_name"><big><b></b></big></div>
+	<div id="product_description"></div>
+</div> <!-- id="product" -->
+
+
+<div id="main">
+
+
+<!-- Menu -->
+
+<div id="navigation">
+<br/>
+<h1>Druid</h1>
+
+<ul>
+  <li><a href="../index.html">Index</a></li>
+</ul>
+
+<h2>Contents</h2>
+<ul>
+<li><a href="#Functions">Functions</a></li>
+<li><a href="#Fields">Fields</a></li>
+</ul>
+
+
+<h2>Modules</h2>
+<ul class="nowrap">
+  <li><a href="../modules/BackHandler.html">BackHandler</a></li>
+  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
+  <li><a href="../modules/Blocker.html">Blocker</a></li>
+  <li><a href="../modules/Button.html">Button</a></li>
+  <li><a href="../modules/Checkbox.html">Checkbox</a></li>
+  <li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
+  <li><a href="../modules/DataList.html">DataList</a></li>
+  <li><a href="../modules/Drag.html">Drag</a></li>
+  <li><a href="../modules/Druid.html">Druid</a></li>
+  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
+  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
+  <li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
+  <li><a href="../modules/Helper.html">Helper</a></li>
+  <li><a href="../modules/Hotkey.html">Hotkey</a></li>
+  <li><a href="../modules/Hover.html">Hover</a></li>
+  <li><a href="../modules/Input.html">Input</a></li>
+  <li><a href="../modules/LangText.html">LangText</a></li>
+  <li><a href="../modules/Layout.html">Layout</a></li>
+  <li><a href="../modules/PinKnob.html">PinKnob</a></li>
+  <li><a href="../modules/Progress.html">Progress</a></li>
+  <li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
+  <li><strong>RichInput</strong></li>
+  <li><a href="../modules/RichText.html">RichText</a></li>
+  <li><a href="../modules/Scroll.html">Scroll</a></li>
+  <li><a href="../modules/Slider.html">Slider</a></li>
+  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
+  <li><a href="../modules/Swipe.html">Swipe</a></li>
+  <li><a href="../modules/Text.html">Text</a></li>
+  <li><a href="../modules/Timer.html">Timer</a></li>
+</ul>
+
+</div>
+
+<div id="content">
+
+<h1>Module <code>RichInput</code></h1>
+<p>Druid Rich Input custom component.</p>
+<p>
+ It's wrapper on Input component with cursor and placeholder text</p>
+
+
+<h2><a href="#Functions">Functions</a></h2>
+<table class="function_list">
+	<tr>
+	<td class="name" nowrap><a href="#init">init(self, template, nodes)</a></td>
+	<td class="summary">Component init function</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#set_placeholder">set_placeholder(self, placeholder_text)</a></td>
+	<td class="summary">Set placeholder text</td>
+	</tr>
+</table>
+<h2><a href="#Fields">Fields</a></h2>
+<table class="function_list">
+	<tr>
+	<td class="name" nowrap><a href="#cursor">cursor</a></td>
+	<td class="summary">On input field text change to empty string callback(self, input_text)</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#druid">druid</a></td>
+	<td class="summary">The component druid instance</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#input">input</a></td>
+	<td class="summary">On input field text change callback(self, input_text)</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#placeholder">placeholder</a></td>
+	<td class="summary">On input field text change to max length string callback(self, input_text)</td>
+	</tr>
+</table>
+
+<br/>
+<br/>
+
+
+    <h2 class="section-header "><a name="Functions"></a>Functions</h2>
+
+    <dl class="function">
+    <dt>
+    <a name = "init"></a>
+    <strong>init(self, template, nodes)</strong>
+    </dt>
+    <dd>
+    Component init function
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">RichInput</span></span>
+         <a href="../modules/RichInput.html#">RichInput</a>
+        </li>
+        <li><span class="parameter">template</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         The template string name
+        </li>
+        <li><span class="parameter">nodes</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+         Nodes table from gui.clone_tree
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "set_placeholder"></a>
+    <strong>set_placeholder(self, placeholder_text)</strong>
+    </dt>
+    <dd>
+    Set placeholder text
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">RichInput</span></span>
+         <a href="../modules/RichInput.html#">RichInput</a>
+        </li>
+        <li><span class="parameter">placeholder_text</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         The placeholder text
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+</dl>
+    <h2 class="section-header "><a name="Fields"></a>Fields</h2>
+
+    <dl class="function">
+    <dt>
+    <a name = "cursor"></a>
+    <strong>cursor</strong>
+    </dt>
+    <dd>
+    On input field text change to empty string callback(self, input_text)
+
+
+    <ul>
+        <li><span class="parameter">cursor</span>
+            <span class="types"><span class="type">node</span></span>
+
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "druid"></a>
+    <strong>druid</strong>
+    </dt>
+    <dd>
+    The component druid instance
+
+
+    <ul>
+        <li><span class="parameter">druid</span>
+            <span class="types"><span class="type">DruidInstance</span></span>
+         <a href="../modules/DruidInstance.html#">DruidInstance</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "input"></a>
+    <strong>input</strong>
+    </dt>
+    <dd>
+    On input field text change callback(self, input_text)
+
+
+    <ul>
+        <li><span class="parameter">input</span>
+            <span class="types"><span class="type">Input</span></span>
+         <a href="../modules/Input.html#">Input</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "placeholder"></a>
+    <strong>placeholder</strong>
+    </dt>
+    <dd>
+    On input field text change to max length string callback(self, input_text)
+
+
+    <ul>
+        <li><span class="parameter">placeholder</span>
+            <span class="types"><span class="type">druid.text</span></span>
+         <a href="../modules/Text.html#">Text</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+</dl>
+
+
+</div> <!-- id="content" -->
+</div> <!-- id="main" -->
+<div id="about">
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc TESTING</a></i>
+<i style="float:right;">Last updated 2015-01-01 12:00:00 </i>
+</div> <!-- id="about" -->
+</div> <!-- id="container" -->
+</body>
+</html>

docs/modules/RichText.html

@@ -0,0 +1,430 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+<head>
+    <title>Defold Druid UI Framework</title>
+    <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
+</head>
+<body>
+
+<div id="container">
+
+<div id="product">
+	<div id="product_logo"></div>
+	<div id="product_name"><big><b></b></big></div>
+	<div id="product_description"></div>
+</div> <!-- id="product" -->
+
+
+<div id="main">
+
+
+<!-- Menu -->
+
+<div id="navigation">
+<br/>
+<h1>Druid</h1>
+
+<ul>
+  <li><a href="../index.html">Index</a></li>
+</ul>
+
+<h2>Contents</h2>
+<ul>
+<li><a href="#Functions">Functions</a></li>
+<li><a href="#Tables">Tables</a></li>
+</ul>
+
+
+<h2>Modules</h2>
+<ul class="nowrap">
+  <li><a href="../modules/BackHandler.html">BackHandler</a></li>
+  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
+  <li><a href="../modules/Blocker.html">Blocker</a></li>
+  <li><a href="../modules/Button.html">Button</a></li>
+  <li><a href="../modules/Checkbox.html">Checkbox</a></li>
+  <li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
+  <li><a href="../modules/DataList.html">DataList</a></li>
+  <li><a href="../modules/Drag.html">Drag</a></li>
+  <li><a href="../modules/Druid.html">Druid</a></li>
+  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
+  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
+  <li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
+  <li><a href="../modules/Helper.html">Helper</a></li>
+  <li><a href="../modules/Hotkey.html">Hotkey</a></li>
+  <li><a href="../modules/Hover.html">Hover</a></li>
+  <li><a href="../modules/Input.html">Input</a></li>
+  <li><a href="../modules/LangText.html">LangText</a></li>
+  <li><a href="../modules/Layout.html">Layout</a></li>
+  <li><a href="../modules/PinKnob.html">PinKnob</a></li>
+  <li><a href="../modules/Progress.html">Progress</a></li>
+  <li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
+  <li><a href="../modules/RichInput.html">RichInput</a></li>
+  <li><strong>RichText</strong></li>
+  <li><a href="../modules/Scroll.html">Scroll</a></li>
+  <li><a href="../modules/Slider.html">Slider</a></li>
+  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
+  <li><a href="../modules/Swipe.html">Swipe</a></li>
+  <li><a href="../modules/Text.html">Text</a></li>
+  <li><a href="../modules/Timer.html">Timer</a></li>
+</ul>
+
+</div>
+
+<div id="content">
+
+<h1>Module <code>RichText</code></h1>
+<p>Druid Rich Text Custom Component.</p>
+<p>
+ <b># Overview #</b>
+<p> This custom component is inspired by <a href="https://github.com/britzl/defold-richtext" target="_blank">defold-richtext</a> by britzl.
+ It uses a similar syntax for tags but currently supports fewer tags.
+<p> All parameters for the Rich Text component are adjusted in the GUI scene.
+<p> This component uses GUI component template. (/druid/custom/rich_text/rich_text.gui).
+<p> You able to customize it or make your own with the next node scructure:
+<p> root
+<p>   - text_prefab
+<p>   - icon_prefab
+<p> <b># Rich Text Setup #</b>
+<p> • Root node size: Set the maximum width and height of the text.
+<p> • Root anchor: Define the alignment of the Rich Text inside the root node size area.
+<p> • Text prefab: Configure all default text parameters for the text node.
+<p> • Text prefab anchor: Set the anchor for each text node (adjust this only if animating text).
+<p> • Icon prefab: Configure all default node parameters for the icon node.
+<p> • Icon prefab anchor: Set the anchor for each icon node (adjust this only if animating the icon).
+<p> <b># Notes #</b>
+<p> • Nested tags are supported
+<p> <a href="https://insality.github.io/druid/druid/index.html?example=custom_rich_text" target="_blank"><b>Example Link</b></a></p>
+    <h3>Usage:</h3>
+    <ul>
+        <li><pre class="example">local RichText = require(&quot;druid.custom.rich_text.rich_text&quot;)
+...
+self.rich_text = self.druid:new(RichText, &quot;rich_text&quot;)
+self.rich_text:set_text(&quot;Hello, Druid Rich Text!&quot;)
+</pre></li>
+        <li><pre class="example">type druid.rich_text.word = {
+  node: Node,
+  relative_scale: number,
+  color: vector4,
+  position: vector3,
+  offset: vector3,
+  scale: vector3,
+  size: vector3,
+  metrics: druid.rich_text.metrics,
+  pivot: Pivot,
+  text: string,
+  shadow: vector4,
+  outline: vector4,
+  font: string,
+  image: druid.rich_text.image,
+  default_animation: string,
+  br: boolean,
+  nobr: boolean,
+}
+
+type druid.rich_text.word.image = {
+  texture: string,
+  anim: string,
+  width: number,
+  height: number,
+}
+
+type druid.rich_text.lines_metrics = {
+  text_width: number,
+  text_height: number,
+  lines: table&lt;number, druid.rich_text.metrics&gt;,
+}
+
+type druid.rich_text.metrics = {
+  width: number,
+  height: number,
+  offset_x: number|nil,
+  offset_y: number|nil,
+  node_size: vector3|nil @For images only,
+}
+</pre></li>
+    </ul>
+
+
+<h2><a href="#Functions">Functions</a></h2>
+<table class="function_list">
+	<tr>
+	<td class="name" nowrap><a href="#clear">clear()</a></td>
+	<td class="summary">Clear all created words.</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#get_line_metric">get_line_metric()</a></td>
+	<td class="summary">Get current line metrics</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#get_words">get_words()</a></td>
+	<td class="summary">Get all current words.</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#init">init(self, template, nodes)</a></td>
+	<td class="summary">Rich Text component constructor</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#set_text">set_text(self, text)</a></td>
+	<td class="summary">Set text for Rich Text</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#tagged">tagged(tag)</a></td>
+	<td class="summary">Get all words, which has a passed tag.</td>
+	</tr>
+</table>
+<h2><a href="#Tables">Tables</a></h2>
+<table class="function_list">
+	<tr>
+	<td class="name" nowrap><a href="#style">style</a></td>
+	<td class="summary">Component style params.</td>
+	</tr>
+</table>
+
+<br/>
+<br/>
+
+
+    <h2 class="section-header "><a name="Functions"></a>Functions</h2>
+
+    <dl class="function">
+    <dt>
+    <a name = "clear"></a>
+    <strong>clear()</strong>
+    </dt>
+    <dd>
+    Clear all created words.
+
+
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "get_line_metric"></a>
+    <strong>get_line_metric()</strong>
+    </dt>
+    <dd>
+    Get current line metrics
+
+
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">druid.rich_text.lines_metrics</span></span>
+
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "get_words"></a>
+    <strong>get_words()</strong>
+    </dt>
+    <dd>
+    Get all current words.
+
+
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+        druid.rich_text.word[]
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "init"></a>
+    <strong>init(self, template, nodes)</strong>
+    </dt>
+    <dd>
+    Rich Text component constructor
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">RichText</span></span>
+         <a href="../modules/RichText.html#">RichText</a>
+        </li>
+        <li><span class="parameter">template</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         The Rich Text template name
+        </li>
+        <li><span class="parameter">nodes</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+         The node table, if prefab was copied by gui.clone_tree()
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "set_text"></a>
+    <strong>set_text(self, text)</strong>
+    </dt>
+    <dd>
+    Set text for Rich Text
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">RichText</span></span>
+         <a href="../modules/RichText.html#">RichText</a>
+        </li>
+        <li><span class="parameter">text</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         The text to set
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+        <li>
+           <span class="types"><span class="type">druid.rich_text.word[]</span></span>
+        words</li>
+        <li>
+           <span class="types"><span class="type">druid.rich_text.lines_metrics</span></span>
+        line_metrics</li>
+    </ol>
+
+
+
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example">• color: Change text color
+
+&lt;color=red&gt;Foobar&lt;/color&gt;
+&lt;color=<span class="number">1.0</span>,<span class="number">0</span>,<span class="number">0</span>,<span class="number">1.0</span>&gt;Foobar&lt;/color&gt;
+&lt;color=#ff0000&gt;Foobar&lt;/color&gt;
+&lt;color=#ff0000ff&gt;Foobar&lt;/color&gt;
+
+• shadow: Change text shadow
+
+&lt;shadow=red&gt;Foobar&lt;/shadow&gt;
+&lt;shadow=<span class="number">1.0</span>,<span class="number">0</span>,<span class="number">0</span>,<span class="number">1.0</span>&gt;Foobar&lt;/shadow&gt;
+&lt;shadow=#ff0000&gt;Foobar&lt;/shadow&gt;
+&lt;shadow=#ff0000ff&gt;Foobar&lt;/shadow&gt;
+
+• outline: Change text shadow
+
+&lt;outline=red&gt;Foobar&lt;/outline&gt;
+&lt;outline=<span class="number">1.0</span>,<span class="number">0</span>,<span class="number">0</span>,<span class="number">1.0</span>&gt;Foobar&lt;/outline&gt;
+&lt;outline=#ff0000&gt;Foobar&lt;/outline&gt;
+&lt;outline=#ff0000ff&gt;Foobar&lt;/outline&gt;
+
+• font: Change font
+
+&lt;font=MyCoolFont&gt;Foobar&lt;/font&gt;
+
+• size: Change text size, relative to default size
+
+&lt;size=<span class="number">2</span>&gt;Twice as large&lt;/size&gt;
+
+• br: Insert a line <span class="keyword">break</span>
+
+&lt;br/&gt;
+
+• nobr: Prevent the text from breaking
+
+Words &lt;nobr&gt;inside tag&lt;/nobr&gt; won't <span class="keyword">break</span>
+
+• img: Display image
+
+&lt;img=texture:image/&gt;
+&lt;img=texture:image,size/&gt;
+&lt;img=texture:image,width,height/&gt;</pre>
+    </ul>
+
+</dd>
+    <dt>
+    <a name = "tagged"></a>
+    <strong>tagged(tag)</strong>
+    </dt>
+    <dd>
+    Get all words, which has a passed tag.
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">tag</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">druid.rich_text.word[]</span></span>
+        words
+    </ol>
+
+
+
+
+</dd>
+</dl>
+    <h2 class="section-header "><a name="Tables"></a>Tables</h2>
+
+    <dl class="function">
+    <dt>
+    <a name = "style"></a>
+    <strong>style</strong>
+    </dt>
+    <dd>
+    Component style params.
+ You can override this component styles params in Druid styles table
+ or create your own style
+
+
+    <h3>Fields:</h3>
+    <ul>
+        <li><span class="parameter">COLORS</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+         Rich Text color aliases
+         (<em>default</em> {})
+        </li>
+        <li><span class="parameter">ADJUST_STEPS</span>
+            <span class="types"><span class="type">number</span></span>
+         Amount steps of attemps text adjust by height
+         (<em>default</em> 20)
+        </li>
+        <li><span class="parameter">ADJUST_SCALE_DELTA</span>
+            <span class="types"><span class="type">number</span></span>
+         Scale step on each height adjust step
+         (<em>default</em> 0.02)
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+</dl>
+
+
+</div> <!-- id="content" -->
+</div> <!-- id="main" -->
+<div id="about">
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc TESTING</a></i>
+<i style="float:right;">Last updated 2015-01-01 12:00:00 </i>
+</div> <!-- id="about" -->
+</div> <!-- id="container" -->
+</body>
+</html>

docs/modules/Slider.html

@@ -3,7 +3,7 @@
 <html>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
 <head>
-    <title>Defold Druid UI Library</title>
+    <title>Defold Druid UI Framework</title>
     <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
 </head>
 <body>
@@ -40,29 +40,34 @@
 <h2>Modules</h2>
 <ul class="nowrap">
   <li><a href="../modules/BackHandler.html">BackHandler</a></li>
+  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
   <li><a href="../modules/Blocker.html">Blocker</a></li>
   <li><a href="../modules/Button.html">Button</a></li>
-  <li><a href="../modules/Drag.html">Drag</a></li>
-  <li><a href="../modules/Hover.html">Hover</a></li>
-  <li><a href="../modules/Scroll.html">Scroll</a></li>
-  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
-  <li><a href="../modules/Swipe.html">Swipe</a></li>
-  <li><a href="../modules/Text.html">Text</a></li>
-  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
-  <li><a href="../modules/druid.html">druid</a></li>
-  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
   <li><a href="../modules/Checkbox.html">Checkbox</a></li>
   <li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
   <li><a href="../modules/DataList.html">DataList</a></li>
+  <li><a href="../modules/Drag.html">Drag</a></li>
+  <li><a href="../modules/Druid.html">Druid</a></li>
+  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
+  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
   <li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
+  <li><a href="../modules/Helper.html">Helper</a></li>
+  <li><a href="../modules/Hotkey.html">Hotkey</a></li>
+  <li><a href="../modules/Hover.html">Hover</a></li>
   <li><a href="../modules/Input.html">Input</a></li>
   <li><a href="../modules/LangText.html">LangText</a></li>
+  <li><a href="../modules/Layout.html">Layout</a></li>
+  <li><a href="../modules/PinKnob.html">PinKnob</a></li>
   <li><a href="../modules/Progress.html">Progress</a></li>
   <li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
+  <li><a href="../modules/RichInput.html">RichInput</a></li>
+  <li><a href="../modules/RichText.html">RichText</a></li>
+  <li><a href="../modules/Scroll.html">Scroll</a></li>
   <li><strong>Slider</strong></li>
+  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
+  <li><a href="../modules/Swipe.html">Swipe</a></li>
+  <li><a href="../modules/Text.html">Text</a></li>
   <li><a href="../modules/Timer.html">Timer</a></li>
-  <li><a href="../modules/druid.helper.html">druid.helper</a></li>
-  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
 </ul>
 
 </div>
@@ -71,7 +76,7 @@
 
 <h1>Module <code>Slider</code></h1>
 <p>Druid slider component</p>
-<p></p>
+<p> <a href="https://insality.github.io/druid/druid/index.html?example=general_sliders" target="_blank"><b>Example Link</b></a></p>
 
 
 <h2><a href="#Functions">Functions</a></h2>
@@ -85,6 +90,10 @@
 	<td class="summary">Set value for slider</td>
 	</tr>
 	<tr>
+	<td class="name" nowrap><a href="#set_input_node">set_input_node(self, input_node)</a></td>
+	<td class="summary">Set input zone for slider.</td>
+	</tr>
+	<tr>
 	<td class="name" nowrap><a href="#set_steps">set_steps(self, steps)</a></td>
 	<td class="summary">Set slider steps.</td>
 	</tr>
@@ -92,38 +101,38 @@
 <h2><a href="#Fields">Fields</a></h2>
 <table class="function_list">
 	<tr>
-	<td class="name" nowrap><a href="#on_change_value">on_change_value</a></td>
-	<td class="summary">On change value callback(self, value)</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#node">node</a></td>
-	<td class="summary">Slider pin node</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#start_pos">start_pos</a></td>
-	<td class="summary">Start pin node position</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#pos">pos</a></td>
-	<td class="summary">Current pin node position</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#target_pos">target_pos</a></td>
-	<td class="summary">Targer pin node position</td>
+	<td class="name" nowrap><a href="#dist">dist</a></td>
+	<td class="summary">Length between start and end position</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#end_pos">end_pos</a></td>
 	<td class="summary">End pin node position</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#dist">dist</a></td>
-	<td class="summary">Length between start and end position</td>
-	</tr>
-	<tr>
 	<td class="name" nowrap><a href="#is_drag">is_drag</a></td>
 	<td class="summary">Current drag state</td>
 	</tr>
 	<tr>
+	<td class="name" nowrap><a href="#node">node</a></td>
+	<td class="summary">Slider pin node</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#on_change_value">on_change_value</a></td>
+	<td class="summary">On change value callback(self, value)</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#pos">pos</a></td>
+	<td class="summary">Current pin node position</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#start_pos">start_pos</a></td>
+	<td class="summary">Start pin node position</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#target_pos">target_pos</a></td>
+	<td class="summary">Targer pin node position</td>
+	</tr>
+	<tr>
 	<td class="name" nowrap><a href="#value">value</a></td>
 	<td class="summary">Current slider value</td>
 	</tr>
@@ -148,7 +157,7 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Slider</span></span>
-
+         <a href="../modules/Slider.html#">Slider</a>
         </li>
         <li><span class="parameter">node</span>
             <span class="types"><a class="type" href="../modules/Slider.html#node">node</a></span>
@@ -182,7 +191,7 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Slider</span></span>
-
+         <a href="../modules/Slider.html#">Slider</a>
         </li>
         <li><span class="parameter">value</span>
             <span class="types"><span class="type">number</span></span>
@@ -199,6 +208,40 @@
 
 
 
+</dd>
+    <dt>
+    <a name = "set_input_node"></a>
+    <strong>set_input_node(self, input_node)</strong>
+    </dt>
+    <dd>
+    Set input zone for slider.
+ User can touch any place of node, pin instantly will
+ move at this position and node drag will start.
+ This function require the Defold version 1.3.0+
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Slider</span></span>
+         <a href="../modules/Slider.html#">Slider</a>
+        </li>
+        <li><span class="parameter">input_node</span>
+            <span class="types"><span class="type">Node</span></span>
+
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">Slider</span></span>
+        <a href="../modules/Slider.html#">Slider</a>
+    </ol>
+
+
+
+
 </dd>
     <dt>
     <a name = "set_steps"></a>
@@ -213,7 +256,7 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Slider</span></span>
-
+         <a href="../modules/Slider.html#">Slider</a>
         </li>
         <li><span class="parameter">steps</span>
             <span class="types"><span class="type">number[]</span></span>
@@ -221,6 +264,12 @@
         </li>
     </ul>
 
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">Slider</span></span>
+        <a href="../modules/Slider.html#">Slider</a>
+    </ol>
 
 
 
@@ -235,96 +284,16 @@
 
     <dl class="function">
     <dt>
-    <a name = "on_change_value"></a>
-    <strong>on_change_value</strong>
+    <a name = "dist"></a>
+    <strong>dist</strong>
     </dt>
     <dd>
-    On change value callback(self, value)
+    Length between start and end position
 
 
     <ul>
-        <li><span class="parameter">on_change_value</span>
-            <span class="types"><span class="type">druid_event</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "node"></a>
-    <strong>node</strong>
-    </dt>
-    <dd>
-    Slider pin node
-
-
-    <ul>
-        <li><span class="parameter">node</span>
-            <span class="types"><a class="type" href="../modules/Slider.html#node">node</a></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "start_pos"></a>
-    <strong>start_pos</strong>
-    </dt>
-    <dd>
-    Start pin node position
-
-
-    <ul>
-        <li><span class="parameter">start_pos</span>
-            <span class="types"><span class="type">vector3</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "pos"></a>
-    <strong>pos</strong>
-    </dt>
-    <dd>
-    Current pin node position
-
-
-    <ul>
-        <li><span class="parameter">pos</span>
-            <span class="types"><span class="type">vector3</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "target_pos"></a>
-    <strong>target_pos</strong>
-    </dt>
-    <dd>
-    Targer pin node position
-
-
-    <ul>
-        <li><span class="parameter">target_pos</span>
-            <span class="types"><span class="type">vector3</span></span>
+        <li><span class="parameter">dist</span>
+            <span class="types"><span class="type">number</span></span>
 
         </li>
     </ul>
@@ -353,26 +322,6 @@
 
 
 
-</dd>
-    <dt>
-    <a name = "dist"></a>
-    <strong>dist</strong>
-    </dt>
-    <dd>
-    Length between start and end position
-
-
-    <ul>
-        <li><span class="parameter">dist</span>
-            <span class="types"><span class="type">number</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
 </dd>
     <dt>
     <a name = "is_drag"></a>
@@ -393,6 +342,106 @@
 
 
 
+</dd>
+    <dt>
+    <a name = "node"></a>
+    <strong>node</strong>
+    </dt>
+    <dd>
+    Slider pin node
+
+
+    <ul>
+        <li><span class="parameter">node</span>
+            <span class="types"><a class="type" href="../modules/Slider.html#node">node</a></span>
+
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "on_change_value"></a>
+    <strong>on_change_value</strong>
+    </dt>
+    <dd>
+    On change value callback(self, value)
+
+
+    <ul>
+        <li><span class="parameter">on_change_value</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "pos"></a>
+    <strong>pos</strong>
+    </dt>
+    <dd>
+    Current pin node position
+
+
+    <ul>
+        <li><span class="parameter">pos</span>
+            <span class="types"><span class="type">vector3</span></span>
+
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "start_pos"></a>
+    <strong>start_pos</strong>
+    </dt>
+    <dd>
+    Start pin node position
+
+
+    <ul>
+        <li><span class="parameter">start_pos</span>
+            <span class="types"><span class="type">vector3</span></span>
+
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "target_pos"></a>
+    <strong>target_pos</strong>
+    </dt>
+    <dd>
+    Targer pin node position
+
+
+    <ul>
+        <li><span class="parameter">target_pos</span>
+            <span class="types"><span class="type">vector3</span></span>
+
+        </li>
+    </ul>
+
+
+
+
+
 </dd>
     <dt>
     <a name = "value"></a>
@@ -420,8 +469,8 @@
 </div> <!-- id="content" -->
 </div> <!-- id="main" -->
 <div id="about">
-<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-04-06 00:03:14 </i>
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc TESTING</a></i>
+<i style="float:right;">Last updated 2015-01-01 12:00:00 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

docs/modules/Swipe.html

@@ -3,7 +3,7 @@
 <html>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
 <head>
-    <title>Defold Druid UI Library</title>
+    <title>Defold Druid UI Framework</title>
     <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
 </head>
 <body>
@@ -41,29 +41,34 @@
 <h2>Modules</h2>
 <ul class="nowrap">
   <li><a href="../modules/BackHandler.html">BackHandler</a></li>
+  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
   <li><a href="../modules/Blocker.html">Blocker</a></li>
   <li><a href="../modules/Button.html">Button</a></li>
-  <li><a href="../modules/Drag.html">Drag</a></li>
-  <li><a href="../modules/Hover.html">Hover</a></li>
-  <li><a href="../modules/Scroll.html">Scroll</a></li>
-  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
-  <li><strong>Swipe</strong></li>
-  <li><a href="../modules/Text.html">Text</a></li>
-  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
-  <li><a href="../modules/druid.html">druid</a></li>
-  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
   <li><a href="../modules/Checkbox.html">Checkbox</a></li>
   <li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
   <li><a href="../modules/DataList.html">DataList</a></li>
+  <li><a href="../modules/Drag.html">Drag</a></li>
+  <li><a href="../modules/Druid.html">Druid</a></li>
+  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
+  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
   <li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
+  <li><a href="../modules/Helper.html">Helper</a></li>
+  <li><a href="../modules/Hotkey.html">Hotkey</a></li>
+  <li><a href="../modules/Hover.html">Hover</a></li>
   <li><a href="../modules/Input.html">Input</a></li>
   <li><a href="../modules/LangText.html">LangText</a></li>
+  <li><a href="../modules/Layout.html">Layout</a></li>
+  <li><a href="../modules/PinKnob.html">PinKnob</a></li>
   <li><a href="../modules/Progress.html">Progress</a></li>
   <li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
+  <li><a href="../modules/RichInput.html">RichInput</a></li>
+  <li><a href="../modules/RichText.html">RichText</a></li>
+  <li><a href="../modules/Scroll.html">Scroll</a></li>
   <li><a href="../modules/Slider.html">Slider</a></li>
+  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
+  <li><strong>Swipe</strong></li>
+  <li><a href="../modules/Text.html">Text</a></li>
   <li><a href="../modules/Timer.html">Timer</a></li>
-  <li><a href="../modules/druid.helper.html">druid.helper</a></li>
-  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
 </ul>
 
 </div>
@@ -74,7 +79,8 @@
 <p>Component to handle swipe gestures on node.</p>
 <p>
  Swipe will be triggered, if swipe was started and
- ended on one node</p>
+ ended on one node
+<p> <a href="https://insality.github.io/druid/druid/index.html?example=general_swipe" target="_blank"><b>Example Link</b></a></p>
 
 
 <h2><a href="#Functions">Functions</a></h2>
@@ -97,17 +103,17 @@
 </table>
 <h2><a href="#Fields">Fields</a></h2>
 <table class="function_list">
-	<tr>
-	<td class="name" nowrap><a href="#node">node</a></td>
-	<td class="summary">Swipe node</td>
-	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#click_zone">click_zone</a></td>
 	<td class="summary">Restriction zone</td>
 	</tr>
 	<tr>
+	<td class="name" nowrap><a href="#node">node</a></td>
+	<td class="summary">Swipe node</td>
+	</tr>
+	<tr>
 	<td class="name" nowrap><a href="#on_swipe">on_swipe</a></td>
-	<td class="summary">Trigger on swipe event(self, swipe_side, dist, delta_time</td>
+	<td class="summary">Trigger on swipe event(self, swipe_side, dist, delta_time)</td>
 	</tr>
 </table>
 
@@ -130,7 +136,7 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Swipe</span></span>
-
+         <a href="../modules/Swipe.html#">Swipe</a>
         </li>
         <li><span class="parameter">node</span>
             <span class="types"><a class="type" href="../modules/Swipe.html#node">node</a></span>
@@ -160,7 +166,7 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Swipe</span></span>
-
+         <a href="../modules/Swipe.html#">Swipe</a>
         </li>
         <li><span class="parameter">zone</span>
             <span class="types"><a class="type" href="../modules/Swipe.html#node">node</a></span>
@@ -215,26 +221,6 @@
     <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 
     <dl class="function">
-    <dt>
-    <a name = "node"></a>
-    <strong>node</strong>
-    </dt>
-    <dd>
-    Swipe node
-
-
-    <ul>
-        <li><span class="parameter">node</span>
-            <span class="types"><a class="type" href="../modules/Swipe.html#node">node</a></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
     <dt>
     <a name = "click_zone"></a>
     <strong>click_zone</strong>
@@ -255,19 +241,39 @@
 
 
 
+</dd>
+    <dt>
+    <a name = "node"></a>
+    <strong>node</strong>
+    </dt>
+    <dd>
+    Swipe node
+
+
+    <ul>
+        <li><span class="parameter">node</span>
+            <span class="types"><a class="type" href="../modules/Swipe.html#node">node</a></span>
+
+        </li>
+    </ul>
+
+
+
+
+
 </dd>
     <dt>
     <a name = "on_swipe"></a>
     <strong>on_swipe</strong>
     </dt>
     <dd>
-    Trigger on swipe event(self, swipe_side, dist, delta_time
+    Trigger on swipe event(self, swipe_side, dist, delta_time)
 
 
     <ul>
         <li><span class="parameter">on_swipe</span>
-            <span class="types"><span class="type">druid_event</span></span>
-        )
+            <span class="types"><span class="type">DruidEvent</span></span>
+        ) <a href="../modules/DruidEvent.html#">DruidEvent</a>
         </li>
     </ul>
 
@@ -282,8 +288,8 @@
 </div> <!-- id="content" -->
 </div> <!-- id="main" -->
 <div id="about">
-<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-04-06 00:03:14 </i>
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc TESTING</a></i>
+<i style="float:right;">Last updated 2015-01-01 12:00:00 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

docs/modules/Text.html

@@ -3,7 +3,7 @@
 <html>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
 <head>
-    <title>Defold Druid UI Library</title>
+    <title>Defold Druid UI Framework</title>
     <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
 </head>
 <body>
@@ -33,6 +33,7 @@
 <h2>Contents</h2>
 <ul>
 <li><a href="#Functions">Functions</a></li>
+<li><a href="#Tables">Tables</a></li>
 <li><a href="#Fields">Fields</a></li>
 </ul>
 
@@ -40,29 +41,34 @@
 <h2>Modules</h2>
 <ul class="nowrap">
   <li><a href="../modules/BackHandler.html">BackHandler</a></li>
+  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
   <li><a href="../modules/Blocker.html">Blocker</a></li>
   <li><a href="../modules/Button.html">Button</a></li>
-  <li><a href="../modules/Drag.html">Drag</a></li>
-  <li><a href="../modules/Hover.html">Hover</a></li>
-  <li><a href="../modules/Scroll.html">Scroll</a></li>
-  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
-  <li><a href="../modules/Swipe.html">Swipe</a></li>
-  <li><strong>Text</strong></li>
-  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
-  <li><a href="../modules/druid.html">druid</a></li>
-  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
   <li><a href="../modules/Checkbox.html">Checkbox</a></li>
   <li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
   <li><a href="../modules/DataList.html">DataList</a></li>
+  <li><a href="../modules/Drag.html">Drag</a></li>
+  <li><a href="../modules/Druid.html">Druid</a></li>
+  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
+  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
   <li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
+  <li><a href="../modules/Helper.html">Helper</a></li>
+  <li><a href="../modules/Hotkey.html">Hotkey</a></li>
+  <li><a href="../modules/Hover.html">Hover</a></li>
   <li><a href="../modules/Input.html">Input</a></li>
   <li><a href="../modules/LangText.html">LangText</a></li>
+  <li><a href="../modules/Layout.html">Layout</a></li>
+  <li><a href="../modules/PinKnob.html">PinKnob</a></li>
   <li><a href="../modules/Progress.html">Progress</a></li>
   <li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
+  <li><a href="../modules/RichInput.html">RichInput</a></li>
+  <li><a href="../modules/RichText.html">RichText</a></li>
+  <li><a href="../modules/Scroll.html">Scroll</a></li>
   <li><a href="../modules/Slider.html">Slider</a></li>
+  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
+  <li><a href="../modules/Swipe.html">Swipe</a></li>
+  <li><strong>Text</strong></li>
   <li><a href="../modules/Timer.html">Timer</a></li>
-  <li><a href="../modules/druid.helper.html">druid.helper</a></li>
-  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
 </ul>
 
 </div>
@@ -70,78 +76,125 @@
 <div id="content">
 
 <h1>Module <code>Text</code></h1>
-<p>Component to handle all GUI texts.</p>
-<p>
- Druid text can adjust itself for text node size
- Text will never will be outside of his text size (even multiline)</p>
+<p>Component for Wrapping GUI Text Nodes: Druid Text
+<p> ## Overview ##
+<p> Druid Text is a component that provides various adjustment modes for text nodes.</p>
+<p> It allows text to be scaled down to fit within the size of the text node.
+<p> ## Notes ##
+<p> • The text pivot can be changed using the text:set_pivot method.
+ The anchoring will be inside the text node's area size.
+<p> • There are several text adjustment types available. The default is DOWNSCALE.
+ You can change the default adjustment type in the Text style. Refer to the example below to see all available adjustment types:
+<p> - const.TEXT_ADJUST.DOWNSCALE: Changes the text's scale to fit within the text node's size.
+<p> - const.TEXT_ADJUST.TRIM: Trims the text with a postfix (default: "...", can be overridden in styles)
+ to fit within the text node's size.
+<p> - const.TEXT_ADJUST.NO_ADJUST: No adjustment is applied, similar
+ to the default Defold Text Node behavior.
+<p> - const.TEXT_ADJUST.DOWNSCALE_LIMITED: Changes the text's scale
+ with a limited downscale. You can set the minimum scale using the text:set_minimal_scale() function.
+<p> - const.TEXT_ADJUST.SCROLL: Changes the text's pivot to imitate scrolling within the text box.
+ For better effect, use with a stencil node.
+<p> - const.TEXT_ADJUST.SCALE_THEN_SCROLL: Combines two modes: limited downscale first, then scroll.
+<p> <a href="https://insality.github.io/druid/druid/index.html?example=texts_general" target="_blank"><b>Example Link</b></a></p>
 
 
 <h2><a href="#Functions">Functions</a></h2>
 <table class="function_list">
 	<tr>
-	<td class="name" nowrap><a href="#init">init(self, node[, value[, no_adjust]])</a></td>
-	<td class="summary">Component init function</td>
+	<td class="name" nowrap><a href="#get_text_adjust">get_text_adjust(self, adjust_type)</a></td>
+	<td class="summary">Return current text adjust type</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#get_text_width">get_text_width(self[, text])</a></td>
+	<td class="name" nowrap><a href="#get_text_size">get_text_size(self[, text])</a></td>
 	<td class="summary">Calculate text width with font with respect to trailing space</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#set_to">set_to(self, set_to)</a></td>
-	<td class="summary">Set text to text field</td>
+	<td class="name" nowrap><a href="#init">init(self, node[, value[, adjust_type=downscale]])</a></td>
+	<td class="summary"><a href="../modules/Text.html#">Text</a> constructor</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#set_color">set_color(self, color)</a></td>
-	<td class="summary">Set color</td>
+	<td class="name" nowrap><a href="#is_multiline">is_multiline(self)</a></td>
+	<td class="summary">Return true, if text with line break</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#set_alpha">set_alpha(self, alpha)</a></td>
 	<td class="summary">Set alpha</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#set_scale">set_scale(self, scale)</a></td>
-	<td class="summary">Set scale</td>
+	<td class="name" nowrap><a href="#set_color">set_color(self, color)</a></td>
+	<td class="summary">Set color</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#set_minimal_scale">set_minimal_scale(self, minimal_scale)</a></td>
+	<td class="summary">Set minimal scale for DOWNSCALE_LIMITED or SCALE_THEN_SCROLL adjust types</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#set_pivot">set_pivot(self, pivot)</a></td>
 	<td class="summary">Set text pivot.</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#is_multiline">is_multiline(self)</a></td>
-	<td class="summary">Return true, if text with line break</td>
+	<td class="name" nowrap><a href="#set_scale">set_scale(self, scale)</a></td>
+	<td class="summary">Set scale</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#set_text_adjust">set_text_adjust(self[, adjust_type[, minimal_scale]])</a></td>
+	<td class="summary">Set text adjust, refresh the current text visuals, if needed</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#set_to">set_to(self, set_to)</a></td>
+	<td class="summary">Set text to text field</td>
+	</tr>
+</table>
+<h2><a href="#Tables">Tables</a></h2>
+<table class="function_list">
+	<tr>
+	<td class="name" nowrap><a href="#style">style</a></td>
+	<td class="summary">Component style params.</td>
 	</tr>
 </table>
 <h2><a href="#Fields">Fields</a></h2>
 <table class="function_list">
 	<tr>
-	<td class="name" nowrap><a href="#on_set_text">on_set_text</a></td>
-	<td class="summary">On set text callback(self, text)</td>
+	<td class="name" nowrap><a href="#adjust_type">adjust_type</a></td>
+	<td class="summary">Current text size adjust settings</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#on_update_text_scale">on_update_text_scale</a></td>
-	<td class="summary">On adjust text size callback(self, new_scale)</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#on_set_pivot">on_set_pivot</a></td>
-	<td class="summary">On change pivot callback(self, pivot)</td>
+	<td class="name" nowrap><a href="#color">color</a></td>
+	<td class="summary">Current text color</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#node">node</a></td>
 	<td class="summary">Text node</td>
 	</tr>
 	<tr>
+	<td class="name" nowrap><a href="#node_id">node_id</a></td>
+	<td class="summary">The node id of text node</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#on_set_pivot">on_set_pivot</a></td>
+	<td class="summary">On change pivot callback(self, pivot)</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#on_set_text">on_set_text</a></td>
+	<td class="summary">On set text callback(self, text)</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#on_update_text_scale">on_update_text_scale</a></td>
+	<td class="summary">On adjust text size callback(self, new_scale, text_metrics)</td>
+	</tr>
+	<tr>
 	<td class="name" nowrap><a href="#pos">pos</a></td>
 	<td class="summary">Current text position</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#start_scale">start_scale</a></td>
-	<td class="summary">Initial text node scale</td>
-	</tr>
-	<tr>
 	<td class="name" nowrap><a href="#scale">scale</a></td>
 	<td class="summary">Current text node scale</td>
 	</tr>
 	<tr>
+	<td class="name" nowrap><a href="#start_scale">start_scale</a></td>
+	<td class="summary">Initial text node scale</td>
+	</tr>
+	<tr>
 	<td class="name" nowrap><a href="#start_size">start_size</a></td>
 	<td class="summary">Initial text node size</td>
 	</tr>
@@ -149,14 +202,6 @@
 	<td class="name" nowrap><a href="#text_area">text_area</a></td>
 	<td class="summary">Current text node available are</td>
 	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#is_no_adjust">is_no_adjust</a></td>
-	<td class="summary">Current text size adjust settings</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#color">color</a></td>
-	<td class="summary">Current text color</td>
-	</tr>
 </table>
 
 <br/>
@@ -167,43 +212,37 @@
 
     <dl class="function">
     <dt>
-    <a name = "init"></a>
-    <strong>init(self, node[, value[, no_adjust]])</strong>
+    <a name = "get_text_adjust"></a>
+    <strong>get_text_adjust(self, adjust_type)</strong>
     </dt>
     <dd>
-    Component init function
+    Return current text adjust type
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">self</span>
-            <span class="types"><span class="type">Text</span></span>
 
         </li>
-        <li><span class="parameter">node</span>
-            <span class="types"><a class="type" href="../modules/Text.html#node">node</a></span>
-         Gui text node
-        </li>
-        <li><span class="parameter">value</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
-         Initial text. Default value is node text from GUI scene.
-         (<em>optional</em>)
-        </li>
-        <li><span class="parameter">no_adjust</span>
-            <span class="types"><span class="type">bool</span></span>
-         If true, text will be not auto-adjust size
-         (<em>optional</em>)
+        <li><span class="parameter">adjust_type</span>
+
         </li>
     </ul>
 
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">number</span></span>
+        The current text adjust type
+    </ol>
 
 
 
 
 </dd>
     <dt>
-    <a name = "get_text_width"></a>
-    <strong>get_text_width(self[, text])</strong>
+    <a name = "get_text_size"></a>
+    <strong>get_text_size(self[, text])</strong>
     </dt>
     <dd>
     Calculate text width with font with respect to trailing space
@@ -213,138 +252,56 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Text</span></span>
-
+         <a href="../modules/Text.html#">Text</a>
         </li>
         <li><span class="parameter">text</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
 
          (<em>optional</em>)
         </li>
     </ul>
 
+    <h3>Returns:</h3>
+    <ol>
+        <li>
+           <span class="types"><span class="type">number</span></span>
+        Width</li>
+        <li>
+           <span class="types"><span class="type">number</span></span>
+        Height</li>
+    </ol>
 
 
 
 
 </dd>
     <dt>
-    <a name = "set_to"></a>
-    <strong>set_to(self, set_to)</strong>
+    <a name = "init"></a>
+    <strong>init(self, node[, value[, adjust_type=downscale]])</strong>
     </dt>
     <dd>
-    Set text to text field
+    <a href="../modules/Text.html#">Text</a> constructor
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Text</span></span>
-
+         <a href="../modules/Text.html#">Text</a>
         </li>
-        <li><span class="parameter">set_to</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
-         Text for node
+        <li><span class="parameter">node</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a> or <a class="type" href="../modules/Text.html#node">node</a></span>
+         Node name or GUI Text Node itself
         </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_color"></a>
-    <strong>set_color(self, color)</strong>
-    </dt>
-    <dd>
-    Set color
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">Text</span></span>
-
+        <li><span class="parameter">value</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         Initial text. Default value is node text from GUI scene.
+         (<em>optional</em>)
         </li>
-        <li><span class="parameter">color</span>
-            <span class="types"><span class="type">vector4</span></span>
-         Color for node
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_alpha"></a>
-    <strong>set_alpha(self, alpha)</strong>
-    </dt>
-    <dd>
-    Set alpha
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">Text</span></span>
-
-        </li>
-        <li><span class="parameter">alpha</span>
-            <span class="types"><span class="type">number</span></span>
-         Alpha for node
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_scale"></a>
-    <strong>set_scale(self, scale)</strong>
-    </dt>
-    <dd>
-    Set scale
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">Text</span></span>
-
-        </li>
-        <li><span class="parameter">scale</span>
-            <span class="types"><span class="type">vector3</span></span>
-         Scale for node
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_pivot"></a>
-    <strong>set_pivot(self, pivot)</strong>
-    </dt>
-    <dd>
-    Set text pivot.  Text will re-anchor inside
- his text area
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">Text</span></span>
-
-        </li>
-        <li><span class="parameter">pivot</span>
-            <span class="types"><span class="type">gui.pivot</span></span>
-         Gui pivot constant
+        <li><span class="parameter">adjust_type</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         Adjust type for text. By default is DOWNSCALE. Look const.TEXT_ADJUST for reference
+         (<em>default</em> downscale)
         </li>
     </ul>
 
@@ -365,7 +322,7 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Text</span></span>
-
+         <a href="../modules/Text.html#">Text</a>
         </li>
     </ul>
 
@@ -379,22 +336,278 @@
 
 
 
+</dd>
+    <dt>
+    <a name = "set_alpha"></a>
+    <strong>set_alpha(self, alpha)</strong>
+    </dt>
+    <dd>
+    Set alpha
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Text</span></span>
+         <a href="../modules/Text.html#">Text</a>
+        </li>
+        <li><span class="parameter">alpha</span>
+            <span class="types"><span class="type">number</span></span>
+         Alpha for node
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">Text</span></span>
+        Current text instance
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "set_color"></a>
+    <strong>set_color(self, color)</strong>
+    </dt>
+    <dd>
+    Set color
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Text</span></span>
+         <a href="../modules/Text.html#">Text</a>
+        </li>
+        <li><span class="parameter">color</span>
+            <span class="types"><span class="type">vector4</span></span>
+         Color for node
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">Text</span></span>
+        Current text instance
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "set_minimal_scale"></a>
+    <strong>set_minimal_scale(self, minimal_scale)</strong>
+    </dt>
+    <dd>
+    Set minimal scale for DOWNSCALE_LIMITED or SCALE_THEN_SCROLL adjust types
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Text</span></span>
+         <a href="../modules/Text.html#">Text</a>
+        </li>
+        <li><span class="parameter">minimal_scale</span>
+            <span class="types"><span class="type">number</span></span>
+         If pass nil - not use minimal scale
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">Text</span></span>
+        Current text instance
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "set_pivot"></a>
+    <strong>set_pivot(self, pivot)</strong>
+    </dt>
+    <dd>
+    Set text pivot.  Text will re-anchor inside text area
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Text</span></span>
+         <a href="../modules/Text.html#">Text</a>
+        </li>
+        <li><span class="parameter">pivot</span>
+            <span class="types"><span class="type">gui.pivot</span></span>
+         Gui pivot constant
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">Text</span></span>
+        Current text instance
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "set_scale"></a>
+    <strong>set_scale(self, scale)</strong>
+    </dt>
+    <dd>
+    Set scale
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Text</span></span>
+         <a href="../modules/Text.html#">Text</a>
+        </li>
+        <li><span class="parameter">scale</span>
+            <span class="types"><span class="type">vector3</span></span>
+         Scale for node
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">Text</span></span>
+        Current text instance
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "set_text_adjust"></a>
+    <strong>set_text_adjust(self[, adjust_type[, minimal_scale]])</strong>
+    </dt>
+    <dd>
+    Set text adjust, refresh the current text visuals, if needed
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Text</span></span>
+         <a href="../modules/Text.html#">Text</a>
+        </li>
+        <li><span class="parameter">adjust_type</span>
+            <span class="types"><span class="type">number</span></span>
+         See const.TEXT_ADJUST. If pass nil - use current adjust type
+         (<em>optional</em>)
+        </li>
+        <li><span class="parameter">minimal_scale</span>
+            <span class="types"><span class="type">number</span></span>
+         If pass nil - not use minimal scale
+         (<em>optional</em>)
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">Text</span></span>
+        Current text instance
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "set_to"></a>
+    <strong>set_to(self, set_to)</strong>
+    </dt>
+    <dd>
+    Set text to text field
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">self</span>
+            <span class="types"><span class="type">Text</span></span>
+         <a href="../modules/Text.html#">Text</a>
+        </li>
+        <li><span class="parameter">set_to</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         Text for node
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">Text</span></span>
+        Current text instance
+    </ol>
+
+
+
+
+</dd>
+</dl>
+    <h2 class="section-header "><a name="Tables"></a>Tables</h2>
+
+    <dl class="function">
+    <dt>
+    <a name = "style"></a>
+    <strong>style</strong>
+    </dt>
+    <dd>
+    Component style params.
+ You can override this component styles params in druid styles table
+ or create your own style
+
+
+    <h3>Fields:</h3>
+    <ul>
+        <li><span class="parameter">TRIM_POSTFIX</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         The postfix for TRIM adjust type
+         (<em>default</em> ...)
+        </li>
+        <li><span class="parameter">DEFAULT_ADJUST</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         The default adjust type for any text component
+         (<em>default</em> DOWNSCALE)
+        </li>
+    </ul>
+
+
+
+
+
 </dd>
 </dl>
     <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 
     <dl class="function">
     <dt>
-    <a name = "on_set_text"></a>
-    <strong>on_set_text</strong>
+    <a name = "adjust_type"></a>
+    <strong>adjust_type</strong>
     </dt>
     <dd>
-    On set text callback(self, text)
+    Current text size adjust settings
 
 
     <ul>
-        <li><span class="parameter">on_set_text</span>
-            <span class="types"><span class="type">druid_event</span></span>
+        <li><span class="parameter">adjust_type</span>
+            <span class="types"><span class="type">number</span></span>
 
         </li>
     </ul>
@@ -405,36 +618,16 @@
 
 </dd>
     <dt>
-    <a name = "on_update_text_scale"></a>
-    <strong>on_update_text_scale</strong>
+    <a name = "color"></a>
+    <strong>color</strong>
     </dt>
     <dd>
-    On adjust text size callback(self, new_scale)
+    Current text color
 
 
     <ul>
-        <li><span class="parameter">on_update_text_scale</span>
-            <span class="types"><span class="type">druid_event</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "on_set_pivot"></a>
-    <strong>on_set_pivot</strong>
-    </dt>
-    <dd>
-    On change pivot callback(self, pivot)
-
-
-    <ul>
-        <li><span class="parameter">on_set_pivot</span>
-            <span class="types"><span class="type">druid_event</span></span>
+        <li><span class="parameter">color</span>
+            <span class="types"><span class="type">vector3</span></span>
 
         </li>
     </ul>
@@ -463,6 +656,86 @@
 
 
 
+</dd>
+    <dt>
+    <a name = "node_id"></a>
+    <strong>node_id</strong>
+    </dt>
+    <dd>
+    The node id of text node
+
+
+    <ul>
+        <li><span class="parameter">node_id</span>
+            <span class="types"><span class="type">hash</span></span>
+
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "on_set_pivot"></a>
+    <strong>on_set_pivot</strong>
+    </dt>
+    <dd>
+    On change pivot callback(self, pivot)
+
+
+    <ul>
+        <li><span class="parameter">on_set_pivot</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "on_set_text"></a>
+    <strong>on_set_text</strong>
+    </dt>
+    <dd>
+    On set text callback(self, text)
+
+
+    <ul>
+        <li><span class="parameter">on_set_text</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "on_update_text_scale"></a>
+    <strong>on_update_text_scale</strong>
+    </dt>
+    <dd>
+    On adjust text size callback(self, new_scale, text_metrics)
+
+
+    <ul>
+        <li><span class="parameter">on_update_text_scale</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
+        </li>
+    </ul>
+
+
+
+
+
 </dd>
     <dt>
     <a name = "pos"></a>
@@ -485,15 +758,15 @@
 
 </dd>
     <dt>
-    <a name = "start_scale"></a>
-    <strong>start_scale</strong>
+    <a name = "scale"></a>
+    <strong>scale</strong>
     </dt>
     <dd>
-    Initial text node scale
+    Current text node scale
 
 
     <ul>
-        <li><span class="parameter">start_scale</span>
+        <li><span class="parameter">scale</span>
             <span class="types"><span class="type">vector3</span></span>
 
         </li>
@@ -505,15 +778,15 @@
 
 </dd>
     <dt>
-    <a name = "scale"></a>
-    <strong>scale</strong>
+    <a name = "start_scale"></a>
+    <strong>start_scale</strong>
     </dt>
     <dd>
-    Current text node scale
+    Initial text node scale
 
 
     <ul>
-        <li><span class="parameter">scale</span>
+        <li><span class="parameter">start_scale</span>
             <span class="types"><span class="type">vector3</span></span>
 
         </li>
@@ -563,46 +836,6 @@
 
 
 
-</dd>
-    <dt>
-    <a name = "is_no_adjust"></a>
-    <strong>is_no_adjust</strong>
-    </dt>
-    <dd>
-    Current text size adjust settings
-
-
-    <ul>
-        <li><span class="parameter">is_no_adjust</span>
-            <span class="types"><span class="type">bool</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "color"></a>
-    <strong>color</strong>
-    </dt>
-    <dd>
-    Current text color
-
-
-    <ul>
-        <li><span class="parameter">color</span>
-            <span class="types"><span class="type">vector3</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
 </dd>
 </dl>
 
@@ -610,8 +843,8 @@
 </div> <!-- id="content" -->
 </div> <!-- id="main" -->
 <div id="about">
-<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-04-06 00:03:14 </i>
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc TESTING</a></i>
+<i style="float:right;">Last updated 2015-01-01 12:00:00 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

docs/modules/Timer.html

@@ -3,7 +3,7 @@
 <html>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
 <head>
-    <title>Defold Druid UI Library</title>
+    <title>Defold Druid UI Framework</title>
     <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
 </head>
 <body>
@@ -40,29 +40,34 @@
 <h2>Modules</h2>
 <ul class="nowrap">
   <li><a href="../modules/BackHandler.html">BackHandler</a></li>
+  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
   <li><a href="../modules/Blocker.html">Blocker</a></li>
   <li><a href="../modules/Button.html">Button</a></li>
-  <li><a href="../modules/Drag.html">Drag</a></li>
-  <li><a href="../modules/Hover.html">Hover</a></li>
-  <li><a href="../modules/Scroll.html">Scroll</a></li>
-  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
-  <li><a href="../modules/Swipe.html">Swipe</a></li>
-  <li><a href="../modules/Text.html">Text</a></li>
-  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
-  <li><a href="../modules/druid.html">druid</a></li>
-  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
   <li><a href="../modules/Checkbox.html">Checkbox</a></li>
   <li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
   <li><a href="../modules/DataList.html">DataList</a></li>
+  <li><a href="../modules/Drag.html">Drag</a></li>
+  <li><a href="../modules/Druid.html">Druid</a></li>
+  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
+  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
   <li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
+  <li><a href="../modules/Helper.html">Helper</a></li>
+  <li><a href="../modules/Hotkey.html">Hotkey</a></li>
+  <li><a href="../modules/Hover.html">Hover</a></li>
   <li><a href="../modules/Input.html">Input</a></li>
   <li><a href="../modules/LangText.html">LangText</a></li>
+  <li><a href="../modules/Layout.html">Layout</a></li>
+  <li><a href="../modules/PinKnob.html">PinKnob</a></li>
   <li><a href="../modules/Progress.html">Progress</a></li>
   <li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
+  <li><a href="../modules/RichInput.html">RichInput</a></li>
+  <li><a href="../modules/RichText.html">RichText</a></li>
+  <li><a href="../modules/Scroll.html">Scroll</a></li>
   <li><a href="../modules/Slider.html">Slider</a></li>
+  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
+  <li><a href="../modules/Swipe.html">Swipe</a></li>
+  <li><a href="../modules/Text.html">Text</a></li>
   <li><strong>Timer</strong></li>
-  <li><a href="../modules/druid.helper.html">druid.helper</a></li>
-  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
 </ul>
 
 </div>
@@ -83,39 +88,39 @@
 	<td class="summary">Component init function</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#set_to">set_to(self, set_to)</a></td>
-	<td class="summary">Set text to text field</td>
+	<td class="name" nowrap><a href="#set_interval">set_interval(self, from, to)</a></td>
+	<td class="summary">Set time interval</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#set_state">set_state(self, is_on)</a></td>
 	<td class="summary">Called when update</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#set_interval">set_interval(self, from, to)</a></td>
-	<td class="summary">Set time interval</td>
+	<td class="name" nowrap><a href="#set_to">set_to(self, set_to)</a></td>
+	<td class="summary">Set text to text field</td>
 	</tr>
 </table>
 <h2><a href="#Fields">Fields</a></h2>
 <table class="function_list">
 	<tr>
-	<td class="name" nowrap><a href="#on_tick">on_tick</a></td>
-	<td class="summary">On timer tick.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#on_set_enabled">on_set_enabled</a></td>
-	<td class="summary">On timer change enabled state callback(self, is_enabled)</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#on_timer_end">on_timer_end</a></td>
-	<td class="summary">On timer end callback</td>
+	<td class="name" nowrap><a href="#from">from</a></td>
+	<td class="summary">Initial timer value</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#node">node</a></td>
 	<td class="summary">Trigger node</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#from">from</a></td>
-	<td class="summary">Initial timer value</td>
+	<td class="name" nowrap><a href="#on_set_enabled">on_set_enabled</a></td>
+	<td class="summary">On timer change enabled state callback(self, is_enabled)</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#on_tick">on_tick</a></td>
+	<td class="summary">On timer tick.</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#on_timer_end">on_timer_end</a></td>
+	<td class="summary">On timer end callback</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#target">target</a></td>
@@ -146,7 +151,7 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Timer</span></span>
-
+         <a href="../modules/Timer.html#">Timer</a>
         </li>
         <li><span class="parameter">node</span>
             <span class="types"><a class="type" href="../modules/Timer.html#node">node</a></span>
@@ -174,22 +179,26 @@
 
 </dd>
     <dt>
-    <a name = "set_to"></a>
-    <strong>set_to(self, set_to)</strong>
+    <a name = "set_interval"></a>
+    <strong>set_interval(self, from, to)</strong>
     </dt>
     <dd>
-    Set text to text field
+    Set time interval
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Timer</span></span>
-
+         <a href="../modules/Timer.html#">Timer</a>
         </li>
-        <li><span class="parameter">set_to</span>
+        <li><span class="parameter">from</span>
             <span class="types"><span class="type">number</span></span>
-         Value in seconds
+         Start time in seconds
+        </li>
+        <li><span class="parameter">to</span>
+            <span class="types"><span class="type">number</span></span>
+         Target time in seconds
         </li>
     </ul>
 
@@ -210,7 +219,7 @@
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Timer</span></span>
-
+         <a href="../modules/Timer.html#">Timer</a>
         </li>
         <li><span class="parameter">is_on</span>
             <span class="types"><span class="type">bool</span></span>
@@ -224,26 +233,22 @@
 
 </dd>
     <dt>
-    <a name = "set_interval"></a>
-    <strong>set_interval(self, from, to)</strong>
+    <a name = "set_to"></a>
+    <strong>set_to(self, set_to)</strong>
     </dt>
     <dd>
-    Set time interval
+    Set text to text field
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">self</span>
             <span class="types"><span class="type">Timer</span></span>
-
+         <a href="../modules/Timer.html#">Timer</a>
         </li>
-        <li><span class="parameter">from</span>
+        <li><span class="parameter">set_to</span>
             <span class="types"><span class="type">number</span></span>
-         Start time in seconds
-        </li>
-        <li><span class="parameter">to</span>
-            <span class="types"><span class="type">number</span></span>
-         Target time in seconds
+         Value in seconds
         </li>
     </ul>
 
@@ -257,16 +262,16 @@
 
     <dl class="function">
     <dt>
-    <a name = "on_tick"></a>
-    <strong>on_tick</strong>
+    <a name = "from"></a>
+    <strong>from</strong>
     </dt>
     <dd>
-    On timer tick.  Fire every second callback(self, value)
+    Initial timer value
 
 
     <ul>
-        <li><span class="parameter">on_tick</span>
-            <span class="types"><span class="type">druid_event</span></span>
+        <li><span class="parameter">from</span>
+            <span class="types"><span class="type">number</span></span>
 
         </li>
     </ul>
@@ -275,46 +280,6 @@
 
 
 
-</dd>
-    <dt>
-    <a name = "on_set_enabled"></a>
-    <strong>on_set_enabled</strong>
-    </dt>
-    <dd>
-    On timer change enabled state callback(self, is_enabled)
-
-
-    <ul>
-        <li><span class="parameter">on_set_enabled</span>
-            <span class="types"><span class="type">druid_event</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "on_timer_end"></a>
-    <strong>on_timer_end</strong>
-    </dt>
-    <dd>
-    On timer end callback
-
-
-    <ul>
-        <li><span class="parameter">on_timer_end</span>
-            <span class="types"><span class="type">druid_event</span></span>
-        (self, Timer)
-        </li>
-    </ul>
-
-
-
-
-
 </dd>
     <dt>
     <a name = "node"></a>
@@ -337,17 +302,57 @@
 
 </dd>
     <dt>
-    <a name = "from"></a>
-    <strong>from</strong>
+    <a name = "on_set_enabled"></a>
+    <strong>on_set_enabled</strong>
     </dt>
     <dd>
-    Initial timer value
+    On timer change enabled state callback(self, is_enabled)
 
 
     <ul>
-        <li><span class="parameter">from</span>
-            <span class="types"><span class="type">number</span></span>
+        <li><span class="parameter">on_set_enabled</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
+        </li>
+    </ul>
 
+
+
+
+
+</dd>
+    <dt>
+    <a name = "on_tick"></a>
+    <strong>on_tick</strong>
+    </dt>
+    <dd>
+    On timer tick.  Fire every second callback(self, value)
+
+
+    <ul>
+        <li><span class="parameter">on_tick</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+         <a href="../modules/DruidEvent.html#">DruidEvent</a>
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "on_timer_end"></a>
+    <strong>on_timer_end</strong>
+    </dt>
+    <dd>
+    On timer end callback
+
+
+    <ul>
+        <li><span class="parameter">on_timer_end</span>
+            <span class="types"><span class="type">DruidEvent</span></span>
+        (self, Timer) <a href="../modules/DruidEvent.html#">DruidEvent</a>
         </li>
     </ul>
 
@@ -402,8 +407,8 @@
 </div> <!-- id="content" -->
 </div> <!-- id="main" -->
 <div id="about">
-<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-04-06 00:03:14 </i>
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc TESTING</a></i>
+<i style="float:right;">Last updated 2015-01-01 12:00:00 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

docs/modules/druid.helper.html

@@ -92,6 +92,10 @@
 	<td class="summary">Check if node is enabled in gui hierarchy.</td>
 	</tr>
 	<tr>
+	<td class="name" nowrap><a href="#get_closest_stencil_node">get_closest_stencil_node(node)</a></td>
+	<td class="summary">Return closest non inverted clipping parent node for node</td>
+	</tr>
+	<tr>
 	<td class="name" nowrap><a href="#get_pivot_offset">get_pivot_offset(pivot)</a></td>
 	<td class="summary">Get node offset for given gui pivot</td>
 	</tr>
@@ -242,6 +246,33 @@
 
 
 
+</dd>
+    <dt>
+    <a name = "get_closest_stencil_node"></a>
+    <strong>get_closest_stencil_node(node)</strong>
+    </dt>
+    <dd>
+    Return closest non inverted clipping parent node for node
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">node</span>
+            <span class="types"><span class="type">node</span></span>
+         Gui node
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">node</span> or <span class="type">nil</span></span>
+        The clipping node
+    </ol>
+
+
+
+
 </dd>
     <dt>
     <a name = "get_pivot_offset"></a>
@@ -339,7 +370,7 @@
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">message</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
          The deprecated message
         </li>
     </ul>
@@ -356,7 +387,7 @@
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-04-06 00:03:14 </i>
+<i style="float:right;">Last updated 2022-02-12 17:16:44 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

docs/modules/druid.html

@@ -3,7 +3,7 @@
 <html>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
 <head>
-    <title>Defold Druid UI Library</title>
+    <title>Defold Druid UI Framework</title>
     <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
 </head>
 <body>
@@ -39,86 +39,113 @@
 <h2>Modules</h2>
 <ul class="nowrap">
   <li><a href="../modules/BackHandler.html">BackHandler</a></li>
+  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
   <li><a href="../modules/Blocker.html">Blocker</a></li>
   <li><a href="../modules/Button.html">Button</a></li>
-  <li><a href="../modules/Drag.html">Drag</a></li>
-  <li><a href="../modules/Hover.html">Hover</a></li>
-  <li><a href="../modules/Scroll.html">Scroll</a></li>
-  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
-  <li><a href="../modules/Swipe.html">Swipe</a></li>
-  <li><a href="../modules/Text.html">Text</a></li>
-  <li><a href="../modules/BaseComponent.html">BaseComponent</a></li>
-  <li><strong>druid</strong></li>
-  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
   <li><a href="../modules/Checkbox.html">Checkbox</a></li>
   <li><a href="../modules/CheckboxGroup.html">CheckboxGroup</a></li>
   <li><a href="../modules/DataList.html">DataList</a></li>
+  <li><a href="../modules/Drag.html">Drag</a></li>
+  <li><strong>Druid</strong></li>
+  <li><a href="../modules/DruidEvent.html">DruidEvent</a></li>
+  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
   <li><a href="../modules/DynamicGrid.html">DynamicGrid</a></li>
+  <li><a href="../modules/Helper.html">Helper</a></li>
+  <li><a href="../modules/Hotkey.html">Hotkey</a></li>
+  <li><a href="../modules/Hover.html">Hover</a></li>
   <li><a href="../modules/Input.html">Input</a></li>
   <li><a href="../modules/LangText.html">LangText</a></li>
+  <li><a href="../modules/Layout.html">Layout</a></li>
+  <li><a href="../modules/PinKnob.html">PinKnob</a></li>
   <li><a href="../modules/Progress.html">Progress</a></li>
   <li><a href="../modules/RadioGroup.html">RadioGroup</a></li>
+  <li><a href="../modules/RichInput.html">RichInput</a></li>
+  <li><a href="../modules/RichText.html">RichText</a></li>
+  <li><a href="../modules/Scroll.html">Scroll</a></li>
   <li><a href="../modules/Slider.html">Slider</a></li>
+  <li><a href="../modules/StaticGrid.html">StaticGrid</a></li>
+  <li><a href="../modules/Swipe.html">Swipe</a></li>
+  <li><a href="../modules/Text.html">Text</a></li>
   <li><a href="../modules/Timer.html">Timer</a></li>
-  <li><a href="../modules/druid.helper.html">druid.helper</a></li>
-  <li><a href="../modules/DruidInstance.html">DruidInstance</a></li>
 </ul>
 
 </div>
 
 <div id="content">
 
-<h1>Module <code>druid</code></h1>
-<p>Druid UI Library.</p>
+<h1>Module <code>Druid</code></h1>
+<p>Druid UI Component Framework.</p>
 <p>
- Powerful Defold component based UI library. Use standart
- components or make your own game-specific components to
- make amazing GUI in your games.
-<p> Contains the several basic components and examples
- to how to do your custom complex components to
- separate UI game logic to small files
-<p>    require("druid.druid")
-    function init(self)
-        self.druid = druid.new(self)
-    end
+ <b># Overview #</b>
+<p> Druid - powerful Defold component UI library. Use basic and extended
+ Druid components or make your own game-specific components to make
+ amazing GUI in your games.
+<p> To start using Druid, please refer to the Usage section below.
+<p> <b># Notes #</b>
+<p> • Each Druid instance maintains the self context from the constructor and passes it to each Druid callback.
+<p> See next: <a href="../modules/DruidInstance.html#">DruidInstance</a>
 </p>
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example">local druid = require(&quot;druid.druid&quot;)
+
+local function on_play(self)
+    print(&quot;Gonna play!&quot;)
+end
+
+function init(self)
+    self.druid = druid.new(self)
+    self.druid:new_button(&quot;button_play&quot;, on_play)
+end
+
+function final(self)
+    self.druid:final()
+end
+
+function update(self, dt)
+    self.druid:update(dt)
+end
+
+function on_message(self, message_id, message, sender)
+    self.druid:on_message(message_id, message, sender)
+end
+
+function on_input(self, action_id, action)
+    return self.druid:on_input(action_id, action)
+end
+</pre>
+    </ul>
 
 
 <h2><a href="#Functions">Functions</a></h2>
 <table class="function_list">
 	<tr>
-	<td class="name" nowrap><a href="#register">register(name, module)</a></td>
-	<td class="summary">Register external druid component.</td>
+	<td class="name" nowrap><a href="#druid.new">druid.new(context[, style])</a></td>
+	<td class="summary">Create a new Druid instance for creating GUI components.</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#new">new(context[, style])</a></td>
-	<td class="summary">Create Druid instance.</td>
+	<td class="name" nowrap><a href="#druid.on_language_change">druid.on_language_change()</a></td>
+	<td class="summary">Call this function when the game language changes.</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#set_default_style">set_default_style(style)</a></td>
-	<td class="summary">Set new default style.</td>
+	<td class="name" nowrap><a href="#druid.on_window_callback">druid.on_window_callback(event)</a></td>
+	<td class="summary">Set the window callback to enable on_focus_gain and on_focus_lost functions.</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#set_text_function">set_text_function(callback)</a></td>
-	<td class="summary">Set text function
- Druid locale component will call this function
- to get translated text.</td>
+	<td class="name" nowrap><a href="#druid.register">druid.register(name, module)</a></td>
+	<td class="summary">Register a new external Druid component.</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#set_sound_function">set_sound_function(callback)</a></td>
-	<td class="summary">Set sound function.</td>
+	<td class="name" nowrap><a href="#druid.set_default_style">druid.set_default_style(style)</a></td>
+	<td class="summary">Set your own default style for all Druid instances.</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#on_window_callback">on_window_callback(event)</a></td>
-	<td class="summary">Callback on global window event.</td>
+	<td class="name" nowrap><a href="#druid.set_sound_function">druid.set_sound_function(callback)</a></td>
+	<td class="summary">Set the Druid sound function to play UI sounds if used.</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#on_layout_change">on_layout_change()</a></td>
-	<td class="summary">Callback on global layout change event.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#on_language_change">on_language_change()</a></td>
-	<td class="summary">Callback on global language change event.</td>
+	<td class="name" nowrap><a href="#druid.set_text_function">druid.set_text_function(callback)</a></td>
+	<td class="summary">Set the text function for the LangText component.</td>
 	</tr>
 </table>
 
@@ -130,49 +157,22 @@
 
     <dl class="function">
     <dt>
-    <a name = "register"></a>
-    <strong>register(name, module)</strong>
+    <a name = "druid.new"></a>
+    <strong>druid.new(context[, style])</strong>
     </dt>
     <dd>
-    Register external druid component.
- After register you can create the component with
- druid_instance:new_{name}. For example `druid:new_button(...)`
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">name</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
-         module name
-        </li>
-        <li><span class="parameter">module</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
-         lua table with component
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "new"></a>
-    <strong>new(context[, style])</strong>
-    </dt>
-    <dd>
-    Create Druid instance.
+    Create a new Druid instance for creating GUI components.
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">context</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
-         Druid context. Usually it is self of script
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+         The Druid context. Usually, this is the self of the gui_script. It is passed into all Druid callbacks.
         </li>
         <li><span class="parameter">style</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
-         Druid style module
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+         The Druid style table to override style parameters for this Druid instance.
          (<em>optional</em>)
         </li>
     </ul>
@@ -181,25 +181,118 @@
     <ol>
 
            <span class="types"><span class="type">druid_instance</span></span>
-        Druid instance
+        The Druid instance <a href="../modules/DruidInstance.html#">DruidInstance</a>.
     </ol>
 
 
 
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example"><span class="keyword">local</span> druid = <span class="global">require</span>(<span class="string">"druid.druid"</span>)
+
+<span class="keyword">function</span> init(self)
+   self.druid = druid.new(self)
+<span class="keyword">end</span></pre>
+    </ul>
 
 </dd>
     <dt>
-    <a name = "set_default_style"></a>
-    <strong>set_default_style(style)</strong>
+    <a name = "druid.on_language_change"></a>
+    <strong>druid.on_language_change()</strong>
     </dt>
     <dd>
-    Set new default style.
+    Call this function when the game language changes.
+<p> This function will translate all current LangText components.
+
+
+
+
+
+
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example">druid.on_language_change()</pre>
+    </ul>
+
+</dd>
+    <dt>
+    <a name = "druid.on_window_callback"></a>
+    <strong>druid.on_window_callback(event)</strong>
+    </dt>
+    <dd>
+    Set the window callback to enable on_focus_gain and on_focus_lost functions.
+<p> This is used to trigger the on_focus_lost and on_focus_gain functions in Druid components.
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">event</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         Event param from window listener
+        </li>
+    </ul>
+
+
+
+
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example">window.set_listener(<span class="keyword">function</span>(_, event)
+   druid.on_window_callback(event)
+<span class="keyword">end</span>)</pre>
+    </ul>
+
+</dd>
+    <dt>
+    <a name = "druid.register"></a>
+    <strong>druid.register(name, module)</strong>
+    </dt>
+    <dd>
+    Register a new external Druid component.
+<p> You can register your own components to make new alias: the druid:new_{name} function.
+ For example, if you want to register a component called "my_component", you can create it using druid:new_my_component(...).
+ This can be useful if you have your own "basic" components that you don't want to re-create each time.
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">name</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         module name
+        </li>
+        <li><span class="parameter">module</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+         lua table with component
+        </li>
+    </ul>
+
+
+
+
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example"><span class="keyword">local</span> my_component = <span class="global">require</span>(<span class="string">"path.to.my.component"</span>)
+druid.register(<span class="string">"my_component"</span>, my_component)
+...
+<span class="keyword">local</span> druid = druid.new(self)
+<span class="keyword">local</span> component_instance = self.druid:new_my_component(...)</pre>
+    </ul>
+
+</dd>
+    <dt>
+    <a name = "druid.set_default_style"></a>
+    <strong>druid.set_default_style(style)</strong>
+    </dt>
+    <dd>
+    Set your own default style for all Druid instances.
+<p> To create your own style file, copy the default style file and make changes to it.
+ Register the new style before creating your Druid instances.
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">style</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
          Druid style module
         </li>
     </ul>
@@ -207,40 +300,21 @@
 
 
 
-
-</dd>
-    <dt>
-    <a name = "set_text_function"></a>
-    <strong>set_text_function(callback)</strong>
-    </dt>
-    <dd>
-    Set text function
- Druid locale component will call this function
- to get translated text.  After set_text_funtion
- all existing locale component will be updated
-
-
-    <h3>Parameters:</h3>
+    <h3>Usage:</h3>
     <ul>
-        <li><span class="parameter">callback</span>
-            <span class="types"><span class="type">function</span></span>
-         Get localized text function
-        </li>
+        <pre class="example"><span class="keyword">local</span> my_style = <span class="global">require</span>(<span class="string">"path.to.my.style"</span>)
+druid.set_default_style(my_style)</pre>
     </ul>
 
-
-
-
-
 </dd>
     <dt>
-    <a name = "set_sound_function"></a>
-    <strong>set_sound_function(callback)</strong>
+    <a name = "druid.set_sound_function"></a>
+    <strong>druid.set_sound_function(callback)</strong>
     </dt>
     <dd>
-    Set sound function.
- Component will call this function to
- play sound by sound_id
+    Set the Druid sound function to play UI sounds if used.
+<p> Set a function to play a sound given a sound_id. This function is used for button clicks to play the "click" sound.
+ It can also be used to play sounds in your custom components (see the default Druid style file for an example).
 
 
     <h3>Parameters:</h3>
@@ -254,57 +328,41 @@
 
 
 
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example">druid.set_sound_function(<span class="keyword">function</span>(sound_id)
+    sound.play(sound_id) <span class="comment">-- Replace with your real function
+</span><span class="keyword">end</span>)</pre>
+    </ul>
 
 </dd>
     <dt>
-    <a name = "on_window_callback"></a>
-    <strong>on_window_callback(event)</strong>
+    <a name = "druid.set_text_function"></a>
+    <strong>druid.set_text_function(callback)</strong>
     </dt>
     <dd>
-    Callback on global window event.
- Used to trigger on_focus_lost and on_focus_gain
+    Set the text function for the LangText component.
+<p> The Druid locale component will call this function to get translated text.
+ After setting the text function, all existing locale components will be updated.
 
 
     <h3>Parameters:</h3>
     <ul>
-        <li><span class="parameter">event</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
-         Event param from window listener
+        <li><span class="parameter">callback</span>
+            <span class="types"><span class="type">function</span></span>
+         Get localized text function
         </li>
     </ul>
 
 
 
 
-
-</dd>
-    <dt>
-    <a name = "on_layout_change"></a>
-    <strong>on_layout_change()</strong>
-    </dt>
-    <dd>
-    Callback on global layout change event.
-
-
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "on_language_change"></a>
-    <strong>on_language_change()</strong>
-    </dt>
-    <dd>
-    Callback on global language change event.
- Use to update all lang texts
-
-
-
-
-
-
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example">druid.set_text_function(<span class="keyword">function</span>(text_id)
+   <span class="keyword">return</span> lang_data[text_id] <span class="comment">-- Replace with your real function
+</span><span class="keyword">end</span>)</pre>
+    </ul>
 
 </dd>
 </dl>
@@ -313,8 +371,8 @@
 </div> <!-- id="content" -->
 </div> <!-- id="main" -->
 <div id="about">
-<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-04-06 00:03:14 </i>
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc TESTING</a></i>
+<i style="float:right;">Last updated 2015-01-01 12:00:00 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

docs_md/01-components.md

@@ -1,10 +1,8 @@
-
-
 # Druid components
 
 
 ## Button
-[Button API here](https://insality.github.io/druid/modules/druid.button.html)
+[Button API here](https://insality.github.io/druid/modules/Button.html)
 
 ### Overview
 Basic Druid input component. Handle input on node and provide different callbacks on touch events.
@@ -36,13 +34,13 @@ _fill example usecases_
 
 
 ## Text
-[Text API here](https://insality.github.io/druid/modules/druid.text.html)
+[Text API here](https://insality.github.io/druid/modules/Text.html)
 
 ### Overview
 Basic Druid text component. Text components by default have the text size adjusting.
 
 ### Setup
-Create text node with druid: `text = druid:new_text(node_name, [initial_value], [is_disable_size_adjust])`
+Create text node with druid: `text = druid:new_text(node_name, [initial_value], [text_adjust_type])`
 
 ### Notes
 - Text component by default have auto adjust text sizing. Text never will be bigger, than text node size, which you can setup in GUI scene. It can be disabled on component creating by settings argument `is_no_adjust` to _true_
@@ -53,9 +51,17 @@ Create text node with druid: `text = druid:new_text(node_name, [initial_value],
 
 ![](../media/text_anchor.gif)
 
+- There is several text adjust types. Default Downscale. You can change the default adjust type in the text style table.
+	- **const.TEXT_ADJUST.DOWNSCALE** - Change text's scale to fit in the text node size
+	- **const.TEXT_ADJUST.TRIM** - Trim the text with postfix (default - "...", override in styles) to fit in the text node size
+	- **const.TEXT_ADJUST.NO_ADJUST** - No any adjust, like default Defold text node
+	- **const.TEXT_ADJUST.DOWNSCALE_LIMITED** - Change text's scale list downscale, but there is limit for text's scale
+	- **const.TEXT_ADJUST.SCROLL** - Change text's pivot to imitate scrolling in the text box. Use with stencil node for better effect.
+	- **const.TEXT_ADJUST.SCALE_THEN_SCROLL** - Combine two modes: first limited downscale, then scroll
+
 
 ## Blocker
-[Blocker API here](https://insality.github.io/druid/modules/druid.blocker.html)
+[Blocker API here](https://insality.github.io/druid/modules/Blocker.html)
 
 ### Overview
 Druid component for block input. Use it to block input in special zone.
@@ -75,7 +81,7 @@ So you can do the safe zones, when you have the big buttons
 
 
 ## Back Handler
-[Back handler API here](https://insality.github.io/druid/modules/druid.back_handler.html)
+[Back handler API here](https://insality.github.io/druid/modules/BackHandler.html)
 
 ### Overview
 Component to handle back button. It handle Android back button and Backspace key. Key triggers in `input.binding` should be setup for correct working.
@@ -87,7 +93,7 @@ Setup callback with `druid:new_back_handler(callback)`
 
 
 ## Lang text
-[Lang text API here](https://insality.github.io/druid/modules/druid.lang_text.html)
+[Lang text API here](https://insality.github.io/druid/modules/LangText.html)
 
 ### Overview
 Wrap on Text component to handle localization. It uses druid get_text_function to set text by it's id
@@ -99,7 +105,7 @@ Create lang text component with druid `text = druid:new_lang_text(node_name, loc
 
 
 ## Scroll
-[Scroll API here](https://insality.github.io/druid/modules/druid.scroll.html)
+[Scroll API here](https://insality.github.io/druid/modules/Scroll.html)
 
 ### Overview
 Basic Druid scroll component. Handle all scrolling stuff in druid GUI
@@ -120,20 +126,20 @@ Usually, Place _view_node_ and as children add _content_node_:
 *Here content_node below view_node, in game content_node be able to scroll left until end*
 
 ### Notes
-- Scroll by default style have inertion and extra size for strecthing effect. It can be adjust via scroll [style settings](https://insality.github.io/druid/modules/druid.scroll.html#Style)
+- Scroll by default style have inertion and extra size for strecthing effect. It can be adjust via scroll [style settings](https://insality.github.io/druid/modules/Scroll.html#Style)
 - You can setup "points of interest". Scroll always will be centered on closes point of interest. It is able to create slider without inertion and points of interest on each scroll element.
 - Scroll have next events:
 	- *on_scroll* (self, position) On scroll move callback
 	- *on_scroll_to* (self, position, is_instant) On scroll_to function callback
 	- *on_point_scroll* (self, item_index, position) On scroll_to_index function callback
 - You can adjust scroll content size by `scroll:set_size(node_size)`. It will setup new size to _content node_
-- You can enabled or disable inertion mode via `scroll:set_intert(state)`
+- You can enabled or disable inertion mode via `scroll:set_inert(state)`
 - You can adjust extra stretch size via `scroll:set_extra_stretch_size`
 - Multitouch is required for scroll. Scroll is correctly handling touch_id swap while dragging scroll
 
 
 ## Progress
-[Progress API here](https://insality.github.io/druid/modules/druid.progress.html)
+[Progress API here](https://insality.github.io/druid/modules/Progress.html)
 
 ### Overview
 Basic Druid progress bar component
@@ -141,7 +147,7 @@ Basic Druid progress bar component
 ### Setup
 Create progress bar component with druid: `progress = druid:new_progress(node_name, key, init_value)`
 
-Node name should have maximum node size, so in GUI scene, node_name should be fully filled. 
+Node name should have maximum node size, so in GUI scene, node_name should be fully filled.
 Key is value from druid const: const.SIDE.X (or just "x") or const.SIDE.Y (or just "y")
 
 ### Notes
@@ -151,7 +157,7 @@ Key is value from druid const: const.SIDE.X (or just "x") or const.SIDE.Y (or ju
 
 
 ## Slider
-[Slider API here](https://insality.github.io/druid/modules/druid.slider.html)
+[Slider API here](https://insality.github.io/druid/modules/Slider.html)
 
 ### Overview
 Basic Druid slider component
@@ -159,7 +165,7 @@ Basic Druid slider component
 ### Setup
 Create slider component  with druid: `slider = druid:new_slider(node_name, end_pos, callback)`
 
-Pin node (node_name in params) should be placed in zero position (initial). It will be available to mode Pin node between start pos and end pos. 
+Pin node (node_name in params) should be placed in zero position (initial). It will be available to mode Pin node between start pos and end pos.
 
 ### Notes
 - You can setup points of interests on slider via `slider:set_steps`. If steps are exist, slider values will be only from this steps (notched slider)
@@ -167,7 +173,7 @@ Pin node (node_name in params) should be placed in zero position (initial). It w
 
 
 ## Input
-[Input API here](https://insality.github.io/druid/modules/druid.input.html)
+[Input API here](https://insality.github.io/druid/modules/Input.html)
 
 ### Overview
 Basic Druid text input component
@@ -187,7 +193,7 @@ Create input component with druid: `input = druid:new_input(button_node_name, te
 
 
 ## Checkbox
-[Checkbox API here](https://insality.github.io/druid/modules/druid.checkbox.html)
+[Checkbox API here](https://insality.github.io/druid/modules/Checkbox.html)
 
 ### Overview
 Basic Druid checkbox component.
@@ -201,7 +207,7 @@ Create checkbox component with druid: `checkbox = druid:new_checkbox(node, callb
 
 
 ## Checkbox group
-[Checkbox group API here](https://insality.github.io/druid/modules/druid.checkbox_group.html)
+[Checkbox group API here](https://insality.github.io/druid/modules/CheckboxGroup.html)
 
 ### Overview
 Several checkboxes in one group
@@ -215,7 +221,7 @@ Create checkbox_group component with druid: `group = druid:new_checkbox_group(no
 
 
 ## Radio group
-[Radio group API here](https://insality.github.io/druid/modules/druid.radio_group.html)
+[Radio group API here](https://insality.github.io/druid/modules/RadioGroup.html)
 
 ### Overview
 Several checkboxes in one group with single choice
@@ -230,7 +236,7 @@ Create radio_group component with druid: `group = druid:new_radio_group(nodes[],
 
 
 ## Timer
-[Timer API here](https://insality.github.io/druid/modules/druid.timer.html)
+[Timer API here](https://insality.github.io/druid/modules/Timer.html)
 
 ### Overview
 Handle timer work on gui text node
@@ -245,7 +251,7 @@ Create timer component with druid: `timer = druid:new_timer(text_node, from_seco
 
 
 ## Static Grid
-[Static Grid API here](https://insality.github.io/druid/modules/druid.static_grid.html)
+[Static Grid API here](https://insality.github.io/druid/modules/StaticGrid.html)
 
 ### Overview
 Component for manage node positions.
@@ -266,17 +272,17 @@ Create  component with druid: `grid = druid:new_static_grid(parent_node, prefab_
 
 
 ## Dynamic Grid
-[Dynamic Grid API here](https://insality.github.io/druid/modules/druid.dynamic_grid.html)
+[Dynamic Grid API here](https://insality.github.io/druid/modules/DynamicGrid.html)
 
 ### Overview
 Component for manage node positions with different node sizes.
 Unlike Static Grid, Dynamic Grid can place nodes only in one row or in one column.
-Dynamic Grid can't have gaps between elements 
+Dynamic Grid can't have gaps between elements
 - you will get error, if try spawn element far away from others.
 Dynamic Grid should have __West__, __East__, __South__ or __North__ pivot (vertical or horizontal element placement)
 
 ### Setup
-Create  component with druid: `grid = druid:new_dynamic_grid(parent_node)`
+Create component with druid: `grid = druid:new_dynamic_grid(parent_node)`
 
 Check the _parent_node_ have correct pivot point. You will get the error otherwise.
 
@@ -290,8 +296,34 @@ Check the _parent_node_ have correct pivot point. You will get the error otherwi
 - First node placed at Grid pivot point. Other nodes placed nearby of other nodes.
 - On *add/remove* nodes always shifted. You can point the shift side in this functions (*is_shift_left* boolean argumentp
 
+
+## Data List
+[Data List API here](https://insality.github.io/druid/modules/DataList.html)
+
+### Overview
+Component to manage data for huge dataset in scroll. DataList create elements only in scroll view.
+It requires Druid Scroll and Druid Grid (Static or Dynamic) components
+
+
+### Setup
+Create component with druid: `grid = druid:new_data_list(scroll, grid, create_callback)`
+- scroll - already created Scroll component
+- grid - already created StaticGrid or DynamicGrid component
+- create_function - your function to create node instances. This callback have next parameters: fun(self, data, index, data_list)
+	- self - Script/Druid context
+	- data- your element data
+	- index - element index
+	- data_list - current DataList component
+
+Create function should return root node and optionaly, Druid component. It’s required to manage create/remove lifecycle.
+
+### Notes
+- Set data with `data_list:set_data({...})` after component initialize
+- You can use `data_list:scroll_to_index()` function to show data element
+
+
 ## Hover
-[Hover API here](https://insality.github.io/druid/modules/druid.hover.html)
+[Hover API here](https://insality.github.io/druid/modules/Hover.html)
 
 ### Overview
 System Druid component, handle hover node state.
@@ -306,7 +338,7 @@ Create hover component with druid: `hover = druid:new_hover(node, callback)`
 
 
 ## Swipe
-[Swipe API here](https://insality.github.io/druid/modules/druid.swipe.html)
+[Swipe API here](https://insality.github.io/druid/modules/Swipe.html)
 
 ### Overview
 System Druid component, handle swipe actions on node
@@ -327,7 +359,7 @@ Create swipe component with druid: `hover = druid:new_swipe(node, swipe_callback
 
 
 ## Drag
-[Drag API here](https://insality.github.io/druid/modules/druid.drag.html)
+[Drag API here](https://insality.github.io/druid/modules/Drag.html)
 
 ### Overview
 System Druid component, handle drag actions on node
@@ -336,10 +368,12 @@ System Druid component, handle drag actions on node
 Create drag component with druid: `hover = druid:new_drag(node, drag_callback)`
 
 ### Notes
-- Drag callback have next params: (self, swipe_side, distance, time)
+- Drag callback have next params: (self, dx, dy, total_x, total_y)
 	- **self**: Druid self context
 	- **dx**: *number* - delta x position
 	- **dy**: *number* - delta y position
+	- **total_x**: *number* - total delta x position
+	- **total_y**: *number* - total delta y position
 - In styles, you can point the drag start deadzone. Default value is 10 pixels
 - Drag correctly process multitouch. You can switch touch_id, while dragging on node with correct _dx_ and _dy_ values (made for correct scrolling)
 - You can restrict horizontal or vertical dragging by setting `drag.can_x` or `drag.can_y` to _false_ value
@@ -355,3 +389,56 @@ Create drag component with druid: `hover = druid:new_drag(node, drag_callback)`
 	- _on_drag_ (self, dx, dy) - Event on drag process
 	- _on_drag_end_ (self) - Event on drag end
 - Drag node zone can be restricted via `drag:set_click_zone(node)`
+
+
+## Hotkey
+[Hotkey API here](https://insality.github.io/druid/modules/Hotkey.html)
+
+### Overview
+Druid component to handle keyboard hotkeys with key modificators
+
+### Setup
+This is extended component. Before use it, you should register it:
+```
+local druid =  require("druid.druid")
+local hotkey =  require("druid.extended.hotkey")
+druid.register("hotkey", hotkey)
+```
+Create hotkey component with druid: `hotkey = druid:new_hotkey(keys_array, callback, [callback_argument])`
+
+### Notes
+- Hotkey callback is similar with button callback: (self, callback_argument)
+	- **self**: Druid self context
+	- **callback_argument**: *value* - Any value passed at component constructor
+- In styles, you can point the array of modificator keys. This keys should be pressed with main key to trigger the callback
+- The keys_arrays should contains one action key and any amount of modificator keys
+- You can add additional hotkeys to hotkey component with `hotkey:add_hotkey(keys_array, callback_argument)`
+
+
+## Layout
+[Layout API here](https://insality.github.io/druid/modules/Layout.html)
+
+### Overview
+Component to handle node size depends on layout mode. Unlike from Defold Adjust modes, you able to select node stretch by one size or zoom by minimum or maximum side
+
+### Setup
+This is extended component. Before use it, you should register it:
+```
+local druid =  require("druid.druid")
+local layout =  require("druid.extended.layout")
+druid.register("layout", layout)
+```
+Create layout component with druid: `layout = druid:new_layout(node, layout_mode, on_size_change_callback)`
+
+
+### Notes
+- Layout mode can be next:
+	- `const.LAYOUT_MODE.STRETCH_X` - Stretch node only by X
+	- `const.LAYOUT_MODE.STRETCH_Y` - Stretch node only by Y
+	- `const.LAYOUT_MODE.ZOOM_MIN` - Zoom node by minimal stretch multiplier
+	- `const.LAYOUT_MODE.ZOOM_MAX` - Zoom node by maximum stretch multiplier
+	- `const.LAYOUT_MODE.FIT` - Usual Defold Fit mode
+	- `const.LAYOUT_MODE.STRETCH` - Usual Defold Stretch Mode
+- The Layout component will change the node size property. So it's able to increase size of 9patch nodes without scaling issue
+- The Layout works even inside parent node with Fit adjust mode
+

docs_md/02-creating_custom_components.md

@@ -1,118 +1,157 @@
-# Creating custom components
+# Creating Custom Components
 
 ## Overview
 
-Druid allows you to create your custom components from druid basic components or other custom components.
+Druid offers the flexibility to create custom components that contain your own logic, as well as other Druid basic components or custom components. While Druid provides a set of predefined components like buttons and scrolls, it goes beyond that and provides a way to handle all your GUI elements in a more abstract manner. Custom components are a powerful way to separate logic and create higher levels of abstraction in your code.
 
-Every component is the children of Basic Druid component. Read the [basic component API here].(https://insality.github.io/druid/modules/component.html), Methods of basic components you can call via self:{method_name}
+Every component is a child of the Basic Druid component. You can call methods of basic components using `self:{method_name}`.
 
+## Custom Components
 
-## Custom components
+### Basic Component Template
+A basic custom component template looks like this (you can copy it from `/druid/templates/component.template.lua`):
 
-Basic custom component template looks like this:
 ```lua
 local component = require("druid.component")
 
-local M = component.create("my_component")
+---@class component_name : druid.base_component
+local Component = component.create("component_name")
 
--- Component constructor
-function M.init(self, ...)
+local SCHEME = {
+    ROOT = "root",
+    BUTTON = "button",
+}
+
+function Component:init(template, nodes)
+    self:set_template(template)
+    self:set_nodes(nodes)
+    self.root = self:get_node(SCHEME.ROOT)
+    self.druid = self:get_druid()
+
+    self.button = self.druid:new_button(SCHEME.BUTTON, function() end)
 end
 
--- Call only if exist interest: component.ON_UPDATE
-function M.update(self, dt)
-end
+function Component:on_remove() end
 
--- Call only if exist interest: component.ON_INPUT or component.ON_INPUT_HIGH
-function M.on_input(self, action_id, action)
-end
-
--- Call on component creation and on component:set_style() function
-function M.on_style_change(self, style)
-end
-
--- Call only if exist interest: component.ON_MESSAGE
-function M.on_message(self, message_id, message, sender)
-end
-
--- Call only if component with ON_ANGUAGECHANinterest
-function M.on_anguagechanself)
-end
-
--- Call only if component with ON_LAYOUT_CHANGE interest
-function M.on_layout_change(self)
-end
-
--- Call, if input was capturing before this component
--- Example: scroll is start scrolling, so you need unhover button
-function M.on_input_interrupt(self)
-end
-
--- Call, if game lost focus. Need ON_FOCUS_LOST intereset
-function M.on_focus_lost(self)
-end
-
--- Call, if game gained focus. Need ON_FOCUS_GAINED intereset
-function M.on_focus_gained(self)
-end
-
--- Call on component remove or on druid:final
-function M.on_remove(self)
-end
-
-return M
+return Component
 ```
 
+### Full Component Template
+
+A full custom component template looks like this (you can copy it from `/druid/templates/component_full.template.lua`):
+
+```lua
+local component =  require("druid.component")
+
+---@class component_name : druid.base_component
+local Component = component.create("component_name")
+local SCHEME = {
+    ROOT = "root",
+    BUTTON = "button",
+}
+
+function Component:init(template, nodes)
+    self:set_template(template)
+    self:set_nodes(nodes)
+    self.root = self:get_node(SCHEME.ROOT)
+    self.druid = self:get_druid()
+end
+
+function Component:update(dt) end
+
+function Component:on_input(action_id, action) return false end
+
+function Component:on_style_change(style) end
+
+function Component:on_message(message_id, message, sender) end
+
+function Component:on_language_change() end
+
+function Component:on_layout_change() end
+
+function Component:on_window_resized() end
+
+function Component:on_input_interrupt() end
+
+function Component:on_focus_lost() end
+
+function Component:on_focus_gained() end
+
+function Component:on_remove() end
+
+return Component
+```
+
+### Spawning a Custom Component
+
+After creating your custom component, you can spawn it in your code. For example, if you have a component named `my_component`, you can create it like this:
 
-Add your custom component to druid via `druid.register`
 ```lua
 local druid = require("druid.druid")
 local my_component = require("my.amazing.component")
 
 function init(self)
-	druid.register("my_component", my_component)
+    self.druid = druid.new(self)
+    self.druid:new(my_component, "template_name", nodes)
 end
 ```
 
-Registering make new function with "new_{component_name}". In our example it will be: `druid:new_my_component()`.
+In the code above, `template_name` refers to the name of the GUI template file if you're using it in your custom component. `nodes` is a table obtained from `gui.clone_tree(node)`. If you're spawning multiple nodes for the component, pass the table to the component constructor. Inside the component, you need to set the template and nodes using `self:set_template(template)` and `self:set_nodes(nodes)`.
 
-Or you can create component without registering with `druid:create(my_component_module)`
+### Registering a Custom Component
+
+You can register your custom component to use it without requiring the component module in every file. Registering components is convenient for very basic components in your game. Here's how you can register a custom component in Druid:
 
-As component registered, you can create your component with next code:
 ```lua
 local druid = require("druid.druid")
 local my_component = require("my.amazing.component")
 
 function init(self)
-	self.druid = druid.new(self)
-
-	local my_component = self.druid:new_my_component(...)
-	-- or --
-	local my_component = self.druid:create(my_component, ...)
+    druid.register("my_component", my_component)
 end
 ```
 
-### Interest
-Interest - is a way to indicate what events your component will respond to.
-There is next interests in druid:
-- **ON_MESSAGE** - component will receive messages from on_message
+Once the component is registered, a new function will be available with the name "new_{component_name}". In our example, it will be `druid:new_my_component()`. With the component registered, you can create an instance of it using the following code:
 
-- **ON_UPDATE** - component will be updated from update
+```lua
+local druid = require("druid.druid")
+local my_component = require("my.amazing.component")
 
-- **ON_INPUT_HIGH** - component will receive input from on_input, before other components with ON_INPUT
+function init(self)
+    self.druid = druid.new(self)
+    self.my_component = self.druid:new_my_component(template, nodes)
+end
+```
 
-- **ON_INPUT** - component will receive input from on_input, after other components with ON_INPUT_HIGH
+## Create Druid Component Editor Script
 
-- **ON_LANGUAGE_CHANGE** - will call _on_language_change_ function on language change trigger
+Druid provides an editor script to assist you in creating Lua files for your GUI scenes. You can find the commands under the menu `Edit -> Create Druid Component` when working with *.gui scenes.
 
-- **ON_LAYOUT_CHANGE** will call _on_layout_change_ function on layout change trigger
+The script analyzes the current GUI scene and generates a Lua file with stubs for all Druid components found. The output file is named after the current GUI scene and placed in the same directory. Note that the script does not override any existing *.lua files. If you want to regenerate a file, delete the previous version first.
 
-- **ON_FOCUS_LOST** will call _on_focust_lost_ function in on focus lost event. You need to pass window_callback to global `druid:on_window_callback`
+The script requires `python3` with `deftree` installed. If `deftree` is not installed, the instructions will be displayed in the console.
 
-- **ON_FOCUS_GAINED** will call _on_focust_gained_ function in on focus gained event. You need to pass window_callback to global `druid:on_window_callback`
+### Auto-Layout Components
 
-## Best practice on custom components
-On each component recommended describe component scheme in next way:
+The generator script also checks the current GUI scene for Druid components and creates stubs for them. If a node name starts with a specific keyword, the script generates component stubs in the Lua file. For example, nodes named `button` and `button_exit` will result in the generation of two Druid Button components with callback stubs.
+
+Available keywords:
+- `button`: Adds a [Druid Button](01-components.md#button) component and generates the callback stub.
+- `text`: Adds a [Druid Text](01-components.md#text) component.
+- `lang_text`: Adds a [Druid Lang Text](01-components.md#lang-text) component.
+- `grid` or `static_grid`: Adds a [Druid Static Grid](01-components.md#static-grid) component. You should set up the Grid prefab for this component after generating the file.
+- `dynamic_grid`: Adds a [Druid Dynamic Grid](01-components.md#dynamic-grid) component.
+- `scroll_view`: Adds a [Druid Scroll](01-components.md#scroll) component. It also adds a `scroll_content` node with the same postfix. Ensure that it's the correct node.
+- `blocker`: Adds a [Druid Blocker](01-components.md#blocker) component.
+- `slider`: Adds a [Druid Slider](01-components.md#slider) component. You should adjust the end position of the Slider after generating the file.
+- `progress`: Adds a [Druid Progress](01-components.md#progress) component.
+- `timer`: Adds a [Dr
+
+uid Timer](01-components.md#timer) component.
+
+## Best Practices for Custom Components
+
+When working with each component, it's recommended to describe the component scheme in the following way:
 
 ```lua
 -- Component module
@@ -121,31 +160,22 @@ local component = require("druid.component")
 local M = component.create("your_component")
 
 local SCHEME = {
-	ROOT = "root",
-	ITEM = "item",
-	TITLE = "title"
+    ROOT = "root",
+    ITEM = "item",
+    TITLE = "title"
 }
 
 function M.init(self, template_name, node_table)
-	-- If component use template, setup it:
-	self:set_template(template_name)
+    self:set_template(template_name)
+    self:set_nodes(node_table)
 
-	-- If component was cloned with gui.clone_tree, pass his nodes
-	self:set_nodes(node_table)
+    local root = self:get_node(SCHEME.ROOT)
+    local druid = self:get_druid()
 
-	-- helper can get node from gui/template/table
-	local root = self:get_node(SCHEME.ROOT)
-
-	-- This component can spawn another druid components:
-	local druid = self:get_druid()
-
-	-- Button self on callback is self of _this_ component
-	local button = druid:new_button(...)
+    -- Create components inside this component using the inner druid instance
 end
-
 ```
 
+## The Power of Using Templates
 
-## Power of using templates
-
-You can use one component, but creating and customizing templates for them. Templates only requires to match the component scheme.
+With Druid, you can use a single component but create and customize templates for it. Templates only need to match the component scheme. For example, you can have a component named `player_panel` and two GUI templates named `player_panel` and `enemy_panel` with different layouts. The same component script can be used for both templates.

docs_md/03-styles.md

@@ -37,7 +37,7 @@ local my_style = require("my.amazing.style")
 
 local function init(self)
 	self.druid = druid.new(self)
-	self.button = self.druid:new_button(self, "node")
+	self.button = self.druid:new_button("node", function() end)
 	-- Setup custom style for specific component
 	self.button:set_style(my_style)
 end
@@ -50,10 +50,10 @@ The most components have their styles. You can explore it on [Druid API](https:/
 
 To create you style, create lua module, what return <_component_name_, _component_style_> table
 
-Example: [default druid style](https://github.com/Insality/druid/blob/develop/druid/styles/default/style.lua)
+Example: [default druid style](styles/default/style.lua)
 
 Override all fields you want and set your style with one of next ways:
 
 - Set your style as global via `druid.set_default_style`
 - Set style for concrete druid instance via `druid = druid.new(self, style)`
-- Set style for concrete instance via `component:set_style(style)`
+- Set style for concrete instance via `component:set_style(style)`

docs_md/04-druid_assets.md

@@ -1,8 +0,0 @@
-# Druid assets
-
-## Overview
-I've created [druid-assets repository](https://github.com/Insality/druid-assets) to make a _marketplace_ with  custom styles and components.
-
-Any of Druid users can push their own components and styles to share it with the other users
-
-Also, this marketplace is great example to how you can create your custom components

docs_md/05-examples.md

@@ -1,6 +0,0 @@
-# Examples
-
-## Overview
-See the [example folder](https://github.com/Insality/druid/tree/develop/example/kenney) for examples of how to use Druid
-
-Try the [HTML5 version](https://insality.github.io/druid/druid/) of the example app

docs_md/FAQ.md

@@ -1,67 +1,36 @@
-
 # Druid FAQ
 
->_Have questions about Druid? Ask me!_
-> _Here is questions you might have_
+Welcome to the Druid FAQ! Here are answers to some common questions you may have:
 
-### Q: Why I want use Druid?
-**A:** ---
+### Q: How do I remove a Druid component instance?
+**A:** To remove a created Druid component, use the `druid:remove` function. You can find more information in the [API reference](https://insality.github.io/druid/modules/druid_instance.html#druid:remove).
 
+### Q: How does Druid process input?
+**A:** Input processing in Druid follows a Last-In-First-Out (LIFO) queue. Buttons added later have higher priority than those added earlier. To ensure correct button behavior, place your buttons from back to front in most cases.
 
-### Q: How to remove the Druid component instance?
-**A:** Any created **Druid** component can be removed with _druid:remove_. [API reference link](https://insality.github.io/druid/modules/druid_instance.html#druid:remove).
+### Q: What is the purpose of the Blocker component?
+**A:** The Blocker component is used to block input in a specific zone. It is useful for creating unclickable zones within buttons or for creating a panel of buttons on top of another button (e.g., closing windows by clicking on the window background). You can find more information about the Blocker component [here](https://github.com/Insality/druid/blob/master/docs_md/01-components.md#notes-2).
 
+### Q: What can I do with custom components?
+**A:** With custom components in Druid, the possibilities are endless! Custom components allow you to separate component placement and game logic from other elements, making them reusable and easier to test and develop. Custom components can be used for scroll elements with buttons, custom GUI widgets, or even components with custom game logic. Templates often accompany custom components, allowing you to create multiple visual variations for a single component module. You can find some examples of custom components [here](https://github.com/Insality/druid-assets).
 
-### Q: How to make scroll work?
-**A:** ---
+### Q: How does `self:get_node()` work?
+**A:** The `self:get_node()` function in a Druid component searches for nodes in the GUI directly or in cloned nodes created using `gui.clone_tree()`. It also considers nodes placed as templates, with the full node ID composed of the template name and node name (including cloned nodes). To ensure correct usage of `self:get_node()`, set up the component nodes using `self:set_template()` and `self:set_component_nodes()` before calling `self:get_node()`. It's best to pass the string name of the node, rather than the GUI node itself.
 
-
-### Q: How the input is processing?
-**A:**
-*SImply*: the **Druid** has a LIFO queue to check input. Last added buttons have more priority than first. Placing your buttons from behind to the front is correct in most cases.
-
-
-### Q: For what purpose Blocker component is exist?
-**A:** Component explanation [here](https://github.com/Insality/druid/blob/master/docs_md/01-components.md#notes-2). 
-With Blocker you can block input in some zone. It is useful for make unclickable zone in buttons or kind of buttons panel on other big button (ex. close windows on window background click)
-
-
-### Q: Which stuff can I do with custom components?
-**A:** Any of you can imagine! There is a lot of examples, but in general: custom components allow you place component and some game logic separately from other stuff. It will be reusable, easier for testing and developing.
-
-For example it can be element in scroll with buttons, your custom GUI widget or even component with your game logic. Usually custom components going with templates. You can do several templates for single component module (for different visuals!)
-
-Some examples of custom components you can find [here](https://github.com/Insality/druid-assets).
-
-
-### Q: How *self:get_node()* is working?
-**A:** The node can be placed in gui directly or can be cloned via *gui.clone_tree()*. Also nodes can be placed as templates, so full node id will be composed from template name and node name (in cloned nodes too).
-
-**Druid** component *self:get_node()* trying to search in all of this places. Use *self:set_template()* and *self:set_component_nodes()* for correct setup component nodes before any call of *self:get_node()*.
-
-Remember, usually you should pass *__string name__ of the node*, not gui node itself. It's better and more druid-way. 
-
-
-### Q: My button in scroll is clickable outside the stencil node
-**A:** Since **Druid** checking click node with _gui.pick_node_, stencil is not prevent this. You can setup additional click zone on your buttons with _button:set_click_zone_.
-
-The usual Druid way after add button to the scroll do:
+### Q: My button in a scroll is clickable outside the stencil node. How can I fix this?
+**A:** When using Druid, the stencil node does not prevent buttons from being clickable outside its bounds. To address this, you can set up an additional click zone on your buttons using the `button:set_click_zone()` function. After adding a button to the scroll, you can use the following code:
 ```lua
--- Scroll view node usually is stencil node
+-- Assuming the scroll view node is the stencil node
 button:set_click_zone(scroll.view_node)
 ```
 
-
-### Q: How to use EmmyLua annotations? _(from Druid 0.6.0)_
-**A:** Since the dependencies can't be processed by external editors, for use generated EmmyLua annotations you should copy the _annotations.lua_ to your project. For EmmyLua it will be enough. Remember you can _restart emmylua server_ for refresh the changes, if something goes wrong.
-After the annotations is processed, you should point the type of druid in requires:
+### Q: How do I use EmmyLua annotations? (from Druid 0.6.0)
+**A:** EmmyLua annotations are used for better autocompletion and type inference in editors. To use the generated EmmyLua annotations, copy the `druid/annotations.lua` file to your project. After copying, you may need to restart the EmmyLua server to ensure the changes take effect. Once the annotations are processed, you can specify the type of Druid in your code:
 ```lua
 ---@type druid
 local druid = require("druid.druid")
 
--- Now the autocomplete is working
+-- Autocomplete and type information should now work
 ```
 
-
-### Q: When I should use *on_layout_change*?
-**A:** ---
+Feel free to ask any additional questions you have about Druid!

docs_md/advanced-setup.md

@@ -0,0 +1,131 @@
+# Advanced Druid Setup
+
+
+## Input Bindings
+
+By default, **Druid** utilizes the `/builtins/input/all.input_binding` for input bindings.
+
+**Druid** requires the following input bindings:
+
+- Mouse trigger: `Button 1` -> `touch` (for basic input components)
+- Mouse trigger: `Wheel up` -> `mouse_wheel_up` (for Scroll component)
+- Mouse trigger: `Wheel down` -> `mouse_wheel_down` (for Scroll component)
+- Key trigger: `Backspace` -> `key_backspace` (for BackHandler component, input component)
+- Key trigger: `Back` -> `key_back` (for BackHandler component, Android back button, input component)
+- Key trigger: `Enter` -> `key_enter` (for Input component, optional)
+- Key trigger: `Esc` -> `key_esc` (for Input component, optional)
+- Touch triggers: `Touch multi` -> `touch_multi` (for Scroll component)
+
+![](../media/input_binding_2.png)
+![](../media/input_binding_1.png)
+
+
+## Changing Key Bindings
+
+If you need to use your own key bindings or key names, you can modify them in your *game.project* file.
+
+Here are the default values for key bindings:
+```
+[druid]
+input_text = text
+input_touch = touch
+input_marked_text = marked_text
+input_key_esc = key_esc
+input_key_back = key_back
+input_key_enter = key_enter
+input_key_backspace = key_backspace
+input_multitouch = touch_multi
+input_scroll_up = mouse_wheel_up
+input_scroll_down = mouse_wheel_down
+```
+
+
+## Input Capturing
+
+By default, **Druid** automatically captures input focus if any input component is created. Therefore, you do not need to call `msg.post(".", "acquire_input_focus")`.
+
+If you do not require this behavior, you can disable it by setting the `druid.no_auto_input` field in the _game.project_ file:
+```
+[druid]
+no_auto_input = 1
+```
+
+
+## Template Name Check
+
+By default, **Druid** automatically checks the parent component's template name to construct the full template name for the component. It's used in user custom components.
+
+If, for some reason, you want to pass the full template name manually, you can disable this feature by setting the `druid.no_auto_template` field in the _game.project_ file:
+
+```
+[druid]
+no_auto_template = 1
+```
+
+
+## Stencil Check
+
+When creating input components inside stencil nodes, **Druid** automatically sets up `component:set_click_zone()` during the _late_init_ component step to restrict input clicks outside of the stencil zone. This is particularly useful for buttons inside scroll stencil nodes.
+
+To disable this feature, add the following field to your _game.project_ file:
+```
+[druid]
+no_stencil_check = 1
+```
+
+
+## Code Bindings
+
+Adjust **Druid** settings as needed:
+```lua
+local druid = require("druid.druid")
+
+-- Used for button component and custom components
+-- The callback should play the sound by name: function(sound_id) ... end
+druid.set_sound_function(function(sound_id)
+    -- sound_system.play(sound_id)
+end)
+
+-- Used for lang_text component
+-- The callback should return the localized string by locale ID: function(locale_id) ... end
+druid.set_text_function(function(locale_id)
+	-- return lang.get(locale_id)
+end)
+
+-- Used to change the default Druid style
+druid.set_default_style(your_style)
+
+-- Call this function when the language changes in the game,
+-- to retranslate all lang_text components:
+local function on_language_change()
+    druid.on_language_change()
+end
+
+-- Call this function inside window.set_listener
+-- to capture game focus lost/gained callbacks:
+-- window.set_listener(function(self, event, data) druid.on_window_callback(event, data) end))
+local function on_window_callback(self, event, data)
+    druid.on_window_callback(event)
+end
+window.set_listener(on_window_callback)
+```
+
+
+## EmmyLua Annotations
+
+[EmmyLua](https://emmylua.github.io/annotation.html) is a Lua annotation library. It is a useful tool for enabling Lua code autocompletion in editors such as [VSCode](https://github.com/EmmyLua/VSCode-EmmyLua) and [IntelliJ IDEA](https://github.com/EmmyLua/IntelliJ-EmmyLua).
+
+Since dependencies cannot be processed by external editors, to use the EmmyLua annotations, you should copy the _druid/annotations.lua_ file to your project.
+
+Remember that you can restart the EmmyLua server to refresh the changes if something goes wrong.
+
+After the annotations are processed, you should specify the type of "Druid" in the "require" statement:
+
+```lua
+---@type druid
+local druid = require("druid.druid")
+
+-- Now the autocomplete is working
+```
+
+<img src="../media/emmy_lua_preview.png" width="700">

docs_md/changelog.md

@@ -66,7 +66,7 @@
 		- _Content node_ - dynamic node, moving by _Scroll_ component
 	- Scroll will be disabled only if content size equals to view size (by width or height separatly)
 	- You can adjust start scroll size via _.gui_ scene. Just setup correct node size
-	- Different anchoring is supported (for easier layouting)
+	- Different anchoring is supported (for easier layout)
 	- Function _scroll_to_ now accept position relative to _content node_. It's more easier for handling. _Example:_ if you have children node of _content_node_, you can pass this node position to scroll to this.
 	- **Resolve #52**: _Content node size_ now can be less than _view node size_. In this case, content will be scrolled only inside _view size_ (can be disabled via style field: _SMALL_CONTENT_SCROLL_)
 	- **Fix #50**: If style.SOFT_ZONE_SIZE equals to [0..1], scroll can be disappeared
@@ -136,7 +136,7 @@ Also check _component.template.lua_ what you can use for your own custom compone
 
 Hey! Are you tired from **Druid** updates? _(It's a joke)_
 
-Finally, got a time to release component to process huge amount of data. So introducing: **DataList** component. I can't say what it's "infinity" scroll, but it can help to solve your problem with `GUI nodes limit reached` and helps with scroll optimization. Give feedback about it!
+Finally, got a time to release component to process huge amount of data. So introducing: **DataList** component. It can help solve your problem with `GUI nodes limit reached` and helps with scroll optimization. Give feedback about it!
 
 The next important stuff is **EmmyLua** docs. I'm implemented EmmyLua doc generator from LuaDoc and Protofiles, so now you can use EmmyLua annotations inside your IDE instead of website API looking or source code scanning.
 
@@ -144,11 +144,12 @@ Also the **Druid examples** is reworked, so each example will be in separate col
 
 Input priority got reworked too. Now instead of two input stacks: usual and high, Druid use simple input priority value.
 
-And I should note here is several breaking changes, take a look in changelogs.
+And I should note here are several breaking changes, take a look in changelogs.
 
 Wanna something more? [Add an issues!](https://github.com/Insality/druid/issues)
 Have a good day.
 
+
 **Changelog 0.6.0**
 ---
 
@@ -183,7 +184,7 @@ Have a good day.
 - Lang text now can be initialized without default locale id
 - Input component: rename field _selected_ to _is_selected_ (according to the docs)
 - **#92** Setup repo for CI and unit tests. (Yea, successful build and tests badges!)
-- **#86** Fix a lot of event triggers on scroll inertia moving 
+- **#86** Fix a lot of event triggers on scroll inertia moving
 - **#101** Fix scroll to other node instead of swipe direction with scroll's points of interest (without inert settings)
 - **#103** Add `helper.centate_nodes` function. It can horizontal align several Box and Text nodes
 - **#105** Add `Input:select` and `Input:unselect` function.
@@ -202,3 +203,300 @@ Have a good day.
 	- This is basic implementation, it is work not perfect
 - **#124** Add `Scroll:set_click_zone` function. This is just link to `Drag:set_click_zone` function inside scroll component.
 - **#127** The `druid:create` is deprecated. Use `druid:new` for creating custom components
+
+
+### Druid 0.7.0:
+
+Hello! Here I'm again with new Druid stuff for you!
+
+The feature I want a long time to deliver for you: the different Text size adjust modes. Druid use the text node sizes to fit the text into this box.
+There are new adjust modes such as Trim, Scroll, Downscale with restrictions and Downscale + Scroll. You can change default adjust mode via text style table, but by default there is no changes - it's downscale adjust mode as before.
+I'll hope it can be useful for you for in different cases and now it will be much easy to fit all your texts for different languages!
+
+The next features is made for add more control for availability of user input. So meet the whitelists, blacklists and custom check functions for Buttons. Now you can easily choose the more suitable way to enable/disable/restrict input for you users. I'm sure it can be useful for you tutorials.
+
+Another small, but cool feature on my mind is `druid.stencil_check`. If you did interactive elements inside the Scroll, probably you used `component:set_click_zone` to restrict input zone by stencil scroll view node. With this feature, Druid will do it automaticaly for you! You can enable this feature in your `game.project`. It will not override you existing `set_click_zone`.
+
+Now you even able to remap default input keys! Also there are several bugfixes with Scroll, Text, Grids.
+
+Wanna something more? [Add an issues!](https://github.com/Insality/druid/issues)
+Good luck!
+
+
+**Changelog 0.7.0**
+---
+
+- **#78** [Text] Update Text component:
+	- Add text adjust type instead of _no_adjust_ param.
+		- const.TEXT_ADJUST.DOWNSCALE - Change text's scale to fit in the text node size
+		- const.TEXT_ADJUST.TRIM - Trim the text with postfix (default - "...", override in styles) to fit in the text node size
+		- const.TEXT_ADJUST.NO_ADJUST - No any adjust, like default Defold text node
+		- const.TEXT_ADJUST.DOWNSCALE_LIMITED - Change text's scale list downscale, but there is limit for text's scale
+		- const.TEXT_ADJUST.SCROLL - Change text's pivot to imitate scrolling in the text box. Use with stencil node for better effect.
+		- const.TEXT_ADJUST.SCALE_THEN_SCROLL - Combine two modes: first limited downscale, then scroll
+- **#110** [Button] Add `Button:set_check_function(check_function, failure_callback)` function to add your custom click condition to button.
+	- `Button:set_enabled` has more priority than this to check button availability
+	- The `check_function` should return _true_ of _false_. If true - button can be clicked by user
+	- The `failure_callback` will be called if `check_function` will return false
+	- Example with `set_check_function` in general:buttons example collection
+- **#66** Add `druid:set_whitelist()` and `druid.set_blacklist()` functions. It's affects only on input process step, you can allow/forbid interact with list of specific components
+	- You can pass array of components, single component or nil in these functions
+- **#111** Add autocheck for input and stencil nodes. To enable this feature, add `druid.stencil_check = 1` to your _game.project_ file.
+	- This feature is using for auto setup `component:set_click_zone` to restrict clicks outside scrolls zone for example. Now you can don't think about click zone and let Druid do it instead of you!
+	- Add `helper.get_closest_stencil_node` function to get closest parent of non inverted stencil node
+	- Add `component.ON_LATE_INIT` interest. Component with this will call `component.on_late_init` function once after component init on update step. This can be used to do something after all gui components are inited
+- **#81** Add ability to interact with Druid input via messages:
+	- Currently add for Button and Text component only:
+		- Send to _gui.script_ message: `druid_const.ON_MESSAGE_INPUT`. The message table params:
+			- `node_id` - the name of the node with component on it
+			- `action` - value from `druid_const.MESSAGE_INPUT`. Available values:
+				- **BUTTON_CLICK** - usual button click callback
+				- **BUTTON_LONG_CLICK** - button long click callback
+				- **BUTTON_DOUBLE_CLICK** - button double click callback
+				- **BUTTON_REPEATED_CLICK** - button repeated click callback
+				- **TEXT_SET** - set text for Text component
+			- `value` - optional field for several actions. For example value is text for **TEXT_SET**
+	- Add Druid component interest: `component.ON_MESSAGE_INPUT`
+	- Implement new interest via function `component:on_message_input(node_id, message)`
+	- See **System: Message input** example
+- **#131** [Static Grid] Add style param: `IS_DYNAMIC_NODE_POSES` (default: false). Always align by content size with node anchor.
+	- If true - Static Grid will by always align to content anchor.
+	- If false (currently behaviour) - all poses for static grid is predefined and not depends on element's count (see example: static grid and static grid with dynamic poses)
+- **#125** Now `component:set_input_priority()` affects on all component's children too
+- **#143** Update all lang components on `druid.set_text_function` call
+- **#112** Allow remap default Druid input bindings via `game.project`
+- **#107** [Text] Better scale text adjust by height for multiline text nodes (but still not perfect)
+- **#144** [Scroll] Fix some glitches with scroll Points of Interest. Remove false detection of scroll stopped.
+- **#142** [Scroll] Add Scroll style param `WHEEL_SCROLL_BY_INERTION` (default - false). If true - mouse wheel will add inertion to scroll, if false - set position directly per mouse wheel event.
+	- This fix caused because Mac trackpad seems have additional mouse wheel events for simulate inertion. If you uncomfortable with this, you can disable `WHEEL_SCROLL_BY_INERTION` for more controllable scroll by mouse wheel.
+- **#132** Add example with grid add/remove with animations
+
+
+### Druid 0.8.0
+Hello!
+
+In this Druid update no any huge special features. Mostly the bug fixes and reworking the component's interest points. If you used interests in your custom components, you should remove it from `component.create` and all should works as before.
+
+Also added last row allignment in Static Grid component with "dynamic content poses" style enabled. You can look how it is work here: https://insality.github.io/druid/druid/?example=grid_static_grid_dynamic_pos
+
+
+You can say thanks to me via stars on GitHub! :wink:
+Wanna something more? [Add an issues!](https://github.com/Insality/druid/issues)
+Have a nice day!
+
+
+**Changelog 0.8.0**
+
+---
+
+-  **#160** __[BREAKING]__ Remove component interests list
+	- The component interests now setup via function declaration inside your components. The functions are still the same.
+	- Now `component.create` function have next signature: _create(component_name, input_priority)_
+	- Your should remove interests list from your custom components if exists
+		- From `component.create("custom", { component.ON_INPUT, component.ON_LATE_INIT }, const.PRIORITY_INPUT_HIGH)` to
+`component.create("custom", const.PRIORITY_INPUT_HIGH)`
+-  **#166**  [Input] Fix issue with Cyrillic symbols in range "[А-я]"
+-  **#162** [Static Grid] Add last row alignment with dynamic content poses enabled
+	- Add style param: _static_grid.IS_ALIGN_LAST_ROW_, true by default. Works only if _static_grid.IS_DYNAMIC_NODE_POSES_ enabled. See the "Static grid with dynamic poses" example.
+-  **#163** [Lang Text] Set default locale_id value from text node
+-  **#147** [Lang Text] Remove `...` from lang_text to fixed arguments, add _format_ function to change only string format arguments
+	- There are some issues with `...`. Now Lang Text will support up to 7 _string.format_ arguments
+- [Lang Text] Add more self chaining to Lang text component (_set_to_, _translate_ and _format_ functions)
+-  **#151**  [Text] Fix text adjust by height
+	- It still have not perfect fitting, but it's good enough!
+-  **#164 #150**  [Scroll] Fix `scroll:scroll_to_percent` by Y position
+-  **#148**  [Scroll] Remove scroll inertion after scroll `animate` or `set_to` functions
+-  [Input] Add current text argument to _on_input_unselect_ event
+-  **#152**  [Checkbox] Add _is_instant_ argument to  `set_state` function
+	- Add _initial_state_ argument to Checkbox component constructor
+	- Update Checkbox style, add _is_instant_ param
+-  **#149**  [Button] Call button style functions after actual callback
+-  **#153** System: Mode Druid acquire input to late_init step
+	- Required to solve issues, when go input acquire can be later, when gui input acquire (on init step)
+-  **#154** System: Change text adjust const to strings
+-  **#155** Fix: Add margin to total width calculation in `helper.centrate_nodes`
+
+
+### Druid 0.9.0
+_Custom components update_
+
+Hello!
+
+Here is the long awaited update! Finally I implemented some ideas how to make easier creating custom components. There is a bunch of improvements you can be interested in.
+
+I wanna make a point that Druid is not only set of defined components to place buttons, scroll, etc. But mostly it's a way how to handle all your GUI elements in general. Custom components is most powerful way to separate logic and make higher abstraction in your code.
+
+Usually - custom components is set of GUI template and lua code for this template. I've added editor script, that can make a lua component file from your GUI scene (all boilerplate and usage code, also some component that can be defined right in GUI scene).
+
+Auto layout from GUI script should be a powerful tool too! Also it's brings some code structure and style across all your files. Auto layout works from node names. If its starts or equal to some string, it will add code to generated lua file. For example, if you have in your scene node with name "button_start", it will create the Druid button, stub function and annotations to this. Sounds good!
+
+For more information see [Create custom components](docs_md/02-creating_custom_components.md) documentations.
+
+Also this update have some breaking changes: you should no more pass full tempalte name in inner components and the second one is renaming `text:get_text_width` to `text:get_text_size`.
+
+The Defold 1.3.0 solves the old my issue with slider component. Now you can define input zone (not only the slider pin node) to interact with slider. It's because of inroduction `gui.screen_to_local` and `gui.set_screen_position` in default GUI api. If you using previuos Defold releases, this piece of logic will be ignored.
+
+The Druid Assets repository will be closed and I move some components right in Druid repository. You can now use custom components in your game if your need. Right now it's Rich Input (input field with cursor and placegolder) and Pin Knob (Rotating node for set value). And slowly working on adding new examples and improvements of existing ones.
+
+You can say thanks to me via stars on GitHub! :wink:
+Also you can help with testing new functions and leave feedback.
+Wanna something more? [Add an issues!](https://github.com/Insality/druid/issues)
+Take care of yourself
+
+
+**Changelog 0.9.0**
+
+---
+
+-  **#119** Add **Create Druid Component** editor script *(python3 with deftree required)*
+	- The headliner of current update. This editor scripts allows you to create Custom component lua script from you *.gui* scene file. It will create component file with the same name as GUI scene and place it nearby. Inside this generated file you will find the instructions how to start usage this (require and create code).
+	- This code contains GUI scheme, basic component boilerplace and generated code for components, used in this GUI scene (see #159)
+	- See [Create custom components](docs_md/02-creating_custom_components.md) for more info
+-  **#159** Add auto layout custom components by node naming
+	- The **Create Druid Component** script will check the node names to create Druid components stubs inside generated code
+	- The generator will check the node name, if it's starts from special prefix, it will create component code for you
+	- Currently support the next components: `button`, `text`, `lang_text`, `grid`, `static_grid`, `dynamic_grid`, `scroll_view`, `blocker`, `slider`, `progress` and `timer`
+-  **#158** **[BREAKING]** Auto `get_node` inside inner components with template/nodes
+	- Before this update, if your component with template using another component with template, you had to pass full template name (`current_template .. "/" .. inner_component_template`). From this update you should pass only the `inner_component_template` name. It's will auto check the parent component template name to build full template path
+	- If you don't want migrate code for this, this option can be disabled via `druid.no_auto_template` in your _game.project_ file. By default it's enabled now
+-  **#171** Add `component:get_template()` function to **Druid** Base Component
+	- Now it's able to get full component template name. This function has "protected" scope, so you should use it only inside your component code.
+-  **#173** Fix GUI nodes usage inside inner templates
+	- Now you can pass the node name instead of node itself to Druid components inside your Custom Components. Before this update Druid didn't check the nodes in parent component (usually for basic components such as button, text inside your components)
+	- So you can use now `self.druid:new_button(SCHEME.BUTTON)` instead of `self.druid:new_button(self:get_node(SCHEME.BUTTON))` inside your custom components
+-  **#174** Add assert to nil node on `self:get_node()`
+	- It's required for easier debuging components, when GUI node path is wrong and your got the nil. The error with node path will appear in console.
+-  **#169** [System] Fix on_layout_change event
+	- It was broken, now the on_layout_change event is working as expected
+-  **#165** [StaticGrid] Add `static_grid:set_in_row(amount)` function
+-  **#44** [Slider] Click zone on all slider node, not only pin node
+	- Finally! Added the `slider:set_input_node(node)` function. Now slider can be interacted not only with slider pin node, but with any zone you will define.
+	- It will work only from Defold 1.3.0. If you use earlier version, nothing is happened. It using new `gui.screen_to_local` and `gui.set_screen_position` functions.
+- **#178** **[BREAKING][Text]** Rename `text:get_text_width` to `text:get_text_size`. Now it return two numbers: width and height
+-  **#114** Add default component templates
+	- Added templates for fast prototyping. Use GUI templates to place buttons, checkbox, input and sliders on your GUI scene. You still have to create component with `druid:new` functions inside gui_script.
+-  **#168** Add button to open code of current example
+	- Inside every example added button to open code of this example on GitHub
+-  **#140** Better documentation for custom components
+-  **#172** Update documentation with links to components
+	- The docs in (https://insality.github.io/druid/) now have cross links for every custom type
+-  **#175** Remove Druid Assets repository, move to Druid library
+	- Added folder `druid/custom`. It will have the complex custom components. Usually you should to use default GUI template or create your own with similar GUI scheme. Currently add `RichInput` and `PinKnob` components from druid-assets repository.
+	- Usually to use custom component you have to require lua file first and create it's via `druid:new(Component, template_name, [nodes])`. See component docs to see constructor params.
+	- This components will be included in build only if used
+-  **#176** Keep last scene and scroll position in Druid example
+	- Probably, it's useful for faster debug, but anyway. The example now keep the last scene and scroll position.
+- Add new examples: Checkboxes, Swipe, Grid, Rich input, Pin knob
+- Now editor scripts are available in Druid as dependency
+- Move emmylua annotations inside Druid dependency folder. You can copy it from Defold Editor outline
+- Optimize different stuff(Scroll, Druid Event, Druid instance and Base component)
+- Force Data List component to `IS_DYNAMIC_NODE_POSES = false` style
+
+
+### Druid 0.10.0
+
+Hello! Here is new Druid update. It's brings to you two new components: Layout and Hotkey. Both components are "extended", so to use it, you should register it first (when you try to use it, in console will be prompt with code you should use)
+
+In general:
+```
+local layout =  require("druid.extended.layout")
+druid.register("layout", layout)
+```
+
+The Drag component now knows about window scaling, so now it have more accuracy dx/dy values depends on the screen size. The scroll and other components should work better :)
+
+Now you can change the input priority of components temporary. For example while you interact with them (input fields, drag on select etc).
+
+Also the update brings several bug fixes and now **Druid** have stencil_check mode enabled by default. It should be more easy to use input components with stencil nodes without manual `set_click_zone` functions.
+
+And yeah, the new **Druid** logo is here!
+
+**Changelog 0.10.0**
+
+---
+
+- **#133** [Hotkey] Add new extended component: Hotkey
+	- It's allow you set hotkeys to call callbacks
+	- You should pass one action key and several modificator keys (left shift, right ctrl etc)
+	- List of modificator keys ids setup via component style (you can change it)
+	- You can add several hotkeys on one callback via `hotkey:add_hotkey` with additional params
+- **#98** [Layout] Add new extended component: Layout
+	- It's allow you to extend standart Defold node adjust modes
+	- Layout mode can be next:
+		- `const.LAYOUT_MODE.STRETCH_X` - Stretch node only by X
+		- `const.LAYOUT_MODE.STRETCH_Y` - Stretch node only by Y
+		- `const.LAYOUT_MODE.ZOOM_MIN` - Zoom node by minimal stretch multiplier
+		- `const.LAYOUT_MODE.ZOOM_MAX` - Zoom node by maximum stretch multiplier
+		- `const.LAYOUT_MODE.FIT` - Usual Defold Fit mode
+		- `const.LAYOUT_MODE.STRETCH` - Usual Defold Stretch Mode
+	- The Layout changes the node size property. So it's look much better if you use 9slice nodes
+	- Works even the node parent is have Fit adjust mode
+- **#200** [Scroll] Glitch if content size equals to scroll view size in runtime
+- **#201** [DataList] Update DataList:
+	- Add two events: `on_element_add` and `on_element_remove`
+	- Add `data_list:get_data()` to access all current data in DataList
+	- Add `data_list:get_created_nodes()` to access currently visual nodes in DataList
+	- Add `data_list:get_created_components()` to access currenly visual component in DataList (if created)
+- **#190** [Progress] Add `progress:set_max_size` function to change max size of progress bar
+- **#188** [Drag] Add two values passed to on_drag callback. Now it is `on_drag(self, dx, dy, total_x, total_y)` to check the overral drag distance
+- **#195** [Drag] Add `drag:is_enabled` and `drag:set_enabled` to enable/disable drag input component
+- **#186** [Grid] Fix: Method `set_in_row` works incorrectly with IS_DYNAMIC_NODE_POSES style option
+- **#185** [System] Add `on_window_resized` component interest. It will called on game window size changes
+- **#189** [System] Add optional flag to `component:set_input_priority` to mark it as temporary. It will reset to default input priority after the `component:reset_input_priority`
+- **#204** [System] Fix: wrong code example link, if open example from direct URL
+- **#202** [System] Enabled stencil check to true by default. To disable this, use `druid.no_stencil_check` in game.project settings
+- [Examples] Add layout, layout fit, progress bar, data list + component examples
+
+
+### Druid 0.11.0
+Hello! What a wonderful day for the new **Druid** update!
+
+Alright, let's get straight to the point. Look at what I have for you!
+
+**Druid Rich Text** has finally been released. The main difference from the existing **Bjorn's** Rich Text is that all visual parameters are customizable directly in the GUI. This allows you to integrate **Rich Text** more accurately and quickly. Additionally, this **Rich Text** aligns pixel perfect (well, [almost](https://github.com/defold/defold/issues/7197)) with regular GUI text node.
+
+This version is the most basic one. Honestly, just wanna to publish current version for your and polish it later. Read [RichText API here](https://insality.github.io/druid/modules/RichText.html)
+
+Another addition is the ability to enable the "HTML mode" for the Button component. In this mode, the button's action occurs in the context of `user action`, allowing operations like "copy and paste text" "show the keyboard" and more. However, in this mode, the button only responds to regular clicks due to the technical implementation of it (so no double clicks or long taps for this button).
+
+The huge work was done on documentation. Now it's more clear and have more examples. All documentation now moved to the API section. The separate `componentd.md` manual will be deleted soon as all documentation will be moved to the API section.
+
+The API section now filled with overview and usage examples. I've started with the basic modules, in future I will add more examples for all modules.
+
+Also, I've added the **Unit Tests**. It's not cover all **Druid** code, but it's a good start! 🎉
+
+Have a good day!
+
+
+**Changelog 0.11.0**
+
+---
+
+- **#191**: [RichText] Finally add **Druid [Rich Text](https://insality.github.io/druid/modules/RichText.html)** custom component. Component is used to make formatted text in your's GUI. This Rich Text mostly adjusted visually in GUI and have almost pixel-perfect match with similar GUI text node
+- **#39**: [System] Finally add **Unit Tests**. Yeah, it cover not all **Druid** code, but it's a good start! 🎉
+- **#219**: [System] UTF-8 performance optimization. Now Druid will try to use *utf8* native extension over lua utf8 library if exists. If you wanna use native utf8, just [add the extension](https://github.com/d954mas/defold-utf8) in your `game.project` dependency.
+- **#156**: [Button] Now button can work in HTML5 with `html5.set_interaction_listener`.
+	- The API is `button:set_web_user_interaction(true)`. In HTML5 mode button have several restrictions. Basically, only the single tap event will work.
+- **#227**: Update current URL in HTML5 example
+	- Now if you will open the example from direct URL, it will be updated to the current URL in your browser. So now it's much easier to share the example link with each other.
+- **#183**: Documentation about [GUI in World Space](https://forum.defold.com/t/how-to-gui-in-defold/73256#gui-in-world-coordinates-49)
+	- Also not only the GUI in World Space, but overall How to GUI in Defold article.
+- **#234**: [BREAKING][Blocker] Now `blocker:set_enabled` and `blocker:is_enabled` affects only inner state of component. To consume input, the blocker component should be enabled and the node itself should be enabled.
+- **#235**: [Drag] Fix Drag coordinates on streched screen.
+- **#236**: [Hover] Fix nil return in `hover:on_input`.
+- **#237**: [Layout] Add `layout:set_max_gui_upscale` function.
+	- This functions will scale down element, if current GUI scale is bigger than `max_gui_upscale` value. It can be useful for adapt mobile device to desktop screen.
+- **#238**: [System] Add Helper documentation.
+- [System] Now the documentation contains the **Druid** size. The current size as dependency is around **67KB**. It counted without extended components, which is not included by default in the build.
+
+
+❤️ Support ❤️
+
+Please support me if you like this project! It will help me keep engaged to update **Druid** and make it even better!
+
+[![Github-sponsors](https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#EA4AAA)](https://github.com/sponsors/insality) [![Ko-Fi](https://img.shields.io/badge/Ko--fi-F16061?style=for-the-badge&logo=ko-fi&logoColor=white)](https://ko-fi.com/insality) [![BuyMeACoffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-ffdd00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black)](https://www.buymeacoffee.com/insality)
+
+
+Thanks for my the supporters:
+- [Defold Foundation](https://defold.com)
+- [Ragetto](https://forum.defold.com/u/ragetto)

docs_md/game_examples.md

@@ -0,0 +1,8 @@
+# Game Examples
+
+## Family Island
+
+## Sea Battle: Universe
+
+## Monkey Mart
+

druid.code-workspace

@@ -0,0 +1,31 @@
+{
+	"folders": [
+		{
+			"path": "."
+		}
+	],
+	"settings": {
+		"files.exclude": {
+			"**/.git": true,         // this is a default value
+			"**/.DS_Store": true,    // this is a default value
+
+			"**/node_modules": true, // this excludes all folders
+									// named "node_modules" from
+									// the explore tree
+
+			// alternative version
+			"node_modules": true,   // this excludes the folder
+									// only from the root of
+									// your workspace
+			".internal": true,
+			"bundle": true,
+			"input": true,
+			"media": true,
+			"build": true,
+			"docs": true,
+			".github": true,
+			".deployer_cache": true,
+			"dist": true
+		}
+	}
+}

druid/base/back_handler.lua

@@ -1,13 +1,38 @@
---- Component to handle back key (android, backspace)
+-- Copyright (c) 2023 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
+
+--- Component with event on back and backspace button.
+-- <b># Overview #</b>
+--
+-- Back Handler is recommended to put in every game window to close it
+-- or in main screen to call settings window.
+--
+-- <b># Notes #</b>
+--
+-- • Back Handler inheritance @{BaseComponent}, you can use all of its methods in addition to those described here.
+--
+-- • Back Handler react on release action ACTION_BACK or ACTION_BACKSPACE
+-- @usage
+-- local callback = function(self, params) ... end
+--
+-- local params = {}
+-- local back_handler = self.druid:new_back_handler(callback, [params])
 -- @module BackHandler
 -- @within BaseComponent
 -- @alias druid.back_handler
 
---- On back handler callback(self, params)
--- @tfield druid_event on_back
+--- The @{DruidEvent} Event on back handler action.
+--
+-- Trigger on input action ACTION_BACK or ACTION_BACKSPACE
+-- @usage
+-- -- Subscribe additional callbacks:
+-- back_handler.on_back:subscribe(callback)
+-- @tfield DruidEvent on_back @{DruidEvent}
 
---- Params to back callback
--- @tfield any params
+--- Custom args to pass in the callback
+-- @usage
+-- -- Replace params on runtime:
+-- back_handler.params = { ... }
+-- @tfield[opt] any params
 
 ---
 
@@ -15,25 +40,27 @@ local Event = require("druid.event")
 local const = require("druid.const")
 local component = require("druid.component")
 
-local BackHandler = component.create("back_handler", { component.ON_INPUT })
+local BackHandler = component.create("back_handler")
 
 
---- Component init function
--- @tparam BackHandler self
+--- The @{BackHandler} constructor
+-- @tparam BackHandler self @{BackHandler}
 -- @tparam callback callback On back button
--- @tparam[opt] any params Callback argument
-function BackHandler.init(self, callback, params)
-	self.params = params
+-- @tparam[opt] any custom_args Button events custom arguments
+-- @local
+function BackHandler.init(self, callback, custom_args)
+	self.params = custom_args
 	self.on_back = Event(callback)
 end
 
 
---- Input handler for component
--- @tparam BackHandler self
+--- Component input handler
+-- @tparam BackHandler self @{BackHandler}
 -- @tparam string action_id on_input action id
 -- @tparam table action on_input action
+-- @local
 function BackHandler.on_input(self, action_id, action)
-	if not action[const.RELEASED] then
+	if not action.released then
 		return false
 	end
 

druid/base/blocker.lua

@@ -1,9 +1,25 @@
---- Component to block input on specify zone by node
+-- Copyright (c) 2023 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
+
+--- Component to consume input in special zone defined by GUI node.
+-- <b># Overview #</b>
+--
+-- <b># Notes #</b>
+--
+-- Blocker consume input if `gui.pick_node` works on it.
+--
+-- • Blocker inheritance @{BaseComponent}, you can use all of its methods in addition to those described here.
+--
+-- • Blocker initial enabled state is `gui.is_enabled(node, true)`
+--
+-- • The Blocker node should be enabled to capture the input
+-- @usage
+-- local node = gui.get_node("blocker_node")
+-- local blocker = self.druid:new_blocker(node)
 -- @module Blocker
 -- @within BaseComponent
 -- @alias druid.blocker
 
----Trigger node
+---Blocker node
 -- @tfield node node
 
 ---
@@ -11,17 +27,23 @@
 local const = require("druid.const")
 local component = require("druid.component")
 
-local Blocker = component.create("blocker", { component.ON_INPUT })
+local Blocker = component.create("blocker")
 
 
---- Component init function
--- @tparam Blocker self
+--- @{Blocker} constructor
+-- @tparam Blocker self @{Blocker}
 -- @tparam node node Gui node
 function Blocker.init(self, node)
 	self.node = self:get_node(node)
+	self._is_enabled = gui.is_enabled(self.node, true)
 end
 
 
+--- Component input handler
+-- @tparam Blocker self @{Blocker}
+-- @tparam string action_id on_input action id
+-- @tparam table action on_input action
+-- @local
 function Blocker.on_input(self, action_id, action)
 	if action_id ~= const.ACTION_TOUCH and
 		action_id ~= const.ACTION_MULTITOUCH and
@@ -33,6 +55,10 @@ function Blocker.on_input(self, action_id, action)
 		return false
 	end
 
+	if not gui.is_enabled(self.node, true) then
+		return false
+	end
+
 	if gui.pick_node(self.node, action.x, action.y) then
 		return true
 	end
@@ -41,19 +67,21 @@ function Blocker.on_input(self, action_id, action)
 end
 
 
---- Set enabled blocker component state
--- @tparam Blocker self
+--- Set enabled blocker component state.
+--
+-- Don't change node enabled state itself.
+-- @tparam Blocker self @{Blocker}
 -- @tparam bool state Enabled state
 function Blocker.set_enabled(self, state)
-	gui.set_enabled(self.node, state)
+	self._is_enabled = state
 end
 
 
---- Return blocked enabled state
--- @tparam Blocker self
+--- Return blocker enabled state
+-- @tparam Blocker self @{Blocker}
 -- @treturn bool True, if blocker is enabled
 function Blocker.is_enabled(self)
-	return gui.is_enabled(self.node)
+	return self._is_enabled
 end
 
 

druid/base/button.lua

@@ -1,48 +1,137 @@
---- Component to handle basic GUI button
+-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
+
+--- Druid Component for Handling User Click Interactions: Click, Long Click, Double Click, and More.
+--
+-- <b># Overview #</b>
+--
+-- This component provides a versatile solution for handling user click interactions.
+-- It allows you to make any GUI node clickable and define various callbacks for different types of clicks.
+--
+-- <b># Notes #</b>
+--
+-- • The click callback will not trigger if the cursor moves outside the node's
+-- area between the pressed and released states.
+--
+-- • If a button has a double click event subscriber and the double click event is triggered,
+-- the regular click callback will not be triggered.
+--
+-- • Buttons can be triggered using a keyboard key by calling the button:set_key_trigger method.
+--
+-- • To animate a small icon on a big button panel, you can use an animation node.
+-- The trigger node name should be set as "big panel," and the animation node should be set as "small icon."
+--
+-- <a href="https://insality.github.io/druid/druid/index.html?example=general_buttons" target="_blank"><b>Example Link</b></a>
+-- @usage
+-- local function on_button_click(self, args, button)
+--     print("Button has clicked with params: " .. args)
+--     print("Also the button component is passed in callback params")
+-- end
+--
+-- local custom_args = "Any variable to pass inside callback"
+-- local button = self.druid:new_button("button_name", on_button_click, custom_args)
+--
 -- @module Button
 -- @within BaseComponent
 -- @alias druid.button
 
---- On release button callback(self, params, button_instance)
--- @tfield druid_event on_click
 
---- On repeated action button callback(self, params, button_instance, click_amount)
--- @tfield druid_event on_repeated_click
+--- The @{DruidEvent}: Event on successful release action over button.
+-- @usage
+-- -- Custom args passed in Button constructor
+-- button.on_click:subscribe(function(self, custom_args, button_instance)
+--     print("On button click!")
+-- end)
+-- @tfield DruidEvent on_click @{DruidEvent}
 
----On long tap button callback(self, params, button_instance, time)
--- @tfield druid_event on_long_click
 
----On double tap button callback(self, params, button_instance, click_amount)
--- @tfield druid_event on_double_click
+--- The @{DruidEvent}: Event on repeated action over button.
+--
+-- This callback will be triggered if user hold the button. The repeat rate pick from `input.repeat_interval` in game.project
+-- @usage
+-- -- Custom args passed in Button constructor
+-- button.on_repeated_click:subscribe(function(self, custom_args, button_instance, click_count)
+--     print("On repeated Button click!")
+-- end)
+-- @tfield DruidEvent on_repeated_click @{DruidEvent}
 
----On button hold before long_click callback(self, params, button_instance, time)
--- @tfield druid_event on_hold_callback
 
----On click outside of button(self, params, button_instance)
--- @tfield druid_event on_click_outside
+--- The @{DruidEvent}: Event on long tap action over button.
+--
+-- This callback will be triggered if user pressed the button and hold the some amount of time.
+-- The amount of time picked from button style param: LONGTAP_TIME
+-- @usage
+-- -- Custom args passed in Button constructor
+-- button.on_long_click:subscribe(function(self, custom_args, button_instance, hold_time)
+--     print("On long Button click!")
+-- end)
+-- @tfield DruidEvent on_long_click @{DruidEvent}
 
----Trigger node
--- @tfield node node
 
----Animation node
+--- The @{DruidEvent}: Event on double tap action over button.
+--
+-- If secondary click was too fast after previous one, the double
+-- click will be called instead usual click (if on_double_click subscriber exists)
+-- @usage
+-- -- Custom args passed in Button constructor
+-- button.on_double_click:subscribe(function(self, custom_args, button_instance, click_amount)
+--     print("On double Button click!")
+-- end)
+-- @tfield DruidEvent on_double_click @{DruidEvent}
+
+
+--- The @{DruidEvent}: Event calls every frame before on_long_click event.
+--
+-- If long_click subscriber exists, the on_hold_callback will be called before long_click trigger.
+--
+-- Usecase: Animate button progress of long tap
+-- @usage
+-- -- Custom args passed in Button constructor
+-- button.on_double_click:subscribe(function(self, custom_args, button_instance, time)
+--     print("On hold Button callback!")
+-- end)
+-- @tfield DruidEvent on_hold_callback @{DruidEvent}
+
+
+--- The @{DruidEvent}: Event calls if click event was outside of button.
+--
+-- This event will be triggered for each button what was not clicked on user click action
+--
+-- Usecase: Hide the popup when click outside
+-- @usage
+-- -- Custom args passed in Button constructor
+-- button.on_click_outside:subscribe(function(self, custom_args, button_instance)
+--     print("On click Button outside!")
+-- end)
+-- @tfield DruidEvent on_click_outside @{DruidEvent}
+
+
+--- The @{DruidEvent}: Event triggered if button was pressed by user.
+-- @usage
+-- -- Custom args passed in Button constructor
+-- button.on_pressed:subscribe(function(self, custom_args, button_instance)
+--     print("On Button pressed!")
+-- end)
+-- @tfield DruidEvent on_pressed @{DruidEvent}
+
+--- Button trigger node
+-- @tfield Node node
+
+---The GUI node id from button node
+-- @tfield hash node_id
+
+--- Button animation node.
+-- In default case equals to clickable node.
+--
+-- Usecase: You have the big clickable panel, but want to animate only one small icon on it.
 -- @tfield[opt=node] node anim_node
 
----Initial scale of anim_node
--- @tfield vector3 start_scale
-
----Initial pos of anim_node
--- @tfield vector3 start_pos
-
----Initial pos of anim_node
--- @tfield vector3 pos
-
----Params to click callbacks
+---Custom args for any Button event. Setup in Button constructor
 -- @tfield any params
 
----Druid hover logic component
--- @tfield druid.hover hover
+--- The @{Hover}: Button Hover component
+-- @tfield Hover hover @{Hover}
 
----Restriction zone
+--- Additional button click area, defined by another GUI Node
 -- @tfield[opt] node click_zone
 
 ---
@@ -52,11 +141,11 @@ local const = require("druid.const")
 local helper = require("druid.helper")
 local component = require("druid.component")
 
-local Button = component.create("button", { component.ON_INPUT })
+local Button = component.create("button")
 
 
 local function is_input_match(self, action_id)
-	if action_id == const.ACTION_TOUCH then
+	if action_id == const.ACTION_TOUCH or action_id == const.ACTION_MULTITOUCH then
 		return true
 	end
 
@@ -79,10 +168,13 @@ end
 
 
 local function on_button_click(self)
-	self.style.on_click(self, self.anim_node)
-
+	if self._is_html5_mode then
+		self._is_html5_listener_set = false
+		html5.set_interaction_listener(nil)
+	end
 	self.click_in_row = 1
 	self.on_click:trigger(self:get_context(), self.params, self)
+	self.style.on_click(self, self.anim_node)
 end
 
 
@@ -92,27 +184,24 @@ local function on_button_repeated_click(self)
 		self.is_repeated_started = true
 	end
 
-	self.style.on_click(self, self.anim_node)
-
 	self.click_in_row = self.click_in_row + 1
 	self.on_repeated_click:trigger(self:get_context(), self.params, self, self.click_in_row)
+	self.style.on_click(self, self.anim_node)
 end
 
 
 local function on_button_long_click(self)
-	self.style.on_click(self, self.anim_node)
-
 	self.click_in_row = 1
 	local time = socket.gettime() - self.last_pressed_time
 	self.on_long_click:trigger(self:get_context(), self.params, self, time)
+	self.style.on_click(self, self.anim_node)
 end
 
 
 local function on_button_double_click(self)
-	self.style.on_click(self, self.anim_node)
-
 	self.click_in_row = self.click_in_row + 1
 	self.on_double_click:trigger(self:get_context(), self.params, self, self.click_in_row)
+	self.style.on_click(self, self.anim_node)
 end
 
 
@@ -126,12 +215,25 @@ local function on_button_release(self)
 		return false
 	end
 
-	if not self.disabled then
-		if self.can_action then
+	local check_function_result = true
+	if self._check_function then
+		check_function_result = self._check_function(self:get_context())
+	end
+
+	if self.disabled then
+		self.style.on_click_disabled(self, self.anim_node)
+		return true
+	elseif not check_function_result then
+		if self._failure_callback then
+			self._failure_callback(self:get_context())
+		end
+		return true
+	else
+		if self.can_action and not self._is_html5_mode then
 			self.can_action = false
 
 			local time = socket.gettime()
-			local is_long_click = (time - self.last_pressed_time) > self.style.LONGTAP_TIME
+			local is_long_click = (time - self.last_pressed_time) >= self.style.LONGTAP_TIME
 			is_long_click = is_long_click and self.on_long_click:is_exist()
 
 			local is_double_click = (time - self.last_released_time) < self.style.DOUBLETAP_TIME
@@ -148,15 +250,12 @@ local function on_button_release(self)
 			self.last_released_time = time
 		end
 		return true
-	else
-		self.style.on_click_disabled(self, self.anim_node)
-		return false
 	end
 end
 
 
 --- Component style params.
--- You can override this component styles params in druid styles table
+-- You can override this component styles params in Druid styles table
 -- or create your own style
 -- @table style
 -- @tfield[opt=0.4] number LONGTAP_TIME Minimum time to trigger on_hold_callback
@@ -181,20 +280,21 @@ function Button.on_style_change(self, style)
 end
 
 
---- Component init function
--- @tparam Button self
--- @tparam node node Gui node
--- @tparam function callback Button callback
--- @tparam[opt] table params Button callback params
--- @tparam[opt] node anim_node Button anim node (node, if not provided)
-function Button.init(self, node, callback, params, anim_node)
+--- The @{Button} constructor
+-- @tparam Button self @{Button}
+-- @tparam string|Node node Node name or GUI Node itself
+-- @tparam function callback On click button callback
+-- @tparam[opt] any custom_args Button events custom arguments
+-- @tparam[opt] string|Node anim_node Node to animate instead of trigger node.
+function Button.init(self, node, callback, custom_args, anim_node)
 	self.druid = self:get_druid()
 	self.node = self:get_node(node)
+	self.node_id = gui.get_id(self.node)
 
 	self.anim_node = anim_node and self:get_node(anim_node) or self.node
 	self.start_scale = gui.get_scale(self.anim_node)
 	self.start_pos = gui.get_position(self.anim_node)
-	self.params = params
+	self.params = custom_args
 	self.hover = self.druid:new_hover(node, on_button_hover)
 	self.hover.on_mouse_hover:subscribe(on_button_mouse_hover)
 	self.click_zone = nil
@@ -204,8 +304,14 @@ function Button.init(self, node, callback, params, anim_node)
 	self.click_in_row = 0
 	self.key_trigger = nil
 
-	-- Event stubs
+	self._check_function = nil
+	self._failure_callback = nil
+	self._is_html5_mode = false
+	self._is_html5_listener_set = false
+
+	-- Events
 	self.on_click = Event(callback)
+	self.on_pressed = Event()
 	self.on_repeated_click = Event()
 	self.on_long_click = Event()
 	self.on_double_click = Event()
@@ -214,22 +320,33 @@ function Button.init(self, node, callback, params, anim_node)
 end
 
 
+function Button.on_late_init(self)
+	if not self.click_zone and const.IS_STENCIL_CHECK then
+		local stencil_node = helper.get_closest_stencil_node(self.node)
+		if stencil_node then
+			self:set_click_zone(stencil_node)
+		end
+	end
+end
+
+
 function Button.on_input(self, action_id, action)
 	if not is_input_match(self, action_id) then
 		return false
 	end
 
-	if not helper.is_enabled(self.node) then
+	if not gui.is_enabled(self.node, true) then
+		return false
+	end
+
+	if not self:is_enabled() then
 		return false
 	end
 
 	local is_pick = true
 	local is_key_trigger = (action_id == self.key_trigger)
 	if not is_key_trigger then
-		is_pick = gui.pick_node(self.node, action.x, action.y)
-		if self.click_zone then
-			is_pick = is_pick and gui.pick_node(self.click_zone, action.x, action.y)
-		end
+		is_pick = helper.pick_node(self.node, action.x, action.y, self.click_zone)
 	end
 
 	if not is_pick then
@@ -238,6 +355,11 @@ function Button.on_input(self, action_id, action)
 		if action.released then
 			self.on_click_outside:trigger(self:get_context(), self.params, self)
 		end
+
+		if self._is_html5_mode and self._is_html5_listener_set then
+			self._is_html5_listener_set = false
+			html5.set_interaction_listener(nil)
+		end
 		return false
 	end
 
@@ -250,12 +372,20 @@ function Button.on_input(self, action_id, action)
 		self.can_action = true
 		self.is_repeated_started = false
 		self.last_pressed_time = socket.gettime()
+		self.on_pressed:trigger(self:get_context(), self.params, self)
+
+		if self._is_html5_mode then
+			self._is_html5_listener_set = true
+			html5.set_interaction_listener(function()
+				on_button_click(self)
+			end)
+		end
 		return true
 	end
 
 	-- While hold button, repeat rate pick from input.repeat_interval
 	if action.repeated then
-		if not self.disabled and self.on_repeated_click:is_exist() and self.can_action then
+		if self.on_repeated_click:is_exist() and self.can_action then
 			on_button_repeated_click(self)
 			return true
 		end
@@ -265,7 +395,7 @@ function Button.on_input(self, action_id, action)
 		return on_button_release(self)
 	end
 
-	if not self.disabled and self.can_action and self.on_long_click:is_exist() then
+	if self.can_action and self.on_long_click:is_exist() then
 		local press_time = socket.gettime() - self.last_pressed_time
 
 		if self.style.AUTOHOLD_TRIGGER <= press_time then
@@ -288,10 +418,40 @@ function Button.on_input_interrupt(self)
 end
 
 
---- Set enabled button component state
--- @tparam Button self
+function Button.on_message_input(self, node_id, message)
+	if node_id ~= self.node_id or self.disabled or not gui.is_enabled(self.node) then
+		return false
+	end
+
+	if message.action == const.MESSAGE_INPUT.BUTTON_CLICK then
+		on_button_click(self)
+	end
+
+	if message.action == const.MESSAGE_INPUT.BUTTON_LONG_CLICK then
+		on_button_long_click(self)
+	end
+
+	if message.action == const.MESSAGE_INPUT.BUTTON_DOUBLE_CLICK then
+		on_button_double_click(self)
+	end
+
+	if message.action == const.MESSAGE_INPUT.BUTTON_REPEATED_CLICK then
+		on_button_repeated_click(self)
+		self.is_repeated_started = false
+		self.last_pressed_time = socket.gettime()
+	end
+end
+
+
+--- Set button enabled state.
+-- The style.on_set_enabled will be triggered.
+-- Disabled button is not clickable.
+-- @tparam Button self @{Button}
 -- @tparam bool state Enabled state
 -- @treturn Button Current button instance
+-- @usage
+-- button:set_enabled(false)
+-- button:set_enabled(true)
 function Button.set_enabled(self, state)
 	self.disabled = not state
 	self.hover:set_enabled(state)
@@ -301,19 +461,27 @@ function Button.set_enabled(self, state)
 end
 
 
---- Return button enabled state
--- @tparam Button self
--- @treturn bool True, if button is enabled
+--- Get button enabled state.
+--
+-- By default all Buttons is enabled on creating.
+-- @tparam Button self @{Button}
+-- @treturn bool True, if button is enabled now, False overwise
+-- @usage
+-- local is_enabled = button:is_enabled()
 function Button.is_enabled(self)
 	return not self.disabled
 end
 
 
---- Strict button click area. Useful for
--- no click events outside stencil node
--- @tparam Button self
+--- Set additional button click area.
+-- Useful to restrict click outside out stencil node or scrollable content.
+--
+-- This functions calls automatically if you don't disable it in game.project: druid.no_stencil_check
+-- @tparam Button self @{Button}
 -- @tparam node zone Gui node
 -- @treturn Button Current button instance
+-- @usage
+-- button:set_click_zone("stencil_node")
 function Button.set_click_zone(self, zone)
 	self.click_zone = self:get_node(zone)
 	self.hover:set_click_zone(zone)
@@ -322,10 +490,12 @@ function Button.set_click_zone(self, zone)
 end
 
 
---- Set key-code to trigger this button
--- @tparam Button self
--- @tparam hash key The action_id of the key
+--- Set key name to trigger this button by keyboard.
+-- @tparam Button self @{Button}
+-- @tparam hash key The action_id of the input key
 -- @treturn Button Current button instance
+-- @usage
+-- button:set_key_trigger("key_space")
 function Button.set_key_trigger(self, key)
 	self.key_trigger = hash(key)
 
@@ -333,12 +503,42 @@ function Button.set_key_trigger(self, key)
 end
 
 
---- Get key-code to trigger this button
+--- Get current key name to trigger this button.
 -- @tparam Button self
--- @treturn hash The action_id of the key
+-- @treturn hash The action_id of the input key
+-- @usage
+-- local key_hash = button:get_key_trigger()
 function Button.get_key_trigger(self)
 	return self.key_trigger
 end
 
 
+--- Set function for additional check for button click availability
+-- @tparam Button self
+-- @tparam[opt] function check_function Should return true or false. If true - button can be pressed.
+-- @tparam[opt] function failure_callback Function will be called on button click, if check function return false
+-- @treturn Button Current button instance
+function Button.set_check_function(self, check_function, failure_callback)
+	self._check_function = check_function
+	self._failure_callback = failure_callback
+end
+
+
+--- Set Button mode to work inside user HTML5 interaction event.
+--
+-- It's required to make protected things like copy & paste text, show mobile keyboard, etc
+-- The HTML5 button's doesn't call any events except on_click event.
+--
+-- If the game is not HTML, html mode will be not enabled
+-- @tparam Button self
+-- @tparam[opt] boolean is_web_mode If true - button will be called inside html5 callback
+-- @treturn Button Current button instance
+-- @usage
+-- button:set_web_user_interaction(true)
+function Button.set_web_user_interaction(self, is_web_mode)
+	self._is_html5_mode = not not (is_web_mode and html5)
+	return self
+end
+
+
 return Button

druid/base/drag.lua

@@ -1,25 +1,29 @@
+-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
+
 --- Component to handle drag action on node.
 -- Drag have correct handling for multitouch and swap
 -- touched while dragging. Drag will be processed even
 -- the cursor is outside of node, if drag is already started
+--
+-- <a href="https://insality.github.io/druid/druid/index.html?example=general_drag" target="_blank"><b>Example Link</b></a>
 -- @module Drag
 -- @within BaseComponent
 -- @alias druid.drag
 
 --- Event on touch start callback(self)
--- @tfield druid_event on_touch_start
+-- @tfield DruidEvent on_touch_start @{DruidEvent}
 
 --- Event on touch end callback(self)
--- @tfield druid_event on_touch_end
+-- @tfield DruidEvent on_touch_end @{DruidEvent}
 
 --- Event on drag start callback(self)
--- @tfield druid_event on_drag_start
+-- @tfield DruidEvent on_drag_start @{DruidEvent}
 
---- on drag progress callback(self, dx, dy)
--- @tfield druid_event on_drag Event
+--- on drag progress callback(self, dx, dy, total_x, total_y)
+-- @tfield DruidEvent on_drag Event @{DruidEvent}
 
---- Event on drag end callback(self)
--- @tfield druid_event on_drag_end
+--- Event on drag end callback(self, total_x, total_y)
+-- @tfield DruidEvent on_drag_end @{DruidEvent}
 
 --- Is component now touching
 -- @tfield bool is_touch
@@ -49,7 +53,7 @@ local const = require("druid.const")
 local helper = require("druid.helper")
 local component = require("druid.component")
 
-local Drag = component.create("drag", { component.ON_INPUT }, const.PRIORITY_INPUT_HIGH)
+local Drag = component.create("drag", const.PRIORITY_INPUT_HIGH)
 
 
 local function start_touch(self, touch)
@@ -61,6 +65,7 @@ local function start_touch(self, touch)
 
 	self.x = touch.x
 	self.y = touch.y
+	self._scene_scale = helper.get_scene_scale(self.node)
 
 	self.on_touch_start:trigger(self:get_context())
 end
@@ -68,7 +73,11 @@ end
 
 local function end_touch(self)
 	if self.is_drag then
-		self.on_drag_end:trigger(self:get_context())
+		self.on_drag_end:trigger(
+			self:get_context(),
+			self.x - self.touch_start_pos.x,
+			self.y - self.touch_start_pos.y
+		)
 	end
 
 	self.is_drag = false
@@ -94,7 +103,7 @@ local function process_touch(self, touch)
 	if not self.is_drag and distance >= self.style.DRAG_DEADZONE then
 		self.is_drag = true
 		self.on_drag_start:trigger(self:get_context())
-		self:set_input_priority(const.PRIORITY_INPUT_MAX)
+		self:set_input_priority(const.PRIORITY_INPUT_MAX, true)
 	end
 end
 
@@ -153,14 +162,16 @@ end
 -- or create your own style
 -- @table style
 -- @tfield[opt=10] number DRAG_DEADZONE Distance in pixels to start dragging
+-- @tfield[opt=false] boolean NO_USE_SCREEN_KOEF If screen aspect ratio affects on drag values
 function Drag.on_style_change(self, style)
 	self.style = {}
 	self.style.DRAG_DEADZONE = style.DRAG_DEADZONE or 10
+	self.style.NO_USE_SCREEN_KOEF = style.NO_USE_SCREEN_KOEF or false
 end
 
 
 --- Drag component constructor
--- @tparam Drag self
+-- @tparam Drag self @{Drag}
 -- @tparam node node GUI node to detect dragging
 -- @tparam function on_drag_callback Callback for on_drag_event(self, dx, dy)
 function Drag.init(self, node, on_drag_callback)
@@ -174,16 +185,39 @@ function Drag.init(self, node, on_drag_callback)
 	self.is_touch = false
 	self.is_drag = false
 	self.touch_start_pos = vmath.vector3(0)
+	self._is_enabled = true
 
 	self.can_x = true
 	self.can_y = true
 
+	self._scene_scale = helper.get_scene_scale(self.node)
+
 	self.click_zone = nil
 	self.on_touch_start = Event()
 	self.on_touch_end = Event()
 	self.on_drag_start = Event()
 	self.on_drag = Event(on_drag_callback)
 	self.on_drag_end = Event()
+
+	self:on_window_resized()
+end
+
+
+function Drag.on_late_init(self)
+	if not self.click_zone and const.IS_STENCIL_CHECK then
+		local stencil_node = helper.get_closest_stencil_node(self.node)
+		if stencil_node then
+			self:set_click_zone(stencil_node)
+		end
+	end
+end
+
+
+function Drag.on_window_resized(self)
+	local x_koef, y_koef = helper.get_screen_aspect_koef()
+	self._x_koef = x_koef
+	self._y_koef = y_koef
+	self._scene_scale = helper.get_scene_scale(self.node)
 end
 
 
@@ -199,15 +233,11 @@ function Drag.on_input(self, action_id, action)
 		return false
 	end
 
-	if not helper.is_enabled(self.node) then
+	if not self._is_enabled or not gui.is_enabled(self.node, true) then
 		return false
 	end
 
-	local is_pick = gui.pick_node(self.node, action.x, action.y)
-	if self.click_zone then
-		is_pick = is_pick and gui.pick_node(self.click_zone, action.x, action.y)
-	end
-
+	local is_pick = helper.pick_node(self.node, action.x, action.y, self.click_zone)
 	if not is_pick and not self.is_drag then
 		end_touch(self)
 		return false
@@ -256,7 +286,16 @@ function Drag.on_input(self, action_id, action)
 	end
 
 	if self.is_drag then
-		self.on_drag:trigger(self:get_context(), self.dx, self.dy)
+		local x_koef, y_koef = self._x_koef, self._y_koef
+		if self.style.NO_USE_SCREEN_KOEF then
+			x_koef, y_koef = 1, 1
+		end
+
+		self.on_drag:trigger(self:get_context(),
+			self.dx * x_koef / self._scene_scale.x,
+			self.dy * y_koef / self._scene_scale.y,
+			(self.x - self.touch_start_pos.x) * x_koef / self._scene_scale.x,
+			(self.y - self.touch_start_pos.y) * y_koef / self._scene_scale.y)
 	end
 
 	return self.is_drag
@@ -265,11 +304,27 @@ end
 
 --- Strict drag click area. Useful for
 -- restrict events outside stencil node
--- @tparam Drag self
+-- @tparam Drag self @{Drag}
 -- @tparam node node Gui node
 function Drag.set_click_zone(self, node)
 	self.click_zone = self:get_node(node)
 end
 
 
+--- Set Drag input enabled or disabled
+-- @tparam Drag self @{Drag}
+-- @tparam bool is_enabled
+function Drag.set_enabled(self, is_enabled)
+	self._is_enabled = is_enabled
+end
+
+
+--- Check if Drag component is enabled
+-- @tparam Drag self @{Drag}
+-- @treturn bool
+function Drag.is_enabled(self)
+	return self._is_enabled
+end
+
+
 return Drag

druid/base/hover.lua

@@ -1,13 +1,15 @@
+-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
+
 --- Component to handle hover node interaction
 -- @module Hover
 -- @within BaseComponent
 -- @alias druid.hover
 
---- On hover callback(self, state)
--- @tfield druid_event on_hover
+--- On hover callback(self, state, hover_instance)
+-- @tfield DruidEvent on_hover @{DruidEvent}
 
---- On mouse hover callback(self, state)
--- @tfield druid_event on_mouse_hover
+--- On mouse hover callback(self, state, hover_instance)
+-- @tfield DruidEvent on_mouse_hover @{DruidEvent}
 
 ---
 
@@ -16,11 +18,11 @@ local const = require("druid.const")
 local helper = require("druid.helper")
 local component = require("druid.component")
 
-local Hover = component.create("hover", { component.ON_INPUT })
+local Hover = component.create("hover")
 
 
 --- Component init function
--- @tparam Hover self
+-- @tparam Hover self @{Hover}
 -- @tparam node node Gui node
 -- @tparam function on_hover_callback Hover callback
 function Hover.init(self, node, on_hover_callback)
@@ -36,6 +38,16 @@ function Hover.init(self, node, on_hover_callback)
 end
 
 
+function Hover.on_late_init(self)
+	if not self.click_zone and const.IS_STENCIL_CHECK then
+		local stencil_node = helper.get_closest_stencil_node(self.node)
+		if stencil_node then
+			self:set_click_zone(stencil_node)
+		end
+	end
+end
+
+
 function Hover.on_input(self, action_id, action)
 	if action_id ~= const.ACTION_TOUCH and action_id ~= nil then
 		return false
@@ -46,17 +58,13 @@ function Hover.on_input(self, action_id, action)
 		return false
 	end
 
-	if not helper.is_enabled(self.node) or not self._is_enabled then
+	if not gui.is_enabled(self.node, true) or not self._is_enabled then
 		self:set_hover(false)
 		self:set_mouse_hover(false)
 		return false
 	end
 
-	local is_pick = gui.pick_node(self.node, action.x, action.y)
-	if self.click_zone then
-		is_pick = is_pick and gui.pick_node(self.click_zone, action.x, action.y)
-	end
-
+	local is_pick = helper.pick_node(self.node, action.x, action.y, self.click_zone)
 	local hover_function = action_id and self.set_hover or self.set_mouse_hover
 
 	if not is_pick then
@@ -69,6 +77,8 @@ function Hover.on_input(self, action_id, action)
 	else
 		hover_function(self, true)
 	end
+
+	return false
 end
 
 
@@ -78,29 +88,46 @@ end
 
 
 --- Set hover state
--- @tparam Hover self
+-- @tparam Hover self @{Hover}
 -- @tparam bool state The hover state
 function Hover.set_hover(self, state)
 	if self._is_hovered ~= state then
 		self._is_hovered = state
-		self.on_hover:trigger(self:get_context(), state)
+		self.on_hover:trigger(self:get_context(), state, self)
 	end
 end
 
+
+--- Return current hover state. True if touch action was on the node at current time
+-- @tparam Hover self @{Hover}
+-- @treturn bool The current hovered state
+function Hover.is_hovered(self)
+	return self._is_hovered
+end
+
+
 --- Set mouse hover state
--- @tparam Hover self
+-- @tparam Hover self @{Hover}
 -- @tparam bool state The mouse hover state
 function Hover.set_mouse_hover(self, state)
 	if self._is_mouse_hovered ~= state then
 		self._is_mouse_hovered = state
-		self.on_mouse_hover:trigger(self:get_context(), state)
+		self.on_mouse_hover:trigger(self:get_context(), state, self)
 	end
 end
 
 
+--- Return current hover state. True if nil action_id (usually desktop mouse) was on the node at current time
+-- @tparam Hover self @{Hover}
+-- @treturn bool The current hovered state
+function Hover.is_mouse_hovered(self)
+	return self._is_mouse_hovered
+end
+
+
 --- Strict hover click area. Useful for
 -- no click events outside stencil node
--- @tparam Hover self
+-- @tparam Hover self @{Hover}
 -- @tparam node zone Gui node
 function Hover.set_click_zone(self, zone)
 	self.click_zone = self:get_node(zone)
@@ -110,7 +137,7 @@ end
 --- Set enable state of hover component.
 -- If hover is not enabled, it will not generate
 -- any hover events
--- @tparam Hover self
+-- @tparam Hover self @{Hover}
 -- @tparam bool state The hover enabled state
 function Hover.set_enabled(self, state)
 	self._is_enabled = state
@@ -127,7 +154,7 @@ end
 
 
 --- Return current hover enabled state
--- @tparam Hover self
+-- @tparam Hover self @{Hover}
 -- @treturn bool The hover enabled state
 function Hover.is_enabled(self)
 	return self._is_enabled

druid/base/scroll.lua

@@ -1,23 +1,51 @@
+-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
+
 --- Component to handle scroll content.
--- Scroll consist from two nodes: scroll parent and scroll input
--- Scroll input the user input zone, it's static
--- Scroll parent the scroll moving part, it will change position.
--- Setup initial scroll size by changing scroll parent size. If scroll parent
--- size will be less than scroll_input size, no scroll is available. For scroll
--- parent size should be more than input size
+-- <b># Overview #</b>
+--
+-- The Scroll component is designed to handle scrollable content and consists of two nodes: the scroll parent and the scroll input.
+--
+-- The scroll input represents the user input zone and remains static.
+--
+-- The scroll parent is the movable part of the scroll and changes its position.
+--
+-- The initial scroll size can be set by adjusting the size of the scroll parent.
+-- If the size of the scroll parent is smaller than the scroll input size, scrolling is not available.
+--
+-- <b># Notes #</b>
+--
+-- • By default, the scroll style includes inertia and extra size for a stretching effect.
+-- These settings can be adjusted using the scroll style settings.
+-- For more details, refer to the scroll style settings.
+--
+-- • "Points of interest" can be set up for the scroll.
+-- The scroll will always be centered on the closest point of interest.
+-- This feature allows creating a slider without inertia and with points of interest on each scroll element.
+--
+-- • The scroll content size can be adjusted using the scroll:set_size(node_size) method.
+-- This method sets a new size for the _content node.
+--
+-- • Inertial scrolling mode can be enabled or disabled using the scroll:set_inert(state) method.
+--
+-- • The extra stretch size can be adjusted using the scroll:set_extra_stretch_size method.
+--
+-- • Multitouch is required for scrolling. The scroll component correctly handles
+-- touch ID swaps while dragging the scroll.
+--
+-- <a href="https://insality.github.io/druid/druid/index.html?example=general_scroll" target="_blank"><b>Example Link</b></a>
 -- @module Scroll
 -- @within BaseComponent
 -- @alias druid.scroll
 
 
 --- On scroll move callback(self, position)
--- @tfield druid_event on_scroll
+-- @tfield DruidEvent on_scroll @{DruidEvent}
 
 --- On scroll_to function callback(self, target, is_instant)
--- @tfield druid_event on_scroll_to
+-- @tfield DruidEvent on_scroll_to @{DruidEvent}
 
 --- On scroll_to_index function callback(self, index, point)
--- @tfield druid_event on_point_scroll
+-- @tfield DruidEvent on_point_scroll @{DruidEvent}
 
 --- Scroll view node
 -- @tfield node view_node
@@ -44,7 +72,7 @@
 -- @tfield vector3 available_size
 
 --- Drag Druid component
--- @tfield Drag drag
+-- @tfield Drag drag @{Drag}
 
 --- Current index of points of interests
 -- @tfield[opt] number selected
@@ -59,7 +87,7 @@ local const = require("druid.const")
 local helper = require("druid.helper")
 local component = require("druid.component")
 
-local Scroll = component.create("scroll", { component.ON_INPUT, component.ON_UPDATE, component.ON_LAYOUT_CHANGE })
+local Scroll = component.create("scroll")
 
 
 local function inverse_lerp(min, max, current)
@@ -106,6 +134,7 @@ end
 -- @tfield[opt=false] bool SMALL_CONTENT_SCROLL If true, content node with size less than view node size can be scrolled
 -- @tfield[opt=0] bool WHEEL_SCROLL_SPEED The scroll speed via mouse wheel scroll or touchpad. Set to 0 to disable wheel scrolling
 -- @tfield[opt=false] bool WHEEL_SCROLL_INVERTED If true, invert direction for touchpad and mouse wheel scroll
+-- @tfield[opt=false] bool WHEEL_SCROLL_BY_INERTION If true, wheel will add inertion to scroll. Direct set position otherwise.
 function Scroll.on_style_change(self, style)
 	self.style = {}
 	self.style.EXTRA_STRETCH_SIZE = style.EXTRA_STRETCH_SIZE or 0
@@ -121,6 +150,7 @@ function Scroll.on_style_change(self, style)
 	self.style.SMALL_CONTENT_SCROLL = style.SMALL_CONTENT_SCROLL or false
 	self.style.WHEEL_SCROLL_SPEED = style.WHEEL_SCROLL_SPEED or 0
 	self.style.WHEEL_SCROLL_INVERTED = style.WHEEL_SCROLL_INVERTED or false
+	self.style.WHEEL_SCROLL_BY_INERTION = style.WHEEL_SCROLL_BY_INERTION or false
 
 	self._is_inert = not (self.style.FRICT == 0 or
 		self.style.FRICT_HOLD == 0 or
@@ -128,17 +158,18 @@ function Scroll.on_style_change(self, style)
 end
 
 
---- Scroll constructor
--- @tparam Scroll self
--- @tparam node view_node GUI view scroll node
--- @tparam node content_node GUI content scroll node
+--- @{Scroll} constructor
+-- @tparam Scroll self @{Scroll}
+-- @tparam string|node view_node GUI view scroll node
+-- @tparam string|node content_node GUI content scroll node
 function Scroll.init(self, view_node, content_node)
 	self.druid = self:get_druid()
 
 	self.view_node = self:get_node(view_node)
+	self.view_border = helper.get_border(self.view_node)
 	self.content_node = self:get_node(content_node)
 
-	self.view_size = vmath.mul_per_elem(gui.get_size(self.view_node), gui.get_scale(self.view_node))
+	self.view_size = helper.get_scaled_size(self.view_node)
 
 	self.position = gui.get_position(self.content_node)
 	self.target_position = vmath.vector3(self.position)
@@ -164,20 +195,27 @@ function Scroll.init(self, view_node, content_node)
 	self._is_vertical_scroll = true
 	self._grid_on_change = nil
 	self._grid_on_change_callback = nil
-	self._outside_offset_vector = vmath.vector3(0)
 
 	self:_update_size()
 end
 
 
+function Scroll.on_late_init(self)
+	if not self.click_zone and const.IS_STENCIL_CHECK then
+		local stencil_node = helper.get_closest_stencil_node(self.node)
+		if stencil_node then
+			self:set_click_zone(stencil_node)
+		end
+	end
+end
+
+
 function Scroll.on_layout_change(self)
 	gui.set_position(self.content_node, self.position)
 end
 
 
 function Scroll.update(self, dt)
-	self:_update_params()
-
 	if self.drag.is_drag then
 		self:_update_hand_scroll(dt)
 	else
@@ -197,7 +235,7 @@ end
 
 
 --- Start scroll to target point.
--- @tparam Scroll self
+-- @tparam Scroll self @{Scroll}
 -- @tparam vector3 point Target point
 -- @tparam[opt] bool is_instant Instant scroll flag
 -- @usage scroll:scroll_to(vmath.vector3(0, 50, 0))
@@ -231,7 +269,7 @@ end
 
 
 --- Scroll to item in scroll by point index.
--- @tparam Scroll self
+-- @tparam Scroll self @{Scroll}
 -- @tparam number index Point index
 -- @tparam[opt] bool skip_cb If true, skip the point callback
 function Scroll.scroll_to_index(self, index, skip_cb)
@@ -254,7 +292,7 @@ end
 
 
 --- Start scroll to target scroll percent
--- @tparam Scroll self
+-- @tparam Scroll self @{Scroll}
 -- @tparam vector3 percent target percent
 -- @tparam[opt] bool is_instant instant scroll flag
 -- @usage scroll:scroll_to_percent(vmath.vector3(0.5, 0, 0))
@@ -263,7 +301,7 @@ function Scroll.scroll_to_percent(self, percent, is_instant)
 
 	local pos = vmath.vector3(
 		-helper.lerp(border.x, border.z, 1 - percent.x),
-		-helper.lerp(border.w, border.y, 1 - percent.y),
+		-helper.lerp(border.y, border.w, 1 - percent.y),
 		0
 	)
 
@@ -273,7 +311,7 @@ end
 
 --- Return current scroll progress status.
 -- Values will be in [0..1] interval
--- @tparam Scroll self
+-- @tparam Scroll self @{Scroll}
 -- @treturn vector3 New vector with scroll progress values
 function Scroll.get_percent(self)
 	local x_perc = 1 - inverse_lerp(self.available_pos.x, self.available_pos.z, self.position.x)
@@ -285,7 +323,7 @@ end
 
 --- Set scroll content size.
 -- It will change content gui node size
--- @tparam Scroll self
+-- @tparam Scroll self @{Scroll}
 -- @tparam vector3 size The new size for content node
 -- @tparam vector3 offset Offset value to set, where content is starts
 -- @treturn druid.scroll Current scroll instance
@@ -303,7 +341,7 @@ end
 --- Enable or disable scroll inert.
 -- If disabled, scroll through points (if exist)
 -- If no points, just simple drag without inertion
--- @tparam Scroll self
+-- @tparam Scroll self @{Scroll}
 -- @tparam bool state Inert scroll state
 -- @treturn druid.scroll Current scroll instance
 function Scroll.set_inert(self, state)
@@ -314,7 +352,7 @@ end
 
 
 --- Return if scroll have inertion.
--- @tparam Scroll self
+-- @tparam Scroll self @{Scroll}
 -- @treturn bool If scroll have inertion
 function Scroll.is_inert(self)
 	return self._is_inert
@@ -323,7 +361,7 @@ end
 
 --- Set extra size for scroll stretching.
 -- Set 0 to disable stretching effect
--- @tparam Scroll self
+-- @tparam Scroll self @{Scroll}
 -- @tparam[opt=0] number stretch_size Size in pixels of additional scroll area
 -- @treturn druid.scroll Current scroll instance
 function Scroll.set_extra_stretch_size(self, stretch_size)
@@ -335,7 +373,7 @@ end
 
 
 --- Return vector of scroll size with width and height.
--- @tparam Scroll self
+-- @tparam Scroll self @{Scroll}
 -- @treturn vector3 Available scroll size
 function Scroll.get_scroll_size(self)
 	return self.available_size
@@ -344,7 +382,7 @@ end
 
 --- Set points of interest.
 -- Scroll will always centered on closer points
--- @tparam Scroll self
+-- @tparam Scroll self @{Scroll}
 -- @tparam table points Array of vector3 points
 -- @treturn druid.scroll Current scroll instance
 function Scroll.set_points(self, points)
@@ -361,7 +399,7 @@ end
 
 
 --- Lock or unlock horizontal scroll
--- @tparam Scroll self
+-- @tparam Scroll self @{Scroll}
 -- @tparam bool state True, if horizontal scroll is enabled
 -- @treturn druid.scroll Current scroll instance
 function Scroll.set_horizontal_scroll(self, state)
@@ -372,7 +410,7 @@ end
 
 
 --- Lock or unlock vertical scroll
--- @tparam Scroll self
+-- @tparam Scroll self @{Scroll}
 -- @tparam bool state True, if vertical scroll is enabled
 -- @treturn druid.scroll Current scroll instance
 function Scroll.set_vertical_scroll(self, state)
@@ -384,20 +422,38 @@ end
 
 --- Check node if it visible now on scroll.
 -- Extra border is not affected. Return true for elements in extra scroll zone
--- @tparam Scroll self
+-- @tparam Scroll self @{Scroll}
 -- @tparam node node The node to check
 -- @treturn boolean True if node in visible scroll area
 function Scroll.is_node_in_view(self, node)
-	local node_border = helper.get_border(node, gui.get_position(node))
-	local view_border = helper.get_border(self.view_node, -(self.position - self._outside_offset_vector))
+	local node_offset_for_view = gui.get_position(node)
+	local parent = gui.get_parent(node)
+	local is_parent_of_view = false
+	while parent do
+		if parent ~= self.view_node then
+			local parent_pos = gui.get_position(parent)
+			node_offset_for_view.x = node_offset_for_view.x + parent_pos.x
+			node_offset_for_view.y = node_offset_for_view.y + parent_pos.y
+			parent = gui.get_parent(parent)
+		else
+			is_parent_of_view = true
+			parent = nil
+		end
+	end
+	if not is_parent_of_view then
+		error("The node to check is_node_in_view should be child if scroll view")
+		return false
+	end
+
+	local node_border = helper.get_border(node, node_offset_for_view)
 
 	-- Check is vertical outside (Left or Right):
-	if node_border.z < view_border.x or node_border.x > view_border.z then
+	if node_border.z < self.view_border.x or node_border.x > self.view_border.z then
 		return false
 	end
 
 	-- Check is horizontal outside (Up or Down):
-	if node_border.w > view_border.y or node_border.y < view_border.w then
+	if node_border.w > self.view_border.y or node_border.y < self.view_border.w then
 		return false
 	end
 
@@ -407,7 +463,7 @@ end
 
 --- Bind the grid component (Static or Dynamic) to recalculate
 -- scroll size on grid changes
--- @tparam Scroll self
+-- @tparam Scroll self @{Scroll}
 -- @tparam StaticGrid|DynamicGrid grid Druid grid component
 -- @treturn druid.scroll Current scroll instance
 function Scroll.bind_grid(self, grid)
@@ -424,7 +480,9 @@ function Scroll.bind_grid(self, grid)
 
 	self._grid_on_change = grid.on_change_items
 	self._grid_on_change_callback = self._grid_on_change:subscribe(function()
-		self:set_size(grid:get_size(), grid:get_offset())
+		local size = grid:get_size()
+		local offset = grid:get_offset()
+		self:set_size(size, offset)
 	end)
 	self:set_size(grid:get_size(), grid:get_offset())
 
@@ -510,8 +568,11 @@ function Scroll._check_soft_zone(self)
 end
 
 
---- Cancel animation on other animation or input touch
+-- Cancel animation on other animation or input touch
 function Scroll._cancel_animate(self)
+	self.inertion.x = 0
+	self.inertion.y = 0
+
 	if self.is_animate then
 		self.target_position = gui.get_position(self.content_node)
 		self.position.x = self.target_position.x
@@ -530,8 +591,7 @@ function Scroll._set_scroll_position(self, position)
 	if self.position.x ~= position.x or self.position.y ~= position.y then
 		self.position.x = position.x
 		self.position.y = position.y
-		self:_update_params()
-		gui.set_position(self.content_node, position)
+		gui.set_position(self.content_node, self.position)
 
 		self.on_scroll:trigger(self:get_context(), self.position)
 	end
@@ -597,11 +657,11 @@ end
 function Scroll._check_threshold(self)
 	local is_stopped = false
 
-	if math.abs(self.inertion.x) < self.style.INERT_THRESHOLD then
+	if self.drag.can_x and math.abs(self.inertion.x) < self.style.INERT_THRESHOLD then
 		is_stopped = true
 		self.inertion.x = 0
 	end
-	if math.abs(self.inertion.y) < self.style.INERT_THRESHOLD then
+	if self.drag.can_y and math.abs(self.inertion.y) < self.style.INERT_THRESHOLD then
 		is_stopped = true
 		self.inertion.y = 0
 	end
@@ -658,12 +718,10 @@ end
 
 
 function Scroll._update_size(self)
-	local view_border = helper.get_border(self.view_node)
-
 	local content_border = helper.get_border(self.content_node)
-	local content_size = vmath.mul_per_elem(gui.get_size(self.content_node), gui.get_scale(self.content_node))
+	local content_size = helper.get_scaled_size(self.content_node)
 
-	self.available_pos = get_border_vector(view_border - content_border, self._offset)
+	self.available_pos = get_border_vector(self.view_border - content_border, self._offset)
 	self.available_size = get_size_vector(self.available_pos)
 
 	self.drag.can_x = self.available_size.x > 0 and self._is_horizontal_scroll
@@ -675,24 +733,20 @@ function Scroll._update_size(self)
 	local content_border_extra = helper.get_border(self.content_node)
 	local stretch_size = self.style.EXTRA_STRETCH_SIZE
 
-	if self.drag.can_x then
-		local sign = content_size.x > self.view_size.x and 1 or -1
-		content_border_extra.x = content_border_extra.x - stretch_size * sign
-		content_border_extra.z = content_border_extra.z + stretch_size * sign
-	end
+	local sign_x = content_size.x > self.view_size.x and 1 or -1
+	content_border_extra.x = content_border_extra.x - stretch_size * sign_x
+	content_border_extra.z = content_border_extra.z + stretch_size * sign_x
 
-	if self.drag.can_y then
-		local sign = content_size.y > self.view_size.y and 1 or -1
-		content_border_extra.y = content_border_extra.y + stretch_size * sign
-		content_border_extra.w = content_border_extra.w - stretch_size * sign
-	end
+	local sign_y = content_size.y > self.view_size.y and 1 or -1
+	content_border_extra.y = content_border_extra.y + stretch_size * sign_y
+	content_border_extra.w = content_border_extra.w - stretch_size * sign_y
 
 	if not self.style.SMALL_CONTENT_SCROLL then
 		self.drag.can_x = content_size.x > self.view_size.x
 		self.drag.can_y = content_size.y > self.view_size.y
 	end
 
-	self.available_pos_extra = get_border_vector(view_border - content_border_extra, self._offset)
+	self.available_pos_extra = get_border_vector(self.view_border - content_border_extra, self._offset)
 	self.available_size_extra = get_size_vector(self.available_pos_extra)
 
 	self:_set_scroll_position(self.position)
@@ -701,32 +755,6 @@ function Scroll._update_size(self)
 end
 
 
-function Scroll._update_params(self)
-	local t = self.target_position
-	local b = self.available_pos
-
-	self._outside_offset_vector.x = 0
-	self._outside_offset_vector.y = 0
-
-	-- Right border (minimum x)
-	if t.x < b.x then
-		self._outside_offset_vector.x = t.x - b.x
-	end
-	-- Left border (maximum x)
-	if t.x > b.z then
-		self._outside_offset_vector.x = t.x - b.z
-	end
-	-- Top border (minimum y)
-	if t.y < b.y then
-		self._outside_offset_vector.y = t.y - b.y
-	end
-	-- Bot border (maximum y)
-	if t.y > b.w then
-		self._outside_offset_vector.y = t.y - b.w
-	end
-end
-
-
 function Scroll._process_scroll_wheel(self, action_id, action)
 	if not self._is_mouse_hover or self.style.WHEEL_SCROLL_SPEED == 0 then
 		return false
@@ -741,10 +769,22 @@ function Scroll._process_scroll_wheel(self, action_id, action)
 		koef = -koef
 	end
 
-	if self.drag.can_y then
-		self.inertion.y = (self.inertion.y + self.style.WHEEL_SCROLL_SPEED * koef) * self.style.FRICT_HOLD
+	if self.style.WHEEL_SCROLL_BY_INERTION then
+		if self.drag.can_y then
+			self.inertion.y = (self.inertion.y + self.style.WHEEL_SCROLL_SPEED * koef) * self.style.FRICT_HOLD
+		elseif self.drag.can_x then
+			self.inertion.x = (self.inertion.x + self.style.WHEEL_SCROLL_SPEED * koef) * self.style.FRICT_HOLD
+		end
 	else
-		self.inertion.x = (self.inertion.x + self.style.WHEEL_SCROLL_SPEED * koef) * self.style.FRICT_HOLD
+		if self.drag.can_y then
+			self.target_position.y = self.target_position.y + self.style.WHEEL_SCROLL_SPEED * koef
+			self.inertion.y = 0
+		elseif self.drag.can_x then
+			self.target_position.x = self.target_position.x + self.style.WHEEL_SCROLL_SPEED * koef
+			self.inertion.x = 0
+		end
+
+		self:_set_scroll_position(self.target_position)
 	end
 
 	return true

druid/base/static_grid.lua

@@ -1,23 +1,55 @@
---- Component to handle placing components by row and columns.
--- Grid can anchor your elements, get content size and other
+-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
+
+--- Component to handle component's position by row and columns.
+-- <b># Overview #</b>
+--
+-- The Static Grid component allows for positioning components in rows and columns.
+-- It provides a static grid layout with constant node sizes, allowing for pre-calculated
+-- node positions and the option to include gaps between nodes.
+--
+-- <b># Notes #</b>
+--
+-- • In a static grid, the node size remains constant, enabling the calculation of node
+-- positions before placement. If you want add gaps between nodes, increase the root prefab size,
+-- including the padding and margin.
+--
+-- • The static grid can automatically shift elements when nodes are added or removed.
+--
+-- • When a node is added, the grid will set the node's parent to the specified parent_node.
+--
+-- • You can obtain an array of positions for each element, which can be used to set
+-- points of interest in a scroll component.
+--
+-- • The size of all elements can be retrieved for setting up the size in a scroll component.
+--
+-- • The grid can be bound to a scroll component for automatic resizing of the scroll content size.
+--
+-- • The pivot of the parent_node affects the node placement within the grid.
+--
+-- • A prefab node is used to determine the node size and anchor.
+--
+-- • You can specify a position_function for animations using the
+-- _static_grid:set_position_function(node, pos) callback. The default position function is gui.set_position().
+--
+-- <a href="https://insality.github.io/druid/druid/index.html?example=general_grid" target="_blank"><b>Example Link</b></a>
 -- @module StaticGrid
 -- @within BaseComponent
 -- @alias druid.static_grid
 
 --- On item add callback(self, node, index)
--- @tfield druid_event on_add_item
+-- @tfield DruidEvent on_add_item @{DruidEvent}
 
 --- On item remove callback(self, index)
--- @tfield druid_event on_remove_item
+-- @tfield DruidEvent on_remove_item @{DruidEvent}
 
---- On item add or remove callback(self, index)
--- @tfield druid_event on_change_items
+--- On item add, remove or change in_row callback(self, index|nil)
+-- @tfield DruidEvent on_change_items @{DruidEvent}
 
 --- On grid clear callback(self)
--- @tfield druid_event on_clear
+-- @tfield DruidEvent on_clear @{DruidEvent}
 
 --- On update item positions callback(self)
--- @tfield druid_event on_update_positions
+-- @tfield DruidEvent on_update_positions @{DruidEvent}
 
 --- Parent gui node
 -- @tfield node parent
@@ -31,9 +63,12 @@
 --- The last index of node in grid
 -- @tfield number last_index
 
---- Item anchor
+--- Item anchor [0..1]
 -- @tfield vector3 anchor
 
+--- Item pivot [-0.5..0.5]
+-- @tfield vector3 pivot
+
 --- Item size
 -- @tfield vector3 node_size
 
@@ -47,7 +82,7 @@ local Event = require("druid.event")
 local helper = require("druid.helper")
 local component = require("druid.component")
 
-local StaticGrid = component.create("static_grid", { component.ON_LAYOUT_CHANGE })
+local StaticGrid = component.create("static_grid")
 
 
 local function _extend_border(border, pos, size, pivot)
@@ -63,9 +98,22 @@ local function _extend_border(border, pos, size, pivot)
 end
 
 
---- Component init function
--- @tparam StaticGrid self
--- @tparam node parent The gui node parent, where items will be placed
+--- Component style params.
+-- You can override this component styles params in druid styles table
+-- or create your own style
+-- @table style
+-- @tfield[opt=false] bool IS_DYNAMIC_NODE_POSES If true, always center grid content as grid pivot sets
+-- @tfield[opt=false] bool IS_ALIGN_LAST_ROW If true, always align last row of the grid as grid pivot sets
+function StaticGrid.on_style_change(self, style)
+	self.style = {}
+	self.style.IS_DYNAMIC_NODE_POSES = style.IS_DYNAMIC_NODE_POSES or false
+	self.style.IS_ALIGN_LAST_ROW = style.IS_ALIGN_LAST_ROW or false
+end
+
+
+--- The @{StaticGrid} constructor
+-- @tparam StaticGrid self @{StaticGrid}
+-- @tparam string|Node parent The GUI Node container, where grid's items will be placed
 -- @tparam node element Element prefab. Need to get it size
 -- @tparam[opt=1] number in_row How many nodes in row can be placed
 function StaticGrid.init(self, parent, element, in_row)
@@ -89,7 +137,6 @@ function StaticGrid.init(self, parent, element, in_row)
 
 	self.border = vmath.vector4(0) -- Current grid content size
 
-
 	self.on_add_item = Event()
 	self.on_remove_item = Event()
 	self.on_change_items = Event()
@@ -102,14 +149,16 @@ end
 
 local _temp_pos = vmath.vector3(0)
 --- Return pos for grid node index
--- @tparam StaticGrid self
+-- @tparam StaticGrid self @{StaticGrid}
 -- @tparam number index The grid element index
 -- @treturn vector3 Node position
 function StaticGrid.get_pos(self, index)
 	local row = math.ceil(index / self.in_row) - 1
 	local col = (index - row * self.in_row) - 1
 
-	_temp_pos.x = col * self.node_size.x + self._zero_offset.x
+	local zero_offset_x = self:_get_zero_offset_x(row)
+
+	_temp_pos.x = col * self.node_size.x + zero_offset_x
 	_temp_pos.y = -row * self.node_size.y + self._zero_offset.y
 	_temp_pos.z = 0
 
@@ -118,7 +167,7 @@ end
 
 
 --- Return index for grid pos
--- @tparam StaticGrid self
+-- @tparam StaticGrid self @{StaticGrid}
 -- @tparam vector3 pos The node position in the grid
 -- @treturn number The node index
 function StaticGrid.get_index(self, pos)
@@ -134,7 +183,7 @@ end
 
 
 --- Return grid index by node
--- @tparam StaticGrid self
+-- @tparam StaticGrid self @{StaticGrid}
 -- @tparam node node The gui node in the grid
 -- @treturn number The node index
 function StaticGrid.get_index_by_node(self, node)
@@ -154,7 +203,7 @@ end
 
 
 --- Set grid anchor. Default anchor is equal to anchor of grid parent node
--- @tparam StaticGrid self
+-- @tparam StaticGrid self @{StaticGrid}
 -- @tparam vector3 anchor Anchor
 function StaticGrid.set_anchor(self, anchor)
 	self.anchor = anchor
@@ -163,37 +212,24 @@ end
 
 
 --- Add new item to the grid
--- @tparam StaticGrid self
---	@tparam node item Gui node
+-- @tparam StaticGrid self @{StaticGrid}
+-- @tparam node item Gui node
 -- @tparam[opt] number index The item position. By default add as last item
 -- @tparam[opt=SHIFT.RIGHT] number shift_policy How shift nodes, if required. See const.SHIFT
-function StaticGrid.add(self, item, index, shift_policy)
-	shift_policy = shift_policy or const.SHIFT.RIGHT
+-- @tparam[opt=false] boolean is_instant If true, update node positions instantly
+function StaticGrid.add(self, item, index, shift_policy, is_instant)
 	index = index or ((self.last_index or 0) + 1)
 
-	if self.nodes[index] then
-		if shift_policy == const.SHIFT.RIGHT then
-			for i = self.last_index, index, -1 do
-				self.nodes[i + 1] = self.nodes[i]
-			end
-		end
-		if shift_policy == const.SHIFT.LEFT then
-			for i = self.first_index, index do
-				self.nodes[i - 1] = self.nodes[i]
-			end
-		end
-	end
-
-	self.nodes[index] = item
+	helper.insert_with_shift(self.nodes, item, index, shift_policy)
 	gui.set_parent(item, self.parent)
 
 	-- Add new item instantly in new pos. Break update function for correct positioning
 	self:_update_indexes()
 	self:_update_borders()
 
-	gui.set_position(item, self:get_pos(index))
+	gui.set_position(item, self:get_pos(index) + self:_get_zero_offset())
 
-	self:_update_pos()
+	self:_update_pos(is_instant)
 
 	self.on_add_item:trigger(self:get_context(), item, index)
 	self.on_change_items:trigger(self:get_context(), index)
@@ -201,29 +237,18 @@ end
 
 
 --- Remove the item from the grid. Note that gui node will be not deleted
--- @tparam StaticGrid self
+-- @tparam StaticGrid self @{StaticGrid}
 -- @tparam number index The grid node index to remove
 -- @tparam[opt=SHIFT.RIGHT] number shift_policy How shift nodes, if required. See const.SHIFT
+-- @tparam[opt=false] boolean is_instant If true, update node positions instantly
 -- @treturn Node The deleted gui node from grid
-function StaticGrid.remove(self, index, shift_policy)
-	shift_policy = shift_policy or const.SHIFT.RIGHT
+function StaticGrid.remove(self, index, shift_policy, is_instant)
 	assert(self.nodes[index], "No grid item at given index " .. index)
 
 	local remove_node = self.nodes[index]
-	self.nodes[index] = nil
+	helper.remove_with_shift(self.nodes, index, shift_policy)
 
-	if shift_policy == const.SHIFT.RIGHT then
-		for i = index, self.last_index do
-			self.nodes[i] = self.nodes[i + 1]
-		end
-	end
-	if shift_policy == const.SHIFT.LEFT then
-		for i = index, self.first_index, -1 do
-			self.nodes[i] = self.nodes[i - 1]
-		end
-	end
-
-	self:_update()
+	self:_update(is_instant)
 
 	self.on_remove_item:trigger(self:get_context(), index)
 	self.on_change_items:trigger(self:get_context(), index)
@@ -233,7 +258,7 @@ end
 
 
 --- Return grid content size
--- @tparam StaticGrid self
+-- @tparam StaticGrid self @{StaticGrid}
 -- @treturn vector3 The grid content size
 function StaticGrid.get_size(self)
 	return vmath.vector3(
@@ -243,7 +268,6 @@ function StaticGrid.get_size(self)
 end
 
 
-
 function StaticGrid.get_size_for(self, count)
 	if not count or count == 0 then
 		return vmath.vector3(0)
@@ -267,7 +291,7 @@ end
 
 
 --- Return grid content borders
--- @tparam StaticGrid self
+-- @tparam StaticGrid self @{StaticGrid}
 -- @treturn vector3 The grid content borders
 function StaticGrid.get_borders(self)
 	return self.border
@@ -275,7 +299,7 @@ end
 
 
 --- Return array of all node positions
--- @tparam StaticGrid self
+-- @tparam StaticGrid self @{StaticGrid}
 -- @treturn vector3[] All grid node positions
 function StaticGrid.get_all_pos(self)
 	local result = {}
@@ -289,7 +313,7 @@ end
 
 --- Change set position function for grid nodes. It will call on
 -- update poses on grid elements. Default: gui.set_position
--- @tparam StaticGrid self
+-- @tparam StaticGrid self @{StaticGrid}
 -- @tparam function callback Function on node set position
 -- @treturn druid.static_grid Current grid instance
 function StaticGrid.set_position_function(self, callback)
@@ -301,7 +325,7 @@ end
 
 --- Clear grid nodes array. GUI nodes will be not deleted!
 -- If you want to delete GUI nodes, use static_grid.nodes array before grid:clear
--- @tparam StaticGrid self
+-- @tparam StaticGrid self @{StaticGrid}
 -- @treturn druid.static_grid Current grid instance
 function StaticGrid.clear(self)
 	self.border.x = 0
@@ -319,7 +343,7 @@ end
 
 
 --- Return StaticGrid offset, where StaticGrid content starts.
--- @tparam StaticGrid self The StaticGrid instance
+-- @tparam StaticGrid self @{StaticGrid} The StaticGrid instance
 -- @treturn vector3 The StaticGrid offset
 function StaticGrid:get_offset()
 	local borders = self:get_borders()
@@ -334,8 +358,27 @@ function StaticGrid:get_offset()
 end
 
 
+--- Set new in_row elements for grid
+-- @tparam StaticGrid self @{StaticGrid}
+-- @tparam number in_row The new in_row value
+-- @treturn druid.static_grid Current grid instance
+function StaticGrid.set_in_row(self, in_row)
+	self.in_row = in_row
+	self._grid_horizonal_offset = self.node_size.x * (self.in_row - 1) * self.anchor.x
+	self._zero_offset = vmath.vector3(
+		self.node_size.x * self.node_pivot.x - self.node_size.x * self.pivot.x - self._grid_horizonal_offset,
+		self.node_size.y * self.node_pivot.y - self.node_size.y * self.pivot.y,
+		0)
+
+	self:_update(true)
+	self.on_change_items:trigger(self:get_context())
+
+	return self
+end
+
+
 --- Update grid inner state
--- @tparam StaticGrid self
+-- @tparam StaticGrid self @{StaticGrid}
 -- @tparam bool is_instant If true, node position update instantly, otherwise with set_position_function callback
 -- @local
 function StaticGrid._update(self, is_instant)
@@ -346,7 +389,7 @@ end
 
 
 --- Update first and last indexes of grid nodes
--- @tparam StaticGrid self
+-- @tparam StaticGrid self @{StaticGrid}
 -- @local
 function StaticGrid._update_indexes(self)
 	self.first_index = nil
@@ -362,7 +405,7 @@ end
 
 
 --- Update grid content borders, recalculate min and max values
--- @tparam StaticGrid self
+-- @tparam StaticGrid self @{StaticGrid}
 -- @local
 function StaticGrid._update_borders(self)
 	if not self.first_index then
@@ -381,12 +424,16 @@ end
 
 
 --- Update grid nodes position
--- @tparam StaticGrid self
+-- @tparam StaticGrid self @{StaticGrid}
 -- @tparam bool is_instant If true, node position update instantly, otherwise with set_position_function callback
 -- @local
 function StaticGrid._update_pos(self, is_instant)
+	local zero_offset = self:_get_zero_offset()
+
 	for i, node in pairs(self.nodes) do
 		local pos = self:get_pos(i)
+		pos.x = pos.x + zero_offset.x
+		pos.y = pos.y + zero_offset.y
 
 		if is_instant then
 			gui.set_position(node, pos)
@@ -399,4 +446,43 @@ function StaticGrid._update_pos(self, is_instant)
 end
 
 
+--- Return elements offset for correct posing nodes. Correct posing at
+-- parent pivot node (0:0) with adjusting of node sizes and anchoring
+-- @treturn vector3 The offset vector
+-- @local
+function StaticGrid:_get_zero_offset()
+	if not self.style.IS_DYNAMIC_NODE_POSES then
+		return const.VECTOR_ZERO
+	end
+
+	-- zero offset: center pos - border size * anchor
+	return vmath.vector3(
+		-((self.border.x + self.border.z)/2 + (self.border.z - self.border.x) * self.pivot.x),
+		-((self.border.y + self.border.w)/2 + (self.border.y - self.border.w) * self.pivot.y),
+		0
+	)
+end
+
+
+--- Return offset x for last row in grid. Used to align this row accorting to grid's anchor
+-- @treturn number The offset x value
+-- @local
+function StaticGrid:_get_zero_offset_x(row_index)
+	if not self.style.IS_DYNAMIC_NODE_POSES or not self.style.IS_ALIGN_LAST_ROW then
+		return self._zero_offset.x
+	end
+
+	local offset_x = self._zero_offset.x
+	local last_row = math.ceil(self.last_index / self.in_row) - 1
+
+	if last_row > 0 and last_row == row_index then
+		local elements_in_row = (self.last_index - (last_row * self.in_row)) - 1
+		local offset = elements_in_row * self.node_size.x * self.anchor.x
+		offset_x = self.node_size.x * self.node_pivot.x - self.node_size.x * self.pivot.x - offset
+	end
+
+	return offset_x
+end
+
+
 return StaticGrid

druid/base/text.lua

@@ -1,22 +1,55 @@
---- Component to handle all GUI texts.
--- Druid text can adjust itself for text node size
--- Text will never will be outside of his text size (even multiline)
+-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
+
+--- Component for Wrapping GUI Text Nodes: Druid Text
+--
+-- ## Overview ##
+--
+-- Druid Text is a component that provides various adjustment modes for text nodes. It allows text to be scaled down to fit within the size of the text node.
+--
+-- ## Notes ##
+--
+-- • The text pivot can be changed using the text:set_pivot method.
+-- The anchoring will be inside the text node's area size.
+--
+-- • There are several text adjustment types available. The default is DOWNSCALE.
+-- You can change the default adjustment type in the Text style. Refer to the example below to see all available adjustment types:
+--
+-- - const.TEXT_ADJUST.DOWNSCALE: Changes the text's scale to fit within the text node's size.
+--
+-- - const.TEXT_ADJUST.TRIM: Trims the text with a postfix (default: "...", can be overridden in styles)
+-- to fit within the text node's size.
+--
+-- - const.TEXT_ADJUST.NO_ADJUST: No adjustment is applied, similar
+-- to the default Defold Text Node behavior.
+--
+-- - const.TEXT_ADJUST.DOWNSCALE_LIMITED: Changes the text's scale
+-- with a limited downscale. You can set the minimum scale using the text:set_minimal_scale() function.
+--
+-- - const.TEXT_ADJUST.SCROLL: Changes the text's pivot to imitate scrolling within the text box.
+-- For better effect, use with a stencil node.
+--
+-- - const.TEXT_ADJUST.SCALE_THEN_SCROLL: Combines two modes: limited downscale first, then scroll.
+--
+-- <a href="https://insality.github.io/druid/druid/index.html?example=texts_general" target="_blank"><b>Example Link</b></a>
 -- @module Text
 -- @within BaseComponent
 -- @alias druid.text
 
 --- On set text callback(self, text)
--- @tfield druid_event on_set_text
+-- @tfield DruidEvent on_set_text @{DruidEvent}
 
---- On adjust text size callback(self, new_scale)
--- @tfield druid_event on_update_text_scale
+--- On adjust text size callback(self, new_scale, text_metrics)
+-- @tfield DruidEvent on_update_text_scale @{DruidEvent}
 
 --- On change pivot callback(self, pivot)
--- @tfield druid_event on_set_pivot
+-- @tfield DruidEvent on_set_pivot @{DruidEvent}
 
 --- Text node
 -- @tfield node node
 
+--- The node id of text node
+-- @tfield hash node_id
+
 --- Current text position
 -- @tfield vector3 pos
 
@@ -33,7 +66,7 @@
 -- @tfield vector3 text_area
 
 --- Current text size adjust settings
--- @tfield bool is_no_adjust
+-- @tfield number adjust_type
 
 --- Current text color
 -- @tfield vector3 color
@@ -42,9 +75,12 @@
 
 local Event = require("druid.event")
 local const = require("druid.const")
+local helper = require("druid.helper")
+local utf8_lua = require("druid.system.utf8")
 local component = require("druid.component")
+local utf8 = utf8 or utf8_lua
 
-local Text = component.create("text", { component.ON_LAYOUT_CHANGE })
+local Text = component.create("text")
 
 
 local function update_text_size(self)
@@ -57,38 +93,80 @@ local function update_text_size(self)
 end
 
 
---- Setup scale x, but can only be smaller, than start text scale
-local function update_text_area_size(self)
+--- Reset initial scale for text
+local function reset_default_scale(self)
 	gui.set_scale(self.node, self.start_scale)
 	gui.set_size(self.node, self.start_size)
+end
+
+
+--- Setup scale x, but can only be smaller, than start text scale
+local function update_text_area_size(self)
+	reset_default_scale(self)
 
 	local max_width = self.text_area.x
 	local max_height = self.text_area.y
 
-	local metrics = gui.get_text_metrics_from_node(self.node)
-	local cur_scale = gui.get_scale(self.node)
+	local metrics = helper.get_text_metrics_from_node(self.node)
 
 	local scale_modifier = max_width / metrics.width
 	scale_modifier = math.min(scale_modifier, self.start_scale.x)
 
-	local scale_modifier_height = max_height / metrics.height
-	scale_modifier = math.min(scale_modifier, scale_modifier_height)
+	if self:is_multiline() then
+		local scale_modifier_by_height = math.sqrt(max_height / metrics.height)
+		scale_modifier = math.min(self.start_scale.y, scale_modifier_by_height)
 
-	local new_scale = vmath.vector3(scale_modifier, scale_modifier, cur_scale.z)
+		if metrics.width * scale_modifier > max_width then
+			scale_modifier = math.min(max_width / metrics.width, self.start_scale.x)
+		end
+	end
+
+	if self._minimal_scale then
+		scale_modifier = math.max(scale_modifier, self._minimal_scale)
+	end
+
+	local new_scale = vmath.vector3(scale_modifier, scale_modifier, self.start_scale.z)
 	gui.set_scale(self.node, new_scale)
 	self.scale = new_scale
 
 	update_text_size(self)
 
-	self.on_update_text_scale:trigger(self:get_context(), new_scale)
+	self.on_update_text_scale:trigger(self:get_context(), new_scale, metrics)
+end
+
+
+local function update_text_with_trim(self, trim_postfix)
+	local max_width = self.text_area.x
+	local text_width = self:get_text_size()
+
+	if text_width > max_width then
+		local text_length = utf8.len(self.last_value)
+		local new_text = self.last_value
+		while text_width > max_width do
+			text_length = text_length - 1
+			new_text = utf8.sub(self.last_value, 1, text_length)
+			text_width = self:get_text_size(new_text .. trim_postfix)
+		end
+
+		gui.set_text(self.node, new_text .. trim_postfix)
+	end
+end
+
+
+local function update_text_with_anchor_shift(self)
+	if self:get_text_size() >= self.text_area.x then
+		self:set_pivot(const.REVERSE_PIVOTS[self.start_pivot])
+	else
+		self:set_pivot(self.start_pivot)
+	end
 end
 
 
 -- calculate space width with font
 local function get_space_width(self, font)
 	if not self._space_width[font] then
-		local no_space = gui.get_text_metrics(font, "1", 0, false, 0, 0).width
-		local with_space = gui.get_text_metrics(font, " 1", 0, false, 0, 0).width
+		local no_space = resource.get_text_metrics(font, "1").width
+		local with_space = resource.get_text_metrics(font, " 1").width
 		self._space_width[font] = with_space - no_space
 	end
 
@@ -96,15 +174,59 @@ local function get_space_width(self, font)
 end
 
 
---- Component init function
--- @tparam Text self
--- @tparam node node Gui text node
+local function update_adjust(self)
+	if not self.adjust_type or self.adjust_type == const.TEXT_ADJUST.NO_ADJUST then
+		reset_default_scale(self)
+		return
+	end
+
+	if self.adjust_type == const.TEXT_ADJUST.DOWNSCALE then
+		update_text_area_size(self)
+	end
+
+	if self.adjust_type == const.TEXT_ADJUST.TRIM then
+		update_text_with_trim(self, self.style.TRIM_POSTFIX)
+	end
+
+	if self.adjust_type == const.TEXT_ADJUST.DOWNSCALE_LIMITED then
+		update_text_area_size(self)
+	end
+
+	if self.adjust_type == const.TEXT_ADJUST.SCROLL then
+		update_text_with_anchor_shift(self)
+	end
+
+	if self.adjust_type == const.TEXT_ADJUST.SCALE_THEN_SCROLL then
+		update_text_area_size(self)
+		update_text_with_anchor_shift(self)
+	end
+end
+
+
+--- Component style params.
+-- You can override this component styles params in druid styles table
+-- or create your own style
+-- @table style
+-- @tfield[opt=...] string TRIM_POSTFIX The postfix for TRIM adjust type
+-- @tfield[opt=DOWNSCALE] string DEFAULT_ADJUST The default adjust type for any text component
+function Text.on_style_change(self, style)
+	self.style = {}
+	self.style.TRIM_POSTFIX = style.TRIM_POSTFIX or "..."
+	self.style.DEFAULT_ADJUST = style.DEFAULT_ADJUST or const.TEXT_ADJUST.DOWNSCALE
+end
+
+
+--- @{Text} constructor
+-- @tparam Text self @{Text}
+-- @tparam string|node node Node name or GUI Text Node itself
 -- @tparam[opt] string value Initial text. Default value is node text from GUI scene.
--- @tparam[opt] bool no_adjust If true, text will be not auto-adjust size
-function Text.init(self, node, value, no_adjust)
+-- @tparam[opt=downscale] string adjust_type Adjust type for text. By default is DOWNSCALE. Look const.TEXT_ADJUST for reference
+function Text.init(self, node, value, adjust_type)
 	self.node = self:get_node(node)
 	self.pos = gui.get_position(self.node)
+	self.node_id = gui.get_id(self.node)
 
+	self.start_pivot = gui.get_pivot(self.node)
 	self.start_scale = gui.get_scale(self.node)
 	self.scale = gui.get_scale(self.node)
 
@@ -113,7 +235,7 @@ function Text.init(self, node, value, no_adjust)
 	self.text_area.x = self.text_area.x * self.start_scale.x
 	self.text_area.y = self.text_area.y * self.start_scale.y
 
-	self.is_no_adjust = no_adjust
+	self.adjust_type = adjust_type or self.style.DEFAULT_ADJUST
 	self.color = gui.get_color(self.node)
 
 	self.on_set_text = Event()
@@ -132,73 +254,106 @@ function Text.on_layout_change(self)
 end
 
 
+function Text.on_message_input(self, node_id, message)
+	if node_id ~= self.node_id  then
+		return false
+	end
+
+	if message.action == const.MESSAGE_INPUT.TEXT_SET then
+		Text.set_to(self, message.value)
+	end
+end
+
+
 --- Calculate text width with font with respect to trailing space
--- @tparam Text self
+-- @tparam Text self @{Text}
 -- @tparam[opt] string text
-function Text.get_text_width(self, text)
+-- @treturn number Width
+-- @treturn number Height
+function Text.get_text_size(self, text)
 	text = text or self.last_value
-	local font = gui.get_font(self.node)
+	local font_name = gui.get_font(self.node)
+	local font = gui.get_font_resource(font_name)
 	local scale = gui.get_scale(self.node)
-	local result = gui.get_text_metrics(font, text, 0, false, 0, 0).width
+	local linebreak = gui.get_line_break(self.node)
+	local metrics = resource.get_text_metrics(font, text, {
+		line_break = linebreak,
+		leading = 1,
+		tracking = 0,
+		width = self.start_size.x
+	})
+	local width = metrics.width
 	for i = #text, 1, -1 do
 		local c = string.sub(text, i, i)
 		if c ~= ' ' then
 			break
 		end
 
-		result = result + get_space_width(self, font)
+		width = width + get_space_width(self, font)
 	end
 
-	return result * scale.x
+	return width * scale.x, metrics.height * scale.y
 end
 
 
 --- Set text to text field
--- @tparam Text self
+-- @tparam Text self @{Text}
 -- @tparam string set_to Text for node
+-- @treturn Text Current text instance
 function Text.set_to(self, set_to)
+	set_to = set_to or ""
+
 	self.last_value = set_to
 	gui.set_text(self.node, set_to)
 
 	self.on_set_text:trigger(self:get_context(), set_to)
 
-	if not self.is_no_adjust then
-		update_text_area_size(self)
-	end
+	update_adjust(self)
+
+	return self
 end
 
 
 --- Set color
--- @tparam Text self
+-- @tparam Text self @{Text}
 -- @tparam vector4 color Color for node
+-- @treturn Text Current text instance
 function Text.set_color(self, color)
 	self.color = color
 	gui.set_color(self.node, color)
+
+	return self
 end
 
 
 --- Set alpha
--- @tparam Text self
+-- @tparam Text self @{Text}
 -- @tparam number alpha Alpha for node
+-- @treturn Text Current text instance
 function Text.set_alpha(self, alpha)
 	self.color.w = alpha
 	gui.set_color(self.node, self.color)
+
+	return self
 end
 
 
 --- Set scale
--- @tparam Text self
+-- @tparam Text self @{Text}
 -- @tparam vector3 scale Scale for node
+-- @treturn Text Current text instance
 function Text.set_scale(self, scale)
 	self.last_scale = scale
 	gui.set_scale(self.node, scale)
+
+	return self
 end
 
 
---- Set text pivot. Text will re-anchor inside
--- his text area
--- @tparam Text self
+--- Set text pivot. Text will re-anchor inside text area
+-- @tparam Text self @{Text}
 -- @tparam gui.pivot pivot Gui pivot constant
+-- @treturn Text Current text instance
 function Text.set_pivot(self, pivot)
 	local prev_pivot = gui.get_pivot(self.node)
 	local prev_offset = const.PIVOTS[prev_pivot]
@@ -216,15 +371,49 @@ function Text.set_pivot(self, pivot)
 	gui.set_position(self.node, self.pos)
 
 	self.on_set_pivot:trigger(self:get_context(), pivot)
+
+	return self
 end
 
 
 --- Return true, if text with line break
--- @tparam Text self
+-- @tparam Text self @{Text}
 -- @treturn bool Is text node with line break
 function Text.is_multiline(self)
 	return gui.get_line_break(self.node)
 end
 
 
+--- Set text adjust, refresh the current text visuals, if needed
+-- @tparam Text self @{Text}
+-- @tparam[opt] number adjust_type See const.TEXT_ADJUST. If pass nil - use current adjust type
+-- @tparam[opt] number minimal_scale If pass nil - not use minimal scale
+-- @treturn Text Current text instance
+function Text.set_text_adjust(self, adjust_type, minimal_scale)
+	self.adjust_type = adjust_type
+	self._minimal_scale = minimal_scale
+	self:set_to(self.last_value)
+
+	return self
+end
+
+
+--- Set minimal scale for DOWNSCALE_LIMITED or SCALE_THEN_SCROLL adjust types
+-- @tparam Text self @{Text}
+-- @tparam number minimal_scale If pass nil - not use minimal scale
+-- @treturn Text Current text instance
+function Text.set_minimal_scale(self, minimal_scale)
+	self._minimal_scale = minimal_scale
+
+	return self
+end
+
+
+--- Return current text adjust type
+-- @treturn number The current text adjust type
+function Text.get_text_adjust(self, adjust_type)
+	return self.adjust_type
+end
+
+
 return Text

druid/component.lua

@@ -1,5 +1,20 @@
+-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
+
 --- Basic class for all Druid components.
--- To create you component, use `component.create`
+-- To create you custom component, use static function `component.create`
+-- @usage
+-- -- Create your component:
+-- local component = require("druid.component")
+--
+-- local AwesomeComponent = component.create("awesome_component")
+--
+-- function AwesomeComponent:init(template, nodes)
+--     self:set_template(template)
+--     self:set_nodes(nodes)
+--     self.druid = self:get_druid()
+-- end
+--
+-- return AwesomeComponent
 -- @module BaseComponent
 -- @alias druid.base_component
 
@@ -7,135 +22,197 @@ local const = require("druid.const")
 local class = require("druid.system.middleclass")
 local helper = require("druid.helper")
 
-
 local BaseComponent = class("druid.component")
 
+local INTERESTS = {} -- Cache interests per component class in runtime
+local IS_AUTO_TEMPLATE = not (sys.get_config("druid.no_auto_template") == "1")
 
---- Component Interests
-BaseComponent.ALL = const.ALL
+-- Component Interests
 BaseComponent.ON_INPUT = const.ON_INPUT
 BaseComponent.ON_UPDATE = const.ON_UPDATE
 BaseComponent.ON_MESSAGE = const.ON_MESSAGE
+BaseComponent.ON_LATE_INIT = const.ON_LATE_INIT
 BaseComponent.ON_FOCUS_LOST = const.ON_FOCUS_LOST
 BaseComponent.ON_FOCUS_GAINED = const.ON_FOCUS_GAINED
 BaseComponent.ON_LAYOUT_CHANGE = const.ON_LAYOUT_CHANGE
+BaseComponent.ON_MESSAGE_INPUT = const.ON_MESSAGE_INPUT
+BaseComponent.ON_WINDOW_RESIZED = const.ON_WINDOW_RESIZED
 BaseComponent.ON_LANGUAGE_CHANGE = const.ON_LANGUAGE_CHANGE
 
-
 BaseComponent.ALL_INTERESTS = {
-	BaseComponent.ALL,
 	BaseComponent.ON_INPUT,
 	BaseComponent.ON_UPDATE,
 	BaseComponent.ON_MESSAGE,
+	BaseComponent.ON_LATE_INIT,
 	BaseComponent.ON_FOCUS_LOST,
 	BaseComponent.ON_FOCUS_GAINED,
 	BaseComponent.ON_LAYOUT_CHANGE,
+	BaseComponent.ON_MESSAGE_INPUT,
+	BaseComponent.ON_WINDOW_RESIZED,
 	BaseComponent.ON_LANGUAGE_CHANGE,
 }
 
-
--- Value is method name of component
+-- Mapping from on_message method to specific method name
 BaseComponent.SPECIFIC_UI_MESSAGES = {
-	[BaseComponent.ON_FOCUS_LOST] = "on_focus_lost",
-	[BaseComponent.ON_FOCUS_GAINED] = "on_focus_gained",
-	[BaseComponent.ON_LAYOUT_CHANGE] = "on_layout_change",
-	[BaseComponent.ON_LANGUAGE_CHANGE] = "on_language_change",
-}
-
-
-BaseComponent.UI_INPUT = {
-	[BaseComponent.ON_INPUT] = true
+	[hash("layout_changed")] = BaseComponent.ON_LAYOUT_CHANGE, -- The message_id from Defold
+	[hash(BaseComponent.ON_FOCUS_LOST)] = BaseComponent.ON_FOCUS_LOST,
+	[hash(BaseComponent.ON_FOCUS_GAINED)] = BaseComponent.ON_FOCUS_GAINED,
+	[hash(BaseComponent.ON_WINDOW_RESIZED)] = BaseComponent.ON_WINDOW_RESIZED,
+	[hash(BaseComponent.ON_MESSAGE_INPUT)] = BaseComponent.ON_MESSAGE_INPUT,
+	[hash(BaseComponent.ON_LANGUAGE_CHANGE)] = BaseComponent.ON_LANGUAGE_CHANGE,
 }
 
 
 local uid = 0
-function BaseComponent.static.get_uid()
+function BaseComponent.create_uid()
 	uid = uid + 1
 	return uid
 end
 
 
 --- Set current component style table.
--- Invoke `on_style_change` on component, if exist. BaseComponent should handle
+--
+-- Invoke `on_style_change` on component, if exist. Component should handle
 -- their style changing and store all style params
--- @tparam BaseComponent self
+-- @function component:set_style
+-- @tparam BaseComponent self @{BaseComponent}
 -- @tparam table druid_style Druid style module
+-- @treturn BaseComponent @{BaseComponent}
 function BaseComponent.set_style(self, druid_style)
-	self._meta.style = druid_style or const.EMPTY_TABLE
-	local component_style = self._meta.style[self._component.name] or const.EMPTY_TABLE
+	self._meta.style = druid_style or {}
+	local component_style = self._meta.style[self._component.name] or {}
 
 	if self.on_style_change then
 		self:on_style_change(component_style)
 	end
+
+	return self
 end
 
 
---- Set current component template name
--- @tparam BaseComponent self
+--- Set component template name.
+--
+-- Use on all your custom components with GUI layouts used as templates.
+-- It will check parent template name to build full template name in self:get_node()
+-- @function component:set_template
+-- @tparam BaseComponent self @{BaseComponent}
 -- @tparam string template BaseComponent template name
+-- @treturn BaseComponent @{BaseComponent}
 function BaseComponent.set_template(self, template)
+	template = template or ""
+
+	local parent = self:get_parent_component()
+	if parent and IS_AUTO_TEMPLATE then
+		local parent_template = parent:get_template()
+		if #parent_template > 0 then
+			if #template > 0 then
+				template = "/" .. template
+			end
+			template = parent_template .. template
+		end
+	end
+
 	self._meta.template = template
+	return self
 end
 
 
---- Set current component nodes
--- @tparam BaseComponent self
+--- Get current component template name.
+-- @function component:get_template
+-- @tparam BaseComponent self @{BaseComponent}
+-- @treturn string Component full template name
+function BaseComponent.get_template(self)
+	return self._meta.template
+end
+
+
+--- Set current component nodes.
+-- Use if your component nodes was cloned with `gui.clone_tree` and you got the node tree.
+-- @function component:set_nodes
+-- @tparam BaseComponent self @{BaseComponent}
 -- @tparam table nodes BaseComponent nodes table
+-- @treturn BaseComponent @{BaseComponent}
+-- @usage
+-- local nodes = gui.clone_tree(self.prefab)
+-- ... In your component:
+-- self:set_nodes(nodes)
 function BaseComponent.set_nodes(self, nodes)
 	self._meta.nodes = nodes
+
+	-- When we use gui.clone_tree in inner template (template inside other template)
+	-- this nodes have no id. We have table: hash(correct_id) : hash("")
+	-- It's wrong and we use this hack to fix this
+	if nodes then
+		for id, node in pairs(nodes) do
+			gui.set_id(node, id)
+		end
+	end
+
+	return self
 end
 
 
---- Get current component context
--- @tparam BaseComponent self
+--- Context used as first arg in all Druid events
+--
+-- Context is usually self of gui_script.
+-- @function component:get_context
+-- @tparam BaseComponent self @{BaseComponent}
 -- @treturn table BaseComponent context
 function BaseComponent.get_context(self)
 	return self._meta.context
 end
 
 
---- Increase input priority in current input stack
--- @tparam BaseComponent self
+--- Increase input priority in input stack
+-- @function component:increase_input_priority
+-- @tparam BaseComponent self @{BaseComponent}
 -- @local
 function BaseComponent.increase_input_priority(self)
 	helper.deprecated("The component:increase_input_priority is deprecated. Please use component:set_input_priority(druid_const.PRIORITY_INPUT_MAX) instead")
 end
 
 
-
---- Get node for component by name.
+--- Get component node by name.
+--
 -- If component has nodes, node_or_name should be string
--- It auto pick node by template name or from nodes by clone_tree
--- if they was setup via component:set_nodes, component:set_template
--- @tparam BaseComponent self
+-- It autopick node by template name or from nodes by gui.clone_tree
+-- if they was setup via component:set_nodes, component:set_template.
+-- If node is not found, the exception will fired
+-- @function component:get_node
+-- @tparam BaseComponent self @{BaseComponent}
 -- @tparam string|node node_or_name Node name or node itself
 -- @treturn node Gui node
 function BaseComponent.get_node(self, node_or_name)
-	local template_name = self:__get_template() or const.EMPTY_STRING
+	if type(node_or_name) ~= "string" then
+		-- Assume it's already node from gui.get_node
+		return node_or_name
+	end
+
+	local template_name = self:get_template()
 	local nodes = self:__get_nodes()
 
-	if template_name ~= const.EMPTY_STRING then
+	if #template_name > 0 then
 		template_name = template_name .. "/"
 	end
 
-	local node_type = type(node_or_name)
+	local node
 	if nodes then
-		assert(node_type == const.STRING, "You should pass node name instead of node")
-		return nodes[template_name .. node_or_name]
+		node = nodes[template_name .. node_or_name]
 	else
-		if node_type == const.STRING then
-			return gui.get_node(template_name .. node_or_name)
-		else
-			-- Assume it's already node from gui.get_node
-			return node_or_name
-		end
+		node = gui.get_node(template_name .. node_or_name)
 	end
+
+	if not node then
+		assert(node, "No component with name: " .. (template_name or "") .. (node_or_name or ""))
+	end
+
+	return node
 end
 
 
---- Return druid with context of calling component.
--- Use it to create component inside of other components.
--- @tparam BaseComponent self
+--- Get Druid instance for inner component creation.
+-- @function component:get_druid
+-- @tparam BaseComponent self @{BaseComponent}
 -- @treturn Druid Druid instance with component context
 function BaseComponent.get_druid(self)
 	local context = { _context = self }
@@ -144,15 +221,27 @@ end
 
 
 --- Return component name
--- @tparam BaseComponent self
+-- @function component:get_name
+-- @tparam BaseComponent self @{BaseComponent}
 -- @treturn string The component name
 function BaseComponent.get_name(self)
-	return self._component.name
+	return self._component.name .. BaseComponent.create_uid()
+end
+
+
+--- Return parent component name
+-- @function component:get_parent_name
+-- @tparam BaseComponent self @{BaseComponent}
+-- @treturn string|nil The parent component name if exist or bil
+function BaseComponent.get_parent_name(self)
+	local parent = self:get_parent_component()
+	return parent and parent:get_name()
 end
 
 
 --- Return component input priority
--- @tparam BaseComponent self
+-- @function component:get_input_priority
+-- @tparam BaseComponent self @{BaseComponent}
 -- @treturn number The component input priority
 function BaseComponent.get_input_priority(self)
 	return self._component.input_priority
@@ -160,15 +249,30 @@ end
 
 
 --- Set component input priority
--- @tparam BaseComponent self
+--
+-- Default value: 10
+-- @function component:set_input_priority
+-- @tparam BaseComponent self @{BaseComponent}
 -- @tparam number value The new input priority value
+-- @tparam boolean is_temporary If true, the reset input priority will return to previous value
 -- @treturn number The component input priority
-function BaseComponent.set_input_priority(self, value)
+function BaseComponent.set_input_priority(self, value, is_temporary)
 	assert(value)
 
-	if self._component.input_priority ~= value then
-		self._component.input_priority = value
-		self._component._is_input_priority_changed = true
+	if self._component.input_priority == value then
+		return self
+	end
+
+	self._component.input_priority = value
+	self._component._is_input_priority_changed = true
+
+	if not is_temporary then
+		self._component.default_input_priority = value
+	end
+
+	local children = self:get_childrens()
+	for i = 1, #children do
+		children[i]:set_input_priority(value, is_temporary)
 	end
 
 	return self
@@ -176,7 +280,8 @@ end
 
 
 --- Reset component input priority to default value
--- @tparam BaseComponent self
+-- @function component:reset_input_priority
+-- @tparam BaseComponent self @{BaseComponent}
 -- @treturn number The component input priority
 function BaseComponent.reset_input_priority(self)
 	self:set_input_priority(self._component.default_input_priority)
@@ -184,8 +289,11 @@ function BaseComponent.reset_input_priority(self)
 end
 
 
---- Return component uid. UID generated in component creation order
--- @tparam BaseComponent self
+--- Return component UID.
+--
+-- UID generated in component creation order.
+-- @function component:get_uid
+-- @tparam BaseComponent self @{BaseComponent}
 -- @treturn number The component uid
 function BaseComponent.get_uid(self)
 	return self._component._uid
@@ -193,10 +301,12 @@ end
 
 
 --- Set component input state. By default it enabled
--- You can disable any input of component by this function
--- @tparam BaseComponent self
+--
+-- If input is disabled, the component will not receive input events
+-- @function component:set_input_enabled
+-- @tparam BaseComponent self @{BaseComponent}
 -- @tparam bool state The component input state
---	@treturn BaseComponent BaseComponent itself
+-- @treturn BaseComponent BaseComponent itself
 function BaseComponent.set_input_enabled(self, state)
 	self._meta.input_enabled = state
 
@@ -208,43 +318,42 @@ function BaseComponent.set_input_enabled(self, state)
 end
 
 
---- Return the parent for current component
--- @tparam BaseComponent self
--- @treturn druid.base_component|nil The druid component instance or nil
+--- Return the parent component if exist
+-- @function component:get_parent_component
+-- @tparam BaseComponent self @{BaseComponent}
+-- @treturn BaseComponent|nil The druid component instance or nil
 function BaseComponent.get_parent_component(self)
-	local context = self:get_context()
-
-	if context.isInstanceOf and context:isInstanceOf(BaseComponent) then
-		return context
-	end
-
-	return nil
+	return self._meta.parent
 end
 
 
 --- Setup component context and his style table
--- @tparam BaseComponent self
+-- @function component:setup_component
+-- @tparam BaseComponent self @{BaseComponent}
 -- @tparam table druid_instance The parent druid instance
 -- @tparam table context Druid context. Usually it is self of script
 -- @tparam table style Druid style module
+-- @tparam table instance_class The component instance class
 -- @treturn component BaseComponent itself
-function BaseComponent.setup_component(self, druid_instance, context, style)
+-- @local
+function BaseComponent.setup_component(self, druid_instance, context, style, instance_class)
 	self._meta = {
-		template = nil,
-		context = nil,
+		template = "",
+		context = context,
 		nodes = nil,
 		style = nil,
 		druid = druid_instance,
 		input_enabled = true,
-		children = {}
+		children = {},
+		parent = type(context) ~= "userdata" and context,
+		instance_class = instance_class
 	}
 
-	self:__set_context(context)
 	self:set_style(style)
+	self:set_template("")
 
-	local parent = self:get_parent_component()
-	if parent then
-		parent:__add_children(self)
+	if self._meta.parent then
+		self._meta.parent:__add_children(self)
 	end
 
 	return self
@@ -252,28 +361,51 @@ end
 
 
 --- Basic constructor of component. It will call automaticaly
--- by `BaseComponent.static.create`
--- @tparam BaseComponent self
+-- by `BaseComponent.create`
+-- @function component:initialize
+-- @tparam BaseComponent self @{BaseComponent}
 -- @tparam string name BaseComponent name
--- @tparam[opt={}] table interest List of component's interest
 -- @tparam[opt=DEFAULT] number input_priority The input priority. The bigger number processed first
 -- @local
-function BaseComponent.initialize(self, name, interest, input_priority)
-	interest = interest or {}
-
+function BaseComponent.initialize(self, name, input_priority)
 	self._component = {
 		name = name,
-		interest = interest,
 		input_priority = input_priority or const.PRIORITY_INPUT,
 		default_input_priority = input_priority or const.PRIORITY_INPUT,
+		is_debug = false,
 		_is_input_priority_changed = true, -- Default true for sort once time after GUI init
-		_uid = BaseComponent.get_uid()
+		_uid = BaseComponent.create_uid()
 	}
 end
 
 
+--- Print log information if debug mode is enabled
+-- @function component:log_message
+-- @tparam BaseComponent self @{BaseComponent}
+-- @tparam string message
+-- @tparam table context
+-- @local
+function BaseComponent.log_message(self, message, context)
+	if not self._component.is_debug then
+		return
+	end
+	print("[" .. self:get_name() .. "]:", message, helper.table_to_string(context))
+end
+
+
+--- Set debug logs for component enabled or disabled
+-- @function component:set_debug
+-- @tparam BaseComponent self @{BaseComponent}
+-- @tparam bool is_debug
+-- @local
+function BaseComponent.set_debug(self, is_debug)
+	self._component.is_debug = is_debug
+end
+
+
 --- Return true, if input priority was changed
--- @tparam BaseComponent self
+-- @function component:_is_input_priority_changed
+-- @tparam BaseComponent self @{BaseComponent}
 -- @local
 function BaseComponent._is_input_priority_changed(self)
 	return self._component._is_input_priority_changed
@@ -281,7 +413,8 @@ end
 
 
 --- Reset is_input_priority_changed field
--- @tparam BaseComponent self
+-- @function component:_reset_input_priority_changed
+-- @tparam BaseComponent self @{BaseComponent}
 -- @local
 function BaseComponent._reset_input_priority_changed(self)
 	self._component._is_input_priority_changed = false
@@ -293,44 +426,48 @@ function BaseComponent.__tostring(self)
 end
 
 
---- Set current component context
--- @tparam BaseComponent self
--- @tparam table context Druid context. Usually it is self of script
--- @local
-function BaseComponent.__set_context(self, context)
-	self._meta.context = context
-end
-
-
 --- Get current component interests
--- @tparam BaseComponent self
+-- @function component:__get_interests
+-- @tparam BaseComponent self @{BaseComponent}
 -- @treturn table List of component interests
 -- @local
 function BaseComponent.__get_interests(self)
-	return self._component.interest
-end
+	local instance_class = self._meta.instance_class
+	if INTERESTS[instance_class] then
+		return INTERESTS[instance_class]
+	end
 
+	local interests = {}
+	for index = 1, #BaseComponent.ALL_INTERESTS do
+		local interest = BaseComponent.ALL_INTERESTS[index]
+		if self[interest] and type(self[interest]) == "function" then
+			table.insert(interests, interest)
+		end
+	end
 
---- Get current component template name
--- @tparam BaseComponent self
--- @treturn string BaseComponent template name
--- @local
-function BaseComponent.__get_template(self)
-	return self._meta.template
+	INTERESTS[instance_class] = interests
+	return INTERESTS[instance_class]
 end
 
 
 --- Get current component nodes
--- @tparam BaseComponent self
+-- @function component:__get_nodes
+-- @tparam BaseComponent self @{BaseComponent}
 -- @treturn table BaseComponent nodes table
 -- @local
 function BaseComponent.__get_nodes(self)
-	return self._meta.nodes
+	local nodes = self._meta.nodes
+	local parent = self:get_parent_component()
+	if parent then
+		nodes = nodes or parent:__get_nodes()
+	end
+	return nodes
 end
 
 
 --- Add child to component children list
--- @tparam BaseComponent self
+-- @function component:__add_children
+-- @tparam BaseComponent self @{BaseComponent}
 -- @tparam component children The druid component instance
 -- @local
 function BaseComponent.__add_children(self, children)
@@ -339,7 +476,8 @@ end
 
 
 --- Remove child from component children list
--- @tparam BaseComponent self
+-- @function component:__remove_children
+-- @tparam BaseComponent self @{BaseComponent}
 -- @tparam component children The druid component instance
 -- @local
 function BaseComponent.__remove_children(self, children)
@@ -351,18 +489,35 @@ function BaseComponent.__remove_children(self, children)
 end
 
 
---- Create new component. It will inheritance from basic
--- druid component.
+--- Return all children components, recursive
+-- @function component:get_childrens
+-- @tparam BaseComponent self @{BaseComponent}
+-- @treturn table Array of childrens if the Druid component instance
+function BaseComponent.get_childrens(self)
+	local childrens = {}
+
+	for i = 1, #self._meta.children do
+		local children = self._meta.children[i]
+
+		table.insert(childrens, children)
+		helper.add_array(childrens, children:get_childrens())
+	end
+
+	return childrens
+end
+
+
+--- Create new component. It will inheritance from basic Druid component.
+-- @function BaseComponent.create
 -- @tparam string name BaseComponent name
--- @tparam[opt={}] table interest List of component's interest
 -- @tparam[opt=DEFAULT] number input_priority The input priority. The bigger number processed first
 -- @local
-function BaseComponent.static.create(name, interest, input_priority)
+function BaseComponent.create(name, input_priority)
 	-- Yea, inheritance here
 	local new_class = class(name, BaseComponent)
 
 	new_class.initialize = function(self)
-		BaseComponent.initialize(self, name, interest, input_priority)
+		BaseComponent.initialize(self, name, input_priority)
 	end
 
 	return new_class

druid/const.lua

@@ -1,3 +1,5 @@
+-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
+
 --- Druid constants
 -- @local
 -- @module DruidConst
@@ -5,42 +7,43 @@
 
 local M = {}
 
-M.ACTION_TEXT = hash("text")
-M.ACTION_MARKED_TEXT = hash("marked_text")
-
-M.ACTION_BACKSPACE = hash("key_backspace")
-M.ACTION_ENTER = hash("key_enter")
-M.ACTION_BACK = hash("key_back")
-M.ACTION_ESC = hash("key_esc")
-
-M.ACTION_TOUCH = hash("touch")
-M.ACTION_SCROLL_UP = hash("scroll_up")
-M.ACTION_MULTITOUCH = hash("multitouch")
-M.ACTION_SCROLL_DOWN = hash("scroll_down")
-
-
-M.RELEASED = "released"
-M.PRESSED = "pressed"
-M.STRING = "string"
-M.TABLE = "table"
-M.ZERO = "0"
+M.ACTION_TEXT = hash(sys.get_config("druid.input_text", "text"))
+M.ACTION_TOUCH = hash(sys.get_config("druid.input_touch", "touch"))
+M.ACTION_MARKED_TEXT = hash(sys.get_config("druid.input_marked_text", "marked_text"))
+M.ACTION_ESC = hash(sys.get_config("druid.input_key_esc", "key_esc"))
+M.ACTION_BACK = hash(sys.get_config("druid.input_key_back", "key_back"))
+M.ACTION_ENTER = hash(sys.get_config("druid.input_key_enter", "key_enter"))
+M.ACTION_MULTITOUCH = hash(sys.get_config("druid.input_multitouch", "touch_multi"))
+M.ACTION_BACKSPACE = hash(sys.get_config("druid.input_key_backspace", "key_backspace"))
+M.ACTION_SCROLL_UP = hash(sys.get_config("druid.input_scroll_up", "mouse_wheel_up"))
+M.ACTION_SCROLL_DOWN = hash(sys.get_config("druid.input_scroll_down", "mouse_wheel_down"))
 
+M.IS_STENCIL_CHECK = not (sys.get_config("druid.no_stencil_check") == "1")
 
 --- Component Interests
-M.ALL = "all"
-M.ON_INPUT = hash("on_input")
-M.ON_UPDATE = hash("on_update")
-M.ON_MESSAGE = hash("on_message")
-M.ON_FOCUS_LOST = hash("on_focus_lost")
-M.ON_FOCUS_GAINED = hash("on_focus_gained")
-M.ON_LAYOUT_CHANGE = hash("layout_changed")
-M.ON_LANGUAGE_CHANGE = hash("on_language_change")
-
+M.ON_INPUT = "on_input"
+M.ON_UPDATE = "update"
+M.ON_MESSAGE = "on_message"
+M.ON_LATE_INIT = "on_late_init"
+M.ON_FOCUS_LOST = "on_focus_lost"
+M.ON_FOCUS_GAINED = "on_focus_gained"
+M.ON_LAYOUT_CHANGE = "on_layout_change"
+M.ON_MESSAGE_INPUT = "on_message_input"
+M.ON_WINDOW_RESIZED = "on_window_resized"
+M.ON_LANGUAGE_CHANGE = "on_language_change"
 
+-- Components with higher priority value processed first
 M.PRIORITY_INPUT = 10
 M.PRIORITY_INPUT_HIGH = 20
 M.PRIORITY_INPUT_MAX = 100
 
+M.MESSAGE_INPUT = {
+	BUTTON_CLICK = "button_click",
+	BUTTON_LONG_CLICK = "button_long_click",
+	BUTTON_DOUBLE_CLICK = "button_double_click",
+	BUTTON_REPEATED_CLICK = "button_repeated_click",
+	TEXT_SET = "text_set",
+}
 
 M.PIVOTS = {
 	[gui.PIVOT_CENTER] = vmath.vector3(0),
@@ -54,11 +57,31 @@ M.PIVOTS = {
 	[gui.PIVOT_NW] = vmath.vector3(-0.5, 0.5, 0),
 }
 
+M.REVERSE_PIVOTS = {
+	[gui.PIVOT_CENTER] = gui.PIVOT_CENTER,
+	[gui.PIVOT_N] = gui.PIVOT_S,
+	[gui.PIVOT_NE] = gui.PIVOT_SW,
+	[gui.PIVOT_E] = gui.PIVOT_W,
+	[gui.PIVOT_SE] = gui.PIVOT_NW,
+	[gui.PIVOT_S] = gui.PIVOT_N,
+	[gui.PIVOT_SW] = gui.PIVOT_NE,
+	[gui.PIVOT_W] = gui.PIVOT_E,
+	[gui.PIVOT_NW] = gui.PIVOT_SE,
+}
 
+M.LAYOUT_MODE = {
+	STRETCH_X = "stretch_x",
+	STRETCH_Y = "stretch_y",
+	ZOOM_MIN = "zoom_min",
+	ZOOM_MAX = "zoom_max",
+	FIT = gui.ADJUST_FIT,
+	STRETCH = gui.ADJUST_STRETCH,
+}
+
+M.VECTOR_ZERO = vmath.vector3(0)
 M.SYS_INFO = sys.get_sys_info()
 M.CURRENT_SYSTEM_NAME = M.SYS_INFO.system_name
 
-
 M.OS = {
 	ANDROID = "Android",
 	IOS = "iPhone OS",
@@ -68,20 +91,26 @@ M.OS = {
 	BROWSER = "HTML5",
 }
 
-
 M.SHIFT = {
 	NO_SHIFT = 0,
 	LEFT = -1,
 	RIGHT = 1,
 }
 
+M.TEXT_ADJUST = {
+	DOWNSCALE = "downscale",
+	TRIM = "trim",
+	NO_ADJUST = "no_adjust",
+	DOWNSCALE_LIMITED = "downscale_limited",
+	SCROLL = "scroll",
+	SCALE_THEN_SCROLL = "scale_then_scroll",
+}
 
 M.SIDE = {
 	X = "x",
 	Y = "y"
 }
 
-
 M.SWIPE = {
 	UP = "up",
 	DOWN = "down",
@@ -89,16 +118,10 @@ M.SWIPE = {
 	RIGHT = "right",
 }
 
-
 M.ERRORS = {
 	GRID_DYNAMIC_ANCHOR = "The pivot of dynamic grid node should be West, East, South or North"
 }
 
-
 M.EMPTY_FUNCTION = function() end
-M.EMPTY_STRING = ""
-M.SPACE_STRING = " "
-M.EMPTY_TABLE = {}
-
 
 return M

druid/custom/pin_knob/pin_knob.gui

@@ -0,0 +1,182 @@
+script: ""
+fonts {
+  name: "game"
+  font: "/example/assets/fonts/game.font"
+}
+textures {
+  name: "kenney"
+  texture: "/example/assets/images/kenney.atlas"
+}
+background_color {
+  x: 0.0
+  y: 0.0
+  z: 0.0
+  w: 0.0
+}
+nodes {
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 1.0
+    y: 1.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  type: TYPE_BOX
+  blend_mode: BLEND_MODE_ALPHA
+  texture: "kenney/empty"
+  id: "root"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  adjust_mode: ADJUST_MODE_FIT
+  layer: ""
+  inherit_alpha: true
+  slice9 {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 0.0
+  }
+  clipping_mode: CLIPPING_MODE_NONE
+  clipping_visible: true
+  clipping_inverted: false
+  alpha: 1.0
+  template_node_child: false
+  size_mode: SIZE_MODE_AUTO
+}
+nodes {
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 2.0
+    y: 2.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 36.0
+    y: 36.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  type: TYPE_BOX
+  blend_mode: BLEND_MODE_ALPHA
+  texture: "kenney/slider_move"
+  id: "pin"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  adjust_mode: ADJUST_MODE_FIT
+  parent: "root"
+  layer: ""
+  inherit_alpha: true
+  slice9 {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 0.0
+  }
+  clipping_mode: CLIPPING_MODE_NONE
+  clipping_visible: true
+  clipping_inverted: false
+  alpha: 1.0
+  template_node_child: false
+  size_mode: SIZE_MODE_AUTO
+}
+nodes {
+  position {
+    x: 0.0
+    y: 13.5
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 0.2
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 17.0
+    y: 17.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 0.101960786
+    y: 0.101960786
+    z: 0.101960786
+    w: 1.0
+  }
+  type: TYPE_BOX
+  blend_mode: BLEND_MODE_ALPHA
+  texture: "kenney/tick"
+  id: "notch"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  adjust_mode: ADJUST_MODE_FIT
+  parent: "pin"
+  layer: ""
+  inherit_alpha: true
+  slice9 {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 0.0
+  }
+  clipping_mode: CLIPPING_MODE_NONE
+  clipping_visible: true
+  clipping_inverted: false
+  alpha: 1.0
+  template_node_child: false
+  size_mode: SIZE_MODE_AUTO
+}
+material: "/builtins/materials/gui.material"
+adjust_reference: ADJUST_REFERENCE_PARENT
+max_nodes: 512

druid/custom/pin_knob/pin_knob.lua

@@ -0,0 +1,123 @@
+-- Copyright (c) 2022 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
+
+--- Druid pin knob custom component.
+-- It's simple rotating input element
+-- @module PinKnob
+-- @within BaseComponent
+-- @alias druid.pin_knob
+
+--- The component druid instance
+-- @tfield DruidInstance druid @{DruidInstance}
+
+--- Is currently under user control
+-- @tfield bool is_drag
+
+--- The pin node
+-- @tfield node node
+
+---
+
+local const = require("druid.const")
+local component = require("druid.component")
+
+local PinKnob = component.create("druid.pin_knob", { const.ON_INPUT })
+
+local SCHEME = {
+	ROOT = "root",
+	PIN = "pin",
+}
+
+
+local function update_visual(self)
+	local rotation = vmath.vector3(0, 0, self.angle)
+	gui.set_rotation(self.node, rotation)
+end
+
+
+local function set_angle(self, value)
+	local prev_value = self.angle
+
+	self.angle = value
+	self.angle = math.min(self.angle, self.angle_max)
+	self.angle = math.max(self.angle, self.angle_min)
+	update_visual(self)
+
+	if prev_value ~= self.angle and self.callback then
+		local output_value = self.angle
+		if output_value ~= 0 then
+			output_value = -output_value
+		end
+		self.callback(self:get_context(), output_value)
+	end
+end
+
+
+--- Component init function
+-- @tparam PinKnob self @{PinKnob}
+-- @tparam function callback Callback(self, value) on value changed
+-- @tparam string template The template string name
+-- @tparam table nodes Nodes table from gui.clone_tree
+function PinKnob.init(self, callback, template, nodes)
+	self:set_template(template)
+	self:set_nodes(nodes)
+	self.druid = self:get_druid()
+	self.node = self:get_node(SCHEME.PIN)
+	self.is_drag = false
+
+	self.callback = callback
+	self:set_angle(0, -100, 100)
+	self._friction = 0.75
+end
+
+
+--- Set current and min/max angles for component
+-- @tparam PinKnob self @{PinKnob}
+-- @tparam number cur_value The new value for pin knob
+-- @tparam number min The minimum value for pin knob
+-- @tparam number max The maximum value for pin knob
+-- @treturn PinKnob @{PinKnob}
+function PinKnob.set_angle(self, cur_value, min, max)
+	self.angle_min = min or self.angle_min
+	self.angle_max = max or self.angle_max
+	set_angle(self, cur_value)
+
+	return self
+end
+
+
+--- Set current and min/max angles for component
+-- @tparam PinKnob self @{PinKnob}
+-- @tparam[opt=1] number value The spin speed multiplier
+-- @treturn PinKnob @{PinKnob}
+function PinKnob.set_friction(self, value)
+	self._friction = value or 1
+
+	return self
+end
+
+
+function PinKnob.on_input(self, action_id, action)
+	if action_id ~= const.ACTION_TOUCH then
+		return false
+	end
+
+	if gui.pick_node(self.node, action.x, action.y) then
+		if action.pressed then
+			self.pos = gui.get_position(self.node)
+			self.is_drag = true
+		end
+	end
+
+	if self.is_drag and not action.pressed then
+		set_angle(self, self.angle - action.dx * self._friction - action.dy * self._friction)
+	end
+
+	if action.released then
+		self.is_drag = false
+	end
+
+	return self.is_drag
+end
+
+
+return PinKnob

druid/custom/rich_input/rich_input.gui

@@ -0,0 +1,371 @@
+script: ""
+fonts {
+  name: "game"
+  font: "/example/assets/fonts/game.font"
+}
+textures {
+  name: "kenney"
+  texture: "/example/assets/images/kenney.atlas"
+}
+background_color {
+  x: 0.0
+  y: 0.0
+  z: 0.0
+  w: 0.0
+}
+nodes {
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 1.0
+    y: 1.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  type: TYPE_BOX
+  blend_mode: BLEND_MODE_ALPHA
+  texture: "kenney/empty"
+  id: "root"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  adjust_mode: ADJUST_MODE_FIT
+  layer: ""
+  inherit_alpha: true
+  slice9 {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 0.0
+  }
+  clipping_mode: CLIPPING_MODE_NONE
+  clipping_visible: true
+  clipping_inverted: false
+  alpha: 1.0
+  template_node_child: false
+  size_mode: SIZE_MODE_AUTO
+}
+nodes {
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 190.0
+    y: 45.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  type: TYPE_BOX
+  blend_mode: BLEND_MODE_ALPHA
+  texture: "kenney/progress_back"
+  id: "button"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  adjust_mode: ADJUST_MODE_FIT
+  parent: "root"
+  layer: ""
+  inherit_alpha: true
+  slice9 {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 0.0
+  }
+  clipping_mode: CLIPPING_MODE_NONE
+  clipping_visible: true
+  clipping_inverted: false
+  alpha: 1.0
+  template_node_child: false
+  size_mode: SIZE_MODE_AUTO
+}
+nodes {
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 0.5
+    y: 0.5
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 300.0
+    y: 60.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 0.9490196
+    y: 0.9490196
+    z: 0.9490196
+    w: 1.0
+  }
+  type: TYPE_TEXT
+  blend_mode: BLEND_MODE_ALPHA
+  text: "Placeholder"
+  font: "game"
+  id: "placeholder_text"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  outline {
+    x: 0.4
+    y: 0.4
+    z: 0.4
+    w: 1.0
+  }
+  shadow {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  adjust_mode: ADJUST_MODE_FIT
+  line_break: false
+  parent: "button"
+  layer: ""
+  inherit_alpha: true
+  alpha: 1.0
+  outline_alpha: 1.0
+  shadow_alpha: 0.0
+  template_node_child: false
+  text_leading: 1.0
+  text_tracking: 0.0
+}
+nodes {
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 0.6
+    y: 0.6
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 300.0
+    y: 60.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  type: TYPE_TEXT
+  blend_mode: BLEND_MODE_ALPHA
+  text: "User input"
+  font: "game"
+  id: "input_text"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  outline {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  shadow {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  adjust_mode: ADJUST_MODE_FIT
+  line_break: false
+  parent: "button"
+  layer: ""
+  inherit_alpha: true
+  alpha: 1.0
+  outline_alpha: 1.0
+  shadow_alpha: 0.0
+  template_node_child: false
+  text_leading: 1.0
+  text_tracking: 0.0
+}
+nodes {
+  position {
+    x: 67.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 0.6
+    y: 0.6
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 1.0
+    y: 1.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  type: TYPE_BOX
+  blend_mode: BLEND_MODE_ALPHA
+  texture: "kenney/empty"
+  id: "cursor_node"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  adjust_mode: ADJUST_MODE_FIT
+  parent: "button"
+  layer: ""
+  inherit_alpha: true
+  slice9 {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 0.0
+  }
+  clipping_mode: CLIPPING_MODE_NONE
+  clipping_visible: true
+  clipping_inverted: false
+  alpha: 1.0
+  template_node_child: false
+  size_mode: SIZE_MODE_AUTO
+}
+nodes {
+  position {
+    x: 0.0
+    y: 2.0
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 20.0
+    y: 40.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 0.2
+    y: 0.2
+    z: 0.2
+    w: 1.0
+  }
+  type: TYPE_TEXT
+  blend_mode: BLEND_MODE_ALPHA
+  text: "|"
+  font: "game"
+  id: "cursor_text"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  outline {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  shadow {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  adjust_mode: ADJUST_MODE_FIT
+  line_break: false
+  parent: "cursor_node"
+  layer: ""
+  inherit_alpha: true
+  alpha: 1.0
+  outline_alpha: 0.0
+  shadow_alpha: 0.0
+  template_node_child: false
+  text_leading: 1.0
+  text_tracking: 0.0
+}
+material: "/builtins/materials/gui.material"
+adjust_reference: ADJUST_REFERENCE_PARENT
+max_nodes: 512

druid/custom/rich_input/rich_input.lua

@@ -0,0 +1,95 @@
+-- Copyright (c) 2022 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
+
+--- Druid Rich Input custom component.
+-- It's wrapper on Input component with cursor and placeholder text
+-- @module RichInput
+-- @within Input
+-- @alias druid.rich_input
+
+--- The component druid instance
+-- @tfield DruidInstance druid @{DruidInstance}
+
+--- On input field text change callback(self, input_text)
+-- @tfield Input input @{Input}
+
+--- On input field text change to empty string callback(self, input_text)
+-- @tfield node cursor
+
+--- On input field text change to max length string callback(self, input_text)
+-- @tfield druid.text placeholder @{Text}
+
+---
+
+local component = require("druid.component")
+
+local RichInput = component.create("druid.rich_input")
+
+local SCHEME = {
+	ROOT = "root",
+	BUTTON = "button",
+	PLACEHOLDER = "placeholder_text",
+	INPUT = "input_text",
+	CURSOR = "cursor_node",
+}
+
+
+local function animate_cursor(self)
+	gui.cancel_animation(self.cursor, gui.PROP_COLOR)
+	gui.set_color(self.cursor, vmath.vector4(1))
+	gui.animate(self.cursor, gui.PROP_COLOR, vmath.vector4(1,1,1,0), gui.EASING_INSINE, 0.8, 0, nil, gui.PLAYBACK_LOOP_PINGPONG)
+end
+
+
+local function update_text(self, text)
+	local text_width = self.input.total_width
+	animate_cursor(self)
+	gui.set_position(self.cursor, vmath.vector3(text_width/2, 0, 0))
+	gui.set_scale(self.cursor, self.input.text.scale)
+end
+
+
+local function on_select(self)
+	gui.set_enabled(self.cursor, true)
+	gui.set_enabled(self.placeholder.node, false)
+	animate_cursor(self)
+end
+
+
+local function on_unselect(self)
+	gui.set_enabled(self.cursor, false)
+	gui.set_enabled(self.placeholder.node, true and #self.input:get_text() == 0)
+end
+
+
+--- Component init function
+-- @tparam RichInput self @{RichInput}
+-- @tparam string template The template string name
+-- @tparam table nodes Nodes table from gui.clone_tree
+function RichInput.init(self, template, nodes)
+	self:set_template(template)
+	self:set_nodes(nodes)
+	self.druid = self:get_druid()
+	self.input = self.druid:new_input(self:get_node(SCHEME.BUTTON), self:get_node(SCHEME.INPUT))
+	self.cursor = self:get_node(SCHEME.CURSOR)
+
+	self.input:set_text("")
+	self.placeholder = self.druid:new_text(self:get_node(SCHEME.PLACEHOLDER))
+
+	self.input.on_input_text:subscribe(update_text)
+	self.input.on_input_select:subscribe(on_select)
+	self.input.on_input_unselect:subscribe(on_unselect)
+	on_unselect(self)
+	update_text(self, "")
+end
+
+
+--- Set placeholder text
+-- @tparam RichInput self @{RichInput}
+-- @tparam string placeholder_text The placeholder text
+function RichInput.set_placeholder(self, placeholder_text)
+	self.placeholder:set_to(placeholder_text)
+	return self
+end
+
+
+return RichInput

druid/custom/rich_text/module/rt.lua

@@ -0,0 +1,543 @@
+-- Source: https://github.com/britzl/defold-richtext version 5.19.0
+-- Author: Britzl
+-- Modified by: Insality
+
+--- RT
+-- @module rich_text.rt
+-- @local
+
+local helper = require("druid.helper")
+local parser = require("druid.custom.rich_text.module.rt_parse")
+local utf8_lua = require("druid.system.utf8")
+local utf8 = utf8 or utf8_lua
+
+local M = {}
+
+-- Trim spaces on string start
+local function ltrim(text)
+	return text:match('^%s*(.*)')
+end
+
+
+-- compare two words and check that they have the same size, color, font and tags
+local function compare_words(one, two)
+	if one == nil
+	or two == nil
+	or one.size ~= two.size
+	or one.color ~= two.color
+	or one.shadow ~= two.shadow
+	or one.outline ~= two.outline
+	or one.font ~= two.font then
+		return false
+	end
+	local one_tags, two_tags = one.tags, two.tags
+	if one_tags == two_tags then
+		return true
+	end
+	if one_tags == nil or two_tags == nil then
+		return false
+	end
+	for k, v in pairs(one_tags) do
+		if two_tags[k] ~= v then
+			return false
+		end
+	end
+	for k, v in pairs(two_tags) do
+		if one_tags[k] ~= v then
+			return false
+		end
+	end
+	return true
+end
+
+
+--- Get the length of a text ignoring any tags except image tags
+-- which are treated as having a length of 1
+-- @param text String with text or a list of words (from richtext.create)
+-- @return Length of text
+function M.length(text)
+	assert(text)
+	if type(text) == "string" then
+		return parser.length(text)
+	else
+		local count = 0
+		for i = 1, #text do
+			local word = text[i]
+			local is_text_node = not word.image
+			count = count + (is_text_node and utf8.len(word.text) or 1)
+		end
+		return count
+	end
+end
+
+
+---@param word rich_text.word
+---@param previous_word rich_text.word|nil
+---@param settings rich_text.settings
+---@return rich_text.metrics
+local function get_text_metrics(word, previous_word, settings)
+	local text = word.text
+	local font_resource = gui.get_font_resource(word.font)
+
+	---@type druid.rich_text.metrics
+	local metrics
+	local word_scale_x = word.relative_scale * settings.text_scale.x * settings.adjust_scale
+	local word_scale_y = word.relative_scale * settings.text_scale.y * settings.adjust_scale
+
+	if utf8.len(text) == 0 then
+		metrics = resource.get_text_metrics(font_resource, "|")
+		metrics.width = 0
+		metrics.height = metrics.height * word_scale_y
+	else
+		metrics = resource.get_text_metrics(font_resource, text)
+		metrics.width = metrics.width * word_scale_x
+		metrics.height = metrics.height * word_scale_y
+
+		if previous_word and not previous_word.image then
+			local previous_word_metrics = resource.get_text_metrics(font_resource, previous_word.text)
+			local union_metrics = resource.get_text_metrics(font_resource, previous_word.text .. text)
+
+			local without_previous_width = metrics.width
+			metrics.width = (union_metrics.width - previous_word_metrics.width) * word_scale_x
+			-- Since the several characters can be ajusted to fit the space between the previous word and this word
+			-- For example: chars: [.,?!]
+			metrics.offset_x = metrics.width - without_previous_width
+		end
+	end
+
+	metrics.offset_x = metrics.offset_x or 0
+	metrics.offset_y = metrics.offset_y or 0
+
+	return metrics
+end
+
+
+---@param word druid.rich_text.word
+---@param settings druid.rich_text.settings
+---@return druid.rich_text.metrics
+local function get_image_metrics(word, settings)
+	local node_prefab = settings.node_prefab
+	gui.play_flipbook(node_prefab, word.image.anim)
+	local node_size = gui.get_size(node_prefab)
+	local aspect = node_size.x / node_size.y
+	node_size.x = word.image.width or node_size.x
+	node_size.y = word.image.height or (node_size.x / aspect)
+
+	return {
+		width = node_size.x * word.relative_scale * settings.node_scale.x * settings.adjust_scale,
+		height = node_size.y * word.relative_scale * settings.node_scale.y * settings.adjust_scale,
+		node_size = node_size,
+	}
+end
+
+
+---@param word druid.rich_text.word
+---@param settings druid.rich_text.settings
+---@param previous_word druid.rich_text.word|nil
+---@return druid.rich_text.metrics
+local function measure_node(word, settings, previous_word)
+	local metrics = word.image and get_image_metrics(word, settings) or get_text_metrics(word, previous_word, settings)
+	return metrics
+end
+
+
+-- Create rich text gui nodes from text
+--- @param text string The text to create rich text nodes from
+--- @param settings table Optional settings table (refer to documentation for details)
+--- @param style druid.rich_text.style
+--- @return words
+--- @return metrics
+function M.create(text, settings, style)
+	assert(text, "You must provide a text")
+
+	-- default settings for a word
+	-- will be assigned to each word unless tags override the values
+	local font = gui.get_font(settings.text_prefab)
+	local word_params = {
+		node = nil, -- Autofill on node creation
+		relative_scale = 1,
+		color = nil,
+		position = nil, -- Autofill later
+		scale = nil, -- Autofill later
+		size = nil, -- Autofill later
+		pivot = nil, -- Autofill later
+		offset = nil, -- Autofill later
+		metrics = {},
+		-- text params
+		source_text = nil,
+		text = nil, -- Autofill later in parse.lua
+		text_color = gui.get_color(settings.text_prefab),
+		shadow = settings.shadow,
+		outline = settings.outline,
+		font = font,
+		-- Image params
+		---@type rich_text.word.image
+		image = nil,
+		image_color = gui.get_color(settings.node_prefab),
+		default_animation = nil,
+		-- Tags
+		br = nil,
+		nobr = nil,
+	}
+
+	local parsed_words = parser.parse(text, word_params, style)
+	local lines = M._split_on_lines(parsed_words, settings)
+	local lines_metrics = M._position_lines(lines, settings)
+	M._update_nodes(lines, settings)
+
+	local words = {}
+	for index = 1, #lines do
+		helper.add_array(words, lines[index])
+	end
+
+	return words, settings, lines_metrics
+end
+
+
+---@param word druid.rich_text.word
+---@param metrics druid.rich_text.metrics
+---@param settings druid.rich_text.settings
+function M._fill_properties(word, metrics, settings)
+	word.metrics = metrics
+	word.position = vmath.vector3(0)
+
+	if word.image then
+		-- Image properties
+		word.scale = gui.get_scale(settings.node_prefab) * word.relative_scale * settings.adjust_scale
+		word.pivot = gui.get_pivot(settings.node_prefab)
+		word.size = metrics.node_size
+		word.offset = vmath.vector3(0, 0, 0)
+		if word.image.width then
+			word.size.y = word.image.height or (word.size.y * word.image.width / word.size.x)
+			word.size.x = word.image.width
+		end
+	else
+		-- Text properties
+		word.scale = gui.get_scale(settings.text_prefab) * word.relative_scale * settings.adjust_scale
+		word.pivot = gui.get_pivot(settings.text_prefab)
+		word.size = vmath.vector3(metrics.width, metrics.height, 0)
+		word.offset = vmath.vector3(metrics.offset_x, metrics.offset_y, 0)
+	end
+end
+
+
+---@param words druid.rich_text.word[]
+---@param settings druid.rich_text.settings
+---@return druid.rich_text.word[][]
+function M._split_on_lines(words, settings)
+	local i = 1
+	local lines = {}
+	local current_line = {}
+	local word_count = #words
+	local current_line_width = 0
+	local current_line_height = 0
+
+	repeat
+		local word = words[i]
+		if word.image then
+			word.default_animation = settings.default_animation
+		end
+
+		-- Reset texts to start measure again
+		word.text = word.source_text
+
+		-- get the previous word, so we can combine
+		local previous_word = current_line[#current_line]
+		if settings.combine_words then
+			if not compare_words(previous_word, word) then
+				previous_word = nil
+			end
+		end
+
+		local word_metrics = measure_node(word, settings)
+
+		local next_words_width = word_metrics.width
+		-- Collect width of nobr words from current to next words with nobr
+		if word.nobr then
+			for index = i + 1, word_count do
+				if words[index].nobr then
+					local next_word_measure = measure_node(words[index], settings, words[index-1])
+					next_words_width = next_words_width + next_word_measure.width
+				else
+					break
+				end
+			end
+		end
+		local overflow = (current_line_width + next_words_width) > settings.width
+		local is_new_line = (overflow or word.br) and settings.is_multiline and not word.nobr
+
+		-- We recalculate metrics with previous_word if it follow for word on current line
+		if not is_new_line and previous_word then
+			word_metrics = measure_node(word, settings, previous_word)
+		end
+
+		-- Trim first word of the line
+		if is_new_line or not previous_word then
+			word.text = ltrim(word.text)
+			word_metrics = measure_node(word, settings, nil)
+		end
+		M._fill_properties(word, word_metrics, settings)
+
+		-- check if the line overflows due to this word
+		if not is_new_line then
+			-- the word fits on the line, add it and update text metrics
+			current_line_width = current_line_width + word.metrics.width
+			current_line_height = math.max(current_line_height, word.metrics.height)
+			current_line[#current_line + 1] = word
+		else
+			-- overflow, position the words that fit on the line
+			lines[#lines + 1] = current_line
+
+			word.text = ltrim(word.text)
+			current_line = { word }
+			current_line_height = word.metrics.height
+			current_line_width = word.metrics.width
+		end
+
+		i = i + 1
+	until i > word_count
+
+	if #current_line > 0 then
+		lines[#lines + 1] = current_line
+	end
+
+	return lines
+end
+
+
+---@param lines rich_text.word[][]
+---@param settings rich_text.settings
+---@return rich_text.lines_metrics
+function M._position_lines(lines, settings)
+	local lines_metrics = M._get_lines_metrics(lines, settings)
+	-- current x-y is left top point of text spawn
+
+	local parent_size = gui.get_size(settings.parent)
+	local pivot = helper.get_pivot_offset(gui.get_pivot(settings.parent))
+	local offset_y = (parent_size.y - lines_metrics.text_height) * (pivot.y - 0.5) - (parent_size.y * (pivot.y - 0.5))
+
+	local current_y = offset_y
+	for line_index = 1, #lines do
+		local line = lines[line_index]
+		local line_metrics = lines_metrics.lines[line_index]
+		local current_x = (parent_size.x - line_metrics.width) * (pivot.x + 0.5) - (parent_size.x * (pivot.x + 0.5))
+		local max_height = 0
+		for word_index = 1, #line do
+			local word = line[word_index]
+			local pivot_offset = helper.get_pivot_offset(word.pivot)
+			local word_width = word.metrics.width
+			word.position.x = current_x + word_width * (pivot_offset.x + 0.5) + word.offset.x
+			word.position.y = current_y + word.metrics.height * (pivot_offset.y - 0.5) + word.offset.y
+
+			-- Align item on text line depends on anchor
+			word.position.y = word.position.y - (word.metrics.height - line_metrics.height) * (pivot_offset.y - 0.5)
+
+			current_x = current_x + word_width
+
+			-- TODO: check if we need to calculate images
+			if not word.image then
+				max_height = math.max(max_height, word.metrics.height)
+			end
+
+			if settings.image_pixel_grid_snap and word.image then
+				word.position.x = helper.round(word.position.x)
+				word.position.y = helper.round(word.position.y)
+			end
+		end
+
+		current_y = current_y - line_metrics.height
+	end
+
+	return lines_metrics
+end
+
+
+---@param lines rich_text.word[][]
+---@param settings rich_text.settings
+---@return rich_text.lines_metrics
+function M._get_lines_metrics(lines, settings)
+	local metrics = {}
+	local text_width = 0
+	local text_height = 0
+	for line_index = 1, #lines do
+		local line = lines[line_index]
+		local width = 0
+		local height = 0
+		for word_index = 1, #line do
+			local word = line[word_index]
+			local word_width = word.metrics.width
+			width = width + word_width
+			-- TODO: Here too
+			if not word.image then
+				height = math.max(height, word.metrics.height)
+			end
+		end
+
+		if line_index > 1 then
+			height = height * settings.text_leading
+		end
+
+		text_width = math.max(text_width, width)
+		text_height = text_height + height
+
+		metrics[#metrics + 1] = {
+			width = width,
+			height = height,
+		}
+	end
+
+	---@type rich_text.lines_metrics
+	local lines_metrics = {
+		text_width = text_width,
+		text_height = text_height,
+		lines = metrics,
+	}
+
+	return lines_metrics
+end
+
+
+---@param lines rich_text.word[][]
+---@param settings rich_text.settings
+function M._update_nodes(lines, settings)
+	for line_index = 1, #lines do
+		local line = lines[line_index]
+		for word_index = 1, #line do
+			local word = line[word_index]
+			local node
+			if word.image then
+				node = word.node or gui.clone(settings.node_prefab)
+				gui.set_size_mode(node, gui.SIZE_MODE_MANUAL)
+				gui.play_flipbook(node, hash(word.image.anim or word.default_animation))
+				gui.set_color(node, word.color or word.image_color)
+			else
+				node = word.node or gui.clone(settings.text_prefab)
+				gui.set_outline(node, word.outline)
+				gui.set_shadow(node, word.shadow)
+				gui.set_text(node, word.text)
+				gui.set_color(node, word.color or word.text_color)
+				gui.set_font(node, word.font or settings.font)
+			end
+			word.node = node
+			gui.set_enabled(node, true)
+			gui.set_parent(node, settings.parent)
+			gui.set_size(node, word.size)
+			gui.set_scale(node, word.scale)
+			gui.set_position(node, word.position)
+		end
+	end
+end
+
+
+---@param words rich_text.word[]
+---@param settings rich_text.settings
+---@param scale number
+---@return rich_text.lines_metrics
+function M.set_text_scale(words, settings, scale)
+	settings.adjust_scale = scale
+
+	local lines = M._split_on_lines(words, settings)
+	local line_metrics = M._position_lines(lines, settings)
+	M._update_nodes(lines, settings)
+
+	return line_metrics
+end
+
+
+---@param words druid.rich_text.word[]
+---@param settings druid.rich_text.settings
+---@param lines_metrics druid.rich_text.lines_metrics
+---@param style druid.rich_text.style
+function M.adjust_to_area(words, settings, lines_metrics, style)
+	local last_line_metrics = lines_metrics
+
+	if not settings.is_multiline then
+		if lines_metrics.text_width > settings.width then
+			last_line_metrics = M.set_text_scale(words, settings, settings.width / lines_metrics.text_width)
+		end
+	else
+		-- Multiline adjusting is very tricky stuff...
+		-- It's doing a lot of calculations, beware!
+		if lines_metrics.text_width > settings.width or lines_metrics.text_height > settings.height then
+			local scale_koef = math.sqrt(settings.height / lines_metrics.text_height)
+			if lines_metrics.text_width * scale_koef > settings.width then
+				scale_koef = math.sqrt(settings.width / lines_metrics.text_width)
+			end
+			local adjust_scale = math.min(scale_koef, 1)
+
+			local lines = M.apply_scale_without_update(words, settings, adjust_scale)
+			local is_fit = M.is_fit_info_area(lines, settings)
+			local step = is_fit and style.ADJUST_SCALE_DELTA or -style.ADJUST_SCALE_DELTA
+
+			for i = 1, style.ADJUST_STEPS do
+				-- Grow down to check if we fit
+				if step < 0 and is_fit then
+					last_line_metrics = M.set_text_scale(words, settings, adjust_scale)
+					break
+				end
+				-- Grow up to check if we still fit
+				if step > 0 and not is_fit then
+					last_line_metrics = M.set_text_scale(words, settings, adjust_scale - step)
+					break
+				end
+
+				adjust_scale = adjust_scale + step
+				lines = M.apply_scale_without_update(words, settings, adjust_scale)
+				is_fit = M.is_fit_info_area(lines, settings)
+
+				if i == style.ADJUST_STEPS then
+					last_line_metrics = M.set_text_scale(words, settings, adjust_scale)
+				end
+			end
+		end
+	end
+
+	return last_line_metrics
+end
+
+
+---@return boolean @If we fit into area size
+function M.apply_scale_without_update(words, settings, scale)
+	settings.adjust_scale = scale
+	return M._split_on_lines(words, settings)
+end
+
+
+---@param lines rich_text.word[][]
+---@param settings rich_text.settings
+function M.is_fit_info_area(lines, settings)
+	local lines_metrics = M._get_lines_metrics(lines, settings)
+	local area_size = gui.get_size(settings.parent)
+	return lines_metrics.text_width <= area_size.x and lines_metrics.text_height <= area_size.y
+end
+
+
+--- Get all words with a specific tag
+-- @param words The words to search (as received from richtext.create)
+-- @param tag The tag to search for. Nil to search for words without a tag
+-- @return Words matching the tag
+function M.tagged(words, tag)
+	local tagged = {}
+	for i = 1, #words do
+		local word = words[i]
+		if not tag and not word.tags then
+			tagged[#tagged + 1] = word
+		elseif word.tags and word.tags[tag] then
+			tagged[#tagged + 1] = word
+		end
+	end
+	return tagged
+end
+
+
+---Removes the gui nodes created by rich text
+function M.remove(words)
+	assert(words)
+
+	for i = 1, #words do
+		gui.delete_node(words[i].node)
+	end
+end
+
+
+return M

druid/custom/rich_text/module/rt_color.lua

@@ -0,0 +1,50 @@
+-- Source: https://github.com/britzl/defold-richtext version 5.19.0
+-- Author: Britzl
+-- Modified by: Insality
+
+local M = {}
+local cache = {}
+
+function M.parse_hex(hex)
+	if cache[hex] then
+		return cache[hex]
+	end
+
+	local r,g,b,a = hex:match("#?(%x%x)(%x%x)(%x%x)(%x?%x?)")
+	if a == "" then a = "ff" end
+	if r and g and b and a then
+		local color = vmath.vector4(
+			tonumber(r, 16) / 255,
+			tonumber(g, 16) / 255,
+			tonumber(b, 16) / 255,
+			tonumber(a, 16) / 255
+		)
+
+		cache[hex] = color
+		return color
+	end
+	return nil
+end
+
+
+function M.parse_decimal(dec)
+	if cache[dec] then
+		return cache[dec]
+	end
+
+	local r,g,b,a = dec:match("(%d*%.?%d*),(%d*%.?%d*),(%d*%.?%d*),(%d*%.?%d*)")
+	if r and g and b and a then
+		local color = vmath.vector4(tonumber(r), tonumber(g), tonumber(b), tonumber(a))
+		cache[dec] = color
+		return color
+	end
+	return nil
+end
+
+
+function M.parse(c)
+	return M.parse_hex(c) or M.parse_decimal(c)
+end
+
+
+return M

druid/custom/rich_text/module/rt_parse.lua

@@ -0,0 +1,189 @@
+-- Source: https://github.com/britzl/defold-richtext version 5.19.0
+-- Author: Britzl
+-- Modified by: Insality
+
+local tags = require("druid.custom.rich_text.module.rt_tags")
+local utf8_lua = require("druid.system.utf8")
+local utf8 = utf8 or utf8_lua
+
+local M = {}
+
+local function parse_tag(tag, params, style)
+	local settings = { tags = { [tag] = params }, tag = tag }
+	if not tags.apply(tag, params, settings, style) then
+		settings[tag] = params
+	end
+
+	return settings
+end
+
+
+-- add a single word to the list of words
+local function add_word(text, settings, words)
+	-- handle HTML entities
+	text = text:gsub("&lt;", "<"):gsub("&gt;", ">"):gsub("&nbsp;", " ")
+
+	local data = { text = text, source_text = text }
+	for k,v in pairs(settings) do
+		data[k] = v
+	end
+
+	words[#words + 1] = data
+end
+
+
+-- split a line into words
+local function split_line(line, settings, words)
+	assert(line)
+	assert(settings)
+	assert(words)
+
+	local ws_start, trimmed_text, ws_end = line:match("^(%s*)(.-)(%s*)$")
+	if trimmed_text == "" then
+		add_word(ws_start .. ws_end, settings, words)
+	else
+		local wi = #words
+		for word in trimmed_text:gmatch("%S+") do
+			add_word(word .. " ", settings, words)
+		end
+		local first = words[wi + 1]
+		first.text = ws_start .. first.text
+		first.source_text = first.text
+		local last = words[#words]
+		last.text = utf8.sub(last.text, 1, utf8.len(last.text) - 1) .. ws_end
+		last.source_text = last.text
+	end
+end
+
+
+-- split text
+-- split by lines first
+local function split_text(text, settings, words)
+	assert(text)
+	assert(settings)
+	assert(words)
+	-- special treatment of empty text with a linebreak <br/>
+	if text == "" and settings.linebreak then
+		add_word(text, settings, words)
+		return
+	end
+
+	-- we don't want to deal with \r\n, remove all \r
+	text = text:gsub("\r", "")
+
+	-- the Lua pattern expects the text to have a linebreak at the end
+	local added_linebreak = false
+	if text:sub(-1)~="\n" then
+		added_linebreak = true
+		text = text .. "\n"
+	end
+
+	-- split into lines
+	for line in text:gmatch("(.-)\n") do
+		split_line(line, settings, words)
+		-- flag last word of a line as having a linebreak
+		local last = words[#words]
+		last.linebreak = true
+	end
+
+	-- remove the last linebreak if we manually added it above
+	if added_linebreak then
+		local last = words[#words]
+		last.linebreak = false
+	end
+end
+
+
+-- Merge one tag into another
+local function merge_tags(dst, src)
+	for k, v in pairs(src) do
+		if k ~= "tags" then
+			dst[k] = v
+		end
+	end
+	for tag, params in pairs(src.tags or {}) do
+		dst.tags[tag] = (params == "") and true or params
+	end
+end
+
+
+--- Parse the text into individual words
+-- @param text The text to parse
+-- @param default_settings Default settings for each word
+-- @param color_aliases Color aliases table
+-- @return List of all words
+function M.parse(text, default_settings, style)
+	assert(text)
+	assert(default_settings)
+
+	text = text:gsub("&zwsp;", "<zwsp>\226\128\139</zwsp>")
+	local all_words = {}
+	local open_tags = {}
+
+	while true do
+		-- merge list of word settings from defaults and all open tags
+		local word_settings = { tags = {} }
+		merge_tags(word_settings, default_settings)
+		for _, open_tag in ipairs(open_tags) do
+			merge_tags(word_settings, open_tag)
+		end
+
+		-- find next tag, with the text before and after the tag
+		local before_tag, tag, after_tag = text:match("(.-)(</?%S->)(.*)")
+
+		-- no more tags, split and add rest of the text
+		if not before_tag or not tag or not after_tag then
+			if text ~= "" then
+				split_text(text, word_settings, all_words)
+			end
+			break
+		end
+
+		-- split and add text before the encountered tag
+		if before_tag ~= "" then
+			split_text(before_tag, word_settings, all_words)
+		end
+
+		-- parse the tag, split into name and optional parameters
+		local endtag, name, params, empty = tag:match("<(/?)(%a+)=?(%S-)(/?)>")
+
+		local is_endtag = endtag == "/"
+		local is_empty = empty == "/"
+		if is_empty then
+			-- empty tag, ie tag without content
+			-- example <br/> and <img=texture:image/>
+			local empty_tag_settings = parse_tag(name, params, style)
+			merge_tags(empty_tag_settings, word_settings)
+			add_word("", empty_tag_settings, all_words)
+		elseif not is_endtag then
+			-- open tag - parse and add it
+			local tag_settings = parse_tag(name, params, style)
+			open_tags[#open_tags + 1] = tag_settings
+		else
+			-- end tag - remove it from the list of open tags
+			local found = false
+			for i=#open_tags,1,-1 do
+				if open_tags[i].tag == name then
+					table.remove(open_tags, i)
+					found = true
+					break
+				end
+			end
+			if not found then print(("Found end tag '%s' without matching start tag"):format(name)) end
+		end
+
+		-- parse text after the tag on the next iteration
+		text = after_tag
+	end
+
+	return all_words
+end
+
+
+--- Get the length of a text, excluding any tags (except image and spine tags)
+function M.length(text)
+	return utf8.len(text:gsub("<img.-/>", " "):gsub("<.->", ""))
+end
+
+
+return M

druid/custom/rich_text/module/rt_tags.lua

@@ -0,0 +1,113 @@
+-- Source: https://github.com/britzl/defold-richtext version 5.19.0
+-- Author: Britzl
+-- Modified by: Insality
+
+local color = require("druid.custom.rich_text.module.rt_color")
+
+local M = {}
+local tags = {}
+
+
+function M.apply(tag, params, settings, style)
+	local fn = tags[tag]
+	if not fn then
+		return false
+	end
+
+	fn(params, settings, style)
+	return true
+end
+
+
+function M.register(tag, fn)
+	assert(tag, "You must provide a tag")
+	assert(fn, "You must provide a tag function")
+	tags[tag] = fn
+end
+
+
+-- Split string at first occurrence of token
+-- If the token doesn't exist the whole string is returned
+-- @param s The string to split
+-- @param token The token to split string on
+-- @return before The string before the token or the whole string if token doesn't exist
+-- @return after The string after the token or nul
+local function split(s, token)
+	if not s then return nil, nil end
+	local before, after = s:match("(.-)" .. token .. "(.*)")
+	before = before or s
+	return before, after
+end
+
+
+-- Format: <color=[#]{HEX_VALUE}>{Text}</color>
+-- Format: <color={COLOR_NAME}>{Text}</color>
+-- Example: <color=FF0000>Rich Text</color>
+M.register("color", function(params, settings, style)
+	params = style.COLORS[params] or params
+	settings.color = color.parse(params)
+end)
+
+
+M.register("shadow", function(params, settings, style)
+	params = style.COLORS[params] or params
+	settings.shadow = color.parse(params)
+end)
+
+
+M.register("outline", function(params, settings, style)
+	params = style.COLORS[params] or params
+	settings.outline = color.parse(params)
+end)
+
+
+M.register("font", function(params, settings)
+	settings.font = params
+end)
+
+
+M.register("size", function(params, settings)
+	settings.relative_scale = tonumber(params)
+end)
+
+
+-- Example: </br>
+M.register("br", function(params, settings)
+	settings.br = true
+end)
+
+
+-- Example: <nobr></nobr>
+M.register("nobr", function(params, settings)
+	settings.nobr = true
+end)
+
+
+-- Format: <img={animation_id},[width],[height]/>
+-- Example: <img=logo/>
+-- Example: <img=logo,48/>
+-- Example: <img=logo,48,48/>
+M.register("img", function(params, settings)
+	local texture_and_anim, params = split(params, ",")
+	local width, height
+	width, params = split(params, ",")
+	height = split(params, ",")
+	local texture, anim = split(texture_and_anim, ":")
+	if not anim then
+		anim = texture
+		texture = nil
+	end
+
+	width = width and tonumber(width)
+	height = height and tonumber(height)
+
+	settings.image = {
+		texture = texture,
+		anim = anim,
+		width = width,
+		height = height
+	}
+end)
+
+
+return M

druid/custom/rich_text/rich_text.gui

@@ -0,0 +1,199 @@
+script: ""
+fonts {
+  name: "game"
+  font: "/example/assets/fonts/game.font"
+}
+textures {
+  name: "items"
+  texture: "/example/assets/images/kenney.atlas"
+}
+background_color {
+  x: 0.0
+  y: 0.0
+  z: 0.0
+  w: 0.0
+}
+nodes {
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 400.0
+    y: 100.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  type: TYPE_BOX
+  blend_mode: BLEND_MODE_ALPHA
+  texture: ""
+  id: "root"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  adjust_mode: ADJUST_MODE_FIT
+  layer: ""
+  inherit_alpha: true
+  slice9 {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 0.0
+  }
+  clipping_mode: CLIPPING_MODE_NONE
+  clipping_visible: true
+  clipping_inverted: false
+  alpha: 1.0
+  template_node_child: false
+  size_mode: SIZE_MODE_MANUAL
+  custom_type: 0
+  enabled: true
+  visible: false
+}
+nodes {
+  position {
+    x: -200.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 400.0
+    y: 100.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  type: TYPE_TEXT
+  blend_mode: BLEND_MODE_ALPHA
+  text: "Rich text"
+  font: "game"
+  id: "text_prefab"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_W
+  outline {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  shadow {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  adjust_mode: ADJUST_MODE_FIT
+  line_break: false
+  parent: "root"
+  layer: ""
+  inherit_alpha: true
+  alpha: 1.0
+  outline_alpha: 0.0
+  shadow_alpha: 0.0
+  template_node_child: false
+  text_leading: 1.0
+  text_tracking: 0.0
+  custom_type: 0
+  enabled: true
+  visible: true
+}
+nodes {
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 21.0
+    y: 20.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  type: TYPE_BOX
+  blend_mode: BLEND_MODE_ALPHA
+  texture: "items/checkmark"
+  id: "icon_prefab"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  adjust_mode: ADJUST_MODE_FIT
+  parent: "root"
+  layer: ""
+  inherit_alpha: true
+  slice9 {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 0.0
+  }
+  clipping_mode: CLIPPING_MODE_NONE
+  clipping_visible: true
+  clipping_inverted: false
+  alpha: 1.0
+  template_node_child: false
+  size_mode: SIZE_MODE_AUTO
+  custom_type: 0
+  enabled: true
+  visible: true
+}
+material: "/builtins/materials/gui.material"
+adjust_reference: ADJUST_REFERENCE_PARENT
+max_nodes: 512

druid/custom/rich_text/rich_text.lua

@@ -0,0 +1,272 @@
+-- Copyright (c) 2022 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
+
+--- Druid Rich Text Custom Component.
+-- <b># Overview #</b>
+--
+-- This custom component is inspired by <a href="https://github.com/britzl/defold-richtext" target="_blank">defold-richtext</a> by britzl.
+-- It uses a similar syntax for tags but currently supports fewer tags.
+--
+-- All parameters for the Rich Text component are adjusted in the GUI scene.
+--
+-- This component uses GUI component template. (/druid/custom/rich_text/rich_text.gui).
+--
+-- You able to customize it or make your own with the next node scructure:
+--
+-- root
+--
+--   - text_prefab
+--
+--   - icon_prefab
+--
+-- <b># Rich Text Setup #</b>
+--
+-- • Root node size: Set the maximum width and height of the text.
+--
+-- • Root anchor: Define the alignment of the Rich Text inside the root node size area.
+--
+-- • Text prefab: Configure all default text parameters for the text node.
+--
+-- • Text prefab anchor: Set the anchor for each text node (adjust this only if animating text).
+--
+-- • Icon prefab: Configure all default node parameters for the icon node.
+--
+-- • Icon prefab anchor: Set the anchor for each icon node (adjust this only if animating the icon).
+--
+-- <b># Notes #</b>
+--
+-- • Nested tags are supported
+--
+-- <a href="https://insality.github.io/druid/druid/index.html?example=custom_rich_text" target="_blank"><b>Example Link</b></a>
+-- @usage
+-- local RichText = require("druid.custom.rich_text.rich_text")
+-- ...
+-- self.rich_text = self.druid:new(RichText, "rich_text")
+-- self.rich_text:set_text("Hello, Druid Rich Text!")
+-- @usage
+-- type druid.rich_text.word = {
+--   node: Node,
+--   relative_scale: number,
+--   color: vector4,
+--   position: vector3,
+--   offset: vector3,
+--   scale: vector3,
+--   size: vector3,
+--   metrics: druid.rich_text.metrics,
+--   pivot: Pivot,
+--   text: string,
+--   shadow: vector4,
+--   outline: vector4,
+--   font: string,
+--   image: druid.rich_text.image,
+--   default_animation: string,
+--   br: boolean,
+--   nobr: boolean,
+-- }
+--
+-- type druid.rich_text.word.image = {
+--   texture: string,
+--   anim: string,
+--   width: number,
+--   height: number,
+-- }
+--
+-- type druid.rich_text.lines_metrics = {
+--   text_width: number,
+--   text_height: number,
+--   lines: table<number, druid.rich_text.metrics>,
+-- }
+--
+-- type druid.rich_text.metrics = {
+--   width: number,
+--   height: number,
+--   offset_x: number|nil,
+--   offset_y: number|nil,
+--   node_size: vector3|nil @For images only,
+-- }
+-- @module RichText
+-- @within BaseComponent
+-- @alias druid.rich_text
+
+--- The component druid instance
+-- @tfield DruidInstance druid @{DruidInstance}
+
+
+local component = require("druid.component")
+local rich_text = require("druid.custom.rich_text.module.rt")
+
+local RichText = component.create("rich_text")
+
+local SCHEME = {
+	ROOT = "root",
+	TEXT_PREFAB = "text_prefab",
+	ICON_PREFAB = "icon_prefab"
+}
+
+
+--- Rich Text component constructor
+-- @tparam RichText self @{RichText}
+-- @tparam string template The Rich Text template name
+-- @tparam table nodes The node table, if prefab was copied by gui.clone_tree()
+function RichText.init(self, template, nodes)
+	self:set_template(template)
+	self:set_nodes(nodes)
+
+	self.root = self:get_node(SCHEME.ROOT)
+	self.druid = self:get_druid()
+
+	self.text_prefab = self:get_node(SCHEME.TEXT_PREFAB)
+	self.icon_prefab = self:get_node(SCHEME.ICON_PREFAB)
+
+	gui.set_enabled(self.text_prefab, false)
+	gui.set_enabled(self.icon_prefab, false)
+
+	self._settings = self:_create_settings()
+end
+
+
+--- Component style params.
+-- You can override this component styles params in Druid styles table
+-- or create your own style
+-- @table style
+-- @tfield[opt={}] table COLORS Rich Text color aliases
+-- @tfield[opt=20] number ADJUST_STEPS Amount steps of attemps text adjust by height
+-- @tfield[opt=0.02] number ADJUST_SCALE_DELTA Scale step on each height adjust step
+function RichText.on_style_change(self, style)
+	self.style = {}
+	self.style.COLORS = style.COLORS or {}
+	self.style.ADJUST_STEPS = style.ADJUST_STEPS or 20
+	self.style.ADJUST_SCALE_DELTA = style.ADJUST_SCALE_DELTA or 0.02
+end
+
+
+--- Set text for Rich Text
+-- @tparam RichText self @{RichText}
+-- @tparam string text The text to set
+-- @treturn druid.rich_text.word[] words
+-- @treturn druid.rich_text.lines_metrics line_metrics
+-- @usage
+-- • color: Change text color
+--
+-- <color=red>Foobar</color>
+-- <color=1.0,0,0,1.0>Foobar</color>
+-- <color=#ff0000>Foobar</color>
+-- <color=#ff0000ff>Foobar</color>
+--
+-- • shadow: Change text shadow
+--
+-- <shadow=red>Foobar</shadow>
+-- <shadow=1.0,0,0,1.0>Foobar</shadow>
+-- <shadow=#ff0000>Foobar</shadow>
+-- <shadow=#ff0000ff>Foobar</shadow>
+--
+-- • outline: Change text shadow
+--
+-- <outline=red>Foobar</outline>
+-- <outline=1.0,0,0,1.0>Foobar</outline>
+-- <outline=#ff0000>Foobar</outline>
+-- <outline=#ff0000ff>Foobar</outline>
+--
+-- • font: Change font
+--
+-- <font=MyCoolFont>Foobar</font>
+--
+-- • size: Change text size, relative to default size
+--
+-- <size=2>Twice as large</size>
+--
+-- • br: Insert a line break
+--
+-- <br/>
+--
+-- • nobr: Prevent the text from breaking
+--
+-- Words <nobr>inside tag</nobr> won't break
+--
+-- • img: Display image
+--
+-- <img=texture:image/>
+-- <img=texture:image,size/>
+-- <img=texture:image,width,height/>
+function RichText.set_text(self, text)
+	self:clear()
+
+	local words, settings, line_metrics = rich_text.create(text, self._settings, self.style)
+	line_metrics = rich_text.adjust_to_area(words, settings, line_metrics, self.style)
+
+	self._words = words
+	self._line_metrics = line_metrics
+
+	return words, line_metrics
+end
+
+
+function RichText:on_remove()
+	self:clear()
+end
+
+
+--- Clear all created words.
+function RichText:clear()
+	if self._words then
+		rich_text.remove(self._words)
+		self._words = nil
+	end
+end
+
+
+--- Get all words, which has a passed tag.
+-- @tparam string tag
+-- @treturn druid.rich_text.word[] words
+function RichText:tagged(tag)
+	if not self._words then
+		return
+	end
+
+	return rich_text.tagged(self._words, tag)
+end
+
+
+--- Get all current words.
+-- @treturn table druid.rich_text.word[]
+function RichText:get_words()
+	return self._words
+end
+
+
+--- Get current line metrics
+--- @treturn druid.rich_text.lines_metrics
+function RichText:get_line_metric()
+	return self._line_metrics
+end
+
+
+function RichText:_create_settings()
+	local root_size = gui.get_size(self.root)
+	return {
+		-- General settings
+		-- Adjust scale using to fit the text to the root node area
+		adjust_scale = 1,
+		parent = self.root,
+		width = root_size.x,
+		height = root_size.y,
+		combine_words = false, -- disabled now
+		text_prefab = self.text_prefab,
+		node_prefab = self.icon_prefab,
+
+		-- Text Settings
+		shadow = gui.get_shadow(self.text_prefab),
+		outline = gui.get_outline(self.text_prefab),
+		text_scale = gui.get_scale(self.text_prefab),
+		text_leading = gui.get_leading(self.text_prefab),
+		is_multiline = gui.get_line_break(self.text_prefab),
+
+		-- Image settings
+		image_pixel_grid_snap = false, -- disabled now
+		node_scale = gui.get_scale(self.icon_prefab),
+		image_scale = gui.get_scale(self.icon_prefab),
+		default_animation = gui.get_flipbook(self.icon_prefab),
+	}
+end
+
+
+return RichText

druid/druid.lua

@@ -1,18 +1,49 @@
---- Druid UI Library.
--- Powerful Defold component based UI library. Use standart
--- components or make your own game-specific components to
--- make amazing GUI in your games.
+-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
+
+--- Druid UI Component Framework.
+-- <b># Overview #</b>
 --
--- Contains the several basic components and examples
--- to how to do your custom complex components to
--- separate UI game logic to small files
+-- Druid - powerful Defold component UI library. Use basic and extended
+-- Druid components or make your own game-specific components to make
+-- amazing GUI in your games.
 --
---    require("druid.druid")
---    function init(self)
---        self.druid = druid.new(self)
---    end
+-- To start using Druid, please refer to the Usage section below.
 --
--- @module druid
+-- <b># Notes #</b>
+--
+-- • Each Druid instance maintains the self context from the constructor and passes it to each Druid callback.
+--
+-- See next: @{DruidInstance}
+--
+-- @usage
+-- local druid = require("druid.druid")
+--
+-- local function on_play(self)
+--     print("Gonna play!")
+-- end
+--
+-- function init(self)
+--     self.druid = druid.new(self)
+--     self.druid:new_button("button_play", on_play)
+-- end
+--
+-- function final(self)
+--     self.druid:final()
+-- end
+--
+-- function update(self, dt)
+--     self.druid:update(dt)
+-- end
+--
+-- function on_message(self, message_id, message, sender)
+--     self.druid:on_message(message_id, message, sender)
+-- end
+--
+-- function on_input(self, action_id, action)
+--     return self.druid:on_input(action_id, action)
+-- end
+--
+-- @module Druid
 
 local const = require("druid.const")
 local base_component = require("druid.component")
@@ -36,26 +67,39 @@ local function get_druid_instances()
 end
 
 
---- Register external druid component.
--- After register you can create the component with
--- druid_instance:new_{name}. For example `druid:new_button(...)`
--- @function druid:register
+--- Register a new external Druid component.
+--
+-- You can register your own components to make new alias: the druid:new_{name} function.
+-- For example, if you want to register a component called "my_component", you can create it using druid:new_my_component(...).
+-- This can be useful if you have your own "basic" components that you don't want to re-create each time.
+-- @function druid.register
 -- @tparam string name module name
 -- @tparam table module lua table with component
+-- @usage
+-- local my_component = require("path.to.my.component")
+-- druid.register("my_component", my_component)
+-- ...
+-- local druid = druid.new(self)
+-- local component_instance = self.druid:new_my_component(...)
 function M.register(name, module)
-	-- TODO: Find better solution to creating elements?
-	-- Current way is very implicit
 	druid_instance["new_" .. name] = function(self, ...)
 		return druid_instance.new(self, module, ...)
 	end
 end
 
 
---- Create Druid instance.
+--- Create a new Druid instance for creating GUI components.
+--
 -- @function druid.new
--- @tparam table context Druid context. Usually it is self of script
--- @tparam[opt] table style Druid style module
--- @treturn druid_instance Druid instance
+-- @tparam table context The Druid context. Usually, this is the self of the gui_script. It is passed into all Druid callbacks.
+-- @tparam[opt] table style The Druid style table to override style parameters for this Druid instance.
+-- @treturn druid_instance The Druid instance @{DruidInstance}.
+-- @usage
+-- local druid = require("druid.druid")
+--
+-- function init(self)
+--    self.druid = druid.new(self)
+-- end
 function M.new(context, style)
 	if settings.default_style == nil then
 		M.set_default_style(default_style)
@@ -67,41 +111,60 @@ function M.new(context, style)
 end
 
 
---- Set new default style.
+--- Set your own default style for all Druid instances.
+--
+-- To create your own style file, copy the default style file and make changes to it.
+-- Register the new style before creating your Druid instances.
 -- @function druid.set_default_style
 -- @tparam table style Druid style module
+-- @usage
+-- local my_style = require("path.to.my.style")
+-- druid.set_default_style(my_style)
 function M.set_default_style(style)
 	settings.default_style = style or {}
 end
 
 
---- Set text function
--- Druid locale component will call this function
--- to get translated text. After set_text_funtion
--- all existing locale component will be updated
+--- Set the text function for the LangText component.
+--
+-- The Druid locale component will call this function to get translated text.
+-- After setting the text function, all existing locale components will be updated.
 -- @function druid.set_text_function
 -- @tparam function callback Get localized text function
+-- @usage
+-- druid.set_text_function(function(text_id)
+--    return lang_data[text_id] -- Replace with your real function
+-- end)
 function M.set_text_function(callback)
 	settings.get_text = callback or const.EMPTY_FUNCTION
-	-- TODO: Update all localized text
-	-- Need to store all current druid instances to iterate over it?
+	M.on_language_change()
 end
 
 
---- Set sound function.
--- Component will call this function to
--- play sound by sound_id
+--- Set the Druid sound function to play UI sounds if used.
+--
+-- Set a function to play a sound given a sound_id. This function is used for button clicks to play the "click" sound.
+-- It can also be used to play sounds in your custom components (see the default Druid style file for an example).
 -- @function druid.set_sound_function
 -- @tparam function callback Sound play callback
+-- @usage
+-- druid.set_sound_function(function(sound_id)
+--     sound.play(sound_id) -- Replace with your real function
+-- end)
 function M.set_sound_function(callback)
 	settings.play_sound = callback or const.EMPTY_FUNCTION
 end
 
 
---- Callback on global window event.
--- Used to trigger on_focus_lost and on_focus_gain
+--- Set the window callback to enable on_focus_gain and on_focus_lost functions.
+--
+-- This is used to trigger the on_focus_lost and on_focus_gain functions in Druid components.
 -- @function druid.on_window_callback
 -- @tparam string event Event param from window listener
+-- @usage
+-- window.set_listener(function(_, event)
+--    druid.on_window_callback(event)
+-- end)
 function M.on_window_callback(event)
 	local instances = get_druid_instances()
 
@@ -109,30 +172,24 @@ function M.on_window_callback(event)
 		for i = 1, #instances do
 			msg.post(instances[i].url, base_component.ON_FOCUS_LOST)
 		end
-	end
-
-	if event == window.WINDOW_EVENT_FOCUS_GAINED then
+	elseif event == window.WINDOW_EVENT_FOCUS_GAINED then
 		for i = 1, #instances do
 			msg.post(instances[i].url, base_component.ON_FOCUS_GAINED)
 		end
+	elseif event == window.WINDOW_EVENT_RESIZED then
+		for i = 1, #instances do
+			msg.post(instances[i].url, base_component.ON_WINDOW_RESIZED)
+		end
 	end
 end
 
 
---- Callback on global layout change event.
--- @function druid.on_layout_change
-function M.on_layout_change()
-	local instances = get_druid_instances()
-
-	for i = 1, #instances do
-		msg.post(instances[i].url, base_component.ON_LAYOUT_CHANGE)
-	end
-end
-
-
---- Callback on global language change event.
--- Use to update all lang texts
+--- Call this function when the game language changes.
+--
+-- This function will translate all current LangText components.
 -- @function druid.on_language_change
+-- @usage
+-- druid.on_language_change()
 function M.on_language_change()
 	local instances = get_druid_instances()
 

druid/editor_scripts/component.lua_template

@@ -0,0 +1,32 @@
+--- For component interest functions
+--- see https://github.com/Insality/druid/blob/develop/docs_md/02-creating_custom_components.md
+--- Require this component in you gui file:
+--- local {COMPONENT_NAME} = require("{COMPONENT_PATH}")
+--- And create this component via:
+--- self.{COMPONENT_TYPE} = self.druid:new({COMPONENT_NAME}, template, nodes)
+
+local component = require("druid.component")
+
+---@class {COMPONENT_TYPE}: druid.base_component{COMPONENT_ANNOTATIONS}
+---@field druid druid_instance
+local {COMPONENT_NAME} = component.create("{COMPONENT_TYPE}")
+
+local SCHEME = {
+{SCHEME_LIST}
+}
+
+
+---@param template string
+---@param nodes table<hash, node>
+function {COMPONENT_NAME}:init(template, nodes)
+	self:set_template(template)
+	self:set_nodes(nodes)
+	self.druid = self:get_druid(){COMPONENT_DEFINE}
+end
+
+
+function {COMPONENT_NAME}:on_remove()
+end
+
+{COMPONENT_FUNCTIONS}
+return {COMPONENT_NAME}

druid/editor_scripts/create_druid_component.py

@@ -0,0 +1,139 @@
+# @license MIT, Insality 2021
+# @source https://github.com/Insality/druid
+
+import os
+import sys
+import deftree
+
+current_filepath = os.path.abspath(os.path.dirname(__file__))
+TEMPLATE_PATH = current_filepath + "/component.lua_template"
+
+component_annotations = ""
+component_functions = ""
+component_define = ""
+
+def to_camel_case(snake_str):
+	components = snake_str.split('_')
+	return ''.join(x.title() for x in components[0:])
+
+
+def get_id(node_name):
+	return node_name.upper().replace("/", "_")
+
+
+def process_component(node_name, component_name):
+	global component_annotations
+	global component_functions
+	global component_define
+
+	if node_name == "root":
+		component_annotations += "\n---@field root node"
+		component_define += "\n\tself.root = self:get_node(SCHEME.ROOT)"
+
+	if node_name.startswith("button"):
+		component_annotations += "\n---@field {0} druid.button".format(node_name)
+		component_functions += "\nfunction {1}:_on_{0}()\n\tprint(\"Click on {0}\")\nend\n\n".format(node_name, component_name)
+		component_define += "\n\tself.{0} = self.druid:new_button(SCHEME.{1}, self._on_{0})".format(node_name, get_id(node_name))
+
+	if node_name.startswith("text"):
+		component_annotations += "\n---@field {0} druid.text".format(node_name)
+		component_define += "\n\tself.{0} = self.druid:new_text(SCHEME.{1})".format(node_name, get_id(node_name))
+
+	if node_name.startswith("lang_text"):
+		component_annotations += "\n---@field {0} druid.text".format(node_name)
+		component_define += "\n\tself.{0} = self.druid:new_lang_text(SCHEME.{1}, \"lang_id\")".format(node_name, get_id(node_name))
+
+	if node_name.startswith("grid") or node_name.startswith("static_grid"):
+		component_annotations += "\n---@field {0} druid.static_grid".format(node_name)
+		component_define += "\n--TODO: Replace prefab_name with grid element prefab"
+		component_define += "\n\tself.{0} = self.druid:new_static_grid(SCHEME.{1}, \"prefab_name\", 1)".format(node_name, get_id(node_name))
+
+	if node_name.startswith("dynamic_grid"):
+		component_annotations += "\n---@field {0} druid.dynamic_grid".format(node_name)
+		component_define += "\n\tself.{0} = self.druid:new_dynamic_grid(SCHEME.{1})".format(node_name, get_id(node_name))
+
+	if node_name.startswith("scroll_view"):
+		field_name = node_name.replace("_view", "")
+		content_name = node_name.replace("_view", "_content")
+		component_annotations += "\n---@field {0} druid.scroll".format(field_name)
+		component_define += "\n\tself.{0} = self.druid:new_scroll(SCHEME.{1}, SCHEME.{2})".format(field_name, get_id(node_name), get_id(content_name))
+
+	if node_name.startswith("blocker"):
+		component_annotations += "\n---@field {0} druid.blocker".format(node_name)
+		component_define += "\n\tself.{0} = self.druid:new_blocker(SCHEME.{1})".format(node_name, get_id(node_name))
+
+	if node_name.startswith("slider"):
+		component_annotations += "\n---@field {0} druid.slider".format(node_name)
+		component_define += "\n--TODO: Replace slider end position. It should be only vertical or horizontal"
+		component_define += "\n\tself.{0} = self.druid:new_slider(SCHEME.{1}, vmath.vector3(100, 0, 0), self._on_{0}_change)".format(node_name, get_id(node_name))
+		component_functions += "\nfunction {1}:_on_{0}_change(value)\n\tprint(\"Slider change:\", value)\nend\n\n".format(node_name, component_name)
+
+	if node_name.startswith("progress"):
+		component_annotations += "\n---@field {0} druid.progress".format(node_name)
+		component_define += "\n\tself.{0} = self.druid:new_progress(SCHEME.{1}, \"x\")".format(node_name, get_id(node_name))
+
+	if node_name.startswith("timer"):
+		component_annotations += "\n---@field {0} druid.timer".format(node_name)
+		component_define += "\n\tself.{0} = self.druid:new_timer(SCHEME.{1}, 59, 0, self._on_{0}_end)".format(node_name, get_id(node_name))
+		component_functions += "\nfunction {1}:_on_{0}_end()\n\tprint(\"Timer {0} trigger\")\nend\n\n".format(node_name, component_name)
+
+
+def main():
+	global component_annotations
+	global component_functions
+	global component_define
+
+	filename = sys.argv[1]
+	print("Create Druid component from gui file", filename)
+	tree = deftree.parse(filename)
+	root = tree.get_root()
+
+	output_directory = os.path.dirname(filename)
+	output_filename = os.path.splitext(os.path.basename(filename))[0]
+
+	output_full_path = os.path.join(output_directory, output_filename + ".lua")
+	is_already_exists = os.path.exists(output_full_path)
+	if is_already_exists:
+		print("Error: The file is already exists")
+		print("File:", output_full_path)
+		return
+
+	component_require_path = os.path.join(output_directory, output_filename).replace("/", ".").replace("..", "")
+	component_name = to_camel_case(output_filename)
+	component_type = output_filename
+	scheme_list = []
+
+	# Gather nodes from GUI scene
+	for node in root.iter_elements("nodes"):
+		node_name = node.get_attribute("id").value
+		scheme_list.append("\t" + get_id(node_name) + " = \"" + node_name + "\"")
+
+		is_template = node.get_attribute("template")
+		is_in_template = "/" in node_name
+		if not is_template and not is_in_template:
+			process_component(node_name, component_name)
+
+	if len(component_define) > 2:
+		component_define = "\n" + component_define
+
+	template_file = open(TEMPLATE_PATH, "r")
+	filedata = template_file.read()
+	template_file.close()
+
+	filedata = filedata.replace("{COMPONENT_NAME}", component_name)
+	filedata = filedata.replace("{COMPONENT_TYPE}", component_type)
+	filedata = filedata.replace("{COMPONENT_PATH}", component_require_path)
+	filedata = filedata.replace("{COMPONENT_DEFINE}", component_define)
+	filedata = filedata.replace("{COMPONENT_FUNCTIONS}", component_functions)
+	filedata = filedata.replace("{COMPONENT_ANNOTATIONS}", component_annotations)
+	filedata = filedata.replace("{SCHEME_LIST}", ",\n".join(scheme_list))
+
+	output_file = open(output_full_path, "w")
+	output_file.write(filedata)
+	output_file.close()
+
+	print("Success: The file is created")
+	print("File:", output_full_path)
+
+
+main()

druid/editor_scripts/druid.editor_script

@@ -0,0 +1,127 @@
+--- @license MIT, Insality 2021
+--- @source https://github.com/Insality/druid
+
+local M = {}
+
+
+local function ends_with(str, ending)
+	return ending == "" or str:sub(-#ending) == ending
+end
+
+
+local function save_file_from_dependency(dependency_file_path, output_file_path)
+	local content = editor.get(dependency_file_path, "text")
+	local file, err = io.open(output_file_path, "w")
+	if err then
+		print("Error:", err)
+		return false
+	end
+	file:write(content)
+	file:close()
+	print("Write file at", output_file_path)
+	return true
+end
+
+
+function M.get_commands()
+	return {
+		{
+			label = "Print gui scheme",
+
+			locations = { "Outline" },
+
+			query = {
+				selection = {type = "outline", cardinality = "many"}
+			},
+
+			active = function(opts)
+				return true
+			end,
+
+			run = function(opts)
+				print("local SCHEME = {")
+
+				for i = 1, #opts.selection do
+					local file = opts.selection[i]
+					if editor.can_get(file, "id") then
+						local id = editor.get(file, "id")
+						print("\t" .. string.upper(id) .. " = \"" .. id .. "\",")
+					end
+				end
+
+				print("}")
+				print("")
+			end
+		},
+
+		{
+			label = "Assign layers",
+
+			locations = {"Edit"},
+
+			query = {
+				selection = {type = "resource", cardinality = "one"}
+			},
+
+			active = function(opts)
+				local path = editor.get(opts.selection, "path")
+				return ends_with(path, ".gui")
+			end,
+
+			run = function(opts)
+				local file = opts.selection
+				print("Run script for", editor.get(file, "path"))
+				save_file_from_dependency('/druid/editor_scripts/run_python_script_on_gui.sh', "./build/run_python_script_on_gui.sh")
+				save_file_from_dependency('/druid/editor_scripts/setup_layers.py', "./build/setup_layers.py")
+				return {
+					{
+						action = "shell",
+						command = {
+							"bash",
+							"./build/run_python_script_on_gui.sh",
+							"./build/setup_layers.py",
+							"." .. editor.get(file, "path")
+						}
+					}
+				}
+			end
+		},
+
+		{
+			label = "Create Druid Component",
+
+			locations = {"Edit"},
+
+			query = {
+				selection = {type = "resource", cardinality = "one"}
+			},
+
+			active = function(opts)
+				local path = editor.get(opts.selection, "path")
+				return ends_with(path, ".gui")
+			end,
+
+			run = function(opts)
+				local file = opts.selection
+				print("Run script for", editor.get(file, "path"))
+				save_file_from_dependency('/druid/editor_scripts/run_python_script_on_gui.sh', "./build/run_python_script_on_gui.sh")
+				save_file_from_dependency('/druid/editor_scripts/create_druid_component.py', "./build/create_druid_component.py")
+				save_file_from_dependency('/druid/editor_scripts/component.lua_template', "./build/component.lua_template")
+				return {
+					{
+						action = "shell",
+						command = {
+							"bash",
+							"./build/run_python_script_on_gui.sh",
+							"./build/create_druid_component.py",
+							"." .. editor.get(file, "path")
+						}
+					}
+				}
+			end
+		}
+	}
+end
+
+
+return M

druid/editor_scripts/run_python_script_on_gui.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+# @license MIT, Insality 2022
+# @source https://github.com/Insality/druid
+
+echo "Run bash for $1"
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+
+is_defree_installed=$(pip3 list --disable-pip-version-check | grep -E "deftree")
+if [ -z "$is_defree_installed" ]; then
+    echo "The python deftree is not installed. Please install it via"
+    echo "pip3 install deftree"
+    exit 0
+fi
+
+python3 $1 $2

druid/editor_scripts/setup_layers.py

@@ -1,4 +1,4 @@
-# @license MIT, Insality 2020
+# @license MIT, Insality 2021
 # @source https://github.com/Insality/druid
 
 import sys

druid/event.lua

@@ -1,17 +1,27 @@
---- Lua event small library
+-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
+
+--- Druid Event Module
+--
+-- The Event module provides a simple class for handling callbacks. It is used in many Druid components.
+--
+-- You can subscribe to an event using the `:subscribe` method and unsubscribe using the `:unsubscribe` method.
 -- @module DruidEvent
--- @alias druid_event
+-- @alias druid.event
 
 local class = require("druid.system.middleclass")
 
 local DruidEvent = class("druid.event")
 
 
---- Event constructur
--- @tparam DruidEvent self
--- @tparam function initial_callback Subscribe the callback on new event, if callback exist
+--- DruidEvent constructor
+-- @tparam DruidEvent self @{DruidEvent}
+-- @tparam[opt] function initial_callback Subscribe the callback on new event, if callback exist
+-- @usage
+-- local Event = require("druid.event")
+-- ...
+-- local event = Event(initial_callback)
 function DruidEvent.initialize(self, initial_callback)
-	self._callbacks = {}
+	self._callbacks = nil -- initialize later
 
 	if initial_callback then
 		self:subscribe(initial_callback)
@@ -20,13 +30,21 @@ end
 
 
 --- Subscribe callback on event
--- @tparam DruidEvent self
+-- @tparam DruidEvent self @{DruidEvent}
 -- @tparam function callback Callback itself
--- @tparam table context Additional context as first param to callback call
+-- @tparam[opt] Any context Additional context as first param to callback call, usually it's self
+-- @usage
+-- local function on_long_callback(self)
+--     print("Long click!")
+-- end
+-- ...
+-- local button = self.druid:new_button("button", callback)
+-- button.on_long_click:subscribe(on_long_callback, self)
 function DruidEvent.subscribe(self, callback, context)
 	assert(type(self) == "table", "You should subscribe to event with : syntax")
 	assert(type(callback) == "function", "Callback should be function")
 
+	self._callbacks = self._callbacks or {}
 	table.insert(self._callbacks, {
 		callback = callback,
 		context = context
@@ -37,10 +55,20 @@ end
 
 
 --- Unsubscribe callback on event
--- @tparam DruidEvent self
+-- @tparam DruidEvent self @{DruidEvent}
 -- @tparam function callback Callback itself
--- @tparam table context Additional context as first param to callback call
+-- @tparam[opt] Any context Additional context as first param to callback call
+-- @usage
+-- local function on_long_callback(self)
+--     print("Long click!")
+-- end
+-- ...
+-- button.on_long_click:unsubscribe(on_long_callback, self)
 function DruidEvent.unsubscribe(self, callback, context)
+	if not self._callbacks then
+		return
+	end
+
 	for index, callback_info in ipairs(self._callbacks) do
 		if callback_info.callback == callback and callback_info.context == context then
 			table.remove(self._callbacks, index)
@@ -51,25 +79,41 @@ end
 
 
 --- Return true, if event have at lease one handler
--- @tparam DruidEvent self
+-- @tparam DruidEvent self @{DruidEvent}
 -- @treturn bool True if event have handlers
+-- @usage
+-- local is_long_click_handler_exists = button.on_long_click:is_exist()
 function DruidEvent.is_exist(self)
+	if not self._callbacks then
+		return false
+	end
 	return #self._callbacks > 0
 end
 
 
 --- Clear the all event handlers
--- @tparam DruidEvent self
+-- @tparam DruidEvent self @{DruidEvent}
+-- @usage
+-- button.on_long_click:clear()
 function DruidEvent.clear(self)
-	self._callbacks = {}
+	self._callbacks = nil
 end
 
 
 --- Trigger the event and call all subscribed callbacks
--- @tparam DruidEvent self
--- @tparam any ... All event params
+-- @tparam DruidEvent self @{DruidEvent}
+-- @tparam Any ... All event params
+-- @usage
+-- local Event = require("druid.event")
+-- ...
+-- local event = Event()
+-- event:trigger("Param1", "Param2")
 function DruidEvent.trigger(self, ...)
-	for index, callback_info in ipairs(self._callbacks) do
+	if not self._callbacks then
+		return false
+	end
+
+	for _, callback_info in ipairs(self._callbacks) do
 		if callback_info.context then
 			callback_info.callback(callback_info.context, ...)
 		else

druid/extended/checkbox.lua

@@ -1,10 +1,14 @@
+-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
+
 --- Druid checkbox component
+--
+-- <a href="https://insality.github.io/druid/druid/index.html?example=general_checkboxes" target="_blank"><b>Example Link</b></a>
 -- @module Checkbox
 -- @within BaseComponent
 -- @alias druid.checkbox
 
 --- On change state callback(self, state)
--- @tfield druid_event on_change_state
+-- @tfield DruidEvent on_change_state @{DruidEvent}
 
 --- Visual node
 -- @tfield node node
@@ -13,14 +17,14 @@
 -- @tfield[opt=node] node click_node
 
 --- Button component from click_node
--- @tfield Button button
+-- @tfield Button button @{Button}
 
 ---
 
 local Event = require("druid.event")
 local component = require("druid.component")
 
-local Checkbox = component.create("checkbox", { component.ON_LAYOUT_CHANGE })
+local Checkbox = component.create("checkbox")
 
 
 local function on_click(self)
@@ -43,17 +47,18 @@ end
 
 
 --- Component init function
--- @tparam Checkbox self
+-- @tparam Checkbox self @{Checkbox}
 -- @tparam node node Gui node
 -- @tparam function callback Checkbox callback
 -- @tparam[opt=node] node click_node Trigger node, by default equals to node
-function Checkbox.init(self, node, callback, click_node)
+-- @tparam[opt=false] boolean initial_state The initial state of checkbox, default - false
+function Checkbox.init(self, node, callback, click_node, initial_state)
 	self.druid = self:get_druid()
 	self.node = self:get_node(node)
-	self.click_node = self:get_node(click_node)
+	self.click_node = self:get_node(click_node or node)
 
 	self.button = self.druid:new_button(self.click_node or self.node, on_click)
-	self:set_state(false, true)
+	self:set_state(initial_state, true, true)
 
 	self.on_change_state = Event(callback)
 end
@@ -65,21 +70,24 @@ end
 
 
 --- Set checkbox state
--- @tparam Checkbox self
+-- @tparam Checkbox self @{Checkbox}
 -- @tparam bool state Checkbox state
 -- @tparam bool is_silent Don't trigger on_change_state if true
-function Checkbox.set_state(self, state, is_silent)
+-- @tparam bool is_instant If instant checkbox change
+function Checkbox.set_state(self, state, is_silent, is_instant)
 	self.state = state
-	self.style.on_change_state(self, self.node, state)
+	self.style.on_change_state(self, self.node, state, is_instant)
 
 	if not is_silent then
 		self.on_change_state:trigger(self:get_context(), state)
 	end
+
+	return self
 end
 
 
 --- Return checkbox state
--- @tparam Checkbox self
+-- @tparam Checkbox self @{Checkbox}
 -- @treturn bool Checkbox state
 function Checkbox.get_state(self)
 	return self.state

druid/extended/checkbox_group.lua

@@ -1,13 +1,17 @@
+-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
+
 --- Checkbox group module
+--
+-- <a href="https://insality.github.io/druid/druid/index.html?example=general_checkboxes" target="_blank"><b>Example Link</b></a>
 -- @module CheckboxGroup
 -- @within BaseComponent
 -- @alias druid.checkbox_group
 
 --- On any checkbox click callback(self, index)
--- @tfield druid_event on_checkbox_click
+-- @tfield DruidEvent on_checkbox_click @{DruidEvent}
 
 --- Array of checkbox components
--- @tfield table checkboxes
+-- @tfield table checkboxes @{Checkbox}
 
 ---
 
@@ -18,7 +22,7 @@ local CheckboxGroup = component.create("checkbox_group")
 
 
 --- Component init function
--- @tparam CheckboxGroup self
+-- @tparam CheckboxGroup self @{CheckboxGroup}
 -- @tparam node[] nodes Array of gui node
 -- @tparam function callback Checkbox callback
 -- @tparam[opt=node] node[] click_nodes Array of trigger nodes, by default equals to nodes
@@ -40,19 +44,20 @@ end
 
 
 --- Set checkbox group state
--- @tparam CheckboxGroup self
+-- @tparam CheckboxGroup self @{CheckboxGroup}
 -- @tparam bool[] indexes Array of checkbox state
-function CheckboxGroup.set_state(self, indexes)
+-- @tparam boolean is_instant If instant state change
+function CheckboxGroup.set_state(self, indexes, is_instant)
 	for i = 1, #indexes do
 		if self.checkboxes[i] then
-			self.checkboxes[i]:set_state(indexes[i], true)
+			self.checkboxes[i]:set_state(indexes[i], true, is_instant)
 		end
 	end
 end
 
 
 --- Return checkbox group state
--- @tparam CheckboxGroup self
+-- @tparam CheckboxGroup self @{CheckboxGroup}
 -- @treturn bool[] Array if checkboxes state
 function CheckboxGroup.get_state(self)
 	local result = {}

druid/extended/component.template.lua

@@ -1,66 +0,0 @@
---- Druid component template
--- @module druid.component
--- @local
-local component = require("druid.component")
-
-local Component = component.create("my_component_name", { component.ON_UPDATE })
-
-
--- Component constructor
-function Component:init(...)
-end
-
-
--- Call only if exist interest: component.ON_UPDATE
-function Component:update(dt)
-end
-
-
--- Call only if exist interest: component.ON_INPUT
-function Component:on_input(action_id, action)
-	return false
-end
-
-
--- Call on component creation and on component:set_style() function
-function Component:on_style_change(style)
-end
-
-
--- Call only if exist interest: component.ON_MESSAGE
-function Component:on_message(message_id, message, sender)
-end
-
-
--- Call only if component with ON_LANGUAGE_CHANGE interest
-function Component:on_language_change()
-end
-
-
--- Call only if component with ON_LAYOUT_CHANGE interest
-function Component:on_layout_change()
-end
-
-
--- Call, if input was capturing before this component
--- Example: scroll is start scrolling, so you need unhover button
-function Component:on_input_interrupt()
-end
-
-
--- Call, if game lost focus. Need ON_FOCUS_LOST intereset
-function Component:on_focus_lost()
-end
-
-
--- Call, if game gained focus. Need ON_FOCUS_GAINED intereset
-function Component:on_focus_gained()
-end
-
-
--- Call on component remove or on druid:final
-function Component:on_remove()
-end
-
-
-return Component

druid/extended/data_list.lua

@@ -1,15 +1,19 @@
+-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
+
 --- Component to manage data for huge dataset in scroll.
 -- It requires Druid Scroll and Druid Grid (Static or Dynamic) components
+--
+-- <a href="https://insality.github.io/druid/druid/index.html?example=general_data_list" target="_blank"><b>Example Link</b></a>
 -- @module DataList
 -- @within BaseComponent
 -- @alias druid.data_list
 
 
 --- The Druid scroll component
--- @tfield druid.scroll scroll
+-- @tfield Scroll scroll @{Scroll}
 
 --- The Druid Grid component
--- @tfield druid.static_grid grid
+-- @tfield StaticGrid|DynamicGrid grid @{StaticGrid}, @{DynamicGrid}
 
 --- The current visual top data index
 -- @tfield number top_index
@@ -21,7 +25,13 @@
 -- @tfield number scroll_progress
 
 --- Event triggered when scroll progress is changed; event(self, progress_value)
--- @tfield druid_event on_scroll_progress_change
+-- @tfield DruidEvent on_scroll_progress_change @{DruidEvent}
+
+---On DataList visual element created Event callback(self, index, node, instance)
+-- @tfield DruidEvent on_element_add @{DruidEvent}
+
+---On DataList visual element created Event callback(self, index)
+-- @tfield DruidEvent on_element_remove @{DruidEvent}
 
 ---
 
@@ -34,14 +44,17 @@ local DataList = component.create("data_list")
 
 
 --- Data list constructor
--- @tparam DataList self
--- @tparam druid.scroll scroll The Scroll instance for Data List component
--- @tparam druid.grid grid The Grid instance for Data List component
+-- @tparam DataList self @{DataList}
+-- @tparam Scroll scroll The @{Scroll} instance for Data List component
+-- @tparam StaticGrid|DynamicGrid grid The @{StaticGrid} or @{DynamicGrid} instance for Data List component
 -- @tparam function create_function The create function callback(self, data, index, data_list). Function should return (node, [component])
 function DataList.init(self, scroll, grid, create_function)
 	self.druid = self:get_druid()
 	self.scroll = scroll
 	self.grid = grid
+	if self.grid.style then
+		self.grid.style.IS_DYNAMIC_NODE_POSES = false
+	end
 	self.scroll:bind_grid(grid)
 
 	-- Current visual elements indexes
@@ -59,18 +72,22 @@ function DataList.init(self, scroll, grid, create_function)
 	self.scroll.on_scroll:subscribe(self._check_elements, self)
 
 	self.on_scroll_progress_change = Event()
+	self.on_element_add = Event()
+	self.on_element_remove = Event()
+
+	self:set_data()
 end
 
 
 --- Druid System on_remove function
--- @tparam DataList self
+-- @tparam DataList self @{DataList}
 function DataList.on_remove(self)
 	self.scroll.on_scroll:unsubscribe(self._check_elements, self)
 end
 
 
 --- Set new data set for DataList component
--- @tparam DataList self
+-- @tparam DataList self @{DataList}
 -- @tparam table data The new data array
 -- @treturn druid.data_list Current DataList instance
 function DataList.set_data(self, data)
@@ -82,8 +99,16 @@ function DataList.set_data(self, data)
 end
 
 
+--- Return current data from DataList component
+-- @tparam DataList self @{DataList}
+-- @treturn table The current data array
+function DataList.get_data(self)
+	return self._data
+end
+
+
 --- Add element to DataList. Currenly untested
--- @tparam DataList self
+-- @tparam DataList self @{DataList}
 -- @tparam table data
 -- @tparam number index
 -- @tparam number shift_policy The constant from const.SHIFT.*
@@ -92,80 +117,72 @@ function DataList.add(self, data, index, shift_policy)
 	index = index or self._data_last_index + 1
 	shift_policy = shift_policy or const.SHIFT.RIGHT
 
-	if self._data[index] then
-		if shift_policy == const.SHIFT.RIGHT then
-			for i = self._data_last_index, index, -1 do
-				self._data[i + 1] = self._data[i]
-			end
-		end
-		if shift_policy == const.SHIFT.LEFT then
-			for i = self._data_first_index, index do
-				self._data[i - 1] = self._data[i]
-			end
-		end
-	end
-	self._data[index] = data
+	helper.insert_with_shift(self._data, data, index, shift_policy)
 	self:_update_data_info()
 	self:_check_elements()
 end
 
 
 --- Remove element from DataList. Currenly untested
--- @tparam DataList self
+-- @tparam DataList self @{DataList}
 -- @tparam number index
 -- @tparam number shift_policy The constant from const.SHIFT.*
 -- @local
 function DataList.remove(self, index, shift_policy)
-	table.remove(self._data, index)
-	self:_refresh()
+	--self:_refresh()
+
+	helper.remove_with_shift(self._data, index, shift_policy)
+	self:_update_data_info()
 end
 
 
 --- Remove element from DataList by data value. Currenly untested
--- @tparam DataList self
+-- @tparam DataList self @{DataList}
 -- @tparam tabe data
 -- @tparam number shift_policy The constant from const.SHIFT.*
 -- @local
 function DataList.remove_by_data(self, data, shift_policy)
 	local index = helper.contains(self._data, data)
 	if index then
-		table.remove(self._data, index)
+		helper.remove_with_shift(self._data, index, shift_policy)
+		self:_update_data_info()
 		self:_refresh()
 	end
 end
 
 
 --- Clear the DataList and refresh visuals
--- @tparam DataList self
+-- @tparam DataList self @{DataList}
 function DataList.clear(self)
 	self._data = {}
+	self:_update_data_info()
 	self:_refresh()
 end
 
 
 --- Return first index from data. It not always equals to 1
--- @tparam DataList self
+-- @tparam DataList self @{DataList}
 function DataList.get_first_index(self)
 	return self._data_first_index
 end
 
 
 --- Return last index from data
--- @tparam DataList self
+-- @tparam DataList self @{DataList}
 function DataList.get_last_index(self)
 	return self._data_last_index
 end
 
 
 --- Return amount of data
--- @tparam DataList self
+-- @tparam DataList self @{DataList}
 function DataList.get_length(self)
 	return self._data_length
 end
 
 
 --- Return index for data value
--- @tparam DataList self
+-- @tparam DataList self @{DataList}
 -- @tparam table data
 function DataList.get_index(self, data)
 	for index, value in pairs(self._data) do
@@ -178,8 +195,36 @@ function DataList.get_index(self, data)
 end
 
 
+--- Return all currenly created nodes in DataList
+-- @tparam DataList self @{DataList}
+-- @treturn Node[] List of created nodes
+function DataList.get_created_nodes(self)
+	local nodes = {}
+
+	for index, data in pairs(self._data_visual) do
+		nodes[index] = data.node
+	end
+
+	return nodes
+end
+
+
+--- Return all currenly created components in DataList
+-- @tparam DataList self @{DataList}
+-- @treturn druid.base_component[] List of created nodes
+function DataList.get_created_components(self)
+	local components = {}
+
+	for index, data in pairs(self._data_visual) do
+		components[index] = data.component
+	end
+
+	return components
+end
+
+
 --- Instant scroll to element with passed index
--- @tparam DataList self
+-- @tparam DataList self @{DataList}
 -- @tparam number index
 function DataList.scroll_to_index(self, index)
 	local target = helper.clamp(index, self:get_first_index(), self:get_last_index())
@@ -193,7 +238,7 @@ end
 
 
 --- Add element at passed index
--- @tparam DataList self
+-- @tparam DataList self @{DataList}
 -- @tparam number index
 -- @local
 function DataList._add_at(self, index)
@@ -207,11 +252,13 @@ function DataList._add_at(self, index)
 		node = node,
 		component = instance
 	}
+
+	self.on_element_add:trigger(self:get_context(), index, node, instance)
 end
 
 
 --- Remove element from passed index
--- @tparam DataList self
+-- @tparam DataList self @{DataList}
 -- @tparam number index
 -- @local
 function DataList._remove_at(self, index)
@@ -220,15 +267,18 @@ function DataList._remove_at(self, index)
 	local node = self._data_visual[index].node
 	gui.delete_node(node)
 
-	if self._data_visual[index].component then
-		self.druid:remove(self._data_visual[index].component)
+	local instance = self._data_visual[index].component
+	if instance then
+		self.druid:remove(instance)
 	end
 	self._data_visual[index] = nil
+
+	self.on_element_remove:trigger(self:get_context(), index)
 end
 
 
---- Fully refresh all DataList elements
--- @tparam DataList self
+--- Refresh all elements in DataList
+-- @tparam DataList self @{DataList}
 -- @local
 function DataList._refresh(self)
 	for index, _ in pairs(self._data_visual) do
@@ -239,7 +289,7 @@ end
 
 
 --- Check elements which should be created
--- @tparam DataList self
+-- @tparam DataList self @{DataList}
 -- @local
 function DataList._check_elements(self)
 	for index, data in pairs(self._data_visual) do
@@ -277,7 +327,7 @@ end
 
 --- Check elements which should be created.
 -- Start from index with step until element is outside of scroll view
--- @tparam DataList self
+-- @tparam DataList self @{DataList}
 -- @tparam number index
 -- @tparam number step
 -- @local
@@ -310,9 +360,8 @@ function DataList._check_elements_from(self, index, step)
 end
 
 
-
 --- Update actual data params
--- @tparam DataList self
+-- @tparam DataList self @{DataList}
 -- @local
 function DataList._update_data_info(self)
 	self._data_first_index = false
@@ -326,8 +375,8 @@ function DataList._update_data_info(self)
 	end
 
 	if self._data_length == 0 then
-		self._data_first_index = 1
-		self._data_last_index = 1
+		self._data_first_index = 0
+		self._data_last_index = 0
 	end
 end
 

druid/extended/dynamic_grid.lua

@@ -1,22 +1,26 @@
+-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
+
 --- Component to handle placing components in row
+--
+-- <a href="https://insality.github.io/druid/druid/index.html?example=general_grid" target="_blank"><b>Example Link</b></a>
 -- @module DynamicGrid
 -- @within BaseComponent
 -- @alias druid.dynamic_grid
 
 --- On item add callback(self, node, index)
--- @tfield druid_event on_add_item
+-- @tfield DruidEvent on_add_item @{DruidEvent}
 
 --- On item remove callback(self, index)
--- @tfield druid_event on_remove_item
+-- @tfield DruidEvent on_remove_item @{DruidEvent}
 
 --- On item add or remove callback(self, index)
--- @tfield druid_event on_change_items
+-- @tfield DruidEvent on_change_items @{DruidEvent}
 
 --- On grid clear callback(self)
--- @tfield druid_event on_clear
+-- @tfield DruidEvent on_clear @{DruidEvent}
 
 --- On update item positions callback(self)
--- @tfield druid_event on_update_positions
+-- @tfield DruidEvent on_update_positions @{DruidEvent}
 
 --- Parent gui node
 -- @tfield node parent
@@ -43,7 +47,7 @@ local Event = require("druid.event")
 local helper = require("druid.helper")
 local component = require("druid.component")
 
-local DynamicGrid = component.create("dynamic_grid", { component.ON_LAYOUT_CHANGE })
+local DynamicGrid = component.create("dynamic_grid")
 
 
 local SIDE_VECTORS = {
@@ -62,7 +66,7 @@ local AVAILABLE_PIVOTS = {
 
 
 --- Component init function
--- @tparam DynamicGrid self
+-- @tparam DynamicGrid self @{DynamicGrid}
 -- @tparam node parent The gui node parent, where items will be placed
 function DynamicGrid.init(self, parent)
 	self.parent = self:get_node(parent)
@@ -93,7 +97,7 @@ end
 
 
 --- Return pos for grid node index
--- @tparam DynamicGrid self
+-- @tparam DynamicGrid self @{DynamicGrid}
 -- @tparam number index The grid element index
 -- @tparam node node The node to be placed
 -- @tparam[opt] number origin_index Index of nearby node
@@ -116,7 +120,7 @@ function DynamicGrid.get_pos(self, index, node, origin_index)
 		assert(not self.first_index, "Dynamic Grid can't have gaps between nodes. Error on grid:add")
 
 		-- If not origin node, so it should be first element in the grid
-		local size = self:_get_node_size(node)
+		local size = helper.get_scaled_size(node)
 		local pivot = const.PIVOTS[gui.get_pivot(node)]
 		return vmath.vector3(
 			size.x * pivot.x - size.x * self.pivot.x,
@@ -134,11 +138,12 @@ end
 
 
 --- Add new node to the grid
--- @tparam DynamicGrid self
---	@tparam node node Gui node
+-- @tparam DynamicGrid self @{DynamicGrid}
+-- @tparam node node Gui node
 -- @tparam[opt] number index The node position. By default add as last node
 -- @tparam[opt=SHIFT.RIGHT] number shift_policy How shift nodes, if required. See const.SHIFT
-function DynamicGrid.add(self, node, index, shift_policy)
+-- @tparam[opt=false] boolean is_instant If true, update node positions instantly
+function DynamicGrid.add(self, node, index, shift_policy, is_instant)
 	shift_policy = shift_policy or const.SHIFT.RIGHT
 	local delta = shift_policy -- -1 or 1 or 0
 
@@ -168,7 +173,7 @@ function DynamicGrid.add(self, node, index, shift_policy)
 	end
 
 	-- Sync grid data
-	self:_update()
+	self:_update(is_instant)
 
 	self.on_add_item:trigger(self:get_context(), node, index)
 	self.on_change_items:trigger(self:get_context(), index)
@@ -176,11 +181,12 @@ end
 
 
 --- Remove the item from the grid. Note that gui node will be not deleted
--- @tparam DynamicGrid self
+-- @tparam DynamicGrid self @{DynamicGrid}
 -- @tparam number index The grid node index to remove
 -- @tparam[opt=SHIFT.RIGHT] number shift_policy How shift nodes, if required. See const.SHIFT
--- @treturn Node The deleted gui node from grid
-function DynamicGrid.remove(self, index, shift_policy)
+-- @tparam[opt=false] boolean is_instant If true, update node positions instantly
+-- @treturn node The deleted gui node from grid
+function DynamicGrid.remove(self, index, shift_policy, is_instant)
 	shift_policy = shift_policy or const.SHIFT.RIGHT
 	local delta = shift_policy -- -1 or 1 or 0
 
@@ -202,7 +208,7 @@ function DynamicGrid.remove(self, index, shift_policy)
 	end
 
 	-- Sync grid data
-	self:_update()
+	self:_update(is_instant)
 
 	self.on_remove_item:trigger(self:get_context(), index)
 	self.on_change_items:trigger(self:get_context(), index)
@@ -212,7 +218,7 @@ end
 
 
 --- Return grid content size
--- @tparam DynamicGrid self
+-- @tparam DynamicGrid self @{DynamicGrid}
 -- @tparam vector3 border
 -- @treturn vector3 The grid content size
 function DynamicGrid.get_size(self, border)
@@ -225,7 +231,7 @@ end
 
 
 --- Return DynamicGrid offset, where DynamicGrid content starts.
--- @tparam DynamicGrid self The DynamicGrid instance
+-- @tparam DynamicGrid self @{DynamicGrid} The DynamicGrid instance
 -- @treturn vector3 The DynamicGrid offset
 function DynamicGrid.get_offset(self)
 	local size = self:get_size()
@@ -240,7 +246,7 @@ end
 
 
 --- Return grid content borders
--- @tparam DynamicGrid self
+-- @tparam DynamicGrid self @{DynamicGrid}
 -- @treturn vector3 The grid content borders
 function DynamicGrid.get_borders(self)
 	return self.border
@@ -248,7 +254,7 @@ end
 
 
 --- Return grid index by node
--- @tparam DynamicGrid self
+-- @tparam DynamicGrid self @{DynamicGrid}
 -- @tparam node node The gui node in the grid
 -- @treturn number The node index
 function DynamicGrid.get_index_by_node(self, node)
@@ -263,7 +269,7 @@ end
 
 
 --- Return array of all node positions
--- @tparam DynamicGrid self
+-- @tparam DynamicGrid self @{DynamicGrid}
 -- @treturn vector3[] All grid node positions
 function DynamicGrid.get_all_pos(self)
 	local result = {}
@@ -277,7 +283,7 @@ end
 
 --- Change set position function for grid nodes. It will call on
 -- update poses on grid elements. Default: gui.set_position
--- @tparam DynamicGrid self
+-- @tparam DynamicGrid self @{DynamicGrid}
 -- @tparam function callback Function on node set position
 -- @treturn druid.dynamic_grid Current grid instance
 function DynamicGrid.set_position_function(self, callback)
@@ -288,7 +294,7 @@ end
 
 --- Clear grid nodes array. GUI nodes will be not deleted!
 -- If you want to delete GUI nodes, use dynamic_grid.nodes array before grid:clear
--- @tparam DynamicGrid self
+-- @tparam DynamicGrid self @{DynamicGrid}
 -- @treturn druid.dynamic_grid Current grid instance
 function DynamicGrid.clear(self)
 	self.nodes = {}
@@ -304,7 +310,7 @@ function DynamicGrid._add_node(self, node, index, origin_index)
 	self.nodes[index] = {
 		node = node,
 		pos = self:get_pos(index, node, origin_index),
-		size = self:_get_node_size(node),
+		size = helper.get_scaled_size(node),
 		pivot = const.PIVOTS[gui.get_pivot(node)]
 	}
 
@@ -315,7 +321,7 @@ end
 
 
 --- Update grid inner state
--- @tparam DynamicGrid self
+-- @tparam DynamicGrid self @{DynamicGrid}
 -- @tparam bool is_instant If true, node position update instantly, otherwise with set_position_function callback
 -- @local
 function DynamicGrid._update(self, is_instant)
@@ -326,7 +332,7 @@ end
 
 
 --- Update first and last indexes of grid nodes
--- @tparam DynamicGrid self
+-- @tparam DynamicGrid self @{DynamicGrid}
 -- @local
 function DynamicGrid._update_indexes(self)
 	self.first_index = nil
@@ -342,7 +348,7 @@ end
 
 
 --- Update grid content borders, recalculate min and max values
--- @tparam DynamicGrid self
+-- @tparam DynamicGrid self @{DynamicGrid}
 -- @local
 function DynamicGrid._update_borders(self)
 	if not self.first_index then
@@ -371,7 +377,7 @@ end
 
 
 --- Update grid nodes position
--- @tparam DynamicGrid self
+-- @tparam DynamicGrid self @{DynamicGrid}
 -- @tparam bool is_instant If true, node position update instantly, otherwise with set_position_function callback
 -- @local
 function DynamicGrid._update_pos(self, is_instant)
@@ -390,7 +396,7 @@ end
 function DynamicGrid._get_next_node_pos(self, origin_node_index, new_node, place_side)
 	local node = self.nodes[origin_node_index]
 
-	local new_node_size = self:_get_node_size(new_node)
+	local new_node_size = helper.get_scaled_size(new_node)
 	local new_pivot = const.PIVOTS[gui.get_pivot(new_node)]
 
 	local dist_x = (node.size.x/2 + new_node_size.x/2) * place_side.x
@@ -406,12 +412,6 @@ function DynamicGrid._get_next_node_pos(self, origin_node_index, new_node, place
 end
 
 
-
-function DynamicGrid._get_node_size(self, node)
-	return vmath.mul_per_elem(gui.get_size(node), gui.get_scale(node))
-end
-
-
 --- Return side vector to correct node shifting
 function DynamicGrid._get_side_vector(self, side, is_forward)
 	if side == const.SIDE.X then

druid/extended/hotkey.lua

@@ -0,0 +1,156 @@
+-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
+
+--- Druid hotkey component
+--
+-- <a href="https://insality.github.io/druid/druid/index.html?example=general_hotkey" target="_blank"><b>Example Link</b></a>
+-- @module Hotkey
+-- @within BaseComponent
+-- @alias druid.hotkey
+
+--- On change state callback(self, state)
+-- @tfield DruidEvent on_change_state @{DruidEvent}
+
+--- Visual node
+-- @tfield node node
+
+--- Button trigger node
+-- @tfield[opt=node] node click_node
+
+--- Button component from click_node
+-- @tfield Button button @{Button}
+
+---
+
+local helper = require("druid.helper")
+local component = require("druid.component")
+
+local Hotkey = component.create("hotkey")
+
+
+--- Component init function
+-- @tparam Hotkey self @{Hotkey}
+-- @tparam string[]|string keys The keys to be pressed for trigger callback. Should contains one key and any modificator keys
+-- @tparam function callback The callback function
+-- @tparam[opt] value callback_argument The argument to pass into the callback function
+function Hotkey.init(self, keys, callback, callback_argument)
+	self.druid = self:get_druid()
+
+	self._hotkeys = {}
+	self._modificators = {}
+	self._callback = callback
+
+	if keys then
+		self:add_hotkey(keys, callback_argument)
+	end
+end
+
+
+--- Component style params.
+-- You can override this component styles params in druid styles table
+-- or create your own style
+-- @table style
+-- @tfield string[] MODIFICATORS The list of action_id as hotkey modificators
+function Hotkey.on_style_change(self, style)
+	self.style = {}
+	self.style.MODIFICATORS = style.MODIFICATORS or {}
+
+	for index = 1, #style.MODIFICATORS do
+		self.style.MODIFICATORS[index] = hash(self.style.MODIFICATORS[index])
+	end
+end
+
+
+--- Add hotkey for component callback
+-- @tparam Hotkey self @{Hotkey}
+-- @tparam string[]|hash[]|string|hash keys that have to be pressed before key pressed to activate
+-- @tparam[opt] value callback_argument The argument to pass into the callback function
+function Hotkey.add_hotkey(self, keys, callback_argument)
+	keys = keys or {}
+	if type(keys) == "string" then
+		keys = { keys }
+	end
+
+	local modificators = {}
+	local key = nil
+
+	for index = 1, #keys do
+		local key_hash = hash(keys[index])
+		if helper.contains(self.style.MODIFICATORS, key_hash) then
+			table.insert(modificators, key_hash)
+		else
+			if not key then
+				key = key_hash
+			else
+				error("The hotkey keys should contains only one key (except modificator keys)")
+			end
+		end
+	end
+
+	table.insert(self._hotkeys, {
+		modificators = modificators,
+		key = key,
+		is_processing = false,
+		callback_argument = callback_argument,
+	})
+
+	-- Current hotkey status
+	for index = 1, #self.style.MODIFICATORS do
+		local modificator = hash(self.style.MODIFICATORS[index])
+		self._modificators[modificator] = self._modificators[modificator] or false
+	end
+
+	return self
+end
+
+
+function Hotkey.on_input(self, action_id, action)
+	if not action_id then
+		return false
+	end
+
+	if self._modificators[action_id] ~= nil then
+		if action.pressed then
+			self._modificators[action_id] = true
+		end
+		if action.released then
+			self._modificators[action_id] = false
+		end
+	end
+
+	for index = 1, #self._hotkeys do
+		local hotkey = self._hotkeys[index]
+		if action_id == hotkey.key then
+			local is_modificator_ok = true
+
+			-- Check only required modificators pressed
+			for i = 1, #self.style.MODIFICATORS do
+				local mod = self.style.MODIFICATORS[i]
+				if helper.contains(hotkey.modificators, mod) and self._modificators[mod] == false then
+					is_modificator_ok = false
+				end
+				if not helper.contains(hotkey.modificators, mod) and self._modificators[mod] == true then
+					is_modificator_ok = false
+				end
+			end
+
+			if action.pressed and is_modificator_ok then
+				hotkey.is_processing = true
+			end
+			if action.released and is_modificator_ok and hotkey.is_processing then
+				hotkey.is_processing = false
+				if hotkey.callback_argument then
+					self._callback(self:get_context(), hotkey.callback_argument)
+					return true
+				else
+					self._callback(self:get_context())
+					return true
+				end
+			end
+		end
+	end
+
+	return false
+end
+
+
+return Hotkey

druid/extended/input.lua

@@ -1,33 +1,37 @@
+-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
+
 --- Druid input text component.
 -- Carry on user text input
+--
+-- <a href="https://insality.github.io/druid/druid/index.html?example=general_input" target="_blank"><b>Example Link</b></a>
 -- @author Part of code from Britzl gooey input component
 -- @module Input
 -- @within BaseComponent
 -- @alias druid.input
 
 --- On input field select callback(self, button_node)
--- @tfield druid_event on_input_select
+-- @tfield DruidEvent on_input_select @{DruidEvent}
 
---- On input field unselect callback(self, button_node)
--- @tfield druid_event on_input_unselect
+--- On input field unselect callback(self, input_text)
+-- @tfield DruidEvent on_input_unselect @{DruidEvent}
 
 --- On input field text change callback(self, input_text)
--- @tfield druid_event on_input_text
+-- @tfield DruidEvent on_input_text @{DruidEvent}
 
 --- On input field text change to empty string callback(self, input_text)
--- @tfield druid_event on_input_empty
+-- @tfield DruidEvent on_input_empty @{DruidEvent}
 
 --- On input field text change to max length string callback(self, input_text)
--- @tfield druid_event on_input_full
+-- @tfield DruidEvent on_input_full @{DruidEvent}
 
 --- On trying user input with not allowed character callback(self, params, button_instance)
--- @tfield druid_event on_input_wrong
+-- @tfield DruidEvent on_input_wrong @{DruidEvent}
 
 --- Text component
--- @tfield druid.text text
+-- @tfield Text text @{Text}
 
 --- Button component
--- @tfield druid.button button
+-- @tfield Button button @{Button}
 
 --- Is current input selected now
 -- @tfield bool is_selected
@@ -49,9 +53,10 @@
 local Event = require("druid.event")
 local const = require("druid.const")
 local component = require("druid.component")
-local utf8 = require("druid.system.utf8")
+local utf8_lua = require("druid.system.utf8")
+local utf8 = utf8 or utf8_lua
 
-local Input = component.create("input", { component.ON_INPUT, component.ON_FOCUS_LOST })
+local Input = component.create("input")
 
 
 --- Mask text by replacing every character with a mask character
@@ -85,6 +90,7 @@ end
 -- @tfield[opt=false] bool IS_LONGTAP_ERASE Is long tap will erase current input data
 -- @tfield[opt=*] string MASK_DEFAULT_CHAR Default character mask for password input
 -- @tfield[opt=false] bool IS_UNSELECT_ON_RESELECT If true, call unselect on select selected input
+-- @tfield[opt=false] bool NO_CONSUME_INPUT_WHILE_SELECTED If true, will not consume input while input is selected. It's allow to interact with other components while input is selected (text input still captured)
 -- @tfield function on_select (self, button_node) Callback on input field selecting
 -- @tfield function on_unselect (self, button_node) Callback on input field unselecting
 -- @tfield function on_input_wrong (self, button_node) Callback on wrong user input
@@ -95,6 +101,7 @@ function Input.on_style_change(self, style)
 	self.style.IS_LONGTAP_ERASE = style.IS_LONGTAP_ERASE or false
 	self.style.MASK_DEFAULT_CHAR = style.MASK_DEFAULT_CHAR or "*"
 	self.style.IS_UNSELECT_ON_RESELECT = style.IS_UNSELECT_ON_RESELECT or false
+	self.style.NO_CONSUME_INPUT_WHILE_SELECTED = style.NO_CONSUME_INPUT_WHILE_SELECTED or false
 
 	self.style.on_select = style.on_select or function(_, button_node) end
 	self.style.on_unselect = style.on_unselect or function(_, button_node) end
@@ -108,13 +115,15 @@ function Input.on_style_change(self, style)
 end
 
 
--- @tparam node click_node Button node to enabled input component
--- @tparam node|druid.text text_node Text node what will be changed on user input. You can pass text component instead of text node name
+--- Component init function
+-- @tparam Input self @{Input}
+-- @tparam node click_node Node to enabled input component
+-- @tparam node|Text text_node Text node what will be changed on user input. You can pass text component instead of text node name @{Text}
 -- @tparam[opt] number keyboard_type Gui keyboard type for input field
 function Input.init(self, click_node, text_node, keyboard_type)
 	self.druid = self:get_druid(self)
 
-	if type(text_node) == const.TABLE then
+	if type(text_node) == "table" then
 		self.text = text_node
 	else
 		self.text = self.druid:new_text(text_node)
@@ -141,6 +150,10 @@ function Input.init(self, click_node, text_node, keyboard_type)
 	self.button.on_click_outside:subscribe(self.unselect)
 	self.button.on_long_click:subscribe(clear_and_select)
 
+	if html5 then
+		self.button:set_web_user_interaction(true)
+	end
+
 	self.on_input_select = Event()
 	self.on_input_unselect = Event()
 	self.on_input_text = Event()
@@ -164,8 +177,8 @@ function Input.on_input(self, action_id, action)
 			end)
 
 			-- ignore arrow keys
-			if not string.match(hex, "EF9C8[0-3]") then
-				if not self.allowed_characters or action.text:match(self.allowed_characters) then
+			if not utf8.match(hex, "EF9C8[0-3]") then
+				if not self.allowed_characters or utf8.match(action.text, self.allowed_characters) then
 					input_text = self.value .. action.text
 					if self.max_length then
 						input_text = utf8.sub(input_text, 1, self.max_length)
@@ -210,7 +223,8 @@ function Input.on_input(self, action_id, action)
 		end
 	end
 
-	return self.is_selected
+	local is_consume_input = not self.style.NO_CONSUME_INPUT_WHILE_SELECTED and self.is_selected
+	return is_consume_input
 end
 
 
@@ -225,7 +239,7 @@ end
 
 
 --- Set text for input field
--- @tparam Input self
+-- @tparam Input self @{Input}
 -- @tparam string input_text The string to apply for input field
 function Input.set_text(self, input_text)
 	-- Case when update with marked text
@@ -256,8 +270,8 @@ function Input.set_text(self, input_text)
 		self.text:set_to(final_text)
 
 		-- measure it
-		self.text_width = self.text:get_text_width(value)
-		self.marked_text_width = self.text:get_text_width(marked_value)
+		self.text_width = self.text:get_text_size(value)
+		self.marked_text_width = self.text:get_text_size(marked_value)
 		self.total_width = self.text_width + self.marked_text_width
 
 		self.on_input_text:trigger(self:get_context(), final_text)
@@ -272,13 +286,13 @@ end
 
 
 --- Select input field. It will show the keyboard and trigger on_select events
--- @tparam Input self
+-- @tparam Input self @{Input}
 function Input.select(self)
 	gui.reset_keyboard()
 	self.marked_value = ""
 	if not self.is_selected then
-		self:set_input_priority(const.PRIORITY_INPUT_MAX)
-		self.button:set_input_priority(const.PRIORITY_INPUT_MAX)
+		self:set_input_priority(const.PRIORITY_INPUT_MAX, true)
+		self.button:set_input_priority(const.PRIORITY_INPUT_MAX, true)
 		self.previous_value = self.value
 		self.is_selected = true
 
@@ -295,7 +309,7 @@ end
 
 
 --- Remove selection from input. It will hide the keyboard and trigger on_unselect events
--- @tparam Input self
+-- @tparam Input self @{Input}
 function Input.unselect(self)
 	gui.reset_keyboard()
 	self.marked_value = ""
@@ -305,7 +319,7 @@ function Input.unselect(self)
 		self.is_selected = false
 
 		gui.hide_keyboard()
-		self.on_input_unselect:trigger(self:get_context())
+		self.on_input_unselect:trigger(self:get_context(), self:get_text())
 
 		self.style.on_unselect(self, self.button.node)
 	end
@@ -313,7 +327,7 @@ end
 
 
 --- Return current input field text
--- @tparam Input self
+-- @tparam Input self @{Input}
 -- @treturn string The current input field text
 function Input.get_text(self)
 	return self.value .. self.marked_value
@@ -322,7 +336,7 @@ end
 
 --- Set maximum length for input field.
 -- Pass nil to make input field unliminted (by default)
--- @tparam Input self
+-- @tparam Input self @{Input}
 -- @tparam number max_length Maximum length for input text field
 -- @treturn druid.input Current input instance
 function Input.set_max_length(self, max_length)
@@ -334,7 +348,7 @@ end
 --- Set allowed charaters for input field.
 -- See: https://defold.com/ref/stable/string/
 -- ex: [%a%d] for alpha and numeric
--- @tparam Input self
+-- @tparam Input self @{Input}
 -- @tparam string characters Regulax exp. for validate user input
 -- @treturn druid.input Current input instance
 function Input.set_allowed_characters(self, characters)
@@ -344,7 +358,7 @@ end
 
 
 --- Reset current input selection and return previous value
--- @tparam Input self
+-- @tparam Input self @{Input}
 function Input.reset_changes(self)
 	self:set_text(self.previous_value)
 	self:unselect()

druid/extended/lang_text.lua

@@ -1,14 +1,27 @@
---- Component to handle all GUI texts
--- Good working with localization system
+-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
+
+--- Component to wrap over GUI Text nodes with localization helpers
+--
+-- <b># Overview #</b>
+--
+-- • The initialization of druid.set_text_function is required to enable localization
+-- using the localization ID.
+--
+-- • The LangText component supports up to 7 string format parameters.
+-- This limitation exists due to certain issues with using ... arguments.
+--
+-- <b># Notes #</b>
+--
+-- <a href="https://insality.github.io/druid/druid/index.html?example=texts_lang_text" target="_blank"><b>Example Link</b></a>
 -- @module LangText
 -- @within BaseComponent
 -- @alias druid.lang_text
 
 --- On change text callback
--- @tfield druid_event on_change
+-- @tfield DruidEvent on_change @{DruidEvent}
 
 --- The text component
--- @tfield Text text
+-- @tfield Text text @{Text}
 
 ---
 
@@ -16,24 +29,23 @@ local Event = require("druid.event")
 local settings = require("druid.system.settings")
 local component = require("druid.component")
 
-local LangText = component.create("lang_text", { component.ON_LANGUAGE_CHANGE })
+local LangText = component.create("lang_text")
 
 
---- Component init function
--- @tparam LangText self
--- @tparam node node The text node
--- @tparam string locale_id Default locale id, optional
--- @tparam bool no_adjust If true, will not correct text size
-function LangText.init(self, node, locale_id, no_adjust)
+--- The @{LangText} constructor
+-- @tparam LangText self @{LangText}
+-- @tparam string|node node Node name or GUI Text Node itself
+-- @tparam string locale_id Default locale id or text from node as default
+-- @tparam[opt=downscale] string adjust_type Adjust type for text. By default is DOWNSCALE. Look const.TEXT_ADJUST for reference
+function LangText.init(self, node, locale_id, adjust_type)
 	self.druid = self:get_druid()
-	self.text = self.druid:new_text(node, locale_id, no_adjust)
+	self.text = self.druid:new_text(node, locale_id, adjust_type)
+	self.node = self.text.node
 	self.last_locale_args = {}
 
 	self.on_change = Event()
 
-	if locale_id then
-		self:translate(locale_id)
-	end
+	self:translate(locale_id or gui.get_text(self.node))
 
 	return self
 end
@@ -47,23 +59,53 @@ end
 
 
 --- Setup raw text to lang_text component
--- @tparam LangText self
+-- @tparam LangText self @{LangText}
 -- @tparam string text Text for text node
+-- @treturn LangText Current instance
 function LangText.set_to(self, text)
 	self.last_locale = false
 	self.text:set_to(text)
 	self.on_change:trigger()
+
+	return self
 end
 
 
 --- Translate the text by locale_id
--- @tparam LangText self
+-- @tparam LangText self @{LangText}
 -- @tparam string locale_id Locale id
-function LangText.translate(self, locale_id, ...)
-	self.last_locale_args = {...}
+-- @tparam[opt] string a Optional param to string.format
+-- @tparam[opt] string b Optional param to string.format
+-- @tparam[opt] string c Optional param to string.format
+-- @tparam[opt] string d Optional param to string.format
+-- @tparam[opt] string e Optional param to string.format
+-- @tparam[opt] string f Optional param to string.format
+-- @tparam[opt] string g Optional param to string.format
+-- @treturn LangText Current instance
+function LangText.translate(self, locale_id, a, b, c, d, e, f, g)
+	self.last_locale_args = { a, b, c, d, e, f, g }
 	self.last_locale = locale_id or self.last_locale
-	self.text:set_to(settings.get_text(self.last_locale, ...) or "")
+	self.text:set_to(settings.get_text(self.last_locale, a, b, c, d, e, f, g) or "")
+
+	return self
 end
 
 
+--- Format string with new text params on localized text
+-- @tparam LangText self @{LangText}
+-- @tparam[opt] string a Optional param to string.format
+-- @tparam[opt] string b Optional param to string.format
+-- @tparam[opt] string c Optional param to string.format
+-- @tparam[opt] string d Optional param to string.format
+-- @tparam[opt] string e Optional param to string.format
+-- @tparam[opt] string f Optional param to string.format
+-- @tparam[opt] string g Optional param to string.format
+-- @treturn LangText Current instance
+function LangText.format(self, a, b, c, d, e, f, g)
+	self.last_locale_args = { a, b, c, d, e, f, g }
+	self.text:set_to(settings.get_text(self.last_locale, a, b, c, d, e, f, g) or "")
+
+	return self
+end
+
 return LangText

druid/extended/layout.lua

@@ -0,0 +1,217 @@
+-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
+
+--- Layout management on node
+--
+-- <a href="https://insality.github.io/druid/druid/index.html?example=general_layout" target="_blank"><b>Example Link</b></a>
+-- @module Layout
+-- @within BaseComponent
+-- @alias druid.layout
+
+--- Layout node
+-- @tfield node node
+
+--- Current layout mode
+-- @tfield string mode
+
+---On window resize callback(self, new_size)
+-- @tfield DruidEvent on_size_changed @{DruidEvent}
+
+---
+
+
+local const = require("druid.const")
+local helper = require("druid.helper")
+local component = require("druid.component")
+local Event = require("druid.event")
+
+
+local Layout = component.create("layout")
+
+
+--- Component init function
+-- @tparam Layout self @{Layout}
+-- @tparam node node Gui node
+-- @tparam string mode The layout mode (from const.LAYOUT_MODE)
+-- @tparam[opt] function on_size_changed_callback The callback on window resize
+function Layout.init(self, node, mode, on_size_changed_callback)
+	self.node = self:get_node(node)
+
+	self._min_size = nil
+	self._max_size = nil
+	self._current_size = vmath.vector3(0)
+	self._inited = false
+	self._max_gui_upscale = nil
+	self._fit_node = nil
+
+	self._anchors = {}
+
+	self.mode = mode or const.LAYOUT_MODE.FIT
+
+	self.on_size_changed = Event(on_size_changed_callback)
+end
+
+
+function Layout.on_late_init(self)
+	self._inited = true
+	self.origin_size = self.origin_size or gui.get_size(self.node)
+	self.fit_size = self.fit_size or vmath.vector3(self.origin_size)
+	self.pivot = helper.get_pivot_offset(gui.get_pivot(self.node))
+	self.origin_position = gui.get_position(self.node)
+	self.position = vmath.vector3(self.origin_position)
+	gui.set_size_mode(self.node, gui.SIZE_MODE_MANUAL)
+	gui.set_adjust_mode(self.node, gui.ADJUST_FIT)
+	self:on_window_resized()
+end
+
+
+function Layout.on_window_resized(self)
+	if not self._inited then
+		return
+	end
+
+	local x_koef, y_koef = helper.get_screen_aspect_koef()
+
+	local revert_scale = 1
+	if self._max_gui_upscale then
+		revert_scale = self._max_gui_upscale / helper.get_gui_scale()
+		revert_scale = math.min(revert_scale, 1)
+	end
+	gui.set_scale(self.node, vmath.vector3(revert_scale))
+
+	if self._fit_node then
+		self.fit_size = gui.get_size(self._fit_node)
+		self.fit_size.x = self.fit_size.x / x_koef
+		self.fit_size.y = self.fit_size.y / y_koef
+	end
+
+	x_koef = self.fit_size.x / self.origin_size.x * x_koef
+	y_koef = self.fit_size.y / self.origin_size.y * y_koef
+
+	local new_size = vmath.vector3(self.origin_size)
+
+	if self.mode == const.LAYOUT_MODE.STRETCH then
+		new_size.x = new_size.x * x_koef / revert_scale
+		new_size.y = new_size.y * y_koef / revert_scale
+	end
+
+	if self.mode == const.LAYOUT_MODE.STRETCH_X then
+		new_size.x = new_size.x * x_koef / revert_scale
+	end
+
+	if self.mode == const.LAYOUT_MODE.STRETCH_Y then
+		new_size.y = new_size.y * y_koef / revert_scale
+	end
+
+	-- Fit to the stretched container (node size or other defined)
+	if self.mode == const.LAYOUT_MODE.ZOOM_MIN then
+		new_size = new_size * math.min(x_koef, y_koef)
+	end
+	if self.mode == const.LAYOUT_MODE.ZOOM_MAX then
+		new_size = new_size * math.max(x_koef, y_koef)
+	end
+
+	if self._min_size then
+		new_size.x = math.max(new_size.x, self._min_size.x)
+		new_size.y = math.max(new_size.y, self._min_size.y)
+	end
+	if self._max_size then
+		new_size.x = math.min(new_size.x, self._max_size.x)
+		new_size.y = math.min(new_size.y, self._max_size.y)
+	end
+	self._current_size = new_size
+	gui.set_size(self.node, new_size)
+
+	self.position.x = self.origin_position.x + self.origin_position.x * (x_koef - 1)
+	self.position.y = self.origin_position.y + self.origin_position.y * (y_koef - 1)
+	gui.set_position(self.node, self.position)
+
+	self.on_size_changed:trigger(self:get_context(), new_size)
+end
+
+
+--- Set minimal size of layout node
+-- @tparam Layout self @{Layout}
+-- @tparam vector3 min_size
+-- @treturn Layout @{Layout}
+function Layout.set_min_size(self, min_size)
+	self._min_size = min_size
+	return self
+end
+
+
+--- Set maximum size of layout node
+-- @tparam Layout self @{Layout}
+-- @tparam vector3 max_size
+-- @treturn Layout @{Layout}
+function Layout.set_max_size(self, max_size)
+	self._max_size = max_size
+	return self
+end
+
+
+--- Set new origin position of layout node. You should apply this on node movement
+-- @tparam Layout self @{Layout}
+-- @tparam vector3 new_origin_position
+-- @treturn Layout @{Layout}
+function Layout.set_origin_position(self, new_origin_position)
+	self.origin_position = new_origin_position or self.origin_position
+	self:on_window_resized()
+	return self
+end
+
+
+--- Set new origin size of layout node. You should apply this on node manual size change
+-- @tparam Layout self @{Layout}
+-- @tparam vector3 new_origin_size
+-- @treturn Layout @{Layout}
+function Layout.set_origin_size(self, new_origin_size)
+	self.origin_size = new_origin_size or self.origin_size
+	self:on_window_resized()
+	return self
+end
+
+
+--- Set max gui upscale for FIT adjust mode (or side). It happens on bigger render gui screen
+-- @tparam Layout self @{Layout}
+-- @tparam number max_gui_upscale
+-- @treturn Layout @{Layout}
+function Layout.set_max_gui_upscale(self, max_gui_upscale)
+	self._max_gui_upscale = max_gui_upscale
+	self:on_window_resized()
+end
+
+
+--- Set size for layout node to fit inside it
+-- @tparam Layout self @{Layout}
+-- @tparam vector3 target_size
+-- @treturn Layout @{Layout}
+function Layout.fit_into_size(self, target_size)
+	self.fit_size = target_size
+	self:on_window_resized()
+	return self
+end
+
+
+--- Set node for layout node to fit inside it. Pass nil to reset
+-- @tparam Layout self @{Layout}
+-- @tparam[opt] Node node
+-- @treturn Layout @{Layout}
+function Layout.fit_into_node(self, node)
+	self._fit_node = node
+	self:on_window_resized()
+	return self
+end
+
+
+--- Set current size for layout node to fit inside it
+-- @tparam Layout self @{Layout}
+-- @treturn Layout @{Layout}
+function Layout.fit_into_window(self)
+	return self:fit_into_size(vmath.vector3(
+		gui.get_width(),
+		gui.get_height(),
+		0))
+end
+
+
+return Layout