Merge pull request #303 from Insality/update_docs

Docs, widgets and code refactor

.github/workflows/ci-workflow.yml

@@ -7,17 +7,22 @@ jobs:
         name: Build and run tests
         runs-on: ubuntu-latest
         steps:
-          - uses: actions/checkout@v2
+          - uses: actions/checkout@v4
             with:
                 lfs: true
-          - uses: actions/setup-java@v1
+
+          - uses: actions/setup-java@v3
             with:
-                java-version: '17'
+                distribution: 'zulu'
+                java-version: '21'
 
           - name: Build && Run
             run: |
               deployer_url="https://raw.githubusercontent.com/Insality/defold-deployer/1/deployer.sh"
               curl -s ${deployer_url} | bash -s lbd --headless --settings ./test/test.ini
 
-          - name: Upload test report
-            run: bash <(curl -s https://codecov.io/bash)
+          - name: Upload coverage reports to Codecov
+            uses: codecov/codecov-action@v4.0.1
+            with:
+              token: ${{ secrets.CODECOV_TOKEN }}
+              slug: insality/druid

.luacov

@@ -0,0 +1,73 @@
+local reporter = require("luacov.reporter.defold")
+
+--- Default values for configuration options.
+-- For project specific configuration create '.luacov' file in your project
+-- folder. It should be a Lua script setting various options as globals
+-- or returning table of options.
+-- @class module
+-- @name deftest.coverage.configuration
+return {
+
+  --- Reporter class to use when creating a report. Default: DefaultReporter from reporter.lua
+  reporter = reporter,
+
+  --- Filename to store collected stats. Default: "luacov.stats.out".
+  statsfile = "luacov.stats.out",
+
+  --- Filename to store report. Default: "luacov.report.out".
+  reportfile = "luacov.report.out",
+
+  --- Enable saving coverage data after every `savestepsize` lines?
+  -- Setting this flag to `true` in config is equivalent to running LuaCov
+  -- using `luacov.tick` module. Default: false.
+  tick = false,
+
+  --- Stats file updating frequency for `luacov.tick`.
+  -- The lower this value - the more frequently results will be written out to the stats file.
+  -- You may want to reduce this value (to, for example, 2) to avoid losing coverage data in
+  -- case your program may terminate without triggering luacov exit hooks that are supposed
+  -- to save the data. Default: 100.
+  savestepsize = 100,
+
+  --- Run reporter on completion? Default: true.
+  runreport = true,
+
+  --- Delete stats file after reporting? Default: false.
+  deletestats = true,
+
+  --- Process Lua code loaded from raw strings?
+  -- That is, when the 'source' field in the debug info
+  -- does not start with '@'. Default: true.
+  codefromstrings = true,
+
+  --- Lua patterns for files to include when reporting.
+  -- All will be included if nothing is listed.
+  -- Do not include the '.lua' extension. Path separator is always '/'.
+  -- Overruled by `exclude`.
+  -- @usage
+  -- include = {
+  --    "mymodule$",      -- the main module
+  --    "mymodule%/.+$",  -- and everything namespaced underneath it
+  -- }
+  include = {},
+
+  --- Lua patterns for files to exclude when reporting.
+  -- Nothing will be excluded if nothing is listed.
+  -- Do not include the '.lua' extension. Path separator is always '/'.
+  -- Overrules `include`.
+  exclude = { "^test%/.+$" },
+
+  --- Table mapping names of modules to be included to their filenames.
+  -- Has no effect if empty.
+  -- Real filenames mentioned here will be used for reporting
+  -- even if the modules have been installed elsewhere.
+  -- Module name can contain '*' wildcard to match groups of modules,
+  -- in this case corresponding path will be used as a prefix directory
+  -- where modules from the group are located.
+  -- @usage
+  -- modules = {
+  --    ["some_rock"] = "src/some_rock.lua",
+  --    ["some_rock.*"] = "src"
+  -- }
+  modules = {},
+}

.vscode/settings.json

@@ -32,9 +32,8 @@
 	"Lua.diagnostics.libraryFiles": "Disable",
 	"Lua.runtime.version": "Lua 5.1",
 	"Lua.workspace.library": [
-		"~/Library/Application Support/Code/User/globalStorage/astronachos.defold",
-		"~/Library/Application Support/Code/User/workspaceStorage/72e25b7e0fdc873ee6f7baa61edbd6b1/astronachos.defold",
-		"~/Library/Application Support/Code/User/workspaceStorage/1446075a23c89451a63f0e82b2291def/astronachos.defold"
+		"~/Library/Application Support/Cursor/User/globalStorage/astronachos.defold",
+		"~/Library/Application Support/Cursor/User/workspaceStorage/1446075a23c89451a63f0e82b2291def/astronachos.defold"
 	],
 	"files.exclude": {
 		"**/*.gui": true

CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# Contribution Guidelines
+
+Hello, Defolder! Thanks for your interest in contributing to the **Druid** project. It's a massive project that has been around for a long time, and it's still growing. This project has a lot of places where you can help!
+
+Finally, there are set of instructions that will help you to contribute to the project.
+
+Thanks for your help!
+
+## Update Documentation
+
+If you see any mistakes in the documentation, you can update it by yourself.
+
+You can push changes to the `master` branch directly. In case of small fixes, please also update the relative API `md` files. If there is a lot of changes, I will regenerate them manually.
+
+## Issue Reporting
+
+If you find any bugs, please report them to the [issue tracker](https://github.com/druid-js/druid/issues).
+
+## Pull Requests
+
+Any pull requests are welcome!
+
+Please, open PR against the `develop` branch. Very nice to have an issue, which this PR fixes.
+
+You fix should contains only changes, which are related to the issue. Also please keep the code style the same!
+
+Thanks <3
+
+## Add or Update Examples
+
+Examples contains a GUI scene, a Druid widget for this GUI. This GUI is included to the `examples.gui` and the information about examples are added in `examples_list.lua` file
+
+You can add new examples or update existing ones.
+
+To add new example, you need to create a new folder in the `examples` directory.
+
+

README.md

@@ -7,37 +7,54 @@
 
 [![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)
 
-**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.
+**Druid** - a powerful, flexible and easy to use **Defold** component UI framework. Contains a wide range of UI components that you can use to create a beautiful, responsive and customizable GUIs. Provides a powerful way to create, compose and manage your custom components and scenes.
 
 ## Druid Example
 
-Check the [**HTML5 version**](https://insality.github.io/druid/druid/) of the **Druid** example app.
+Check the [**HTML5 version**](https://insality.github.io/druid/) of the **Druid** example app.
 
 In this example you can inspect a variety of **Druid** components and see how they work. Each example page provides a direct link to the corresponding example code, making it easier for you to understand how to use **Druid**.
 
+## Features
+
+- **Components** - Provides a extensive set of components, from basic buttons to infinity data lists and rich texts
+- **Customizable** - You can customize components appearance and behaviour
+- **Widgets** - Powerful way to create your own reusable components
+- **Input Handling** - Handles input in a stack-based manner and manage input priority
+- **Event Based** - Uses [Defold Event](https://github.com/Insality/defold-event) for components callbacks and communication between components
+
 ## Setup
 
-### [Dependency](https://www.defold.com/manuals/libraries/)
+### [Dependency](https://defold.com/manuals/libraries/#setting-up-library-dependencies)
 
-Open your `game.project` file and add the following line to the dependencies field under the project section:
+Open your `game.project` file and add the following lines to the dependencies field under the project section:
 
-**[Druid](https://github.com/Insality/druid/archive/refs/tags/1.0.zip)**
+
+**[Druid](https://github.com/Insality/druid/)**
 
 ```
 https://github.com/Insality/druid/archive/refs/tags/1.0.zip
 ```
 
+**[Defold Event](https://github.com/Insality/defold-event)**
+
+```
+https://github.com/Insality/defold-event/archive/refs/tags/10.zip
+```
+
+After that, select `Project ▸ Fetch Libraries` to update [library dependencies]((https://defold.com/manuals/libraries/#setting-up-library-dependencies)). This happens automatically whenever you open a project so you will only need to do this if the dependencies change without re-opening the project.
+
 Here is a list of [all releases](https://github.com/Insality/druid/releases).
 
 
 ### Library Size
 
-> **Note:** The library size is calculated based on the build report per platform. The extended components are exlcuded, which are including only on demand.
+> **Note:** The library size is calculated based on the build report per platform. Full size contains all components, they can be stripped out in the build process if you don't need them.
 
-| Platform         | Library Size  |
+| Platform         | Full Size  |
 | ---------------- | ------------- |
-| HTML5            | **38.00 KB**  |
-| Desktop / Mobile | **65.74 KB**  |
+| HTML5            | **84.52 KB**  |
+| Desktop / Mobile | **141.03 KB**  |
 
 
 ### Input Bindings
@@ -49,167 +66,74 @@ Here is a list of [all releases](https://github.com/Insality/druid/releases).
 
 ### Basic usage
 
-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*.
-
-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.
-
-All **Druid** and component methods are invoked using the `:` operator, such as `self.druid:new_button()`.
-
-```lua
-local druid = require("druid.druid")
-
--- 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.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/DruidInstance.html).
-
-
-### Default GUI Script
-
-Put the following code in your GUI script to start using **Druid**.
-
-```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_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
-```
-
-
-### Default Widget Template
-
-Create a new lua file to create a new widget class. This widget can be created with `self.druid:new_widget(widget_class, [template], [nodes])`
-
-```lua
-local M = {}
-
-function M:init()
-	self.root = self:get_node("root")
-	self.button = self.druid:new_button("button", self.on_click)
-end
-
-function M:on_click()
-	print("Button clicked!")
-end
-
-return M
-```
-
+Read more in the [Basic Usage](wiki/basic_usage.md)
 
 ### API Documentation
 
-**Druid** offers a wide range of components and functions. To facilitate usage, **Druid** provides comprehensive API documentation with examples and annotations.
+Best start is from the [Quick API Reference](api/quick_api_reference.md)
 
-Start reading the API documentation [here](https://insality.github.io/druid/modules/Druid.html).
+With next quick links:
 
-**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 Instance](api/druid_instance_api.md) - **Druid** instance returned from `druid.new(self)`
+- [Helper](api/druid_helper_api.md) - A lot of useful functions
+- [Widgets](wiki/widgets.md) - About widgets and how to use them
 
 
 ## Druid Components
 
 Here is full **Druid** components list.
 
-### Basic Components
-
-> Basic components always included in the build and available for use.
+### Components
 
 | 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=ui_example_basic_button) | <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=ui_example_basic_text) | <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=ui_example_basic_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. | [Blocker Example](https://insality.github.io/druid/druid/?example=ui_example_basic_blocker) | <img src="media/preview/blocker.gif" width="200" height="100"> |
-| **[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 | [Back Handler Example](https://insality.github.io/druid/druid/?example=ui_example_basic_back_handler) | <img src="media/preview/back_handler.gif" width="200" height="100"> |
-| **[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=ui_example_basic_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. | [Hover Example](https://insality.github.io/druid/druid/?example=ui_example_basic_hover) | <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=ui_example_basic_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=ui_example_basic_drag) | <img src="media/preview/drag.gif" width="200" height="100"> |
-
-
-### Extended components
-
-| Name | Description | Example | <div style="width:200px">Preview</div> |
-|------|-------------|---------|---------|
-| **[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=ui_example_data_list_basic) | <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=ui_example_basic_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` | [Lang Text Example](https://insality.github.io/druid/druid/?example=ui_example_window_language) | <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=ui_example_basic_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=ui_example_basic_slider) | <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. | [Timer Example](https://insality.github.io/druid/druid/?example=ui_example_basic_timer) | <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=ui_example_basic_hotkey) | <img src="media/preview/hotkey.gif" width="200" height="100"> |
-| **[Layout](https://insality.github.io/druid/modules/Layout.html)** | Logic over GUI Node. Arrange nodes inside layout node with margin/paddings settings. | [Layout Example](https://insality.github.io/druid/druid/?example=ui_example_layout_basic) | <img src="media/preview/layout.gif" width="200" height="100"> |
-| **[Rich Input](https://insality.github.io/druid/modules/RichInput.html)** | Logic over GUI Node and GUI Text (or Text component). Provides rich text input with different styles and text formatting. | [Rich Input Example](https://insality.github.io/druid/druid/?example=ui_example_basic_rich_input) | <img src="media/preview/rich_input.gif" width="200" height="100"> |
-| **[Rich Text](https://insality.github.io/druid/modules/RichText.html)** | Logic over GUI Text. Provides rich text formatting with different styles and text formatting. | [Rich Text Example](https://insality.github.io/druid/druid/?example=ui_example_basic_rich_text) | <img src="media/preview/rich_text.gif" width="200" height="100"> |
-
-For a complete overview, see: **_[components.md](docs_md/01-components.md)_**.
+| **[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/?example=ui_example_basic_button) | <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/?example=ui_example_basic_text) | <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/?example=ui_example_basic_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. | [Blocker Example](https://insality.github.io/druid/?example=ui_example_basic_blocker) | <img src="media/preview/blocker.gif" width="200" height="100"> |
+| **[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 | [Back Handler Example](https://insality.github.io/druid/?example=ui_example_basic_back_handler) | <img src="media/preview/back_handler.gif" width="200" height="100"> |
+| **[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/?example=ui_example_basic_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. | [Hover Example](https://insality.github.io/druid/?example=ui_example_basic_hover) | <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/?example=ui_example_basic_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/?example=ui_example_basic_drag) | <img src="media/preview/drag.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/?example=ui_example_data_list_basic) | <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/?example=ui_example_basic_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` | [Lang Text Example](https://insality.github.io/druid/?example=ui_example_window_language) | <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/?example=ui_example_basic_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/?example=ui_example_basic_slider) | <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. | [Timer Example](https://insality.github.io/druid/?example=ui_example_basic_timer) | <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/?example=ui_example_basic_hotkey) | <img src="media/preview/hotkey.gif" width="200" height="100"> |
+| **[Layout](https://insality.github.io/druid/modules/Layout.html)** | Logic over GUI Node. Arrange nodes inside layout node with margin/paddings settings. | [Layout Example](https://insality.github.io/druid/?example=ui_example_layout_basic) | <img src="media/preview/layout.gif" width="200" height="100"> |
+| **[Rich Input](https://insality.github.io/druid/modules/RichInput.html)** | Logic over GUI Node and GUI Text (or Text component). Provides rich text input with different styles and text formatting. | [Rich Input Example](https://insality.github.io/druid/?example=ui_example_basic_rich_input) | <img src="media/preview/rich_input.gif" width="200" height="100"> |
+| **[Rich Text](https://insality.github.io/druid/modules/RichText.html)** | Logic over GUI Text. Provides rich text formatting with different styles and text formatting. | [Rich Text Example](https://insality.github.io/druid/?example=ui_example_basic_rich_text) | <img src="media/preview/rich_text.gif" width="200" height="100"> |
 
 
 ## 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/Button.html#on_click)) pointed list of component events. You can manually subscribe to these events with the following API:
+All **Druid** components using [Defold Event](https://github.com/Insality/defold-event) for components callbacks. 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)
 
 - **event:unsubscribe**(callback)
 
-- **event:clear**()
-
 You can subscribe several callbacks to a single event.
 
+Examples:
+
+```lua
+button.on_click:subscribe(function(self, args)
+	print("Button clicked!")
+end)
+
+scroll.on_scroll:subscribe(function(self, position)
+	print("Scroll scrolled!")
+end)
+
+input.on_input_unselect:subscribe(function(self, text)
+	print("User enter input:", text)
+end)
+```
+
 ## Details
 
 - **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.
@@ -220,7 +144,7 @@ You can subscribe several callbacks to a single event.
 
 ## Examples
 
-Try the [**HTML5 version**](https://insality.github.io/druid/druid/) of the **Druid** example app.
+Try the [**HTML5 version**](https://insality.github.io/druid/) of the **Druid** example app.
 
 Each example page provides a direct link to the corresponding example code, making it easier for you to understand how to use **Druid**.
 
@@ -228,21 +152,19 @@ Or refer directly to the [**example folder**](https://github.com/Insality/druid/
 
 ## 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)
+You can find the full **Druid** functions at [Quick API Reference](api/quick_api_reference.md)
 
-You can find the full **Druid** [documentation here](https://insality.github.io/druid/modules/Druid.html).
+To better understand **Druid**, read the following documentation:
+
+- [How To GUI in Defold](https://forum.defold.com/t/how-to-gui-in-defold/73256)
+- [Widgets](wiki/widgets.md)
+- [Create custom components](docs_md/02-creating_custom_components.md)
+- [Druid styles](docs_md/03-styles.md)
 
 
 ## Licenses
 
-- Developed and supported by [Insality](https://github.com/Insality)
-- Original idea by [AGulev](https://github.com/AGulev)
-- Assets from [Kenney](http://www.kenney.nl/)
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
 
 ## Issues and suggestions
@@ -256,10 +178,14 @@ For a complete history of the development of **Druid**, please check the [change
 
 ## 👏 Contributors
 
+Special thanks to all the contributors who have helped make **Druid** better!
+
 <a href="https://github.com/Insality/druid/graphs/contributors">
   <img src="https://contributors-img.web.app/image?repo=insality/druid"/>
 </a>
 
+Read the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.
+
 
 ## ❤️ Support project ❤️
 

api/components/base/back_handler_api.md

@@ -0,0 +1,36 @@
+# druid.back_handler API
+
+> at /druid/base/back_handler.lua
+
+The component that handles the back handler action, like backspace or android back button
+
+
+## Functions
+- [init](#init)
+
+
+## Fields
+- [on_back](#on_back)
+- [params](#params)
+
+
+
+### init
+
+---
+```lua
+back_handler:init([callback], [params])
+```
+
+- **Parameters:**
+	- `[callback]` *(function|nil)*: The callback to call when the back handler is triggered
+	- `[params]` *(any)*: Custom args to pass in the callback
+
+
+## Fields
+<a name="on_back"></a>
+- **on_back** (_event_): Trigger on back handler action, fun(self, params)
+
+<a name="params"></a>
+- **params** (_any_): Custom args to pass in the callback
+

api/components/base/blocker_api.md

@@ -0,0 +1,58 @@
+# druid.blocker API
+
+> at /druid/base/blocker.lua
+
+
+## Functions
+- [init](#init)
+- [set_enabled](#set_enabled)
+- [is_enabled](#is_enabled)
+
+
+## Fields
+- [node](#node)
+
+
+
+### init
+
+---
+```lua
+blocker:init(node)
+```
+
+- **Parameters:**
+	- `node` *(string|node)*: The node to use as a blocker
+
+### set_enabled
+
+---
+```lua
+blocker:set_enabled(state)
+```
+
+Set blocker enabled state
+
+- **Parameters:**
+	- `state` *(boolean)*: The new enabled state
+
+- **Returns:**
+	- `self` *(druid.blocker)*: The blocker instance
+
+### is_enabled
+
+---
+```lua
+blocker:is_enabled()
+```
+
+Get blocker enabled state
+
+- **Returns:**
+	- `is_enabled` *(boolean)*: True if the blocker is enabled
+
+
+## Fields
+<a name="node"></a>
+- **node** (_node_)
+

api/components/base/button_api.md

@@ -0,0 +1,256 @@
+# druid.button API
+
+> at /druid/base/button.lua
+
+Druid component to make clickable node with various interaction callbacks
+
+
+## Functions
+- [init](#init)
+- [set_animations_disabled](#set_animations_disabled)
+- [set_enabled](#set_enabled)
+- [is_enabled](#is_enabled)
+- [set_click_zone](#set_click_zone)
+- [set_key_trigger](#set_key_trigger)
+- [get_key_trigger](#get_key_trigger)
+- [set_check_function](#set_check_function)
+- [set_web_user_interaction](#set_web_user_interaction)
+
+
+## Fields
+- [on_click](#on_click)
+- [on_pressed](#on_pressed)
+- [on_repeated_click](#on_repeated_click)
+- [on_long_click](#on_long_click)
+- [on_double_click](#on_double_click)
+- [on_hold_callback](#on_hold_callback)
+- [on_click_outside](#on_click_outside)
+- [node](#node)
+- [node_id](#node_id)
+- [anim_node](#anim_node)
+- [params](#params)
+- [hover](#hover)
+- [click_zone](#click_zone)
+- [start_scale](#start_scale)
+- [start_pos](#start_pos)
+- [disabled](#disabled)
+- [key_trigger](#key_trigger)
+- [style](#style)
+- [druid](#druid)
+- [is_repeated_started](#is_repeated_started)
+- [last_pressed_time](#last_pressed_time)
+- [last_released_time](#last_released_time)
+- [click_in_row](#click_in_row)
+- [can_action](#can_action)
+
+
+
+### init
+
+---
+```lua
+button:init(node_or_node_id, [callback], [custom_args], [anim_node])
+```
+
+The constructor for the button component
+
+- **Parameters:**
+	- `node_or_node_id` *(string|node)*: Node name or GUI Node itself
+	- `[callback]` *(fun()|nil)*: Callback on button click
+	- `[custom_args]` *(any)*: Custom args for any Button event
+	- `[anim_node]` *(string|node|nil)*: Node to animate instead of trigger node
+
+### set_animations_disabled
+
+---
+```lua
+button:set_animations_disabled()
+```
+
+Remove default button style animations
+
+- **Returns:**
+	- `self` *(druid.button)*: The current button instance
+
+### set_enabled
+
+---
+```lua
+button:set_enabled([state])
+```
+
+Set button enabled state.
+The style.on_set_enabled will be triggered.
+Disabled button is not clickable.
+
+- **Parameters:**
+	- `[state]` *(boolean|nil)*: Enabled state
+
+- **Returns:**
+	- `self` *(druid.button)*: The current button instance
+
+### is_enabled
+
+---
+```lua
+button:is_enabled()
+```
+
+Get button enabled state.
+By default all Buttons is enabled on creating.
+
+- **Returns:**
+	- `is_enabled` *(boolean)*: True, if button is enabled now, False overwise
+
+### set_click_zone
+
+---
+```lua
+button:set_click_zone([zone])
+```
+
+Set additional button click area.
+Useful to restrict click outside out stencil node or scrollable content.
+If button node placed inside stencil node, it will be automatically set to this stencil node.
+
+- **Parameters:**
+	- `[zone]` *(string|node|nil)*: Gui node
+
+- **Returns:**
+	- `self` *(druid.button)*: The current button instance
+
+### set_key_trigger
+
+---
+```lua
+button:set_key_trigger(key)
+```
+
+Set key name to trigger this button by keyboard.
+
+- **Parameters:**
+	- `key` *(string|hash)*: The action_id of the input key. Example: "key_space"
+
+- **Returns:**
+	- `self` *(druid.button)*: The current button instance
+
+### get_key_trigger
+
+---
+```lua
+button:get_key_trigger()
+```
+
+Get current key name to trigger this button.
+
+- **Returns:**
+	- `key_trigger` *(hash)*: The action_id of the input key
+
+### set_check_function
+
+---
+```lua
+button:set_check_function([check_function], [failure_callback])
+```
+
+Set function for additional check for button click availability
+
+- **Parameters:**
+	- `[check_function]` *(function|nil)*: Should return true or false. If true - button can be pressed.
+	- `[failure_callback]` *(function|nil)*: Function will be called on button click, if check function return false
+
+- **Returns:**
+	- `self` *(druid.button)*: The current button instance
+
+### set_web_user_interaction
+
+---
+```lua
+button:set_web_user_interaction([is_web_mode])
+```
+
+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
+
+- **Parameters:**
+	- `[is_web_mode]` *(boolean|nil)*: If true - button will be called inside html5 callback
+
+- **Returns:**
+	- `self` *(druid.button)*: The current button instance
+
+
+## Fields
+<a name="on_click"></a>
+- **on_click** (_event_): function(self, custom_args, button_instance)
+
+<a name="on_pressed"></a>
+- **on_pressed** (_event_): function(self, custom_args, button_instance)
+
+<a name="on_repeated_click"></a>
+- **on_repeated_click** (_event_): function(self, custom_args, button_instance, click_count)
+
+<a name="on_long_click"></a>
+- **on_long_click** (_event_): function(self, custom_args, button_instance, hold_time)
+
+<a name="on_double_click"></a>
+- **on_double_click** (_event_): function(self, custom_args, button_instance, click_amount)
+
+<a name="on_hold_callback"></a>
+- **on_hold_callback** (_event_): function(self, custom_args, button_instance, press_time)
+
+<a name="on_click_outside"></a>
+- **on_click_outside** (_event_): function(self, custom_args, button_instance)
+
+<a name="node"></a>
+- **node** (_node_): Clickable node
+
+<a name="node_id"></a>
+- **node_id** (_hash_): Node id
+
+<a name="anim_node"></a>
+- **anim_node** (_node_): Animation node. In default case equals to clickable node
+
+<a name="params"></a>
+- **params** (_any_): Custom arguments for any Button event
+
+<a name="hover"></a>
+- **hover** (_druid.hover_): Hover component for this button
+
+<a name="click_zone"></a>
+- **click_zone** (_node_): Click zone node to restrict click area
+
+<a name="start_scale"></a>
+- **start_scale** (_vector3_): Start scale of the button
+
+<a name="start_pos"></a>
+- **start_pos** (_vector3_): Start position of the button
+
+<a name="disabled"></a>
+- **disabled** (_boolean_): Is button disabled
+
+<a name="key_trigger"></a>
+- **key_trigger** (_hash_): Key trigger for this button
+
+<a name="style"></a>
+- **style** (_table_): Style for this button
+
+<a name="druid"></a>
+- **druid** (_druid.instance_): The Druid Factory used to create components
+
+<a name="is_repeated_started"></a>
+- **is_repeated_started** (_boolean_)
+
+<a name="last_pressed_time"></a>
+- **last_pressed_time** (_integer_)
+
+<a name="last_released_time"></a>
+- **last_released_time** (_integer_)
+
+<a name="click_in_row"></a>
+- **click_in_row** (_integer_)
+
+<a name="can_action"></a>
+- **can_action** (_boolean_):  Can't interact, if touch outside of button
+

api/components/base/component_api.md

@@ -0,0 +1,445 @@
+# druid.component API
+
+> at /druid/component.lua
+
+
+## Functions
+- [create](#create)
+- [create_widget](#create_widget)
+
+- [init](#init)
+- [update](#update)
+- [on_remove](#on_remove)
+- [on_input](#on_input)
+- [on_input_interrupt](#on_input_interrupt)
+- [on_message](#on_message)
+- [on_late_init](#on_late_init)
+- [on_focus_lost](#on_focus_lost)
+- [on_focus_gained](#on_focus_gained)
+- [on_style_change](#on_style_change)
+- [on_layout_change](#on_layout_change)
+- [on_window_resized](#on_window_resized)
+- [on_language_change](#on_language_change)
+- [set_style](#set_style)
+- [set_template](#set_template)
+- [get_template](#get_template)
+- [set_nodes](#set_nodes)
+- [get_context](#get_context)
+- [get_node](#get_node)
+- [get_druid](#get_druid)
+- [get_name](#get_name)
+- [get_parent_name](#get_parent_name)
+- [get_input_priority](#get_input_priority)
+- [set_input_priority](#set_input_priority)
+- [reset_input_priority](#reset_input_priority)
+- [get_uid](#get_uid)
+- [set_input_enabled](#set_input_enabled)
+- [get_input_enabled](#get_input_enabled)
+- [get_parent_component](#get_parent_component)
+- [get_nodes](#get_nodes)
+- [get_childrens](#get_childrens)
+
+
+## Fields
+- [druid](#druid)
+
+
+
+### create
+
+---
+```lua
+component.create([name], [input_priority])
+```
+
+Сreate a new component class, which will inherit from the base Druid component.
+
+- **Parameters:**
+	- `[name]` *(string|nil)*: The name of the component
+	- `[input_priority]` *(number|nil)*: The input priority. The bigger number processed first. Default value: 10
+
+- **Returns:**
+	- `` *(druid.component)*:
+
+### create_widget
+
+---
+```lua
+component.create_widget(self, widget_class, context)
+```
+
+Create the Druid component instance
+
+- **Parameters:**
+	- `self` *(druid.instance)*: The Druid Factory used to create components
+	- `widget_class` *(druid.widget)*:
+	- `context` *(table)*:
+
+- **Returns:**
+	- `` *(druid.widget)*:
+
+### init
+
+---
+```lua
+component:init()
+```
+
+Called when component is created
+
+### update
+
+---
+```lua
+component:update()
+```
+
+Called every frame
+
+### on_remove
+
+---
+```lua
+component:on_remove()
+```
+
+Called when component is removed
+
+### on_input
+
+---
+```lua
+component:on_input()
+```
+
+Called when input event is triggered
+
+### on_input_interrupt
+
+---
+```lua
+component:on_input_interrupt()
+```
+
+Called when input event is consumed before
+
+### on_message
+
+---
+```lua
+component:on_message()
+```
+
+Called when message is received
+
+### on_late_init
+
+---
+```lua
+component:on_late_init()
+```
+
+Called before update once time after GUI init
+
+### on_focus_lost
+
+---
+```lua
+component:on_focus_lost()
+```
+
+Called when app lost focus
+
+### on_focus_gained
+
+---
+```lua
+component:on_focus_gained()
+```
+
+Called when app gained focus
+
+### on_style_change
+
+---
+```lua
+component:on_style_change()
+```
+
+Called when style is changed
+
+### on_layout_change
+
+---
+```lua
+component:on_layout_change()
+```
+
+Called when GUI layout is changed
+
+### on_window_resized
+
+---
+```lua
+component:on_window_resized()
+```
+
+Called when window is resized
+
+### on_language_change
+
+---
+```lua
+component:on_language_change()
+```
+
+Called when language is changed
+
+### set_style
+
+---
+```lua
+component:set_style([druid_style])
+```
+
+Set component style. Pass nil to clear style
+
+- **Parameters:**
+	- `[druid_style]` *(table|nil)*:
+
+- **Returns:**
+	- `self` *(<T>)*: The component itself for chaining
+
+### set_template
+
+---
+```lua
+component:set_template([template])
+```
+
+Set component template name. Pass nil to clear template.
+This template id used to access nodes inside the template on GUI scene.
+Parent template will be added automatically if exist.
+
+- **Parameters:**
+	- `[template]` *(string|nil)*:
+
+- **Returns:**
+	- `self` *(<T>)*: The component itself for chaining
+
+### get_template
+
+---
+```lua
+component:get_template()
+```
+
+Get full template name.
+
+- **Returns:**
+	- `` *(string)*:
+
+### set_nodes
+
+---
+```lua
+component:set_nodes(nodes)
+```
+
+Set current component nodes, returned from `gui.clone_tree` function.
+
+- **Parameters:**
+	- `nodes` *(table<hash, node>)*:
+
+- **Returns:**
+	- `` *(druid.component)*:
+
+### get_context
+
+---
+```lua
+component:get_context()
+```
+
+Return current component context
+
+- **Returns:**
+	- `context` *(any)*: Usually it's self of script but can be any other Druid component
+
+### get_node
+
+---
+```lua
+component:get_node(node_id)
+```
+
+Get component node by node_id. Respect to current template and nodes.
+
+- **Parameters:**
+	- `node_id` *(string|node)*:
+
+- **Returns:**
+	- `` *(node)*:
+
+### get_druid
+
+---
+```lua
+component:get_druid([template], [nodes])
+```
+
+Get Druid instance for inner component creation.
+
+- **Parameters:**
+	- `[template]` *(string|nil)*:
+	- `[nodes]` *(table<hash, node>|nil)*:
+
+- **Returns:**
+	- `` *(druid.instance)*:
+
+### get_name
+
+---
+```lua
+component:get_name()
+```
+
+Get component name
+
+- **Returns:**
+	- `name` *(string)*: The component name + uid
+
+### get_parent_name
+
+---
+```lua
+component:get_parent_name()
+```
+
+Get parent component name
+
+- **Returns:**
+	- `parent_name` *(string|nil)*: The parent component name if exist or nil
+
+### get_input_priority
+
+---
+```lua
+component:get_input_priority()
+```
+
+Get component input priority, the bigger number processed first. Default value: 10
+
+- **Returns:**
+	- `` *(number)*:
+
+### set_input_priority
+
+---
+```lua
+component:set_input_priority(value, [is_temporary])
+```
+
+Set component input priority, the bigger number processed first. Default value: 10
+
+- **Parameters:**
+	- `value` *(number)*:
+	- `[is_temporary]` *(boolean|nil)*: If true, the reset input priority will return to previous value
+
+- **Returns:**
+	- `self` *(druid.component)*: The component itself for chaining
+
+### reset_input_priority
+
+---
+```lua
+component:reset_input_priority()
+```
+
+Reset component input priority to it's default value, that was set in `create` function or `set_input_priority`
+
+- **Returns:**
+	- `self` *(druid.component)*: The component itself for chaining
+
+### get_uid
+
+---
+```lua
+component:get_uid()
+```
+
+Get component UID, unique identifier created in component creation order.
+
+- **Returns:**
+	- `uid` *(number)*: The component uid
+
+### set_input_enabled
+
+---
+```lua
+component:set_input_enabled(state)
+```
+
+Set component input state. By default it's enabled.
+If input is disabled, the component will not receive input events.
+Recursive for all children components.
+
+- **Parameters:**
+	- `state` *(boolean)*:
+
+- **Returns:**
+	- `self` *(druid.component)*: The component itself for chaining
+
+### get_input_enabled
+
+---
+```lua
+component:get_input_enabled()
+```
+
+Get component input state. By default it's enabled. Can be disabled by `set_input_enabled` function.
+
+- **Returns:**
+	- `` *(boolean)*:
+
+### get_parent_component
+
+---
+```lua
+component:get_parent_component()
+```
+
+Get parent component
+
+- **Returns:**
+	- `parent_component` *(druid.component|nil)*: The parent component if exist or nil
+
+### get_nodes
+
+---
+```lua
+component:get_nodes()
+```
+
+Get current component nodes
+
+- **Returns:**
+	- `` *(table<hash, node>|nil)*:
+
+### get_childrens
+
+---
+```lua
+component:get_childrens()
+```
+
+Return all children components, recursive
+
+- **Returns:**
+	- `Array` *(table)*: of childrens if the Druid component instance
+
+
+## Fields
+<a name="druid"></a>
+- **druid** (_druid.instance_): Druid instance to create inner components
+

api/components/base/drag_api.md

@@ -0,0 +1,176 @@
+# druid.drag API
+
+> at /druid/base/drag.lua
+
+A component that allows you to subscribe to drag events over a node
+
+
+## Functions
+- [init](#init)
+- [set_drag_cursors](#set_drag_cursors)
+- [set_click_zone](#set_click_zone)
+- [set_enabled](#set_enabled)
+- [is_enabled](#is_enabled)
+
+
+## Fields
+- [node](#node)
+- [on_touch_start](#on_touch_start)
+- [on_touch_end](#on_touch_end)
+- [on_drag_start](#on_drag_start)
+- [on_drag](#on_drag)
+- [on_drag_end](#on_drag_end)
+- [style](#style)
+- [click_zone](#click_zone)
+- [is_touch](#is_touch)
+- [is_drag](#is_drag)
+- [can_x](#can_x)
+- [can_y](#can_y)
+- [dx](#dx)
+- [dy](#dy)
+- [touch_id](#touch_id)
+- [x](#x)
+- [y](#y)
+- [screen_x](#screen_x)
+- [screen_y](#screen_y)
+- [touch_start_pos](#touch_start_pos)
+- [druid](#druid)
+- [hover](#hover)
+
+
+
+### init
+
+---
+```lua
+drag:init(node_or_node_id, [on_drag_callback])
+```
+
+The constructor for Drag component
+
+- **Parameters:**
+	- `node_or_node_id` *(string|node)*: The node to subscribe to drag events over
+	- `[on_drag_callback]` *(fun(self: any, touch: any))*: The callback to call when a drag occurs
+
+### set_drag_cursors
+
+---
+```lua
+drag:set_drag_cursors(is_enabled)
+```
+
+Set Drag component enabled state.
+
+- **Parameters:**
+	- `is_enabled` *(boolean)*: True if Drag component is enabled
+
+### set_click_zone
+
+---
+```lua
+drag:set_click_zone([node])
+```
+
+Set Drag click zone
+
+- **Parameters:**
+	- `[node]` *(string|node|nil)*: Node or node id
+
+- **Returns:**
+	- `self` *(druid.drag)*: Current instance
+
+### set_enabled
+
+---
+```lua
+drag:set_enabled(is_enabled)
+```
+
+Set Drag component enabled state.
+
+- **Parameters:**
+	- `is_enabled` *(boolean)*:
+
+- **Returns:**
+	- `self` *(druid.drag)*: Current instance
+
+### is_enabled
+
+---
+```lua
+drag:is_enabled()
+```
+
+Check if Drag component is capture input
+
+- **Returns:**
+	- `is_enabled` *(boolean)*: True if Drag component is enabled
+
+
+## Fields
+<a name="node"></a>
+- **node** (_node_): The node to subscribe to drag events over
+
+<a name="on_touch_start"></a>
+- **on_touch_start** (_event_): fun(self, touch) The event triggered when a touch starts
+
+<a name="on_touch_end"></a>
+- **on_touch_end** (_event_): fun(self, touch) The event triggered when a touch ends
+
+<a name="on_drag_start"></a>
+- **on_drag_start** (_event_): fun(self, touch) The event triggered when a drag starts
+
+<a name="on_drag"></a>
+- **on_drag** (_event_): fun(self, touch) The event triggered when a drag occurs
+
+<a name="on_drag_end"></a>
+- **on_drag_end** (_event_): fun(self, touch) The event triggered when a drag ends
+
+<a name="style"></a>
+- **style** (_druid.drag.style_): The style of Drag component
+
+<a name="click_zone"></a>
+- **click_zone** (_node_): The click zone of Drag component
+
+<a name="is_touch"></a>
+- **is_touch** (_boolean_): True if a touch is active
+
+<a name="is_drag"></a>
+- **is_drag** (_boolean_): True if a drag is active
+
+<a name="can_x"></a>
+- **can_x** (_boolean_): True if Drag can move horizontally
+
+<a name="can_y"></a>
+- **can_y** (_boolean_): True if Drag can move vertically
+
+<a name="dx"></a>
+- **dx** (_number_): The horizontal drag distance
+
+<a name="dy"></a>
+- **dy** (_number_): The vertical drag distance
+
+<a name="touch_id"></a>
+- **touch_id** (_number_): The touch id
+
+<a name="x"></a>
+- **x** (_number_): The current x position
+
+<a name="y"></a>
+- **y** (_number_): The current y position
+
+<a name="screen_x"></a>
+- **screen_x** (_number_): The current screen x position
+
+<a name="screen_y"></a>
+- **screen_y** (_number_): The current screen y position
+
+<a name="touch_start_pos"></a>
+- **touch_start_pos** (_vector3_): The touch start position
+
+<a name="druid"></a>
+- **druid** (_druid.instance_): The Druid Factory used to create components
+
+<a name="hover"></a>
+- **hover** (_druid.hover_): The component for handling hover events on a node
+

api/components/base/hover_api.md

@@ -0,0 +1,144 @@
+# druid.hover API
+
+> at /druid/base/hover.lua
+
+The component for handling hover events on a node
+
+
+## Functions
+- [init](#init)
+- [set_hover](#set_hover)
+- [is_hovered](#is_hovered)
+- [set_mouse_hover](#set_mouse_hover)
+- [is_mouse_hovered](#is_mouse_hovered)
+- [set_click_zone](#set_click_zone)
+- [set_enabled](#set_enabled)
+- [is_enabled](#is_enabled)
+
+
+## Fields
+- [node](#node)
+- [on_hover](#on_hover)
+- [on_mouse_hover](#on_mouse_hover)
+- [style](#style)
+- [click_zone](#click_zone)
+
+
+
+### init
+
+---
+```lua
+hover:init(node, on_hover_callback, on_mouse_hover)
+```
+
+The constructor for the hover component
+
+- **Parameters:**
+	- `node` *(node)*: Gui node
+	- `on_hover_callback` *(function)*: Hover callback
+	- `on_mouse_hover` *(function)*: On mouse hover callback
+
+### set_hover
+
+---
+```lua
+hover:set_hover([state])
+```
+
+Set hover state
+
+- **Parameters:**
+	- `[state]` *(boolean|nil)*: The hover state
+
+### is_hovered
+
+---
+```lua
+hover:is_hovered()
+```
+
+Return current hover state. True if touch action was on the node at current time
+
+- **Returns:**
+	- `is_hovered` *(boolean)*: The current hovered state
+
+### set_mouse_hover
+
+---
+```lua
+hover:set_mouse_hover([state])
+```
+
+Set mouse hover state
+
+- **Parameters:**
+	- `[state]` *(boolean|nil)*: The mouse hover state
+
+### is_mouse_hovered
+
+---
+```lua
+hover:is_mouse_hovered()
+```
+
+Return current hover state. True if nil action_id (usually desktop mouse) was on the node at current time
+
+- **Returns:**
+	- `The` *(boolean)*: current hovered state
+
+### set_click_zone
+
+---
+```lua
+hover:set_click_zone([zone])
+```
+
+Strict hover click area. Useful for no click events outside stencil node
+
+- **Parameters:**
+	- `[zone]` *(string|node|nil)*: Gui node
+
+### set_enabled
+
+---
+```lua
+hover:set_enabled([state])
+```
+
+Set enable state of hover component.
+If hover is not enabled, it will not generate
+any hover events
+
+- **Parameters:**
+	- `[state]` *(boolean|nil)*: The hover enabled state
+
+### is_enabled
+
+---
+```lua
+hover:is_enabled()
+```
+
+Return current hover enabled state
+
+- **Returns:**
+	- `The` *(boolean)*: hover enabled state
+
+
+## Fields
+<a name="node"></a>
+- **node** (_node_): Gui node
+
+<a name="on_hover"></a>
+- **on_hover** (_event_): fun(self: druid.hover, is_hover: boolean) Hover event
+
+<a name="on_mouse_hover"></a>
+- **on_mouse_hover** (_event_): fun(self: druid.hover, is_hover: boolean) Mouse hover event
+
+<a name="style"></a>
+- **style** (_druid.hover.style_): Style of the hover component
+
+<a name="click_zone"></a>
+- **click_zone** (_node_): Click zone of the hover component
+

api/components/base/scroll_api.md

@@ -0,0 +1,377 @@
+# druid.scroll API
+
+> at /druid/base/scroll.lua
+
+
+## Functions
+- [init](#init)
+- [scroll_to](#scroll_to)
+- [scroll_to_index](#scroll_to_index)
+- [scroll_to_percent](#scroll_to_percent)
+- [get_percent](#get_percent)
+- [set_size](#set_size)
+- [set_view_size](#set_view_size)
+- [update_view_size](#update_view_size)
+- [set_inert](#set_inert)
+- [is_inert](#is_inert)
+- [set_extra_stretch_size](#set_extra_stretch_size)
+- [get_scroll_size](#get_scroll_size)
+- [set_points](#set_points)
+- [set_horizontal_scroll](#set_horizontal_scroll)
+- [set_vertical_scroll](#set_vertical_scroll)
+- [is_node_in_view](#is_node_in_view)
+- [bind_grid](#bind_grid)
+- [set_click_zone](#set_click_zone)
+
+
+## Fields
+- [node](#node)
+- [click_zone](#click_zone)
+- [on_scroll](#on_scroll)
+- [on_scroll_to](#on_scroll_to)
+- [on_point_scroll](#on_point_scroll)
+- [view_node](#view_node)
+- [view_border](#view_border)
+- [content_node](#content_node)
+- [view_size](#view_size)
+- [position](#position)
+- [target_position](#target_position)
+- [available_pos](#available_pos)
+- [available_size](#available_size)
+- [drag](#drag)
+- [selected](#selected)
+- [is_animate](#is_animate)
+- [style](#style)
+- [druid](#druid)
+- [hover](#hover)
+- [points](#points)
+- [available_pos_extra](#available_pos_extra)
+- [available_size_extra](#available_size_extra)
+
+
+
+### init
+
+---
+```lua
+scroll:init(view_node, content_node)
+```
+
+The Scroll constructor
+
+- **Parameters:**
+	- `view_node` *(string|node)*: GUI view scroll node
+	- `content_node` *(string|node)*: GUI content scroll node
+
+### scroll_to
+
+---
+```lua
+scroll:scroll_to(point, [is_instant])
+```
+
+Start scroll to target point.
+
+- **Parameters:**
+	- `point` *(vector3)*: Target point
+	- `[is_instant]` *(boolean|nil)*: Instant scroll flag
+
+### scroll_to_index
+
+---
+```lua
+scroll:scroll_to_index(index, [skip_cb])
+```
+
+Scroll to item in scroll by point index.
+
+- **Parameters:**
+	- `index` *(number)*: Point index
+	- `[skip_cb]` *(boolean|nil)*: If true, skip the point callback
+
+### scroll_to_percent
+
+---
+```lua
+scroll:scroll_to_percent(percent, [is_instant])
+```
+
+Start scroll to target scroll percent
+
+- **Parameters:**
+	- `percent` *(vector3)*: target percent
+	- `[is_instant]` *(boolean|nil)*: instant scroll flag
+
+### get_percent
+
+---
+```lua
+scroll:get_percent()
+```
+
+Return current scroll progress status.
+ Values will be in [0..1] interval
+
+- **Returns:**
+	- `New` *(vector3)*: vector with scroll progress values
+
+### set_size
+
+---
+```lua
+scroll:set_size(size, [offset])
+```
+
+Set scroll content size.
+ It will change content gui node size
+
+- **Parameters:**
+	- `size` *(vector3)*: The new size for content node
+	- `[offset]` *(vector3|nil)*: Offset value to set, where content is starts
+
+- **Returns:**
+	- `self` *(druid.scroll)*: Current scroll instance
+
+### set_view_size
+
+---
+```lua
+scroll:set_view_size(size)
+```
+
+Set new scroll view size in case the node size was changed.
+
+- **Parameters:**
+	- `size` *(vector3)*: The new size for view node
+
+- **Returns:**
+	- `self` *(druid.scroll)*: Current scroll instance
+
+### update_view_size
+
+---
+```lua
+scroll:update_view_size()
+```
+
+Refresh scroll view size, used when view node size is changed
+
+- **Returns:**
+	- `self` *(druid.scroll)*: Current scroll instance
+
+### set_inert
+
+---
+```lua
+scroll:set_inert(state)
+```
+
+Enable or disable scroll inert
+ If disabled, scroll through points (if exist)
+ If no points, just simple drag without inertion
+
+- **Parameters:**
+	- `state` *(boolean)*: Inert scroll state
+
+- **Returns:**
+	- `self` *(druid.scroll)*: Current scroll instance
+
+### is_inert
+
+---
+```lua
+scroll:is_inert()
+```
+
+Return if scroll have inertion
+
+- **Returns:**
+	- `is_inert` *(boolean)*: If scroll have inertion
+
+### set_extra_stretch_size
+
+---
+```lua
+scroll:set_extra_stretch_size([stretch_size])
+```
+
+Set extra size for scroll stretching
+ Set 0 to disable stretching effect
+
+- **Parameters:**
+	- `[stretch_size]` *(number|nil)*: Size in pixels of additional scroll area
+
+- **Returns:**
+	- `self` *(druid.scroll)*: Current scroll instance
+
+### get_scroll_size
+
+---
+```lua
+scroll:get_scroll_size()
+```
+
+Return vector of scroll size with width and height.
+
+- **Returns:**
+	- `Available` *(vector3)*: scroll size
+
+### set_points
+
+---
+```lua
+scroll:set_points(points)
+```
+
+Set points of interest.
+ Scroll will always centered on closer points
+
+- **Parameters:**
+	- `points` *(table)*: Array of vector3 points
+
+- **Returns:**
+	- `self` *(druid.scroll)*: Current scroll instance
+
+### set_horizontal_scroll
+
+---
+```lua
+scroll:set_horizontal_scroll(state)
+```
+
+Lock or unlock horizontal scroll
+
+- **Parameters:**
+	- `state` *(boolean)*: True, if horizontal scroll is enabled
+
+- **Returns:**
+	- `self` *(druid.scroll)*: Current scroll instance
+
+### set_vertical_scroll
+
+---
+```lua
+scroll:set_vertical_scroll(state)
+```
+
+Lock or unlock vertical scroll
+
+- **Parameters:**
+	- `state` *(boolean)*: True, if vertical scroll is enabled
+
+- **Returns:**
+	- `self` *(druid.scroll)*: Current scroll instance
+
+### is_node_in_view
+
+---
+```lua
+scroll:is_node_in_view(node)
+```
+
+Check node if it visible now on scroll.
+ Extra border is not affected. Return true for elements in extra scroll zone
+
+- **Parameters:**
+	- `node` *(node)*: The node to check
+
+- **Returns:**
+	- `True` *(boolean)*: if node in visible scroll area
+
+### bind_grid
+
+---
+```lua
+scroll:bind_grid([grid])
+```
+
+Bind the grid component (Static or Dynamic) to recalculate
+ scroll size on grid changes
+
+- **Parameters:**
+	- `[grid]` *(druid.grid|nil)*: Druid grid component
+
+- **Returns:**
+	- `self` *(druid.scroll)*: Current scroll instance
+
+### set_click_zone
+
+---
+```lua
+scroll:set_click_zone(node)
+```
+
+Strict drag scroll area. Useful for
+ restrict events outside stencil node
+
+- **Parameters:**
+	- `node` *(string|node)*: Gui node
+
+
+## Fields
+<a name="node"></a>
+- **node** (_node_): The root node
+
+<a name="click_zone"></a>
+- **click_zone** (_node_): Optional click zone to restrict scroll area
+
+<a name="on_scroll"></a>
+- **on_scroll** (_event_): Triggered on scroll move with (self, position)
+
+<a name="on_scroll_to"></a>
+- **on_scroll_to** (_event_): Triggered on scroll_to with (self, target, is_instant)
+
+<a name="on_point_scroll"></a>
+- **on_point_scroll** (_event_): Triggered on scroll_to_index with (self, index, point)
+
+<a name="view_node"></a>
+- **view_node** (_node_): The scroll view node (static part)
+
+<a name="view_border"></a>
+- **view_border** (_vector4_): The scroll view borders
+
+<a name="content_node"></a>
+- **content_node** (_node_): The scroll content node (moving part)
+
+<a name="view_size"></a>
+- **view_size** (_vector3_): Size of the view node
+
+<a name="position"></a>
+- **position** (_vector3_): Current scroll position
+
+<a name="target_position"></a>
+- **target_position** (_vector3_): Target scroll position for animations
+
+<a name="available_pos"></a>
+- **available_pos** (_vector4_): Available content position (min_x, max_y, max_x, min_y)
+
+<a name="available_size"></a>
+- **available_size** (_vector3_): Size of available positions (width, height, 0)
+
+<a name="drag"></a>
+- **drag** (_druid.drag_): The drag component instance
+
+<a name="selected"></a>
+- **selected** (_number_): Current selected point of interest index
+
+<a name="is_animate"></a>
+- **is_animate** (_boolean_): True if scroll is animating
+
+<a name="style"></a>
+- **style** (_druid.scroll.style_): Component style parameters
+
+<a name="druid"></a>
+- **druid** (_druid.instance_): The Druid Factory used to create components
+
+<a name="hover"></a>
+- **hover** (_druid.hover_): The component for handling hover events on a node
+
+<a name="points"></a>
+- **points** (_table_)
+
+<a name="available_pos_extra"></a>
+- **available_pos_extra** (_unknown_)
+
+<a name="available_size_extra"></a>
+- **available_size_extra** (_vector3_)
+

api/components/base/static_grid_api.md

@@ -0,0 +1,387 @@
+# druid.grid API
+
+> at /druid/base/static_grid.lua
+
+The component for manage the nodes position in the grid with various options
+
+
+## Functions
+- [init](#init)
+- [get_pos](#get_pos)
+- [get_index](#get_index)
+- [get_index_by_node](#get_index_by_node)
+- [set_anchor](#set_anchor)
+- [refresh](#refresh)
+- [set_pivot](#set_pivot)
+- [add](#add)
+- [set_items](#set_items)
+- [remove](#remove)
+- [get_size](#get_size)
+- [get_size_for](#get_size_for)
+- [get_borders](#get_borders)
+- [get_all_pos](#get_all_pos)
+- [set_position_function](#set_position_function)
+- [clear](#clear)
+- [get_offset](#get_offset)
+- [set_in_row](#set_in_row)
+- [set_item_size](#set_item_size)
+- [sort_nodes](#sort_nodes)
+
+
+## Fields
+- [on_add_item](#on_add_item)
+- [on_remove_item](#on_remove_item)
+- [on_change_items](#on_change_items)
+- [on_clear](#on_clear)
+- [on_update_positions](#on_update_positions)
+- [parent](#parent)
+- [nodes](#nodes)
+- [first_index](#first_index)
+- [last_index](#last_index)
+- [anchor](#anchor)
+- [pivot](#pivot)
+- [node_size](#node_size)
+- [border](#border)
+- [in_row](#in_row)
+- [style](#style)
+- [node_pivot](#node_pivot)
+
+
+
+### init
+
+---
+```lua
+grid:init(parent, element, [in_row])
+```
+
+The constructor for the grid component
+
+- **Parameters:**
+	- `parent` *(string|node)*: The GUI Node container, where grid's items will be placed
+	- `element` *(node)*: Element prefab. Need to get it size
+	- `[in_row]` *(number|nil)*: How many nodes in row can be placed. By default 1
+
+### get_pos
+
+---
+```lua
+grid:get_pos(index)
+```
+
+Return pos for grid node index
+
+- **Parameters:**
+	- `index` *(number)*: The grid element index
+
+- **Returns:**
+	- `position` *(vector3)*: Node position
+
+### get_index
+
+---
+```lua
+grid:get_index(pos)
+```
+
+Return grid index by position
+
+- **Parameters:**
+	- `pos` *(vector3)*: The node position in the grid
+
+- **Returns:**
+	- `index` *(number)*: The node index
+
+### get_index_by_node
+
+---
+```lua
+grid:get_index_by_node(node)
+```
+
+Return grid index by node
+
+- **Parameters:**
+	- `node` *(node)*: The gui node in the grid
+
+- **Returns:**
+	- `index` *(number|nil)*: The node index
+
+### set_anchor
+
+---
+```lua
+grid:set_anchor(anchor)
+```
+
+Set grid anchor. Default anchor is equal to anchor of grid parent node
+
+- **Parameters:**
+	- `anchor` *(vector3)*: Anchor
+
+### refresh
+
+---
+```lua
+grid:refresh()
+```
+
+Instantly update the grid content
+
+- **Returns:**
+	- `self` *(druid.grid)*: Current grid instance
+
+### set_pivot
+
+---
+```lua
+grid:set_pivot(pivot)
+```
+
+Set grid pivot
+
+- **Parameters:**
+	- `pivot` *(constant)*: The new pivot
+
+- **Returns:**
+	- `self` *(druid.grid)*: Current grid instance
+
+### add
+
+---
+```lua
+grid:add(item, [index], [shift_policy], [is_instant])
+```
+
+Add new item to the grid
+
+- **Parameters:**
+	- `item` *(node)*: GUI node
+	- `[index]` *(number|nil)*: The item position. By default add as last item
+	- `[shift_policy]` *(number|nil)*: How shift nodes, if required. Default: const.SHIFT.RIGHT
+	- `[is_instant]` *(boolean|nil)*: If true, update node positions instantly
+
+- **Returns:**
+	- `self` *(druid.grid)*: Current grid instance
+
+### set_items
+
+---
+```lua
+grid:set_items(nodes, [is_instant])
+```
+
+Set new items to the grid. All previous items will be removed
+
+- **Parameters:**
+	- `nodes` *(node[])*: The new grid nodes
+	- `[is_instant]` *(boolean|nil)*: If true, update node positions instantly
+
+- **Returns:**
+	- `self` *(druid.grid)*: Current grid instance
+
+### remove
+
+---
+```lua
+grid:remove(index, [shift_policy], [is_instant])
+```
+
+Remove the item from the grid. Note that gui node will be not deleted
+
+- **Parameters:**
+	- `index` *(number)*: The grid node index to remove
+	- `[shift_policy]` *(number|nil)*: How shift nodes, if required. Default: const.SHIFT.RIGHT
+	- `[is_instant]` *(boolean|nil)*: If true, update node positions instantly
+
+- **Returns:**
+	- `node` *(node)*: The deleted gui node from grid
+
+### get_size
+
+---
+```lua
+grid:get_size()
+```
+
+Return grid content size
+
+- **Returns:**
+	- `size` *(vector3)*: The grid content size
+
+### get_size_for
+
+---
+```lua
+grid:get_size_for(count)
+```
+
+Return grid content size for given count of nodes
+
+- **Parameters:**
+	- `count` *(number)*: The count of nodes
+
+- **Returns:**
+	- `size` *(vector3)*: The grid content size
+
+### get_borders
+
+---
+```lua
+grid:get_borders()
+```
+
+Return grid content borders
+
+- **Returns:**
+	- `borders` *(vector4)*: The grid content borders
+
+### get_all_pos
+
+---
+```lua
+grid:get_all_pos()
+```
+
+Return array of all node positions
+
+- **Returns:**
+	- `positions` *(vector3[])*: All grid node positions
+
+### set_position_function
+
+---
+```lua
+grid:set_position_function(callback)
+```
+
+Change set position function for grid nodes. It will call on
+ update poses on grid elements. Default: gui.set_position
+
+- **Parameters:**
+	- `callback` *(function)*: Function on node set position
+
+- **Returns:**
+	- `self` *(druid.grid)*: Current grid instance
+
+### clear
+
+---
+```lua
+grid:clear()
+```
+
+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
+
+- **Returns:**
+	- `self` *(druid.grid)*: Current grid instance
+
+### get_offset
+
+---
+```lua
+grid:get_offset()
+```
+
+Return StaticGrid offset, where StaticGrid content starts.
+
+- **Returns:**
+	- `offset` *(vector3)*: The StaticGrid offset
+
+### set_in_row
+
+---
+```lua
+grid:set_in_row(in_row)
+```
+
+Set new in_row elements for grid
+
+- **Parameters:**
+	- `in_row` *(number)*: The new in_row value
+
+- **Returns:**
+	- `self` *(druid.grid)*: Current grid instance
+
+### set_item_size
+
+---
+```lua
+grid:set_item_size([width], [height])
+```
+
+Set new node size for grid
+
+- **Parameters:**
+	- `[width]` *(number|nil)*: The new node width
+	- `[height]` *(number|nil)*: The new node height
+
+- **Returns:**
+	- `self` *(druid.grid)*: Current grid instance
+
+### sort_nodes
+
+---
+```lua
+grid:sort_nodes(comparator)
+```
+
+Sort grid nodes by custom comparator function
+
+- **Parameters:**
+	- `comparator` *(function)*: The comparator function. (a, b) -> boolean
+
+- **Returns:**
+	- `self` *(druid.grid)*: Current grid instance
+
+
+## Fields
+<a name="on_add_item"></a>
+- **on_add_item** (_event_): Trigger on add item event, fun(self, item, index)
+
+<a name="on_remove_item"></a>
+- **on_remove_item** (_event_): Trigger on remove item event, fun(self, index)
+
+<a name="on_change_items"></a>
+- **on_change_items** (_event_): Trigger on change items event, fun(self, index)
+
+<a name="on_clear"></a>
+- **on_clear** (_event_): Trigger on clear event, fun(self)
+
+<a name="on_update_positions"></a>
+- **on_update_positions** (_event_): Trigger on update positions event, fun(self)
+
+<a name="parent"></a>
+- **parent** (_node_): Parent node
+
+<a name="nodes"></a>
+- **nodes** (_node[]_): Nodes array
+
+<a name="first_index"></a>
+- **first_index** (_number_): First index
+
+<a name="last_index"></a>
+- **last_index** (_number_): Last index
+
+<a name="anchor"></a>
+- **anchor** (_vector3_): Anchor
+
+<a name="pivot"></a>
+- **pivot** (_vector3_): Pivot
+
+<a name="node_size"></a>
+- **node_size** (_vector3_): Node size
+
+<a name="border"></a>
+- **border** (_vector4_): Border
+
+<a name="in_row"></a>
+- **in_row** (_number_): In row
+
+<a name="style"></a>
+- **style** (_druid.grid.style_): Style
+
+<a name="node_pivot"></a>
+- **node_pivot** (_unknown_)
+

api/components/base/text_api.md

@@ -0,0 +1,298 @@
+# druid.text API
+
+> at /druid/base/text.lua
+
+The component to handle text behaviour over a GUI Text node, mainly used to automatically adjust text size to fit the text area
+
+
+## Functions
+- [init](#init)
+- [get_text_size](#get_text_size)
+- [get_text_index_by_width](#get_text_index_by_width)
+- [set_to](#set_to)
+- [set_text](#set_text)
+- [get_text](#get_text)
+- [set_size](#set_size)
+- [set_color](#set_color)
+- [set_alpha](#set_alpha)
+- [set_scale](#set_scale)
+- [set_pivot](#set_pivot)
+- [is_multiline](#is_multiline)
+- [set_text_adjust](#set_text_adjust)
+- [set_minimal_scale](#set_minimal_scale)
+- [get_text_adjust](#get_text_adjust)
+
+
+## Fields
+- [node](#node)
+- [on_set_text](#on_set_text)
+- [on_update_text_scale](#on_update_text_scale)
+- [on_set_pivot](#on_set_pivot)
+- [style](#style)
+- [pos](#pos)
+- [node_id](#node_id)
+- [start_size](#start_size)
+- [text_area](#text_area)
+- [adjust_type](#adjust_type)
+- [color](#color)
+- [last_value](#last_value)
+- [last_scale](#last_scale)
+
+
+
+### init
+
+---
+```lua
+text:init(node, [value], [adjust_type])
+```
+
+The Text constructor
+
+- **Parameters:**
+	- `node` *(string|node)*: Node name or GUI Text Node itself
+	- `[value]` *(string|nil)*: Initial text. Default value is node text from GUI scene. Default: nil
+	- `[adjust_type]` *(string|nil)*: Adjust type for text. By default is DOWNSCALE. Look const.TEXT_ADJUST for reference. Default: DOWNSCALE
+
+### get_text_size
+
+---
+```lua
+text:get_text_size([text])
+```
+
+Calculate text width with font with respect to trailing space
+
+- **Parameters:**
+	- `[text]` *(string|nil)*: The text to calculate the size of, if nil - use current text
+
+- **Returns:**
+	- `width` *(number)*: The text width
+	- `height` *(number)*: The text height
+
+### get_text_index_by_width
+
+---
+```lua
+text:get_text_index_by_width(width)
+```
+
+Get chars count by width
+
+- **Parameters:**
+	- `width` *(number)*: The width to get the chars count of
+
+- **Returns:**
+	- `index` *(number)*: The chars count
+
+### set_to
+
+---
+```lua
+text:set_to(set_to)
+```
+
+Set text to text field
+
+- **Parameters:**
+	- `set_to` *(string)*: Text for node
+
+- **Returns:**
+	- `self` *(druid.text)*: Current text instance
+
+### set_text
+
+---
+```lua
+text:set_text([new_text])
+```
+
+- **Parameters:**
+	- `[new_text]` *(any)*:
+
+- **Returns:**
+	- `` *(druid.text)*:
+
+### get_text
+
+---
+```lua
+text:get_text()
+```
+
+- **Returns:**
+	- `` *(unknown)*:
+
+### set_size
+
+---
+```lua
+text:set_size(size)
+```
+
+Set text area size
+
+- **Parameters:**
+	- `size` *(vector3)*: The new text area size
+
+- **Returns:**
+	- `self` *(druid.text)*: Current text instance
+
+### set_color
+
+---
+```lua
+text:set_color(color)
+```
+
+Set color
+
+- **Parameters:**
+	- `color` *(vector4)*: Color for node
+
+- **Returns:**
+	- `self` *(druid.text)*: Current text instance
+
+### set_alpha
+
+---
+```lua
+text:set_alpha(alpha)
+```
+
+Set alpha
+
+- **Parameters:**
+	- `alpha` *(number)*: Alpha for node
+
+- **Returns:**
+	- `self` *(druid.text)*: Current text instance
+
+### set_scale
+
+---
+```lua
+text:set_scale(scale)
+```
+
+Set scale
+
+- **Parameters:**
+	- `scale` *(vector3)*: Scale for node
+
+- **Returns:**
+	- `self` *(druid.text)*: Current text instance
+
+### set_pivot
+
+---
+```lua
+text:set_pivot(pivot)
+```
+
+Set text pivot. Text will re-anchor inside text area
+
+- **Parameters:**
+	- `pivot` *(userdata)*: The gui.PIVOT_* constant
+
+- **Returns:**
+	- `self` *(druid.text)*: Current text instance
+
+### is_multiline
+
+---
+```lua
+text:is_multiline()
+```
+
+Return true, if text with line break
+
+- **Returns:**
+	- `Is` *(boolean)*: text node with line break
+
+### set_text_adjust
+
+---
+```lua
+text:set_text_adjust([adjust_type], [minimal_scale])
+```
+
+Set text adjust, refresh the current text visuals, if needed
+Values are: "downscale", "trim", "no_adjust", "downscale_limited",
+"scroll", "scale_then_scroll", "trim_left", "scale_then_trim", "scale_then_trim_left"
+
+- **Parameters:**
+	- `[adjust_type]` *(string|nil)*: See const.TEXT_ADJUST. If pass nil - use current adjust type
+	- `[minimal_scale]` *(number|nil)*: To remove minimal scale, use `text:set_minimal_scale(nil)`, if pass nil - not change minimal scale
+
+- **Returns:**
+	- `self` *(druid.text)*: Current text instance
+
+### set_minimal_scale
+
+---
+```lua
+text:set_minimal_scale(minimal_scale)
+```
+
+Set minimal scale for DOWNSCALE_LIMITED or SCALE_THEN_SCROLL adjust types
+
+- **Parameters:**
+	- `minimal_scale` *(number)*: If pass nil - not use minimal scale
+
+- **Returns:**
+	- `self` *(druid.text)*: Current text instance
+
+### get_text_adjust
+
+---
+```lua
+text:get_text_adjust()
+```
+
+Return current text adjust type
+
+- **Returns:**
+	- `adjust_type` *(string)*: The current text adjust type
+
+
+## Fields
+<a name="node"></a>
+- **node** (_node_): The text node
+
+<a name="on_set_text"></a>
+- **on_set_text** (_event_): The event triggered when the text is set, fun(self, text)
+
+<a name="on_update_text_scale"></a>
+- **on_update_text_scale** (_event_): The event triggered when the text scale is updated, fun(self, scale, metrics)
+
+<a name="on_set_pivot"></a>
+- **on_set_pivot** (_event_): The event triggered when the text pivot is set, fun(self, pivot)
+
+<a name="style"></a>
+- **style** (_druid.text.style_): The style of the text
+
+<a name="pos"></a>
+- **pos** (_unknown_)
+
+<a name="node_id"></a>
+- **node_id** (_unknown_)
+
+<a name="start_size"></a>
+- **start_size** (_unknown_)
+
+<a name="text_area"></a>
+- **text_area** (_unknown_)
+
+<a name="adjust_type"></a>
+- **adjust_type** (_string|nil_)
+
+<a name="color"></a>
+- **color** (_unknown_)
+
+<a name="last_value"></a>
+- **last_value** (_unknown_)
+
+<a name="last_scale"></a>
+- **last_scale** (_vector3_)
+

api/components/custom/rich_input_api.md

@@ -0,0 +1,183 @@
+# druid.rich_input API
+
+> at /druid/custom/rich_input/rich_input.lua
+
+The component that handles a rich text input field, it's a wrapper around the druid.input component
+
+
+## Functions
+- [init](#init)
+- [on_input](#on_input)
+- [set_placeholder](#set_placeholder)
+- [select](#select)
+- [set_text](#set_text)
+- [set_font](#set_font)
+- [get_text](#get_text)
+- [set_allowed_characters](#set_allowed_characters)
+
+
+## Fields
+- [root](#root)
+- [input](#input)
+- [cursor](#cursor)
+- [cursor_text](#cursor_text)
+- [cursor_position](#cursor_position)
+- [druid](#druid)
+- [is_lshift](#is_lshift)
+- [is_lctrl](#is_lctrl)
+- [is_button_input_enabled](#is_button_input_enabled)
+- [drag](#drag)
+- [placeholder](#placeholder)
+- [text_position](#text_position)
+
+
+
+### init
+
+---
+```lua
+rich_input:init(template, nodes)
+```
+
+- **Parameters:**
+	- `template` *(string)*: The template string name
+	- `nodes` *(table)*: Nodes table from gui.clone_tree
+
+### on_input
+
+---
+```lua
+rich_input:on_input([action_id], [action])
+```
+
+- **Parameters:**
+	- `[action_id]` *(any)*:
+	- `[action]` *(any)*:
+
+- **Returns:**
+	- `` *(boolean)*:
+
+### set_placeholder
+
+---
+```lua
+rich_input:set_placeholder(placeholder_text)
+```
+
+Set placeholder text
+
+- **Parameters:**
+	- `placeholder_text` *(string)*: The placeholder text
+
+- **Returns:**
+	- `self` *(druid.rich_input)*: Current instance
+
+### select
+
+---
+```lua
+rich_input:select()
+```
+
+Select input field
+
+- **Returns:**
+	- `self` *(druid.rich_input)*: Current instance
+
+### set_text
+
+---
+```lua
+rich_input:set_text(text)
+```
+
+Set input field text
+
+- **Parameters:**
+	- `text` *(string)*: The input text
+
+- **Returns:**
+	- `self` *(druid.rich_input)*: Current instance
+
+### set_font
+
+---
+```lua
+rich_input:set_font(font)
+```
+
+Set input field font
+
+- **Parameters:**
+	- `font` *(hash)*: The font hash
+
+- **Returns:**
+	- `self` *(druid.rich_input)*: Current instance
+
+### get_text
+
+---
+```lua
+rich_input:get_text()
+```
+
+Set input field text
+
+- **Returns:**
+	- `` *(string)*:
+
+### set_allowed_characters
+
+---
+```lua
+rich_input:set_allowed_characters(characters)
+```
+
+Set allowed charaters for input field.
+ See: https://defold.com/ref/stable/string/
+ ex: [%a%d] for alpha and numeric
+
+- **Parameters:**
+	- `characters` *(string)*: Regulax exp. for validate user input
+
+- **Returns:**
+	- `self` *(druid.rich_input)*: Current instance
+
+
+## Fields
+<a name="root"></a>
+- **root** (_node_): The root node of the rich input
+
+<a name="input"></a>
+- **input** (_druid.input_): The input component
+
+<a name="cursor"></a>
+- **cursor** (_node_): The cursor node
+
+<a name="cursor_text"></a>
+- **cursor_text** (_node_): The cursor text node
+
+<a name="cursor_position"></a>
+- **cursor_position** (_vector3_): The position of the cursor
+
+<a name="druid"></a>
+- **druid** (_druid.instance_): The Druid Factory used to create components
+
+<a name="is_lshift"></a>
+- **is_lshift** (_boolean_)
+
+<a name="is_lctrl"></a>
+- **is_lctrl** (_boolean_)
+
+<a name="is_button_input_enabled"></a>
+- **is_button_input_enabled** (_unknown_)
+
+<a name="drag"></a>
+- **drag** (_druid.drag_): A component that allows you to subscribe to drag events over a node
+
+<a name="placeholder"></a>
+- **placeholder** (_druid.text_): The component to handle text behaviour over a GUI Text node, mainly used to automatically adjust text size to fit the text area
+
+<a name="text_position"></a>
+- **text_position** (_unknown_)
+

api/components/custom/rich_text_api.md

@@ -0,0 +1,145 @@
+# druid.rich_text API
+
+> at /druid/custom/rich_text/rich_text.lua
+
+The component that handles a rich text display, allows to custom color, size, font, etc. of the parts of the text
+
+
+## Functions
+- [init](#init)
+- [set_text](#set_text)
+- [get_text](#get_text)
+- [clear](#clear)
+- [tagged](#tagged)
+- [get_words](#get_words)
+- [get_line_metric](#get_line_metric)
+
+
+## Fields
+- [root](#root)
+- [text_prefab](#text_prefab)
+- [style](#style)
+
+
+
+### init
+
+---
+```lua
+rich_text:init(text_node, [value])
+```
+
+- **Parameters:**
+	- `text_node` *(string|node)*: The text node to make Rich Text
+	- `[value]` *(string|nil)*: The initial text value. Default will be gui.get_text(text_node)
+
+### set_text
+
+---
+```lua
+rich_text:set_text([text])
+```
+
+Set text for Rich Text
+
+- **Parameters:**
+	- `[text]` *(string|nil)*: The text to set
+
+- **Returns:**
+	- `words` *(druid.rich_text.word[])*:
+	- `line_metrics` *(druid.rich_text.lines_metrics)*:
+
+- **Example Usage:**
+
+```lua
+rich_text:set_text("＜color=red＞Foobar＜/color＞")
+rich_text:set_text("＜color=1.0,0,0,1.0＞Foobar＜/color＞")
+rich_text:set_text("＜color=#ff0000＞Foobar＜/color＞")
+rich_text:set_text("＜color=#ff0000ff＞Foobar＜/color＞")
+rich_text:set_text("＜shadow=red＞Foobar＜/shadow＞")
+rich_text:set_text("＜shadow=1.0,0,0,1.0＞Foobar＜/shadow＞")
+rich_text:set_text("＜shadow=#ff0000＞Foobar＜/shadow＞")
+rich_text:set_text("＜shadow=#ff0000ff＞Foobar＜/shadow＞")
+rich_text:set_text("＜outline=red＞Foobar＜/outline＞")
+rich_text:set_text("＜outline=1.0,0,0,1.0＞Foobar＜/outline＞")
+rich_text:set_text("＜outline=#ff0000＞Foobar＜/outline＞")
+rich_text:set_text("＜outline=#ff0000ff＞Foobar＜/outline＞")
+rich_text:set_text("＜font=MyCoolFont＞Foobar＜/font＞")
+rich_text:set_text("＜size=2＞Twice as large＜/size＞")
+rich_text:set_text("＜br/＞Insert a line break")
+rich_text:set_text("＜nobr＞Prevent the text from breaking")
+rich_text:set_text("＜img=texture:image＞Display image")
+rich_text:set_text("＜img=texture:image,size＞Display image with size")
+rich_text:set_text("＜img=texture:image,width,height＞Display image with width and height")
+```
+### get_text
+
+---
+```lua
+rich_text:get_text()
+```
+
+Get the current text of the rich text
+
+- **Returns:**
+	- `text` *(string)*: The current text of the rich text
+
+### clear
+
+---
+```lua
+rich_text:clear()
+```
+
+Clear all created words.
+
+### tagged
+
+---
+```lua
+rich_text:tagged(tag)
+```
+
+Get all words, which has a passed tag.
+
+- **Parameters:**
+	- `tag` *(string)*: The tag to get the words for
+
+- **Returns:**
+	- `words` *(druid.rich_text.word[])*: The words with the passed tag
+
+### get_words
+
+---
+```lua
+rich_text:get_words()
+```
+
+Get all current created words, each word is a table that contains the information about the word
+
+- **Returns:**
+	- `` *(druid.rich_text.word[])*:
+
+### get_line_metric
+
+---
+```lua
+rich_text:get_line_metric()
+```
+
+Get the current line metrics
+
+- **Returns:**
+	- `lines_metrics` *(druid.rich_text.lines_metrics)*: The line metrics of the rich text
+
+
+## Fields
+<a name="root"></a>
+- **root** (_node_): The root node of the rich text
+
+<a name="text_prefab"></a>
+- **text_prefab** (_node_): The text prefab node
+
+<a name="style"></a>
+- **style** (_table_)
+

api/components/extended/container_api.md

@@ -0,0 +1,359 @@
+# druid.container API
+
+> at /druid/extended/container.lua
+
+The component used for managing the size and positions with other containers relations to create a adaptable layouts
+
+
+## Functions
+- [init](#init)
+- [refresh_origins](#refresh_origins)
+- [set_pivot](#set_pivot)
+- [set_size](#set_size)
+- [get_position](#get_position)
+- [set_position](#set_position)
+- [get_size](#get_size)
+- [get_scale](#get_scale)
+- [fit_into_size](#fit_into_size)
+- [fit_into_window](#fit_into_window)
+- [add_container](#add_container)
+- [remove_container_by_node](#remove_container_by_node)
+- [set_parent_container](#set_parent_container)
+- [refresh](#refresh)
+- [refresh_scale](#refresh_scale)
+- [update_child_containers](#update_child_containers)
+- [create_draggable_corners](#create_draggable_corners)
+- [clear_draggable_corners](#clear_draggable_corners)
+- [fit_into_node](#fit_into_node)
+- [set_min_size](#set_min_size)
+
+
+## Fields
+- [node](#node)
+- [druid](#druid)
+- [node_offset](#node_offset)
+- [origin_size](#origin_size)
+- [size](#size)
+- [origin_position](#origin_position)
+- [position](#position)
+- [pivot_offset](#pivot_offset)
+- [center_offset](#center_offset)
+- [mode](#mode)
+- [fit_size](#fit_size)
+- [min_size_x](#min_size_x)
+- [min_size_y](#min_size_y)
+- [on_size_changed](#on_size_changed)
+- [node_fill_x](#node_fill_x)
+- [node_fill_y](#node_fill_y)
+- [x_koef](#x_koef)
+- [y_koef](#y_koef)
+- [x_anchor](#x_anchor)
+- [y_anchor](#y_anchor)
+- [style](#style)
+
+
+
+### init
+
+---
+```lua
+container:init(node, mode, [callback])
+```
+
+- **Parameters:**
+	- `node` *(node)*: Gui node
+	- `mode` *(string)*: Layout mode
+	- `[callback]` *(fun(self: druid.container, size: vector3)|nil)*: Callback on size changed
+
+### refresh_origins
+
+---
+```lua
+container:refresh_origins()
+```
+
+Refresh the origins of the container, origins is the size and position of the container when it was created
+
+### set_pivot
+
+---
+```lua
+container:set_pivot(pivot)
+```
+
+Set the pivot of the container
+
+- **Parameters:**
+	- `pivot` *(constant)*: The pivot to set
+
+### set_size
+
+---
+```lua
+container:set_size([width], [height], [anchor_pivot])
+```
+
+Set new size of layout node
+
+- **Parameters:**
+	- `[width]` *(number|nil)*: The width to set
+	- `[height]` *(number|nil)*: The height to set
+	- `[anchor_pivot]` *(constant|nil)*: If set will keep the corner possition relative to the new size
+
+- **Returns:**
+	- `Container` *(druid.container)*:
+
+### get_position
+
+---
+```lua
+container:get_position()
+```
+
+Get the position of the container
+
+- **Returns:**
+	- `position` *(vector3)*: The position of the container
+
+### set_position
+
+---
+```lua
+container:set_position(pos_x, pos_y)
+```
+
+Set the position of the container
+
+- **Parameters:**
+	- `pos_x` *(number)*: The x position to set
+	- `pos_y` *(number)*: The y position to set
+
+### get_size
+
+---
+```lua
+container:get_size()
+```
+
+Get the current size of the layout node
+
+- **Returns:**
+	- `size` *(vector3)*: The current size of the layout node
+
+### get_scale
+
+---
+```lua
+container:get_scale()
+```
+
+Get the current scale of the layout node
+
+- **Returns:**
+	- `scale` *(vector3)*: The current scale of the layout node
+
+### fit_into_size
+
+---
+```lua
+container:fit_into_size(target_size)
+```
+
+Set size for layout node to fit inside it
+
+- **Parameters:**
+	- `target_size` *(vector3)*: The target size to fit into
+
+- **Returns:**
+	- `self` *(druid.container)*: Current container instance
+
+### fit_into_window
+
+---
+```lua
+container:fit_into_window()
+```
+
+Set current size for layout node to fit inside it
+
+- **Returns:**
+	- `self` *(druid.container)*: Current container instance
+
+### add_container
+
+---
+```lua
+container:add_container(node_or_container, [mode], [on_resize_callback])
+```
+
+- **Parameters:**
+	- `node_or_container` *(string|table|druid.container|node)*: The component used for managing the size and positions with other containers relations to create a adaptable layouts
+	- `[mode]` *(string|nil)*: stretch, fit, stretch_x, stretch_y. Default: Pick from node, "fit" or "stretch"
+	- `[on_resize_callback]` *(fun(self: userdata, size: vector3)|nil)*:
+
+- **Returns:**
+	- `Container` *(druid.container)*: New created layout instance
+
+### remove_container_by_node
+
+---
+```lua
+container:remove_container_by_node([node])
+```
+
+- **Parameters:**
+	- `[node]` *(any)*:
+
+- **Returns:**
+	- `` *(druid.container|nil)*:
+
+### set_parent_container
+
+---
+```lua
+container:set_parent_container([parent_container])
+```
+
+- **Parameters:**
+	- `[parent_container]` *(druid.container|nil)*: The component used for managing the size and positions with other containers relations to create a adaptable layouts
+
+### refresh
+
+---
+```lua
+container:refresh()
+```
+
+ Glossary
+ Center Offset - vector from node position to visual center of node
+
+### refresh_scale
+
+---
+```lua
+container:refresh_scale()
+```
+
+### update_child_containers
+
+---
+```lua
+container:update_child_containers()
+```
+
+### create_draggable_corners
+
+---
+```lua
+container:create_draggable_corners()
+```
+
+- **Returns:**
+	- `self` *(druid.container)*: Current container instance
+
+### clear_draggable_corners
+
+---
+```lua
+container:clear_draggable_corners()
+```
+
+- **Returns:**
+	- `self` *(druid.container)*: Current container instance
+
+### fit_into_node
+
+---
+```lua
+container:fit_into_node(node)
+```
+
+Set node for layout node to fit inside it. Pass nil to reset
+
+- **Parameters:**
+	- `node` *(string|node)*: The node_id or gui.get_node(node_id)
+
+- **Returns:**
+	- `self` *(druid.container)*: Current container instance
+
+### set_min_size
+
+---
+```lua
+container:set_min_size([min_size_x], [min_size_y])
+```
+
+Set the minimum size of the container
+
+- **Parameters:**
+	- `[min_size_x]` *(number|nil)*: The minimum size x
+	- `[min_size_y]` *(number|nil)*: The minimum size y
+
+- **Returns:**
+	- `self` *(druid.container)*: Current container instance
+
+
+## Fields
+<a name="node"></a>
+- **node** (_node_): The gui node
+
+<a name="druid"></a>
+- **druid** (_druid.instance_): The druid instance
+
+<a name="node_offset"></a>
+- **node_offset** (_vector4_): The node offset
+
+<a name="origin_size"></a>
+- **origin_size** (_vector3_): The origin size
+
+<a name="size"></a>
+- **size** (_vector3_): The current size
+
+<a name="origin_position"></a>
+- **origin_position** (_vector3_): The origin position
+
+<a name="position"></a>
+- **position** (_vector3_): The current position
+
+<a name="pivot_offset"></a>
+- **pivot_offset** (_vector3_): The pivot offset
+
+<a name="center_offset"></a>
+- **center_offset** (_vector3_): The center offset
+
+<a name="mode"></a>
+- **mode** (_string_): The layout mode
+
+<a name="fit_size"></a>
+- **fit_size** (_vector3_): The fit size
+
+<a name="min_size_x"></a>
+- **min_size_x** (_number_): The minimum size x
+
+<a name="min_size_y"></a>
+- **min_size_y** (_number_): The minimum size y
+
+<a name="on_size_changed"></a>
+- **on_size_changed** (_event_): fun(self: druid.container, size: vector3) The event triggered when the size changes
+
+<a name="node_fill_x"></a>
+- **node_fill_x** (_nil_)
+
+<a name="node_fill_y"></a>
+- **node_fill_y** (_nil_)
+
+<a name="x_koef"></a>
+- **x_koef** (_number_)
+
+<a name="y_koef"></a>
+- **y_koef** (_number_)
+
+<a name="x_anchor"></a>
+- **x_anchor** (_unknown_)
+
+<a name="y_anchor"></a>
+- **y_anchor** (_unknown_)
+
+<a name="style"></a>
+- **style** (_table_)
+

api/components/extended/data_list_api.md

@@ -0,0 +1,236 @@
+# druid.data_list API
+
+> at /druid/extended/data_list.lua
+
+The component used for managing a list of data with a scrollable view, used to manage huge list data and render only visible elements
+
+
+## Functions
+- [init](#init)
+- [on_remove](#on_remove)
+- [set_use_cache](#set_use_cache)
+- [set_data](#set_data)
+- [get_data](#get_data)
+- [add](#add)
+- [remove](#remove)
+- [remove_by_data](#remove_by_data)
+- [clear](#clear)
+- [get_index](#get_index)
+- [get_created_nodes](#get_created_nodes)
+- [get_created_components](#get_created_components)
+- [scroll_to_index](#scroll_to_index)
+
+
+## Fields
+- [scroll](#scroll)
+- [grid](#grid)
+- [on_scroll_progress_change](#on_scroll_progress_change)
+- [on_element_add](#on_element_add)
+- [on_element_remove](#on_element_remove)
+- [top_index](#top_index)
+- [last_index](#last_index)
+- [scroll_progress](#scroll_progress)
+
+
+
+### init
+
+---
+```lua
+data_list:init(scroll, grid, create_function)
+```
+
+- **Parameters:**
+	- `scroll` *(druid.scroll)*: The Scroll instance for Data List component
+	- `grid` *(druid.grid)*: The StaticGrid instance for Data List component
+	- `create_function` *(function)*: The create function callback(self, data, index, data_list). Function should return (node, [component])
+
+### on_remove
+
+---
+```lua
+data_list:on_remove()
+```
+
+Druid System on_remove function
+
+### set_use_cache
+
+---
+```lua
+data_list:set_use_cache(is_use_cache)
+```
+
+Set use cache version of DataList. Requires make setup of components in on_element_add callback and clean in on_element_remove
+
+- **Parameters:**
+	- `is_use_cache` *(boolean)*: Use cache version of DataList
+
+- **Returns:**
+	- `self` *(druid.data_list)*: Current DataList instance
+
+### set_data
+
+---
+```lua
+data_list:set_data(data)
+```
+
+Set new data set for DataList component
+
+- **Parameters:**
+	- `data` *(table)*: The new data array
+
+- **Returns:**
+	- `self` *(druid.data_list)*: Current DataList instance
+
+### get_data
+
+---
+```lua
+data_list:get_data()
+```
+
+Return current data from DataList component
+
+- **Returns:**
+	- `data` *(table)*: The current data array
+
+### add
+
+---
+```lua
+data_list:add(data, [index], [shift_policy])
+```
+
+Add element to DataList
+
+- **Parameters:**
+	- `data` *(table)*: The data to add
+	- `[index]` *(number|nil)*: The index to add the data at
+	- `[shift_policy]` *(number|nil)*: The constant from const.SHIFT.*
+
+- **Returns:**
+	- `self` *(druid.data_list)*: Current DataList instance
+
+### remove
+
+---
+```lua
+data_list:remove([index], [shift_policy])
+```
+
+Remove element from DataList
+
+- **Parameters:**
+	- `[index]` *(number|nil)*: The index to remove the data at
+	- `[shift_policy]` *(number|nil)*: The constant from const.SHIFT.*
+
+- **Returns:**
+	- `self` *(druid.data_list)*: Current DataList instance
+
+### remove_by_data
+
+---
+```lua
+data_list:remove_by_data(data, [shift_policy])
+```
+
+Remove element from DataList by data value
+
+- **Parameters:**
+	- `data` *(table)*: The data to remove
+	- `[shift_policy]` *(number|nil)*: The constant from const.SHIFT.*
+
+- **Returns:**
+	- `self` *(druid.data_list)*: Current DataList instance
+
+### clear
+
+---
+```lua
+data_list:clear()
+```
+
+Clear the DataList and refresh visuals
+
+- **Returns:**
+	- `self` *(druid.data_list)*: Current DataList instance
+
+### get_index
+
+---
+```lua
+data_list:get_index(data)
+```
+
+Return index for data value
+
+- **Parameters:**
+	- `data` *(table)*:
+
+- **Returns:**
+	- `` *(unknown|nil)*:
+
+### get_created_nodes
+
+---
+```lua
+data_list:get_created_nodes()
+```
+
+Return all currenly created nodes in DataList
+
+- **Returns:**
+	- `List` *(node[])*: of created nodes
+
+### get_created_components
+
+---
+```lua
+data_list:get_created_components()
+```
+
+Return all currenly created components in DataList
+
+- **Returns:**
+	- `components` *(druid.component[])*: List of created components
+
+### scroll_to_index
+
+---
+```lua
+data_list:scroll_to_index(index)
+```
+
+Instant scroll to element with passed index
+
+- **Parameters:**
+	- `index` *(number)*: The index to scroll to
+
+
+## Fields
+<a name="scroll"></a>
+- **scroll** (_druid.scroll_): The scroll instance for Data List component
+
+<a name="grid"></a>
+- **grid** (_druid.grid_): The StaticGrid or DynamicGrid instance for Data List component
+
+<a name="on_scroll_progress_change"></a>
+- **on_scroll_progress_change** (_event_): The event triggered when the scroll progress changes
+
+<a name="on_element_add"></a>
+- **on_element_add** (_event_): The event triggered when a new element is added
+
+<a name="on_element_remove"></a>
+- **on_element_remove** (_event_): The event triggered when an element is removed
+
+<a name="top_index"></a>
+- **top_index** (_number_): The top index of the visible elements
+
+<a name="last_index"></a>
+- **last_index** (_number_): The last index of the visible elements
+
+<a name="scroll_progress"></a>
+- **scroll_progress** (_number_): The scroll progress
+

api/components/extended/hotkey_api.md

@@ -0,0 +1,125 @@
+# druid.hotkey API
+
+> at /druid/extended/hotkey.lua
+
+The component used for managing hotkeys and trigger callbacks when hotkeys are pressed
+
+
+## Functions
+- [init](#init)
+- [on_style_change](#on_style_change)
+- [add_hotkey](#add_hotkey)
+- [is_processing](#is_processing)
+- [on_focus_gained](#on_focus_gained)
+- [on_input](#on_input)
+- [set_repeat](#set_repeat)
+
+
+## Fields
+- [on_hotkey_pressed](#on_hotkey_pressed)
+- [on_hotkey_released](#on_hotkey_released)
+- [style](#style)
+- [druid](#druid)
+
+
+
+### init
+
+---
+```lua
+hotkey:init(keys, callback, [callback_argument])
+```
+
+The Hotkey constructor
+
+- **Parameters:**
+	- `keys` *(string|string[])*: The keys to be pressed for trigger callback. Should contains one key and any modificator keys
+	- `callback` *(function)*: The callback function
+	- `[callback_argument]` *(any)*: The argument to pass into the callback function
+
+### on_style_change
+
+---
+```lua
+hotkey:on_style_change(style)
+```
+
+- **Parameters:**
+	- `style` *(druid.hotkey.style)*:
+
+### add_hotkey
+
+---
+```lua
+hotkey:add_hotkey(keys, [callback_argument])
+```
+
+Add hotkey for component callback
+
+- **Parameters:**
+	- `keys` *(string|hash|hash[]|string[])*: that have to be pressed before key pressed to activate
+	- `[callback_argument]` *(any)*: The argument to pass into the callback function
+
+- **Returns:**
+	- `self` *(druid.hotkey)*: Current instance
+
+### is_processing
+
+---
+```lua
+hotkey:is_processing()
+```
+
+- **Returns:**
+	- `` *(boolean)*:
+
+### on_focus_gained
+
+---
+```lua
+hotkey:on_focus_gained()
+```
+
+### on_input
+
+---
+```lua
+hotkey:on_input([action_id], action)
+```
+
+- **Parameters:**
+	- `[action_id]` *(hash|nil)*: The action id
+	- `action` *(action)*: The action
+
+- **Returns:**
+	- `is_consume` *(boolean)*: True if the action is consumed
+
+### set_repeat
+
+---
+```lua
+hotkey:set_repeat(is_enabled_repeated)
+```
+
+If true, the callback will be triggered on action.repeated
+
+- **Parameters:**
+	- `is_enabled_repeated` *(boolean)*: The flag value
+
+- **Returns:**
+	- `self` *(druid.hotkey)*: Current instance
+
+
+## Fields
+<a name="on_hotkey_pressed"></a>
+- **on_hotkey_pressed** (_event_): fun(self, context, callback_argument) The event triggered when a hotkey is pressed
+
+<a name="on_hotkey_released"></a>
+- **on_hotkey_released** (_event_): fun(self, context, callback_argument) The event triggered when a hotkey is released
+
+<a name="style"></a>
+- **style** (_druid.hotkey.style_): The style of the hotkey component
+
+<a name="druid"></a>
+- **druid** (_druid.instance_): The Druid Factory used to create components
+

api/components/extended/input_api.md

@@ -0,0 +1,314 @@
+# druid.input API
+
+> at /druid/extended/input.lua
+
+The component used for managing input fields in basic way
+
+
+## Functions
+- [init](#init)
+- [on_focus_lost](#on_focus_lost)
+- [on_input_interrupt](#on_input_interrupt)
+- [get_text_selected](#get_text_selected)
+- [get_text_selected_replaced](#get_text_selected_replaced)
+- [set_text](#set_text)
+- [select](#select)
+- [unselect](#unselect)
+- [get_text](#get_text)
+- [set_max_length](#set_max_length)
+- [set_allowed_characters](#set_allowed_characters)
+- [reset_changes](#reset_changes)
+- [select_cursor](#select_cursor)
+- [move_selection](#move_selection)
+
+
+## Fields
+- [on_input_select](#on_input_select)
+- [on_input_unselect](#on_input_unselect)
+- [on_input_text](#on_input_text)
+- [on_input_empty](#on_input_empty)
+- [on_input_full](#on_input_full)
+- [on_input_wrong](#on_input_wrong)
+- [on_select_cursor_change](#on_select_cursor_change)
+- [style](#style)
+- [text](#text)
+- [ALLOWED_ACTIONS](#ALLOWED_ACTIONS)
+- [druid](#druid)
+- [is_selected](#is_selected)
+- [value](#value)
+- [previous_value](#previous_value)
+- [current_value](#current_value)
+- [marked_value](#marked_value)
+- [is_empty](#is_empty)
+- [text_width](#text_width)
+- [market_text_width](#market_text_width)
+- [total_width](#total_width)
+- [cursor_index](#cursor_index)
+- [start_index](#start_index)
+- [end_index](#end_index)
+- [max_length](#max_length)
+- [allowed_characters](#allowed_characters)
+- [keyboard_type](#keyboard_type)
+- [button](#button)
+- [marked_text_width](#marked_text_width)
+
+
+
+### init
+
+---
+```lua
+input:init(click_node, text_node, [keyboard_type])
+```
+
+- **Parameters:**
+	- `click_node` *(node)*: Node to enabled input component
+	- `text_node` *(druid.text|node)*: Text node what will be changed on user input. You can pass text component instead of text node name Text
+	- `[keyboard_type]` *(number|nil)*: Gui keyboard type for input field
+
+### on_focus_lost
+
+---
+```lua
+input:on_focus_lost()
+```
+
+### on_input_interrupt
+
+---
+```lua
+input:on_input_interrupt()
+```
+
+### get_text_selected
+
+---
+```lua
+input:get_text_selected()
+```
+
+- **Returns:**
+	- `` *(string|unknown)*:
+
+### get_text_selected_replaced
+
+---
+```lua
+input:get_text_selected_replaced(text)
+```
+
+Replace selected text with new text
+
+- **Parameters:**
+	- `text` *(string)*: The text to replace selected text
+
+- **Returns:**
+	- `new_text` *(string)*: New input text
+
+### set_text
+
+---
+```lua
+input:set_text(input_text)
+```
+
+Set text for input field
+
+- **Parameters:**
+	- `input_text` *(string)*: The string to apply for input field
+
+### select
+
+---
+```lua
+input:select()
+```
+
+Select input field. It will show the keyboard and trigger on_select events
+
+### unselect
+
+---
+```lua
+input:unselect()
+```
+
+Remove selection from input. It will hide the keyboard and trigger on_unselect events
+
+### get_text
+
+---
+```lua
+input:get_text()
+```
+
+Return current input field text
+
+- **Returns:**
+	- `text` *(string)*: The current input field text
+
+### set_max_length
+
+---
+```lua
+input:set_max_length(max_length)
+```
+
+Set maximum length for input field.
+ Pass nil to make input field unliminted (by default)
+
+- **Parameters:**
+	- `max_length` *(number)*: Maximum length for input text field
+
+- **Returns:**
+	- `self` *(druid.input)*: Current input instance
+
+### set_allowed_characters
+
+---
+```lua
+input:set_allowed_characters(characters)
+```
+
+Set allowed charaters for input field.
+ See: https://defold.com/ref/stable/string/
+ ex: [%a%d] for alpha and numeric
+
+- **Parameters:**
+	- `characters` *(string)*: Regulax exp. for validate user input
+
+- **Returns:**
+	- `self` *(druid.input)*: Current input instance
+
+### reset_changes
+
+---
+```lua
+input:reset_changes()
+```
+
+Reset current input selection and return previous value
+
+- **Returns:**
+	- `self` *(druid.input)*: Current input instance
+
+### select_cursor
+
+---
+```lua
+input:select_cursor([cursor_index], [start_index], [end_index])
+```
+
+Set cursor position in input field
+
+- **Parameters:**
+	- `[cursor_index]` *(number|nil)*: Cursor index for cursor position, if nil - will be set to the end of the text
+	- `[start_index]` *(number|nil)*: Start index for cursor position, if nil - will be set to the end of the text
+	- `[end_index]` *(number|nil)*: End index for cursor position, if nil - will be set to the start_index
+
+- **Returns:**
+	- `self` *(druid.input)*: Current input instance
+
+### move_selection
+
+---
+```lua
+input:move_selection(delta, is_add_to_selection, is_move_to_end)
+```
+
+Change cursor position by delta
+
+- **Parameters:**
+	- `delta` *(number)*: side for cursor position, -1 for left, 1 for right
+	- `is_add_to_selection` *(boolean)*: (Shift key)
+	- `is_move_to_end` *(boolean)*: (Ctrl key)
+
+- **Returns:**
+	- `self` *(druid.input)*: Current input instance
+
+
+## Fields
+<a name="on_input_select"></a>
+- **on_input_select** (_event_): fun(self: druid.input, input: druid.input) The event triggered when the input field is selected
+
+<a name="on_input_unselect"></a>
+- **on_input_unselect** (_event_): fun(self: druid.input, text: string, input: druid.input) The event triggered when the input field is unselected
+
+<a name="on_input_text"></a>
+- **on_input_text** (_event_): fun(self: druid.input) The event triggered when the input field is changed
+
+<a name="on_input_empty"></a>
+- **on_input_empty** (_event_): fun(self: druid.input) The event triggered when the input field is empty
+
+<a name="on_input_full"></a>
+- **on_input_full** (_event_): fun(self: druid.input) The event triggered when the input field is full
+
+<a name="on_input_wrong"></a>
+- **on_input_wrong** (_event_): fun(self: druid.input) The event triggered when the input field is wrong
+
+<a name="on_select_cursor_change"></a>
+- **on_select_cursor_change** (_event_): fun(self: druid.input, cursor_index: number, start_index: number, end_index: number) The event triggered when the cursor index is changed
+
+<a name="style"></a>
+- **style** (_druid.input.style_): The style of the input component
+
+<a name="text"></a>
+- **text** (_druid.text_): The text component
+
+<a name="ALLOWED_ACTIONS"></a>
+- **ALLOWED_ACTIONS** (_table_)
+
+<a name="druid"></a>
+- **druid** (_druid.instance_): The Druid Factory used to create components
+
+<a name="is_selected"></a>
+- **is_selected** (_boolean_)
+
+<a name="value"></a>
+- **value** (_unknown_)
+
+<a name="previous_value"></a>
+- **previous_value** (_unknown_)
+
+<a name="current_value"></a>
+- **current_value** (_unknown_)
+
+<a name="marked_value"></a>
+- **marked_value** (_string_)
+
+<a name="is_empty"></a>
+- **is_empty** (_boolean_)
+
+<a name="text_width"></a>
+- **text_width** (_integer_)
+
+<a name="market_text_width"></a>
+- **market_text_width** (_integer_)
+
+<a name="total_width"></a>
+- **total_width** (_integer_)
+
+<a name="cursor_index"></a>
+- **cursor_index** (_integer_)
+
+<a name="start_index"></a>
+- **start_index** (_number_)
+
+<a name="end_index"></a>
+- **end_index** (_number_)
+
+<a name="max_length"></a>
+- **max_length** (_nil_)
+
+<a name="allowed_characters"></a>
+- **allowed_characters** (_nil_)
+
+<a name="keyboard_type"></a>
+- **keyboard_type** (_number_)
+
+<a name="button"></a>
+- **button** (_druid.button_): Druid component to make clickable node with various interaction callbacks
+
+<a name="marked_text_width"></a>
+- **marked_text_width** (_number_)
+

api/components/extended/lang_text_api.md

@@ -0,0 +1,121 @@
+# druid.lang_text API
+
+> at /druid/extended/lang_text.lua
+
+The component used for displaying localized text, can automatically update text when locale is changed
+
+
+## Functions
+- [init](#init)
+- [on_language_change](#on_language_change)
+- [set_to](#set_to)
+- [set_text](#set_text)
+- [translate](#translate)
+- [format](#format)
+
+
+## Fields
+- [text](#text)
+- [node](#node)
+- [on_change](#on_change)
+- [druid](#druid)
+
+
+
+### init
+
+---
+```lua
+lang_text:init(node, [locale_id], [adjust_type])
+```
+
+- **Parameters:**
+	- `node` *(string|node)*: The node_id or gui.get_node(node_id)
+	- `[locale_id]` *(string|nil)*: Default locale id or text from node as default
+	- `[adjust_type]` *(string|nil)*: Adjust type for text. By default is DOWNSCALE. Look const.TEXT_ADJUST for reference
+
+- **Returns:**
+	- `` *(druid.lang_text)*:
+
+### on_language_change
+
+---
+```lua
+lang_text:on_language_change()
+```
+
+### set_to
+
+---
+```lua
+lang_text:set_to(text)
+```
+
+Setup raw text to lang_text component
+
+- **Parameters:**
+	- `text` *(string)*: Text for text node
+
+- **Returns:**
+	- `self` *(druid.lang_text)*: Current instance
+
+### set_text
+
+---
+```lua
+lang_text:set_text(text)
+```
+
+Setup raw text to lang_text component
+
+- **Parameters:**
+	- `text` *(string)*: Text for text node
+
+- **Returns:**
+	- `self` *(druid.lang_text)*: Current instance
+
+### translate
+
+---
+```lua
+lang_text:translate(locale_id, ...)
+```
+
+Translate the text by locale_id
+
+- **Parameters:**
+	- `locale_id` *(string)*: Locale id
+	- `...` *(...)*: vararg
+
+- **Returns:**
+	- `self` *(druid.lang_text)*: Current instance
+
+### format
+
+---
+```lua
+lang_text:format(...)
+```
+
+Format string with new text params on localized text
+
+- **Parameters:**
+	- `...` *(...)*: vararg
+
+- **Returns:**
+	- `self` *(druid.lang_text)*: Current instance
+
+
+## Fields
+<a name="text"></a>
+- **text** (_druid.text_): The text component
+
+<a name="node"></a>
+- **node** (_node_): The node of the text component
+
+<a name="on_change"></a>
+- **on_change** (_event_): The event triggered when the text is changed
+
+<a name="druid"></a>
+- **druid** (_druid.instance_): The Druid Factory used to create components
+

api/components/extended/layout_api.md

@@ -0,0 +1,326 @@
+# druid.layout API
+
+> at /druid/extended/layout.lua
+
+The component used for managing the layout of nodes, placing them inside the node size with respect to the size and pivot of each node
+
+
+## Functions
+- [init](#init)
+- [update](#update)
+- [get_entities](#get_entities)
+- [set_node_index](#set_node_index)
+- [set_margin](#set_margin)
+- [set_padding](#set_padding)
+- [set_dirty](#set_dirty)
+- [set_justify](#set_justify)
+- [set_type](#set_type)
+- [set_hug_content](#set_hug_content)
+- [add](#add)
+- [remove](#remove)
+- [get_size](#get_size)
+- [get_content_size](#get_content_size)
+- [refresh_layout](#refresh_layout)
+- [clear_layout](#clear_layout)
+- [get_node_size](#get_node_size)
+- [calculate_rows_data](#calculate_rows_data)
+- [set_node_position](#set_node_position)
+
+
+## Fields
+- [node](#node)
+- [rows_data](#rows_data)
+- [is_dirty](#is_dirty)
+- [entities](#entities)
+- [margin](#margin)
+- [padding](#padding)
+- [type](#type)
+- [is_resize_width](#is_resize_width)
+- [is_resize_height](#is_resize_height)
+- [is_justify](#is_justify)
+- [on_size_changed](#on_size_changed)
+- [size](#size)
+
+
+
+### init
+
+---
+```lua
+layout:init(node_or_node_id, layout_type)
+```
+
+```lua
+layout_type:
+    | "horizontal"
+    | "vertical"
+    | "horizontal_wrap"
+```
+
+- **Parameters:**
+	- `node_or_node_id` *(string|node)*:
+	- `layout_type` *("horizontal"|"horizontal_wrap"|"vertical")*:
+
+### update
+
+---
+```lua
+layout:update()
+```
+
+### get_entities
+
+---
+```lua
+layout:get_entities()
+```
+
+- **Returns:**
+	- `entities` *(node[])*: The entities to manage the layout of
+
+### set_node_index
+
+---
+```lua
+layout:set_node_index(node, index)
+```
+
+- **Parameters:**
+	- `node` *(node)*: The node to set the index of
+	- `index` *(number)*: The index to set the node to
+
+- **Returns:**
+	- `self` *(druid.layout)*: for chaining
+
+### set_margin
+
+---
+```lua
+layout:set_margin([margin_x], [margin_y])
+```
+
+Set the margin of the layout
+
+- **Parameters:**
+	- `[margin_x]` *(number|nil)*: The margin x
+	- `[margin_y]` *(number|nil)*: The margin y
+
+- **Returns:**
+	- `self` *(druid.layout)*: Current layout instance
+
+### set_padding
+
+---
+```lua
+layout:set_padding([padding_x], [padding_y], [padding_z], [padding_w])
+```
+
+- **Parameters:**
+	- `[padding_x]` *(number|nil)*: The padding x
+	- `[padding_y]` *(number|nil)*: The padding y
+	- `[padding_z]` *(number|nil)*: The padding z
+	- `[padding_w]` *(number|nil)*: The padding w
+
+- **Returns:**
+	- `self` *(druid.layout)*: Current layout instance
+
+### set_dirty
+
+---
+```lua
+layout:set_dirty()
+```
+
+- **Returns:**
+	- `self` *(druid.layout)*: Current layout instance
+
+### set_justify
+
+---
+```lua
+layout:set_justify(is_justify)
+```
+
+- **Parameters:**
+	- `is_justify` *(boolean)*:
+
+- **Returns:**
+	- `self` *(druid.layout)*: Current layout instance
+
+### set_type
+
+---
+```lua
+layout:set_type(type)
+```
+
+- **Parameters:**
+	- `type` *(string)*: The layout type: "horizontal", "vertical", "horizontal_wrap"
+
+- **Returns:**
+	- `self` *(druid.layout)*: Current layout instance
+
+### set_hug_content
+
+---
+```lua
+layout:set_hug_content(is_hug_width, is_hug_height)
+```
+
+- **Parameters:**
+	- `is_hug_width` *(boolean)*:
+	- `is_hug_height` *(boolean)*:
+
+- **Returns:**
+	- `self` *(druid.layout)*: Current layout instance
+
+### add
+
+---
+```lua
+layout:add(node_or_node_id)
+```
+
+Add node to layout
+
+- **Parameters:**
+	- `node_or_node_id` *(string|node)*: node_or_node_id
+
+- **Returns:**
+	- `self` *(druid.layout)*: Current layout instance
+
+### remove
+
+---
+```lua
+layout:remove(node_or_node_id)
+```
+
+Remove node from layout
+
+- **Parameters:**
+	- `node_or_node_id` *(string|node)*: node_or_node_id
+
+- **Returns:**
+	- `self` *(druid.layout)*: for chaining
+
+### get_size
+
+---
+```lua
+layout:get_size()
+```
+
+- **Returns:**
+	- `` *(vector3)*:
+
+### get_content_size
+
+---
+```lua
+layout:get_content_size()
+```
+
+- **Returns:**
+	- `` *(number)*:
+	- `` *(number)*:
+
+### refresh_layout
+
+---
+```lua
+layout:refresh_layout()
+```
+
+- **Returns:**
+	- `self` *(druid.layout)*: Current layout instance
+
+### clear_layout
+
+---
+```lua
+layout:clear_layout()
+```
+
+- **Returns:**
+	- `self` *(druid.layout)*: Current layout instance
+
+### get_node_size
+
+---
+```lua
+layout:get_node_size(node)
+```
+
+- **Parameters:**
+	- `node` *(node)*:
+
+- **Returns:**
+	- `width` *(number)*: The width of the node
+	- `height` *(number)*: The height of the node
+
+### calculate_rows_data
+
+---
+```lua
+layout:calculate_rows_data()
+```
+
+Calculate rows data for layout. Contains total width, height and rows info (width, height, count of elements in row)
+
+- **Returns:**
+	- `` *(druid.layout.rows_data)*:
+
+### set_node_position
+
+---
+```lua
+layout:set_node_position(node, x, y)
+```
+
+- **Parameters:**
+	- `node` *(node)*:
+	- `x` *(number)*:
+	- `y` *(number)*:
+
+- **Returns:**
+	- `` *(node)*:
+
+
+## Fields
+<a name="node"></a>
+- **node** (_node_): The node to manage the layout of
+
+<a name="rows_data"></a>
+- **rows_data** (_druid.layout.rows_data_): Last calculated rows data
+
+<a name="is_dirty"></a>
+- **is_dirty** (_boolean_)
+
+<a name="entities"></a>
+- **entities** (_node[]_): The entities to manage the layout of
+
+<a name="margin"></a>
+- **margin** (_{ x: number, y: number }_): The margin of the layout
+
+<a name="padding"></a>
+- **padding** (_vector4_): The padding of the layout
+
+<a name="type"></a>
+- **type** (_string_): The type of the layout
+
+<a name="is_resize_width"></a>
+- **is_resize_width** (_boolean_): True if the layout should resize the width of the node
+
+<a name="is_resize_height"></a>
+- **is_resize_height** (_boolean_): True if the layout should resize the height of the node
+
+<a name="is_justify"></a>
+- **is_justify** (_boolean_): True if the layout should justify the nodes
+
+<a name="on_size_changed"></a>
+- **on_size_changed** (_event.on_size_changed_): The event triggered when the size of the layout is changed
+
+<a name="size"></a>
+- **size** (_unknown_)
+

api/components/extended/progress_api.md

@@ -0,0 +1,232 @@
+# druid.progress API
+
+> at /druid/extended/progress.lua
+
+The component used to manage a node as a progress bar, changing the size and scale of the node
+
+
+## Functions
+- [init](#init)
+- [on_style_change](#on_style_change)
+- [on_layout_change](#on_layout_change)
+- [on_remove](#on_remove)
+- [update](#update)
+- [fill](#fill)
+- [empty](#empty)
+- [set_to](#set_to)
+- [get](#get)
+- [set_steps](#set_steps)
+- [to](#to)
+- [set_max_size](#set_max_size)
+
+
+## Fields
+- [node](#node)
+- [on_change](#on_change)
+- [style](#style)
+- [key](#key)
+- [prop](#prop)
+- [scale](#scale)
+- [size](#size)
+- [max_size](#max_size)
+- [slice](#slice)
+- [last_value](#last_value)
+- [slice_size](#slice_size)
+- [target](#target)
+- [steps](#steps)
+- [step_callback](#step_callback)
+- [target_callback](#target_callback)
+
+
+
+### init
+
+---
+```lua
+progress:init(node, key, [init_value])
+```
+
+- **Parameters:**
+	- `node` *(string|node)*: Node name or GUI Node itself.
+	- `key` *(string)*: Progress bar direction: "x" or "y"
+	- `[init_value]` *(number|nil)*: Initial value of progress bar. Default: 1
+
+### on_style_change
+
+---
+```lua
+progress:on_style_change(style)
+```
+
+- **Parameters:**
+	- `style` *(druid.progress.style)*:
+
+### on_layout_change
+
+---
+```lua
+progress:on_layout_change()
+```
+
+### on_remove
+
+---
+```lua
+progress:on_remove()
+```
+
+### update
+
+---
+```lua
+progress:update(dt)
+```
+
+- **Parameters:**
+	- `dt` *(number)*: Delta time
+
+### fill
+
+---
+```lua
+progress:fill()
+```
+
+Fill the progress bar
+
+- **Returns:**
+	- `self` *(druid.progress)*: Current progress instance
+
+### empty
+
+---
+```lua
+progress:empty()
+```
+
+Empty the progress bar
+
+- **Returns:**
+	- `self` *(druid.progress)*: Current progress instance
+
+### set_to
+
+---
+```lua
+progress:set_to(to)
+```
+
+Instant fill progress bar to value
+
+- **Parameters:**
+	- `to` *(number)*: Progress bar value, from 0 to 1
+
+- **Returns:**
+	- `self` *(druid.progress)*: Current progress instance
+
+### get
+
+---
+```lua
+progress:get()
+```
+
+Return the current value of the progress bar
+
+- **Returns:**
+	- `value` *(number)*: The current value of the progress bar
+
+### set_steps
+
+---
+```lua
+progress:set_steps(steps, callback)
+```
+
+Set points on progress bar to fire the callback
+
+- **Parameters:**
+	- `steps` *(number[])*: Array of progress bar values
+	- `callback` *(function)*: Callback on intersect step value
+
+- **Returns:**
+	- `self` *(druid.progress)*: Current progress instance
+
+### to
+
+---
+```lua
+progress:to(to, [callback])
+```
+
+Start animation of a progress bar
+
+- **Parameters:**
+	- `to` *(number)*: value between 0..1
+	- `[callback]` *(function|nil)*: Callback on animation ends
+
+- **Returns:**
+	- `self` *(druid.progress)*: Current progress instance
+
+### set_max_size
+
+---
+```lua
+progress:set_max_size(max_size)
+```
+
+Set progress bar max node size
+
+- **Parameters:**
+	- `max_size` *(vector3)*: The new node maximum (full) size
+
+- **Returns:**
+	- `self` *(druid.progress)*: Current progress instance
+
+
+## Fields
+<a name="node"></a>
+- **node** (_node_)
+
+<a name="on_change"></a>
+- **on_change** (_event_)
+
+<a name="style"></a>
+- **style** (_druid.progress.style_)
+
+<a name="key"></a>
+- **key** (_string_)
+
+<a name="prop"></a>
+- **prop** (_hash_)
+
+<a name="scale"></a>
+- **scale** (_unknown_)
+
+<a name="size"></a>
+- **size** (_unknown_)
+
+<a name="max_size"></a>
+- **max_size** (_unknown_)
+
+<a name="slice"></a>
+- **slice** (_unknown_)
+
+<a name="last_value"></a>
+- **last_value** (_number_)
+
+<a name="slice_size"></a>
+- **slice_size** (_unknown_)
+
+<a name="target"></a>
+- **target** (_nil_)
+
+<a name="steps"></a>
+- **steps** (_number[]_)
+
+<a name="step_callback"></a>
+- **step_callback** (_function_)
+
+<a name="target_callback"></a>
+- **target_callback** (_function|nil_)
+

api/components/extended/slider_api.md

@@ -0,0 +1,164 @@
+# druid.slider API
+
+> at /druid/extended/slider.lua
+
+The component to make a draggable node over a line with a progress report
+
+
+## Functions
+- [init](#init)
+- [on_layout_change](#on_layout_change)
+- [on_remove](#on_remove)
+- [on_window_resized](#on_window_resized)
+- [on_input](#on_input)
+- [set](#set)
+- [set_steps](#set_steps)
+- [set_input_node](#set_input_node)
+- [set_enabled](#set_enabled)
+- [is_enabled](#is_enabled)
+
+
+## Fields
+- [node](#node)
+- [on_change_value](#on_change_value)
+- [style](#style)
+
+
+
+### init
+
+---
+```lua
+slider:init(node, end_pos, [callback])
+```
+
+The Slider constructor
+
+- **Parameters:**
+	- `node` *(node)*: GUI node to drag as a slider
+	- `end_pos` *(vector3)*: The end position of slider, should be on the same axis as the node
+	- `[callback]` *(function|nil)*: On slider change callback
+
+### on_layout_change
+
+---
+```lua
+slider:on_layout_change()
+```
+
+### on_remove
+
+---
+```lua
+slider:on_remove()
+```
+
+### on_window_resized
+
+---
+```lua
+slider:on_window_resized()
+```
+
+### on_input
+
+---
+```lua
+slider:on_input(action_id, action)
+```
+
+- **Parameters:**
+	- `action_id` *(number)*: The action id
+	- `action` *(action)*: The action table
+
+- **Returns:**
+	- `is_consumed` *(boolean)*: True if the input was consumed
+
+### set
+
+---
+```lua
+slider:set(value, [is_silent])
+```
+
+Set value for slider
+
+- **Parameters:**
+	- `value` *(number)*: Value from 0 to 1
+	- `[is_silent]` *(boolean|nil)*: Don't trigger event if true
+
+- **Returns:**
+	- `self` *(druid.slider)*: Current slider instance
+
+### set_steps
+
+---
+```lua
+slider:set_steps(steps)
+```
+
+Set slider steps. Pin node will
+apply closest step position
+
+- **Parameters:**
+	- `steps` *(number[])*: Array of steps
+
+- **Returns:**
+	- `self` *(druid.slider)*: Current slider instance
+
+### set_input_node
+
+---
+```lua
+slider:set_input_node([input_node])
+```
+
+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+
+
+- **Parameters:**
+	- `[input_node]` *(string|node|nil)*:
+
+- **Returns:**
+	- `self` *(druid.slider)*: Current slider instance
+
+### set_enabled
+
+---
+```lua
+slider:set_enabled(is_enabled)
+```
+
+Set Slider input enabled or disabled
+
+- **Parameters:**
+	- `is_enabled` *(boolean)*: True if slider is enabled
+
+- **Returns:**
+	- `self` *(druid.slider)*: Current slider instance
+
+### is_enabled
+
+---
+```lua
+slider:is_enabled()
+```
+
+Check if Slider component is enabled
+
+- **Returns:**
+	- `is_enabled` *(boolean)*: True if slider is enabled
+
+
+## Fields
+<a name="node"></a>
+- **node** (_node_): The node to manage the slider
+
+<a name="on_change_value"></a>
+- **on_change_value** (_event_): The event triggered when the slider value changes
+
+<a name="style"></a>
+- **style** (_table_): The style of the slider
+

api/components/extended/swipe_api.md

@@ -0,0 +1,57 @@
+# druid.swipe API
+
+> at /druid/extended/swipe.lua
+
+The component to manage swipe events over a node
+
+
+## Functions
+- [init](#init)
+- [set_click_zone](#set_click_zone)
+
+
+## Fields
+- [node](#node)
+- [on_swipe](#on_swipe)
+- [style](#style)
+- [click_zone](#click_zone)
+
+
+
+### init
+
+---
+```lua
+swipe:init(node_or_node_id, on_swipe_callback)
+```
+
+- **Parameters:**
+	- `node_or_node_id` *(string|node)*:
+	- `on_swipe_callback` *(function)*:
+
+### set_click_zone
+
+---
+```lua
+swipe:set_click_zone([zone])
+```
+
+Set the click zone for the swipe, useful for restricting events outside stencil node
+
+- **Parameters:**
+	- `[zone]` *(string|node|nil)*: Gui node
+
+
+## Fields
+<a name="node"></a>
+- **node** (_node_): The node to manage the swipe
+
+<a name="on_swipe"></a>
+- **on_swipe** (_event_): fun(context, side, dist, dt) The event triggered when a swipe is detected
+
+<a name="style"></a>
+- **style** (_druid.swipe.style_): The style of the swipe
+
+<a name="click_zone"></a>
+- **click_zone** (_node_): The click zone of the swipe
+

api/components/extended/timer_api.md

@@ -0,0 +1,122 @@
+# druid.timer API
+
+> at /druid/extended/timer.lua
+
+The component that handles a text to display a seconds timer
+
+
+## Functions
+- [init](#init)
+- [set_to](#set_to)
+- [set_state](#set_state)
+- [set_interval](#set_interval)
+
+
+## Fields
+- [on_tick](#on_tick)
+- [on_set_enabled](#on_set_enabled)
+- [on_timer_end](#on_timer_end)
+- [node](#node)
+- [from](#from)
+- [target](#target)
+- [value](#value)
+- [is_on](#is_on)
+- [temp](#temp)
+- [last_value](#last_value)
+
+
+
+### init
+
+---
+```lua
+timer:init(node, [seconds_from], [seconds_to], [callback])
+```
+
+- **Parameters:**
+	- `node` *(node)*: Gui text node
+	- `[seconds_from]` *(number|nil)*: Start timer value in seconds
+	- `[seconds_to]` *(number|nil)*: End timer value in seconds
+	- `[callback]` *(function|nil)*: Function on timer end
+
+- **Returns:**
+	- `` *(druid.timer)*:
+
+### set_to
+
+---
+```lua
+timer:set_to(set_to)
+```
+
+Set the timer to a specific value
+
+- **Parameters:**
+	- `set_to` *(number)*: Value in seconds
+
+- **Returns:**
+	- `self` *(druid.timer)*: Current timer instance
+
+### set_state
+
+---
+```lua
+timer:set_state([is_on])
+```
+
+Set the timer to a specific value
+
+- **Parameters:**
+	- `[is_on]` *(boolean|nil)*: Timer enable state
+
+- **Returns:**
+	- `self` *(druid.timer)*: Current timer instance
+
+### set_interval
+
+---
+```lua
+timer:set_interval(from, to)
+```
+
+Set the timer interval
+
+- **Parameters:**
+	- `from` *(number)*: Start time in seconds
+	- `to` *(number)*: Target time in seconds
+
+- **Returns:**
+	- `self` *(druid.timer)*: Current timer instance
+
+
+## Fields
+<a name="on_tick"></a>
+- **on_tick** (_event_): fun(context, value) The event triggered when the timer ticks
+
+<a name="on_set_enabled"></a>
+- **on_set_enabled** (_event_): fun(context, is_on) The event triggered when the timer is enabled
+
+<a name="on_timer_end"></a>
+- **on_timer_end** (_event_): fun(context) The event triggered when the timer ends
+
+<a name="node"></a>
+- **node** (_node_): The node to display the timer
+
+<a name="from"></a>
+- **from** (_number_): The start time of the timer
+
+<a name="target"></a>
+- **target** (_number_): The target time of the timer
+
+<a name="value"></a>
+- **value** (_number_): The current value of the timer
+
+<a name="is_on"></a>
+- **is_on** (_boolean_): True if the timer is on
+
+<a name="temp"></a>
+- **temp** (_unknown_)
+
+<a name="last_value"></a>
+- **last_value** (_number_)
+

api/components/widgets/fps_panel_api.md

@@ -0,0 +1,97 @@
+# druid.widget.fps_panel API
+
+> at /druid/widget/fps_panel/fps_panel.lua
+
+
+## Functions
+- [init](#init)
+- [on_remove](#on_remove)
+- [update](#update)
+- [push_fps_value](#push_fps_value)
+
+
+## Fields
+- [root](#root)
+- [delta_time](#delta_time)
+- [collect_time](#collect_time)
+- [collect_time_counter](#collect_time_counter)
+- [graph_samples](#graph_samples)
+- [fps_samples](#fps_samples)
+- [mini_graph](#mini_graph)
+- [text_min_fps](#text_min_fps)
+- [text_fps](#text_fps)
+- [timer_id](#timer_id)
+- [previous_time](#previous_time)
+
+
+
+### init
+
+---
+```lua
+fps_panel:init()
+```
+
+### on_remove
+
+---
+```lua
+fps_panel:on_remove()
+```
+
+### update
+
+---
+```lua
+fps_panel:update([dt])
+```
+
+- **Parameters:**
+	- `[dt]` *(any)*:
+
+### push_fps_value
+
+---
+```lua
+fps_panel:push_fps_value()
+```
+
+
+## Fields
+<a name="root"></a>
+- **root** (_node_)
+
+<a name="delta_time"></a>
+- **delta_time** (_number_):  in seconds
+
+<a name="collect_time"></a>
+- **collect_time** (_integer_):  in seconds
+
+<a name="collect_time_counter"></a>
+- **collect_time_counter** (_integer_)
+
+<a name="graph_samples"></a>
+- **graph_samples** (_number_)
+
+<a name="fps_samples"></a>
+- **fps_samples** (_table_):  Store frame time in seconds last collect_time seconds
+
+<a name="mini_graph"></a>
+- **mini_graph** (_druid.widget.mini_graph_): Widget to display a several lines with different height in a row
+Init, set amount of samples and max value of value means that the line will be at max height
+Use `push_line_value` to add a new value to the line
+Or `set_line_value` to set a value to the line by index
+Setup colors inside template file (at minimum and maximum)
+
+<a name="text_min_fps"></a>
+- **text_min_fps** (_druid.text_): The component to handle text behaviour over a GUI Text node, mainly used to automatically adjust text size to fit the text area
+
+<a name="text_fps"></a>
+- **text_fps** (_druid.text_): The component to handle text behaviour over a GUI Text node, mainly used to automatically adjust text size to fit the text area
+
+<a name="timer_id"></a>
+- **timer_id** (_unknown_)
+
+<a name="previous_time"></a>
+- **previous_time** (_unknown_)
+

api/components/widgets/memory_panel_api.md

@@ -0,0 +1,105 @@
+# druid.widget.memory_panel API
+
+> at /druid/widget/memory_panel/memory_panel.lua
+
+
+## Functions
+- [init](#init)
+- [on_remove](#on_remove)
+- [set_low_memory_limit](#set_low_memory_limit)
+- [push_next_value](#push_next_value)
+- [update_text_memory](#update_text_memory)
+
+
+## Fields
+- [root](#root)
+- [delta_time](#delta_time)
+- [samples_count](#samples_count)
+- [memory_limit](#memory_limit)
+- [mini_graph](#mini_graph)
+- [max_value](#max_value)
+- [text_per_second](#text_per_second)
+- [text_memory](#text_memory)
+- [memory](#memory)
+- [memory_samples](#memory_samples)
+- [timer_id](#timer_id)
+
+
+
+### init
+
+---
+```lua
+memory_panel:init()
+```
+
+### on_remove
+
+---
+```lua
+memory_panel:on_remove()
+```
+
+### set_low_memory_limit
+
+---
+```lua
+memory_panel:set_low_memory_limit([limit])
+```
+
+- **Parameters:**
+	- `[limit]` *(any)*:
+
+### push_next_value
+
+---
+```lua
+memory_panel:push_next_value()
+```
+
+### update_text_memory
+
+---
+```lua
+memory_panel:update_text_memory()
+```
+
+
+## Fields
+<a name="root"></a>
+- **root** (_node_)
+
+<a name="delta_time"></a>
+- **delta_time** (_number_)
+
+<a name="samples_count"></a>
+- **samples_count** (_integer_)
+
+<a name="memory_limit"></a>
+- **memory_limit** (_integer_)
+
+<a name="mini_graph"></a>
+- **mini_graph** (_druid.widget.mini_graph_): Widget to display a several lines with different height in a row
+Init, set amount of samples and max value of value means that the line will be at max height
+Use `push_line_value` to add a new value to the line
+Or `set_line_value` to set a value to the line by index
+Setup colors inside template file (at minimum and maximum)
+
+<a name="max_value"></a>
+- **max_value** (_druid.text_): The component to handle text behaviour over a GUI Text node, mainly used to automatically adjust text size to fit the text area
+
+<a name="text_per_second"></a>
+- **text_per_second** (_druid.text_): The component to handle text behaviour over a GUI Text node, mainly used to automatically adjust text size to fit the text area
+
+<a name="text_memory"></a>
+- **text_memory** (_druid.text_): The component to handle text behaviour over a GUI Text node, mainly used to automatically adjust text size to fit the text area
+
+<a name="memory"></a>
+- **memory** (_unknown_)
+
+<a name="memory_samples"></a>
+- **memory_samples** (_table_)
+
+<a name="timer_id"></a>
+- **timer_id** (_unknown_)
+

api/components/widgets/mini_graph_api.md

@@ -0,0 +1,233 @@
+# druid.widget.mini_graph API
+
+> at /druid/widget/mini_graph/mini_graph.lua
+
+Widget to display a several lines with different height in a row
+Init, set amount of samples and max value of value means that the line will be at max height
+Use `push_line_value` to add a new value to the line
+Or `set_line_value` to set a value to the line by index
+Setup colors inside template file (at minimum and maximum)
+
+
+## Functions
+- [init](#init)
+- [on_remove](#on_remove)
+- [clear](#clear)
+- [set_samples](#set_samples)
+- [get_samples](#get_samples)
+- [set_line_value](#set_line_value)
+- [get_line_value](#get_line_value)
+- [push_line_value](#push_line_value)
+- [set_max_value](#set_max_value)
+- [set_line_height](#set_line_height)
+- [get_lowest_value](#get_lowest_value)
+- [get_highest_value](#get_highest_value)
+- [on_drag_widget](#on_drag_widget)
+- [toggle_hide](#toggle_hide)
+
+
+## Fields
+- [root](#root)
+- [text_header](#text_header)
+- [icon_drag](#icon_drag)
+- [content](#content)
+- [layout](#layout)
+- [prefab_line](#prefab_line)
+- [color_zero](#color_zero)
+- [color_one](#color_one)
+- [is_hidden](#is_hidden)
+- [max_value](#max_value)
+- [lines](#lines)
+- [values](#values)
+- [container](#container)
+- [default_size](#default_size)
+- [samples](#samples)
+
+
+
+### init
+
+---
+```lua
+mini_graph:init()
+```
+
+### on_remove
+
+---
+```lua
+mini_graph:on_remove()
+```
+
+### clear
+
+---
+```lua
+mini_graph:clear()
+```
+
+### set_samples
+
+---
+```lua
+mini_graph:set_samples([samples])
+```
+
+- **Parameters:**
+	- `[samples]` *(any)*:
+
+### get_samples
+
+---
+```lua
+mini_graph:get_samples()
+```
+
+- **Returns:**
+	- `` *(unknown)*:
+
+### set_line_value
+
+---
+```lua
+mini_graph:set_line_value(index, value)
+```
+
+Set normalized to control the color of the line
+
+- **Parameters:**
+	- `index` *(number)*:
+	- `value` *(number)*: The normalized value from 0 to 1
+
+- **Example Usage:**
+
+```lua
+for index = 1, mini_graph:get_samples() do
+	mini_graph:set_line_value(index, math.random())
+end
+```
+### get_line_value
+
+---
+```lua
+mini_graph:get_line_value([index])
+```
+
+- **Parameters:**
+	- `[index]` *(any)*:
+
+- **Returns:**
+	- `` *(number)*:
+
+### push_line_value
+
+---
+```lua
+mini_graph:push_line_value([value])
+```
+
+- **Parameters:**
+	- `[value]` *(any)*:
+
+### set_max_value
+
+---
+```lua
+mini_graph:set_max_value([max_value])
+```
+
+- **Parameters:**
+	- `[max_value]` *(any)*:
+
+### set_line_height
+
+---
+```lua
+mini_graph:set_line_height([index])
+```
+
+- **Parameters:**
+	- `[index]` *(any)*:
+
+### get_lowest_value
+
+---
+```lua
+mini_graph:get_lowest_value()
+```
+
+### get_highest_value
+
+---
+```lua
+mini_graph:get_highest_value()
+```
+
+### on_drag_widget
+
+---
+```lua
+mini_graph:on_drag_widget([dx], [dy])
+```
+
+- **Parameters:**
+	- `[dx]` *(any)*:
+	- `[dy]` *(any)*:
+
+### toggle_hide
+
+---
+```lua
+mini_graph:toggle_hide()
+```
+
+- **Returns:**
+	- `` *(druid.widget.mini_graph)*:
+
+
+## Fields
+<a name="root"></a>
+- **root** (_node_)
+
+<a name="text_header"></a>
+- **text_header** (_druid.text_): The component to handle text behaviour over a GUI Text node, mainly used to automatically adjust text size to fit the text area
+
+<a name="icon_drag"></a>
+- **icon_drag** (_node_)
+
+<a name="content"></a>
+- **content** (_node_)
+
+<a name="layout"></a>
+- **layout** (_druid.layout_): The component used for managing the layout of nodes, placing them inside the node size with respect to the size and pivot of each node
+
+<a name="prefab_line"></a>
+- **prefab_line** (_node_)
+
+<a name="color_zero"></a>
+- **color_zero** (_unknown_)
+
+<a name="color_one"></a>
+- **color_one** (_unknown_)
+
+<a name="is_hidden"></a>
+- **is_hidden** (_boolean_)
+
+<a name="max_value"></a>
+- **max_value** (_integer_):  in this value line will be at max height
+
+<a name="lines"></a>
+- **lines** (_table_)
+
+<a name="values"></a>
+- **values** (_table_)
+
+<a name="container"></a>
+- **container** (_druid.container_): The component used for managing the size and positions with other containers relations to create a adaptable layouts
+
+<a name="default_size"></a>
+- **default_size** (_vector3_)
+
+<a name="samples"></a>
+- **samples** (_any_)
+

api/components/widgets/properties_panel/property_button_api.md

@@ -0,0 +1,97 @@
+# druid.widget.property_button API
+
+> at /druid/widget/properties_panel/properties/property_button.lua
+
+
+## Functions
+- [init](#init)
+- [on_click](#on_click)
+- [set_text_property](#set_text_property)
+- [set_text_button](#set_text_button)
+- [set_color](#set_color)
+
+
+## Fields
+- [root](#root)
+- [container](#container)
+- [text_name](#text_name)
+- [button](#button)
+- [text_button](#text_button)
+- [druid](#druid)
+- [selected](#selected)
+
+
+
+### init
+
+---
+```lua
+property_button:init()
+```
+
+### on_click
+
+---
+```lua
+property_button:on_click()
+```
+
+### set_text_property
+
+---
+```lua
+property_button:set_text_property(text)
+```
+
+- **Parameters:**
+	- `text` *(string)*:
+
+- **Returns:**
+	- `` *(druid.widget.property_button)*:
+
+### set_text_button
+
+---
+```lua
+property_button:set_text_button(text)
+```
+
+- **Parameters:**
+	- `text` *(string)*:
+
+- **Returns:**
+	- `` *(druid.widget.property_button)*:
+
+### set_color
+
+---
+```lua
+property_button:set_color([color_value])
+```
+
+- **Parameters:**
+	- `[color_value]` *(any)*:
+
+
+## Fields
+<a name="root"></a>
+- **root** (_node_)
+
+<a name="container"></a>
+- **container** (_druid.container_): The component used for managing the size and positions with other containers relations to create a adaptable layouts
+
+<a name="text_name"></a>
+- **text_name** (_druid.text_): The component to handle text behaviour over a GUI Text node, mainly used to automatically adjust text size to fit the text area
+
+<a name="button"></a>
+- **button** (_druid.button_): Druid component to make clickable node with various interaction callbacks
+
+<a name="text_button"></a>
+- **text_button** (_druid.text_): The component to handle text behaviour over a GUI Text node, mainly used to automatically adjust text size to fit the text area
+
+<a name="druid"></a>
+- **druid** (_druid.instance_): The Druid Factory used to create components
+
+<a name="selected"></a>
+- **selected** (_node_)
+

api/components/widgets/properties_panel/property_checkbox_api.md

@@ -0,0 +1,112 @@
+
+# druid.widget.property_checkbox API
+
+> at /druid/widget/properties_panel/properties/property_checkbox.lua
+
+
+## Functions
+- [init](#init)
+- [set_value](#set_value)
+- [get_value](#get_value)
+- [on_click](#on_click)
+- [set_text_property](#set_text_property)
+- [on_change](#on_change)
+
+
+## Fields
+- [root](#root)
+- [druid](#druid)
+- [text_name](#text_name)
+- [button](#button)
+- [selected](#selected)
+- [icon](#icon)
+- [container](#container)
+- [on_change_value](#on_change_value)
+
+
+
+### init
+
+---
+```lua
+property_checkbox:init()
+```
+
+### set_value
+
+---
+```lua
+property_checkbox:set_value(value, [is_instant])
+```
+
+- **Parameters:**
+	- `value` *(boolean)*:
+	- `[is_instant]` *(any)*:
+
+### get_value
+
+---
+```lua
+property_checkbox:get_value()
+```
+
+- **Returns:**
+	- `` *(boolean)*:
+
+### on_click
+
+---
+```lua
+property_checkbox:on_click()
+```
+
+### set_text_property
+
+---
+```lua
+property_checkbox:set_text_property(text)
+```
+
+Set the text property of the checkbox
+
+- **Parameters:**
+	- `text` *(string)*:
+
+### on_change
+
+---
+```lua
+property_checkbox:on_change(callback)
+```
+
+Set the callback function for when the checkbox value changes
+
+- **Parameters:**
+	- `callback` *(function)*:
+
+
+## Fields
+<a name="root"></a>
+- **root** (_node_)
+
+<a name="druid"></a>
+- **druid** (_druid.instance_): The Druid Factory used to create components
+
+<a name="text_name"></a>
+- **text_name** (_druid.text_): The component to handle text behaviour over a GUI Text node, mainly used to automatically adjust text size to fit the text area
+
+<a name="button"></a>
+- **button** (_druid.button_): Druid component to make clickable node with various interaction callbacks
+
+<a name="selected"></a>
+- **selected** (_node_)
+
+<a name="icon"></a>
+- **icon** (_node_)
+
+<a name="container"></a>
+- **container** (_druid.container_): The component used for managing the size and positions with other containers relations to create a adaptable layouts
+
+<a name="on_change_value"></a>
+- **on_change_value** (_unknown_)
+

api/components/widgets/properties_panel/property_input_api.md

@@ -0,0 +1,90 @@
+# druid.widget.property_input API
+
+> at /druid/widget/properties_panel/properties/property_input.lua
+
+## Functions
+
+- [init](#init)
+- [set_text_property](#set_text_property)
+- [set_text_value](#set_text_value)
+- [on_change](#on_change)
+
+## Fields
+
+- [root](#root)
+- [container](#container)
+- [text_name](#text_name)
+- [button](#button)
+- [druid](#druid)
+- [selected](#selected)
+- [rich_input](#rich_input)
+
+
+
+### init
+
+---
+```lua
+property_input:init()
+```
+
+### set_text_property
+
+---
+```lua
+property_input:set_text_property(text)
+```
+
+- **Parameters:**
+	- `text` *(string)*:
+
+- **Returns:**
+	- `` *(druid.widget.property_input)*:
+
+### set_text_value
+
+---
+```lua
+property_input:set_text_value(text)
+```
+
+- **Parameters:**
+	- `text` *(string|number)*:
+
+- **Returns:**
+	- `` *(druid.widget.property_input)*:
+
+### on_change
+
+---
+```lua
+property_input:on_change(callback, [callback_context])
+```
+
+- **Parameters:**
+	- `callback` *(fun(self: druid.widget.property_input, text: string))*:
+	- `[callback_context]` *(any)*:
+
+
+## Fields
+<a name="root"></a>
+- **root** (_node_)
+
+<a name="container"></a>
+- **container** (_druid.container_): The component used for managing the size and positions with other containers relations to create a adaptable layouts
+
+<a name="text_name"></a>
+- **text_name** (_druid.text_): The component to handle text behaviour over a GUI Text node, mainly used to automatically adjust text size to fit the text area
+
+<a name="button"></a>
+- **button** (_druid.button_): Druid component to make clickable node with various interaction callbacks
+
+<a name="druid"></a>
+- **druid** (_druid.instance_): The Druid Factory used to create components
+
+<a name="selected"></a>
+- **selected** (_node_)
+
+<a name="rich_input"></a>
+- **rich_input** (_druid.rich_input_): The component that handles a rich text input field, it's a wrapper around the druid.input component
+

api/components/widgets/properties_panel/property_left_right_selector_api.md

@@ -0,0 +1,171 @@
+# druid.widget.property_left_right_selector API
+
+> at /druid/widget/properties_panel/properties/property_left_right_selector.lua
+
+
+## Functions
+- [init](#init)
+- [set_text](#set_text)
+- [on_button_left](#on_button_left)
+- [on_button_right](#on_button_right)
+- [add_step](#add_step)
+- [set_number_type](#set_number_type)
+- [set_array_type](#set_array_type)
+- [set_value](#set_value)
+- [get_value](#get_value)
+
+
+## Fields
+- [root](#root)
+- [druid](#druid)
+- [text_name](#text_name)
+- [button](#button)
+- [selected](#selected)
+- [value](#value)
+- [on_change_value](#on_change_value)
+- [text_value](#text_value)
+- [button_left](#button_left)
+- [button_right](#button_right)
+- [container](#container)
+- [number_type](#number_type)
+- [array_type](#array_type)
+
+
+
+### init
+
+---
+```lua
+property_left_right_selector:init()
+```
+
+### set_text
+
+---
+```lua
+property_left_right_selector:set_text([text])
+```
+
+- **Parameters:**
+	- `[text]` *(any)*:
+
+- **Returns:**
+	- `` *(druid.widget.property_left_right_selector)*:
+
+### on_button_left
+
+---
+```lua
+property_left_right_selector:on_button_left()
+```
+
+### on_button_right
+
+---
+```lua
+property_left_right_selector:on_button_right()
+```
+
+### add_step
+
+---
+```lua
+property_left_right_selector:add_step(koef)
+```
+
+- **Parameters:**
+	- `koef` *(number)*: -1 0 1, on 0 will not move
+
+### set_number_type
+
+---
+```lua
+property_left_right_selector:set_number_type([min], [max], [is_loop], [steps])
+```
+
+- **Parameters:**
+	- `[min]` *(any)*:
+	- `[max]` *(any)*:
+	- `[is_loop]` *(any)*:
+	- `[steps]` *(any)*:
+
+- **Returns:**
+	- `` *(druid.widget.property_left_right_selector)*:
+
+### set_array_type
+
+---
+```lua
+property_left_right_selector:set_array_type([array], [is_loop], [steps])
+```
+
+- **Parameters:**
+	- `[array]` *(any)*:
+	- `[is_loop]` *(any)*:
+	- `[steps]` *(any)*:
+
+- **Returns:**
+	- `` *(druid.widget.property_left_right_selector)*:
+
+### set_value
+
+---
+```lua
+property_left_right_selector:set_value(value, [is_instant])
+```
+
+- **Parameters:**
+	- `value` *(string|number)*:
+	- `[is_instant]` *(any)*:
+
+### get_value
+
+---
+```lua
+property_left_right_selector:get_value()
+```
+
+- **Returns:**
+	- `` *(string|number)*:
+
+
+## Fields
+<a name="root"></a>
+- **root** (_node_)
+
+<a name="druid"></a>
+- **druid** (_druid.instance_): The Druid Factory used to create components
+
+<a name="text_name"></a>
+- **text_name** (_druid.text_): The component to handle text behaviour over a GUI Text node, mainly used to automatically adjust text size to fit the text area
+
+<a name="button"></a>
+- **button** (_druid.button_): Druid component to make clickable node with various interaction callbacks
+
+<a name="selected"></a>
+- **selected** (_node_)
+
+<a name="value"></a>
+- **value** (_string_)
+
+<a name="on_change_value"></a>
+- **on_change_value** (_event_): fun(value: string|number)
+
+<a name="text_value"></a>
+- **text_value** (_druid.text_): The component to handle text behaviour over a GUI Text node, mainly used to automatically adjust text size to fit the text area
+
+<a name="button_left"></a>
+- **button_left** (_druid.button_): Druid component to make clickable node with various interaction callbacks
+
+<a name="button_right"></a>
+- **button_right** (_druid.button_): Druid component to make clickable node with various interaction callbacks
+
+<a name="container"></a>
+- **container** (_druid.container_): The component used for managing the size and positions with other containers relations to create a adaptable layouts
+
+<a name="number_type"></a>
+- **number_type** (_table_)
+
+<a name="array_type"></a>
+- **array_type** (_table_)
+

api/components/widgets/properties_panel/property_slider_api.md

@@ -0,0 +1,150 @@
+# druid.widget.property_slider API
+
+> at /druid/widget/properties_panel/properties/property_slider.lua
+
+
+## Functions
+- [init](#init)
+- [set_text_function](#set_text_function)
+- [set_text_property](#set_text_property)
+- [on_change](#on_change)
+- [set_value](#set_value)
+- [get_value](#get_value)
+- [update_value](#update_value)
+- [set_number_type](#set_number_type)
+
+
+## Fields
+- [root](#root)
+- [container](#container)
+- [druid](#druid)
+- [text_name](#text_name)
+- [text_value](#text_value)
+- [slider](#slider)
+- [on_change_value](#on_change_value)
+- [selected](#selected)
+- [min](#min)
+- [max](#max)
+- [step](#step)
+
+
+
+### init
+
+---
+```lua
+property_slider:init()
+```
+
+### set_text_function
+
+---
+```lua
+property_slider:set_text_function(callback)
+```
+
+- **Parameters:**
+	- `callback` *(fun(value: number):string)*:
+
+### set_text_property
+
+---
+```lua
+property_slider:set_text_property(text)
+```
+
+Sets the text property of the slider
+
+- **Parameters:**
+	- `text` *(string)*:
+
+### on_change
+
+---
+```lua
+property_slider:on_change(callback)
+```
+
+Sets the callback function for when the slider value changes
+
+- **Parameters:**
+	- `callback` *(fun(value: number))*:
+
+### set_value
+
+---
+```lua
+property_slider:set_value(value, [is_instant])
+```
+
+- **Parameters:**
+	- `value` *(number)*:
+	- `[is_instant]` *(any)*:
+
+### get_value
+
+---
+```lua
+property_slider:get_value()
+```
+
+- **Returns:**
+	- `` *(number)*:
+
+### update_value
+
+---
+```lua
+property_slider:update_value([value])
+```
+
+- **Parameters:**
+	- `[value]` *(any)*:
+
+### set_number_type
+
+---
+```lua
+property_slider:set_number_type([min], [max], [step])
+```
+
+- **Parameters:**
+	- `[min]` *(any)*:
+	- `[max]` *(any)*:
+	- `[step]` *(any)*:
+
+
+## Fields
+<a name="root"></a>
+- **root** (_node_)
+
+<a name="container"></a>
+- **container** (_druid.container_): The component used for managing the size and positions with other containers relations to create a adaptable layouts
+
+<a name="druid"></a>
+- **druid** (_druid.instance_): The Druid Factory used to create components
+
+<a name="text_name"></a>
+- **text_name** (_druid.text_): The component to handle text behaviour over a GUI Text node, mainly used to automatically adjust text size to fit the text area
+
+<a name="text_value"></a>
+- **text_value** (_druid.text_): The component to handle text behaviour over a GUI Text node, mainly used to automatically adjust text size to fit the text area
+
+<a name="slider"></a>
+- **slider** (_druid.slider_): The component to make a draggable node over a line with a progress report
+
+<a name="on_change_value"></a>
+- **on_change_value** (_event_): fun(value:number)
+
+<a name="selected"></a>
+- **selected** (_node_)
+
+<a name="min"></a>
+- **min** (_integer_)
+
+<a name="max"></a>
+- **max** (_integer_)
+
+<a name="step"></a>
+- **step** (_number_)
+

api/components/widgets/properties_panel/property_text_api.md

@@ -0,0 +1,66 @@
+# druid.widget.property_text API
+
+> at /druid/widget/properties_panel/properties/property_text.lua
+
+
+## Functions
+- [init](#init)
+- [set_text_property](#set_text_property)
+- [set_text_value](#set_text_value)
+
+
+## Fields
+- [root](#root)
+- [container](#container)
+- [text_name](#text_name)
+- [text_right](#text_right)
+
+
+
+### init
+
+---
+```lua
+property_text:init()
+```
+
+### set_text_property
+
+---
+```lua
+property_text:set_text_property(text)
+```
+
+- **Parameters:**
+	- `text` *(string)*:
+
+- **Returns:**
+	- `` *(druid.widget.property_text)*:
+
+### set_text_value
+
+---
+```lua
+property_text:set_text_value([text])
+```
+
+- **Parameters:**
+	- `[text]` *(string|nil)*:
+
+- **Returns:**
+	- `` *(druid.widget.property_text)*:
+
+
+## Fields
+<a name="root"></a>
+- **root** (_node_)
+
+<a name="container"></a>
+- **container** (_druid.container_): The component used for managing the size and positions with other containers relations to create a adaptable layouts
+
+<a name="text_name"></a>
+- **text_name** (_druid.text_): The component to handle text behaviour over a GUI Text node, mainly used to automatically adjust text size to fit the text area
+
+<a name="text_right"></a>
+- **text_right** (_druid.text_): The component to handle text behaviour over a GUI Text node, mainly used to automatically adjust text size to fit the text area
+

api/components/widgets/properties_panel/property_vector3_api.md

@@ -0,0 +1,104 @@
+# druid.widget.property_vector3 API
+
+> at /druid/widget/properties_panel/properties/property_vector3.lua
+
+
+## Functions
+- [init](#init)
+- [set_text_property](#set_text_property)
+- [set_value](#set_value)
+
+
+## Fields
+- [root](#root)
+- [container](#container)
+- [text_name](#text_name)
+- [button](#button)
+- [druid](#druid)
+- [selected_x](#selected_x)
+- [selected_y](#selected_y)
+- [selected_z](#selected_z)
+- [rich_input_x](#rich_input_x)
+- [rich_input_y](#rich_input_y)
+- [rich_input_z](#rich_input_z)
+- [value](#value)
+- [on_change](#on_change)
+
+
+
+### init
+
+---
+```lua
+property_vector3:init()
+```
+
+### set_text_property
+
+---
+```lua
+property_vector3:set_text_property(text)
+```
+
+- **Parameters:**
+	- `text` *(string)*:
+
+- **Returns:**
+	- `` *(druid.widget.property_vector3)*:
+
+### set_value
+
+---
+```lua
+property_vector3:set_value(x, y, z)
+```
+
+- **Parameters:**
+	- `x` *(number)*:
+	- `y` *(number)*:
+	- `z` *(number)*:
+
+- **Returns:**
+	- `` *(druid.widget.property_vector3)*:
+
+
+## Fields
+<a name="root"></a>
+- **root** (_node_)
+
+<a name="container"></a>
+- **container** (_druid.container_): The component used for managing the size and positions with other containers relations to create a adaptable layouts
+
+<a name="text_name"></a>
+- **text_name** (_druid.text_): The component to handle text behaviour over a GUI Text node, mainly used to automatically adjust text size to fit the text area
+
+<a name="button"></a>
+- **button** (_druid.button_): Druid component to make clickable node with various interaction callbacks
+
+<a name="druid"></a>
+- **druid** (_druid.instance_): The Druid Factory used to create components
+
+<a name="selected_x"></a>
+- **selected_x** (_node_)
+
+<a name="selected_y"></a>
+- **selected_y** (_node_)
+
+<a name="selected_z"></a>
+- **selected_z** (_node_)
+
+<a name="rich_input_x"></a>
+- **rich_input_x** (_druid.rich_input_): The component that handles a rich text input field, it's a wrapper around the druid.input component
+
+<a name="rich_input_y"></a>
+- **rich_input_y** (_druid.rich_input_): The component that handles a rich text input field, it's a wrapper around the druid.input component
+
+<a name="rich_input_z"></a>
+- **rich_input_z** (_druid.rich_input_): The component that handles a rich text input field, it's a wrapper around the druid.input component
+
+<a name="value"></a>
+- **value** (_unknown_)
+
+<a name="on_change"></a>
+- **on_change** (_unknown_)
+

api/components/widgets/properties_panel_api.md

@@ -0,0 +1,366 @@
+# druid.widget.properties_panel API
+
+> at /druid/widget/properties_panel/properties_panel.lua
+
+
+## Functions
+- [properties_constructors](#properties_constructors)
+- [init](#init)
+- [on_remove](#on_remove)
+- [on_drag_widget](#on_drag_widget)
+- [clear_created_properties](#clear_created_properties)
+- [clear](#clear)
+- [on_size_changed](#on_size_changed)
+- [update](#update)
+- [add_checkbox](#add_checkbox)
+- [add_slider](#add_slider)
+- [add_button](#add_button)
+- [add_input](#add_input)
+- [add_text](#add_text)
+- [add_left_right_selector](#add_left_right_selector)
+- [add_vector3](#add_vector3)
+- [add_inner_widget](#add_inner_widget)
+- [add_widget](#add_widget)
+- [remove](#remove)
+- [set_hidden](#set_hidden)
+- [is_hidden](#is_hidden)
+- [set_properties_per_page](#set_properties_per_page)
+- [set_page](#set_page)
+
+
+## Fields
+- [root](#root)
+- [scroll](#scroll)
+- [layout](#layout)
+- [container](#container)
+- [container_content](#container_content)
+- [container_scroll_view](#container_scroll_view)
+- [contaienr_scroll_content](#contaienr_scroll_content)
+- [button_hidden](#button_hidden)
+- [text_header](#text_header)
+- [paginator](#paginator)
+- [properties](#properties)
+- [content](#content)
+- [default_size](#default_size)
+- [current_page](#current_page)
+- [properties_per_page](#properties_per_page)
+- [property_checkbox_prefab](#property_checkbox_prefab)
+- [property_slider_prefab](#property_slider_prefab)
+- [property_button_prefab](#property_button_prefab)
+- [property_input_prefab](#property_input_prefab)
+- [property_text_prefab](#property_text_prefab)
+- [property_left_right_selector_prefab](#property_left_right_selector_prefab)
+- [property_vector3_prefab](#property_vector3_prefab)
+- [is_dirty](#is_dirty)
+
+
+
+### properties_constructors
+
+---
+```lua
+properties_panel:properties_constructors()
+```
+
+List of properties functions to create a new widget. Used to not spawn non-visible widgets but keep the reference
+
+### init
+
+---
+```lua
+properties_panel:init()
+```
+
+### on_remove
+
+---
+```lua
+properties_panel:on_remove()
+```
+
+### on_drag_widget
+
+---
+```lua
+properties_panel:on_drag_widget([dx], [dy])
+```
+
+- **Parameters:**
+	- `[dx]` *(any)*:
+	- `[dy]` *(any)*:
+
+### clear_created_properties
+
+---
+```lua
+properties_panel:clear_created_properties()
+```
+
+### clear
+
+---
+```lua
+properties_panel:clear()
+```
+
+### on_size_changed
+
+---
+```lua
+properties_panel:on_size_changed([new_size])
+```
+
+- **Parameters:**
+	- `[new_size]` *(any)*:
+
+### update
+
+---
+```lua
+properties_panel:update([dt])
+```
+
+- **Parameters:**
+	- `[dt]` *(any)*:
+
+### add_checkbox
+
+---
+```lua
+properties_panel:add_checkbox([on_create])
+```
+
+- **Parameters:**
+	- `[on_create]` *(fun(checkbox: druid.widget.property_checkbox)|nil)*:
+
+- **Returns:**
+	- `` *(druid.widget.properties_panel)*:
+
+### add_slider
+
+---
+```lua
+properties_panel:add_slider([on_create])
+```
+
+- **Parameters:**
+	- `[on_create]` *(fun(slider: druid.widget.property_slider)|nil)*:
+
+- **Returns:**
+	- `` *(druid.widget.properties_panel)*:
+
+### add_button
+
+---
+```lua
+properties_panel:add_button([on_create])
+```
+
+- **Parameters:**
+	- `[on_create]` *(fun(button: druid.widget.property_button)|nil)*:
+
+- **Returns:**
+	- `` *(druid.widget.properties_panel)*:
+
+### add_input
+
+---
+```lua
+properties_panel:add_input([on_create])
+```
+
+- **Parameters:**
+	- `[on_create]` *(fun(input: druid.widget.property_input)|nil)*:
+
+- **Returns:**
+	- `` *(druid.widget.properties_panel)*:
+
+### add_text
+
+---
+```lua
+properties_panel:add_text([on_create])
+```
+
+- **Parameters:**
+	- `[on_create]` *(fun(text: druid.widget.property_text)|nil)*:
+
+- **Returns:**
+	- `` *(druid.widget.properties_panel)*:
+
+### add_left_right_selector
+
+---
+```lua
+properties_panel:add_left_right_selector([on_create])
+```
+
+- **Parameters:**
+	- `[on_create]` *(fun(selector: druid.widget.property_left_right_selector)|nil)*:
+
+- **Returns:**
+	- `` *(druid.widget.properties_panel)*:
+
+### add_vector3
+
+---
+```lua
+properties_panel:add_vector3([on_create])
+```
+
+- **Parameters:**
+	- `[on_create]` *(fun(vector3: druid.widget.property_vector3)|nil)*:
+
+- **Returns:**
+	- `` *(druid.widget.properties_panel)*:
+
+### add_inner_widget
+
+---
+```lua
+properties_panel:add_inner_widget(widget_class, [template], [nodes], [on_create])
+```
+
+- **Parameters:**
+	- `widget_class` *(<T:druid.widget>)*:
+	- `[template]` *(string|nil)*:
+	- `[nodes]` *(node|table<hash, node>|nil)*:
+	- `[on_create]` *(fun(widget: <T:druid.widget>)|nil)*:
+
+- **Returns:**
+	- `` *(druid.widget.properties_panel)*:
+
+### add_widget
+
+---
+```lua
+properties_panel:add_widget(create_widget_callback)
+```
+
+- **Parameters:**
+	- `create_widget_callback` *(fun():druid.widget)*:
+
+- **Returns:**
+	- `` *(druid.widget.properties_panel)*:
+
+### remove
+
+---
+```lua
+properties_panel:remove([widget])
+```
+
+- **Parameters:**
+	- `[widget]` *(any)*:
+
+### set_hidden
+
+---
+```lua
+properties_panel:set_hidden([is_hidden])
+```
+
+- **Parameters:**
+	- `[is_hidden]` *(any)*:
+
+### is_hidden
+
+---
+```lua
+properties_panel:is_hidden()
+```
+
+- **Returns:**
+	- `` *(unknown)*:
+
+### set_properties_per_page
+
+---
+```lua
+properties_panel:set_properties_per_page(properties_per_page)
+```
+
+- **Parameters:**
+	- `properties_per_page` *(number)*:
+
+### set_page
+
+---
+```lua
+properties_panel:set_page([page])
+```
+
+- **Parameters:**
+	- `[page]` *(any)*:
+
+
+## Fields
+<a name="root"></a>
+- **root** (_node_)
+
+<a name="scroll"></a>
+- **scroll** (_druid.scroll_)
+
+<a name="layout"></a>
+- **layout** (_druid.layout_): The component used for managing the layout of nodes, placing them inside the node size with respect to the size and pivot of each node
+
+<a name="container"></a>
+- **container** (_druid.container_): The component used for managing the size and positions with other containers relations to create a adaptable layouts
+
+<a name="container_content"></a>
+- **container_content** (_druid.container_): The component used for managing the size and positions with other containers relations to create a adaptable layouts
+
+<a name="container_scroll_view"></a>
+- **container_scroll_view** (_druid.container_): The component used for managing the size and positions with other containers relations to create a adaptable layouts
+
+<a name="contaienr_scroll_content"></a>
+- **contaienr_scroll_content** (_druid.container_): The component used for managing the size and positions with other containers relations to create a adaptable layouts
+
+<a name="button_hidden"></a>
+- **button_hidden** (_druid.button_): Druid component to make clickable node with various interaction callbacks
+
+<a name="text_header"></a>
+- **text_header** (_druid.text_): The component to handle text behaviour over a GUI Text node, mainly used to automatically adjust text size to fit the text area
+
+<a name="paginator"></a>
+- **paginator** (_druid.widget.property_left_right_selector_)
+
+<a name="properties"></a>
+- **properties** (_druid.widget[]_): List of created properties
+
+<a name="content"></a>
+- **content** (_node_)
+
+<a name="default_size"></a>
+- **default_size** (_vector3_)
+
+<a name="current_page"></a>
+- **current_page** (_integer_)
+
+<a name="properties_per_page"></a>
+- **properties_per_page** (_integer_)
+
+<a name="property_checkbox_prefab"></a>
+- **property_checkbox_prefab** (_node_)
+
+<a name="property_slider_prefab"></a>
+- **property_slider_prefab** (_node_)
+
+<a name="property_button_prefab"></a>
+- **property_button_prefab** (_node_)
+
+<a name="property_input_prefab"></a>
+- **property_input_prefab** (_node_)
+
+<a name="property_text_prefab"></a>
+- **property_text_prefab** (_node_)
+
+<a name="property_left_right_selector_prefab"></a>
+- **property_left_right_selector_prefab** (_node_)
+
+<a name="property_vector3_prefab"></a>
+- **property_vector3_prefab** (_node_)
+
+<a name="is_dirty"></a>
+- **is_dirty** (_boolean_)
+

api/druid_api.md

@@ -0,0 +1,104 @@
+# druid API
+
+> at /druid/druid.lua
+
+Entry point for Druid UI Framework.
+Create a new Druid instance and adjust the Druid settings here.
+
+## Table of Contents
+
+
+## Functions
+- [new](#new)
+- [set_default_style](#set_default_style)
+- [set_text_function](#set_text_function)
+- [set_sound_function](#set_sound_function)
+- [init_window_listener](#init_window_listener)
+- [on_window_callback](#on_window_callback)
+- [on_language_change](#on_language_change)
+
+
+
+### new
+
+---
+```lua
+druid.new(context, [style])
+```
+
+Create a new Druid instance for creating GUI components.
+
+- **Parameters:**
+	- `context` *(table)*: The Druid context. Usually, this is the self of the gui_script. It is passed into all Druid callbacks.
+	- `[style]` *(table|nil)*: The Druid style table to override style parameters for this Druid instance.
+
+- **Returns:**
+	- `druid_instance` *(druid.instance)*: The new Druid instance
+
+### set_default_style
+
+---
+```lua
+druid.set_default_style(style)
+```
+
+Set the default style for all Druid instances.
+
+- **Parameters:**
+	- `style` *(table)*: Default style
+
+### set_text_function
+
+---
+```lua
+druid.set_text_function(callback)
+```
+
+Set the text function for the LangText component.
+
+- **Parameters:**
+	- `callback` *(fun(text_id: string):string)*: Get localized text function
+
+### set_sound_function
+
+---
+```lua
+druid.set_sound_function(callback)
+```
+
+Set the sound function to able components to play sounds.
+
+- **Parameters:**
+	- `callback` *(fun(sound_id: string))*: Sound play callback
+
+### init_window_listener
+
+---
+```lua
+druid.init_window_listener()
+```
+
+Subscribe Druid to the window listener. It will override your previous
+window listener, so if you have one, you should call M.on_window_callback manually.
+
+### on_window_callback
+
+---
+```lua
+druid.on_window_callback(window_event)
+```
+
+Set the window callback to enable Druid window events.
+
+- **Parameters:**
+	- `window_event` *(constant)*: Event param from window listener
+
+### on_language_change
+
+---
+```lua
+druid.on_language_change()
+```
+
+Call this function when the game language changes.
+It will notify all Druid instances to update the lang text components.

api/druid_helper_api.md

@@ -0,0 +1,548 @@
+# druid.helper API
+
+> at /druid/helper.lua
+
+The helper module contains various functions that are used in the Druid library.
+You can use these functions in your projects as well.
+
+
+## Functions
+- [centrate_text_with_icon](#centrate_text_with_icon)
+- [centrate_icon_with_text](#centrate_icon_with_text)
+- [centrate_nodes](#centrate_nodes)
+- [get_node](#get_node)
+- [get_screen_aspect_koef](#get_screen_aspect_koef)
+- [get_gui_scale](#get_gui_scale)
+- [step](#step)
+- [clamp](#clamp)
+- [distance](#distance)
+- [sign](#sign)
+- [round](#round)
+- [lerp](#lerp)
+- [contains](#contains)
+- [deepcopy](#deepcopy)
+- [add_array](#add_array)
+- [pick_node](#pick_node)
+- [get_scaled_size](#get_scaled_size)
+- [get_scene_scale](#get_scene_scale)
+- [get_closest_stencil_node](#get_closest_stencil_node)
+- [get_pivot_offset](#get_pivot_offset)
+- [is_mobile](#is_mobile)
+- [is_web](#is_web)
+- [is_web_mobile](#is_web_mobile)
+- [is_multitouch_supported](#is_multitouch_supported)
+- [table_to_string](#table_to_string)
+- [get_border](#get_border)
+- [get_text_metrics_from_node](#get_text_metrics_from_node)
+- [insert_with_shift](#insert_with_shift)
+- [remove_with_shift](#remove_with_shift)
+- [get_full_position](#get_full_position)
+- [get_animation_data_from_node](#get_animation_data_from_node)
+
+
+## Fields
+- [PROP_SIZE_X](#PROP_SIZE_X)
+- [PROP_SIZE_Y](#PROP_SIZE_Y)
+- [PROP_SCALE_X](#PROP_SCALE_X)
+- [PROP_SCALE_Y](#PROP_SCALE_Y)
+
+
+
+### centrate_text_with_icon
+
+---
+```lua
+helper.centrate_text_with_icon([text_node], [icon_node], margin)
+```
+
+Center two nodes.
+Nodes will be center around 0 x position
+text_node will be first (at left side)
+
+- **Parameters:**
+	- `[text_node]` *(node|nil)*: Gui text node
+	- `[icon_node]` *(node|nil)*: Gui box node
+	- `margin` *(number)*: Offset between nodes
+
+- **Returns:**
+	- `` *(unknown)*:
+
+### centrate_icon_with_text
+
+---
+```lua
+helper.centrate_icon_with_text([icon_node], [text_node], [margin])
+```
+
+Center two nodes.
+Nodes will be center around 0 x position
+icon_node will be first (at left side)
+
+- **Parameters:**
+	- `[icon_node]` *(node|nil)*: Gui box node
+	- `[text_node]` *(node|nil)*: Gui text node
+	- `[margin]` *(number|nil)*: Offset between nodes
+
+- **Returns:**
+	- `` *(unknown)*:
+
+### centrate_nodes
+
+---
+```lua
+helper.centrate_nodes([margin], ...)
+```
+
+Centerate nodes by x position with margin.
+This functions calculate total width of nodes and set position for each node.
+The centrate will be around 0 x position.
+
+- **Parameters:**
+	- `[margin]` *(number|nil)*: Offset between nodes
+	- `...` *(...)*: vararg
+
+- **Returns:**
+	- `` *(unknown)*:
+
+### get_node
+
+---
+```lua
+helper.get_node(node_id, [template], [nodes])
+```
+
+- **Parameters:**
+	- `node_id` *(string|node)*:
+	- `[template]` *(string|nil)*: Full Path to the template
+	- `[nodes]` *(table<hash, node>|nil)*: Nodes what created with gui.clone_tree
+
+- **Returns:**
+	- `` *(node)*:
+
+### get_screen_aspect_koef
+
+---
+```lua
+helper.get_screen_aspect_koef()
+```
+
+Get current screen stretch multiplier for each side
+
+- **Returns:**
+	- `stretch_x` *(number)*:
+	- `stretch_y` *(number)*:
+
+### get_gui_scale
+
+---
+```lua
+helper.get_gui_scale()
+```
+
+Get current GUI scale for each side
+
+- **Returns:**
+	- `scale_x` *(number)*:
+
+### step
+
+---
+```lua
+helper.step(current, target, step)
+```
+
+Move value from current to target value with step amount
+
+- **Parameters:**
+	- `current` *(number)*: Current value
+	- `target` *(number)*: Target value
+	- `step` *(number)*: Step amount
+
+- **Returns:**
+	- `New` *(number)*: value
+
+### clamp
+
+---
+```lua
+helper.clamp(value, [v1], [v2])
+```
+
+Clamp value between min and max. Works with nil values and swap min and max if needed.
+
+- **Parameters:**
+	- `value` *(number)*: Value
+	- `[v1]` *(number|nil)*: Min value. If nil, value will be clamped to positive infinity
+	- `[v2]` *(number|nil)*: Max value If nil, value will be clamped to negative infinity
+
+- **Returns:**
+	- `value` *(number)*: Clamped value
+
+### distance
+
+---
+```lua
+helper.distance(x1, y1, x2, y2)
+```
+
+Calculate distance between two points
+
+- **Parameters:**
+	- `x1` *(number)*: First point x
+	- `y1` *(number)*: First point y
+	- `x2` *(number)*: Second point x
+	- `y2` *(number)*: Second point y
+
+- **Returns:**
+	- `Distance` *(number)*:
+
+### sign
+
+---
+```lua
+helper.sign(val)
+```
+
+Return sign of value
+
+- **Parameters:**
+	- `val` *(number)*: Value
+
+- **Returns:**
+	- `sign` *(number)*: Sign of value, -1, 0 or 1
+
+### round
+
+---
+```lua
+helper.round(num, [num_decimal_places])
+```
+
+Round number to specified decimal places
+
+- **Parameters:**
+	- `num` *(number)*: Number
+	- `[num_decimal_places]` *(number|nil)*: Decimal places
+
+- **Returns:**
+	- `value` *(number)*: Rounded number
+
+### lerp
+
+---
+```lua
+helper.lerp(a, b, t)
+```
+
+Lerp between two values
+
+- **Parameters:**
+	- `a` *(number)*: First value
+	- `b` *(number)*: Second value
+	- `t` *(number)*: Lerp amount
+
+- **Returns:**
+	- `value` *(number)*: Lerped value
+
+### contains
+
+---
+```lua
+helper.contains([array], [value])
+```
+
+Check if value contains in array
+
+- **Parameters:**
+	- `[array]` *(any[])*: Array to check
+	- `[value]` *(any)*: Value
+
+- **Returns:**
+	- `` *(integer|nil)*:
+
+### deepcopy
+
+---
+```lua
+helper.deepcopy(orig_table)
+```
+
+Make a copy table with all nested tables
+
+- **Parameters:**
+	- `orig_table` *(table)*: Original table
+
+- **Returns:**
+	- `Copy` *(table)*: of original table
+
+### add_array
+
+---
+```lua
+helper.add_array([target], [source])
+```
+
+Add all elements from source array to the target array
+
+- **Parameters:**
+	- `[target]` *(any[])*: Array to put elements from source
+	- `[source]` *(any[]|nil)*: The source array to get elements from
+
+- **Returns:**
+	- `The` *(any[])*: target array
+
+### pick_node
+
+---
+```lua
+helper.pick_node(node, x, y, [node_click_area])
+```
+
+Make a check with gui.pick_node, but with additional node_click_area check.
+
+- **Parameters:**
+	- `node` *(node)*:
+	- `x` *(number)*:
+	- `y` *(number)*:
+	- `[node_click_area]` *(node|nil)*: Additional node to check for click area. If nil, only node will be checked
+
+- **Returns:**
+	- `` *(unknown)*:
+
+### get_scaled_size
+
+---
+```lua
+helper.get_scaled_size(node)
+```
+
+Get size of node with scale multiplier
+
+- **Parameters:**
+	- `node` *(node)*: GUI node
+
+- **Returns:**
+	- `scaled_size` *(vector3)*:
+
+### get_scene_scale
+
+---
+```lua
+helper.get_scene_scale(node, [include_passed_node_scale])
+```
+
+Get cumulative parent's node scale
+
+- **Parameters:**
+	- `node` *(node)*: Gui node
+	- `[include_passed_node_scale]` *(boolean|nil)*: True if add current node scale to result
+
+- **Returns:**
+	- `The` *(vector3)*: scene node scale
+
+### get_closest_stencil_node
+
+---
+```lua
+helper.get_closest_stencil_node(node)
+```
+
+Return closest non inverted clipping parent node for given node
+
+- **Parameters:**
+	- `node` *(node)*: GUI node
+
+- **Returns:**
+	- `stencil_node` *(node|nil)*: The closest stencil node or nil
+
+### get_pivot_offset
+
+---
+```lua
+helper.get_pivot_offset(pivot_or_node)
+```
+
+Get pivot offset for given pivot or node
+Offset shown in [-0.5 .. 0.5] range, where -0.5 is left or bottom, 0.5 is right or top.
+
+- **Parameters:**
+	- `pivot_or_node` *(number|node)*: GUI pivot or node
+
+- **Returns:**
+	- `offset` *(vector3)*: The pivot offset
+
+### is_mobile
+
+---
+```lua
+helper.is_mobile()
+```
+
+Check if device is native mobile (Android or iOS)
+
+- **Returns:**
+	- `Is` *(boolean)*: mobile
+
+### is_web
+
+---
+```lua
+helper.is_web()
+```
+
+Check if device is HTML5
+
+- **Returns:**
+	- `` *(boolean)*:
+
+### is_web_mobile
+
+---
+```lua
+helper.is_web_mobile()
+```
+
+Check if device is HTML5 mobile
+
+- **Returns:**
+	- `` *(boolean)*:
+
+### is_multitouch_supported
+
+---
+```lua
+helper.is_multitouch_supported()
+```
+
+Check if device is mobile and can support multitouch
+
+- **Returns:**
+	- `is_multitouch` *(boolean)*: Is multitouch supported
+
+### table_to_string
+
+---
+```lua
+helper.table_to_string(t)
+```
+
+Simple table to one-line string converter
+
+- **Parameters:**
+	- `t` *(table)*:
+
+- **Returns:**
+	- `` *(string)*:
+
+### get_border
+
+---
+```lua
+helper.get_border(node, [offset])
+```
+
+Distance from node position to his borders
+
+- **Parameters:**
+	- `node` *(node)*: GUI node
+	- `[offset]` *(vector3|nil)*: Offset from node position. Pass current node position to get non relative border values
+
+- **Returns:**
+	- `border` *(vector4)*: Vector4 with border values (left, top, right, down)
+
+### get_text_metrics_from_node
+
+---
+```lua
+helper.get_text_metrics_from_node(text_node)
+```
+
+Get text metric from GUI node.
+
+- **Parameters:**
+	- `text_node` *(node)*:
+
+- **Returns:**
+	- `` *(GUITextMetrics)*:
+
+### insert_with_shift
+
+---
+```lua
+helper.insert_with_shift(array, [item], [index], [shift_policy])
+```
+
+Add value to array with shift policy
+Shift policy can be: left, right, no_shift
+
+- **Parameters:**
+	- `array` *(table)*: Array
+	- `[item]` *(any)*: Item to insert
+	- `[index]` *(number|nil)*: Index to insert. If nil, item will be inserted at the end of array
+	- `[shift_policy]` *(number|nil)*: The druid_const.SHIFT.* constant
+
+- **Returns:**
+	- `Inserted` *(any)*: item
+
+### remove_with_shift
+
+---
+```lua
+helper.remove_with_shift([array], [index], [shift_policy])
+```
+
+Remove value from array with shift policy
+ Shift policy can be: left, right, no_shift
+
+- **Parameters:**
+	- `[array]` *(any[])*: Array
+	- `[index]` *(number|nil)*: Index to remove. If nil, item will be removed from the end of array
+	- `[shift_policy]` *(number|nil)*: The druid_const.SHIFT.* constant
+
+- **Returns:**
+	- `Removed` *(any)*: item
+
+### get_full_position
+
+---
+```lua
+helper.get_full_position(node, [root])
+```
+
+Get full position of node in the GUI tree
+
+- **Parameters:**
+	- `node` *(node)*: GUI node
+	- `[root]` *(node|nil)*: GUI root node to stop search
+
+- **Returns:**
+	- `` *(unknown)*:
+
+### get_animation_data_from_node
+
+---
+```lua
+helper.get_animation_data_from_node(node, atlas_path)
+```
+
+- **Parameters:**
+	- `node` *(node)*:
+	- `atlas_path` *(string)*: Path to the atlas
+
+- **Returns:**
+	- `` *(druid.system.animation_data)*:
+
+
+## Fields
+<a name="PROP_SIZE_X"></a>
+- **PROP_SIZE_X** (_unknown_)
+
+<a name="PROP_SIZE_Y"></a>
+- **PROP_SIZE_Y** (_unknown_)
+
+<a name="PROP_SCALE_X"></a>
+- **PROP_SCALE_X** (_unknown_)
+
+<a name="PROP_SCALE_Y"></a>
+- **PROP_SCALE_Y** (_unknown_)
+

api/druid_instance_api.md

@@ -0,0 +1,553 @@
+# druid.instance API
+
+> at /druid/system/druid_instance.lua
+
+The Druid Factory used to create components
+
+
+## Functions
+- [create_druid_instance](#create_druid_instance)
+
+- [new](#new)
+- [final](#final)
+- [remove](#remove)
+- [update](#update)
+- [on_input](#on_input)
+- [on_message](#on_message)
+- [on_window_event](#on_window_event)
+- [set_whitelist](#set_whitelist)
+- [set_blacklist](#set_blacklist)
+- [new_widget](#new_widget)
+- [new_button](#new_button)
+- [new_blocker](#new_blocker)
+- [new_back_handler](#new_back_handler)
+- [new_hover](#new_hover)
+- [new_text](#new_text)
+- [new_grid](#new_grid)
+- [new_scroll](#new_scroll)
+- [new_drag](#new_drag)
+- [new_swipe](#new_swipe)
+- [new_lang_text](#new_lang_text)
+- [new_slider](#new_slider)
+- [new_input](#new_input)
+- [new_data_list](#new_data_list)
+- [new_timer](#new_timer)
+- [new_progress](#new_progress)
+- [new_layout](#new_layout)
+- [new_container](#new_container)
+- [new_hotkey](#new_hotkey)
+- [new_rich_text](#new_rich_text)
+- [new_rich_input](#new_rich_input)
+
+
+## Fields
+- [components_all](#components_all)
+- [components_interest](#components_interest)
+
+
+
+### create_druid_instance
+
+---
+```lua
+instance.create_druid_instance(context, [style])
+```
+
+Druid class constructor which used to create a Druid's components
+
+- **Parameters:**
+	- `context` *(table)*: Druid context. Usually it is self of gui script
+	- `[style]` *(table?)*: Druid style table
+
+- **Returns:**
+	- `` *(druid.instance)*:
+
+### new
+
+---
+```lua
+instance:new(component, ...)
+```
+
+Create new Druid component instance
+
+- **Parameters:**
+	- `component` *(<T:druid.component>)*: The component class to create
+	- `...` *(...)*: vararg
+
+- **Returns:**
+	- `instance` *(<T:druid.component>)*: The new ready to use component
+
+### final
+
+---
+```lua
+instance:final()
+```
+
+Call this in gui_script final function.
+
+### remove
+
+---
+```lua
+instance:remove(component)
+```
+
+Remove created component from Druid instance.
+ Component `on_remove` function will be invoked, if exist.
+
+- **Parameters:**
+	- `component` *(<T:druid.component>)*: Component instance
+
+- **Returns:**
+	- `is_removed` *(boolean)*: True if component was removed
+
+### update
+
+---
+```lua
+instance:update(dt)
+```
+
+Call this in gui_script update function.
+
+- **Parameters:**
+	- `dt` *(number)*: Delta time
+
+### on_input
+
+---
+```lua
+instance:on_input(action_id, action)
+```
+
+Call this in gui_script on_input function.
+
+- **Parameters:**
+	- `action_id` *(hash)*: Action_id from on_input
+	- `action` *(table)*: Action from on_input
+
+- **Returns:**
+	- `is_input_consumed` *(boolean)*: The boolean value is input was consumed
+
+### on_message
+
+---
+```lua
+instance:on_message(message_id, message, sender)
+```
+
+Call this in gui_script on_message function.
+
+- **Parameters:**
+	- `message_id` *(hash)*: Message_id from on_message
+	- `message` *(table)*: Message from on_message
+	- `sender` *(url)*: Sender from on_message
+
+### on_window_event
+
+---
+```lua
+instance:on_window_event(window_event)
+```
+
+Called when the window event occurs
+
+- **Parameters:**
+	- `window_event` *(number)*: The window event
+
+### set_whitelist
+
+---
+```lua
+instance:set_whitelist(whitelist_components)
+```
+
+Set whitelist components for input processing.
+If whitelist is not empty and component not contains in this list,
+component will be not processed on input step
+
+- **Parameters:**
+	- `whitelist_components` *(table|druid.component[])*: The array of component to whitelist
+
+- **Returns:**
+	- `self` *(druid.instance)*: The Druid instance
+
+### set_blacklist
+
+---
+```lua
+instance:set_blacklist(blacklist_components)
+```
+
+Set blacklist components for input processing.
+If blacklist is not empty and component contains in this list,
+component will be not processed on input step DruidInstance
+
+- **Parameters:**
+	- `blacklist_components` *(table|druid.component[])*: The array of component to blacklist
+
+- **Returns:**
+	- `self` *(druid.instance)*: The Druid instance
+
+### new_widget
+
+---
+```lua
+instance:new_widget(widget, [template], [nodes], ...)
+```
+
+Create new Druid widget instance
+
+- **Parameters:**
+	- `widget` *(<T:druid.component>)*: The widget class to create
+	- `[template]` *(string|nil)*: The template name used by widget
+	- `[nodes]` *(node|table<hash, node>|nil)*: The nodes table from gui.clone_tree or prefab node to use for clone
+	- `...` *(...)*: vararg
+
+- **Returns:**
+	- `widget` *(<T:druid.component>)*: The new ready to use widget
+
+### new_button
+
+---
+```lua
+instance:new_button(node, [callback], [params], [anim_node])
+```
+
+Create Button component
+
+- **Parameters:**
+	- `node` *(string|node)*: The node_id or gui.get_node(node_id)
+	- `[callback]` *(function|event|nil)*: Button callback
+	- `[params]` *(any)*: Button callback params
+	- `[anim_node]` *(string|node|nil)*: Button anim node (node, if not provided)
+
+- **Returns:**
+	- `button` *(druid.button)*: The new button component
+
+### new_blocker
+
+---
+```lua
+instance:new_blocker(node)
+```
+
+Create Blocker component
+
+- **Parameters:**
+	- `node` *(string|node)*: The node_id or gui.get_node(node_id)
+
+- **Returns:**
+	- `blocker` *(druid.blocker)*: The new blocker component
+
+### new_back_handler
+
+---
+```lua
+instance:new_back_handler([callback], [params])
+```
+
+Create BackHandler component
+
+- **Parameters:**
+	- `[callback]` *(function|nil)*: The callback(self, custom_args) to call on back event
+	- `[params]` *(any)*: Callback argument
+
+- **Returns:**
+	- `back_handler` *(druid.back_handler)*: The new back handler component
+
+### new_hover
+
+---
+```lua
+instance:new_hover(node, [on_hover_callback], [on_mouse_hover_callback])
+```
+
+Create Hover component
+
+- **Parameters:**
+	- `node` *(string|node)*: The node_id or gui.get_node(node_id)
+	- `[on_hover_callback]` *(function|nil)*: Hover callback
+	- `[on_mouse_hover_callback]` *(function|nil)*: Mouse hover callback
+
+- **Returns:**
+	- `hover` *(druid.hover)*: The new hover component
+
+### new_text
+
+---
+```lua
+instance:new_text(node, [value], [adjust_type])
+```
+
+Create Text component
+
+- **Parameters:**
+	- `node` *(string|node)*: The node_id or gui.get_node(node_id)
+	- `[value]` *(string|nil)*: Initial text. Default value is node text from GUI scene.
+	- `[adjust_type]` *(string|nil)*: Adjust type for text. By default is DOWNSCALE. Look const.TEXT_ADJUST for reference
+
+- **Returns:**
+	- `text` *(druid.text)*: The new text component
+
+### new_grid
+
+---
+```lua
+instance:new_grid(parent_node, item, [in_row])
+```
+
+Create Grid component
+
+- **Parameters:**
+	- `parent_node` *(string|node)*: The node_id or gui.get_node(node_id). Parent of all Grid items.
+	- `item` *(string|node)*: Item prefab. Required to get grid's item size. Can be adjusted separately.
+	- `[in_row]` *(number|nil)*: How many nodes in row can be placed
+
+- **Returns:**
+	- `grid` *(druid.grid)*: The new grid component
+
+### new_scroll
+
+---
+```lua
+instance:new_scroll(view_node, content_node)
+```
+
+Create Scroll component
+
+- **Parameters:**
+	- `view_node` *(string|node)*: The node_id or gui.get_node(node_id). Will used as user input node.
+	- `content_node` *(string|node)*: The node_id or gui.get_node(node_id). Will used as scrollable node inside view_node.
+
+- **Returns:**
+	- `scroll` *(druid.scroll)*: The new scroll component
+
+### new_drag
+
+---
+```lua
+instance:new_drag(node, [on_drag_callback])
+```
+
+Create Drag component
+
+- **Parameters:**
+	- `node` *(string|node)*: The node_id or gui.get_node(node_id). Will used as user input node.
+	- `[on_drag_callback]` *(function|nil)*: Callback for on_drag_event(self, dx, dy)
+
+- **Returns:**
+	- `drag` *(druid.drag)*: The new drag component
+
+### new_swipe
+
+---
+```lua
+instance:new_swipe(node, [on_swipe_callback])
+```
+
+Create Swipe component
+
+- **Parameters:**
+	- `node` *(string|node)*: The node_id or gui.get_node(node_id). Will used as user input node.
+	- `[on_swipe_callback]` *(function|nil)*: Swipe callback for on_swipe_end event
+
+- **Returns:**
+	- `swipe` *(druid.swipe)*: The new swipe component
+
+### new_lang_text
+
+---
+```lua
+instance:new_lang_text(node, [locale_id], [adjust_type])
+```
+
+Create LangText component
+
+- **Parameters:**
+	- `node` *(string|node)*: The_node id or gui.get_node(node_id)
+	- `[locale_id]` *(string|nil)*: Default locale id or text from node as default
+	- `[adjust_type]` *(string|nil)*: Adjust type for text node. Default: const.TEXT_ADJUST.DOWNSCALE
+
+- **Returns:**
+	- `lang_text` *(druid.lang_text)*: The new lang text component
+
+### new_slider
+
+---
+```lua
+instance:new_slider(pin_node, end_pos, [callback])
+```
+
+Create Slider component
+
+- **Parameters:**
+	- `pin_node` *(string|node)*: The_node id or gui.get_node(node_id).
+	- `end_pos` *(vector3)*: The end position of slider
+	- `[callback]` *(function|nil)*: On slider change callback
+
+- **Returns:**
+	- `slider` *(druid.slider)*: The new slider component
+
+### new_input
+
+---
+```lua
+instance:new_input(click_node, text_node, [keyboard_type])
+```
+
+Create Input component
+
+- **Parameters:**
+	- `click_node` *(string|node)*: Button node to enabled input component
+	- `text_node` *(string|druid.text|node)*: Text node what will be changed on user input
+	- `[keyboard_type]` *(number|nil)*: Gui keyboard type for input field
+
+- **Returns:**
+	- `input` *(druid.input)*: The new input component
+
+### new_data_list
+
+---
+```lua
+instance:new_data_list(druid_scroll, druid_grid, create_function)
+```
+
+Create DataList component
+
+- **Parameters:**
+	- `druid_scroll` *(druid.scroll)*: The Scroll instance for Data List component
+	- `druid_grid` *(druid.grid)*: The Grid instance for Data List component
+	- `create_function` *(function)*: The create function callback(self, data, index, data_list). Function should return (node, [component])
+
+- **Returns:**
+	- `data_list` *(druid.data_list)*: The new data list component
+
+### new_timer
+
+---
+```lua
+instance:new_timer(node, [seconds_from], [seconds_to], [callback])
+```
+
+Create Timer component
+
+- **Parameters:**
+	- `node` *(string|node)*: Gui text node
+	- `[seconds_from]` *(number|nil)*: Start timer value in seconds
+	- `[seconds_to]` *(number|nil)*: End timer value in seconds
+	- `[callback]` *(function|nil)*: Function on timer end
+
+- **Returns:**
+	- `timer` *(druid.timer)*: The new timer component
+
+### new_progress
+
+---
+```lua
+instance:new_progress(node, key, [init_value])
+```
+
+Create Progress component
+
+- **Parameters:**
+	- `node` *(string|node)*: Progress bar fill node or node name
+	- `key` *(string)*: Progress bar direction: const.SIDE.X or const.SIDE.Y
+	- `[init_value]` *(number|nil)*: Initial value of progress bar. Default: 1
+
+- **Returns:**
+	- `progress` *(druid.progress)*: The new progress component
+
+### new_layout
+
+---
+```lua
+instance:new_layout(node, [mode])
+```
+
+Create Layout component
+
+- **Parameters:**
+	- `node` *(string|node)*: The_node id or gui.get_node(node_id).
+	- `[mode]` *(string|nil)*: vertical|horizontal|horizontal_wrap. Default: horizontal
+
+- **Returns:**
+	- `layout` *(druid.layout)*: The new layout component
+
+### new_container
+
+---
+```lua
+instance:new_container(node, [mode], [callback])
+```
+
+Create Container component
+
+- **Parameters:**
+	- `node` *(string|node)*: The_node id or gui.get_node(node_id).
+	- `[mode]` *(string|nil)*: Layout mode
+	- `[callback]` *(fun(self: druid.container, size: vector3)|nil)*: Callback on size changed
+
+- **Returns:**
+	- `container` *(druid.container)*: The new container component
+
+### new_hotkey
+
+---
+```lua
+instance:new_hotkey(keys_array, [callback], [callback_argument])
+```
+
+Create Hotkey component
+
+- **Parameters:**
+	- `keys_array` *(string|string[])*: Keys for trigger action. Should contains one action key and any amount of modificator keys
+	- `[callback]` *(function|event|nil)*: The callback function
+	- `[callback_argument]` *(any)*: The argument to pass into the callback function
+
+- **Returns:**
+	- `hotkey` *(druid.hotkey)*: The new hotkey component
+
+### new_rich_text
+
+---
+```lua
+instance:new_rich_text(text_node, [value])
+```
+
+Create RichText component.
+
+- **Parameters:**
+	- `text_node` *(string|node)*: The text node to make Rich Text
+	- `[value]` *(string|nil)*: The initial text value. Default will be gui.get_text(text_node)
+
+- **Returns:**
+	- `rich_text` *(druid.rich_text)*: The new rich text component
+
+### new_rich_input
+
+---
+```lua
+instance:new_rich_input(template, [nodes])
+```
+
+Create RichInput component.
+ As a template please check rich_input.gui layout.
+
+- **Parameters:**
+	- `template` *(string)*: The template string name
+	- `[nodes]` *(table|nil)*: Nodes table from gui.clone_tree
+
+- **Returns:**
+	- `rich_input` *(druid.rich_input)*: The new rich input component
+
+
+## Fields
+<a name="components_all"></a>
+- **components_all** (_druid.component[]_): All created components
+
+<a name="components_interest"></a>
+- **components_interest** (_table<string, druid.component[]>_): All components sorted by interest
+

api/quick_api_reference.md

@@ -0,0 +1,678 @@
+# Quick API Reference
+
+# Table of Contents
+1. [Druid](#druid)
+2. [Druid Instance](#druid-instance)
+3. [Components](#components)
+    1. [Base Component](#base-component)
+    2. [Blocker](#blocker)
+    3. [Button](#button)
+    4. [Container](#container)
+    5. [Data List](#data-list)
+    6. [Drag](#drag)
+    7. [Grid](#grid)
+    8. [Hotkey](#hotkey)
+    9. [Hover](#hover)
+    10. [Input](#input)
+    11. [Lang Text](#lang-text)
+    12. [Layout](#layout)
+    13. [Progress](#progress)
+    14. [Rich Input](#rich-input)
+    15. [Rich Text](#rich-text)
+    16. [Scroll](#scroll)
+    17. [Slider](#slider)
+    18. [Swipe](#swipe)
+    19. [Text](#text)
+    20. [Timer](#timer)
+4. [Helper](#helper)
+5. [Widgets](#widgets)
+
+# API Reference
+
+## [Druid](druid_api.md)
+
+Inspect [API Here](druid_api.md)
+
+```lua
+local druid = require("druid.druid")
+
+druid.init_window_listener()
+druid.on_language_change()
+druid.on_window_callback(window_event)
+druid.set_default_style(style)
+druid.set_sound_function(callback)
+druid.set_text_function(callback)
+
+self.druid = druid.new(context, [style])
+```
+
+## [Druid Instance](druid_instance_api.md)
+
+Inspect [API Here](druid_instance_api.md)
+
+```lua
+-- Lifecycle
+self.druid:final()
+self.druid:update(dt)
+self.druid:on_input(action_id, action)
+self.druid:on_message(message_id, message, sender)
+
+-- Custom components
+self.druid:new(component, ...)
+self.druid:new_widget(widget, [template], [nodes], ...)
+
+-- Built-in components
+self.druid:new_button(node, [callback], [params], [anim_node])
+self.druid:new_text(node, [value], [no_adjust])
+self.druid:new_grid(parent_node, item, [in_row])
+self.druid:new_scroll(view_node, content_node)
+self.druid:new_data_list(druid_scroll, druid_grid, create_function)
+self.druid:new_progress(node, key, [init_value])
+self.druid:new_lang_text(node, [locale_id], [adjust_type])
+self.druid:new_rich_text(text_node, [value])
+self.druid:new_back_handler([callback], [params])
+self.druid:new_blocker(node)
+self.druid:new_hover(node, [on_hover_callback], [on_mouse_hover_callback])
+self.druid:new_drag(node, [on_drag_callback])
+self.druid:new_swipe(node, [on_swipe_callback])
+self.druid:new_input(click_node, text_node, [keyboard_type])
+self.druid:new_rich_input(template, [nodes])
+self.druid:new_layout(node, [mode])
+self.druid:new_container(node, [mode], [callback])
+self.druid:new_hotkey(keys_array, [callback], [callback_argument])
+self.druid:new_slider(pin_node, end_pos, [callback])
+self.druid:new_timer(node, [seconds_from], [seconds_to], [callback])
+
+-- Operational
+self.druid:remove(component)
+self.druid:set_blacklist(blacklist_components)
+self.druid:set_whitelist(whitelist_components)
+```
+
+## Components
+
+### [Base Component](components/base/component_api.md)
+
+Inspect [API Here](components/base/component_api.md)
+
+Basic methods for all components and widgets.
+
+```lua
+component:get_childrens()
+component:get_context()
+component:get_druid([template], [nodes])
+component:get_input_priority()
+component:get_node(node_id)
+component:get_nodes()
+component:get_parent_component()
+component:get_template()
+component:reset_input_priority()
+component:set_input_enabled(state)
+component:set_input_priority(value, [is_temporary])
+component:set_nodes(nodes)
+component:set_style([druid_style])
+component:set_template([template])
+
+-- All widgets goes with created Druid instance
+widget.druid
+```
+
+### [Blocker](components/base/blocker_api.md)
+
+Inspect [API Here](components/base/blocker_api.md)
+
+```lua
+local blocker = self.druid:new_blocker(node)
+
+blocker:is_enabled()
+blocker:set_enabled(state)
+```
+
+### [Button](components/base/button_api.md)
+
+Inspect [API Here](components/base/button_api.md)
+
+```lua
+local button = require("druid.base.button")
+
+button:init(node_or_node_id, [callback], [custom_args], [anim_node])
+button:set_animations_disabled()
+button:set_enabled([state])
+button:is_enabled()
+button:set_click_zone([zone])
+button:set_key_trigger(key)
+button:get_key_trigger()
+button:set_check_function([check_function], [failure_callback])
+button:set_web_user_interaction([is_web_mode])
+
+button.on_click
+button.on_pressed
+button.on_repeated_click
+button.on_long_click
+button.on_double_click
+button.on_hold_callback
+button.on_click_outside
+button.node
+button.node_id
+button.anim_node
+button.params
+button.hover
+button.click_zone
+button.start_scale
+button.start_pos
+button.disabled
+button.key_trigger
+button.style
+button.druid
+button.is_repeated_started
+button.last_pressed_time
+button.last_released_time
+button.click_in_row
+button.can_action
+```
+
+### [Container](components/extended/container_api.md)
+
+Inspect [API Here](components/extended/container_api.md)
+
+```lua
+local container = self.druid:new_container(node, [mode], [callback])
+
+container:add_container(node_or_container, [mode], [on_resize_callback])
+container:clear_draggable_corners()
+container:create_draggable_corners()
+container:fit_into_node(node)
+container:fit_into_size(target_size)
+container:fit_into_window()
+container:get_position()
+container:get_scale()
+container:get_size()
+container:on_window_resized()
+container:refresh()
+container:refresh_origins()
+container:refresh_scale()
+container:remove_container_by_node([node])
+container:set_min_size([min_size_x], [min_size_y])
+container:set_parent_container([parent_container])
+container:set_pivot(pivot)
+container:set_position(pos_x, pos_y)
+container:set_size([width], [height], [anchor_pivot])
+container:update_child_containers()
+```
+
+### [Data List](components/extended/data_list_api.md)
+
+Inspect [API Here](components/extended/data_list_api.md)
+
+```lua
+local data_list = self.druid:new_data_list(druid_scroll, druid_grid, create_function)
+
+data_list:add(data, [index], [shift_policy])
+data_list:clear()
+data_list:get_created_components()
+data_list:get_created_nodes()
+data_list:get_data()
+data_list:get_index(data)
+data_list:remove([index], [shift_policy])
+data_list:remove_by_data(data, [shift_policy])
+data_list:scroll_to_index(index)
+data_list:set_data(data)
+data_list:set_use_cache(is_use_cache)
+```
+
+### [Drag](components/base/drag_api.md)
+
+Inspect [API Here](components/base/drag_api.md)
+
+```lua
+local drag = self.druid:new_drag(node, [on_drag_callback])
+
+drag:is_enabled()
+drag:on_window_resized()
+drag:set_click_zone([node])
+drag:set_drag_cursors(is_enabled)
+drag:set_enabled(is_enabled)
+```
+
+### [Grid](components/base/static_grid_api.md)
+
+Inspect [API Here](components/base/static_grid_api.md)
+
+```lua
+local grid = self.druid:new_grid(parent_node, item, [in_row])
+
+grid:add(item, [index], [shift_policy], [is_instant])
+grid:clear()
+grid:get_all_pos()
+grid:get_borders()
+grid:get_index(pos)
+grid:get_index_by_node(node)
+grid:get_offset()
+grid:get_pos(index)
+grid:get_size()
+grid:get_size_for([count])
+grid:refresh()
+grid:remove(index, [shift_policy], [is_instant])
+grid:set_anchor(anchor)
+grid:set_in_row(in_row)
+grid:set_item_size([width], [height])
+grid:set_items(nodes, [is_instant])
+grid:set_pivot([pivot])
+grid:set_position_function(callback)
+grid:sort_nodes(comparator)
+```
+
+### [Hotkey](components/extended/hotkey_api.md)
+
+Inspect [API Here](components/extended/hotkey_api.md)
+
+```lua
+local hotkey = self.druid:new_hotkey(keys_array, [callback], [callback_argument])
+
+hotkey:add_hotkey(keys, [callback_argument])
+hotkey:is_processing()
+hotkey:on_focus_gained()
+hotkey:set_repeat(is_enabled_repeated)
+```
+
+### [Hover](components/base/hover_api.md)
+
+Inspect [API Here](components/base/hover_api.md)
+
+```lua
+local hover = self.druid:new_hover(node, [on_hover_callback], [on_mouse_hover_callback])
+
+hover:is_enabled()
+hover:is_hovered()
+hover:is_mouse_hovered()
+hover:set_click_zone([zone])
+hover:set_enabled([state])
+hover:set_hover([state])
+hover:set_mouse_hover([state])
+```
+
+### [Input](components/extended/input_api.md)
+
+Inspect [API Here](components/extended/input_api.md)
+
+```lua
+local input = self.druid:new_input(click_node, text_node, [keyboard_type])
+
+input:get_text()
+input:get_text_selected()
+input:get_text_selected_replaced(text)
+input:move_selection(delta, is_add_to_selection, is_move_to_end)
+input:on_focus_lost()
+input:reset_changes()
+input:select()
+input:select_cursor([cursor_index], [start_index], [end_index])
+input:set_allowed_characters(characters)
+input:set_max_length(max_length)
+input:set_text(input_text)
+input:unselect()
+```
+
+### [Lang Text](components/extended/lang_text_api.md)
+
+Inspect [API Here](components/extended/lang_text_api.md)
+
+```lua
+local lang_text = self.druid:new_lang_text(node, [locale_id], [adjust_type])
+
+lang_text:format([a], [b], [c], [d], [e], [f], [g])
+lang_text:on_language_change()
+lang_text:set_text(text)
+lang_text:set_to(text)
+lang_text:translate(locale_id, [a], [b], [c], [d], [e], [f], [g])
+```
+
+### [Layout](components/extended/layout_api.md)
+
+Inspect [API Here](components/extended/layout_api.md)
+
+```lua
+local layout = self.druid:new_layout(node, [mode])
+
+layout:add(node_or_node_id)
+layout:calculate_rows_data()
+layout:clear_layout()
+layout:get_content_size()
+layout:get_entities()
+layout:get_node_size(node)
+layout:get_size()
+layout:refresh_layout()
+layout:remove(node_or_node_id)
+layout:set_dirty()
+layout:set_hug_content(is_hug_width, is_hug_height)
+layout:set_justify(is_justify)
+layout:set_margin([margin_x], [margin_y])
+layout:set_node_index([node], [index])
+layout:set_node_position(node, x, y)
+layout:set_padding([padding_x], [padding_y], [padding_z], [padding_w])
+layout:set_type(type)
+layout:update()
+```
+
+### [Progress](components/extended/progress_api.md)
+
+Inspect [API Here](components/extended/progress_api.md)
+
+```lua
+local progress = self.druid:new_progress(node, key, [init_value])
+
+progress:empty()
+progress:fill()
+progress:get()
+progress:set_max_size(max_size)
+progress:set_steps(steps, callback)
+progress:set_to(to)
+progress:to(to, [callback])
+progress:update([dt])
+```
+
+### [Rich Input](components/custom/rich_input_api.md)
+
+Inspect [API Here](components/custom/rich_input_api.md)
+
+```lua
+local rich_input = self.druid:new_rich_input(template, [nodes])
+
+rich_input:get_text()
+rich_input:select()
+rich_input:set_allowed_characters(characters)
+rich_input:set_font(font)
+rich_input:set_placeholder(placeholder_text)
+rich_input:set_text(text)
+```
+
+### [Rich Text](components/custom/rich_text_api.md)
+
+Inspect [API Here](components/custom/rich_text_api.md)
+
+```lua
+local rich_text = self.druid:new_rich_text(text_node, [value])
+
+rich_text:characters(word)
+rich_text:clear()
+rich_text:get_line_metric()
+rich_text:get_text()
+rich_text:get_words()
+rich_text:set_text([text])
+rich_text:tagged(tag)
+```
+
+### [Scroll](components/base/scroll_api.md)
+
+Inspect [API Here](components/base/scroll_api.md)
+
+```lua
+local scroll = self.druid:new_scroll(view_node, content_node)
+
+scroll:bind_grid([grid])
+scroll:get_percent()
+scroll:get_scroll_size()
+scroll:is_inert()
+scroll:is_node_in_view(node)
+scroll:scroll_to(point, [is_instant])
+scroll:scroll_to_index(index, [skip_cb])
+scroll:scroll_to_percent(percent, [is_instant])
+scroll:set_click_zone(node)
+scroll:set_extra_stretch_size([stretch_size])
+scroll:set_horizontal_scroll(state)
+scroll:set_inert(state)
+scroll:set_points(points)
+scroll:set_size(size, [offset])
+scroll:set_vertical_scroll(state)
+scroll:set_view_size(size)
+scroll:update([dt])
+scroll:update_view_size()
+```
+
+### [Slider](components/extended/slider_api.md)
+
+Inspect [API Here](components/extended/slider_api.md)
+
+```lua
+local slider = self.druid:new_slider(pin_node, end_pos, [callback])
+
+slider:is_enabled()
+slider:set(value, [is_silent])
+slider:set_enabled(is_enabled)
+slider:set_input_node([input_node])
+slider:set_steps(steps)
+```
+
+### [Swipe](components/extended/swipe_api.md)
+
+Inspect [API Here](components/extended/swipe_api.md)
+
+```lua
+local swipe = self.druid:new_swipe(node, [on_swipe_callback])
+
+swipe:set_click_zone([zone])
+```
+
+### [Text](components/base/text_api.md)
+
+Inspect [API Here](components/base/text_api.md)
+
+```lua
+local text = self.druid:new_text(node, [value], [no_adjust])
+
+text:get_text()
+text:get_text_adjust()
+text:get_text_index_by_width(width)
+text:get_text_size([text])
+text:is_multiline()
+text:set_alpha(alpha)
+text:set_color(color)
+text:set_minimal_scale(minimal_scale)
+text:set_pivot(pivot)
+text:set_scale(scale)
+text:set_size(size)
+text:set_text([new_text])
+text:set_text_adjust([adjust_type], [minimal_scale])
+text:set_to(set_to)
+```
+
+### [Timer](components/extended/timer_api.md)
+
+Inspect [API Here](components/extended/timer_api.md)
+
+```lua
+local timer = self.druid:new_timer(node, [seconds_from], [seconds_to], [callback])
+
+timer:set_interval(from, to)
+timer:set_state([is_on])
+timer:set_to(set_to)
+timer:update([dt])
+```
+
+## [Helper](druid_helper_api.md)
+
+Inspect [API Here](druid_helper_api.md)
+
+```lua
+local helper = require("druid.helper")
+
+helper.add_array([target], [source])
+helper.centrate_icon_with_text([icon_node], [text_node], [margin])
+helper.centrate_nodes([margin], ...)
+helper.centrate_text_with_icon([text_node], [icon_node], margin)
+helper.clamp(value, [v1], [v2])
+helper.contains([array], [value])
+helper.deepcopy(orig_table)
+helper.distance(x1, y1, x2, y2)
+helper.get_animation_data_from_node(node, atlas_path)
+helper.get_border(node, [offset])
+helper.get_closest_stencil_node(node)
+helper.get_full_position(node, [root])
+helper.get_gui_scale()
+helper.get_node(node_id, [template], [nodes])
+helper.get_pivot_offset(pivot_or_node)
+helper.get_scaled_size(node)
+helper.get_scene_scale(node, [include_passed_node_scale])
+helper.get_screen_aspect_koef()
+helper.get_text_metrics_from_node(text_node)
+helper.insert_with_shift(array, [item], [index], [shift_policy])
+helper.is_mobile()
+helper.is_multitouch_supported()
+helper.is_web()
+helper.is_web_mobile()
+helper.lerp(a, b, t)
+helper.pick_node(node, x, y, [node_click_area])
+helper.remove_with_shift([array], [index], [shift_policy])
+helper.round(num, [num_decimal_places])
+helper.sign(val)
+helper.step(current, target, step)
+helper.table_to_string(t)
+```
+
+## [Widgets](widgets_api.md)
+
+Inspect [API Here](widgets_api.md)
+
+### [FPS Panel](widgets/fps_panel_api.md)
+
+Inspect [API Here](widgets/fps_panel_api.md)
+
+```lua
+local fps_panel = require("druid.widget.fps_panel.fps_panel")
+
+fps_panel:init()
+fps_panel:on_remove()
+fps_panel:update([dt])
+fps_panel:push_fps_value()
+
+fps_panel.root
+fps_panel.delta_time
+fps_panel.collect_time
+fps_panel.collect_time_counter
+fps_panel.graph_samples
+fps_panel.fps_samples
+fps_panel.mini_graph
+fps_panel.text_min_fps
+fps_panel.text_fps
+fps_panel.timer_id
+fps_panel.previous_time
+```
+
+### [Memory Panel](widgets/memory_panel_api.md)
+
+Inspect [API Here](widgets/memory_panel_api.md)
+
+```lua
+local memory_panel = require("druid.widget.memory_panel.memory_panel")
+
+memory_panel:init()
+memory_panel:on_remove()
+memory_panel:set_low_memory_limit([limit])
+memory_panel:push_next_value()
+memory_panel:update_text_memory()
+
+memory_panel.root
+memory_panel.delta_time
+memory_panel.samples_count
+memory_panel.memory_limit
+memory_panel.mini_graph
+memory_panel.max_value
+memory_panel.text_per_second
+memory_panel.text_memory
+memory_panel.memory
+memory_panel.memory_samples
+memory_panel.timer_id
+```
+
+### [Mini Graph](widgets/mini_graph_api.md)
+
+Inspect [API Here](widgets/mini_graph_api.md)
+
+```lua
+local mini_graph = require("druid.widget.mini_graph.mini_graph")
+
+mini_graph:init()
+mini_graph:on_remove()
+mini_graph:clear()
+mini_graph:set_samples([samples])
+mini_graph:get_samples()
+mini_graph:set_line_value(index, value)
+mini_graph:get_line_value([index])
+mini_graph:push_line_value([value])
+mini_graph:set_max_value([max_value])
+mini_graph:set_line_height([index])
+mini_graph:get_lowest_value()
+mini_graph:get_highest_value()
+mini_graph:on_drag_widget([dx], [dy])
+mini_graph:toggle_hide()
+
+mini_graph.root
+mini_graph.text_header
+mini_graph.icon_drag
+mini_graph.content
+mini_graph.layout
+mini_graph.prefab_line
+mini_graph.color_zero
+mini_graph.color_one
+mini_graph.is_hidden
+mini_graph.max_value
+mini_graph.lines
+mini_graph.values
+mini_graph.container
+mini_graph.default_size
+mini_graph.samples
+```
+
+### [Properties Panel](widgets/properties_panel_api.md)
+
+Inspect [API Here](widgets/properties_panel_api.md)
+
+```lua
+local properties_panel = require("druid.widget.properties_panel.properties_panel")
+
+properties_panel:properties_constructors()
+properties_panel:init()
+properties_panel:on_remove()
+properties_panel:on_drag_widget([dx], [dy])
+properties_panel:clear_created_properties()
+properties_panel:clear()
+properties_panel:on_size_changed([new_size])
+properties_panel:update([dt])
+properties_panel:add_checkbox([on_create])
+properties_panel:add_slider([on_create])
+properties_panel:add_button([on_create])
+properties_panel:add_input([on_create])
+properties_panel:add_text([on_create])
+properties_panel:add_left_right_selector([on_create])
+properties_panel:add_vector3([on_create])
+properties_panel:add_inner_widget(widget_class, [template], [nodes], [on_create])
+properties_panel:add_widget(create_widget_callback)
+properties_panel:remove([widget])
+properties_panel:set_hidden([is_hidden])
+properties_panel:is_hidden()
+properties_panel:set_properties_per_page(properties_per_page)
+properties_panel:set_page([page])
+
+properties_panel.root
+properties_panel.scroll
+properties_panel.layout
+properties_panel.container
+properties_panel.container_content
+properties_panel.container_scroll_view
+properties_panel.contaienr_scroll_content
+properties_panel.button_hidden
+properties_panel.text_header
+properties_panel.paginator
+properties_panel.properties
+properties_panel.content
+properties_panel.default_size
+properties_panel.current_page
+properties_panel.properties_per_page
+properties_panel.property_checkbox_prefab
+properties_panel.property_slider_prefab
+properties_panel.property_button_prefab
+properties_panel.property_input_prefab
+properties_panel.property_text_prefab
+properties_panel.property_left_right_selector_prefab
+properties_panel.property_vector3_prefab
+properties_panel.is_dirty
+```

docs/archive/game0.projectc

@@ -213,8 +213,6 @@ max_time_step = 0.5
 
 [druid]
 no_auto_input = 0
-no_stencil_check = 0
-no_auto_template = 0
 input_text = text
 input_touch = touch
 input_marked_text = marked_text

docs/druid/index.html

@@ -1,158 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-	<meta charset="utf-8">
-	<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
-	<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0, minimal-ui, shrink-to-fit=no">
-	<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 1.0</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
-	* drag the selected text but block mouse down/up events to the engine.
-	*/
-	body {
-	
-		position: fixed; /* Prevent overscroll */
-	
-		margin:0;
-		padding:0;
-	}
-
-	.canvas-app-container {
-		width: 100%;
-		height: 100%;
-		position: absolute;
-		align-items: center;
-		justify-content: center;
-		overflow: hidden;
-	}
-
-	.canvas-app-container:-webkit-full-screen {
-		/* Auto width and height in Safari/Chrome fullscreen. */
-		width: auto;
-		height: auto;
-	}
-
-	#canvas {
-		outline: none;
-		border: 0;
-		width: 100%;
-		vertical-align: bottom;
-	}
-
-	#canvas-container {
-		position: relative;
-	}
-
-	canvas:focus, canvas:active {
-		outline: none;
-		border: 0;
-		ie-dummy: expression(this.hideFocus=true);
-		-moz-outline-style: none;
-	}
-
-	body, div {
-		-webkit-tap-highlight-color: rgba(0,0,0,0);
-		-webkit-touch-callout: none;
-		-webkit-user-select: none;
-		-khtml-user-select: none;
-		-moz-user-select: none;
-		-ms-user-select: none;
-		user-select: none;
-	}
-
-		.canvas-app-progress {
-		position: absolute;
-		background-color: #394046;
-		height: 6px;
-		margin-top: -6px;
-		width: 100%;
-	}
-
-	.canvas-app-progress-bar {
-		font-size: 12px;
-		height: 6px;
-		color: rgb(255, 255, 255);
-		background-color: #1a72eb;
-		text-align: center;
-		line-height: 20px;
-		transition: transform 1s ease;
-		transform-origin: left;
-		transform: scaleX(1.0);
-	}
-	.link, .button {
-		font-family: sans-serif;
-		font-size: 14px;
-		font-weight: normal;
-		font-style: normal;
-		font-stretch: normal;
-		line-height: normal;
-		letter-spacing: 0px;
-		padding-top: 12px;
-	}
-
-	.buttons-background {
-		background-color: #1e2226;
-		width: 100%;
-		height: 42px;
-	}
-
-	body {
-		background-color: #1e2226;
-	}
-
-	.canvas-app-container {
-		background: rgba(36,41,46,1);
-		background: -moz-linear-gradient(-45deg, rgba(36,41,46,1) 0%, rgba(36,41,46,1) 49%, rgba(38,43,49,1) 50%, rgba(38,43,49,1) 100%);
-		background: -webkit-gradient(left top, right bottom, color-stop(0%, rgba(36,41,46,1)), color-stop(49%, rgba(36,41,46,1)), color-stop(50%, rgba(38,43,49,1)), color-stop(100%, rgba(38,43,49,1)));
-		background: -webkit-linear-gradient(-45deg, rgba(36,41,46,1) 0%, rgba(36,41,46,1) 49%, rgba(38,43,49,1) 50%, rgba(38,43,49,1) 100%);
-		background: -o-linear-gradient(-45deg, rgba(36,41,46,1) 0%, rgba(36,41,46,1) 49%, rgba(38,43,49,1) 50%, rgba(38,43,49,1) 100%);
-		background: -ms-linear-gradient(-45deg, rgba(36,41,46,1) 0%, rgba(36,41,46,1) 49%, rgba(38,43,49,1) 50%, rgba(38,43,49,1) 100%);
-		background: linear-gradient(135deg, rgba(36,41,46,1) 0%, rgba(36,41,46,1) 49%, rgba(38,43,49,1) 50%, rgba(38,43,49,1) 100%);
-		filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#24292e', endColorstr='#262b31', GradientType=1 );
-	}
-
-	.canvas-app-canvas {
-		background-repeat:no-repeat;
-		background-position: center center;
-		background-image: url("druid_logo.png");
-	}
-	</style>
-</head>
-
-<body>
-
-	<div id="app-container" class="canvas-app-container">
-		<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="webgl-not-supported" style="display: none; margin: 3em;">
-			<h1>WebGL not supported ⚠️</h1>
-			<p>WebGL is not supported by your browser - visit <a href="https://get.webgl.org/">https://get.webgl.org/</a> to learn more.</p>
-		</div>
-		<div id="canvas-container" class="canvas-app-canvas-container">
-			<canvas id="canvas" class="canvas-app-canvas" tabindex="1" width="1920" height="1080"></canvas>
-		</div>
-		<div class="buttons-background">
-		</div>
-	</div>
-	<!-- -->
-	<script id='engine-loader' type='text/javascript' src="dmloader.js"></script>
-
-	<script id='engine-start' type='text/javascript'>
-		var runningFromFileWarning = document.getElementById("running-from-file-warning");
-		if (window.location.href.startsWith("file://")) {
-			runningFromFileWarning.style.display = "block";
-		}
-		else {
-			EngineLoader.load("canvas", "druid");
-			runningFromFileWarning.parentNode.removeChild(runningFromFileWarning);
-		}
-	</script>
-</body>
-</html>

docs/index.html

@@ -1,186 +1,158 @@
-<!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"/>
+<!DOCTYPE html>
+<html lang="en">
 <head>
-    <title>Defold Druid UI Framework</title>
-    <link rel="stylesheet" href="ldoc_fixed.css" type="text/css" />
+	<meta charset="utf-8">
+	<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+	<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0, minimal-ui, shrink-to-fit=no">
+	<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 1.0</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
+	* drag the selected text but block mouse down/up events to the engine.
+	*/
+	body {
+	
+		position: fixed; /* Prevent overscroll */
+	
+		margin:0;
+		padding:0;
+	}
+
+	.canvas-app-container {
+		width: 100%;
+		height: 100%;
+		position: absolute;
+		align-items: center;
+		justify-content: center;
+		overflow: hidden;
+	}
+
+	.canvas-app-container:-webkit-full-screen {
+		/* Auto width and height in Safari/Chrome fullscreen. */
+		width: auto;
+		height: auto;
+	}
+
+	#canvas {
+		outline: none;
+		border: 0;
+		width: 100%;
+		vertical-align: bottom;
+	}
+
+	#canvas-container {
+		position: relative;
+	}
+
+	canvas:focus, canvas:active {
+		outline: none;
+		border: 0;
+		ie-dummy: expression(this.hideFocus=true);
+		-moz-outline-style: none;
+	}
+
+	body, div {
+		-webkit-tap-highlight-color: rgba(0,0,0,0);
+		-webkit-touch-callout: none;
+		-webkit-user-select: none;
+		-khtml-user-select: none;
+		-moz-user-select: none;
+		-ms-user-select: none;
+		user-select: none;
+	}
+
+		.canvas-app-progress {
+		position: absolute;
+		background-color: #394046;
+		height: 6px;
+		margin-top: -6px;
+		width: 100%;
+	}
+
+	.canvas-app-progress-bar {
+		font-size: 12px;
+		height: 6px;
+		color: rgb(255, 255, 255);
+		background-color: #1a72eb;
+		text-align: center;
+		line-height: 20px;
+		transition: transform 1s ease;
+		transform-origin: left;
+		transform: scaleX(1.0);
+	}
+	.link, .button {
+		font-family: sans-serif;
+		font-size: 14px;
+		font-weight: normal;
+		font-style: normal;
+		font-stretch: normal;
+		line-height: normal;
+		letter-spacing: 0px;
+		padding-top: 12px;
+	}
+
+	.buttons-background {
+		background-color: #1e2226;
+		width: 100%;
+		height: 42px;
+	}
+
+	body {
+		background-color: #1e2226;
+	}
+
+	.canvas-app-container {
+		background: rgba(36,41,46,1);
+		background: -moz-linear-gradient(-45deg, rgba(36,41,46,1) 0%, rgba(36,41,46,1) 49%, rgba(38,43,49,1) 50%, rgba(38,43,49,1) 100%);
+		background: -webkit-gradient(left top, right bottom, color-stop(0%, rgba(36,41,46,1)), color-stop(49%, rgba(36,41,46,1)), color-stop(50%, rgba(38,43,49,1)), color-stop(100%, rgba(38,43,49,1)));
+		background: -webkit-linear-gradient(-45deg, rgba(36,41,46,1) 0%, rgba(36,41,46,1) 49%, rgba(38,43,49,1) 50%, rgba(38,43,49,1) 100%);
+		background: -o-linear-gradient(-45deg, rgba(36,41,46,1) 0%, rgba(36,41,46,1) 49%, rgba(38,43,49,1) 50%, rgba(38,43,49,1) 100%);
+		background: -ms-linear-gradient(-45deg, rgba(36,41,46,1) 0%, rgba(36,41,46,1) 49%, rgba(38,43,49,1) 50%, rgba(38,43,49,1) 100%);
+		background: linear-gradient(135deg, rgba(36,41,46,1) 0%, rgba(36,41,46,1) 49%, rgba(38,43,49,1) 50%, rgba(38,43,49,1) 100%);
+		filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#24292e', endColorstr='#262b31', GradientType=1 );
+	}
+
+	.canvas-app-canvas {
+		background-repeat:no-repeat;
+		background-position: center center;
+		background-image: url("druid_logo.png");
+	}
+	</style>
 </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>
-
-
-
-
-<h2>Modules</h2>
-<ul class="nowrap">
-  <li><a href="modules/BackHandler.html">BackHandler</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/Text.html">Text</a></li>
-  <li><a href="modules/BaseComponent.html">BaseComponent</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/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/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/Helper.html">Helper</a></li>
-  <li><a href="modules/DruidInstance.html">DruidInstance</a></li>
-</ul>
-
+	<div id="app-container" class="canvas-app-container">
+		<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="webgl-not-supported" style="display: none; margin: 3em;">
+			<h1>WebGL not supported ⚠️</h1>
+			<p>WebGL is not supported by your browser - visit <a href="https://get.webgl.org/">https://get.webgl.org/</a> to learn more.</p>
+		</div>
+		<div id="canvas-container" class="canvas-app-canvas-container">
+			<canvas id="canvas" class="canvas-app-canvas" tabindex="1" width="1920" height="1080"></canvas>
+		</div>
+		<div class="buttons-background">
+		</div>
+	</div>
+	<!-- -->
+	<script id='engine-loader' type='text/javascript' src="dmloader.js"></script>
 
-<div id="content">
-
-
-  <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 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 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">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>
-		<td class="summary">Component to handle drag action on node.</td>
-	</tr>
-	<tr>
-		<td class="name"  nowrap><a href="modules/Hover.html">Hover</a></td>
-		<td class="summary">Component to handle hover node interaction</td>
-	</tr>
-	<tr>
-		<td class="name"  nowrap><a href="modules/Scroll.html">Scroll</a></td>
-		<td class="summary">Component to handle scroll content.</td>
-	</tr>
-	<tr>
-		<td class="name"  nowrap><a href="modules/StaticGrid.html">StaticGrid</a></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 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/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">Druid Event Module
-<p> The Event module provides a simple class for handling callbacks.</td>
-	</tr>
-	<tr>
-		<td class="name"  nowrap><a href="modules/DataList.html">DataList</a></td>
-		<td class="summary">Component to manage data for huge dataset in scroll.</td>
-	</tr>
-	<tr>
-		<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 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">Druid component to handle the progress bars.</td>
-	</tr>
-	<tr>
-		<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/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">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 TESTING</a></i>
-<i style="float:right;">Last updated 2015-01-01 12:00:00 </i>
-</div> <!-- id="about" -->
-</div> <!-- id="container" -->
+	<script id='engine-start' type='text/javascript'>
+		var runningFromFileWarning = document.getElementById("running-from-file-warning");
+		if (window.location.href.startsWith("file://")) {
+			runningFromFileWarning.style.display = "block";
+		}
+		else {
+			EngineLoader.load("canvas", "druid");
+			runningFromFileWarning.parentNode.removeChild(runningFromFileWarning);
+		}
+	</script>
 </body>
 </html>

docs/ldoc_fixed.css

@@ -1,311 +0,0 @@
-/* BEGIN RESET
-
-Copyright (c) 2010, Yahoo! Inc. All rights reserved.
-Code licensed under the BSD License:
-http://developer.yahoo.com/yui/license.html
-version: 2.8.2r1
-*/
-html {
-    color: #000;
-    background: #FFF;
-}
-body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td {
-    margin: 0;
-    padding: 0;
-}
-table {
-    border-collapse: collapse;
-    border-spacing: 0;
-}
-fieldset,img {
-    border: 0;
-}
-address,caption,cite,code,dfn,em,strong,th,var,optgroup {
-    font-style: inherit;
-    font-weight: inherit;
-}
-del,ins {
-    text-decoration: none;
-}
-li {
-    margin-left: 20px;
-}
-caption,th {
-    text-align: left;
-}
-h1,h2,h3,h4,h5,h6 {
-    font-size: 100%;
-    font-weight: bold;
-}
-q:before,q:after {
-    content: '';
-}
-abbr,acronym {
-    border: 0;
-    font-variant: normal;
-}
-sup {
-    vertical-align: baseline;
-}
-sub {
-    vertical-align: baseline;
-}
-legend {
-    color: #000;
-}
-input,button,textarea,select,optgroup,option {
-    font-family: inherit;
-    font-size: inherit;
-    font-style: inherit;
-    font-weight: inherit;
-}
-input,button,textarea,select {*font-size:100%;
-}
-/* END RESET */
-
-body {
-    margin-left: 1em;
-    margin-right: 1em;
-    font-family: arial, helvetica, geneva, sans-serif;
-    background-color: #ffffff; margin: 0px;
-}
-
-code, tt { font-family: monospace; font-size: 1.1em; }
-span.parameter { font-family:monospace; }
-span.parameter:after { content:":"; }
-span.types:before { content:"("; }
-span.types:after { content:")"; }
-.type { font-weight: bold; font-style:italic }
-
-body, p, td, th { font-size: .95em; line-height: 1.2em;}
-
-p, ul { margin: 10px 0 0 0px;}
-
-strong { font-weight: bold;}
-
-em { font-style: italic;}
-
-h1 {
-    font-size: 1.5em;
-    margin: 0 0 20px 0;
-}
-h2, h3, h4 { margin: 15px 0 10px 0; }
-h2 { font-size: 1.25em; }
-h3 { font-size: 1.15em; }
-h4 { font-size: 1.06em; }
-
-a:link { font-weight: bold; color: #004080; text-decoration: none; }
-a:visited { font-weight: bold; color: #006699; text-decoration: none; }
-a:link:hover { text-decoration: underline; }
-
-hr {
-    color:#cccccc;
-    background: #00007f;
-    height: 1px;
-}
-
-blockquote { margin-left: 3em; }
-
-ul { list-style-type: disc; }
-
-p.name {
-    font-family: "Andale Mono", monospace;
-    padding-top: 1em;
-}
-
-pre {
-    background-color: rgb(245, 245, 245);
-    border: 1px solid #C0C0C0; /* silver */
-    padding: 10px;
-    margin: 10px 0 10px 0;
-    overflow: auto;
-    font-family: "Andale Mono", monospace;
-}
-
-pre.example {
-    font-size: .85em;
-}
-
-table.index { border: 1px #00007f; }
-table.index td { text-align: left; vertical-align: top; }
-
-#container {
-    margin-left: 1em;
-    margin-right: 1em;
-    background-color: #ffffff;
-}
-
-#product {
-    text-align: center;
-    border-bottom: 1px solid #cccccc;
-    background-color: #ffffff;
-}
-
-#product big {
-    font-size: 2em;
-}
-
-#main {
-    background-color:#FFFFFF; // #f0f0f0;
-    border-left: 1px solid #cccccc;
-}
-
-#navigation {
-    position: fixed;
-    top: 0;
-    left: 0;
-    float: left;
-    width: 14em;
-    vertical-align: top;
-    background-color:#FFFFFF; // #f0f0f0;
-    border-right: 2px solid #cccccc;
-    overflow: visible;
-    overflow-y: scroll;
-    height: 100%;
-    padding-left: 1em;
-}
-
-#navigation h2 {
-    background-color:#FFFFFF;//:#e7e7e7;
-    font-size:1.1em;
-    color:#000000;
-    text-align: left;
-    padding:0.2em;
-    border-bottom:1px solid #dddddd;
-}
-
-#navigation ul
-{
-    font-size:1em;
-    list-style-type: none;
-    margin: 1px 1px 10px 1px;
-}
-
-#navigation li {
-    text-indent: -1em;
-    display: block;
-    margin: 3px 0px 0px 22px;
-}
-
-#navigation li li a {
-    margin: 0px 3px 0px -1em;
-}
-
-#content {
-    margin-left: 14em;
-    padding: 1em;
-    padding-left: 2em;
-    width: 900px;
-    border-left: 2px solid #cccccc;
-   // border-right: 2px solid #cccccc;
-    background-color: #ffffff;
-}
-
-#about {
-    clear: both;
-    padding-left: 1em;
-    margin-left: 14em; // avoid the damn sidebar!
-    border-top: 2px solid #cccccc;
-    border-left: 2px solid #cccccc;
-    background-color: #ffffff;
-}
-
-@media print {
-    body {
-        font: 12pt "Times New Roman", "TimeNR", Times, serif;
-    }
-    a { font-weight: bold; color: #004080; text-decoration: underline; }
-
-    #main {
-        background-color: #ffffff;
-        border-left: 0px;
-    }
-
-    #container {
-        margin-left: 2%;
-        margin-right: 2%;
-        background-color: #ffffff;
-    }
-
-    #content {
-        padding: 1em;
-        background-color: #ffffff;
-    }
-
-    #navigation {
-        display: none;
-    }
-    pre.example {
-        font-family: "Andale Mono", monospace;
-        font-size: 10pt;
-        page-break-inside: avoid;
-    }
-}
-
-table.module_list {
-    border-width: 1px;
-    border-style: solid;
-    border-color: #cccccc;
-    border-collapse: collapse;
-}
-table.module_list td {
-    border-width: 1px;
-    padding: 3px;
-    border-style: solid;
-    border-color: #cccccc;
-}
-table.module_list td.name { background-color: #f0f0f0; ; min-width: 200px; }
-table.module_list td.summary { width: 100%; }
-
-table.function_list {
-    border-width: 1px;
-    border-style: solid;
-    border-color: #cccccc;
-    border-collapse: collapse;
-}
-table.function_list td {
-    border-width: 1px;
-    padding: 3px;
-    border-style: solid;
-    border-color: #cccccc;
-}
-table.function_list td.name { background-color: #f6f6ff; ; min-width: 200px; }
-table.function_list td.summary { width: 100%; }
-
-dl.table dt, dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;}
-dl.table dd, dl.function dd {padding-bottom: 1em; margin: 10px 0 0 20px;}
-dl.table h3, dl.function h3 {font-size: .95em;}
-
-ul.nowrap {
-    overflow:auto;
-    whitespace:nowrap;
-}
-
-/* stop sublists from having initial vertical space */
-ul ul { margin-top: 0px; }
-ol ul { margin-top: 0px; }
-ol ol { margin-top: 0px; }
-ul ol { margin-top: 0px; }
-
-/* make the target distinct; helps when we're navigating to a function */
-a:target + * {
-  background-color: #FF9;
-}
-
-
-/* styles for prettification of source */
-pre .comment { color: #558817; }
-pre .constant { color: #a8660d; }
-pre .escape { color: #844631; }
-pre .keyword { color: #aa5050; font-weight: bold; }
-pre .library { color: #0e7c6b; }
-pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; }
-pre .string { color: #8080ff; }
-pre .number { color: #f8660d; }
-pre .operator { color: #2239a8; font-weight: bold; }
-pre .preprocessor, pre .prepro { color: #a33243; }
-pre .global { color: #800080; }
-pre .user-keyword { color: #800080; }
-pre .prompt { color: #558817; }
-pre .url { color: #272fc2; text-decoration: underline; }
-

docs/modules/BackHandler.html

@@ -1,172 +0,0 @@
-<!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="#Fields">Fields</a></li>
-</ul>
-
-
-<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/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/Progress.html">Progress</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>BackHandler</code></h1>
-<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="#Fields">Fields</a></h2>
-<table class="function_list">
-	<tr>
-	<td class="name" nowrap><a href="#on_back">on_back</a></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">Custom args to pass in the callback</td>
-	</tr>
-</table>
-
-<br/>
-<br/>
-
-
-    <h2 class="section-header "><a name="Fields"></a>Fields</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "on_back"></a>
-    <strong>on_back</strong>
-    </dt>
-    <dd>
-    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">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>
-    <a name = "params"></a>
-    <strong>params</strong>
-    </dt>
-    <dd>
-    Custom args to pass in the callback
-
-
-    <ul>
-        <li><span class="parameter">params</span>
-            <span class="types"><span class="type">any</span> or <span class="type">nil</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-    <h3>Usage:</h3>
-    <ul>
-        <pre class="example"><span class="comment">-- Replace params on runtime:
-</span>back_handler.params = { ... }</pre>
-    </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/BaseComponent.html

@@ -1,549 +0,0 @@
-<!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><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/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/Progress.html">Progress</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>BaseComponent</code></h1>
-<p>Basic class for all Druid components.</p>
-<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="#get_childrens">get_childrens(self)</a></td>
-	<td class="summary">Return all children components, recursive</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#get_context">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="#get_druid">get_druid(self, template, nodes)</a></td>
-	<td class="summary">Get Druid instance for inner component creation.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#get_input_priority">get_input_priority(self)</a></td>
-	<td class="summary">Return component input priority</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_node">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="#get_parent_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="#get_parent_name">get_parent_name(self)</a></td>
-	<td class="summary">Return parent component name</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#get_template">get_template(self)</a></td>
-	<td class="summary">Get current component template name.</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="#reset_input_priority">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="#set_input_enabled">set_input_enabled(self, state)</a></td>
-	<td class="summary">Set component input state.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#set_input_priority">set_input_priority(self, value, is_temporary)</a></td>
-	<td class="summary">Set component input priority</td>
-	</tr>
-</table>
-
-<br/>
-<br/>
-
-
-    <h2 class="section-header "><a name="Functions"></a>Functions</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "get_childrens"></a>
-    <strong>get_childrens(self)</strong>
-    </dt>
-    <dd>
-    Return all children components, recursive
-
-
-    <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>
-        Array of childrens if the Druid component instance
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "get_context"></a>
-    <strong>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>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "get_druid"></a>
-    <strong>get_druid(self, template, nodes)</strong>
-    </dt>
-    <dd>
-    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>
-        <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> or <span class="type">nil</span></span>
-         The 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> or <span class="type">nil</span></span>
-         The nodes table
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">DruidInstance</span></span>
-        Druid instance with component context
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "get_input_priority"></a>
-    <strong>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 = "get_name"></a>
-    <strong>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 = "get_node"></a>
-    <strong>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.1/manual.html#5.4">string</a> or <span class="type">node</span></span>
-         Node name or node itself
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">node</span></span>
-        Gui node
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "get_parent_component"></a>
-    <strong>get_parent_component(self)</strong>
-    </dt>
-    <dd>
-    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">BaseComponent</span> or <span class="type">nil</span></span>
-        The druid component instance or nil
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "get_parent_name"></a>
-    <strong>get_parent_name(self)</strong>
-    </dt>
-    <dd>
-    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.1/manual.html#5.4">string</a> or <span class="type">nil</span></span>
-        The parent component name if exist or bil
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "get_template"></a>
-    <strong>get_template(self)</strong>
-    </dt>
-    <dd>
-    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"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
-        Component full template name
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "get_uid"></a>
-    <strong>get_uid(self)</strong>
-    </dt>
-    <dd>
-    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>
-         <a href="../modules/BaseComponent.html#">BaseComponent</a>
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">number</span></span>
-        The component uid
-    </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>
-         <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 = "set_input_enabled"></a>
-    <strong>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">boolean</span> or <span class="type">nil</span></span>
-         The component input state
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">BaseComponent</span></span>
-        BaseComponent itself
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_input_priority"></a>
-    <strong>set_input_priority(self, value, is_temporary)</strong>
-    </dt>
-    <dd>
-    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> or <span class="type">nil</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">number</span></span>
-        The component input priority
-    </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/Blocker.html

@@ -1,233 +0,0 @@
-<!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><strong>Blocker</strong></li>
-  <li><a href="../modules/Button.html">Button</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/Progress.html">Progress</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>Blocker</code></h1>
-<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">The <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 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">Blocker 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, node)</strong>
-    </dt>
-    <dd>
-    The <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>
-         Gui node
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "is_enabled"></a>
-    <strong>is_enabled(self)</strong>
-    </dt>
-    <dd>
-    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>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">boolean</span></span>
-        @True, if blocker is enabled
-    </ol>
-
-
-
-
-</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">boolean</span> or <span class="type">nil</span></span>
-         Enabled state
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-</dl>
-    <h2 class="section-header "><a name="Fields"></a>Fields</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "node"></a>
-    <strong>node</strong>
-    </dt>
-    <dd>
-    Blocker node
-
-
-    <ul>
-        <li><span class="parameter">node</span>
-            <span class="types"><a class="type" href="../modules/Blocker.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/Button.html

@@ -1,880 +0,0 @@
-<!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><strong>Button</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/Progress.html">Progress</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>Button</code></h1>
-<p>Druid Component for Handling User Click Interactions: Click, Long Click, Double Click, and More.</p>
-<p>
-<p> <b># Overview #</b>
-<p> 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.
-<p> <b># Notes #</b>
-<p> • The click callback will not trigger if the cursor moves outside the node's
- area between the pressed and released states.
-<p> • If a button has a double click event subscriber and the double click event is triggered,
- the regular click callback will not be triggered.
-<p> • Buttons can be triggered using a keyboard key by calling the button:set_key_trigger method.
-<p> • 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."
-<p> <a href="https://insality.github.io/druid/druid/index.html?example=general_buttons" target="_blank"><b>Example Link</b></a></p>
-    <h3>Usage:</h3>
-    <ul>
-        <pre class="example">local function on_button_click(self, args, button)
-    print(&quot;Button has clicked with params: &quot; .. args)
-    print(&quot;Also the button component is passed in callback params&quot;)
-end
-
-local custom_args = &quot;Any variable to pass inside callback&quot;
-local button = self.druid:new_button(&quot;button_name&quot;, on_button_click, custom_args)
-</pre>
-    </ul>
-
-
-<h2><a href="#Functions">Functions</a></h2>
-<table class="function_list">
-	<tr>
-	<td class="name" nowrap><a href="#get_key_trigger">get_key_trigger(self)</a></td>
-	<td class="summary">Get current key name to trigger this button.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#init">init(self, node, callback, custom_args, anim_node)</a></td>
-	<td class="summary">The <a href="../modules/Button.html#">Button</a> constructor</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#is_enabled">is_enabled(self)</a></td>
-	<td class="summary">Get button enabled state.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#set_check_function">set_check_function(self, check_function, failure_callback)</a></td>
-	<td class="summary">Set function for additional check for button click availability</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#set_click_zone">set_click_zone(self, zone)</a></td>
-	<td class="summary">Set additional button click area.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#set_enabled">set_enabled(self, state)</a></td>
-	<td class="summary">Set button enabled state.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#set_key_trigger">set_key_trigger(self, key)</a></td>
-	<td class="summary">Set key name to trigger this button by keyboard.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#set_web_user_interaction">set_web_user_interaction(self, is_web_mode)</a></td>
-	<td class="summary">Set Button mode to work inside user HTML5 interaction event.</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="#anim_node">anim_node</a></td>
-	<td class="summary">Button animation node.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#click_zone">click_zone</a></td>
-	<td class="summary">Additional button click area, defined by another GUI node</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#hover">hover</a></td>
-	<td class="summary">The <a href="../modules/Hover.html#">Hover</a>: Button Hover component</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#node">node</a></td>
-	<td class="summary">Button trigger node</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#node_id">node_id</a></td>
-	<td class="summary">The GUI node id from button node</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#on_click">on_click</a></td>
-	<td class="summary">The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event on successful release action over button.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#on_click_outside">on_click_outside</a></td>
-	<td class="summary">The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event calls if click event was outside of button.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#on_double_click">on_double_click</a></td>
-	<td class="summary">The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event on double tap action over button.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#on_hold_callback">on_hold_callback</a></td>
-	<td class="summary">The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event calls every frame before on_long_click event.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#on_long_click">on_long_click</a></td>
-	<td class="summary">The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event on long tap action over button.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#on_pressed">on_pressed</a></td>
-	<td class="summary">The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event triggered if button was pressed by user.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#on_repeated_click">on_repeated_click</a></td>
-	<td class="summary">The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event on repeated action over button.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#params">params</a></td>
-	<td class="summary">Custom args for any Button event.</td>
-	</tr>
-</table>
-
-<br/>
-<br/>
-
-
-    <h2 class="section-header "><a name="Functions"></a>Functions</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "get_key_trigger"></a>
-    <strong>get_key_trigger(self)</strong>
-    </dt>
-    <dd>
-    Get current key name to trigger this button.
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">Button</span></span>
-
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">hash</span></span>
-        The action_id of the input key
-    </ol>
-
-
-
-    <h3>Usage:</h3>
-    <ul>
-        <pre class="example"><span class="keyword">local</span> key_hash = button:get_key_trigger()</pre>
-    </ul>
-
-</dd>
-    <dt>
-    <a name = "init"></a>
-    <strong>init(self, node, callback, custom_args, anim_node)</strong>
-    </dt>
-    <dd>
-    The <a href="../modules/Button.html#">Button</a> constructor
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">Button</span></span>
-         <a href="../modules/Button.html#">Button</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/Button.html#node">node</a></span>
-         The node_id or gui.get_node(node_id)
-        </li>
-        <li><span class="parameter">callback</span>
-            <span class="types"><span class="type">function</span></span>
-         On click button callback
-        </li>
-        <li><span class="parameter">custom_args</span>
-            <span class="types"><span class="type">any</span> or <span class="type">nil</span></span>
-         Button events custom arguments
-        </li>
-        <li><span class="parameter">anim_node</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a>, <a class="type" href="../modules/Button.html#node">node</a> or <span class="type">nil</span></span>
-         Node to animate instead of trigger node.
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "is_enabled"></a>
-    <strong>is_enabled(self)</strong>
-    </dt>
-    <dd>
-    Get button enabled state.
-<p> By default all Buttons is enabled on creating.
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">Button</span></span>
-         <a href="../modules/Button.html#">Button</a>
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">boolean</span></span>
-        @True, if button is enabled now, False overwise
-    </ol>
-
-
-
-    <h3>Usage:</h3>
-    <ul>
-        <pre class="example"><span class="keyword">local</span> is_enabled = button:is_enabled()</pre>
-    </ul>
-
-</dd>
-    <dt>
-    <a name = "set_check_function"></a>
-    <strong>set_check_function(self, check_function, failure_callback)</strong>
-    </dt>
-    <dd>
-    Set function for additional check for button click availability
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">Button</span></span>
-
-        </li>
-        <li><span class="parameter">check_function</span>
-            <span class="types"><span class="type">function</span> or <span class="type">nil</span></span>
-         Should return true or false. If true - button can be pressed.
-        </li>
-        <li><span class="parameter">failure_callback</span>
-            <span class="types"><span class="type">function</span> or <span class="type">nil</span></span>
-         Function will be called on button click, if check function return false
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">Button</span></span>
-        Current button instance
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_click_zone"></a>
-    <strong>set_click_zone(self, zone)</strong>
-    </dt>
-    <dd>
-    Set additional button click area.
- Useful to restrict click outside out stencil node or scrollable content.
-<p> This functions calls automatically if you don't disable it in game.project: druid.no_stencil_check
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">Button</span></span>
-         <a href="../modules/Button.html#">Button</a>
-        </li>
-        <li><span class="parameter">zone</span>
-            <span class="types"><a class="type" href="../modules/Button.html#node">node</a>, <a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a> or <span class="type">nil</span></span>
-         Gui node
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">Button</span></span>
-        Current button instance
-    </ol>
-
-
-
-    <h3>Usage:</h3>
-    <ul>
-        <pre class="example">button:set_click_zone(<span class="string">"stencil_node"</span>)</pre>
-    </ul>
-
-</dd>
-    <dt>
-    <a name = "set_enabled"></a>
-    <strong>set_enabled(self, state)</strong>
-    </dt>
-    <dd>
-    Set button enabled state.
- The style.on_set_enabled will be triggered.
- Disabled button is not clickable.
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">Button</span></span>
-         <a href="../modules/Button.html#">Button</a>
-        </li>
-        <li><span class="parameter">state</span>
-            <span class="types"><span class="type">boolean</span> or <span class="type">nil</span></span>
-         Enabled state
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">Button</span></span>
-        Current button instance
-    </ol>
-
-
-
-    <h3>Usage:</h3>
-    <ul>
-        <pre class="example">button:set_enabled(<span class="keyword">false</span>)
-button:set_enabled(<span class="keyword">true</span>)</pre>
-    </ul>
-
-</dd>
-    <dt>
-    <a name = "set_key_trigger"></a>
-    <strong>set_key_trigger(self, key)</strong>
-    </dt>
-    <dd>
-    Set key name to trigger this button by keyboard.
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">Button</span></span>
-         <a href="../modules/Button.html#">Button</a>
-        </li>
-        <li><span class="parameter">key</span>
-            <span class="types"><span class="type">hash</span> or <a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
-         The action_id of the input key
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">Button</span></span>
-        Current button instance
-    </ol>
-
-
-
-    <h3>Usage:</h3>
-    <ul>
-        <pre class="example">button:set_key_trigger(<span class="string">"key_space"</span>)</pre>
-    </ul>
-
-</dd>
-    <dt>
-    <a name = "set_web_user_interaction"></a>
-    <strong>set_web_user_interaction(self, is_web_mode)</strong>
-    </dt>
-    <dd>
-    Set Button mode to work inside user HTML5 interaction event.
-<p> 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.
-<p> If the game is not HTML, html mode will be not enabled
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">Button</span></span>
-
-        </li>
-        <li><span class="parameter">is_web_mode</span>
-            <span class="types"><span class="type">boolean</span> or <span class="type">nil</span></span>
-         If true - button will be called inside html5 callback
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">Button</span></span>
-        Current button instance
-    </ol>
-
-
-
-    <h3>Usage:</h3>
-    <ul>
-        <pre class="example">button:set_web_user_interaction(<span class="keyword">true</span>)</pre>
-    </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">LONGTAP_TIME</span>
-            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
-         Minimum time to trigger on_hold_callback. Default: 0.4
-        </li>
-        <li><span class="parameter">AUTOHOLD_TRIGGER</span>
-            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
-         Maximum hold time to trigger button release while holding. Default: 0.8
-        </li>
-        <li><span class="parameter">DOUBLETAP_TIME</span>
-            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
-         Time between double taps. Default: 0.4
-        </li>
-        <li><span class="parameter">on_click</span>
-            <span class="types"><span class="type">function</span></span>
-         function(self, node)
-        </li>
-        <li><span class="parameter">on_click_disabled</span>
-            <span class="types"><span class="type">function</span></span>
-         function(self, node)
-        </li>
-        <li><span class="parameter">on_hover</span>
-            <span class="types"><span class="type">function</span></span>
-         function(self, node, hover_state)
-        </li>
-        <li><span class="parameter">on_mouse_hover</span>
-            <span class="types"><span class="type">function</span></span>
-         function(self, node, hover_state)
-        </li>
-        <li><span class="parameter">on_set_enabled</span>
-            <span class="types"><span class="type">function</span></span>
-         function(self, node, enabled_state)
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-</dl>
-    <h2 class="section-header "><a name="Fields"></a>Fields</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "anim_node"></a>
-    <strong>anim_node</strong>
-    </dt>
-    <dd>
-    Button animation node.
- In default case equals to clickable node.
-<p> Usecase: You have the big clickable panel, but want to animate only one small icon on it.
-
-
-    <ul>
-        <li><span class="parameter">anim_node</span>
-            <span class="types"><a class="type" href="../modules/Button.html#node">node</a> or <span class="type">nil</span></span>
-         Default node
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "click_zone"></a>
-    <strong>click_zone</strong>
-    </dt>
-    <dd>
-    Additional button click area, defined by another GUI node
-
-
-    <ul>
-        <li><span class="parameter">click_zone</span>
-            <span class="types"><a class="type" href="../modules/Button.html#node">node</a> or <span class="type">nil</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "hover"></a>
-    <strong>hover</strong>
-    </dt>
-    <dd>
-    The <a href="../modules/Hover.html#">Hover</a>: Button Hover component
-
-
-    <ul>
-        <li><span class="parameter">hover</span>
-            <span class="types"><span class="type">Hover</span></span>
-         <a href="../modules/Hover.html#">Hover</a>
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "node"></a>
-    <strong>node</strong>
-    </dt>
-    <dd>
-    Button trigger node
-
-
-    <ul>
-        <li><span class="parameter">node</span>
-            <span class="types"><a class="type" href="../modules/Button.html#node">node</a></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "node_id"></a>
-    <strong>node_id</strong>
-    </dt>
-    <dd>
-    The GUI node id from button 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_click"></a>
-    <strong>on_click</strong>
-    </dt>
-    <dd>
-    The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event on successful release action over button.
-
-
-    <ul>
-        <li><span class="parameter">on_click</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">-- Custom args passed in Button constructor
-</span>button.on_click:subscribe(<span class="keyword">function</span>(self, custom_args, button_instance)
-    <span class="global">print</span>(<span class="string">"On button click!"</span>)
-<span class="keyword">end</span>)</pre>
-    </ul>
-
-</dd>
-    <dt>
-    <a name = "on_click_outside"></a>
-    <strong>on_click_outside</strong>
-    </dt>
-    <dd>
-    The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event calls if click event was outside of button.
-<p> This event will be triggered for each button what was not clicked on user click action
-<p> Usecase: Hide the popup when click outside
-
-
-    <ul>
-        <li><span class="parameter">on_click_outside</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">-- Custom args passed in Button constructor
-</span>button.on_click_outside:subscribe(<span class="keyword">function</span>(self, custom_args, button_instance)
-    <span class="global">print</span>(<span class="string">"On click Button outside!"</span>)
-<span class="keyword">end</span>)</pre>
-    </ul>
-
-</dd>
-    <dt>
-    <a name = "on_double_click"></a>
-    <strong>on_double_click</strong>
-    </dt>
-    <dd>
-    The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event on double tap action over button.
-<p> If secondary click was too fast after previous one, the double
- click will be called instead usual click (if on_double_click subscriber exists)
-
-
-    <ul>
-        <li><span class="parameter">on_double_click</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">-- Custom args passed in Button constructor
-</span>button.on_double_click:subscribe(<span class="keyword">function</span>(self, custom_args, button_instance, click_amount)
-    <span class="global">print</span>(<span class="string">"On double Button click!"</span>)
-<span class="keyword">end</span>)</pre>
-    </ul>
-
-</dd>
-    <dt>
-    <a name = "on_hold_callback"></a>
-    <strong>on_hold_callback</strong>
-    </dt>
-    <dd>
-    The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event calls every frame before on_long_click event.
-<p> If long_click subscriber exists, the on_hold_callback will be called before long_click trigger.
-<p> Usecase: Animate button progress of long tap
-
-
-    <ul>
-        <li><span class="parameter">on_hold_callback</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">-- Custom args passed in Button constructor
-</span>button.on_double_click:subscribe(<span class="keyword">function</span>(self, custom_args, button_instance, time)
-    <span class="global">print</span>(<span class="string">"On hold Button callback!"</span>)
-<span class="keyword">end</span>)</pre>
-    </ul>
-
-</dd>
-    <dt>
-    <a name = "on_long_click"></a>
-    <strong>on_long_click</strong>
-    </dt>
-    <dd>
-    The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event on long tap action over button.
-<p> 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
-
-
-    <ul>
-        <li><span class="parameter">on_long_click</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">-- Custom args passed in Button constructor
-</span>button.on_long_click:subscribe(<span class="keyword">function</span>(self, custom_args, button_instance, hold_time)
-    <span class="global">print</span>(<span class="string">"On long Button click!"</span>)
-<span class="keyword">end</span>)</pre>
-    </ul>
-
-</dd>
-    <dt>
-    <a name = "on_pressed"></a>
-    <strong>on_pressed</strong>
-    </dt>
-    <dd>
-    The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event triggered if button was pressed by user.
-
-
-    <ul>
-        <li><span class="parameter">on_pressed</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">-- Custom args passed in Button constructor
-</span>button.on_pressed:subscribe(<span class="keyword">function</span>(self, custom_args, button_instance)
-    <span class="global">print</span>(<span class="string">"On Button pressed!"</span>)
-<span class="keyword">end</span>)</pre>
-    </ul>
-
-</dd>
-    <dt>
-    <a name = "on_repeated_click"></a>
-    <strong>on_repeated_click</strong>
-    </dt>
-    <dd>
-    The <a href="../modules/DruidEvent.html#">DruidEvent</a>: Event on repeated action over button.
-<p> This callback will be triggered if user hold the button. The repeat rate pick from `input.repeat_interval` in game.project
-
-
-    <ul>
-        <li><span class="parameter">on_repeated_click</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">-- Custom args passed in Button constructor
-</span>button.on_repeated_click:subscribe(<span class="keyword">function</span>(self, custom_args, button_instance, click_count)
-    <span class="global">print</span>(<span class="string">"On repeated Button click!"</span>)
-<span class="keyword">end</span>)</pre>
-    </ul>
-
-</dd>
-    <dt>
-    <a name = "params"></a>
-    <strong>params</strong>
-    </dt>
-    <dd>
-    Custom args for any Button event.  Setup in Button constructor
-
-
-    <ul>
-        <li><span class="parameter">params</span>
-            <span class="types"><span class="type">any</span></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/Checkbox.html

@@ -1,350 +0,0 @@
-<!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><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/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>Checkbox</code></h1>
-<p>Druid checkbox component</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 state</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#init">init(self, node, callback, click_node, initial_state)</a></td>
-	<td class="summary">The <a href="../modules/Checkbox.html#">Checkbox</a> constructor</td>
-	</tr>
-	<tr>
-	<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>
-</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 = "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">boolean</span></span>
-        Checkbox state
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "init"></a>
-    <strong>init(self, node, callback, click_node, initial_state)</strong>
-    </dt>
-    <dd>
-    The <a href="../modules/Checkbox.html#">Checkbox</a> constructor
-
-
-    <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>
-        <li><span class="parameter">node</span>
-            <span class="types"><a class="type" href="../modules/Checkbox.html#node">node</a></span>
-         Gui node
-        </li>
-        <li><span class="parameter">callback</span>
-            <span class="types"><span class="type">function</span></span>
-         Checkbox callback
-        </li>
-        <li><span class="parameter">click_node</span>
-            <span class="types"><a class="type" href="../modules/Checkbox.html#node">node</a> or <span class="type">nil</span></span>
-         Trigger node, by default equals to node. Default: node
-        </li>
-        <li><span class="parameter">initial_state</span>
-            <span class="types"><span class="type">boolean</span> or <span class="type">nil</span></span>
-         The initial state of checkbox, default - false
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_state"></a>
-    <strong>set_state(self, state, is_silent, is_instant)</strong>
-    </dt>
-    <dd>
-    Set 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>
-        <li><span class="parameter">state</span>
-            <span class="types"><span class="type">boolean</span> or <span class="type">nil</span></span>
-         Checkbox state
-        </li>
-        <li><span class="parameter">is_silent</span>
-            <span class="types"><span class="type">boolean</span> or <span class="type">nil</span></span>
-         Don't trigger on_change_state if true
-        </li>
-        <li><span class="parameter">is_instant</span>
-            <span class="types"><span class="type">boolean</span> or <span class="type">nil</span></span>
-         If instant checkbox change
-        </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">on_change_state</span>
-            <span class="types"><span class="type">function</span></span>
-         (self, node, state)
-        </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/Checkbox.html#node">node</a> or <span class="type">nil</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>
-    </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/CheckboxGroup.html

@@ -1,259 +0,0 @@
-<!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><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/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>CheckboxGroup</code></h1>
-<p>Checkbox group module</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)</a></td>
-	<td class="summary">The <a href="../modules/CheckboxGroup.html#">CheckboxGroup</a> constructor</td>
-	</tr>
-	<tr>
-	<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>
-</table>
-<h2><a href="#Fields">Fields</a></h2>
-<table class="function_list">
-	<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/>
-<br/>
-
-
-    <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">boolean[]</span></span>
-        Array if checkboxes state
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "init"></a>
-    <strong>init(self, nodes, callback, click_nodes)</strong>
-    </dt>
-    <dd>
-    The <a href="../modules/CheckboxGroup.html#">CheckboxGroup</a> constructor
-
-
-    <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>
-        <li><span class="parameter">nodes</span>
-            <span class="types"><span class="type">node[]</span></span>
-         Array of gui node
-        </li>
-        <li><span class="parameter">callback</span>
-            <span class="types"><span class="type">function</span></span>
-         Checkbox callback
-        </li>
-        <li><span class="parameter">click_nodes</span>
-            <span class="types"><span class="type">node[]</span> or <span class="type">nil</span></span>
-         Array of trigger nodes, by default equals to nodes
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_state"></a>
-    <strong>set_state(self, indexes, is_instant)</strong>
-    </dt>
-    <dd>
-    Set 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>
-        <li><span class="parameter">indexes</span>
-            <span class="types"><span class="type">boolean[]</span></span>
-         Array of checkbox state
-        </li>
-        <li><span class="parameter">is_instant</span>
-            <span class="types"><span class="type">boolean</span> or <span class="type">nil</span></span>
-         If instant state change
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-</dl>
-    <h2 class="section-header "><a name="Fields"></a>Fields</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "checkboxes"></a>
-    <strong>checkboxes</strong>
-    </dt>
-    <dd>
-    Array of checkbox components
-
-
-    <ul>
-        <li><span class="parameter">checkboxes</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>
-
-
-
-
-
-</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/DataList.html

@@ -1,712 +0,0 @@
-<!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><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/Progress.html">Progress</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>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> <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="#add">add(self, data, index, shift_policy)</a></td>
-	<td class="summary">Add element to DataList.</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_index">get_index(self, data)</a></td>
-	<td class="summary">Return index for data value</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#init">init(self, scroll, grid, create_function)</a></td>
-	<td class="summary">The <a href="../modules/DataList.html#">DataList</a> 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="#remove">remove(self, index, shift_policy)</a></td>
-	<td class="summary">Remove element from DataList.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#remove_by_data">remove_by_data(self, data, shift_policy)</a></td>
-	<td class="summary">Remove element from DataList by data value.</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>
-	<tr>
-	<td class="name" nowrap><a href="#set_use_cache">set_use_cache(self, is_use_cache)</a></td>
-	<td class="summary">Set refresh function for DataList component</td>
-	</tr>
-</table>
-<h2><a href="#Fields">Fields</a></h2>
-<table class="function_list">
-	<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="#last_index">last_index</a></td>
-	<td class="summary">The current last index of visual elements</td>
-	</tr>
-	<tr>
-	<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 top index of visual elements</td>
-	</tr>
-</table>
-
-<br/>
-<br/>
-
-
-    <h2 class="section-header "><a name="Functions"></a>Functions</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "add"></a>
-    <strong>add(self, data, index, shift_policy)</strong>
-    </dt>
-    <dd>
-    Add element to DataList.  Currenly untested
-
-
-    <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>
-        <li><span class="parameter">index</span>
-            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
-
-        </li>
-        <li><span class="parameter">shift_policy</span>
-            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
-         The constant from const.SHIFT.*
-        </li>
-    </ul>
-
-
-
-
-
-</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>
-         <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_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 = "init"></a>
-    <strong>init(self, scroll, grid, create_function)</strong>
-    </dt>
-    <dd>
-    The <a href="../modules/DataList.html#">DataList</a> constructor
-
-
-    <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">scroll</span>
-            <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">StaticGrid</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>
-         The create function callback(self, data, index, data_list). Function should return (node, [component])
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "on_remove"></a>
-    <strong>on_remove(self)</strong>
-    </dt>
-    <dd>
-    Druid System on_remove function
-
-
-    <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 = "remove"></a>
-    <strong>remove(self, index, shift_policy)</strong>
-    </dt>
-    <dd>
-    Remove element from DataList.  Currenly untested
-
-
-    <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> or <span class="type">nil</span></span>
-
-        </li>
-        <li><span class="parameter">shift_policy</span>
-            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
-         The constant from const.SHIFT.*
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "remove_by_data"></a>
-    <strong>remove_by_data(self, data, shift_policy)</strong>
-    </dt>
-    <dd>
-    Remove element from DataList by data value.  Currenly untested
-
-
-    <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>
-        <li><span class="parameter">shift_policy</span>
-            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
-         The constant from const.SHIFT.*
-        </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>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_data"></a>
-    <strong>set_data(self, data)</strong>
-    </dt>
-    <dd>
-    Set new data set for 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>
-        <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>
-         The new data array
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">druid.data_list</span></span>
-        Current DataList instance
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_use_cache"></a>
-    <strong>set_use_cache(self, is_use_cache)</strong>
-    </dt>
-    <dd>
-    Set refresh function for 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>
-        <li><span class="parameter">is_use_cache</span>
-            <span class="types"><span class="type">boolean</span></span>
-         Use cache version of DataList. Requires make setup of components in on_element_add callback and clean in on_element_remove
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">druid.data_list</span></span>
-        Current DataList instance
-    </ol>
-
-
-
-
-</dd>
-</dl>
-    <h2 class="section-header "><a name="Fields"></a>Fields</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "grid"></a>
-    <strong>grid</strong>
-    </dt>
-    <dd>
-    The Druid Grid component
-
-
-    <ul>
-        <li><span class="parameter">grid</span>
-            <span class="types"><span class="type">StaticGrid</span></span>
-         <a href="../modules/StaticGrid.html#">StaticGrid</a>, <a href="../modules/DynamicGrid.html#">DynamicGrid</a>
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "last_index"></a>
-    <strong>last_index</strong>
-    </dt>
-    <dd>
-    The current last index of visual elements
-
-
-    <ul>
-        <li><span class="parameter">last_index</span>
-            <span class="types"><span class="type">number</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</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>
-    <strong>scroll_progress</strong>
-    </dt>
-    <dd>
-    The current progress of scroll posititon
-
-
-    <ul>
-        <li><span class="parameter">scroll_progress</span>
-            <span class="types"><span class="type">number</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "top_index"></a>
-    <strong>top_index</strong>
-    </dt>
-    <dd>
-    The current top index of visual elements
-
-
-    <ul>
-        <li><span class="parameter">top_index</span>
-            <span class="types"><span class="type">number</span></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/Drag.html

@@ -1,633 +0,0 @@
-<!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/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/Progress.html">Progress</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>Drag</code></h1>
-<p>Component to handle drag action on node.</p>
-<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> <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>
-<table class="function_list">
-	<tr>
-	<td class="name" nowrap><a href="#init">init(self, node, on_drag_callback)</a></td>
-	<td class="summary">The <a href="../modules/Drag.html#">Drag</a> 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">
-	<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="#can_x">can_x</a></td>
-	<td class="summary">Is drag component process vertical dragging.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#can_y">can_y</a></td>
-	<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="#node">node</a></td>
-	<td class="summary">Drag node</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, touch)</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, touch)</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, touch)</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="#screen_x">screen_x</a></td>
-	<td class="summary">Current touch x screen position</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#screen_y">screen_y</a></td>
-	<td class="summary">Current touch y screen 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>
-	<tr>
-	<td class="name" nowrap><a href="#x">x</a></td>
-	<td class="summary">Current touch x position</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#y">y</a></td>
-	<td class="summary">Current touch y position</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, node, on_drag_callback)</strong>
-    </dt>
-    <dd>
-    The <a href="../modules/Drag.html#">Drag</a> constructor
-
-
-    <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">node</span>
-            <span class="types"><a class="type" href="../modules/Drag.html#node">node</a></span>
-         GUI node to detect dragging
-        </li>
-        <li><span class="parameter">on_drag_callback</span>
-            <span class="types"><span class="type">function</span></span>
-         Callback for on_drag_event(self, dx, dy)
-        </li>
-    </ul>
-
-
-
-
-
-</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">boolean</span></span>
-
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_click_zone"></a>
-    <strong>set_click_zone(self, node)</strong>
-    </dt>
-    <dd>
-    Strict drag click area.  Useful for
- restrict events outside stencil node
-
-
-    <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">node</span>
-            <span class="types"><a class="type" href="../modules/Drag.html#node">node</a>, <a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a> or <span class="type">nil</span></span>
-         Gui node
-        </li>
-    </ul>
-
-
-
-
-
-</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">boolean</span> or <span class="type">nil</span></span>
-
-        </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">DRAG_DEADZONE</span>
-            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
-         Distance in pixels to start dragging. Default: 10
-        </li>
-        <li><span class="parameter">NO_USE_SCREEN_KOEF</span>
-            <span class="types"><span class="type">boolean</span> or <span class="type">nil</span></span>
-         If screen aspect ratio affects on drag values. Default: false
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-</dl>
-    <h2 class="section-header "><a name="Fields"></a>Fields</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "can_x"></a>
-    <strong>can_x</strong>
-    </dt>
-    <dd>
-    Is drag component process vertical dragging.  Default - true
-
-
-    <ul>
-        <li><span class="parameter">can_x</span>
-            <span class="types"><span class="type">boolean</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "can_y"></a>
-    <strong>can_y</strong>
-    </dt>
-    <dd>
-    Is drag component process horizontal.  Default - true
-
-
-    <ul>
-        <li><span class="parameter">can_y</span>
-            <span class="types"><span class="type">boolean</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">boolean</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">boolean</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "node"></a>
-    <strong>node</strong>
-    </dt>
-    <dd>
-    Drag node
-
-
-    <ul>
-        <li><span class="parameter">node</span>
-            <span class="types"><a class="type" href="../modules/Drag.html#node">node</a></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, touch)
-
-
-    <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, touch)
-
-
-    <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, touch)
-
-
-    <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 = "screen_x"></a>
-    <strong>screen_x</strong>
-    </dt>
-    <dd>
-    Current touch x screen position
-
-
-    <ul>
-        <li><span class="parameter">screen_x</span>
-            <span class="types"><span class="type">number</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "screen_y"></a>
-    <strong>screen_y</strong>
-    </dt>
-    <dd>
-    Current touch y screen position
-
-
-    <ul>
-        <li><span class="parameter">screen_y</span>
-            <span class="types"><span class="type">number</span></span>
-
-        </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>
-    <strong>x</strong>
-    </dt>
-    <dd>
-    Current touch x position
-
-
-    <ul>
-        <li><span class="parameter">x</span>
-            <span class="types"><span class="type">number</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "y"></a>
-    <strong>y</strong>
-    </dt>
-    <dd>
-    Current touch y position
-
-
-    <ul>
-        <li><span class="parameter">y</span>
-            <span class="types"><span class="type">number</span></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/Druid.html

@@ -1,374 +0,0 @@
-<!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/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/Progress.html">Progress</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>Druid</code></h1>
-<p>Druid UI Component Framework.</p>
-<p>
- <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="#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="#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="#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="#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="#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="#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="#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>
-
-<br/>
-<br/>
-
-
-    <h2 class="section-header "><a name="Functions"></a>Functions</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "druid.new"></a>
-    <strong>druid.new(context, style)</strong>
-    </dt>
-    <dd>
-    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.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.1/manual.html#5.5">table</a> or <span class="type">nil</span></span>
-         The Druid style table to override style parameters for this Druid instance.
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">druid_instance</span></span>
-        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 = "druid.on_language_change"></a>
-    <strong>druid.on_language_change()</strong>
-    </dt>
-    <dd>
-    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.1/manual.html#5.5">table</a></span>
-         Druid style module
-        </li>
-    </ul>
-
-
-
-
-    <h3>Usage:</h3>
-    <ul>
-        <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 = "druid.set_sound_function"></a>
-    <strong>druid.set_sound_function(callback)</strong>
-    </dt>
-    <dd>
-    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>
-    <ul>
-        <li><span class="parameter">callback</span>
-            <span class="types"><span class="type">function</span></span>
-         Sound play callback
-        </li>
-    </ul>
-
-
-
-
-    <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 = "druid.set_text_function"></a>
-    <strong>druid.set_text_function(callback)</strong>
-    </dt>
-    <dd>
-    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">callback</span>
-            <span class="types"><span class="type">function</span></span>
-         Get localized text function
-        </li>
-    </ul>
-
-
-
-
-    <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>
-
-
-</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/DruidEvent.html

@@ -1,399 +0,0 @@
-<!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/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/Progress.html">Progress</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>DruidEvent</code></h1>
-<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="#clear">clear(self)</a></td>
-	<td class="summary">Clear the all event handlers</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#create">create(callback, callback_context)</a></td>
-	<td class="summary">DruidEvent constructor</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#is_empty">is_empty(self)</a></td>
-	<td class="summary">Return true, if event not have handler</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="#is_subscribed">is_subscribed(self, callback, callback_context)</a></td>
-	<td class="summary">Check is event subscribed.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#subscribe">subscribe(self, callback, 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, callback_context)</a></td>
-	<td class="summary">Unsubscribe callback on event</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(self)</strong>
-    </dt>
-    <dd>
-    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 = "create"></a>
-    <strong>create(callback, callback_context)</strong>
-    </dt>
-    <dd>
-    DruidEvent constructor
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">callback</span>
-            <span class="types"><span class="type">function</span> or <span class="type">nil</span></span>
-         Subscribe the callback on new event, if callback exist
-        </li>
-        <li><span class="parameter">callback_context</span>
-            <span class="types"><span class="type">any</span> or <span class="type">nil</span></span>
-         Additional context as first param to callback call
-        </li>
-    </ul>
-
-
-
-
-    <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(callback)</pre>
-    </ul>
-
-</dd>
-    <dt>
-    <a name = "is_empty"></a>
-    <strong>is_empty(self)</strong>
-    </dt>
-    <dd>
-    Return true, if event not have handler
-
-
-    <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>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">boolean</span></span>
-        True if event not have handlers
-    </ol>
-
-
-
-    <h3>Usage:</h3>
-    <ul>
-        <pre class="example"><span class="keyword">local</span> is_long_click_handler_not_exists = button.on_long_click:is_empty()</pre>
-    </ul>
-
-</dd>
-    <dt>
-    <a name = "is_exist"></a>
-    <strong>is_exist(self)</strong>
-    </dt>
-    <dd>
-    Return true, if event have at lease one handler
-
-
-    <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>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">boolean</span></span>
-        True if event have handlers
-    </ol>
-
-
-
-    <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 = "is_subscribed"></a>
-    <strong>is_subscribed(self, callback, callback_context)</strong>
-    </dt>
-    <dd>
-    Check is event subscribed.
-
-
-    <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">callback_context</span>
-            <span class="types"><span class="type">any</span> or <span class="type">nil</span></span>
-         Additional context as first param to callback call
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">boolean,</span></span>
-        number|nil @Is event subscribed, return index of callback in event as second param
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "subscribe"></a>
-    <strong>subscribe(self, callback, callback_context)</strong>
-    </dt>
-    <dd>
-    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">callback_context</span>
-            <span class="types"><span class="type">any</span> or <span class="type">nil</span></span>
-         Additional context as first param to callback call, usually it's self
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">boolean</span></span>
-        True if callback was subscribed
-    </ol>
-
-
-
-    <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>
-    <a name = "trigger"></a>
-    <strong>trigger(self, ...)</strong>
-    </dt>
-    <dd>
-    Trigger the event and call all subscribed callbacks
-
-
-    <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">...</span>
-            <span class="types"><span class="type">any</span></span>
-         All event params
-        </li>
-    </ul>
-
-
-
-
-    <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, 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">callback_context</span>
-            <span class="types"><span class="type">any</span> or <span class="type">nil</span></span>
-         Additional context as first param to callback call
-        </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>
-
-
-</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/DynamicGrid.html

@@ -1,788 +0,0 @@
-<!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/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><strong>DynamicGrid</strong></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/Progress.html">Progress</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>DynamicGrid</code></h1>
-<p>Component to handle placing components in row</p>
-<p> <a href="https://insality.github.io/druid/druid/index.html?example=general_grid" 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_side_vector">_get_side_vector(self, side, is_forward)</a></td>
-	<td class="summary">Return side vector to correct node shifting</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#add">add(self, node, index, shift_policy, is_instant)</a></td>
-	<td class="summary">Add new node to the grid</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#clear">clear(self)</a></td>
-	<td class="summary">Clear grid nodes array.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#get_all_pos">get_all_pos(self)</a></td>
-	<td class="summary">Return array of all node positions</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#get_borders">get_borders(self)</a></td>
-	<td class="summary">Return grid content borders</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#get_index_by_node">get_index_by_node(self, node)</a></td>
-	<td class="summary">Return grid index by node</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#get_offset">get_offset(self)</a></td>
-	<td class="summary">Return DynamicGrid offset, where DynamicGrid content starts.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#get_pos">get_pos(self, index, node, origin_index)</a></td>
-	<td class="summary">Return pos for grid node index</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#get_size">get_size(self, border)</a></td>
-	<td class="summary">Return grid content size</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#init">init(self, parent)</a></td>
-	<td class="summary">The <a href="../modules/DynamicGrid.html#">DynamicGrid</a> constructor</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#remove">remove(self, index, shift_policy, is_instant)</a></td>
-	<td class="summary">Remove the item from the grid.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#set_position_function">set_position_function(self, callback)</a></td>
-	<td class="summary">Change set position function for grid nodes.</td>
-	</tr>
-</table>
-<h2><a href="#Fields">Fields</a></h2>
-<table class="function_list">
-	<tr>
-	<td class="name" nowrap><a href="#border">border</a></td>
-	<td class="summary">The size of item content</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#first_index">first_index</a></td>
-	<td class="summary">The first index of node in grid</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#last_index">last_index</a></td>
-	<td class="summary">The last index of node in grid</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#node_size">node_size</a></td>
-	<td class="summary">Item size</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#nodes">nodes</a></td>
-	<td class="summary">List of all grid elements.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#on_add_item">on_add_item</a></td>
-	<td class="summary">On item add callback(self, node, index)</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#on_change_items">on_change_items</a></td>
-	<td class="summary">On item add or remove callback(self, index)</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#on_clear">on_clear</a></td>
-	<td class="summary">On grid clear callback(self)</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#on_remove_item">on_remove_item</a></td>
-	<td class="summary">On item remove callback(self, index)</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#on_update_positions">on_update_positions</a></td>
-	<td class="summary">On update item positions callback(self)</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#parent">parent</a></td>
-	<td class="summary">Parent gui node</td>
-	</tr>
-</table>
-
-<br/>
-<br/>
-
-
-    <h2 class="section-header "><a name="Functions"></a>Functions</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "_get_side_vector"></a>
-    <strong>_get_side_vector(self, side, is_forward)</strong>
-    </dt>
-    <dd>
-    Return side vector to correct node shifting
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-
-        </li>
-        <li><span class="parameter">side</span>
-
-        </li>
-        <li><span class="parameter">is_forward</span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "add"></a>
-    <strong>add(self, node, index, shift_policy, is_instant)</strong>
-    </dt>
-    <dd>
-    Add new node to the grid
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">DynamicGrid</span></span>
-         <a href="../modules/DynamicGrid.html#">DynamicGrid</a>
-        </li>
-        <li><span class="parameter">node</span>
-            <span class="types"><span class="type">node</span></span>
-         Gui node
-        </li>
-        <li><span class="parameter">index</span>
-            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
-         The node position. By default add as last node
-        </li>
-        <li><span class="parameter">shift_policy</span>
-            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
-         How shift nodes, if required. Default: const.SHIFT.RIGHT
-        </li>
-        <li><span class="parameter">is_instant</span>
-            <span class="types"><span class="type">boolean</span> or <span class="type">nil</span></span>
-         If true, update node positions instantly
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "clear"></a>
-    <strong>clear(self)</strong>
-    </dt>
-    <dd>
-    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
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">DynamicGrid</span></span>
-         <a href="../modules/DynamicGrid.html#">DynamicGrid</a>
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">druid.dynamic_grid</span></span>
-        Current grid instance
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "get_all_pos"></a>
-    <strong>get_all_pos(self)</strong>
-    </dt>
-    <dd>
-    Return array of all node positions
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">DynamicGrid</span></span>
-         <a href="../modules/DynamicGrid.html#">DynamicGrid</a>
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">vector3[]</span></span>
-        All grid node positions
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "get_borders"></a>
-    <strong>get_borders(self)</strong>
-    </dt>
-    <dd>
-    Return grid content borders
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">DynamicGrid</span></span>
-         <a href="../modules/DynamicGrid.html#">DynamicGrid</a>
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">vector3</span></span>
-        The grid content borders
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "get_index_by_node"></a>
-    <strong>get_index_by_node(self, node)</strong>
-    </dt>
-    <dd>
-    Return grid index by node
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">DynamicGrid</span></span>
-         <a href="../modules/DynamicGrid.html#">DynamicGrid</a>
-        </li>
-        <li><span class="parameter">node</span>
-            <span class="types"><span class="type">node</span></span>
-         The gui node in the grid
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">number</span></span>
-        The node index
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "get_offset"></a>
-    <strong>get_offset(self)</strong>
-    </dt>
-    <dd>
-    Return DynamicGrid offset, where DynamicGrid content starts.
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">DynamicGrid</span></span>
-         <a href="../modules/DynamicGrid.html#">DynamicGrid</a> The DynamicGrid instance
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">vector3</span></span>
-        The DynamicGrid offset
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "get_pos"></a>
-    <strong>get_pos(self, index, node, origin_index)</strong>
-    </dt>
-    <dd>
-    Return pos for grid node index
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">DynamicGrid</span></span>
-         <a href="../modules/DynamicGrid.html#">DynamicGrid</a>
-        </li>
-        <li><span class="parameter">index</span>
-            <span class="types"><span class="type">number</span></span>
-         The grid element index
-        </li>
-        <li><span class="parameter">node</span>
-            <span class="types"><span class="type">node</span></span>
-         The node to be placed
-        </li>
-        <li><span class="parameter">origin_index</span>
-            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
-         Index of nearby node
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">vector3</span></span>
-        node position
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "get_size"></a>
-    <strong>get_size(self, border)</strong>
-    </dt>
-    <dd>
-    Return grid content size
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">DynamicGrid</span></span>
-         <a href="../modules/DynamicGrid.html#">DynamicGrid</a>
-        </li>
-        <li><span class="parameter">border</span>
-            <span class="types"><span class="type">vector3</span></span>
-
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">vector3</span></span>
-        The grid content size
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "init"></a>
-    <strong>init(self, parent)</strong>
-    </dt>
-    <dd>
-    The <a href="../modules/DynamicGrid.html#">DynamicGrid</a> constructor
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">DynamicGrid</span></span>
-         <a href="../modules/DynamicGrid.html#">DynamicGrid</a>
-        </li>
-        <li><span class="parameter">parent</span>
-            <span class="types"><span class="type">node</span></span>
-         The gui node parent, where items will be placed
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "remove"></a>
-    <strong>remove(self, index, shift_policy, is_instant)</strong>
-    </dt>
-    <dd>
-    Remove the item from the grid.  Note that gui node will be not deleted
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">DynamicGrid</span></span>
-         <a href="../modules/DynamicGrid.html#">DynamicGrid</a>
-        </li>
-        <li><span class="parameter">index</span>
-            <span class="types"><span class="type">number</span></span>
-         The grid node index to remove
-        </li>
-        <li><span class="parameter">shift_policy</span>
-            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
-         How shift nodes, if required. Default: const.SHIFT.RIGHT
-        </li>
-        <li><span class="parameter">is_instant</span>
-            <span class="types"><span class="type">boolean</span> or <span class="type">nil</span></span>
-         If true, update node positions instantly
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">node</span></span>
-        The deleted gui node from grid
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_position_function"></a>
-    <strong>set_position_function(self, callback)</strong>
-    </dt>
-    <dd>
-    Change set position function for grid nodes.  It will call on
- update poses on grid elements. Default: gui.set_position
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-            <span class="types"><span class="type">DynamicGrid</span></span>
-         <a href="../modules/DynamicGrid.html#">DynamicGrid</a>
-        </li>
-        <li><span class="parameter">callback</span>
-            <span class="types"><span class="type">function</span></span>
-         Function on node set position
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">druid.dynamic_grid</span></span>
-        Current grid instance
-    </ol>
-
-
-
-
-</dd>
-</dl>
-    <h2 class="section-header "><a name="Fields"></a>Fields</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "border"></a>
-    <strong>border</strong>
-    </dt>
-    <dd>
-    The size of item content
-
-
-    <ul>
-        <li><span class="parameter">border</span>
-            <span class="types"><span class="type">vector4</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "first_index"></a>
-    <strong>first_index</strong>
-    </dt>
-    <dd>
-    The first index of node in grid
-
-
-    <ul>
-        <li><span class="parameter">first_index</span>
-            <span class="types"><span class="type">number</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "last_index"></a>
-    <strong>last_index</strong>
-    </dt>
-    <dd>
-    The last index of node in grid
-
-
-    <ul>
-        <li><span class="parameter">last_index</span>
-            <span class="types"><span class="type">number</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "node_size"></a>
-    <strong>node_size</strong>
-    </dt>
-    <dd>
-    Item size
-
-
-    <ul>
-        <li><span class="parameter">node_size</span>
-            <span class="types"><span class="type">vector3</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "nodes"></a>
-    <strong>nodes</strong>
-    </dt>
-    <dd>
-    List of all grid elements.  Contains from node, pos, size, pivot
-
-
-    <ul>
-        <li><span class="parameter">nodes</span>
-            <span class="types"><span class="type">node[]</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "on_add_item"></a>
-    <strong>on_add_item</strong>
-    </dt>
-    <dd>
-    On item add callback(self, node, index)
-
-
-    <ul>
-        <li><span class="parameter">on_add_item</span>
-            <span class="types"><span class="type">DruidEvent</span></span>
-         <a href="../modules/DruidEvent.html#">DruidEvent</a>
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "on_change_items"></a>
-    <strong>on_change_items</strong>
-    </dt>
-    <dd>
-    On item add or remove callback(self, index)
-
-
-    <ul>
-        <li><span class="parameter">on_change_items</span>
-            <span class="types"><span class="type">DruidEvent</span></span>
-         <a href="../modules/DruidEvent.html#">DruidEvent</a>
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "on_clear"></a>
-    <strong>on_clear</strong>
-    </dt>
-    <dd>
-    On grid clear callback(self)
-
-
-    <ul>
-        <li><span class="parameter">on_clear</span>
-            <span class="types"><span class="type">DruidEvent</span></span>
-         <a href="../modules/DruidEvent.html#">DruidEvent</a>
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "on_remove_item"></a>
-    <strong>on_remove_item</strong>
-    </dt>
-    <dd>
-    On item remove callback(self, index)
-
-
-    <ul>
-        <li><span class="parameter">on_remove_item</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_positions"></a>
-    <strong>on_update_positions</strong>
-    </dt>
-    <dd>
-    On update item positions callback(self)
-
-
-    <ul>
-        <li><span class="parameter">on_update_positions</span>
-            <span class="types"><span class="type">DruidEvent</span></span>
-         <a href="../modules/DruidEvent.html#">DruidEvent</a>
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "parent"></a>
-    <strong>parent</strong>
-    </dt>
-    <dd>
-    Parent gui node
-
-
-    <ul>
-        <li><span class="parameter">parent</span>
-            <span class="types"><span class="type">node</span></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/Helper.html

@@ -1,927 +0,0 @@
-<!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/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/Progress.html">Progress</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, ...)</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, any, 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_multitouch_supported">helper.is_multitouch_supported()</a></td>
-	<td class="summary">Check if device is mobile and can support multitouch</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.is_web_mobile">helper.is_web_mobile()</a></td>
-	<td class="summary">Check if device is HTML5 mobile</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)</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"><span class="type">any[]</span></span>
-         Array to put elements from source
-        </li>
-        <li><span class="parameter">source</span>
-            <span class="types"><span class="type">any[]</span> or <span class="type">nil</span></span>
-         The source array to get elements from
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">any[]</span></span>
-        The target array
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "helper.centrate_nodes"></a>
-    <strong>helper.centrate_nodes(margin, ...)</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> or <span class="type">nil</span></span>
-         Offset between nodes
-        </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> or <span class="type">nil</span></span>
-         Offset from node position. Pass current node position to get non relative border values
-        </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">number</span></span>
-         The gui.PIVOT_* constant
-        </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">boolean</span> or <span class="type">nil</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, any, 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">any</span>
-         Item to insert
-        </li>
-        <li><span class="parameter">index</span>
-            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
-         Index to insert. If nil, item will be inserted at the end of array
-        </li>
-        <li><span class="parameter">shift_policy</span>
-            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
-         The druid_const.SHIFT.* constant
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">any</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">boolean</span></span>
-        Is mobile
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "helper.is_multitouch_supported"></a>
-    <strong>helper.is_multitouch_supported()</strong>
-    </dt>
-    <dd>
-    Check if device is mobile and can support multitouch
-
-
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">boolean</span></span>
-        Is multitouch supported
-    </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">boolean</span></span>
-        Is web
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "helper.is_web_mobile"></a>
-    <strong>helper.is_web_mobile()</strong>
-    </dt>
-    <dd>
-    Check if device is HTML5 mobile
-
-
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">boolean</span></span>
-        Is web mobile
-    </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> or <span class="type">nil</span></span>
-         Index to remove. If nil, item will be removed from the end of array
-        </li>
-        <li><span class="parameter">shift_policy</span>
-            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
-         The druid_const.SHIFT.* constant
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">any</span></span>
-        Removed item
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "helper.round"></a>
-    <strong>helper.round(num, num_decimal_places)</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> or <span class="type">nil</span></span>
-         Decimal places
-        </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

@@ -1,373 +0,0 @@
-<!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/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/Progress.html">Progress</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">The <a href="../modules/Hotkey.html#">Hotkey</a> constructor</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#set_repeat">set_repeat(self, is_enabled_repeated)</a></td>
-	<td class="summary">If true, the callback will be triggered on action.repeated</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_hotkey_pressed">on_hotkey_pressed</a></td>
-	<td class="summary">On hotkey released callback(self, argument)</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#on_hotkey_released">on_hotkey_released</a></td>
-	<td class="summary">On hotkey released callback(self, argument)</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">any</span> or <span class="type">nil</span></span>
-         The argument to pass into the callback function
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">Hotkey</span></span>
-        Current instance
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "init"></a>
-    <strong>init(self, keys, callback, callback_argument)</strong>
-    </dt>
-    <dd>
-    The <a href="../modules/Hotkey.html#">Hotkey</a> constructor
-
-
-    <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">any</span> or <span class="type">nil</span></span>
-         The argument to pass into the callback function
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_repeat"></a>
-    <strong>set_repeat(self, is_enabled_repeated)</strong>
-    </dt>
-    <dd>
-    If true, the callback will be triggered on action.repeated
-
-
-    <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">is_enabled_repeated</span>
-            <span class="types"><span class="type">bool</span></span>
-         The flag value
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">Hotkey</span></span>
-
-    </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">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> or <span class="type">nil</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/Hotkey.html#node">node</a></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "on_hotkey_pressed"></a>
-    <strong>on_hotkey_pressed</strong>
-    </dt>
-    <dd>
-    On hotkey released callback(self, argument)
-
-
-    <ul>
-        <li><span class="parameter">on_hotkey_pressed</span>
-            <span class="types"><span class="type">DruidEvent</span></span>
-         <a href="../modules/DruidEvent.html#">DruidEvent</a>
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "on_hotkey_released"></a>
-    <strong>on_hotkey_released</strong>
-    </dt>
-    <dd>
-    On hotkey released callback(self, argument)
-
-
-    <ul>
-        <li><span class="parameter">on_hotkey_released</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

@@ -1,469 +0,0 @@
-<!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/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/Progress.html">Progress</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>Hover</code></h1>
-<p>Component to handle hover node interaction</p>
-<p></p>
-
-
-<h2><a href="#Functions">Functions</a></h2>
-<table class="function_list">
-	<tr>
-	<td class="name" nowrap><a href="#init">init(self, node, on_hover_callback, on_mouse_hover)</a></td>
-	<td class="summary">The <a href="../modules/Hover.html#">Hover</a> constructor</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>
-	</tr>
-	<tr>
-	<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>
-	<td class="summary">Strict hover click area.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#set_enabled">set_enabled(self, state)</a></td>
-	<td class="summary">Set enable state of hover component.</td>
-	</tr>
-	<tr>
-	<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="#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="#node">node</a></td>
-	<td class="summary">Hover node</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#on_hover">on_hover</a></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, hover_instance)</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, node, on_hover_callback, on_mouse_hover)</strong>
-    </dt>
-    <dd>
-    The <a href="../modules/Hover.html#">Hover</a> constructor
-
-
-    <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">node</span>
-            <span class="types"><a class="type" href="../modules/Hover.html#node">node</a></span>
-         Gui node
-        </li>
-        <li><span class="parameter">on_hover_callback</span>
-            <span class="types"><span class="type">function</span></span>
-         Hover callback
-        </li>
-        <li><span class="parameter">on_mouse_hover</span>
-            <span class="types"><span class="type">function</span></span>
-         On mouse hover callback
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "is_enabled"></a>
-    <strong>is_enabled(self)</strong>
-    </dt>
-    <dd>
-    Return current hover enabled 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>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">boolean</span></span>
-        The hover enabled state
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "is_hovered"></a>
-    <strong>is_hovered(self)</strong>
-    </dt>
-    <dd>
-    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>
-         <a href="../modules/Hover.html#">Hover</a>
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">boolean</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">boolean</span></span>
-        The current hovered state
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_click_zone"></a>
-    <strong>set_click_zone(self, zone)</strong>
-    </dt>
-    <dd>
-    Strict hover click area.  Useful for
- no click events outside stencil node
-
-
-    <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">zone</span>
-            <span class="types"><a class="type" href="../modules/Hover.html#node">node</a>, <a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a> or <span class="type">nil</span></span>
-         Gui node
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_enabled"></a>
-    <strong>set_enabled(self, state)</strong>
-    </dt>
-    <dd>
-    Set enable state of hover component.
- If hover is not enabled, it will not generate
- any hover events
-
-
-    <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">boolean</span> or <span class="type">nil</span></span>
-         The hover enabled state
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_hover"></a>
-    <strong>set_hover(self, state)</strong>
-    </dt>
-    <dd>
-    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">boolean</span> or <span class="type">nil</span></span>
-         The hover state
-        </li>
-    </ul>
-
-
-
-
-
-</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">boolean</span> or <span class="type">nil</span></span>
-         The mouse hover state
-        </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">ON_HOVER_CURSOR</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
-         Mouse hover style on node hover
-         (<em>optional</em>)
-        </li>
-        <li><span class="parameter">ON_MOUSE_HOVER_CURSOR</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
-         Mouse hover style on node mouse hover
-         (<em>optional</em>)
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-</dl>
-    <h2 class="section-header "><a name="Fields"></a>Fields</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "node"></a>
-    <strong>node</strong>
-    </dt>
-    <dd>
-    Hover node
-
-
-    <ul>
-        <li><span class="parameter">node</span>
-            <span class="types"><a class="type" href="../modules/Hover.html#node">node</a></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "on_hover"></a>
-    <strong>on_hover</strong>
-    </dt>
-    <dd>
-    On hover callback(self, state, hover_instance)
-
-
-    <ul>
-        <li><span class="parameter">on_hover</span>
-            <span class="types"><span class="type">DruidEvent</span></span>
-         <a href="../modules/DruidEvent.html#">DruidEvent</a>
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "on_mouse_hover"></a>
-    <strong>on_mouse_hover</strong>
-    </dt>
-    <dd>
-    On mouse hover callback(self, state, hover_instance)
-
-
-    <ul>
-        <li><span class="parameter">on_mouse_hover</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/LangText.html

@@ -1,380 +0,0 @@
-<!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/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/Progress.html">Progress</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>LangText</code></h1>
-<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="#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)</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, b, c, d, e, f, g)</a></td>
-	<td class="summary">Translate the text by locale_id</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">Text node</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#on_change">on_change</a></td>
-	<td class="summary">On change text callback</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#text">text</a></td>
-	<td class="summary">The text component</td>
-	</tr>
-</table>
-
-<br/>
-<br/>
-
-
-    <h2 class="section-header "><a name="Functions"></a>Functions</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "format"></a>
-    <strong>format(self, a, b, c, d, e, f, g)</strong>
-    </dt>
-    <dd>
-    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> or <span class="type">nil</span></span>
-         Optional param to string.format
-        </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> or <span class="type">nil</span></span>
-         Optional param to string.format
-        </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> or <span class="type">nil</span></span>
-         Optional param to string.format
-        </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> or <span class="type">nil</span></span>
-         Optional param to string.format
-        </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> or <span class="type">nil</span></span>
-         Optional param to string.format
-        </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> or <span class="type">nil</span></span>
-         Optional param to string.format
-        </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> or <span class="type">nil</span></span>
-         Optional param to string.format
-        </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)</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"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a> or <a class="type" href="../modules/LangText.html#node">node</a></span>
-         The node_id or gui.get_node(node_id)
-        </li>
-        <li><span class="parameter">locale_id</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">nil</span></span>
-         Default locale id or text from node as default
-        </li>
-        <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> or <span class="type">nil</span></span>
-         Adjust type for text. By default is DOWNSCALE. Look const.TEXT_ADJUST for reference
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_to"></a>
-    <strong>set_to(self, text)</strong>
-    </dt>
-    <dd>
-    Setup raw text to lang_text component
-
-
-    <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">text</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>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "translate"></a>
-    <strong>translate(self, locale_id, a, b, c, d, e, f, g)</strong>
-    </dt>
-    <dd>
-    Translate the text by locale_id
-
-
-    <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">locale_id</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> or <span class="type">nil</span></span>
-         Optional param to string.format
-        </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> or <span class="type">nil</span></span>
-         Optional param to string.format
-        </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> or <span class="type">nil</span></span>
-         Optional param to string.format
-        </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> or <span class="type">nil</span></span>
-         Optional param to string.format
-        </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> or <span class="type">nil</span></span>
-         Optional param to string.format
-        </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> or <span class="type">nil</span></span>
-         Optional param to string.format
-        </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> or <span class="type">nil</span></span>
-         Optional param to string.format
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">LangText</span></span>
-        Current instance
-    </ol>
-
-
-
-
-</dd>
-</dl>
-    <h2 class="section-header "><a name="Fields"></a>Fields</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "node"></a>
-    <strong>node</strong>
-    </dt>
-    <dd>
-    Text node
-
-
-    <ul>
-        <li><span class="parameter">node</span>
-            <span class="types"><a class="type" href="../modules/LangText.html#node">node</a></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "on_change"></a>
-    <strong>on_change</strong>
-    </dt>
-    <dd>
-    On change text callback
-
-
-    <ul>
-        <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>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "text"></a>
-    <strong>text</strong>
-    </dt>
-    <dd>
-    The 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>
-
-
-
-
-
-</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/Layout.html

@@ -1,147 +0,0 @@
-<!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="#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/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/Progress.html">Progress</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="#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>
-</table>
-
-<br/>
-<br/>
-
-
-    <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>
-</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

@@ -1,299 +0,0 @@
-<!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">The <a href="../modules/PinKnob.html#">PinKnob</a> constructor</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)</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>
-    The <a href="../modules/PinKnob.html#">PinKnob</a> constructor
-
-
-    <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)</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> or <span class="type">nil</span></span>
-         The spin speed multiplier. Default: 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">boolean</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

@@ -1,569 +0,0 @@
-<!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/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>Progress</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>
-</ul>
-
-</div>
-
-<div id="content">
-
-<h1>Module <code>Progress</code></h1>
-<p>Druid component to handle the progress bars.</p>
-<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="#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="#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)</a></td>
-	<td class="summary">The <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>
-</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="#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="#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>
-	<td class="summary">Current progress bar scale</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#size">size</a></td>
-	<td class="summary">Current progress bar size</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#slice">slice</a></td>
-	<td class="summary">Progress bar slice9 settings</td>
-	</tr>
-</table>
-
-<br/>
-<br/>
-
-
-    <h2 class="section-header "><a name="Functions"></a>Functions</h2>
-
-    <dl class="function">
-    <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>
-         <a href="../modules/Progress.html#">Progress</a>
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "fill"></a>
-    <strong>fill(self)</strong>
-    </dt>
-    <dd>
-    Fill a progress bar and stop progress animation
-
-
-    <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>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "get"></a>
-    <strong>get(self)</strong>
-    </dt>
-    <dd>
-    Return current progress bar 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>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "init"></a>
-    <strong>init(self, node, key, init_value)</strong>
-    </dt>
-    <dd>
-    The <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> or <span class="type">nil</span></span>
-         Initial value of progress bar. Default: 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>
-    <strong>set_steps(self, steps, callback)</strong>
-    </dt>
-    <dd>
-    Set points on progress bar to fire the callback
-
-
-    <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">steps</span>
-            <span class="types"><span class="type">number[]</span></span>
-         Array of progress bar values
-        </li>
-        <li><span class="parameter">callback</span>
-            <span class="types"><span class="type">function</span></span>
-         Callback on intersect step value
-        </li>
-    </ul>
-
-
-
-
-    <h3>Usage:</h3>
-    <ul>
-        <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>
-    <strong>to(self, to, callback)</strong>
-    </dt>
-    <dd>
-    Start animation of a progress bar
-
-
-    <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>
-         value between 0..1
-        </li>
-        <li><span class="parameter">callback</span>
-            <span class="types"><span class="type">function</span> or <span class="type">nil</span></span>
-         Callback on animation ends
-        </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">SPEED</span>
-            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
-         Progress bas fill rate. More -> faster. Default: 5
-        </li>
-        <li><span class="parameter">MIN_DELTA</span>
-            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
-         Minimum step to fill progress bar. Default: 0.005
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-</dl>
-    <h2 class="section-header "><a name="Fields"></a>Fields</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "key"></a>
-    <strong>key</strong>
-    </dt>
-    <dd>
-    The progress bar direction.
-<p> The values are: "x" or "y". (const.SIDE.X or const.SIDE.Y)
-
-
-    <ul>
-        <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>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "node"></a>
-    <strong>node</strong>
-    </dt>
-    <dd>
-    Progress bar fill node
-
-
-    <ul>
-        <li><span class="parameter">node</span>
-            <span class="types"><a class="type" href="../modules/Progress.html#node">node</a></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "on_change"></a>
-    <strong>on_change</strong>
-    </dt>
-    <dd>
-    On progress bar change callback(self, new_value)
-
-
-    <ul>
-        <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>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "scale"></a>
-    <strong>scale</strong>
-    </dt>
-    <dd>
-    Current progress bar scale
-
-
-    <ul>
-        <li><span class="parameter">scale</span>
-            <span class="types"><span class="type">vector3</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "size"></a>
-    <strong>size</strong>
-    </dt>
-    <dd>
-    Current progress bar size
-
-
-    <ul>
-        <li><span class="parameter">size</span>
-            <span class="types"><span class="type">vector3</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "slice"></a>
-    <strong>slice</strong>
-    </dt>
-    <dd>
-    Progress bar slice9 settings
-
-
-    <ul>
-        <li><span class="parameter">slice</span>
-            <span class="types"><span class="type">vector4</span></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/RadioGroup.html

@@ -1,259 +0,0 @@
-<!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/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>
-</ul>
-
-</div>
-
-<div id="content">
-
-<h1>Module <code>RadioGroup</code></h1>
-<p>Radio group module</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)</a></td>
-	<td class="summary">The <a href="../modules/RadioGroup.html#">RadioGroup</a> constructor</td>
-	</tr>
-	<tr>
-	<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>
-</table>
-<h2><a href="#Fields">Fields</a></h2>
-<table class="function_list">
-	<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/>
-<br/>
-
-
-    <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)</strong>
-    </dt>
-    <dd>
-    The <a href="../modules/RadioGroup.html#">RadioGroup</a> constructor
-
-
-    <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>
-        <li><span class="parameter">nodes</span>
-            <span class="types"><span class="type">node[]</span></span>
-         Array of gui node
-        </li>
-        <li><span class="parameter">callback</span>
-            <span class="types"><span class="type">function</span></span>
-         Radio callback
-        </li>
-        <li><span class="parameter">click_nodes</span>
-            <span class="types"><span class="type">node[]</span> or <span class="type">nil</span></span>
-         Array of trigger nodes, by default equals to nodes. Default - nodes
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_state"></a>
-    <strong>set_state(self, index, is_instant)</strong>
-    </dt>
-    <dd>
-    Set 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>
-        <li><span class="parameter">index</span>
-            <span class="types"><span class="type">number</span></span>
-         Index in radio group
-        </li>
-        <li><span class="parameter">is_instant</span>
-            <span class="types"><span class="type">boolean</span> or <span class="type">nil</span></span>
-         If is instant state change
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-</dl>
-    <h2 class="section-header "><a name="Fields"></a>Fields</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "checkboxes"></a>
-    <strong>checkboxes</strong>
-    </dt>
-    <dd>
-    Array of checkbox components
-
-
-    <ul>
-        <li><span class="parameter">checkboxes</span>
-            <span class="types"><span class="type">Checkbox[]</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</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>
-
-
-</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/RichInput.html

@@ -1,567 +0,0 @@
-<!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/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/Progress.html">Progress</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="#get_text">get_text(self)</a></td>
-	<td class="summary">Set input field text</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#init">init(self, template, nodes)</a></td>
-	<td class="summary">The <a href="../modules/RichInput.html#">RichInput</a> constructor</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="#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_font">set_font(self, font)</a></td>
-	<td class="summary">Set input field font</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>
-	<tr>
-	<td class="name" nowrap><a href="#set_text">set_text(self, text)</a></td>
-	<td class="summary">Set input field 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="#cursor_position">cursor_position</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="#cursor_text">cursor_text</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="#drag">drag</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="#input_text">input_text</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="#placeholder">placeholder</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="#root">root</a></td>
-	<td class="summary">Root node</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#text_position">text_position</a></td>
-	<td class="summary">On input field text change to empty 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 = "get_text"></a>
-    <strong>get_text(self)</strong>
-    </dt>
-    <dd>
-    Set input field 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>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "init"></a>
-    <strong>init(self, template, nodes)</strong>
-    </dt>
-    <dd>
-    The <a href="../modules/RichInput.html#">RichInput</a> constructor
-
-
-    <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 = "select"></a>
-    <strong>select(self)</strong>
-    </dt>
-    <dd>
-    Select input field
-
-
-    <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>
-    </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">RichInput</span></span>
-         <a href="../modules/RichInput.html#">RichInput</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">RichInput</span></span>
-        Current instance
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_font"></a>
-    <strong>set_font(self, font)</strong>
-    </dt>
-    <dd>
-    Set input field font
-
-
-    <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">font</span>
-            <span class="types"><span class="type">hash</span></span>
-         The font hash
-        </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_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>
-    <dt>
-    <a name = "set_text"></a>
-    <strong>set_text(self, text)</strong>
-    </dt>
-    <dd>
-    Set input field 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">text</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
-         The input text
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">druid.input</span></span>
-        Current input instance
-    </ol>
-
-
-
-
-</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 = "cursor_position"></a>
-    <strong>cursor_position</strong>
-    </dt>
-    <dd>
-    On input field text change to empty string callback(self, input_text)
-
-
-    <ul>
-        <li><span class="parameter">cursor_position</span>
-            <span class="types"><span class="type">vector3</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "cursor_text"></a>
-    <strong>cursor_text</strong>
-    </dt>
-    <dd>
-    On input field text change to empty string callback(self, input_text)
-
-
-    <ul>
-        <li><span class="parameter">cursor_text</span>
-            <span class="types"><span class="type">node</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "drag"></a>
-    <strong>drag</strong>
-    </dt>
-    <dd>
-    On input field text change to empty string callback(self, input_text)
-
-
-    <ul>
-        <li><span class="parameter">drag</span>
-            <span class="types"><span class="type">druid.drag</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 = "input_text"></a>
-    <strong>input_text</strong>
-    </dt>
-    <dd>
-    On input field text change to empty string callback(self, input_text)
-
-
-    <ul>
-        <li><span class="parameter">input_text</span>
-            <span class="types"><span class="type">druid.text</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "placeholder"></a>
-    <strong>placeholder</strong>
-    </dt>
-    <dd>
-    On input field text change to empty string callback(self, input_text)
-
-
-    <ul>
-        <li><span class="parameter">placeholder</span>
-            <span class="types"><span class="type">druid.text</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "root"></a>
-    <strong>root</strong>
-    </dt>
-    <dd>
-    Root node
-
-
-    <ul>
-        <li><span class="parameter">root</span>
-            <span class="types"><span class="type">node</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "text_position"></a>
-    <strong>text_position</strong>
-    </dt>
-    <dd>
-    On input field text change to empty string callback(self, input_text)
-
-
-    <ul>
-        <li><span class="parameter">text_position</span>
-            <span class="types"><span class="type">vector3</span></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/RichText.html

@@ -1,560 +0,0 @@
-<!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/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/Progress.html">Progress</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> Create Rich Text on your GUI Text Node. All properties of the text node will be used as default for the text.
-<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,
-  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="#characters">characters(self, word)</a></td>
-	<td class="summary">Split a word into it's characters</td>
-	</tr>
-	<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_text">get_text(self)</a></td>
-	<td class="summary">Get current text</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, text_node, value)</a></td>
-	<td class="summary">The <a href="../modules/RichText.html#">RichText</a> 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(self, 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>
-<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="#root">root</a></td>
-	<td class="summary">The root node of the Rich Text</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#text_prefab">text_prefab</a></td>
-	<td class="summary">The text prefab node</td>
-	</tr>
-</table>
-
-<br/>
-<br/>
-
-
-    <h2 class="section-header "><a name="Functions"></a>Functions</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "characters"></a>
-    <strong>characters(self, word)</strong>
-    </dt>
-    <dd>
-    Split a word into it's characters
-
-
-    <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">word</span>
-            <span class="types"><span class="type">druid.rich_text.word</span></span>
-
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">druid.rich_text.word[]</span></span>
-        characters
-    </ol>
-
-
-
-
-</dd>
-    <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_text"></a>
-    <strong>get_text(self)</strong>
-    </dt>
-    <dd>
-    Get current 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>
-    </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>
-        text
-    </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, text_node, value)</strong>
-    </dt>
-    <dd>
-    The <a href="../modules/RichText.html#">RichText</a> 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">text_node</span>
-            <span class="types"><span class="type">node</span> or <a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
-         The text node to make Rich Text
-        </li>
-        <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> or <span class="type">nil</span></span>
-         The initial text value. Default will be gui.get_text(text_node)
-        </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> or <span class="type">nil</span></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(self, tag)</strong>
-    </dt>
-    <dd>
-    Get all words, which has a passed tag.
-
-
-    <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">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> or <span class="type">nil</span></span>
-         Rich Text color aliases. Default: {}
-        </li>
-        <li><span class="parameter">ADJUST_STEPS</span>
-            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
-         Amount steps of attemps text adjust by height. Default: 20
-        </li>
-        <li><span class="parameter">ADJUST_SCALE_DELTA</span>
-            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
-         Scale step on each height adjust step. Default: 0.02
-        </li>
-    </ul>
-
-
-
-
-
-</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 = "root"></a>
-    <strong>root</strong>
-    </dt>
-    <dd>
-    The root node of the Rich Text
-
-
-    <ul>
-        <li><span class="parameter">root</span>
-            <span class="types"><span class="type">node</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "text_prefab"></a>
-    <strong>text_prefab</strong>
-    </dt>
-    <dd>
-    The text prefab node
-
-
-    <ul>
-        <li><span class="parameter">text_prefab</span>
-            <span class="types"><span class="type">node</span></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/Slider.html

@@ -1,531 +0,0 @@
-<!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/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/Progress.html">Progress</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>
-</ul>
-
-</div>
-
-<div id="content">
-
-<h1>Module <code>Slider</code></h1>
-<p>Druid slider component</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>
-<table class="function_list">
-	<tr>
-	<td class="name" nowrap><a href="#init">init(self, node, end_pos, callback)</a></td>
-	<td class="summary">The <a href="../modules/Slider.html#">Slider</a> constructor</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#is_enabled">is_enabled(self)</a></td>
-	<td class="summary">Check if Slider component is enabled</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#set">set(self, value, is_silent)</a></td>
-	<td class="summary">Set value for slider</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#set_enabled">set_enabled(self, is_enabled)</a></td>
-	<td class="summary">Set Slider input enabled or disabled</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>
-</table>
-<h2><a href="#Fields">Fields</a></h2>
-<table class="function_list">
-	<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="#end_pos">end_pos</a></td>
-	<td class="summary">End pin node 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>
-</table>
-
-<br/>
-<br/>
-
-
-    <h2 class="section-header "><a name="Functions"></a>Functions</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "init"></a>
-    <strong>init(self, node, end_pos, callback)</strong>
-    </dt>
-    <dd>
-    The <a href="../modules/Slider.html#">Slider</a> constructor
-
-
-    <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">node</span>
-            <span class="types"><a class="type" href="../modules/Slider.html#node">node</a></span>
-         Gui pin node
-        </li>
-        <li><span class="parameter">end_pos</span>
-            <span class="types"><span class="type">vector3</span></span>
-         The end position of slider
-        </li>
-        <li><span class="parameter">callback</span>
-            <span class="types"><span class="type">function</span> or <span class="type">nil</span></span>
-         On slider change callback
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "is_enabled"></a>
-    <strong>is_enabled(self)</strong>
-    </dt>
-    <dd>
-    Check if Slider component is enabled
-
-
-    <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>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">boolean</span></span>
-
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set"></a>
-    <strong>set(self, value, is_silent)</strong>
-    </dt>
-    <dd>
-    Set value for slider
-
-
-    <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">value</span>
-            <span class="types"><span class="type">number</span></span>
-         Value from 0 to 1
-        </li>
-        <li><span class="parameter">is_silent</span>
-            <span class="types"><span class="type">boolean</span> or <span class="type">nil</span></span>
-         Don't trigger event if true
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_enabled"></a>
-    <strong>set_enabled(self, is_enabled)</strong>
-    </dt>
-    <dd>
-    Set Slider input enabled or disabled
-
-
-    <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">is_enabled</span>
-            <span class="types"><span class="type">boolean</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</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"><a class="type" href="../modules/Slider.html#node">node</a>, <a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a> or <span class="type">nil</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>
-    <strong>set_steps(self, steps)</strong>
-    </dt>
-    <dd>
-    Set slider steps.  Pin node will
- apply closest step position
-
-
-    <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">steps</span>
-            <span class="types"><span class="type">number[]</span></span>
-         Array of steps
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">Slider</span></span>
-        <a href="../modules/Slider.html#">Slider</a>
-    </ol>
-
-
-
-    <h3>Usage:</h3>
-    <ul>
-        <pre class="example">slider:set_steps({<span class="number">0</span>, <span class="number">0.2</span>, <span class="number">0.6</span>, <span class="number">1</span>})</pre>
-    </ul>
-
-</dd>
-</dl>
-    <h2 class="section-header "><a name="Fields"></a>Fields</h2>
-
-    <dl class="function">
-    <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">vector3</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "end_pos"></a>
-    <strong>end_pos</strong>
-    </dt>
-    <dd>
-    End pin node position
-
-
-    <ul>
-        <li><span class="parameter">end_pos</span>
-            <span class="types"><span class="type">vector3</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "is_drag"></a>
-    <strong>is_drag</strong>
-    </dt>
-    <dd>
-    Current drag state
-
-
-    <ul>
-        <li><span class="parameter">is_drag</span>
-            <span class="types"><span class="type">boolean</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 = "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>
-    <strong>value</strong>
-    </dt>
-    <dd>
-    Current slider value
-
-
-    <ul>
-        <li><span class="parameter">value</span>
-            <span class="types"><span class="type">number</span></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/Swipe.html

@@ -1,288 +0,0 @@
-<!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/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/Progress.html">Progress</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>
-</ul>
-
-</div>
-
-<div id="content">
-
-<h1>Module <code>Swipe</code></h1>
-<p>Component to handle swipe gestures on node.</p>
-<p>
- Swipe will be triggered, if swipe was started and
- 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>
-<table class="function_list">
-	<tr>
-	<td class="name" nowrap><a href="#init">init(self, node, on_swipe_callback)</a></td>
-	<td class="summary">The <a href="../modules/Swipe.html#">Swipe</a> constructor</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#set_click_zone">set_click_zone(self, zone)</a></td>
-	<td class="summary">Strict swipe click area.</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="#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>
-	</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, node, on_swipe_callback)</strong>
-    </dt>
-    <dd>
-    The <a href="../modules/Swipe.html#">Swipe</a> constructor
-
-
-    <h3>Parameters:</h3>
-    <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>
-         Gui node
-        </li>
-        <li><span class="parameter">on_swipe_callback</span>
-            <span class="types"><span class="type">function</span></span>
-         Swipe callback for on_swipe_end event
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_click_zone"></a>
-    <strong>set_click_zone(self, zone)</strong>
-    </dt>
-    <dd>
-    Strict swipe click area.  Useful for
- restrict events outside stencil node
-
-
-    <h3>Parameters:</h3>
-    <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>, <a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a> or <span class="type">nil</span></span>
-         Gui node
-        </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">SWIPE_TIME</span>
-            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
-         Maximum time for swipe trigger. Default: 0.4
-        </li>
-        <li><span class="parameter">SWIPE_THRESHOLD</span>
-            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
-         Minimum distance for swipe trigger. Default: 50
-        </li>
-        <li><span class="parameter">SWIPE_TRIGGER_ON_MOVE</span>
-            <span class="types"><span class="type">boolean</span> or <span class="type">nil</span></span>
-         If true, trigger on swipe moving, not only release action. Default: false
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-</dl>
-    <h2 class="section-header "><a name="Fields"></a>Fields</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "click_zone"></a>
-    <strong>click_zone</strong>
-    </dt>
-    <dd>
-    Restriction zone
-
-
-    <ul>
-        <li><span class="parameter">click_zone</span>
-            <span class="types"><a class="type" href="../modules/Swipe.html#node">node</a> or <span class="type">nil</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</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)
-
-
-    <ul>
-        <li><span class="parameter">on_swipe</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/Text.html

@@ -1,942 +0,0 @@
-<!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/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/Progress.html">Progress</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>
-</ul>
-
-</div>
-
-<div id="content">
-
-<h1>Module <code>Text</code></h1>
-<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="#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_index_by_width">get_text_index_by_width(self, width)</a></td>
-	<td class="summary">Get chars count by width</td>
-	</tr>
-	<tr>
-	<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="#init">init(self, node, value, adjust_type)</a></td>
-	<td class="summary">The <a href="../modules/Text.html#">Text</a> constructor</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>
-	</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_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="#set_scale">set_scale(self, scale)</a></td>
-	<td class="summary">Set scale</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#set_size">set_size(self, size)</a></td>
-	<td class="summary">Set text area size</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="#adjust_type">adjust_type</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>
-	<tr>
-	<td class="name" nowrap><a href="#last_value">last_value</a></td>
-	<td class="summary">The last text value</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="#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>
-	<tr>
-	<td class="name" nowrap><a href="#text_area">text_area</a></td>
-	<td class="summary">Current text node available are</td>
-	</tr>
-</table>
-
-<br/>
-<br/>
-
-
-    <h2 class="section-header "><a name="Functions"></a>Functions</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "get_text_adjust"></a>
-    <strong>get_text_adjust(self, adjust_type)</strong>
-    </dt>
-    <dd>
-    Return current text adjust type
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">self</span>
-
-        </li>
-        <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_index_by_width"></a>
-    <strong>get_text_index_by_width(self, width)</strong>
-    </dt>
-    <dd>
-    Get chars count by width
-
-
-    <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">width</span>
-            <span class="types"><span class="type">number</span></span>
-
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">number</span></span>
-        Chars count
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <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
-
-
-    <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">text</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
-        |nil
-        </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 = "init"></a>
-    <strong>init(self, node, value, adjust_type)</strong>
-    </dt>
-    <dd>
-    The <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">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>
-        <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> or <span class="type">nil</span></span>
-         Initial text. Default value is node text from GUI scene. Default: nil
-        </li>
-        <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> or <span class="type">nil</span></span>
-         Adjust type for text. By default is DOWNSCALE. Look const.TEXT_ADJUST for reference. Default: DOWNSCALE
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "is_multiline"></a>
-    <strong>is_multiline(self)</strong>
-    </dt>
-    <dd>
-    Return true, if text with line break
-
-
-    <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>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">boolean</span></span>
-        Is text node with line break
-    </ol>
-
-
-
-
-</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">number</span></span>
-         The 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_size"></a>
-    <strong>set_size(self, size)</strong>
-    </dt>
-    <dd>
-    Set text area size
-
-
-    <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">size</span>
-            <span class="types"><span class="type">vector3</span></span>
-         The new text area size
-        </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"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a> or <span class="type">nil</span></span>
-         See const.TEXT_ADJUST. If pass nil - use current adjust type
-        </li>
-        <li><span class="parameter">minimal_scale</span>
-            <span class="types"><span class="type">number</span> or <span class="type">nil</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_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> or <span class="type">nil</span></span>
-         The postfix for TRIM adjust type. Default: ...
-        </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> or <span class="type">nil</span></span>
-         The default adjust type for any text component. Default: DOWNSCALE
-        </li>
-        <li><span class="parameter">ADJUST_STEPS</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">nil</span></span>
-         Amount of iterations for text adjust by height. Default: 20
-        </li>
-        <li><span class="parameter">ADJUST_SCALE_DELTA</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">nil</span></span>
-         Scale step on each height adjust step. Default: 0.02
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-</dl>
-    <h2 class="section-header "><a name="Fields"></a>Fields</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "adjust_type"></a>
-    <strong>adjust_type</strong>
-    </dt>
-    <dd>
-    Current text size adjust settings
-
-
-    <ul>
-        <li><span class="parameter">adjust_type</span>
-            <span class="types"><span class="type">number</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>
-    <dt>
-    <a name = "last_value"></a>
-    <strong>last_value</strong>
-    </dt>
-    <dd>
-    The last text value
-
-
-    <ul>
-        <li><span class="parameter">last_value</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>
-    Text node
-
-
-    <ul>
-        <li><span class="parameter">node</span>
-            <span class="types"><a class="type" href="../modules/Text.html#node">node</a></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</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>
-    <strong>pos</strong>
-    </dt>
-    <dd>
-    Current text position
-
-
-    <ul>
-        <li><span class="parameter">pos</span>
-            <span class="types"><span class="type">vector3</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "scale"></a>
-    <strong>scale</strong>
-    </dt>
-    <dd>
-    Current text node scale
-
-
-    <ul>
-        <li><span class="parameter">scale</span>
-            <span class="types"><span class="type">vector3</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "start_scale"></a>
-    <strong>start_scale</strong>
-    </dt>
-    <dd>
-    Initial text node scale
-
-
-    <ul>
-        <li><span class="parameter">start_scale</span>
-            <span class="types"><span class="type">vector3</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "start_size"></a>
-    <strong>start_size</strong>
-    </dt>
-    <dd>
-    Initial text node size
-
-
-    <ul>
-        <li><span class="parameter">start_size</span>
-            <span class="types"><span class="type">vector3</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "text_area"></a>
-    <strong>text_area</strong>
-    </dt>
-    <dd>
-    Current text node available are
-
-
-    <ul>
-        <li><span class="parameter">text_area</span>
-            <span class="types"><span class="type">vector3</span></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/Timer.html

@@ -1,409 +0,0 @@
-<!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/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/Progress.html">Progress</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>
-</ul>
-
-</div>
-
-<div id="content">
-
-<h1>Module <code>Timer</code></h1>
-<p>Component to handle GUI timers.</p>
-<p>
- Timer updating by game delta time. If game is not focused -
- timer will be not updated.</p>
-
-
-<h2><a href="#Functions">Functions</a></h2>
-<table class="function_list">
-	<tr>
-	<td class="name" nowrap><a href="#init">init(self, node, seconds_from, seconds_to, callback)</a></td>
-	<td class="summary">The <a href="../modules/Timer.html#">Timer</a> constructor</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>
-	</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_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="#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="#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>
-	<td class="summary">Target timer value</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#value">value</a></td>
-	<td class="summary">Current timer value</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, node, seconds_from, seconds_to, callback)</strong>
-    </dt>
-    <dd>
-    The <a href="../modules/Timer.html#">Timer</a> constructor
-
-
-    <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">node</span>
-            <span class="types"><a class="type" href="../modules/Timer.html#node">node</a></span>
-         Gui text node
-        </li>
-        <li><span class="parameter">seconds_from</span>
-            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
-         Start timer value in seconds
-        </li>
-        <li><span class="parameter">seconds_to</span>
-            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
-         End timer value in seconds
-        </li>
-        <li><span class="parameter">callback</span>
-            <span class="types"><span class="type">function</span> or <span class="type">nil</span></span>
-         Function on timer end
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_interval"></a>
-    <strong>set_interval(self, from, to)</strong>
-    </dt>
-    <dd>
-    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">from</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
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "set_state"></a>
-    <strong>set_state(self, is_on)</strong>
-    </dt>
-    <dd>
-    Called when update
-
-
-    <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">is_on</span>
-            <span class="types"><span class="type">boolean</span> or <span class="type">nil</span></span>
-         Timer enable state
-        </li>
-    </ul>
-
-
-
-
-
-</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">Timer</span></span>
-         <a href="../modules/Timer.html#">Timer</a>
-        </li>
-        <li><span class="parameter">set_to</span>
-            <span class="types"><span class="type">number</span></span>
-         Value in seconds
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-</dl>
-    <h2 class="section-header "><a name="Fields"></a>Fields</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "from"></a>
-    <strong>from</strong>
-    </dt>
-    <dd>
-    Initial timer value
-
-
-    <ul>
-        <li><span class="parameter">from</span>
-            <span class="types"><span class="type">number</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "node"></a>
-    <strong>node</strong>
-    </dt>
-    <dd>
-    Trigger node
-
-
-    <ul>
-        <li><span class="parameter">node</span>
-            <span class="types"><a class="type" href="../modules/Timer.html#node">node</a></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</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">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>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "target"></a>
-    <strong>target</strong>
-    </dt>
-    <dd>
-    Target timer value
-
-
-    <ul>
-        <li><span class="parameter">target</span>
-            <span class="types"><span class="type">number</span></span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "value"></a>
-    <strong>value</strong>
-    </dt>
-    <dd>
-    Current timer value
-
-
-    <ul>
-        <li><span class="parameter">value</span>
-            <span class="types"><span class="type">number</span></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/druid.extended.layout.html

@@ -1,95 +0,0 @@
-<!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>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/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><strong>druid.extended.layout</strong></li>
-</ul>
-
-</div>
-
-<div id="content">
-
-<h1>Module <code>druid.extended.layout</code></h1>
-<p>Druid layout module
-<p> <b># Overview #</b>
-<p> Layout component works like Dynamic Grid before - for aligning elements in a row or column.</p>
-<p> Works like a Figma layout.
-<p> <b># Notes</p>
-
-
-
-<br/>
-<br/>
-
-
-
-
-</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/druid.system.utf8.html

@@ -1,93 +0,0 @@
-<!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>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><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><strong>druid.system.utf8</strong></li>
-</ul>
-
-</div>
-
-<div id="content">
-
-<h1>Module <code>druid.system.utf8</code></h1>
-<p></p>
-<p></p>
-
-
-
-<br/>
-<br/>
-
-
-
-
-</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_md/01-components.md

@@ -1,372 +0,0 @@
-# Druid components
-
-
-## Button
-[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.
-
-### Setup
-Create button with druid: `button = druid:new_button(node_name, callback, [params], [animation_node])`
-Where node name is name of node from GUI scene. You can use `node_name` as input trigger zone and point another node for animation via `animation_node`
-
-### Usecase
-_fill example usecases_
-
-### Notes
-- Button callback have next params: (self, params, button_instance)
-	- **self** - Druid self context
-	- **params** - Additional params, specified on button creating
-	- **button_instance** - button itself
-- You can set _params_ on button callback on button creating: `druid:new_button("node_name", callback, params)`. This _params_ will pass in callback as second argument
-- Button have next events:
-	- **on_click** - basic button callback
-	- **on_repeated_click** - repeated click callback, while holding the button, don't trigger if callback is empty
-	- **on_long_click** - callback on long button tap, don't trigger if callback is empty
-	- **on_hold_click** - hold callback, before long_click trigger, don't trigger if callback is empty
-	- **on_double_click** - different callback, if tap button 2+ in row, don't trigger if callback is empty
-- Click event will not trigger, if between pressed and released state cursor was outside of node zone
-- If button have double click event and it is triggered, usual callback will be not invoked
-- If you have stencil on buttons and you don't want trigger them outside of stencil node, you can use `button:set_click_zone` to restrict button click zone
-- Button can have key trigger to use then by key: `button:set_key_trigger`
-- Animation node can be used for example to animate small icon on big panel. Node name of trigger zone will be `big panel` and animation node will be `small icon`
-
-
-## Text
-[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], [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_
-
-![](../media/text_autosize.png)
-
-- Text pivot can be changed with `text:set_pivot`, and text will save their position inside their text size box:
-
-![](../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/Blocker.html)
-
-### Overview
-Druid component for block input. Use it to block input in special zone.
-
-### Setup
-Create blocker component with druid: `druid:new_blocker(node_name)`
-
-### Notes
-Explanation:
-![](../media/blocker_scheme.png)
-
-Blue zone is **button** with close_window callback
-
-Yellow zone is blocker with window content
-
-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/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.
-
-### Setup
-Setup callback with `druid:new_back_handler(callback)`
-
-### Notes
-
-
-## Lang text
-[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
-
-### Setup
-Create lang text component with druid `text = druid:new_lang_text(node_name, locale_id)`
-
-### Notes
-
-
-## Scroll
-[Scroll API here](https://insality.github.io/druid/modules/Scroll.html)
-
-### Overview
-Basic Druid scroll component. Handle all scrolling stuff in druid GUI
-
-### Setup
-Create scroll component with druid: `scroll = druid:new_scroll(view_node, content_node)`.
-
-_View_node_ - is static part. It capturing user input and recognize scrolling touches
-
-_Content_node_ - is dynamic part. This node will change position by scroll system
-
-Initial scroll size will be equal to _content_node_ node size. The initial view box will be equal to _view_node_ node size
-
-Usually, Place _view_node_ and as children add _content_node_:
-![](../media/scroll_scheme.png)
-![](../media/scroll_outline.png)
-
-*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/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_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/Progress.html)
-
-### Overview
-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.
-Key is value from druid const: const.SIDE.X (or just "x") or const.SIDE.Y (or just "y")
-
-### Notes
-- Progress correct working with 9slice nodes, it trying to set size by _set_size_ first, if it is not possible, it set up sizing via _set_scale_
-- Progress bar can fill only by vertical or horizontal size. If you want make diagonal progress bar, just rotate node in GUI scene
-- If you have glitchy or dark texture bug with progress bar, try to disable mipmaps in your texture profiles
-
-
-## Slider
-[Slider API here](https://insality.github.io/druid/modules/Slider.html)
-
-### Overview
-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.
-
-### 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)
-- For now, start pos and end pos should be on vertical or horizontal line (their x or y value should be equal)
-
-
-## Input
-[Input API here](https://insality.github.io/druid/modules/Input.html)
-
-### Overview
-Basic Druid text input component
-
-### Setup
-Create input component with druid: `input = druid:new_input(button_node_name, text_node_name, keyboard_type)`
-
-### Notes
-- Input component handle user text input. Input contains from button and text components. Button needed for selecting/unselecting input field
-- Long click on input field for clear and select input field (clearing can be disable via styles)
-- Click outside of button to unselect input field
-- On focus lost (game minimized) input field will be unselected
-- You can setup max length of the text
-- You can setup allowed characters. On add not allowed characters `on_input_wrong` will be called. By default it cause simple shake animation
-- The keyboard for input will not show on mobile HTML5. So input field in mobile HTML5 is not working now
-- To make work different keyboard type, make sure value in game.project Android:InputMethod set to HidderInputField (https://defold.com/manuals/project-settings/#input-method)
-
-
-## Timer
-[Timer API here](https://insality.github.io/druid/modules/Timer.html)
-
-### Overview
-Handle timer work on gui text node
-
-### Setup
-Create timer component with druid: `timer = druid:new_timer(text_node, from_seconds, to_seconds, callback)`
-
-### Notes
-- Timer fires callback, when timer value equals to _to_seconds_
-- Timer will set text node with current timer value
-- Timer uses update function to handle time
-
-
-## Static Grid
-[Static Grid API here](https://insality.github.io/druid/modules/StaticGrid.html)
-
-### Overview
-Component for manage node positions.
-Static grid have constant node size, so it possible to calculate node positions before placement. Nodes can be placed with gaps.
-Static grid can shift elements on add/remove functions.
-
-### Setup
-Create  component with druid: `grid = druid:new_grid(parent_node, prefab_node, max_in_row_elements)`
-
-### Notes
-- On _add node_ grid will set nodeup parent to _parent_node_
-- You can get array of position of every element for setup points of interest in scroll component
-- You can get size of all elements for setup size in scroll component
-- You can also bind the grid to the scroll component for auto resize scroll content size
-- Pivot of parent_node matter for node placement
-- _Prefab node_ used to get node size and anchor
-- You can point *position_function* for animations with _static_grid:set_position_function(node, pos)_ callback. Default - *gui.set_position()*
-
-## 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/Hover.html)
-
-### Overview
-System Druid component, handle hover node state.
-
-### Setup
-Create hover component with druid: `hover = druid:new_hover(node, callback)`
-
-### Notes
-- By default, hover handles _hover event_ with pressed touch action_id. So it's mean, what mouse or touch have to be pressed
-- On desktop platforms there is _on_mouse_hover_ event. It's event on mouse hover without any action id
-- By default, assume what node is on not hovered state (both _hover_ and _mouse_hover_)
-
-
-## Swipe
-[Swipe API here](https://insality.github.io/druid/modules/Swipe.html)
-
-### Overview
-System Druid component, handle swipe actions on node
-
-### Setup
-Create swipe component with druid: `hover = druid:new_swipe(node, swipe_callback)`
-
-### Notes
-- Swipe callback have next params: (self, swipe_side, distance, time)
-	- **self** - Druid self context
-	- **swipe_side**: *string* - values from ["up", "down", "left", "right"]
-	- **distance**: *number* - in pixels, distance of swipe
-	- **time**: *number* - in seconds, time of swiping
-- Swipe trigger only, if all input actions was on swipe node. If action will be outside of node, swipe status will be reseted
-- In swipe style table you can adjust minimal distance and maximum time to trigg-  Hover state trigger only with touch on mobile devices or button mouse holding. Just mouse over swipe
-- In swipe style table you can toggle type of swipe triggering. if SWIPE_TRIGGER_ON_MOVE setup to true - swipe will trigger as swipe can be triggered. If setup to false - swipe will trigger only on released action
-- If you have stencil on swipe node and you don't want trigger it outside of stencil node, you can use `swipe:set_click_zone` to restrict swipe zonethout buttons is now not allowed.
-
-
-## Drag
-[Drag API here](https://insality.github.io/druid/modules/Drag.html)
-
-### Overview
-System Druid component, handle drag actions on node
-
-### Setup
-Create drag component with druid: `hover = druid:new_drag(node, drag_callback)`
-
-### Notes
-- 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
-- You can get info about current drag state:
-	- _is_touch_ - Is currently node touching
-	- _is_drag_ - Is currently node is dragging
-	- _x_ and _y_ - Current touch position
-	- _touch_start_pos_ - Touch stat positions
-- Drag have next events:
-	- _on_touch_start_ (self) - Event on touch start
-	- _on_touch_end_ (self) - Event on touch end
-	- _on_drag_start_ (self) - Event on drag start
-	- _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 arrange nodes inside layout node with margin/paddings settings. Works with different node sizes and pivots. Works in the same way as Figma AutoLayout
-
-### 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)`
-
-
-### Notes
-- Layout mode can be next:
-	- `horizontal` - arrange nodes in horizontal line
-	- `vertical` - arrange nodes in vertical line
-	- `horizontal_wrap` - arrange nodes in horizontal line with wrap to next line
-- You can setup margin and padding for layout nodes
-- You can set "justify" alignment to place nodes with the same margin between layout node borders
-- You can set "hug" by content. This option will set layout node size by content size. Can be setup separately for width and height
-

docs_md/FAQ.md

@@ -1,36 +0,0 @@
-# Druid FAQ
-
-Welcome to the Druid FAQ! Here are answers to some common questions you may have:
-
-### 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: 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 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: 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
--- Assuming the scroll view node is the stencil node
-button:set_click_zone(scroll.view_node)
-```
-
-### 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")
-
--- Autocomplete and type information should now work
-```
-
-Feel free to ask any additional questions you have about Druid!

docs_md/quick_api_reference.md

@@ -1,74 +0,0 @@
-# Quick API Reference
-
-## Druid
-```lua
-local druid = require("druid.druid")
-
-druid.init_window_listener()
-druid.on_language_change()
-druid.on_window_callback(window_event)
-druid.set_default_style(style)
-druid.set_sound_function(callback)
-druid.set_text_function(callback)
-
-self.druid = druid.new(context, [style])
-```
-
-## Druid Instance
-```lua
-self.druid:final()
-self.druid:update(dt)
-self.druid:on_input(action_id, action)
-self.druid:on_message(message_id, message, sender)
-
-self.druid:new(component, ...)
-self.druid:new_back_handler([callback], [params])
-self.druid:new_blocker(node)
-self.druid:new_button(node, [callback], [params], [anim_node])
-self.druid:new_container(node, [mode], [callback])
-self.druid:new_data_list(druid_scroll, druid_grid, create_function)
-self.druid:new_drag(node, [on_drag_callback])
-self.druid:new_grid(parent_node, item, [in_row])
-self.druid:new_hotkey(keys_array, [callback], [callback_argument])
-self.druid:new_hover(node, [on_hover_callback], [on_mouse_hover_callback])
-self.druid:new_input(click_node, text_node, [keyboard_type])
-self.druid:new_lang_text(node, [locale_id], [adjust_type])
-self.druid:new_layout(node, [mode])
-self.druid:new_progress(node, key, [init_value])
-self.druid:new_rich_input(template, [nodes])
-self.druid:new_rich_text(text_node, [value])
-self.druid:new_scroll(view_node, content_node)
-self.druid:new_slider(pin_node, end_pos, [callback])
-self.druid:new_swipe(node, [on_swipe_callback])
-self.druid:new_text(node, [value], [no_adjust])
-self.druid:new_timer(node, [seconds_from], [seconds_to], [callback])
-self.druid:new_widget(widget, [template], [nodes], ...)
-self.druid:on_window_event([window_event])
-self.druid:remove(component)
-self.druid:set_blacklist(blacklist_components)
-self.druid:set_whitelist(whitelist_components)
-```
-
-## Components
-### Base Component
-### Blocker
-### Button
-### Container
-### Data List
-### Drag
-### Grid
-### Hotkey
-### Hover
-### Input
-### Lang Text
-### Layout
-### Progress
-### Rich Input
-### Rich Text
-### Scroll
-### Slider
-### Swipe
-### Text
-### Timer
-
-## Helper

druid.code-workspace

@@ -1,31 +0,0 @@
-{
-	"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

@@ -2,28 +2,35 @@ local event = require("event.event")
 local const = require("druid.const")
 local component = require("druid.component")
 
----@class druid.back_handler: druid.base_component
+---Component to handle back button. It handles Android back button and Backspace key.
+---
+---### Setup
+---Create back handler component with druid: `druid:new_back_handler(callback)`
+---
+---### Notes
+---- Key triggers in `input.binding` should be setup for correct working
+---- It uses a key_back and key_backspace action ids
+---@class druid.back_handler: druid.component
 ---@field on_back event Trigger on back handler action, fun(self, params)
 ---@field params any|nil Custom args to pass in the callback
 local M = component.create("back_handler")
 
 
----@param callback function|nil
----@param params any|nil
+---The Back Handler constructor
+---@param callback function|nil The callback to call when the back handler is triggered
+---@param params any? Custom args to pass in the callback
 function M:init(callback, params)
 	self.params = params
 	self.on_back = event.create(callback)
 end
 
 
----@param action_id string
----@param action table
+---@private
+---@param action_id hash The action id
+---@param action table The action table
+---@return boolean is_consumed True if the input was consumed
 function M:on_input(action_id, action)
-	if not action.released then
-		return false
-	end
-
-	if action_id == const.ACTION_BACK or action_id == const.ACTION_BACKSPACE then
+	if action.released and (action_id == const.ACTION_BACK or action_id == const.ACTION_BACKSPACE) then
 		self.on_back:trigger(self:get_context(), self.params)
 		return true
 	end

druid/base/blocker.lua

@@ -1,21 +1,33 @@
 local const = require("druid.const")
 local component = require("druid.component")
 
----@class druid.blocker: druid.base_component
----@field node node
----@field private _is_enabled boolean
+---Druid component for block input. Use it to block input in special zone.
+---
+---### Setup
+---Create blocker component with druid: `druid:new_blocker(node_name)`
+---
+---### Notes
+---- Blocker can be used to create safe zones, where you have big buttons
+---- Blocker will capture all input events that hit the node, preventing them from reaching other components
+---- Blocker works placed as usual component in stack, so any other component can be placed on top of it and will work as usual
+---@class druid.blocker: druid.component
+---@field node node The node that will block input
+---@field private _is_enabled boolean Whether blocker is enabled
 local M = component.create("blocker")
 
 
----@param node node
+---The Blocker constructor
+---@param node node|string The node to use as a blocker
 function M:init(node)
 	self.node = self:get_node(node)
 	self._is_enabled = gui.is_enabled(self.node, true)
 end
 
 
----@param action_id string
----@param action table
+---@private
+---@param action_id string The action id
+---@param action table The action table
+---@return boolean is_consumed True if the input was consumed
 function M:on_input(action_id, action)
 	if action_id ~= const.ACTION_TOUCH and
 		action_id ~= const.ACTION_MULTITOUCH and
@@ -40,8 +52,8 @@ end
 
 
 ---Set blocker enabled state
----@param state boolean
----@return druid.blocker self
+---@param state boolean The new enabled state
+---@return druid.blocker self The blocker instance
 function M:set_enabled(state)
 	self._is_enabled = state
 
@@ -50,7 +62,7 @@ end
 
 
 ---Get blocker enabled state
----@return boolean
+---@return boolean is_enabled True if the blocker is enabled
 function M:is_enabled()
 	return self._is_enabled
 end

druid/base/button.lua

@@ -1,288 +1,10 @@
--- 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
-
-
---- The event: 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 event on_click event
-
-
---- The event: 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 event on_repeated_click event
-
-
---- The event: 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 event on_long_click event
-
-
---- The event: 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 event on_double_click event
-
-
---- The event: 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 event on_hold_callback event
-
-
---- The event: 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 event on_click_outside event
-
-
---- The event: 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 event on_pressed event
-
---- 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 node|nil anim_node Default node
-
----Custom args for any Button event. Setup in Button constructor
--- @tfield any params
-
---- The Hover: Button Hover component
--- @tfield Hover hover Hover
-
---- Additional button click area, defined by another GUI node
--- @tfield node|nil click_zone
-
----
-
 local event = require("event.event")
 local const = require("druid.const")
 local helper = require("druid.helper")
 local component = require("druid.component")
 
----Clickable node with various interaction callbacks
----@class druid.button: druid.base_component
----@field on_click event function(self, custom_args, button_instance)
----@field on_pressed event
----@field on_repeated_click event
----@field on_long_click event
----@field on_double_click event
----@field on_hold_callback event
----@field on_click_outside event
----@field node node
----@field node_id hash
----@field anim_node node
----@field params any
----@field hover druid.hover
----@field click_zone node|nil
----@field start_scale vector3
----@field start_pos vector3
----@field disabled boolean
----@field key_trigger hash
----@field style table
-local M = component.create("button")
-
-
-local function is_input_match(self, action_id)
-	if action_id == const.ACTION_TOUCH or action_id == const.ACTION_MULTITOUCH then
-		return true
-	end
-
-	if self.key_trigger and action_id == self.key_trigger then
-		return true
-	end
-
-	return false
-end
-
-
-local function on_button_hover(self, hover_state)
-	self.style.on_hover(self, self.anim_node, hover_state)
-end
-
-
-local function on_button_mouse_hover(self, hover_state)
-	self.style.on_mouse_hover(self, self.anim_node, hover_state)
-end
-
-
-local function on_button_click(self)
-	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
-
-
-local function on_button_repeated_click(self)
-	if not self.is_repeated_started then
-		self.click_in_row = 0
-		self.is_repeated_started = true
-	end
-
-	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.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.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
-
-
-local function on_button_hold(self, press_time)
-	self.on_hold_callback:trigger(self:get_context(), self.params, self, press_time)
-end
-
-
----@param self druid.button
-local function on_button_release(self)
-	if self.is_repeated_started then
-		return false
-	end
-
-	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
-			is_long_click = is_long_click and not self.on_long_click:is_empty()
-
-			local is_double_click = (time - self.last_released_time) < self.style.DOUBLETAP_TIME
-			is_double_click = is_double_click and not self.on_double_click:is_empty()
-
-			if is_long_click then
-				local is_hold_complete = (time - self.last_pressed_time) >= self.style.AUTOHOLD_TRIGGER
-				if is_hold_complete then
-					on_button_long_click(self)
-				else
-					self.on_click_outside:trigger(self:get_context(), self.params, self)
-				end
-			elseif is_double_click then
-				on_button_double_click(self)
-			else
-				on_button_click(self)
-			end
-
-			self.last_released_time = time
-		end
-		return true
-	end
-end
-
-
---- Component style params.
----You can override this component styles params in Druid styles table
----or create your own style
+---Button style params.
+---You can override this component styles params in Druid styles table or create your own style
 ---@class druid.button.style
 ---@field LONGTAP_TIME number|nil Minimum time to trigger on_hold_callback. Default: 0.4
 ---@field AUTOHOLD_TRIGGER number|nil Maximum hold time to trigger button release while holding. Default: 0.8
@@ -293,26 +15,49 @@ end
 ---@field on_mouse_hover fun(self, node, hover_state)|nil
 ---@field on_set_enabled fun(self, node, enabled_state)|nil
 
----@param style druid.button.style
-function M:on_style_change(style)
-	self.style = {}
-	self.style.LONGTAP_TIME = style.LONGTAP_TIME or 0.4
-	self.style.AUTOHOLD_TRIGGER = style.AUTOHOLD_TRIGGER or 0.8
-	self.style.DOUBLETAP_TIME = style.DOUBLETAP_TIME or 0.4
-
-	self.style.on_click = style.on_click or function(_, node) end
-	self.style.on_click_disabled = style.on_click_disabled or function(_, node) end
-	self.style.on_mouse_hover = style.on_mouse_hover or function(_, node, state) end
-	self.style.on_hover = style.on_hover or function(_, node, state) end
-	self.style.on_set_enabled = style.on_set_enabled or function(_, node, state) end
-end
+---Basic Druid input component. Handle input on node and provide different callbacks on touch events.
+---
+---### Setup
+---Create button with druid: `button = druid:new_button(node_name, callback, [params], [animation_node])`
+---Where node_name is name of node from GUI scene. You can use `node_name` as input trigger zone and point another node for animation via `animation_node`
+---
+---### Notes
+---- Button callback have next params: (self, params, button_instance)
+----   - **self** - Druid self context
+----   - **params** - Additional params, specified on button creating
+----   - **button_instance** - button itself
+---- You can set _params_ on button callback on button creating: `druid:new_button("node_name", callback, params)`.
+---- Button have several events like on_click, on_repeated_click, on_long_click, on_hold_click, on_double_click
+---- Click event will not trigger if between pressed and released state cursor was outside of node zone
+---- Button can have key trigger to use them by key: `button:set_key_trigger`
+----
+---@class druid.button: druid.component
+---@field on_click event function(self, custom_args, button_instance)
+---@field on_pressed event function(self, custom_args, button_instance)
+---@field on_repeated_click event function(self, custom_args, button_instance, click_count) Repeated click callback, while holding the button
+---@field on_long_click event function(self, custom_args, button_instance, hold_time) Callback on long button tap
+---@field on_double_click event function(self, custom_args, button_instance, click_amount) Different callback, if tap button 2+ in row
+---@field on_hold_callback event function(self, custom_args, button_instance, press_time) Hold callback, before long_click trigger
+---@field on_click_outside event function(self, custom_args, button_instance)
+---@field node node Clickable node
+---@field node_id hash Node id
+---@field anim_node node Animation node. In default case equals to clickable node
+---@field params any Custom arguments for any Button event
+---@field hover druid.hover Hover component for this button
+---@field click_zone node|nil Click zone node to restrict click area
+---@field start_scale vector3 Start scale of the button
+---@field start_pos vector3 Start position of the button
+---@field disabled boolean Is button disabled
+---@field key_trigger hash Key trigger for this button
+---@field style table Style for this button
+local M = component.create("button")
 
 
----Button constructor
----@param node_or_node_id node|string Node name or GUI Node itself.
+---The constructor for the button component
+---@param node_or_node_id node|string Node name or GUI Node itself
 ---@param callback fun()|nil Callback on button click
----@param custom_args any|nil Custom args for any Button event
----@param anim_node node|string|nil Node to animate instead of trigger node.
+---@param custom_args any|nil Custom args for any Button event, will be passed to callbacks
+---@param anim_node node|string|nil Node to animate instead of trigger node, useful for animating small icons on big panels
 function M:init(node_or_node_id, callback, custom_args, anim_node)
 	self.druid = self:get_druid()
 	self.node = self:get_node(node_or_node_id)
@@ -322,8 +67,8 @@ function M:init(node_or_node_id, callback, custom_args, anim_node)
 	self.start_scale = gui.get_scale(self.anim_node)
 	self.start_pos = gui.get_position(self.anim_node)
 	self.params = custom_args
-	self.hover = self.druid:new_hover(node_or_node_id, on_button_hover)
-	self.hover.on_mouse_hover:subscribe(on_button_mouse_hover)
+	self.hover = self.druid:new_hover(node_or_node_id, self._on_button_hover)
+	self.hover.on_mouse_hover:subscribe(self._on_button_mouse_hover)
 	self.click_zone = nil
 	self.is_repeated_started = false
 	self.last_pressed_time = 0
@@ -347,6 +92,39 @@ function M:init(node_or_node_id, callback, custom_args, anim_node)
 end
 
 
+---@private
+---@param style druid.button.style
+function M:on_style_change(style)
+	self.style = {
+		LONGTAP_TIME = style.LONGTAP_TIME or 0.4,
+		AUTOHOLD_TRIGGER = style.AUTOHOLD_TRIGGER or 0.8,
+		DOUBLETAP_TIME = style.DOUBLETAP_TIME or 0.4,
+
+		on_click = style.on_click or function(_, node) end,
+		on_click_disabled = style.on_click_disabled or function(_, node) end,
+		on_mouse_hover = style.on_mouse_hover or function(_, node, state) end,
+		on_hover = style.on_hover or function(_, node, state) end,
+		on_set_enabled = style.on_set_enabled or function(_, node, state) end,
+	}
+end
+
+
+---Remove default button style animations
+---@return druid.button self The current button instance
+function M:set_animations_disabled()
+	local empty_function = function() end
+
+	self.style.on_click = empty_function
+	self.style.on_hover = empty_function
+	self.style.on_mouse_hover = empty_function
+	self.style.on_set_enabled = empty_function
+	self.style.on_click_disabled = empty_function
+
+	return self
+end
+
+
+---@private
 function M:on_late_init()
 	if not self.click_zone then
 		local stencil_node = helper.get_closest_stencil_node(self.node)
@@ -357,8 +135,12 @@ function M:on_late_init()
 end
 
 
+---@private
+---@param action_id hash The action id
+---@param action table The action table
+---@return boolean is_consumed True if the input was consumed
 function M:on_input(action_id, action)
-	if not is_input_match(self, action_id) then
+	if not self:_is_input_match(action_id) then
 		return false
 	end
 
@@ -402,7 +184,7 @@ function M:on_input(action_id, action)
 		if self._is_html5_mode then
 			self._is_html5_listener_set = true
 			html5.set_interaction_listener(function()
-				on_button_click(self)
+				self:_on_button_click()
 			end)
 		end
 		return is_consume
@@ -411,25 +193,25 @@ function M:on_input(action_id, action)
 	-- While hold button, repeat rate pick from input.repeat_interval
 	if action.repeated then
 		if not self.on_repeated_click:is_empty() and self.can_action then
-			on_button_repeated_click(self)
+			self:_on_button_repeated_click()
 			return is_consume
 		end
 	end
 
 	if action.released then
-		return on_button_release(self) and is_consume
+		return self:_on_button_release() and is_consume
 	end
 
 	if self.can_action and not self.on_long_click:is_empty() then
 		local press_time = socket.gettime() - self.last_pressed_time
 
 		if self.style.AUTOHOLD_TRIGGER <= press_time then
-			on_button_release(self)
+			self:_on_button_release()
 			return is_consume
 		end
 
 		if press_time >= self.style.LONGTAP_TIME then
-			on_button_hold(self, press_time)
+			self:_on_button_hold(press_time)
 			return is_consume
 		end
 	end
@@ -438,6 +220,7 @@ function M:on_input(action_id, action)
 end
 
 
+---@private
 function M:on_input_interrupt()
 	self.can_action = false
 	self.hover:set_hover(false)
@@ -446,10 +229,10 @@ end
 
 
 ---Set button enabled state.
--- The style.on_set_enabled will be triggered.
--- Disabled button is not clickable.
+---The style.on_set_enabled will be triggered.
+---Disabled button is not clickable.
 ---@param state boolean|nil Enabled state
----@return druid.button self
+---@return druid.button self The current button instance
 function M:set_enabled(state)
 	self.disabled = not state
 	self.hover:set_enabled(state)
@@ -460,20 +243,18 @@ end
 
 
 ---Get button enabled state.
---
--- By default all Buttons is enabled on creating.
----@return boolean @True, if button is enabled now, False overwise
+---By default all Buttons is enabled on creating.
+---@return boolean is_enabled True, if button is enabled now, False overwise
 function M:is_enabled()
 	return not self.disabled
 end
 
 
 ---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
+---Useful to restrict click outside out stencil node or scrollable content.
+---If button node placed inside stencil node, it will be automatically set to this stencil node.
 ---@param zone node|string|nil Gui node
----@return druid.button self
+---@return druid.button self The current button instance
 function M:set_click_zone(zone)
 	self.click_zone = zone and self:get_node(zone) or nil
 	self.hover:set_click_zone(zone)
@@ -484,7 +265,7 @@ end
 
 ---Set key name to trigger this button by keyboard.
 ---@param key hash|string The action_id of the input key. Example: "key_space"
----@return druid.button self
+---@return druid.button self The current button instance
 function M:set_key_trigger(key)
 	if type(key) == "string" then
 		self.key_trigger = hash(key)
@@ -506,7 +287,7 @@ end
 ---Set function for additional check for button click availability
 ---@param check_function function|nil Should return true or false. If true - button can be pressed.
 ---@param failure_callback function|nil Function will be called on button click, if check function return false
----@return druid.button self
+---@return druid.button self The current button instance
 function M:set_check_function(check_function, failure_callback)
 	self._check_function = check_function
 	self._failure_callback = failure_callback
@@ -522,11 +303,131 @@ end
 ---
 ---If the game is not HTML, html mode will be not enabled
 ---@param is_web_mode boolean|nil If true - button will be called inside html5 callback
----@return druid.button self
+---@return druid.button self The current button instance
 function M:set_web_user_interaction(is_web_mode)
 	self._is_html5_mode = not not (is_web_mode and html5)
 	return self
 end
 
 
+---@param action_id hash The action id
+---@return boolean is_match True if the input matches the button
+function M:_is_input_match(action_id)
+	if action_id == const.ACTION_TOUCH or action_id == const.ACTION_MULTITOUCH then
+		return true
+	end
+
+	if self.key_trigger and action_id == self.key_trigger then
+		return true
+	end
+
+	return false
+end
+
+
+---@param hover_state boolean True if the hover state is active
+function M:_on_button_hover(hover_state)
+	self.style.on_hover(self, self.anim_node, hover_state)
+end
+
+
+---@param hover_state boolean True if the hover state is active
+function M:_on_button_mouse_hover(hover_state)
+	self.style.on_mouse_hover(self, self.anim_node, hover_state)
+end
+
+
+function M:_on_button_click()
+	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
+
+
+function M:_on_button_repeated_click()
+	if not self.is_repeated_started then
+		self.click_in_row = 0
+		self.is_repeated_started = true
+	end
+
+	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
+
+
+function M:_on_button_long_click()
+	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
+
+
+function M:_on_button_double_click()
+	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
+
+
+---@param press_time number Amount of time the button was held
+function M:_on_button_hold(press_time)
+	self.on_hold_callback:trigger(self:get_context(), self.params, self, press_time)
+end
+
+
+function M:_on_button_release()
+	if self.is_repeated_started then
+		return false
+	end
+
+	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
+			is_long_click = is_long_click and not self.on_long_click:is_empty()
+
+			local is_double_click = (time - self.last_released_time) < self.style.DOUBLETAP_TIME
+			is_double_click = is_double_click and not self.on_double_click:is_empty()
+
+			if is_long_click then
+				local is_hold_complete = (time - self.last_pressed_time) >= self.style.AUTOHOLD_TRIGGER
+				if is_hold_complete then
+					self:_on_button_long_click()
+				else
+					self.on_click_outside:trigger(self:get_context(), self.params, self)
+				end
+			elseif is_double_click then
+				self:_on_button_double_click()
+			else
+				self:_on_button_click()
+			end
+
+			self.last_released_time = time
+		end
+		return true
+	end
+end
+
+
 return M

druid/base/drag.lua

@@ -1,62 +1,3 @@
--- 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
-
---- Drag node
--- @tfield node node
-
---- Event on touch start callback(self)
--- @tfield event on_touch_start event
-
---- Event on touch end callback(self)
--- @tfield event on_touch_end event
-
---- Event on drag start callback(self, touch)
--- @tfield event on_drag_start event
-
---- on drag progress callback(self, dx, dy, total_x, total_y, touch)
--- @tfield event on_drag Event event
-
---- Event on drag end callback(self, total_x, total_y, touch)
--- @tfield event on_drag_end event
-
---- Is component now touching
--- @tfield boolean is_touch
-
---- Is component now dragging
--- @tfield boolean is_drag
-
---- Is drag component process vertical dragging. Default - true
--- @tfield boolean can_x
-
---- Is drag component process horizontal. Default - true
--- @tfield boolean can_y
-
---- Current touch x position
--- @tfield number x
-
---- Current touch y position
--- @tfield number y
-
---- Current touch x screen position
--- @tfield number screen_x
-
---- Current touch y screen position
--- @tfield number screen_y
-
---- Touch start position
--- @tfield vector3 touch_start_pos
-
----
-
 local event = require("event.event")
 local const = require("druid.const")
 local helper = require("druid.helper")
@@ -66,156 +7,37 @@ local component = require("druid.component")
 ---@field DRAG_DEADZONE number Distance in pixels to start dragging. Default: 10
 ---@field NO_USE_SCREEN_KOEF boolean If screen aspect ratio affects on drag values. Default: false
 
----@class druid.drag: druid.base_component
----@field node node
----@field on_touch_start event
----@field on_touch_end event
----@field on_drag_start event
----@field on_drag event
----@field on_drag_end event
----@field style druid.drag.style
----@field click_zone node|nil
----@field is_touch boolean
----@field is_drag boolean
----@field can_x boolean
----@field can_y boolean
----@field dx number
----@field dy number
----@field touch_id number
----@field x number
----@field y number
----@field screen_x number
----@field screen_y number
----@field touch_start_pos vector3
----@field private _is_enabled boolean
----@field private _x_koef number
----@field private _y_koef number
+---A component that allows you to subscribe to drag events over a node
+---@class druid.drag: druid.component
+---@field node node The node to subscribe to drag events over
+---@field on_touch_start event fun(self, touch) The event triggered when a touch starts
+---@field on_touch_end event fun(self, touch) The event triggered when a touch ends
+---@field on_drag_start event fun(self, touch) The event triggered when a drag starts
+---@field on_drag event fun(self, touch) The event triggered when a drag occurs
+---@field on_drag_end event fun(self, touch) The event triggered when a drag ends
+---@field style druid.drag.style The style of Drag component
+---@field click_zone node|nil The click zone of Drag component
+---@field is_touch boolean True if a touch is active
+---@field is_drag boolean True if a drag is active
+---@field can_x boolean True if Drag can move horizontally
+---@field can_y boolean True if Drag can move vertically
+---@field dx number The horizontal drag distance
+---@field dy number The vertical drag distance
+---@field touch_id number The touch id
+---@field x number The current x position
+---@field y number The current y position
+---@field screen_x number The current screen x position
+---@field screen_y number The current screen y position
+---@field touch_start_pos vector3 The touch start position
+---@field private _is_enabled boolean True if Drag component is enabled
+---@field private _x_koef number The x koef
+---@field private _y_koef number The y koef
 local M = component.create("drag", const.PRIORITY_INPUT_HIGH)
 
 
-local function start_touch(self, touch)
-	self.is_touch = true
-	self.is_drag = false
-
-	self.touch_start_pos.x = touch.x
-	self.touch_start_pos.y = touch.y
-
-	self.x = touch.x
-	self.y = touch.y
-
-	self.screen_x = touch.screen_x
-	self.screen_y = touch.screen_y
-
-	self._scene_scale = helper.get_scene_scale(self.node)
-
-	self.on_touch_start:trigger(self:get_context(), touch)
-end
-
-
-local function end_touch(self, touch)
-	if self.is_drag then
-		self.on_drag_end:trigger(
-			self:get_context(),
-			self.x - self.touch_start_pos.x,
-			self.y - self.touch_start_pos.y,
-			touch
-		)
-	end
-
-	self.is_drag = false
-	if self.is_touch then
-		self.is_touch = false
-		self.on_touch_end:trigger(self:get_context(), touch)
-	end
-	self:reset_input_priority()
-	self.touch_id = 0
-end
-
-
-local function process_touch(self, touch)
-	if not self.can_x then
-		self.touch_start_pos.x = touch.x
-	end
-
-	if not self.can_y then
-		self.touch_start_pos.y = touch.y
-	end
-
-	local distance = helper.distance(touch.x, touch.y, self.touch_start_pos.x, self.touch_start_pos.y)
-	if not self.is_drag and distance >= self.style.DRAG_DEADZONE then
-		self.is_drag = true
-		self.on_drag_start:trigger(self:get_context(), touch)
-		self:set_input_priority(const.PRIORITY_INPUT_MAX, true)
-	end
-end
-
-
---- Return current touch action from action input data
--- If touch_id stored - return exact this touch action
-local function find_touch(action_id, action, touch_id)
-	local act = helper.is_mobile() and const.ACTION_MULTITOUCH or const.ACTION_TOUCH
-
-	if action_id ~= act then
-		return
-	end
-
-	if action.touch then
-		local touch = action.touch
-		for i = 1, #touch do
-			if touch[i].id == touch_id then
-				return touch[i]
-			end
-		end
-		return touch[1]
-	else
-		return action
-	end
-end
-
-
---- Process on touch release. We should to find, if any other
--- touches exists to switch to another touch.
-local function on_touch_release(self, action_id, action)
-	if #action.touch >= 2 then
-		-- Find next unpressed touch
-		local next_touch
-		for i = 1, #action.touch do
-			if not action.touch[i].released then
-				next_touch = action.touch[i]
-				break
-			end
-		end
-
-		if next_touch then
-			self.x = next_touch.x
-			self.y = next_touch.y
-			self.touch_id = next_touch.id
-		else
-			end_touch(self)
-		end
-	elseif #action.touch == 1 then
-		end_touch(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 number|nil DRAG_DEADZONE Distance in pixels to start dragging. Default: 10
--- @tfield boolean|nil NO_USE_SCREEN_KOEF If screen aspect ratio affects on drag values. Default: false
-function M:on_style_change(style)
-	self.style = {
-		DRAG_DEADZONE = style.DRAG_DEADZONE or 10,
-		NO_USE_SCREEN_KOEF = style.NO_USE_SCREEN_KOEF or false,
-	}
-end
-
-
----Drag constructor
----@param node_or_node_id node|string
----@param on_drag_callback function
+---The constructor for Drag component
+---@param node_or_node_id node|string The node to subscribe to drag events over
+---@param on_drag_callback fun(self, touch) The callback to call when a drag occurs
 function M:init(node_or_node_id, on_drag_callback)
 	self.druid = self:get_druid()
 	self.node = self:get_node(node_or_node_id)
@@ -250,8 +72,18 @@ function M:init(node_or_node_id, on_drag_callback)
 end
 
 
+---@private
+---@param style druid.drag.style The style of Drag component
+function M:on_style_change(style)
+	self.style = {
+		DRAG_DEADZONE = style.DRAG_DEADZONE or 10,
+		NO_USE_SCREEN_KOEF = style.NO_USE_SCREEN_KOEF or false,
+	}
+end
+
+
 ---Set Drag component enabled state.
----@param is_enabled boolean
+---@param is_enabled boolean True if Drag component is enabled
 function M:set_drag_cursors(is_enabled)
 	if defos and is_enabled then
 		self.hover.style.ON_HOVER_CURSOR = defos.CURSOR_CROSSHAIR
@@ -263,6 +95,7 @@ function M:set_drag_cursors(is_enabled)
 end
 
 
+---@private
 function M:on_late_init()
 	if not self.click_zone then
 		local stencil_node = helper.get_closest_stencil_node(self.node)
@@ -273,6 +106,7 @@ function M:on_late_init()
 end
 
 
+---@private
 function M:on_window_resized()
 	local x_koef, y_koef = helper.get_screen_aspect_koef()
 	self._x_koef = x_koef
@@ -281,16 +115,18 @@ function M:on_window_resized()
 end
 
 
+---@private
 function M:on_input_interrupt()
 	if self.is_drag or self.is_touch then
-		end_touch(self)
+		self:_end_touch()
 	end
 end
 
 
----@local
----@param action_id string
----@param action table
+---@private
+---@param action_id hash Action id from on_input
+---@param action table Action from on_input
+---@return boolean is_consumed True if the input was consumed
 function M:on_input(action_id, action)
 	if action_id ~= const.ACTION_TOUCH and action_id ~= const.ACTION_MULTITOUCH then
 		return false
@@ -302,12 +138,12 @@ function M:on_input(action_id, action)
 
 	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)
+		self:_end_touch()
 		return false
 	end
 
 
-	local touch = find_touch(action_id, action, self.touch_id)
+	local touch = self:_find_touch(action_id, action, self.touch_id)
 	if not touch then
 		return false
 	end
@@ -320,24 +156,24 @@ function M:on_input(action_id, action)
 	self.dy = 0
 
 	if touch.pressed and not self.is_touch then
-		start_touch(self, touch)
+		self:_start_touch(touch)
 	end
 
 	if touch.released and self.is_touch then
 		if action.touch then
 			-- Mobile
-			on_touch_release(self, action_id, action)
+			self:_on_touch_release(action_id, action)
 		else
 			-- PC
-			end_touch(self, touch)
+			self:_end_touch(touch)
 		end
 	end
 
 	if self.is_touch then
-		process_touch(self, touch)
+		self:_process_touch(touch)
 	end
 
-	local touch_modified = find_touch(action_id, action, self.touch_id)
+	local touch_modified = self:_find_touch(action_id, action, self.touch_id)
 	if touch_modified and self.is_drag then
 		self.dx = touch_modified.x - self.x
 		self.dy = touch_modified.y - self.y
@@ -369,7 +205,7 @@ end
 
 
 ---Set Drag click zone
----@param node node|string|nil
+---@param node node|string|nil Node or node id
 ---@return druid.drag self Current instance
 function M:set_click_zone(node)
 	self.click_zone = node and self:get_node(node) or nil
@@ -388,11 +224,125 @@ function M:set_enabled(is_enabled)
 end
 
 
----Check if Drag component is enabled
----@return boolean
+---Check if Drag component is capture input
+---@return boolean is_enabled True if Drag component is enabled
 function M:is_enabled()
 	return self._is_enabled
 end
 
 
+function M:_start_touch(touch)
+	self.is_touch = true
+	self.is_drag = false
+
+	self.touch_start_pos.x = touch.x
+	self.touch_start_pos.y = touch.y
+
+	self.x = touch.x
+	self.y = touch.y
+
+	self.screen_x = touch.screen_x
+	self.screen_y = touch.screen_y
+
+	self._scene_scale = helper.get_scene_scale(self.node)
+
+	self.on_touch_start:trigger(self:get_context(), touch)
+end
+
+
+---@param touch touch|nil
+function M:_end_touch(touch)
+	if self.is_drag then
+		self.on_drag_end:trigger(
+			self:get_context(),
+			self.x - self.touch_start_pos.x,
+			self.y - self.touch_start_pos.y,
+			touch
+		)
+	end
+
+	self.is_drag = false
+	if self.is_touch then
+		self.is_touch = false
+		self.on_touch_end:trigger(self:get_context(), touch)
+	end
+	self:reset_input_priority()
+	self.touch_id = 0
+end
+
+
+---@param touch touch Touch action
+function M:_process_touch(touch)
+	if not self.can_x then
+		self.touch_start_pos.x = touch.x
+	end
+
+	if not self.can_y then
+		self.touch_start_pos.y = touch.y
+	end
+
+	local distance = helper.distance(touch.x, touch.y, self.touch_start_pos.x, self.touch_start_pos.y)
+	if not self.is_drag and distance >= self.style.DRAG_DEADZONE then
+		self.is_drag = true
+		self.on_drag_start:trigger(self:get_context(), touch)
+		self:set_input_priority(const.PRIORITY_INPUT_MAX, true)
+	end
+end
+
+
+---Return current touch action from action input data
+---If touch_id stored - return exact this touch action
+---@param action_id hash Action id from on_input
+---@param action table Action from on_input
+---@param touch_id number Touch id
+---@return table|nil touch Touch action
+function M:_find_touch(action_id, action, touch_id)
+	local act = helper.is_mobile() and const.ACTION_MULTITOUCH or const.ACTION_TOUCH
+
+	if action_id ~= act then
+		return
+	end
+
+	if action.touch then
+		local touch = action.touch
+		for i = 1, #touch do
+			if touch[i].id == touch_id then
+				return touch[i]
+			end
+		end
+		return touch[1]
+	else
+		return action
+	end
+end
+
+
+---Process on touch release. We should to find, if any other
+---touches exists to switch to another touch.
+---@param action_id hash Action id from on_input
+---@param action table Action from on_input
+function M:_on_touch_release(action_id, action)
+	if #action.touch >= 2 then
+		-- Find next unpressed touch
+		local next_touch
+		for i = 1, #action.touch do
+			if not action.touch[i].released then
+				next_touch = action.touch[i]
+				break
+			end
+		end
+
+		if next_touch then
+			self.x = next_touch.x
+			self.y = next_touch.y
+			self.touch_id = next_touch.id
+		else
+			self:_end_touch()
+		end
+	elseif #action.touch == 1 then
+		self:_end_touch()
+	end
+end
+
+
 return M

druid/base/hover.lua

@@ -1,40 +1,27 @@
--- 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
-
---- Hover node
--- @tfield node node
-
---- On hover callback(self, state, hover_instance)
--- @tfield event on_hover event
-
---- On mouse hover callback(self, state, hover_instance)
--- @tfield event on_mouse_hover event
-
----
-
 local event = require("event.event")
 local const = require("druid.const")
 local helper = require("druid.helper")
 local component = require("druid.component")
 
----@class druid.hover: druid.base_component
----@field node node
----@field on_hover event
----@field on_mouse_hover event
----@field style table
----@field click_zone node
----@field private _is_hovered boolean|nil
----@field private _is_mouse_hovered boolean|nil
----@field private _is_enabled boolean|nil
----@field private _is_mobile boolean
+---@class druid.hover.style
+---@field ON_HOVER_CURSOR string|nil Mouse hover style on node hover
+---@field ON_MOUSE_HOVER_CURSOR string|nil Mouse hover style on node mouse hover
+
+---The component for handling hover events on a node
+---@class druid.hover: druid.component
+---@field node node Gui node
+---@field on_hover event fun(self: druid.hover, is_hover: boolean) Hover event
+---@field on_mouse_hover event fun(self: druid.hover, is_hover: boolean) Mouse hover event
+---@field style druid.hover.style Style of the hover component
+---@field click_zone node Click zone of the hover component
+---@field private _is_hovered boolean|nil True if the node is hovered
+---@field private _is_mouse_hovered boolean|nil True if the node is mouse hovered
+---@field private _is_enabled boolean|nil True if the hover component is enabled
+---@field private _is_mobile boolean True if the platform is mobile
 local M = component.create("hover")
 
 
---- The Hover constructor
+---The constructor for the hover component
 ---@param node node Gui node
 ---@param on_hover_callback function Hover callback
 ---@param on_mouse_hover function On mouse hover callback
@@ -51,6 +38,7 @@ function M:init(node, on_hover_callback, on_mouse_hover)
 end
 
 
+---@private
 function M:on_late_init()
 	if not self.click_zone then
 		local stencil_node = helper.get_closest_stencil_node(self.node)
@@ -61,12 +49,8 @@ function M:on_late_init()
 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 ON_HOVER_CURSOR Mouse hover style on node hover
--- @tfield[opt] string ON_MOUSE_HOVER_CURSOR Mouse hover style on node mouse hover
+---@private
+---@param style druid.hover.style
 function M:on_style_change(style)
 	self.style = {}
 	self.style.ON_HOVER_CURSOR = style.ON_HOVER_CURSOR or nil
@@ -74,6 +58,10 @@ function M:on_style_change(style)
 end
 
 
+---@private
+---@param action_id hash Action id from on_input
+---@param action table Action from on_input
+---@return boolean is_consumed True if the input was consumed
 function M:on_input(action_id, action)
 	if action_id ~= const.ACTION_TOUCH and action_id ~= nil then
 		return false
@@ -108,6 +96,7 @@ function M:on_input(action_id, action)
 end
 
 
+---@private
 function M:on_input_interrupt()
 	self:set_hover(false)
 end
@@ -130,7 +119,7 @@ end
 
 
 ---Return current hover state. True if touch action was on the node at current time
----@return boolean The current hovered state
+---@return boolean is_hovered The current hovered state
 function M:is_hovered()
 	return self._is_hovered
 end
@@ -159,8 +148,7 @@ function M:is_mouse_hovered()
 end
 
 
---- Strict hover click area. Useful for
--- no click events outside stencil node
+---Strict hover click area. Useful for no click events outside stencil node
 ---@param zone node|string|nil Gui node
 function M:set_click_zone(zone)
 	if not zone then
@@ -173,8 +161,8 @@ end
 
 
 ---Set enable state of hover component.
--- If hover is not enabled, it will not generate
--- any hover events
+---If hover is not enabled, it will not generate
+---any hover events
 ---@param state boolean|nil The hover enabled state
 function M:set_enabled(state)
 	self._is_enabled = state

druid/base/scroll.lua

@@ -1,101 +1,46 @@
--- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
-
---- Component to handle scroll content.
--- <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 event on_scroll event
-
---- On scroll_to function callback(self, target, is_instant)
--- @tfield event on_scroll_to event
-
---- On scroll_to_index function callback(self, index, point)
--- @tfield event on_point_scroll event
-
---- Scroll view node
--- @tfield node view_node
-
---- Scroll view size
--- @tfield vector3 view_size
-
---- Scroll content node
--- @tfield node content_node
-
---- Flag, if scroll now moving by inertion
--- @tfield boolean _is_inert
-
---- Current inert speed
--- @tfield vector3 inertion
-
---- Current scroll posisition
--- @tfield vector3 position
-
---- Current scroll target position
--- @tfield vector3 target_position
-
---- Available position for content node: (min_x, max_y, max_x, min_y)
--- @tfield vector4 available_pos
-
---- Size of available positions: (width, height, 0)
--- @tfield vector3 available_size
-
---- Drag Druid component
--- @tfield Drag drag Drag
-
---- Current index of points of interests
--- @tfield number|nil selected
-
---- Flag, if scroll now animating by gui.animate
--- @tfield boolean is_animate
-
----
-
 local event = require("event.event")
 local const = require("druid.const")
 local helper = require("druid.helper")
 local component = require("druid.component")
 
----@class druid.scroll: druid.base_component
+---Scroll style parameters
+---@class druid.scroll.style
+---@field FRICT number|nil Multiplier for free inertion. Default: 0
+---@field FRICT_HOLD number|nil Multiplier for inertion, while touching. Default: 0
+---@field INERT_THRESHOLD number|nil Scroll speed to stop inertion. Default: 3
+---@field INERT_SPEED number|nil Multiplier for inertion speed. Default: 30
+---@field POINTS_DEADZONE number|nil Speed to check points of interests in no_inertion mode. Default: 20
+---@field BACK_SPEED number|nil Scroll back returning lerp speed. Default: 35
+---@field ANIM_SPEED number|nil Scroll gui.animation speed for scroll_to function. Default: 2
+---@field EXTRA_STRETCH_SIZE number|nil extra size in pixels outside of scroll (stretch effect). Default: 0
+---@field SMALL_CONTENT_SCROLL boolean|nil If true, content node with size less than view node size can be scrolled. Default: false
+---@field WHEEL_SCROLL_SPEED number|nil The scroll speed via mouse wheel scroll or touchpad. Set to 0 to disable wheel scrolling. Default: 0
+---@field WHEEL_SCROLL_INVERTED boolean|nil If true, invert direction for touchpad and mouse wheel scroll. Default: false
+---@field WHEEL_SCROLL_BY_INERTION boolean|nil If true, wheel will add inertion to scroll. Direct set position otherwise.. Default: false
+
+---Basic Druid scroll component. Handles all scrolling behavior in Druid GUI.
+---
+---### Setup
+---Create scroll component with druid: `druid:new_scroll(view_node, content_node)`
+---
+---### Notes
+---- View_node is the static part that captures user input and recognizes scrolling touches
+---- Content_node is the dynamic part that will change position according to the scroll system
+---- Initial scroll size will be equal to content_node size
+---- The initial view box will be equal to view_node size
+---- Scroll by default style has inertia and extra size for stretching effect
+---- You can setup "points of interest" to make scroll always center on closest point
+---- Scroll 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
+---- Multitouch is required for scroll. Scroll correctly handles touch_id swap while dragging
+---@class druid.scroll: druid.component
 ---@field node node The root node
 ---@field click_zone node|nil Optional click zone to restrict scroll area
----@field on_scroll event Triggered on scroll move with (self, position)
----@field on_scroll_to event Triggered on scroll_to with (self, target, is_instant)
----@field on_point_scroll event Triggered on scroll_to_index with (self, index, point)
+---@field on_scroll event Triggered on scroll move with fun(self, position)
+---@field on_scroll_to event Triggered on scroll_to with fun(self, target, is_instant)
+---@field on_point_scroll event Triggered on scroll_to_index with fun(self, index, point)
 ---@field view_node node The scroll view node (static part)
 ---@field view_border vector4 The scroll view borders
 ---@field content_node node The scroll content node (moving part)
@@ -107,6 +52,7 @@ local component = require("druid.component")
 ---@field drag druid.drag The drag component instance
 ---@field selected number|nil Current selected point of interest index
 ---@field is_animate boolean True if scroll is animating
+---@field style druid.scroll.style Component style parameters
 ---@field private _is_inert boolean True if inertial scrolling is enabled
 ---@field private inertion vector3 Current inertial movement vector
 ---@field private _is_horizontal_scroll boolean True if horizontal scroll enabled
@@ -114,81 +60,12 @@ local component = require("druid.component")
 ---@field private _grid_on_change event Grid items change event
 ---@field private _grid_on_change_callback function Grid change callback
 ---@field private _offset vector3 Content start offset
----@field private style table Component style parameters
 local M = component.create("scroll")
 
 
-local function inverse_lerp(min, max, current)
-	return helper.clamp((current - min) / (max - min), 0, 1)
-end
-
-
---- Update vector with next conditions:
--- Field x have to <= field z
--- Field y have to <= field w
-local function get_border_vector(vector, offset)
-	if vector.x > vector.z then
-		vector.x, vector.z = vector.z, vector.x
-	end
-	if vector.y > vector.w then
-		vector.y, vector.w = vector.w, vector.y
-	end
-	vector.x = vector.x - offset.x
-	vector.z = vector.z - offset.x
-	vector.y = vector.y - offset.y
-	vector.w = vector.w - offset.y
-	return vector
-end
-
-
---- Return size from scroll border vector4
-local function get_size_vector(vector)
-	return vmath.vector3(vector.z - vector.x, vector.w - vector.y, 0)
-end
-
-
---- Component style params.
--- You can override this component styles params in druid styles table
--- or create your own style
--- @table style
--- @tfield number|nil FRICT Multiplier for free inertion. Default: 0
--- @tfield number|nil FRICT_HOLD Multiplier for inertion, while touching. Default: 0
--- @tfield number|nil INERT_THRESHOLD Scroll speed to stop inertion. Default: 3
--- @tfield number|nil INERT_SPEED Multiplier for inertion speed. Default: 30
--- @tfield number|nil POINTS_DEADZONE Speed to check points of interests in no_inertion mode. Default: 20
--- @tfield number|nil BACK_SPEED Scroll back returning lerp speed. Default: 35
--- @tfield number|nil ANIM_SPEED Scroll gui.animation speed for scroll_to function. Default: 2
--- @tfield number|nil EXTRA_STRETCH_SIZE extra size in pixels outside of scroll (stretch effect). Default: 0
--- @tfield boolean|nil SMALL_CONTENT_SCROLL If true, content node with size less than view node size can be scrolled. Default: false
--- @tfield boolean|nil WHEEL_SCROLL_SPEED The scroll speed via mouse wheel scroll or touchpad. Set to 0 to disable wheel scrolling. Default: 0
--- @tfield boolean|nil WHEEL_SCROLL_INVERTED If true, invert direction for touchpad and mouse wheel scroll. Default: false
--- @tfield boolean|nil WHEEL_SCROLL_BY_INERTION If true, wheel will add inertion to scroll. Direct set position otherwise.. Default: false
-function M:on_style_change(style)
-	self.style = {}
-	self.style.EXTRA_STRETCH_SIZE = style.EXTRA_STRETCH_SIZE or 0
-	self.style.ANIM_SPEED = style.ANIM_SPEED or 0.2
-	self.style.BACK_SPEED = style.BACK_SPEED or 0.35
-
-	self.style.FRICT = style.FRICT or 0
-	self.style.FRICT_HOLD = style.FRICT_HOLD or 0
-
-	self.style.INERT_THRESHOLD = style.INERT_THRESHOLD or 3
-	self.style.INERT_SPEED = style.INERT_SPEED or 30
-	self.style.POINTS_DEADZONE = style.POINTS_DEADZONE or 20
-	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
-		self.style.INERT_SPEED == 0)
-end
-
-
 ---The Scroll constructor
----@param view_node string|node GUI view scroll node
----@param content_node string|node GUI content scroll node
+---@param view_node string|node GUI view scroll node - the static part that captures user input
+---@param content_node string|node GUI content scroll node - the dynamic part that will change position
 function M:init(view_node, content_node)
 	self.druid = self:get_druid()
 
@@ -227,6 +104,32 @@ function M:init(view_node, content_node)
 end
 
 
+---@private
+---@param style druid.scroll.style
+function M:on_style_change(style)
+	self.style = {}
+	self.style.EXTRA_STRETCH_SIZE = style.EXTRA_STRETCH_SIZE or 0
+	self.style.ANIM_SPEED = style.ANIM_SPEED or 0.2
+	self.style.BACK_SPEED = style.BACK_SPEED or 0.35
+
+	self.style.FRICT = style.FRICT or 0
+	self.style.FRICT_HOLD = style.FRICT_HOLD or 0
+
+	self.style.INERT_THRESHOLD = style.INERT_THRESHOLD or 3
+	self.style.INERT_SPEED = style.INERT_SPEED or 30
+	self.style.POINTS_DEADZONE = style.POINTS_DEADZONE or 20
+	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
+		self.style.INERT_SPEED == 0)
+end
+
+
+---@private
 function M:on_late_init()
 	if not self.click_zone then
 		local stencil_node = helper.get_closest_stencil_node(self.node)
@@ -237,11 +140,13 @@ function M:on_late_init()
 end
 
 
+---@private
 function M:on_layout_change()
 	gui.set_position(self.content_node, self.position)
 end
 
 
+---@private
 function M:update(dt)
 	if self.is_animate then
 		self.position.x = gui.get(self.content_node, "position.x") --[[@as number]]
@@ -257,11 +162,13 @@ function M:update(dt)
 end
 
 
+---@private
 function M:on_input(action_id, action)
 	return self:_process_scroll_wheel(action_id, action)
 end
 
 
+---@private
 function M:on_remove()
 	self:bind_grid(nil)
 end
@@ -270,8 +177,6 @@ end
 ---Start scroll to target point.
 ---@param point vector3 Target point
 ---@param is_instant boolean|nil Instant scroll flag
--- @usage scroll:scroll_to(vmath.vector3(0, 50, 0))
--- @usage scroll:scroll_to(vmath.vector3(0), true)
 function M:scroll_to(point, is_instant)
 	local b = self.available_pos
 	local target = vmath.vector3(
@@ -325,7 +230,6 @@ end
 ---Start scroll to target scroll percent
 ---@param percent vector3 target percent
 ---@param is_instant boolean|nil instant scroll flag
--- @usage scroll:scroll_to_percent(vmath.vector3(0.5, 0, 0))
 function M:scroll_to_percent(percent, is_instant)
 	local border = self.available_pos
 
@@ -350,8 +254,8 @@ end
 -- Values will be in [0..1] interval
 ---@return vector3 New vector with scroll progress values
 function M:get_percent()
-	local x_perc = 1 - inverse_lerp(self.available_pos.x, self.available_pos.z, self.position.x)
-	local y_perc = inverse_lerp(self.available_pos.w, self.available_pos.y, self.position.y)
+	local x_perc = 1 - self:_inverse_lerp(self.available_pos.x, self.available_pos.z, self.position.x)
+	local y_perc = self:_inverse_lerp(self.available_pos.w, self.available_pos.y, self.position.y)
 
 	return vmath.vector3(x_perc, y_perc, 0)
 end
@@ -361,7 +265,7 @@ end
 -- It will change content gui node size
 ---@param size vector3 The new size for content node
 ---@param offset vector3|nil Offset value to set, where content is starts
----@return druid.scroll Current scroll instance
+---@return druid.scroll self Current scroll instance
 function M:set_size(size, offset)
 	if offset then
 		self._offset = offset
@@ -375,7 +279,7 @@ end
 
 ---Set new scroll view size in case the node size was changed.
 ---@param size vector3 The new size for view node
----@return druid.scroll Current scroll instance
+---@return druid.scroll self Current scroll instance
 function M:set_view_size(size)
 	gui.set_size(self.view_node, size)
 	self.view_size = size
@@ -386,7 +290,8 @@ function M:set_view_size(size)
 end
 
 
---- Refresh scroll view size
+---Refresh scroll view size, used when view node size is changed
+---@return druid.scroll self Current scroll instance
 function M:update_view_size()
 	self.view_size = helper.get_scaled_size(self.view_node)
 	self.view_border = helper.get_border(self.view_node)
@@ -396,11 +301,11 @@ function M:update_view_size()
 end
 
 
---- Enable or disable scroll inert.
+---Enable or disable scroll inert
 -- If disabled, scroll through points (if exist)
 -- If no points, just simple drag without inertion
 ---@param state boolean Inert scroll state
----@return druid.scroll Current scroll instance
+---@return druid.scroll self Current scroll instance
 function M:set_inert(state)
 	self._is_inert = state
 
@@ -408,17 +313,17 @@ function M:set_inert(state)
 end
 
 
---- Return if scroll have inertion.
----@return boolean @If scroll have inertion
+---Return if scroll have inertion
+---@return boolean is_inert If scroll have inertion
 function M:is_inert()
 	return self._is_inert
 end
 
 
---- Set extra size for scroll stretching.
+---Set extra size for scroll stretching
 -- Set 0 to disable stretching effect
 ---@param stretch_size number|nil Size in pixels of additional scroll area
----@return druid.scroll Current scroll instance
+---@return druid.scroll self Current scroll instance
 function M:set_extra_stretch_size(stretch_size)
 	self.style.EXTRA_STRETCH_SIZE = stretch_size or 0
 	self:_update_size()
@@ -437,7 +342,7 @@ end
 ---Set points of interest.
 -- Scroll will always centered on closer points
 ---@param points table Array of vector3 points
----@return druid.scroll Current scroll instance
+---@return druid.scroll self Current scroll instance
 function M:set_points(points)
 	self.points = points
 
@@ -453,7 +358,7 @@ end
 
 ---Lock or unlock horizontal scroll
 ---@param state boolean True, if horizontal scroll is enabled
----@return druid.scroll Current scroll instance
+---@return druid.scroll self Current scroll instance
 function M:set_horizontal_scroll(state)
 	self._is_horizontal_scroll = state
 	self.drag.can_x = self.available_size.x > 0 and state or false
@@ -463,7 +368,7 @@ end
 
 ---Lock or unlock vertical scroll
 ---@param state boolean True, if vertical scroll is enabled
----@return druid.scroll Current scroll instance
+---@return druid.scroll self Current scroll instance
 function M:set_vertical_scroll(state)
 	self._is_vertical_scroll = state
 	self.drag.can_y = self.available_size.y > 0 and state or false
@@ -514,7 +419,7 @@ end
 ---Bind the grid component (Static or Dynamic) to recalculate
 -- scroll size on grid changes
 ---@param grid druid.grid|nil Druid grid component
----@return druid.scroll Current scroll instance
+---@return druid.scroll self Current scroll instance
 function M:bind_grid(grid)
 	if self._grid_on_change then
 		self._grid_on_change:unsubscribe(self._grid_on_change_callback)
@@ -560,11 +465,11 @@ function M:_on_scroll_drag(dx, dy)
 
 	-- Right border (minimum x)
 	if t.x < b.x and dx < 0 then
-		x_perc = inverse_lerp(eb.x, b.x, t.x)
+		x_perc = self:_inverse_lerp(eb.x, b.x, t.x)
 	end
 	-- Left border (maximum x)
 	if t.x > b.z and dx > 0 then
-		x_perc = inverse_lerp(eb.z, b.z, t.x)
+		x_perc = self:_inverse_lerp(eb.z, b.z, t.x)
 	end
 	-- Disable x scroll
 	if not self.drag.can_x then
@@ -573,11 +478,11 @@ function M:_on_scroll_drag(dx, dy)
 
 	-- Top border (minimum y)
 	if t.y < b.y and dy < 0 then
-		y_perc = inverse_lerp(eb.y, b.y, t.y)
+		y_perc = self:_inverse_lerp(eb.y, b.y, t.y)
 	end
 	-- Bot border (maximum y)
 	if t.y > b.w and dy > 0 then
-		y_perc = inverse_lerp(eb.w, b.w, t.y)
+		y_perc = self:_inverse_lerp(eb.w, b.w, t.y)
 	end
 	-- Disable y scroll
 	if not self.drag.can_y then
@@ -782,8 +687,8 @@ function M:_update_size()
 	local content_border = helper.get_border(self.content_node)
 	local content_size = helper.get_scaled_size(self.content_node)
 
-	self.available_pos = get_border_vector(self.view_border - content_border, self._offset)
-	self.available_size = get_size_vector(self.available_pos)
+	self.available_pos = self:_get_border_vector(self.view_border - content_border, self._offset)
+	self.available_size = self:_get_size_vector(self.available_pos)
 
 	self.drag.can_x = self.available_size.x > 0 and self._is_horizontal_scroll
 	self.drag.can_y = self.available_size.y > 0 and self._is_vertical_scroll
@@ -807,8 +712,8 @@ function M:_update_size()
 		self.drag.can_y = content_size.y > self.view_size.y and self._is_vertical_scroll
 	end
 
-	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.available_pos_extra = self:_get_border_vector(self.view_border - content_border_extra, self._offset)
+	self.available_size_extra = self:_get_size_vector(self.available_pos_extra)
 
 	self:_set_scroll_position(self.position.x, self.position.y)
 	self.target_position.x = self.position.x
@@ -860,4 +765,38 @@ function M:_on_mouse_hover(state)
 end
 
 
+function M:_inverse_lerp(min, max, current)
+	return helper.clamp((current - min) / (max - min), 0, 1)
+end
+
+
+---Update vector with next conditions:
+---Field x have to <= field z
+---Field y have to <= field w
+---@param vector vector4
+---@param offset vector3
+---@return vector4
+function M:_get_border_vector(vector, offset)
+	if vector.x > vector.z then
+		vector.x, vector.z = vector.z, vector.x
+	end
+	if vector.y > vector.w then
+		vector.y, vector.w = vector.w, vector.y
+	end
+	vector.x = vector.x - offset.x
+	vector.z = vector.z - offset.x
+	vector.y = vector.y - offset.y
+	vector.w = vector.w - offset.y
+	return vector
+end
+
+
+---Return size from scroll border vector4
+---@param vector vector4
+---@return vector3
+function M:_get_size_vector(vector)
+	return vmath.vector3(vector.z - vector.x, vector.w - vector.y, 0)
+end
+
+
 return M

druid/base/static_grid.lua

@@ -1,133 +1,33 @@
--- 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.grid
-
---- On item add callback(self, node, index)
--- @tfield event on_add_item event
-
---- On item remove callback(self, index)
--- @tfield event on_remove_item event
-
---- On item add, remove or change in_row callback(self, index|nil)
--- @tfield event on_change_items event
-
---- On grid clear callback(self)
--- @tfield event on_clear event
-
---- On update item positions callback(self)
--- @tfield event on_update_positions event
-
---- Parent gui node
--- @tfield node parent
-
---- List of all grid nodes
--- @tfield node[] nodes
-
---- The first index of node in grid
--- @tfield number first_index
-
---- The last index of node in grid
--- @tfield number last_index
-
---- Item anchor [0..1]
--- @tfield vector3 anchor
-
---- Item pivot [-0.5..0.5]
--- @tfield vector3 pivot
-
---- Item size
--- @tfield vector3 node_size
-
---- The size of item content
--- @tfield vector4 border
-
----
-
 local const = require("druid.const")
 local event = require("event.event")
 local helper = require("druid.helper")
 local component = require("druid.component")
 
----@class druid.grid: druid.base_component
----@field on_add_item event
----@field on_remove_item event
----@field on_change_items event
----@field on_clear event
----@field on_update_positions event
----@field parent node
----@field nodes node[]
----@field first_index number
----@field last_index number
----@field anchor vector3
----@field pivot vector3
----@field node_size vector3
----@field border vector4
----@field in_row number
----@field style table
-local M = component.create("static_grid")
+---@class druid.grid.style
+---@field IS_DYNAMIC_NODE_POSES boolean|nil If true, always center grid content as grid pivot sets. Default: false
+---@field IS_ALIGN_LAST_ROW boolean|nil If true, always align last row of the grid as grid pivot sets. Default: false
+
+---The component for manage the nodes position in the grid with various options
+---@class druid.grid: druid.component
+---@field on_add_item event Trigger on add item event, fun(self, item, index)
+---@field on_remove_item event Trigger on remove item event, fun(self, index)
+---@field on_change_items event Trigger on change items event, fun(self, index)
+---@field on_clear event Trigger on clear event, fun(self)
+---@field on_update_positions event Trigger on update positions event, fun(self)
+---@field parent node Parent node
+---@field nodes node[] Nodes array
+---@field first_index number First index
+---@field last_index number Last index
+---@field anchor vector3 Anchor
+---@field pivot vector3 Pivot
+---@field node_size vector3 Node size
+---@field border vector4 Border
+---@field in_row number In row
+---@field style druid.grid.style Style
+local M = component.create("grid")
 
 
-local function _extend_border(border, pos, size, pivot)
-	local left = pos.x - size.x/2 - (size.x * pivot.x)
-	local right = pos.x + size.x/2 - (size.x * pivot.x)
-	local top = pos.y + size.y/2 - (size.y * pivot.y)
-	local bottom = pos.y - size.y/2 - (size.y * pivot.y)
-
-	border.x = math.min(border.x, left)
-	border.y = math.max(border.y, top)
-	border.z = math.max(border.z, right)
-	border.w = math.min(border.w, bottom)
-end
-
-
---- Component style params.
--- You can override this component styles params in druid styles table
--- or create your own style
--- @table style
--- @tfield boolean|nil IS_DYNAMIC_NODE_POSES If true, always center grid content as grid pivot sets. Default: false
--- @tfield boolean|nil IS_ALIGN_LAST_ROW If true, always align last row of the grid as grid pivot sets. Default: false
-function M:on_style_change(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
+---The constructor for the grid component
 ---@param parent string|node The GUI Node container, where grid's items will be placed
 ---@param element node Element prefab. Need to get it size
 ---@param in_row number|nil How many nodes in row can be placed. By default 1
@@ -162,10 +62,20 @@ function M:init(parent, element, in_row)
 end
 
 
+---@private
+---@param style druid.grid.style
+function M:on_style_change(style)
+	self.style = {
+		IS_DYNAMIC_NODE_POSES = style.IS_DYNAMIC_NODE_POSES or false,
+		IS_ALIGN_LAST_ROW = style.IS_ALIGN_LAST_ROW or false,
+	}
+end
+
+
 local _temp_pos = vmath.vector3(0)
 ---Return pos for grid node index
 ---@param index number The grid element index
----@return vector3 @Node position
+---@return vector3 position Node position
 function M:get_pos(index)
 	local row = math.ceil(index / self.in_row) - 1
 	local col = (index - row * self.in_row) - 1
@@ -180,9 +90,9 @@ function M:get_pos(index)
 end
 
 
---- Return index for grid pos
+---Return grid index by position
 ---@param pos vector3 The node position in the grid
----@return number The node index
+---@return number index The node index
 function M:get_index(pos)
 	-- Offset to left-top corner from node pivot
 	local node_offset_x = self.node_size.x * (-0.5 + self.node_pivot.x)
@@ -213,6 +123,7 @@ function M:get_index_by_node(node)
 end
 
 
+---@private
 function M:on_layout_change()
 	self:_update(true)
 end
@@ -226,23 +137,24 @@ function M:set_anchor(anchor)
 end
 
 
---- Update grid content
+---Instantly update the grid content
+---@return druid.grid self Current grid instance
 function M:refresh()
 	self:_update(true)
+
+	return self
 end
 
 
+---Set grid pivot
+---@param pivot constant The new pivot
+---@return druid.grid self Current grid instance
 function M:set_pivot(pivot)
 	local prev_pivot = helper.get_pivot_offset(gui.get_pivot(self.parent))
 	self.pivot = helper.get_pivot_offset(pivot)
 
 	local width = gui.get(self.parent, "size.x")
 	local height = gui.get(self.parent, "size.y")
-	--local pos_offset = vmath.vector3(
-	--	width * (self.pivot.x - prev_pivot.x),
-	--	height * (self.pivot.y - prev_pivot.y),
-	--	0
-	--)
 
 	local position = gui.get_position(self.parent)
 	position.x = position.x + width * (self.pivot.x - prev_pivot.x)
@@ -260,6 +172,8 @@ function M:set_pivot(pivot)
 	)
 
 	self:_update(true)
+
+	return self
 end
 
 
@@ -268,6 +182,7 @@ end
 ---@param index number|nil The item position. By default add as last item
 ---@param shift_policy number|nil How shift nodes, if required. Default: const.SHIFT.RIGHT
 ---@param is_instant boolean|nil If true, update node positions instantly
+---@return druid.grid self Current grid instance
 function M:add(item, index, shift_policy, is_instant)
 	index = index or ((self.last_index or 0) + 1)
 
@@ -284,12 +199,15 @@ function M:add(item, index, shift_policy, is_instant)
 
 	self.on_add_item:trigger(self:get_context(), item, index)
 	self.on_change_items:trigger(self:get_context(), index)
+
+	return self
 end
 
 
 ---Set new items to the grid. All previous items will be removed
 ---@param nodes node[] The new grid nodes
--- @tparam[opt=false] boolean is_instant If true, update node positions instantly
+---@param is_instant boolean|nil If true, update node positions instantly
+---@return druid.grid self Current grid instance
 function M:set_items(nodes, is_instant)
 	self.nodes = nodes
 	for index = 1, #nodes do
@@ -300,6 +218,8 @@ function M:set_items(nodes, is_instant)
 	self:_update(is_instant)
 
 	self.on_change_items:trigger(self:get_context())
+
+	return self
 end
 
 
@@ -307,7 +227,7 @@ end
 ---@param index number The grid node index to remove
 ---@param shift_policy number|nil How shift nodes, if required. Default: const.SHIFT.RIGHT
 ---@param is_instant boolean|nil If true, update node positions instantly
----@return node The deleted gui node from grid
+---@return node node The deleted gui node from grid
 function M:remove(index, shift_policy, is_instant)
 	assert(self.nodes[index], "No grid item at given index " .. index)
 
@@ -324,7 +244,7 @@ end
 
 
 ---Return grid content size
----@return vector3 The grid content size
+---@return vector3 size The grid content size
 function M:get_size()
 	return vmath.vector3(
 		self.border.z - self.border.x,
@@ -333,6 +253,9 @@ function M:get_size()
 end
 
 
+---Return grid content size for given count of nodes
+---@param count number The count of nodes
+---@return vector3 size The grid content size
 function M:get_size_for(count)
 	if not count or count == 0 then
 		return vmath.vector3(0)
@@ -342,10 +265,10 @@ function M:get_size_for(count)
 
 	local size = self.node_size
 	local pivot = self.node_pivot
-	_extend_border(border, self:get_pos(1), size, pivot)
-	_extend_border(border, self:get_pos(count), size, pivot)
+	self:_extend_border(border, self:get_pos(1), size, pivot)
+	self:_extend_border(border, self:get_pos(count), size, pivot)
 	if count >= self.in_row then
-		_extend_border(border, self:get_pos(self.in_row), size, pivot)
+		self:_extend_border(border, self:get_pos(self.in_row), size, pivot)
 	end
 
 	return vmath.vector3(
@@ -356,14 +279,14 @@ end
 
 
 ---Return grid content borders
----@return vector4 The grid content borders
+---@return vector4 borders The grid content borders
 function M:get_borders()
 	return self.border
 end
 
 
 ---Return array of all node positions
----@return vector3[] All grid node positions
+---@return vector3[] positions All grid node positions
 function M:get_all_pos()
 	local result = {}
 	for i, node in pairs(self.nodes) do
@@ -377,7 +300,7 @@ end
 ---Change set position function for grid nodes. It will call on
 -- update poses on grid elements. Default: gui.set_position
 ---@param callback function Function on node set position
----@return druid.grid Current grid instance
+---@return druid.grid self Current grid instance
 function M:set_position_function(callback)
 	self._set_position_function = callback or gui.set_position
 
@@ -387,7 +310,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
----@return druid.grid Current grid instance
+---@return druid.grid self Current grid instance
 function M:clear()
 	self.border.x = 0
 	self.border.y = 0
@@ -405,7 +328,7 @@ end
 
 
 ---Return StaticGrid offset, where StaticGrid content starts.
----@return vector3 The StaticGrid offset
+---@return vector3 offset The StaticGrid offset
 function M:get_offset()
 	local borders = self:get_borders()
 	local size = self:get_size()
@@ -421,7 +344,7 @@ end
 
 ---Set new in_row elements for grid
 ---@param in_row number The new in_row value
----@return druid.grid Current grid instance
+---@return druid.grid self Current grid instance
 function M:set_in_row(in_row)
 	self.in_row = in_row
 	self._grid_horizonal_offset = self.node_size.x * (self.in_row - 1) * self.anchor.x
@@ -438,9 +361,9 @@ end
 
 
 ---Set new node size for grid
--- @tparam[opt] number width The new node width
--- @tparam[opt] number height The new node height
----@return druid.grid Current grid instance
+---@param width number|nil The new node width
+---@param height number|nil The new node height
+---@return druid.grid self Current grid instance
 function M:set_item_size(width, height)
 	if width then
 		self.node_size.x = width
@@ -510,7 +433,7 @@ function M:_update_borders()
 	local size = self.node_size
 	local pivot = self.node_pivot
 	for index, node in pairs(self.nodes) do
-		_extend_border(self.border, self:get_pos(index), size, pivot)
+		self:_extend_border(self.border, self:get_pos(index), size, pivot)
 	end
 end
 
@@ -538,7 +461,7 @@ end
 
 
 ---Return elements offset for correct posing nodes. Correct posing at
--- parent pivot node (0:0) with adjusting of node sizes and anchoring
+---parent pivot node (0:0) with adjusting of node sizes and anchoring
 ---@return vector3 The offset vector
 ---@private
 function M:_get_zero_offset()
@@ -576,4 +499,21 @@ function M:_get_zero_offset_x(row_index)
 end
 
 
+---@param border vector4 Will be updated with new border values
+---@param pos vector3
+---@param size vector3
+---@param pivot vector3
+function M:_extend_border(border, pos, size, pivot)
+	local left = pos.x - size.x/2 - (size.x * pivot.x)
+	local right = pos.x + size.x/2 - (size.x * pivot.x)
+	local top = pos.y + size.y/2 - (size.y * pivot.y)
+	local bottom = pos.y - size.y/2 - (size.y * pivot.y)
+
+	border.x = math.min(border.x, left)
+	border.y = math.max(border.y, top)
+	border.z = math.max(border.z, right)
+	border.w = math.min(border.w, bottom)
+end
+
+
 return M

druid/base/text.lua

@@ -1,81 +1,3 @@
--- 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 event on_set_text event
-
---- On adjust text size callback(self, new_scale, text_metrics)
--- @tfield event on_update_text_scale event
-
---- On change pivot callback(self, pivot)
--- @tfield event on_set_pivot event
-
---- Text node
--- @tfield node node
-
---- The node id of text node
--- @tfield hash node_id
-
---- Current text position
--- @tfield vector3 pos
-
---- The last text value
--- @tfield string last_value
-
---- Initial text node scale
--- @tfield vector3 start_scale
-
---- Current text node scale
--- @tfield vector3 scale
-
---- Initial text node size
--- @tfield vector3 start_size
-
---- Current text node available are
--- @tfield vector3 text_area
-
---- Current text size adjust settings
--- @tfield number adjust_type
-
---- Current text color
--- @tfield vector3 color
-
----
-
 local event = require("event.event")
 local const = require("druid.const")
 local helper = require("druid.helper")
@@ -83,249 +5,48 @@ local utf8_lua = require("druid.system.utf8")
 local component = require("druid.component")
 local utf8 = utf8 or utf8_lua --[[@as utf8]]
 
----@class druid.text: druid.base_component
----@field node node
----@field on_set_text event
----@field on_update_text_scale event
----@field on_set_pivot event
----@field style table
----@field private start_pivot userdata
----@field private start_scale vector3
----@field private scale vector3
+---@class druid.text.style
+---@field TRIM_POSTFIX string|nil The postfix for TRIM adjust type. Default: ...
+---@field DEFAULT_ADJUST string|nil The default adjust type for any text component. Default: DOWNSCALE
+---@field ADJUST_STEPS number|nil Amount of iterations for text adjust by height. Default: 20
+---@field ADJUST_SCALE_DELTA number|nil Scale step on each height adjust step. Default: 0.02
+
+---@alias druid.text.adjust_type "downscale"|"trim"|"no_adjust"|"downscale_limited"|"scroll"|"scale_then_scroll"|"trim_left"|"scale_then_trim"|"scale_then_trim_left"
+
+---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], [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.
+---- Text pivot can be changed with `text:set_pivot`, and text will save their position inside their text size box
+---- There are several text adjust types:
+----   - **"downscale"** - Change text's scale to fit in the text node size (default)
+----   - **"trim"** - Trim the text with postfix (default - "...") to fit in the text node size
+----   - **"no_adjust"** - No any adjust, like default Defold text node
+----   - **"downscale_limited"** - Change text's scale like downscale, but there is limit for text's scale
+----   - **"scroll"** - Change text's pivot to imitate scrolling in the text box. Use with stencil node for better effect.
+----   - **"scale_then_scroll"** - Combine two modes: first limited downscale, then scroll
+----   - **"trim_left"** - Trim the text with postfix (default - "...") to fit in the text node size
+----   - **"scale_then_trim"** - Combine two modes: first limited downscale, then trim
+----   - **"scale_then_trim_left"** - Combine two modes: first limited downscale, then trim left
+---@class druid.text: druid.component
+---@field node node The text node
+---@field on_set_text event fun(self, text) The event triggered when the text is set
+---@field on_update_text_scale event fun(self, scale, metrics) The event triggered when the text scale is updated
+---@field on_set_pivot event fun(self, pivot) The event triggered when the text pivot is set
+---@field style druid.text.style The style of the text
+---@field private start_pivot userdata The start pivot of the text
+---@field private start_scale vector3 The start scale of the text
+---@field private scale vector3 The current scale of the text
 local M = component.create("text")
 
-local function update_text_size(self)
-	if self.scale.x == 0 or self.scale.y == 0 then
-		return
-	end
-	if self.start_scale.x == 0 or self.start_scale.y == 0 then
-		return
-	end
-
-	local size = vmath.vector3(
-		self.start_size.x * (self.start_scale.x / self.scale.x),
-		self.start_size.y * (self.start_scale.y / self.scale.y),
-		self.start_size.z
-	)
-	gui.set_size(self.node, size)
-end
-
-
---- Reset initial scale for text
-local function reset_default_scale(self)
-	self.scale.x = self.start_scale.x
-	self.scale.y = self.start_scale.y
-	self.scale.z = self.start_scale.z
-	gui.set_scale(self.node, self.start_scale)
-	gui.set_size(self.node, self.start_size)
-end
-
-
-local function is_fit_info_area(self, metrics)
-	return metrics.width * self.scale.x <= self.text_area.x and
-		   metrics.height * self.scale.y <= self.text_area.y
-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 metrics = helper.get_text_metrics_from_node(self.node)
-
-	if metrics.width == 0 then
-		reset_default_scale(self)
-		self.on_update_text_scale:trigger(self:get_context(), self.start_scale, metrics)
-		return
-	end
-
-	local text_area_width = self.text_area.x
-	local text_area_height = self.text_area.y
-
-	-- Adjust by width
-	local scale_modifier = text_area_width / metrics.width
-
-	-- Adjust by height
-	if self:is_multiline() then
-		-- Approximate scale by height to start adjust scale
-		scale_modifier = math.sqrt(text_area_height / metrics.height)
-		if metrics.width * scale_modifier > text_area_width then
-			scale_modifier = text_area_width / metrics.width
-		end
-
-		-- #RMME
-		if self._minimal_scale then
-			scale_modifier = math.max(scale_modifier, self._minimal_scale)
-		end
-		-- Limit max scale by initial scale
-		scale_modifier = math.min(scale_modifier, self.start_scale.x)
-		-- #RMME
-
-		local is_fit = is_fit_info_area(self, metrics)
-		local step = is_fit and self.style.ADJUST_SCALE_DELTA or -self.style.ADJUST_SCALE_DELTA
-
-		for i = 1, self.style.ADJUST_STEPS do
-			-- Grow down to check if we fit
-			if step < 0 and is_fit then
-				break
-			end
-			-- Grow up to check if we still fit
-			if step > 0 and not is_fit then
-				break
-			end
-
-			scale_modifier = scale_modifier + step
-
-			if self._minimal_scale then
-				scale_modifier = math.max(scale_modifier, self._minimal_scale)
-			end
-			-- Limit max scale by initial scale
-			scale_modifier = math.min(scale_modifier, self.start_scale.x)
-
-			self.scale.x = scale_modifier
-			self.scale.y = scale_modifier
-			self.scale.z = self.start_scale.z
-			gui.set_scale(self.node, self.scale)
-			update_text_size(self)
-			metrics = helper.get_text_metrics_from_node(self.node)
-			is_fit = is_fit_info_area(self, metrics)
-		end
-	end
-
-	if self._minimal_scale then
-		scale_modifier = math.max(scale_modifier, self._minimal_scale)
-	end
-
-	-- Limit max scale by initial scale
-	scale_modifier = math.min(scale_modifier, self.start_scale.x)
-
-	self.scale.x = scale_modifier
-	self.scale.y = scale_modifier
-	self.scale.z = self.start_scale.z
-	gui.set_scale(self.node, self.scale)
-	update_text_size(self)
-
-	self.on_update_text_scale:trigger(self:get_context(), self.scale, metrics)
-end
-
-
----@param self druid.text
----@param trim_postfix string
-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)
-			if text_length == 0 then
-				break
-			end
-		end
-
-		gui.set_text(self.node, new_text .. trim_postfix)
-	else
-		gui.set_text(self.node, self.last_value)
-	end
-end
-
-local function update_text_with_trim_left(self, trim_postfix)
-	local max_width = self.text_area.x
-	local text_width = self:get_text_size()
-	local text_length = utf8.len(self.last_value)
-	local trim_index = 1
-
-	if text_width > max_width then
-		local new_text = self.last_value
-		while text_width > max_width and trim_index < text_length do
-			trim_index = trim_index + 1
-			new_text = trim_postfix .. utf8.sub(self.last_value, trim_index, text_length)
-			text_width = self:get_text_size(new_text)
-		end
-
-		gui.set_text(self.node, new_text)
-	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
-
-
----@param self druid.text
-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.TRIM_LEFT then
-		update_text_with_trim_left(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
-
-	if self.adjust_type == const.TEXT_ADJUST.SCALE_THEN_TRIM then
-		update_text_area_size(self)
-		update_text_with_trim(self, self.style.TRIM_POSTFIX)
-	end
-
-	if self.adjust_type == const.TEXT_ADJUST.SCALE_THEN_TRIM_LEFT then
-		update_text_area_size(self)
-		update_text_with_trim_left(self, self.style.TRIM_POSTFIX)
-	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|nil TRIM_POSTFIX The postfix for TRIM adjust type. Default: ...
--- @tfield string|nil DEFAULT_ADJUST The default adjust type for any text component. Default: DOWNSCALE
--- @tfield string|nil ADJUST_STEPS Amount of iterations for text adjust by height. Default: 20
--- @tfield string|nil ADJUST_SCALE_DELTA Scale step on each height adjust step. Default: 0.02
-function M:on_style_change(style)
-	self.style = {}
-	self.style.TRIM_POSTFIX = style.TRIM_POSTFIX or "..."
-	self.style.DEFAULT_ADJUST = style.DEFAULT_ADJUST or const.TEXT_ADJUST.DOWNSCALE
-	self.style.ADJUST_STEPS = style.ADJUST_STEPS or 20
-	self.style.ADJUST_SCALE_DELTA = style.ADJUST_SCALE_DELTA or 0.02
-end
-
 
 ---The Text constructor
 ---@param node string|node Node name or GUI Text Node itself
 ---@param value string|nil Initial text. Default value is node text from GUI scene. Default: nil
----@param adjust_type string|nil Adjust type for text. By default is DOWNSCALE. Look const.TEXT_ADJUST for reference. Default: DOWNSCALE
+---@param adjust_type druid.text.adjust_type|nil Adjust type for text. By default is "downscale". Options: "downscale", "trim", "no_adjust", "downscale_limited", "scroll", "scale_then_scroll", "trim_left", "scale_then_trim", "scale_then_trim_left"
 function M:init(node, value, adjust_type)
 	self.node = self:get_node(node)
 	self.pos = gui.get_position(self.node)
@@ -348,19 +69,31 @@ function M:init(node, value, adjust_type)
 	self.on_update_text_scale = event.create()
 
 	self:set_text(value or gui.get_text(self.node))
-	return self
 end
 
 
+---@private
+---@param style druid.text.style
+function M:on_style_change(style)
+	self.style = {
+		TRIM_POSTFIX = style.TRIM_POSTFIX or "...",
+		DEFAULT_ADJUST = style.DEFAULT_ADJUST or "downscale",
+		ADJUST_STEPS = style.ADJUST_STEPS or 20,
+		ADJUST_SCALE_DELTA = style.ADJUST_SCALE_DELTA or 0.02
+	}
+end
+
+
+---@private
 function M:on_layout_change()
 	self:set_text(self.last_value)
 end
 
 
 ---Calculate text width with font with respect to trailing space
----@param text string|nil
----@return number Width
----@return number Height
+---@param text string|nil The text to calculate the size of, if nil - use current text
+---@return number width The text width
+---@return number height The text height
 function M:get_text_size(text)
 	text = text or self.last_value
 	local font_name = gui.get_font(self.node)
@@ -382,8 +115,8 @@ end
 
 
 ---Get chars count by width
----@param width number
----@return number Chars count
+---@param width number The width to get the chars count of
+---@return number index The chars count
 function M:get_text_index_by_width(width)
 	local text = self.last_value
 	local font_name = gui.get_font(self.node)
@@ -417,7 +150,7 @@ end
 ---Set text to text field
 ---@deprecated
 ---@param set_to string Text for node
----@return druid.text Current text instance
+---@return druid.text self Current text instance
 function M:set_to(set_to)
 	set_to = tostring(set_to or "")
 
@@ -426,7 +159,7 @@ function M:set_to(set_to)
 
 	self.on_set_text:trigger(self:get_context(), set_to)
 
-	update_adjust(self)
+	self:_update_adjust()
 
 	return self
 end
@@ -451,7 +184,7 @@ function M:set_size(size)
 	self.text_area = vmath.vector3(size)
 	self.text_area.x = self.text_area.x * self.start_scale.x
 	self.text_area.y = self.text_area.y * self.start_scale.y
-	update_adjust(self)
+	self:_update_adjust()
 
 	return self
 end
@@ -459,7 +192,7 @@ end
 
 ---Set color
 ---@param color vector4 Color for node
----@return druid.text Current text instance
+---@return druid.text self Current text instance
 function M:set_color(color)
 	self.color = color
 	gui.set_color(self.node, color)
@@ -470,7 +203,7 @@ end
 
 ---Set alpha
 ---@param alpha number Alpha for node
----@return druid.text Current text instance
+---@return druid.text self Current text instance
 function M:set_alpha(alpha)
 	self.color.w = alpha
 	gui.set_color(self.node, self.color)
@@ -481,7 +214,7 @@ end
 
 ---Set scale
 ---@param scale vector3 Scale for node
----@return druid.text Current text instance
+---@return druid.text self Current text instance
 function M:set_scale(scale)
 	self.last_scale = scale
 	gui.set_scale(self.node, scale)
@@ -492,7 +225,7 @@ end
 
 ---Set text pivot. Text will re-anchor inside text area
 ---@param pivot userdata The gui.PIVOT_* constant
----@return druid.text Current text instance
+---@return druid.text self Current text instance
 function M:set_pivot(pivot)
 	local prev_pivot = gui.get_pivot(self.node)
 	local prev_offset = const.PIVOTS[prev_pivot]
@@ -523,9 +256,7 @@ end
 
 
 ---Set text adjust, refresh the current text visuals, if needed
----Values are: "downscale", "trim", "no_adjust", "downscale_limited",
----"scroll", "scale_then_scroll", "trim_left", "scale_then_trim", "scale_then_trim_left"
----@param adjust_type string|nil See const.TEXT_ADJUST. If pass nil - use current adjust type
+---@param adjust_type druid.text.adjust_type|nil The adjust type to set, values: "downscale", "trim", "no_adjust", "downscale_limited", "scroll", "scale_then_scroll", "trim_left", "scale_then_trim", "scale_then_trim_left"
 ---@param minimal_scale number|nil To remove minimal scale, use `text:set_minimal_scale(nil)`, if pass nil - not change minimal scale
 ---@return druid.text self Current text instance
 function M:set_text_adjust(adjust_type, minimal_scale)
@@ -537,9 +268,9 @@ function M:set_text_adjust(adjust_type, minimal_scale)
 end
 
 
---- Set minimal scale for DOWNSCALE_LIMITED or SCALE_THEN_SCROLL adjust types
+---Set minimal scale for "downscale_limited" or "scale_then_scroll" adjust types
 ---@param minimal_scale number If pass nil - not use minimal scale
----@return druid.text Current text instance
+---@return druid.text self Current text instance
 function M:set_minimal_scale(minimal_scale)
 	self._minimal_scale = minimal_scale
 
@@ -554,4 +285,225 @@ function M:get_text_adjust()
 end
 
 
+---@private
+function M:_update_text_size()
+	if self.scale.x == 0 or self.scale.y == 0 then
+		return
+	end
+	if self.start_scale.x == 0 or self.start_scale.y == 0 then
+		return
+	end
+
+	local size = vmath.vector3(
+		self.start_size.x * (self.start_scale.x / self.scale.x),
+		self.start_size.y * (self.start_scale.y / self.scale.y),
+		self.start_size.z
+	)
+	gui.set_size(self.node, size)
+end
+
+
+---Reset initial scale for text
+---@private
+function M:_reset_default_scale()
+	self.scale.x = self.start_scale.x
+	self.scale.y = self.start_scale.y
+	self.scale.z = self.start_scale.z
+	gui.set_scale(self.node, self.start_scale)
+	gui.set_size(self.node, self.start_size)
+end
+
+
+---@private
+---@param metrics table
+---@return boolean
+function M:_is_fit_info_area(metrics)
+	return metrics.width * self.scale.x <= self.text_area.x and
+		   metrics.height * self.scale.y <= self.text_area.y
+end
+
+
+---Setup scale x, but can only be smaller, than start text scale
+---@private
+function M:_update_text_area_size()
+	self:_reset_default_scale()
+
+	local metrics = helper.get_text_metrics_from_node(self.node)
+
+	if metrics.width == 0 then
+		self:_reset_default_scale()
+		self.on_update_text_scale:trigger(self:get_context(), self.start_scale, metrics)
+		return
+	end
+
+	local text_area_width = self.text_area.x
+	local text_area_height = self.text_area.y
+
+	-- Adjust by width
+	local scale_modifier = text_area_width / metrics.width
+
+	-- Adjust by height
+	if self:is_multiline() then
+		-- Approximate scale by height to start adjust scale
+		scale_modifier = math.sqrt(text_area_height / metrics.height)
+		if metrics.width * scale_modifier > text_area_width then
+			scale_modifier = text_area_width / metrics.width
+		end
+
+		-- #RMME
+		if self._minimal_scale then
+			scale_modifier = math.max(scale_modifier, self._minimal_scale)
+		end
+		-- Limit max scale by initial scale
+		scale_modifier = math.min(scale_modifier, self.start_scale.x)
+		-- #RMME
+
+		local is_fit = self:_is_fit_info_area(metrics)
+		local step = is_fit and self.style.ADJUST_SCALE_DELTA or -self.style.ADJUST_SCALE_DELTA
+
+		for i = 1, self.style.ADJUST_STEPS do
+			-- Grow down to check if we fit
+			if step < 0 and is_fit then
+				break
+			end
+			-- Grow up to check if we still fit
+			if step > 0 and not is_fit then
+				break
+			end
+
+			scale_modifier = scale_modifier + step
+
+			if self._minimal_scale then
+				scale_modifier = math.max(scale_modifier, self._minimal_scale)
+			end
+			-- Limit max scale by initial scale
+			scale_modifier = math.min(scale_modifier, self.start_scale.x)
+
+			self.scale.x = scale_modifier
+			self.scale.y = scale_modifier
+			self.scale.z = self.start_scale.z
+			gui.set_scale(self.node, self.scale)
+			self:_update_text_size()
+			metrics = helper.get_text_metrics_from_node(self.node)
+			is_fit = self:_is_fit_info_area(metrics)
+		end
+	end
+
+	if self._minimal_scale then
+		scale_modifier = math.max(scale_modifier, self._minimal_scale)
+	end
+
+	-- Limit max scale by initial scale
+	scale_modifier = math.min(scale_modifier, self.start_scale.x)
+
+	self.scale.x = scale_modifier
+	self.scale.y = scale_modifier
+	self.scale.z = self.start_scale.z
+	gui.set_scale(self.node, self.scale)
+	self:_update_text_size()
+
+	self.on_update_text_scale:trigger(self:get_context(), self.scale, metrics)
+end
+
+
+---@private
+---@param trim_postfix string
+function M:_update_text_with_trim(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)
+			if text_length == 0 then
+				break
+			end
+		end
+
+		gui.set_text(self.node, new_text .. trim_postfix)
+	else
+		gui.set_text(self.node, self.last_value)
+	end
+end
+
+
+---@private
+---@param trim_postfix string
+function M:_update_text_with_trim_left(trim_postfix)
+	local max_width = self.text_area.x
+	local text_width = self:get_text_size()
+	local text_length = utf8.len(self.last_value)
+	local trim_index = 1
+
+	if text_width > max_width then
+		local new_text = self.last_value
+		while text_width > max_width and trim_index < text_length do
+			trim_index = trim_index + 1
+			new_text = trim_postfix .. utf8.sub(self.last_value, trim_index, text_length)
+			text_width = self:get_text_size(new_text)
+		end
+
+		gui.set_text(self.node, new_text)
+	end
+end
+
+
+---@private
+function M:_update_text_with_anchor_shift()
+	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
+
+
+---@private
+function M:_update_adjust()
+	if not self.adjust_type or self.adjust_type == "no_adjust" then
+		self:_reset_default_scale()
+		return
+	end
+
+	if self.adjust_type == "downscale" then
+		self:_update_text_area_size()
+	end
+
+	if self.adjust_type == "trim" then
+		self:_update_text_with_trim(self.style.TRIM_POSTFIX)
+	end
+
+	if self.adjust_type == "trim_left" then
+		self:_update_text_with_trim_left(self.style.TRIM_POSTFIX)
+	end
+
+	if self.adjust_type == "downscale_limited" then
+		self:_update_text_area_size()
+	end
+
+	if self.adjust_type == "scroll" then
+		self:_update_text_with_anchor_shift()
+	end
+
+	if self.adjust_type == "scale_then_scroll" then
+		self:_update_text_area_size()
+		self:_update_text_with_anchor_shift()
+	end
+
+	if self.adjust_type == "scale_then_trim" then
+		self:_update_text_area_size()
+		self:_update_text_with_trim(self.style.TRIM_POSTFIX)
+	end
+
+	if self.adjust_type == "scale_then_trim_left" then
+		self:_update_text_area_size()
+		self:_update_text_with_trim_left(self.style.TRIM_POSTFIX)
+	end
+end
+
+
 return M

druid/bindings.lua

@@ -1,48 +0,0 @@
-local event = require("event.event")
-
-local M = {}
-local WRAPPED_WIDGETS = {}
-
----Set a widget to the current game object. The game object can acquire the widget by calling `bindings.get_widget`
----It wraps with events only top level functions cross-context, so no access to nested widgets functions
----@param widget druid.widget
-function M.set_widget(widget)
-	local object = msg.url()
-	object.fragment = nil
-
-	-- Make a copy of the widget with all functions wrapped in events
-	-- It makes available to call gui functions from game objects
-	local wrapped_widget = setmetatable({}, { __index = widget })
-	local parent_table = getmetatable(widget).__index
-
-	-- Go through all functions and wrap them in events
-	for key, value in pairs(parent_table) do
-		if type(value) == "function" then
-			wrapped_widget[key] = event.create(function(_, ...)
-				return value(widget, ...)
-			end)
-		end
-	end
-
-	WRAPPED_WIDGETS[object.socket] = WRAPPED_WIDGETS[object.socket] or {}
-	WRAPPED_WIDGETS[object.socket][object.path] = wrapped_widget
-end
-
-
----@param object_url string|userdata|url @root object
----@return druid.widget|nil
-function M.get_widget(object_url)
-	assert(object_url, "You must provide an object_url")
-
-	object_url = msg.url(object_url --[[@as string]])
-
-	local socket_widgets = WRAPPED_WIDGETS[object_url.socket]
-	if not socket_widgets then
-		return nil
-	end
-
-	return socket_widgets[object_url.path]
-end
-
-
-return M