Update README and docs

This commit is contained in:
Insality
2020-03-22 15:19:10 +03:00
parent ed39091a8e
commit a0e5abeffd
29 changed files with 141 additions and 118 deletions

View File

@@ -1,6 +1,8 @@
# Druid components
## Button
Basic Druid input component
- Button callback have next params: (self, params, button_instance)
@@ -16,23 +18,31 @@ Basic Druid input component
- 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`
## Text
Basic Druid text component
- Text component by default have auto adjust text sizing. Text never will be more, than text size, which you can setup in gui scene. It can be disabled on component creating
![](../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)
## Blocker
Druid component for block input
It can be used for block input in special zone.
Example:
![](../media/blocker_scheme.png)
Blue zone is **button** with close_window callback
Blue zone is **button** with close_window callback
Yellow zone is blocker with window content
@@ -43,26 +53,23 @@ Component to handle back button
It works on Android back button and Backspace. Key triggers in `input.binding` should be setup
## Locale
Wrap on Druid text component to handle localization
## Timer
Run timer on text node
## Progress
Basic progress bar
## Lang text
Wrap on Text component to handle localization
## Scroll
Basic scroll component
Basic Druid scroll component
## Grid
Component for manage node positions
## Progress
Basic Druid progress bar component
## Slider
Basic slider component
Basic Druid slider component
## Input
Basic Druid text input component (unimplemented)
## Checkbox
Basic checkbox component
Basic Druid checkbox component
## Checkbox group
Several checkboxes in one group
@@ -70,8 +77,11 @@ Several checkboxes in one group
## Radio group
Several checkboxes in one group with single choice
## Hover
Trigger component for check node hover state
## Timer
Handle timer work on gui text node
## Input
Component to process user text input
## Grid
Component for manage node positions
## Hover
System Druid component, handle hover node state