collapsible wrapper added to README and examples

ynput · Dec 1, 2020 · 6b73060 · 6b73060
1 parent 04d3a0e
commit 6b73060
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 5 deletions.
diff --git a/pype/tools/settings/settings/README.md b/pype/tools/settings/settings/README.md
@@ -436,11 +436,9 @@
 ## Proxy wrappers
 - should wraps multiple inputs only visually
 - these does not have `"key"` key and do not allow to have `"is_file"` or `"is_group"` modifiers enabled
+- can't be used as widget (first item in e.g. `list`, `dict-modifiable`, etc.)
 
 ### form
-- DEPRECATED
- - may be used only in `dict` and `dict-invisible` where is currently used grid layout so form is not needed
- - item is kept as still may be used in specific cases
 - wraps inputs into form look layout
 - should be used only for Pure inputs
 
@@ -462,3 +460,24 @@
  ]
 }
 ```
+
+
+### collapsible-wrap
+- wraps inputs into collapsible widget
+ - looks like `dict` but does not hold `"key"`
+- should be used only for Pure inputs
+
+```
+{
+ "type": "collapsible-wrap",
+ "label": "Collapsible example"
+ "children": [
+ {
+ "type": "text",
+ "key": "_example_input_collapsible",
+ "label": "Example input in collapsible wrapper"
+ }, {
+ ...
+ }
+ ]
+}
diff --git a/pype/tools/settings/settings/gui_schemas/system_schema/example_schema.json b/pype/tools/settings/settings/gui_schemas/system_schema/example_schema.json
@@ -418,6 +418,16 @@
  ]
  }
  ]
+ }, {
+ "type": "collapsible-wrap",
+ "label": "Collapsible Wrapper without key",
+ "children": [
+ {
+ "type": "text",
+ "key": "_example_input_collapsible",
+ "label": "Example input in collapsible wrapper"
+ }
+ ]
  }
  ]
  }

diff --git a/pype/tools/settings/settings/widgets/item_types.py b/pype/tools/settings/settings/widgets/item_types.py
@@ -3768,7 +3768,7 @@ def add_children_gui(self, child_configuration):
  return item
 
 
-class CollapsableWrapperItem(WrapperItemWidget):
+class CollapsibleWrapperItem(WrapperItemWidget):
  def wrapper_initial_attributes(self, schema_data):
  self.collapsable = schema_data.get("collapsable", True)
  self.collapsed = schema_data.get("collapsed", True)
@@ -3955,7 +3955,7 @@ def __init__(self, configuration, parent):
 
 # Wrappers
 TypeToKlass.types["form"] = FormItemWidget
-TypeToKlass.types["collapsable-wrap"] = CollapsableWrapperItem
+TypeToKlass.types["collapsible-wrap"] = CollapsibleWrapperItem
 
 # UI items
 TypeToKlass.types["label"] = LabelWidget