🤖 Merge PR DefinitelyTyped#73470 Feature/ge-react-doc by @hlesemann

Co-authored-by: Jan Hörnle <[email protected]>
Co-authored-by: Paul Kellett <[email protected]>
Co-authored-by: Antony <[email protected]>
Co-authored-by: Paul Kellett <[email protected]>

Author: 4 people

types/gorilla-engine/components/AmpEnv.d.ts

@@ -1,21 +1,65 @@
 declare namespace GorillaEngine.UI {
     interface AmpItem {
+        /**
+         * Sets the color of the respective envelope handle.
+         * This can be a named color (e.g., "red") or a hexadecimal value (e.g., "FF0000"). To specify an RGBA color set the hex alpha as a prefix (e.g., "80FF0000").
+         */
         color: string;
+        /**
+         * Sets the thickness of the respective envelope handle.
+         */
         size: number;
+        /**
+         * Sets the corner radius for the respective envelope handle.
+         */
         cornerRadius: number;
+        /**
+         * Sets the default value for the respective
+         */
         value: number;
+        /**
+         * Sets a value binding for the respective envelope handle.
+         */
         "value&": any;
+        /**
+         * Sets the visibility of the respective envelope handle.
+         * If set to `false`, the handle will not be rendered.
+         */
         visible: boolean;
+        /**
+         * Sets the path to the image used for the respective envelope handle.
+         */
         imagePath: string;
+        /**
+         * Sets the text displayed on the respective envelope handle.
+         */
         text: string;
+        /**
+         * Sets the color of the text. This can be a named color (e.g., "red") or a hexadecimal value (e.g., "FF0000"). To specify an RGBA color set the hex alpha as a prefix (e.g., "80FF0000").
+         */
         textColor: string;
     }
 
     interface AmpEnvProps extends Common, Bounds, Background, Font {
+        /**
+         * Configures the visual properties for the **attack** envelope handle.
+         */
         attack: Partial<AmpItem>;
+        /**
+         * Configures the visual properties for the **decay** envelope handle.
+         */
         decay: Partial<AmpItem>;
+        /**
+         * Configures the visual properties for the **sustain** envelope handle.
+         */
         sustain: Partial<AmpItem>;
+        /**
+         * Configures the visual properties for the **release** envelope handle.
+         */
         release: Partial<AmpItem>;
+        /**
+         * Configures the visual properties for the envelope curve.
+         */
         curve: Partial<{
             color: string;
             thickness: number;

types/gorilla-engine/components/BarStepEditor.d.ts

@@ -1,22 +1,61 @@
 declare namespace GorillaEngine.UI {
     interface BarStepEditorProps extends Common, Bounds, Background, Clickable {
-        value: any;
+        /**
+         * The spacing between the bars.
+         */
         divSize: number;
         min: number;
         max: number;
+        /**
+         * The path to the respective script in the instrument.
+         */
         paramPath: string;
+        /**
+         * Index of the first 
+         */
         startIndex: number;
         endIndex: number;
-        step: Partial<{
+        /**
+         * The dimension of the step
+         */
+       step: Partial<{
+            /**
+             * The horizontal offset of the step relative to its default position
+             */
             x: number;
+            /**
+             * The vertical offset of the step relative to its default position
+             */
             y: number;
+            /**
+             * The width of a step.
+             */
             width: number;
+            /**
+             * The height of a step.
+             */
             height: number;
+            /**
+             * The corner radius of the step.
+             */
             cornerRadius: number;
+            borderSizeX: number;
+            borderSizeY: number;
+            /**
+             * The color of the step when it is active.
+             */
+            activeColor: string;
+            
+            markDefault: boolean;
             incrementHeight: number;
             backgroundColor: string;
-            markDefault: boolean;
+            /**
+             * The color of the step when it is on.
+             */
             onColor: string;
+            /**
+             * The color of the step when it is off.
+             */
             offColor: string;
         }>;
     }
@@ -27,3 +66,4 @@ declare namespace GorillaEngine.UI {
     // tslint:disable-next-line:no-empty-interface
     interface BarStepEditor extends BarStepEditorProps {}
 }
+

types/gorilla-engine/components/ComboBox.d.ts

@@ -6,33 +6,94 @@ declare namespace GorillaEngine.UI {
         bottom: number;
     }
     interface ComboBoxPopupStyles extends Font {
+        /**
+         * The background color of the dropdown popup itself.
+         */
         backgroundColor: string;
+        /**
+         * The text color for standard, unselected items within the popup list.
+         */
         itemTextColor: string;
+        /**
+         * The text color for the **single selected item** in the popup list.
+         */
         itemSelectedTextColor: string;
+        /**
+         * The background color for the **single selected item** in the popup list.
+         */
         itemSelectedBackgroundColor: string;
+        /**
+         * The text color for items that are currently highlighted (e.g., by mouse hover or keyboard navigation)
+         * but not yet selected.
+         */
         itemHighlightedTextColor: string;
+        /**
+         * The background color for items that are currently highlighted (e.g., by mouse hover or keyboard navigation)
+         * but not yet selected.
+         */
         itemHighlightedBackgroundColor: string;
+        /**
+         * Specifies the alignment of the checkmark icon, indicating the selected item, within the popup.
+         * It can be positioned either to the `left` or `right` of the item's text.
+         */
         checkmarkFloat: "left" | "right";
+        /**
+         * The radius for the corners of the popup, providing rounded edges.
+         * A value of `0` results in sharp, square corners.
+         */
         cornerRadius: number;
-        padding: ComboBoxPadding | number;
-        checkmarkPadding: ComboBoxPadding;
+        /**
+         * Defines the padding space around the items within the popup.
+         * This can be a uniform `number` (applying to all sides) or a `ComboBoxPadding` object
+         * for more granular control over top, right, bottom, and left padding.
+         */
+        padding: ComboBoxPadding | number; // Assuming ComboBoxPadding is defined elsewhere as { top, right, bottom, left }
+        /**
+         * Defines the padding specifically for the checkmark icon relative to its containing item.
+         * This allows for fine-tuning the spacing around the checkmark.
+         */
+        checkmarkPadding: ComboBoxPadding; // Assuming ComboBoxPadding is defined elsewhere as { top, right, bottom, left }
     }
 
     interface ComboBoxProps extends Common, Bounds, Background, Clickable, Font, Highlight {
+
+        /**
+         * The value of the combobox, which corresponds to the index of the initially selected item in the `items` array.
+         */
         value: number;
         /**
          * List of options
          */
         items: string[];
         /**
-         * The character that signifies heirarchy within the items array
+         * The character that signifies heirarchy within the items array, will open a submenu at the position of the character.
          */
         levelSeperator: string;
+        /**
+         * If `true`, the text within the combobox will stretch to fit the available width.
+         */
         stretchText: boolean;
+        /**
+         * If `true`, the combobox will allow scrolling through items using the mouse wheel.
+         */
         scrollWheelEnabled: boolean;
+        /**
+         * If true, the combobox will apply a specific style to submenus, which may include different background colors, fonts, or other visual elements.
+         */
         styleSubmenu: boolean;
+
+        /**
+         * The background color of the combobox trigger in its clicked state (i.e., with its popup open).
+         */
         backgroundColorClicked: string;
+        /**
+         * The background color of the combobox trigger on mouse hover.
+         */
         backgroundColorHover: string;
+
+        /** TODO:: THIS has to be a callback function rather than a string for a view model
+         * The action to perform when the selected item is selected again from the combobox.
+         */
         itemReselectedAction: string;
         padding: Partial<ComboBoxPadding> | number;
         images: Partial<{

types/gorilla-engine/components/Curve.d.ts

@@ -1,20 +1,72 @@
 declare namespace GorillaEngine.UI {
+    /**
+     * TODO:: Is this control even exposed to the user? Or is it part of AmpEnv
+     */
     interface CurveProps extends Common, Bounds, Background, Font, Clickable {
+        /**
+         * The value of the curve.
+         */
         value: any;
+        /**
+         * The path to the parameter that the curve is bound to.
+         */
         paramPath: string;
+        /**
+         * The color of the curve.
+         */
         color: string;
+        /**
+         * The thickness of the curve.
+         */
         thickness: number;
+        /**
+         * The handle configuration.
+         */
         handle: Partial<{
+            /**
+             * The value of the handle.
+             */
+            value: any;
+            /**
+             * The color of the handle.
+             */
             color: string;
+            /**
+             * The corner radius of the handle.
+             */
             cornerRadius: number;
+            /**
+             * The width of the handle.
+             */
             width: number;
+            /**
+             * The height of the handle.
+             */
             height: number;
+            /**
+             * Whether the handle is visible.
+             */
             visible: boolean;
         }>;
+        /**
+         * The marking configuration.
+         */
         marking: Partial<{
+            /**
+             * The color of the marking.
+             */
             color: string;
+            /**
+             * The text color of the marking.
+             */
             textColor: string;
+            /**
+             * The thickness of the marking.
+             */
             thickness: number;
+            /**
+             * Whether the marking is visible.
+             */
             visible: boolean;
         }>;
     }

types/gorilla-engine/components/Knob.d.ts

@@ -1,15 +1,48 @@
 declare namespace GorillaEngine.UI {
+
     interface KnobProps extends Common, Bounds, Clickable, Background, Skinnable, MIDILearn, Highlight {
+        /**
+         * The text displayed for component
+         */
         text: string;
+        /**
+         * The minimum value of the knob.
+         */
         min: number;
+        /**
+         * The maximum value of the knob.
+         */
         max: number;
+        /**
+         * The initial value of the knob, which should be between `min` and `max`.
+         */
         value: number;
+        /**
+         * The step size for the knob, which determines how much the value changes with each interaction.
+         */
         stepSize: number;
+
+
         inverted: boolean;
+        /**
+         * If `true`, the knob's value can be adjusted using the mouse scroll wheel.
+         */
         scrollWheelEnabled: boolean;
+        /**
+         * The path to a single image used for the knob's appearance.
+         */
         image: string;
+        /**TODO:: this is rather a slider prop than a knob prop
+         * 
+         */
         snapsToMousePosition: boolean;
+        /**
+         * Sets the minimum rotation angle for the knob image in degrees. Only relevant if `image` is set.
+         */
         minRotation: number;
+        /**
+         * Sets the maximum rotation angle for the knob image in degrees. Only relevant if `image` is set.
+         */
         maxRotation: number;
     }
 

types/gorilla-engine/components/Label.d.ts

@@ -1,6 +1,12 @@
 declare namespace GorillaEngine.UI {
     interface LabelProps extends Common, Bounds, Background, Font, Clickable, Margin, Keyable {
+        /**
+         * The initial text to display in the label. Doesn't update at runtime.
+         */
         value: any;
+        /**
+         * The text to display in the label. Updates at runtime.
+         */
         text: string | number;
         format: string;
         multiLine: boolean;