diff --git a/README.md b/README.md index aa80846..7f7c5c9 100644 --- a/README.md +++ b/README.md @@ -58,37 +58,38 @@ druid.set_default_style(your_style) ## Components **Druid** provides next basic components: -- **Button** - Basic game button -- **Text** - Wrap on text node with text size adjusting +- **[Button](https://github.com/Insality/druid/blob/master/docs_md/01-components.md#button)** - Basic Druid input component -- **Blocker** - Block input in node zone +- **[Text](https://github.com/Insality/druid/blob/master/docs_md/01-components.md#text)** - Basic Druid text component -- **Back Handler** - Handle back button (Android, backspace) +- **Lang text** - Wrap on Text component to handle localization -- **Lang text** - Text component with handle localization system +- **Scroll** - Basic Druid scroll component -- **Timer** - Run timer on text node +- **Progress** - Basic Druid progress bar component -- **Progress** - Basic progress bar +- **Slider** - Basic Druid slider component -- **Scroll** - Basic scroll component +- **Input** - Basic Druid text input component (unimplemented) -- **Grid** - Component for manage node positions - -- **Slider** - Basic slider component - -- **Checkbox** - Basic checkbox component +- **Checkbox** - Basic Druid checkbox component - **Checkbox group** - Several checkboxes in one group - **Radio group** - Several checkboxes in one group with single choice -- **Hover** - Trigger component for check node hover state +- **[Blocker](https://github.com/Insality/druid/blob/master/docs_md/01-components.md#blocker)** - Block input in node zone component -- **Input** - Component to process user text input +- **Back Handler** - Handle back button (Android back, backspace) -Full info see on _components.md_ +- **Timer** - Handle timer work on gui text node + +- **Grid** - Component for manage node positions + +- **Hover** - System Druid component, handle hover node state + +Full info see on _[components.md](https://github.com/Insality/druid/blob/master/docs_md/01-components.md)_ ## Basic usage @@ -153,10 +154,10 @@ Try the [HTML5 version](https://insality.github.io/druid/druid/) of the example ## Documentation To learn **Druid** better, read next documentation: -- [Druid components](https://insality.github.io/druid/topics/01-components.md.html) -- [Create custom components](https://insality.github.io/druid/topics/02-creating_custom_components.md.html) -- [Druid styles](https://insality.github.io/druid/topics/03-styles.md.html) -- [Druid asset store](https://insality.github.io/druid/topics/04-druid_assets.md.html) +- [Druid components](https://github.com/Insality/druid/blob/master/docs_md/01-components.md) +- [Create custom components](https://github.com/Insality/druid/blob/master/docs_md/02-creating_custom_components.md) +- [Druid styles](https://github.com/Insality/druid/blob/master/docs_md/03-styles.md) +- [Druid asset store](https://github.com/Insality/druid/blob/master/docs_md/04-druid_assets.md) Full **Druid** documentation you can find here: https://insality.github.io/druid/ diff --git a/docs/index.html b/docs/index.html index 7d3b373..12e78fc 100644 --- a/docs/index.html +++ b/docs/index.html @@ -185,7 +185,7 @@
generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
diff --git a/docs/modules/component.html b/docs/modules/component.html index c703735..2a20847 100644 --- a/docs/modules/component.html +++ b/docs/modules/component.html @@ -406,7 +406,7 @@
generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
diff --git a/docs/modules/druid.back_handler.html b/docs/modules/druid.back_handler.html index 061853f..e325a78 100644 --- a/docs/modules/druid.back_handler.html +++ b/docs/modules/druid.back_handler.html @@ -215,7 +215,7 @@
generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
diff --git a/docs/modules/druid.blocker.html b/docs/modules/druid.blocker.html index bf2dcfb..561ad3b 100644 --- a/docs/modules/druid.blocker.html +++ b/docs/modules/druid.blocker.html @@ -234,7 +234,7 @@
generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
diff --git a/docs/modules/druid.button.html b/docs/modules/druid.button.html index 9273823..bbdf5fe 100644 --- a/docs/modules/druid.button.html +++ b/docs/modules/druid.button.html @@ -405,7 +405,7 @@
generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
diff --git a/docs/modules/druid.checkbox.html b/docs/modules/druid.checkbox.html index 0d56299..e342bba 100644 --- a/docs/modules/druid.checkbox.html +++ b/docs/modules/druid.checkbox.html @@ -277,7 +277,7 @@
generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
diff --git a/docs/modules/druid.checkbox_group.html b/docs/modules/druid.checkbox_group.html index 1636a4b..2141614 100644 --- a/docs/modules/druid.checkbox_group.html +++ b/docs/modules/druid.checkbox_group.html @@ -239,7 +239,7 @@
generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
diff --git a/docs/modules/druid.grid.html b/docs/modules/druid.grid.html index 85fc6c0..6e08671 100644 --- a/docs/modules/druid.grid.html +++ b/docs/modules/druid.grid.html @@ -370,7 +370,7 @@
generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
diff --git a/docs/modules/druid.helper.html b/docs/modules/druid.helper.html index d4f4125..d51cedf 100644 --- a/docs/modules/druid.helper.html +++ b/docs/modules/druid.helper.html @@ -236,7 +236,7 @@
generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
diff --git a/docs/modules/druid.hover.html b/docs/modules/druid.hover.html index 39a0670..7f092f2 100644 --- a/docs/modules/druid.hover.html +++ b/docs/modules/druid.hover.html @@ -211,7 +211,7 @@
generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
diff --git a/docs/modules/druid.html b/docs/modules/druid.html index b7c0412..890513e 100644 --- a/docs/modules/druid.html +++ b/docs/modules/druid.html @@ -181,7 +181,7 @@
generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
diff --git a/docs/modules/druid.input.html b/docs/modules/druid.input.html index 7847d31..eeed464 100644 --- a/docs/modules/druid.input.html +++ b/docs/modules/druid.input.html @@ -86,7 +86,7 @@
generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
diff --git a/docs/modules/druid.lang_text.html b/docs/modules/druid.lang_text.html index 79e417c..052acc8 100644 --- a/docs/modules/druid.lang_text.html +++ b/docs/modules/druid.lang_text.html @@ -240,7 +240,7 @@
generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
diff --git a/docs/modules/druid.progress.html b/docs/modules/druid.progress.html index 30ecee2..26fa713 100644 --- a/docs/modules/druid.progress.html +++ b/docs/modules/druid.progress.html @@ -378,7 +378,7 @@
generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
diff --git a/docs/modules/druid.radio_group.html b/docs/modules/druid.radio_group.html index c0d19cf..0391222 100644 --- a/docs/modules/druid.radio_group.html +++ b/docs/modules/druid.radio_group.html @@ -239,7 +239,7 @@
generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
diff --git a/docs/modules/druid.scroll.html b/docs/modules/druid.scroll.html index 8bf1938..8d3c393 100644 --- a/docs/modules/druid.scroll.html +++ b/docs/modules/druid.scroll.html @@ -507,7 +507,7 @@
generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
diff --git a/docs/modules/druid.slider.html b/docs/modules/druid.slider.html index c2f9507..49068a6 100644 --- a/docs/modules/druid.slider.html +++ b/docs/modules/druid.slider.html @@ -278,7 +278,7 @@
generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
diff --git a/docs/modules/druid.text.html b/docs/modules/druid.text.html index 3e5a60a..b74e503 100644 --- a/docs/modules/druid.text.html +++ b/docs/modules/druid.text.html @@ -352,7 +352,7 @@
generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
diff --git a/docs/modules/druid.timer.html b/docs/modules/druid.timer.html index 610f4d2..f76d4c3 100644 --- a/docs/modules/druid.timer.html +++ b/docs/modules/druid.timer.html @@ -307,7 +307,7 @@
generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
diff --git a/docs/modules/druid_event.html b/docs/modules/druid_event.html index dbcf349..7850ea7 100644 --- a/docs/modules/druid_event.html +++ b/docs/modules/druid_event.html @@ -239,7 +239,7 @@
generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
diff --git a/docs/modules/druid_instance.html b/docs/modules/druid_instance.html index 73f99bf..6d30ad0 100644 --- a/docs/modules/druid_instance.html +++ b/docs/modules/druid_instance.html @@ -750,7 +750,7 @@
generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
diff --git a/docs/topics/01-components.md.html b/docs/topics/01-components.md.html index 61c39ad..a0875e0 100644 --- a/docs/topics/01-components.md.html +++ b/docs/topics/01-components.md.html @@ -36,17 +36,17 @@
  • Text
  • Blocker
  • Back Handler
    • -
  • Locale
    • -
  • Timer
    • -
  • Progress
    • +
  • Lang text
  • Scroll
    • -
  • Grid
    • +
  • Progress
  • Slider
    • +
  • Input
  • Checkbox
  • Checkbox group
  • Radio group
    • +
  • Timer
    • +
  • Grid
  • Hover
    • -
  • Input
    • @@ -90,8 +90,10 @@

    Druid components

    +

    Button

    +

    Basic Druid input component

    +

    Text

    +

    Basic Druid text component

    +

    + + + +

    + +

    Blocker

    +

    Druid component for block input

    It can be used for block input in special zone.

    -

    Example: -

    +

    Example:

    -

    Blue zone is button with close_window callback

    +

    + +

    Blue zone is button with close_window callback

    Yellow zone is blocker with window content

    @@ -149,33 +161,29 @@

    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

    @@ -185,20 +193,24 @@

    Radio group

    Several checkboxes in one group with single choice

    +

    +

    Timer

    +

    Handle timer work on gui text node

    + +

    +

    Grid

    +

    Component for manage node positions

    +

    Hover

    -

    Trigger component for check node hover state

    - -

    -

    Input

    -

    Component to process user text input

    +

    System Druid component, handle hover node state

    generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
    diff --git a/docs/topics/02-creating_custom_components.md.html b/docs/topics/02-creating_custom_components.md.html index 242991d..cd684e7 100644 --- a/docs/topics/02-creating_custom_components.md.html +++ b/docs/topics/02-creating_custom_components.md.html @@ -202,7 +202,7 @@ There is next interests in druid:
    generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
    diff --git a/docs/topics/03-styles.md.html b/docs/topics/03-styles.md.html index b4eb753..f6bafcd 100644 --- a/docs/topics/03-styles.md.html +++ b/docs/topics/03-styles.md.html @@ -138,7 +138,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
    diff --git a/docs/topics/04-druid_assets.md.html b/docs/topics/04-druid_assets.md.html index f75ffee..cab9b23 100644 --- a/docs/topics/04-druid_assets.md.html +++ b/docs/topics/04-druid_assets.md.html @@ -89,7 +89,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
    diff --git a/docs/topics/05-examples.md.html b/docs/topics/05-examples.md.html index b62e37b..671c7ff 100644 --- a/docs/topics/05-examples.md.html +++ b/docs/topics/05-examples.md.html @@ -87,7 +87,7 @@
    generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
    diff --git a/docs/topics/README.md.html b/docs/topics/README.md.html index 78e9d71..742f109 100644 --- a/docs/topics/README.md.html +++ b/docs/topics/README.md.html @@ -148,27 +148,27 @@

    Components

    -

    Druid provides next basic components: -- Button - Basic game button

    +

    Druid provides next basic components:

    -

    Full info see on components.md

    +

    Full info see on components.md

    @@ -242,10 +242,10 @@

    Documentation

    To learn Druid better, read next documentation: -- Druid components -- Create custom components -- Druid styles -- Druid asset store

    +- Druid components +- Create custom components +- Druid styles +- Druid asset store

    Full Druid documentation you can find here: https://insality.github.io/druid/

    @@ -291,7 +291,7 @@ https://insality.github.io/druid/

    generated by LDoc 1.4.6 -Last updated 2020-03-22 12:55:11 +Last updated 2020-03-22 15:19:02
    diff --git a/docs_md/01-components.md b/docs_md/01-components.md index a0da835..513261c 100644 --- a/docs_md/01-components.md +++ b/docs_md/01-components.md @@ -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 \ No newline at end of file +## Grid +Component for manage node positions + +## Hover +System Druid component, handle hover node state \ No newline at end of file