{"id":16085554,"url":"https://github.com/adamwestman/define","last_synced_at":"2025-03-19T05:30:28.554Z","repository":{"id":257816279,"uuid":"97060038","full_name":"adamwestman/define","owner":"adamwestman","description":"A Defold UI/UX library","archived":false,"fork":false,"pushed_at":"2017-09-01T11:53:31.000Z","size":20,"stargazers_count":18,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-17T03:51:19.307Z","etag":null,"topics":["defold-game-engine","gui","ux-library"],"latest_commit_sha":null,"homepage":null,"language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adamwestman.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-07-12T23:26:44.000Z","updated_at":"2025-02-05T23:55:18.000Z","dependencies_parsed_at":"2024-10-12T00:17:11.797Z","dependency_job_id":null,"html_url":"https://github.com/adamwestman/define","commit_stats":{"total_commits":4,"total_committers":2,"mean_commits":2.0,"dds":0.25,"last_synced_commit":"151fa647892637573851e4d5d6394b8891a1fad5"},"previous_names":["adamwestman/define"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamwestman%2Fdefine","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamwestman%2Fdefine/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamwestman%2Fdefine/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamwestman%2Fdefine/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adamwestman","download_url":"https://codeload.github.com/adamwestman/define/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244364546,"owners_count":20441457,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["defold-game-engine","gui","ux-library"],"created_at":"2024-10-09T13:02:01.523Z","updated_at":"2025-03-19T05:30:28.547Z","avatar_url":"https://github.com/adamwestman.png","language":"Lua","funding_links":[],"categories":["Libraries"],"sub_categories":["Programming Language"],"readme":"# DeFine\n\n_When great is not good enough.. __it needs to be Fine.___\n\nA UI/UX library for the Defold engine, providing fundamental components to build a rich graphical user interface in no time.\n\n# Usage\nAdd latest zip URL as a [dependency](http://www.defold.com/manuals/libraries/#_setting_up_library_dependencies) in your Defold project: `https://github.com/adamwestman/define/archive/master.zip`\n\n## Input Manager\n\nThe __define.input_manager__ provide a shared container to manage all components, allowing them to be grouped and prioritized.\n\n```lua\nfunction init(self)\n  input_manager.acquire()\n\n  self.btn_text = input_manager.add_button(self, button.create(\"text/bg\"), function()\n    self.current_proxy = TEXT_PROXY\n    msg.post(self.current_proxy, \"async_load\")\n  end)\n  self.btn_volume = input_manager.add_button(self, button.create(\"volume/bg\"), function()\n    self.current_proxy = VOLUME_PROXY\n    msg.post(self.current_proxy, \"async_load\")\n  end)\n  self.btn_back = input_manager.add_button(self, button.create(\"back/bg\"), function()\n    msg.post(self.current_proxy, \"unload\")\n  end)\n\n  button.hide(self.btn_back)\nend\n\nfunction final(self)\n\tinput_manager.release()\nend\n\nfunction on_input(self, action_id, action)\n\treturn input_manager.on_input(self, action_id, action)\nend\n```\n\n### Buttons\n\nThe __define.gui.button__ component allows a gui node to react on user tap actions.\n\n### Text Fields\n\nThe __define.gui.text__ component allows users to edit the contents of a text node.\n\n```lua\nlocal text = require \"define.gui.text\"\n\nfunction init(self)\n  self.name = text.create(\"name\")\n  self.place = text.create(\"place\", {max_lengt=10})\n\n  msg.post(\".\", \"acquire_input_focus\")\nend\n\nfunction on_input(self, action_id, action)\n  if text.on_input(self.name, action_id, action) then\n    return true\n  elseif text.on_input(self.place, action_id, action) then\n    return true\n  end\nend\n```\n\n### State Transitions\n\nAll components are built around a state/transition design. This enables the components to be appear and act in depending on needs. Here's an example of how a Checkbox component can be built using the __define.gui.button__ one.\n\n```lua\nlocal button = require \"define.gui.button\"\nlocal volume_checkbox_transitions = require \"examples.volume.volume_checkbox_transitions\"\n\nfunction init(self)\n  self.volume = button.create(\"volume\", volume_checkbox_transitions)\n\n  msg.post(\".\", \"acquire_input_focus\")\nend\n\nfunction on_input(self, action_id, action)\n  if button.on_input(self.volume, action_id, action) then\n    self.muted = not self.muted\n    button.set_state(self.volume, self.muted and hash(\"off\") or hash(\"on\"))\n    sound.set_group_gain(hash(\"master\"), self.muted and 0 or 1)\n  end\nend\n```\n\nWhere the transitions handle the checked state.\n```lua\nlocal input_states = require(\"define.input_states\")\nlocal input_transitions = require(\"define.gui.input_transitions\")\n\nlocal COLOR_DARKEN = vmath.vector4(0.8)\nlocal COLOR_DEFAULT = vmath.vector4(1)\n\nreturn {\n\tinput_transitions.create(input_states.STATE_IDLE, input_states.STATE_PRESSED, input_transitions.multi_parallell(\n\t\tinput_transitions.shake(),\n\t\tinput_transitions.to_color(COLOR_DARKEN)\n\t)),\n\tinput_transitions.create(input_states.STATE_PRESSED, input_states.STATE_IDLE, input_transitions.multi_parallell(\n\t\tinput_transitions.shake(),\n\t\tinput_transitions.to_color(COLOR_DEFAULT)\n\t)),\n\tinput_transitions.create(input_states.STATE_IDLE, input_states.STATE_HIDDEN, input_transitions.to_disabled()),\n\tinput_transitions.create(input_states.STATE_HIDDEN, input_states.STATE_IDLE, input_transitions.to_enabled()),\n\tinput_transitions.create(input_states.STATE_IDLE, input_states.STATE_HOVER, input_transitions.to_color(COLOR_DARKEN)),\n\tinput_transitions.create(input_states.STATE_HOVER, input_states.STATE_IDLE, input_transitions.to_color(COLOR_DEFAULT)),\n\tinput_transitions.create(input_states.STATE_IDLE, hash(\"on\"), input_transitions.to_flipbook(hash(\"volume_on\"))),\n\tinput_transitions.create(input_states.STATE_IDLE, hash(\"off\"), input_transitions.to_flipbook(hash(\"volume_off\"))),\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadamwestman%2Fdefine","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadamwestman%2Fdefine","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadamwestman%2Fdefine/lists"}