Giter Club home page Giter Club logo

godot-collapsible-container's Introduction

drawing CollapsibleContainer

OpeningClosing in Game gif

A Godot plugin node capable of expanding and collapsing.

A custom node for the Godot Game Engine that can help with many of your expanding/collapsing UI needs. It was initially made to mimic an accordion UI element.

OpeningClosing in Editor gif

Table of contents

Node Information

  • The node's folding and unfolding can be previewed directly in the editor.
  • Any Control nodes childed to the node will be hidden when it folds and be revealed when it unfolds. This is optional.
  • The size it expands to or collapses to can be changed to whatever you need. Optionally, it's 'open size' can be set to match a Control node's size; this Control node is generally set to the child node so that the CollapsibleContainer can open exactly to the size of the child to reveal it fully.
  • The node can expand or collapse instantly, or be tweened towards the open/close size values. You can use any tween transition type and ease type of your choice.
  • The direction (e.g., top-left, bottom-right, etc.) the node opens/closes towards can be changed.
  • The dimension (i.e., width, height, or both) the node opens/closes can be changed.
  • This node has comprehensive documentation. Just like with built-in nodes, you can utilize the documentation from within the Godot editor to quickly find and understand relevant functions.

Basic Tutorial Video

Tutorial video going over the basics of the CollapsibleContainer node: https://youtu.be/o2qTSv0QmKA

Installation

You can install the plugin from within Godot's AssetLib tab! Remember to enable it in Project Settings!

Official Godot guide to installing plugins: https://docs.godotengine.org/en/stable/tutorials/plugins/editor/installing_plugins.html

Video guide to install a release from GitHub: https://youtu.be/JRsGAgpPV8U

Written Step-By-Step Guide to Install a Release from GitHub

  1. In the releases section, find the release which corresponds with your Godot version. If a Godot version is not listed, this plugin likely does not work in that Godot version.
  2. Download the .zip file from the release which corresponds with your Godot version.
  3. Open your Godot project.
  4. Create an "addons" folder if it does not already exist in your project's "res://" folder.
  5. Unzip downloaded zip file into that addons folder.
  6. Enable the plugin: Projects -> Project Settings -> Plugins -> Click enable on the CollapsibleContainer plugin.
  7. Done! You can now add the CollapsibleContainer node into your scene tree.

Contribute

Bug/Feedback: Submit an issue using the issues tab after ensuring that it won't be a duplicate.

Pull requests:

  • The main tool script (and even the example projects) are all documented. This includes every function. For complicated functions, this may even include every line in that function. Hopefully this makes it easier to understand and contribute to the project.
  • Submitting a pull request: you should file an issue first that your PR will resolve (if such an issue doesn't already exist). Then, reference what issue(s) your PR resolves in the PR. Your code must be documented.

Donate

Buy Me a Coffee at ko-fi.com

godot-collapsible-container's People

Contributors

arshvirgoraya avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

searetseltev

godot-collapsible-container's Issues

problem with exporting

Hi, thanks for the nice plugin. Works as I need in the editor. Ran in to a problem with exporting to android: I get the error: "parser error: Could not find type "EditorPlugin" in the current scope. Which points to line 403 in collapsible_container.gd.

Tried it in Godot 4.1, 4.1.1 and 4.2 on a mac and version 4.2 on windows with same result. Tried a few things to fix it but am not much of a programmer :-(
Can you point me in a direction to fix this?
Thanks in advance.
Paul

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.