From 08838105923255e66ef0d58115fc9ce671d202ae Mon Sep 17 00:00:00 2001
From: AUTOMATIC1111 <16777216c@gmail.com>
Date: Thu, 10 Aug 2023 13:02:50 +0300
Subject: comment for InputAccordion

---
 modules/ui_components.py | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

(limited to 'modules/ui_components.py')

diff --git a/modules/ui_components.py b/modules/ui_components.py
index 598ce738..9df9ddf4 100644
--- a/modules/ui_components.py
+++ b/modules/ui_components.py
@@ -74,6 +74,11 @@ class DropdownEditable(FormComponent, gr.Dropdown):
 
 
 class InputAccordion(gr.Checkbox):
+    """A gr.Accordion that can be used as an input - returns True if open, False if closed.
+
+    Actaully just a hidden checkbox, but creates an accordion that follows and is followed by the state of the checkbox.
+    """
+
     global_index = 0
 
     def __init__(self, value, **kwargs):
@@ -91,6 +96,19 @@ class InputAccordion(gr.Checkbox):
         self.accordion = gr.Accordion(kwargs.get('label', 'Accordion'), open=value, elem_id=self.accordion_id, elem_classes=['input-accordion'])
 
     def extra(self):
+        """Allows you to put something into the label of the accordion.
+
+        Use it like this:
+
+        ```
+        with InputAccordion(False, label="Accordion") as acc:
+            with acc.extra():
+                FormHTML(value="hello", min_width=0)
+
+            ...
+        ```
+        """
+
         return gr.Column(elem_id=self.accordion_id + '-extra', elem_classes='input-accordion-extra', min_width=0)
 
     def __enter__(self):
-- 
cgit v1.2.3