mirror of
https://github.com/Insality/druid.git
synced 2025-06-27 10:27:47 +02:00
Add examples to component docs
This commit is contained in:
parent
c2b65eb4e2
commit
cb6fd3038a
@ -8,7 +8,7 @@ Simple to-do for Druid Alpha 0.2.0
|
|||||||
+ better name for locale component? lang? lang_text?
|
+ better name for locale component? lang? lang_text?
|
||||||
+ better name for slider component? Slider is ok
|
+ better name for slider component? Slider is ok
|
||||||
+ Druid store assets - separate repository with rich components (progress_rich migrate)
|
+ Druid store assets - separate repository with rich components (progress_rich migrate)
|
||||||
- refactor on_swipe. To on_scroll? Add input priority
|
+ refactor on_swipe. To on_scroll? Add input priority
|
||||||
- separate custom data and predefined fields in components?
|
- separate custom data and predefined fields in components?
|
||||||
- add init/remove stuff for every style in component. How to set custom sprites for button states?
|
- add init/remove stuff for every style in component. How to set custom sprites for button states?
|
||||||
- unify component api (get/set/to and other general stuff)
|
- unify component api (get/set/to and other general stuff)
|
||||||
@ -24,6 +24,7 @@ Simple to-do for Druid Alpha 0.2.0
|
|||||||
- compare with gooey
|
- compare with gooey
|
||||||
- add docs for all components
|
- add docs for all components
|
||||||
- add docs folder for every component with gifs? Solutions
|
- add docs folder for every component with gifs? Solutions
|
||||||
|
- remove component autoremove all children component
|
||||||
|
|
||||||
|
|
||||||
-- Low
|
-- Low
|
||||||
|
@ -2,6 +2,10 @@ project='Druid'
|
|||||||
title='Defold Druid UI Library'
|
title='Defold Druid UI Library'
|
||||||
description='Documentation for Druid Library'
|
description='Documentation for Druid Library'
|
||||||
file={"./druid"}
|
file={"./druid"}
|
||||||
|
package='druid'
|
||||||
|
sort=true
|
||||||
dir='./docs'
|
dir='./docs'
|
||||||
style='!pale'
|
style='!fixed'
|
||||||
|
format='discount'
|
||||||
|
use_markdown_titles=true
|
||||||
no_space_before_args=true
|
no_space_before_args=true
|
@ -1,6 +1,17 @@
|
|||||||
--- Component to handle basic GUI button
|
--- Component to handle basic GUI button
|
||||||
-- @module druid.button
|
-- @module druid.button
|
||||||
|
|
||||||
|
--- Component events
|
||||||
|
-- @tfield druid_event on_click
|
||||||
|
-- @tfield druid_event on_hold_click
|
||||||
|
-- @tfield druid_event on_long_click
|
||||||
|
-- @tfield druid_event on_double_click
|
||||||
|
-- @table events
|
||||||
|
|
||||||
|
--- Component fields
|
||||||
|
-- @tfield node Main node
|
||||||
|
-- @table fields
|
||||||
|
|
||||||
local Event = require("druid.event")
|
local Event = require("druid.event")
|
||||||
local const = require("druid.const")
|
local const = require("druid.const")
|
||||||
local helper = require("druid.helper")
|
local helper = require("druid.helper")
|
||||||
|
@ -7,6 +7,11 @@
|
|||||||
-- to how to do your custom complex components to
|
-- to how to do your custom complex components to
|
||||||
-- separate UI game logic to small files
|
-- separate UI game logic to small files
|
||||||
--
|
--
|
||||||
|
-- require("druid.druid")
|
||||||
|
-- function init(self)
|
||||||
|
-- self.druid = druid.new(self)
|
||||||
|
-- end
|
||||||
|
--
|
||||||
-- @module druid
|
-- @module druid
|
||||||
|
|
||||||
local const = require("druid.const")
|
local const = require("druid.const")
|
||||||
|
@ -1,7 +1,9 @@
|
|||||||
--- Lua event small library
|
--- Lua event small library
|
||||||
|
-- @module druid_event
|
||||||
|
|
||||||
local class = require("druid.system.middleclass")
|
local class = require("druid.system.middleclass")
|
||||||
|
|
||||||
|
-- @class DruidEvent
|
||||||
local M = class("druid.event")
|
local M = class("druid.event")
|
||||||
|
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user