cluaupp 1.3.0 → 1.4.0

package/templates/game/libs/Iris/API.lua

@@ -1,2085 +0,0 @@
-local Types = require(script.Parent.Types)
-
-return function(Iris: Types.Iris)
-    -- basic wrapper for nearly every widget, saves space.
-    local function wrapper(name)
-        return function(arguments, states)
-            return Iris.Internal._Insert(name, arguments, states)
-        end
-    end
-
-    --[[
-        ----------------------------
-            [SECTION] Window API
-        ----------------------------
-    ]]
-    --[=[
-        @class Window
-        
-        Windows are the fundamental widget for Iris. Every other widget must be a descendant of a window.
-
-        ```lua
-        Iris.Window({ "Example Window" })
-            Iris.Text({ "This is an example window!" })
-        Iris.End()
-        ```
-
-        ![Example window](/Iris/assets/api/window/basicWindow.png)
-
-        If you do not want the code inside a window to run unless it is open then you can use the following:
-        ```lua
-        local window = Iris.Window({ "Many Widgets Window" })
-
-        if window.state.isOpened.value and window.state.isUncollapsed.value then
-            Iris.Text({ "I will only be created when the window is open." })
-        end
-        Iris.End() -- must always call Iris.End(), regardless of whether the window is open or not.
-        ```
-    ]=]
-
-    --[=[
-        @within Window
-        @prop Window Iris.Window
-        @tag Widget
-        @tag HasChildren
-        @tag HasState
-        
-        The top-level container for all other widgets to be created within.
-        Can be moved and resized across the screen. Cannot contain embedded windows.
-        Menus can be appended to windows creating a menubar.
-        
-        ```lua
-        hasChildren = true
-        hasState = true
-        Arguments = {
-            Title: string,
-            NoTitleBar: boolean? = false,
-            NoBackground: boolean? = false, -- the background behind the widget container.
-            NoCollapse: boolean? = false,
-            NoClose: boolean? = false,
-            NoMove: boolean? = false,
-            NoScrollbar: boolean? = false, -- the scrollbar if the window is too short for all widgets.
-            NoResize: boolean? = false,
-            NoNav: boolean? = false, -- unimplemented.
-            NoMenu: boolean? = false -- whether the menubar will show if created.
-        }
-        Events = {
-            opened: () -> boolean, -- once when opened.
-            closed: () -> boolean, -- once when closed.
-            collapsed: () -> boolean, -- once when collapsed.
-            uncollapsed: () -> boolean, -- once when uncollapsed.
-            hovered: () -> boolean -- fires when the mouse hovers over any of the window.
-        }
-        States = {
-            size: State<Vector2>? = Vector2.new(400, 300),
-            position: State<Vector2>?,
-            isUncollapsed: State<boolean>? = true,
-            isOpened: State<boolean>? = true,
-            scrollDistance: State<number>? -- vertical scroll distance, if too short.
-        }
-        ```
-    ]=]
-    Iris.Window = wrapper("Window")
-
-    --[=[
-        @within Iris
-        @function SetFocusedWindow
-        @param window Types.Window -- the window to focus.
-
-        Sets the focused window to the window provided, which brings it to the front and makes it active.
-    ]=]
-    Iris.SetFocusedWindow = Iris.Internal.SetFocusedWindow
-
-    --[=[
-        @within Window
-        @prop Tooltip Iris.Tooltip
-        @tag Widget
-
-        Displays a text label next to the cursor
-
-        ```lua
-        Iris.Tooltip({"My custom tooltip"})
-        ```
-
-        ![Basic tooltip example](/Iris/assets/api/window/basicTooltip.png)
-        
-        ```lua
-        hasChildren = false
-        hasState = false
-        Arguments = {
-            Text: string
-        }
-        ```
-    ]=]
-    Iris.Tooltip = wrapper("Tooltip")
-
-    --[[
-        ---------------------------------
-            [SECTION] Menu Widget API
-        ---------------------------------
-    ]]
-    --[=[
-        @class Menu
-        Menu API
-    ]=]
-
-    --[=[
-        @within Menu
-        @prop MenuBar Iris.MenuBar
-        @tag Widget
-        @tag HasChildren
-        
-        Creates a MenuBar for the current window. Must be called directly under a Window and not within a child widget.
-        :::info
-            This does not create any menus, just tells the window that we going to add menus within.
-        :::
-        
-        ```lua
-        hasChildren = true
-        hasState = false
-        ```
-    ]=]
-    Iris.MenuBar = wrapper("MenuBar")
-
-    --[=[
-        @within Menu
-        @prop Menu Iris.Menu
-        @tag Widget
-        @tag HasChildren
-        @tag HasState
-        
-        Creates an collapsable menu. If the Menu is created directly under a MenuBar, then the widget will
-        be placed horizontally below the window title. If the menu Menu is created within another menu, then
-        it will be placed vertically alongside MenuItems and display an arrow alongside.
-
-        The opened menu will be a vertically listed box below or next to the button.
-
-        ```lua
-            Iris.Window({"Menu Demo"})
-                Iris.MenuBar()
-                    Iris.Menu({"Test Menu"})
-                        Iris.Button({"Menu Option 1"})
-                        Iris.Button({"Menu Option 2"})
-                    Iris.End()
-                Iris.End()
-            Iris.End()
-        ```
-
-        ![Example menu](/Iris/assets/api/menu/basicMenu.gif)
-
-        :::info
-        There are widgets which are designed for being parented to a menu whilst other happens to work. There is nothing
-        preventing you from adding any widget as a child, but the behaviour is unexplained and not intended.
-        :::
-        
-        ```lua
-        hasChildren = true
-        hasState = true
-        Arguments = {
-            Text: string -- menu text.
-        }
-        Events = {
-            clicked: () -> boolean,
-            opened: () -> boolean, -- once when opened.
-            closed: () -> boolean, -- once when closed.
-            hovered: () -> boolean
-        }
-        States = {
-            isOpened: State<boolean>? -- whether the menu is open, including any sub-menus within.
-        }
-        ```
-    ]=]
-    Iris.Menu = wrapper("Menu")
-
-    --[=[
-        @within Menu
-        @prop MenuItem Iris.MenuItem
-        @tag Widget
-        
-        Creates a button within a menu. The optional KeyCode and ModiferKey arguments will show the keys next
-        to the title, but **will not** bind any connection to them. You will need to do this yourself.
-
-        ```lua
-        Iris.Window({"MenuToggle Demo"})
-            Iris.MenuBar()
-                Iris.MenuToggle({"Menu Item"})
-            Iris.End()
-        Iris.End()
-        ```
-
-        ![Example Menu Item](/Iris/assets/api/menu/basicMenuItem.gif)
-
-        ```lua
-        hasChildren = false
-        hasState = false
-        Arguments = {
-            Text: string,
-            KeyCode: Enum.KeyCode? = nil, -- an optional keycode, does not actually connect an event.
-            ModifierKey: Enum.ModifierKey? = nil -- an optional modifer key for the key code.
-        }
-        Events = {
-            clicked: () -> boolean,
-            hovered: () -> boolean
-        }
-        ```
-    ]=]
-    Iris.MenuItem = wrapper("MenuItem")
-
-    --[=[
-        @within Menu
-        @prop MenuToggle Iris.MenuToggle
-        @tag Widget
-        @tag HasState
-        
-        Creates a togglable button within a menu. The optional KeyCode and ModiferKey arguments act the same
-        as the MenuItem. It is not visually the same as a checkbox, but has the same functionality.
-        
-        ```lua
-        Iris.Window({"MenuToggle Demo"})
-            Iris.MenuBar()
-                Iris.MenuToggle({"Menu Toggle"})
-            Iris.End()
-        Iris.End()
-        ```
-
-        ![Example Menu Toggle](/Iris/assets/api/menu/basicMenuToggle.gif)
-
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string,
-            KeyCode: Enum.KeyCode? = nil, -- an optional keycode, does not actually connect an event.
-            ModifierKey: Enum.ModifierKey? = nil -- an optional modifer key for the key code.
-        }
-        Events = {
-            checked: () -> boolean, -- once on check.
-            unchecked: () -> boolean, -- once on uncheck.
-            hovered: () -> boolean
-        }
-        States = {
-            isChecked: State<boolean>?
-        }
-        ```
-    ]=]
-    Iris.MenuToggle = wrapper("MenuToggle")
-
-    --[[
-        -----------------------------------
-            [SECTION] Format Widget Iris
-        -----------------------------------
-    ]]
-    --[=[
-        @class Format
-        Format API
-    ]=]
-
-    --[=[
-        @within Format
-        @prop Separator Iris.Separator
-        @tag Widget
-
-        A vertical or horizonal line, depending on the context, which visually seperates widgets.
-        
-        ```lua
-        Iris.Window({"Separator Demo"})
-            Iris.Text({"Some text here!"})
-            Iris.Separator()
-            Iris.Text({"This text has been separated!"})
-        Iris.End()
-        ```
-
-        ![Example Separator](/Iris/assets/api/format/basicSeparator.png)
-
-        ```lua
-        hasChildren = false
-        hasState = false
-        ```
-    ]=]
-    Iris.Separator = wrapper("Separator")
-
-    --[=[
-        @within Format
-        @prop Indent Iris.Indent
-        @tag Widget
-        @tag HasChildren
-        
-        Indents its child widgets.
-
-        ```lua
-        Iris.Window({"Indent Demo"})
-            Iris.Text({"Unindented text!"})
-            Iris.Indent()
-                Iris.Text({"This text has been indented!"})
-            Iris.End()
-        Iris.End()
-        ```
-
-        ![Example Indent](/Iris/assets/api/format/basicIndent.png)
-
-        ```lua
-        hasChildren = true
-        hasState = false
-        Arguments = {
-            Width: number? = Iris._config.IndentSpacing -- indent width ammount.
-        }
-        ```
-    ]=]
-    Iris.Indent = wrapper("Indent")
-
-    --[=[
-        @within Format
-        @prop SameLine Iris.SameLine
-        @tag Widget
-        @tag HasChildren
-        
-        Positions its children in a row, horizontally.
-
-        ```lua
-        Iris.Window({"Same Line Demo"})
-            Iris.Text({"All of these buttons are on the same line!"})
-            Iris.SameLine()
-                Iris.Button({"Button 1"})
-                Iris.Button({"Button 2"})
-                Iris.Button({"Button 3"})
-            Iris.End()
-        Iris.End()
-        ```
-
-        ![Example SameLine](/Iris/assets/api/format/basicSameLine.png)
-        
-        ```lua
-        hasChildren = true
-        hasState = false
-        Arguments = {
-            Width: number? = Iris._config.ItemSpacing.X, -- horizontal spacing between child widgets.
-            VerticalAlignment: Enum.VerticalAlignment? = Enum.VerticalAlignment.Center -- how widgets vertically to each other.
-            HorizontalAlignment: Enum.HorizontalAlignment? = Enum.HorizontalAlignment.Center -- how widgets are horizontally.
-        }
-        ```
-    ]=]
-    Iris.SameLine = wrapper("SameLine")
-
-    --[=[
-        @within Format
-        @prop Group Iris.Group
-        @tag Widget
-        @tag HasChildren
-        
-        Layout widget which contains its children as a single group.
-        
-        ```lua
-        hasChildren = true
-        hasState = false
-        ```
-    ]=]
-    Iris.Group = wrapper("Group")
-
-    --[[
-        ---------------------------------
-            [SECTION] Text Widget API
-        ---------------------------------
-    ]]
-    --[=[
-        @class Text
-        Text Widget API
-    ]=]
-
-    --[=[
-        @within Text
-        @prop Text Iris.Text
-        @tag Widget
-        
-        A text label to display the text argument.
-        The Wrapped argument will make the text wrap around if it is cut off by its parent.
-        The Color argument will change the color of the text, by default it is defined in the configuration file.
-
-        ```lua
-        Iris.Window({"Text Demo"})
-            Iris.Text({"This is regular text"})
-        Iris.End()
-        ```
-
-        ![Example Text](/Iris/assets/api/text/basicText.png)
-
-        ```lua
-        hasChildren = false
-        hasState = false
-        Arguments = {
-            Text: string,
-            Wrapped: boolean? = [CONFIG] = false, -- whether the text will wrap around inside the parent container. If not specified, then equal to the config
-            Color: Color3? = Iris._config.TextColor, -- the colour of the text.
-            RichText: boolean? = [CONFIG] = false -- enable RichText. If not specified, then equal to the config
-        }
-        Events = {
-            hovered: () -> boolean
-        }
-        ```
-    ]=]
-    Iris.Text = wrapper("Text")
-
-    --[=[
-        @within Text
-        @prop TextWrapped Iris.Text
-        @tag Widget
-        @deprecated v2.0.0 -- Use 'Text' with the Wrapped argument or change the config.
-
-        An alias for [Iris.Text](Text#Text) with the Wrapped argument set to true, and the text will wrap around if cut off by its parent.
-
-        ```lua
-        hasChildren = false
-        hasState = false
-        Arguments = {
-            Text: string,
-        }
-        Events = {
-            hovered: () -> boolean
-        }
-        ```
-    ]=]
-    Iris.TextWrapped = function(arguments: Types.WidgetArguments)
-        arguments[2] = true
-        return Iris.Internal._Insert("Text", arguments)
-    end
-
-    --[=[
-        @within Text
-        @prop TextColored Iris.Text
-        @tag Widget
-        @deprecated v2.0.0 -- Use 'Text' with the Color argument or change the config.
-        
-        An alias for [Iris.Text](Text#Text) with the color set by the Color argument.
-
-        ```lua
-        hasChildren = false
-        hasState = false
-        Arguments = {
-            Text: string,
-            Color: Color3 -- the colour of the text.
-        }
-        Events = {
-            hovered: () -> boolean
-        }
-        ```
-    ]=]
-    Iris.TextColored = function(arguments: Types.WidgetArguments)
-        arguments[3] = arguments[2]
-        arguments[2] = nil
-        return Iris.Internal._Insert("Text", arguments)
-    end
-
-    --[=[
-        @within Text
-        @prop SeparatorText Iris.SeparatorText
-        @tag Widget
-        
-        Similar to [Iris.Separator](Format#Separator) but with a text label to be used as a header
-        when an [Iris.Tree](Tree#Tree) or [Iris.CollapsingHeader](Tree#CollapsingHeader) is not appropriate.
-
-        Visually a full width thin line with a text label clipping out part of the line.
-
-        ```lua
-        Iris.Window({"Separator Text Demo"})
-            Iris.Text({"Regular Text"})
-            Iris.SeparatorText({"This is a separator with text"})
-            Iris.Text({"More Regular Text"})
-        Iris.End()
-        ```
-
-        ![Example Separator Text](/Iris/assets/api/text/basicSeparatorText.png)
-        
-        ```lua
-        hasChildren = false
-        hasState = false
-        Arguments = {
-            Text: string
-        }
-        ```
-    ]=]
-    Iris.SeparatorText = wrapper("SeparatorText")
-
-    --[=[
-        @within Text
-        @prop InputText Iris.InputText
-        @tag Widget
-        @tag HasState
-
-        A field which allows the user to enter text.
-
-        ```lua
-        Iris.Window({"Input Text Demo"})
-            local inputtedText = Iris.State("")
-
-            Iris.InputText({"Enter text here:"}, {text = inputtedText})
-            Iris.Text({"You entered: " .. inputtedText:get()})
-        Iris.End()
-        ```
-
-        ![Example Input Text](/Iris/assets/api/text/basicInputText.gif)
-
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string? = "InputText",
-            TextHint: string? = "", -- a hint to display when the text box is empty.
-            ReadOnly: boolean? = false,
-            MultiLine: boolean? = false
-        }
-        Events = {
-            textChanged: () -> boolean, -- whenever the textbox looses focus and a change was made.
-            hovered: () -> boolean
-        }
-        States = {
-            text: State<string>?
-        }
-        ```
-    ]=]
-    Iris.InputText = wrapper("InputText")
-
-    --[[
-        ----------------------------------
-            [SECTION] Basic Widget API
-        ----------------------------------
-    ]]
-    --[=[
-        @class Basic
-        Basic Widget API
-    ]=]
-
-    --[=[
-        @within Basic
-        @prop Button Iris.Button
-        @tag Widget
-        
-        A clickable button the size of the text with padding. Can listen to the `clicked()` event to determine if it was pressed.
-
-        ```lua
-        hasChildren = false
-        hasState = false
-        Arguments = {
-            Text: string,
-            Size: UDim2? = UDim2.fromOffset(0, 0),
-        }
-        Events = {
-            clicked: () -> boolean,
-            rightClicked: () -> boolean,
-            doubleClicked: () -> boolean,
-            ctrlClicked: () -> boolean, -- when the control key is down and clicked.
-            hovered: () -> boolean
-        }
-        ```
-    ]=]
-    Iris.Button = wrapper("Button")
-
-    --[=[
-        @within Basic
-        @prop SmallButton Iris.SmallButton
-        @tag Widget
-        
-        A smaller clickable button, the same as a [Iris.Button](Basic#Button) but without padding. Can listen to the `clicked()` event to determine if it was pressed.
-
-        ```lua
-        hasChildren = false
-        hasState = false
-        Arguments = {
-            Text: string,
-            Size: UDim2? = 0,
-        }
-        Events = {
-            clicked: () -> boolean,
-            rightClicked: () -> boolean,
-            doubleClicked: () -> boolean,
-            ctrlClicked: () -> boolean, -- when the control key is down and clicked.
-            hovered: () -> boolean
-        }
-        ```
-    ]=]
-    Iris.SmallButton = wrapper("SmallButton")
-
-    --[=[
-        @within Basic
-        @prop Checkbox Iris.Checkbox
-        @tag Widget
-        @tag HasState
-        
-        A checkable box with a visual tick to represent a boolean true or false state.
-
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string
-        }
-        Events = {
-            checked: () -> boolean, -- once when checked.
-            unchecked: () -> boolean, -- once when unchecked.
-            hovered: () -> boolean
-        }
-        States = {
-            isChecked = State<boolean>? -- whether the box is checked.
-        }
-        ```
-    ]=]
-    Iris.Checkbox = wrapper("Checkbox")
-
-    --[=[
-        @within Basic
-        @prop RadioButton Iris.RadioButton
-        @tag Widget
-        @tag HasState
-        
-        A circular selectable button, changing the state to its index argument. Used in conjunction with multiple other RadioButtons sharing the same state to represent one value from multiple options.
-        
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string,
-            Index: any -- the state object is set to when clicked.
-        }
-        Events = {
-            selected: () -> boolean,
-            unselected: () -> boolean,
-            active: () -> boolean, -- if the state index equals the RadioButton's index.
-            hovered: () -> boolean
-        }
-        States = {
-            index = State<any>? -- the state set by the index of a RadioButton.
-        }
-        ```
-    ]=]
-    Iris.RadioButton = wrapper("RadioButton")
-
-    --[[
-        ----------------------------------
-            [SECTION] Image Widget API
-        ----------------------------------
-    ]]
-    --[=[
-        @class Image
-        Image Widget API
-
-        Provides two widgets for Images and ImageButtons, which provide the same control as a an ImageLabel instance.
-    ]=]
-
-    --[=[
-        @within Image
-        @prop Image Iris.Image
-        @tag Widget
-
-        An image widget for displaying an image given its texture ID and a size. The widget also supports Rect Offset and Size allowing cropping of the image and the rest of the ScaleType properties.
-        Some of the arguments are only used depending on the ScaleType property, such as TileSize or Slice which will be ignored.
-
-        ```lua
-        hasChildren = false
-        hasState = false
-        Arguments = {
-            Image: string, -- the texture asset id
-            Size: UDim2,
-            Rect: Rect? = Rect.new(), -- Rect structure which is used to determine the offset or size. An empty, zeroed rect is equivalent to nil
-            ScaleType: Enum.ScaleType? = Enum.ScaleType.Stretch, -- used to determine whether the TileSize, SliceCenter and SliceScale arguments are used
-            ResampleMode: Enum.ResampleMode? = Enum.ResampleMode.Default,
-            TileSize: UDim2? = UDim2.fromScale(1, 1), -- only used if the ScaleType is set to Tile
-            SliceCenter: Rect? = Rect.new(), -- only used if the ScaleType is set to Slice
-            SliceScale: number? = 1 -- only used if the ScaleType is set to Slice
-        }
-        Events = {
-            hovered: () -> boolean
-        }
-        ```
-    ]=]
-    Iris.Image = wrapper("Image")
-
-    --[=[
-        @within Image
-        @prop ImageButton Iris.ImageButton
-        @tag Widget
-
-        An image button widget for a button as an image given its texture ID and a size. The widget also supports Rect Offset and Size allowing cropping of the image, and the rest of the ScaleType properties.
-        Supports all of the events of a regular button.
-
-        ```lua
-        hasChildren = false
-        hasState = false
-        Arguments = {
-            Image: string, -- the texture asset id
-            Size: UDim2,
-            Rect: Rect? = Rect.new(), -- Rect structure which is used to determine the offset or size. An empty, zeroed rect is equivalent to nil
-            ScaleType: Enum.ScaleType? = Enum.ScaleType.Stretch, -- used to determine whether the TileSize, SliceCenter and SliceScale arguments are used
-            ResampleMode: Enum.ResampleMode? = Enum.ResampleMode.Default,
-            TileSize: UDim2? = UDim2.fromScale(1, 1), -- only used if the ScaleType is set to Tile
-            SliceCenter: Rect? = Rect.new(), -- only used if the ScaleType is set to Slice
-            SliceScale: number? = 1 -- only used if the ScaleType is set to Slice
-        }
-        Events = {
-            clicked: () -> boolean,
-            rightClicked: () -> boolean,
-            doubleClicked: () -> boolean,
-            ctrlClicked: () -> boolean, -- when the control key is down and clicked.
-            hovered: () -> boolean
-        }
-        ```
-    ]=]
-    Iris.ImageButton = wrapper("ImageButton")
-
-    --[[
-        ---------------------------------
-            [SECTION] Tree Widget API
-        ---------------------------------
-    ]]
-    --[=[
-        @class Tree
-        Tree Widget API
-    ]=]
-
-    --[=[
-        @within Tree
-        @prop Tree Iris.Tree
-        @tag Widget
-        @tag HasChildren
-        @tag HasState
-        
-        A collapsable container for other widgets, to organise and hide widgets when not needed. The state determines whether the child widgets are visible or not. Clicking on the widget will collapse or uncollapse it.
-        
-        ```lua
-        hasChildren: true
-        hasState: true
-        Arguments = {
-            Text: string,
-            SpanAvailWidth: boolean? = false, -- the tree title will fill all horizontal space to the end its parent container.
-            NoIndent: boolean? = false, -- the child widgets will not be indented underneath.
-            DefaultOpen: boolean? = false -- initially opens the tree if no state is provided
-        }
-        Events = {
-            collapsed: () -> boolean,
-            uncollapsed: () -> boolean,
-            hovered: () -> boolean
-        }
-        States = {
-            isUncollapsed: State<boolean>? -- whether the widget is collapsed.
-        }
-        ```
-    ]=]
-    Iris.Tree = wrapper("Tree")
-
-    --[=[
-        @within Tree
-        @prop CollapsingHeader Iris.CollapsingHeader
-        @tag Widget
-        @tag HasChildren
-        @tag HasState
-        
-        The same as a Tree Widget, but with a larger title and clearer, used mainly for organsing widgets on the first level of a window.
-        
-        ```lua
-        hasChildren: true
-        hasState: true
-        Arguments = {
-            Text: string,
-            DefaultOpen: boolean? = false -- initially opens the tree if no state is provided
-        }
-        Events = {
-            collapsed: () -> boolean,
-            uncollapsed: () -> boolean,
-            hovered: () -> boolean
-        }
-        States = {
-            isUncollapsed: State<boolean>? -- whether the widget is collapsed.
-        }
-        ```
-    ]=]
-    Iris.CollapsingHeader = wrapper("CollapsingHeader")
-
-    --[[
-        --------------------------------
-            [SECTION] Tab Widget API
-        --------------------------------
-    ]]
-    --[=[
-        @class Tab
-        Tab Widget API
-    ]=]
-
-    --[=[
-        @within Tab
-        @prop TabBar Iris.TabBar
-        @tag Widget
-        @tag HasChildren
-        @tag HasState
-        
-        Creates a TabBar for putting tabs under. This does not create the tabs but just the container for them to be in.
-        The index state is used to control the current tab and is based on an index starting from 1 rather than the
-        text provided to a Tab. The TabBar will replicate the index to the Tab children .
-        
-        ```lua
-        hasChildren: true
-        hasState: true
-        States = {
-            index: State<number>? -- whether the widget is collapsed.
-        }
-        ```
-    ]=]
-    Iris.TabBar = wrapper("TabBar")
-
-    --[=[
-        @within Tab
-        @prop Tab Iris.Tab
-        @tag Widget
-        @tag HasChildren
-        @tag HasState
-        
-        The tab item for use under a TabBar. The TabBar must be the parent and determines the index value. You cannot
-        provide a state for this tab. The optional Hideable argument determines if a tab can be closed, which is
-        controlled by the isOpened state.
-
-        A tab will take up the full horizontal width of the parent and hide any other tabs in the TabBar.
-        
-        ```lua
-        hasChildren: true
-        hasState: true
-        Arguments = {
-            Text: string,
-            Hideable: boolean? = nil -- determines whether a tab can be closed/hidden
-        }
-        Events = {
-            clicked: () -> boolean,
-            hovered: () -> boolean
-            selected: () -> boolean
-            unselected: () -> boolean
-            active: () -> boolean
-            opened: () -> boolean
-            closed: () -> boolean
-        }
-        States = {
-            isOpened: State<boolean>?
-        }
-        ```
-    ]=]
-    Iris.Tab = wrapper("Tab")
-
-    --[[
-        ----------------------------------
-            [SECTION] Input Widget API
-        ----------------------------------
-    ]]
-    --[=[
-        @class Input
-        Input Widget API
-
-        Input Widgets are textboxes for typing in specific number values. See [Drag], [Slider] or [InputText](Text#InputText) for more input types.
-
-        Iris provides a set of specific inputs for the datatypes:
-        Number,
-        [Vector2](https://create.roblox.com/docs/reference/engine/datatypes/Vector2),
-        [Vector3](https://create.roblox.com/docs/reference/engine/datatypes/Vector3),
-        [UDim](https://create.roblox.com/docs/reference/engine/datatypes/UDim),
-        [UDim2](https://create.roblox.com/docs/reference/engine/datatypes/UDim2),
-        [Rect](https://create.roblox.com/docs/reference/engine/datatypes/Rect),
-        [Color3](https://create.roblox.com/docs/reference/engine/datatypes/Color3)
-        and the custom [Color4](https://create.roblox.com/docs/reference/engine/datatypes/Color3).
-        
-        Each Input widget has the same arguments but the types depend of the DataType:
-        1. Text: string? = "Input{type}" -- the text to be displayed to the right of the textbox.
-        2. Increment: DataType? = nil, -- the increment argument determines how a value will be rounded once the textbox looses focus.
-        3. Min: DataType? = nil, -- the minimum value that the widget will allow, no clamping by default.
-        4. Max: DataType? = nil, -- the maximum value that the widget will allow, no clamping by default.
-        5. Format: string | { string }? = [DYNAMIC] -- uses `string.format` to customise visual display.
-
-        The format string can either by a single value which will apply to every box, or a table allowing specific text.
-
-        :::note
-        If you do not specify a format option then Iris will dynamically calculate a relevant number of sigifs and format option.
-        For example, if you have Increment, Min and Max values of 1, 0 and 100, then Iris will guess that you are only using integers
-        and will format the value as an integer.
-        As another example, if you have Increment, Min and max values of 0.005, 0, 1, then Iris will guess you are using a float of 3
-        significant figures.
-
-        Additionally, for certain DataTypes, Iris will append an prefix to each box if no format option is provided.
-        For example, a Vector3 box will have the append values of "X: ", "Y: " and "Z: " to the relevant input box.
-        :::
-    ]=]
-
-    --[=[
-        @within Input
-        @prop InputNum Iris.InputNum
-        @tag Widget
-        @tag HasState
-        
-        An input box for numbers. The number can be either an integer or a float.
-        
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string? = "InputNum",
-            Increment: number? = nil,
-            Min: number? = nil,
-            Max: number? = nil,
-            Format: string? | { string }? = [DYNAMIC], -- Iris will dynamically generate an approriate format.
-            NoButtons: boolean? = false -- whether to display + and - buttons next to the input box.
-        }
-        Events = {
-            numberChanged: () -> boolean,
-            hovered: () -> boolean
-        }
-        States = {
-            number: State<number>?,
-            editingText: State<boolean>?
-        }
-        ```
-    ]=]
-    Iris.InputNum = wrapper("InputNum")
-
-    --[=[
-        @within Input
-        @prop InputVector2 Iris.InputVector2
-        @tag Widget
-        @tag HasState
-        
-        An input box for Vector2. The numbers can be either integers or floats.
-        
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string? = "InputVector2",
-            Increment: Vector2? = nil,
-            Min: Vector2? = nil,
-            Max: Vector2? = nil,
-            Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.
-        }
-        Events = {
-            numberChanged: () -> boolean,
-            hovered: () -> boolean
-        }
-        States = {
-            number: State<Vector2>?,
-            editingText: State<boolean>?
-        }
-        ```
-    ]=]
-    Iris.InputVector2 = wrapper("InputVector2")
-
-    --[=[
-        @within Input
-        @prop InputVector3 Iris.InputVector3
-        @tag Widget
-        @tag HasState
-        
-        An input box for Vector3. The numbers can be either integers or floats.
-        
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string? = "InputVector3",
-            Increment: Vector3? = nil,
-            Min: Vector3? = nil,
-            Max: Vector3? = nil,
-            Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.
-        }
-        Events = {
-            numberChanged: () -> boolean,
-            hovered: () -> boolean
-        }
-        States = {
-            number: State<Vector3>?,
-            editingText: State<boolean>?
-        }
-        ```
-    ]=]
-    Iris.InputVector3 = wrapper("InputVector3")
-
-    --[=[
-        @within Input
-        @prop InputUDim Iris.InputUDim
-        @tag Widget
-        @tag HasState
-        
-        An input box for UDim. The Scale box will be a float and the Offset box will be
-        an integer, unless specified differently.
-        
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string? = "InputUDim",
-            Increment: UDim? = nil,
-            Min: UDim? = nil,
-            Max: UDim? = nil,
-            Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.
-        }
-        Events = {
-            numberChanged: () -> boolean,
-            hovered: () -> boolean
-        }
-        States = {
-            number: State<UDim>?,
-            editingText: State<boolean>?
-        }
-        ```
-    ]=]
-    Iris.InputUDim = wrapper("InputUDim")
-
-    --[=[
-        @within Input
-        @prop InputUDim2 Iris.InputUDim2
-        @tag Widget
-        @tag HasState
-        
-        An input box for UDim2. The Scale boxes will be floats and the Offset boxes will be
-        integers, unless specified differently.
-        
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string? = "InputUDim2",
-            Increment: UDim2? = nil,
-            Min: UDim2? = nil,
-            Max: UDim2? = nil,
-            Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.
-        }
-        Events = {
-            numberChanged: () -> boolean,
-            hovered: () -> boolean
-        }
-        States = {
-            number: State<UDim2>?,
-            editingText: State<boolean>?
-        }
-        ```
-    ]=]
-    Iris.InputUDim2 = wrapper("InputUDim2")
-
-    --[=[
-        @within Input
-        @prop InputRect Iris.InputRect
-        @tag Widget
-        @tag HasState
-        
-        An input box for Rect. The numbers will default to integers, unless specified differently.
-        
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string? = "InputRect",
-            Increment: Rect? = nil,
-            Min: Rect? = nil,
-            Max: Rect? = nil,
-            Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.
-        }
-        Events = {
-            numberChanged: () -> boolean,
-            hovered: () -> boolean
-        }
-        States = {
-            number: State<Rect>?,
-            editingText: State<boolean>?
-        }
-        ```
-    ]=]
-    Iris.InputRect = wrapper("InputRect")
-
-    --[[
-        ---------------------------------
-            [SECTION] Drag Widget API
-        ---------------------------------
-    ]]
-    --[=[
-        @class Drag
-        Drag Widget API
-
-        A draggable widget for each datatype. Allows direct typing input but also dragging values by clicking and holding.
-        
-        See [Input] for more details on the arguments.
-    ]=]
-
-    --[=[
-        @within Drag
-        @prop DragNum Iris.DragNum
-        @tag Widget
-        @tag HasState
-        
-        A field which allows the user to click and drag their cursor to enter a number.
-        You can ctrl + click to directly input a number, like InputNum.
-        You can hold Shift to increase speed, and Alt to decrease speed when dragging.
-        
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string? = "DragNum",
-            Increment: number? = nil,
-            Min: number? = nil,
-            Max: number? = nil,
-            Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.
-        }
-        Events = {
-            numberChanged: () -> boolean,
-            hovered: () -> boolean
-        }
-        States = {
-            number: State<number>?,
-            editingText: State<boolean>?
-        }
-        ```
-    ]=]
-    Iris.DragNum = wrapper("DragNum")
-
-    --[=[
-        @within Drag
-        @prop DragVector2 Iris.DragVector2
-        @tag Widget
-        @tag HasState
-        
-        A field which allows the user to click and drag their cursor to enter a Vector2.
-        You can ctrl + click to directly input a Vector2, like InputVector2.
-        You can hold Shift to increase speed, and Alt to decrease speed when dragging.
-        
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string? = "DragVector2",
-            Increment: Vector2? = nil,
-            Min: Vector2? = nil,
-            Max: Vector2? = nil,
-            Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.
-        }
-        Events = {
-            numberChanged: () -> boolean,
-            hovered: () -> boolean
-        }
-        States = {
-            number: State<Vector2>?,
-            editingText: State<boolean>?
-        }
-        ```
-    ]=]
-    Iris.DragVector2 = wrapper("DragVector2")
-
-    --[=[
-        @within Drag
-        @prop DragVector3 Iris.DragVector3
-        @tag Widget
-        @tag HasState
-        
-        A field which allows the user to click and drag their cursor to enter a Vector3.
-        You can ctrl + click to directly input a Vector3, like InputVector3.
-        You can hold Shift to increase speed, and Alt to decrease speed when dragging.
-        
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string? = "DragVector3",
-            Increment: Vector3? = nil,
-            Min: Vector3? = nil,
-            Max: Vector3? = nil,
-            Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.
-        }
-        Events = {
-            numberChanged: () -> boolean,
-            hovered: () -> boolean
-        }
-        States = {
-            number: State<Vector3>?,
-            editingText: State<boolean>?
-        }
-        ```
-    ]=]
-    Iris.DragVector3 = wrapper("DragVector3")
-
-    --[=[
-        @within Drag
-        @prop DragUDim Iris.DragUDim
-        @tag Widget
-        @tag HasState
-        
-        A field which allows the user to click and drag their cursor to enter a UDim.
-        You can ctrl + click to directly input a UDim, like InputUDim.
-        You can hold Shift to increase speed, and Alt to decrease speed when dragging.
-        
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string? = "DragUDim",
-            Increment: UDim? = nil,
-            Min: UDim? = nil,
-            Max: UDim? = nil,
-            Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.
-        }
-        Events = {
-            numberChanged: () -> boolean,
-            hovered: () -> boolean
-        }
-        States = {
-            number: State<UDim>?,
-            editingText: State<boolean>?
-        }
-        ```
-    ]=]
-    Iris.DragUDim = wrapper("DragUDim")
-
-    --[=[
-        @within Drag
-        @prop DragUDim2 Iris.DragUDim2
-        @tag Widget
-        @tag HasState
-        
-        A field which allows the user to click and drag their cursor to enter a UDim2.
-        You can ctrl + click to directly input a UDim2, like InputUDim2.
-        You can hold Shift to increase speed, and Alt to decrease speed when dragging.
-        
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string? = "DragUDim2",
-            Increment: UDim2? = nil,
-            Min: UDim2? = nil,
-            Max: UDim2? = nil,
-            Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.
-        }
-        Events = {
-            numberChanged: () -> boolean,
-            hovered: () -> boolean
-        }
-        States = {
-            number: State<UDim2>?,
-            editingText: State<boolean>?
-        }
-        ```
-    ]=]
-    Iris.DragUDim2 = wrapper("DragUDim2")
-
-    --[=[
-        @within Drag
-        @prop DragRect Iris.DragRect
-        @tag Widget
-        @tag HasState
-        
-        A field which allows the user to click and drag their cursor to enter a Rect.
-        You can ctrl + click to directly input a Rect, like InputRect.
-        You can hold Shift to increase speed, and Alt to decrease speed when dragging.
-        
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string? = "DragRect",
-            Increment: Rect? = nil,
-            Min: Rect? = nil,
-            Max: Rect? = nil,
-            Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.
-        }
-        Events = {
-            numberChanged: () -> boolean,
-            hovered: () -> boolean
-        }
-        States = {
-            number: State<Rect>?,
-            editingText: State<boolean>?
-        }
-        ```
-    ]=]
-    Iris.DragRect = wrapper("DragRect")
-
-    --[=[
-        @within Input
-        @prop InputColor3 Iris.InputColor3
-        @tag Widget
-        @tag HasState
-        
-        An input box for Color3. The input boxes are draggable between 0 and 255 or if UseFloats then between 0 and 1.
-        Input can also be done using HSV instead of the default RGB.
-        If no format argument is provided then a default R, G, B or H, S, V prefix is applied.
-        
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string? = "InputColor3",
-            UseFloats: boolean? = false, -- constrain the values between floats 0 and 1 or integers 0 and 255.
-            UseHSV: boolean? = false, -- input using HSV instead.
-            Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.
-        }
-        Events = {
-            numberChanged: () -> boolean,
-            hovered: () -> boolean
-        }
-        States = {
-            color: State<Color3>?,
-            editingText: State<boolean>?
-        }
-        ```
-    ]=]
-    Iris.InputColor3 = wrapper("InputColor3")
-
-    --[=[
-        @within Input
-        @prop InputColor4 Iris.InputColor4
-        @tag Widget
-        @tag HasState
-        
-        An input box for Color4. Color4 is a combination of Color3 and a fourth transparency argument.
-        It has two states for this purpose.
-        The input boxes are draggable between 0 and 255 or if UseFloats then between 0 and 1.
-        Input can also be done using HSV instead of the default RGB.
-        If no format argument is provided then a default R, G, B, T or H, S, V, T prefix is applied.
-        
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string? = "InputColor4",
-            UseFloats: boolean? = false, -- constrain the values between floats 0 and 1 or integers 0 and 255.
-            UseHSV: boolean? = false, -- input using HSV instead.
-            Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.
-        }
-        Events = {
-            numberChanged: () -> boolean,
-            hovered: () -> boolean
-        }
-        States = {
-            color: State<Color3>?,
-            transparency: State<number>?,
-            editingText: State<boolean>?
-        }
-        ```
-    ]=]
-    Iris.InputColor4 = wrapper("InputColor4")
-
-    --[[
-        -----------------------------------
-            [SECTION] Slider Widget API
-        -----------------------------------
-    ]]
-    --[=[
-        @class Slider
-        Slider Widget API
-
-        A draggable widget with a visual bar constrained between a min and max for each datatype.
-        Allows direct typing input but also dragging the slider by clicking and holding anywhere in the box.
-        
-        See [Input] for more details on the arguments.
-    ]=]
-
-    --[=[
-        @within Slider
-        @prop SliderNum Iris.SliderNum
-        @tag Widget
-        @tag HasState
-        
-        A field which allows the user to slide a grip to enter a number within a range.
-        You can ctrl + click to directly input a number, like InputNum.
-        
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string? = "SliderNum",
-            Increment: number? = 1,
-            Min: number? = 0,
-            Max: number? = 100,
-            Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.
-        }
-        Events = {
-            numberChanged: () -> boolean,
-            hovered: () -> boolean
-        }
-        States = {
-            number: State<number>?,
-            editingText: State<boolean>?
-        }
-        ```
-    ]=]
-    Iris.SliderNum = wrapper("SliderNum")
-
-    --[=[
-        @within Slider
-        @prop SliderVector2 Iris.SliderVector2
-        @tag Widget
-        @tag HasState
-        
-        A field which allows the user to slide a grip to enter a Vector2 within a range.
-        You can ctrl + click to directly input a Vector2, like InputVector2.
-        
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string? = "SliderVector2",
-            Increment: Vector2? = { 1, 1 },
-            Min: Vector2? = { 0, 0 },
-            Max: Vector2? = { 100, 100 },
-            Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.
-        }
-        Events = {
-            numberChanged: () -> boolean,
-            hovered: () -> boolean
-        }
-        States = {
-            number: State<Vector2>?,
-            editingText: State<boolean>?
-        }
-        ```
-    ]=]
-    Iris.SliderVector2 = wrapper("SliderVector2")
-
-    --[=[
-        @within Slider
-        @prop SliderVector3 Iris.SliderVector3
-        @tag Widget
-        @tag HasState
-        
-        A field which allows the user to slide a grip to enter a Vector3 within a range.
-        You can ctrl + click to directly input a Vector3, like InputVector3.
-        
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string? = "SliderVector3",
-            Increment: Vector3? = { 1, 1, 1 },
-            Min: Vector3? = { 0, 0, 0 },
-            Max: Vector3? = { 100, 100, 100 },
-            Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.
-        }
-        Events = {
-            numberChanged: () -> boolean,
-            hovered: () -> boolean
-        }
-        States = {
-            number: State<Vector3>?,
-            editingText: State<boolean>?
-        }
-        ```
-    ]=]
-    Iris.SliderVector3 = wrapper("SliderVector3")
-
-    --[=[
-        @within Slider
-        @prop SliderUDim Iris.SliderUDim
-        @tag Widget
-        @tag HasState
-        
-        A field which allows the user to slide a grip to enter a UDim within a range.
-        You can ctrl + click to directly input a UDim, like InputUDim.
-        
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string? = "SliderUDim",
-            Increment: UDim? = { 0.01, 1 },
-            Min: UDim? = { 0, 0 },
-            Max: UDim? = { 1, 960 },
-            Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.
-        }
-        Events = {
-            numberChanged: () -> boolean,
-            hovered: () -> boolean
-        }
-        States = {
-            number: State<UDim>?,
-            editingText: State<boolean>?
-        }
-        ```
-    ]=]
-    Iris.SliderUDim = wrapper("SliderUDim")
-
-    --[=[
-        @within Slider
-        @prop SliderUDim2 Iris.SliderUDim2
-        @tag Widget
-        @tag HasState
-        
-        A field which allows the user to slide a grip to enter a UDim2 within a range.
-        You can ctrl + click to directly input a UDim2, like InputUDim2.
-        
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string? = "SliderUDim2",
-            Increment: UDim2? = { 0.01, 1, 0.01, 1 },
-            Min: UDim2? = { 0, 0, 0, 0 },
-            Max: UDim2? = { 1, 960, 1, 960 },
-            Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.
-        }
-        Events = {
-            numberChanged: () -> boolean,
-            hovered: () -> boolean
-        }
-        States = {
-            number: State<UDim2>?,
-            editingText: State<boolean>?
-        }
-        ```
-    ]=]
-    Iris.SliderUDim2 = wrapper("SliderUDim2")
-
-    --[=[
-        @within Slider
-        @prop SliderRect Iris.SliderRect
-        @tag Widget
-        @tag HasState
-        
-        A field which allows the user to slide a grip to enter a Rect within a range.
-        You can ctrl + click to directly input a Rect, like InputRect.
-        
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string? = "SliderRect",
-            Increment: Rect? = { 1, 1, 1, 1 },
-            Min: Rect? = { 0, 0, 0, 0 },
-            Max: Rect? = { 960, 960, 960, 960 },
-            Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.
-        }
-        Events = {
-            numberChanged: () -> boolean,
-            hovered: () -> boolean
-        }
-        States = {
-            number: State<Rect>?,
-            editingText: State<boolean>?
-        }
-        ```
-    ]=]
-    Iris.SliderRect = wrapper("SliderRect")
-
-    --[[
-        ----------------------------------
-            [SECTION] Combo Widget API
-        ----------------------------------
-    ]]
-    --[=[
-        @class Combo
-        Combo Widget API
-    ]=]
-
-    --[=[
-        @within Combo
-        @prop Selectable Iris.Selectable
-        @tag Widget
-        @tag HasState
-        
-        An object which can be selected.
-        
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string,
-            Index: any, -- index of selectable value.
-            NoClick: boolean? = false -- prevents the selectable from being clicked by the user.
-        }
-        Events = {
-            selected: () -> boolean,
-            unselected: () -> boolean,
-            active: () -> boolean,
-            clicked: () -> boolean,
-            rightClicked: () -> boolean,
-            doubleClicked: () -> boolean,
-            ctrlClicked: () -> boolean,
-            hovered: () -> boolean,
-        }
-        States = {
-            index: State<any> -- a shared state between all selectables.
-        }
-        ```
-    ]=]
-    Iris.Selectable = wrapper("Selectable")
-
-    --[=[
-        @within Combo
-        @prop Combo Iris.Combo
-        @tag Widget
-        @tag HasChildren
-        @tag HasState
-        
-        A dropdown menu box to make a selection from a list of values.
-        
-        ```lua
-        hasChildren = true
-        hasState = true
-        Arguments = {
-            Text: string,
-            NoButton: boolean? = false, -- hide the dropdown button.
-            NoPreview: boolean? = false -- hide the preview field.
-        }
-        Events = {
-            opened: () -> boolean,
-            closed: () -> boolean,
-            changed: () -> boolean,
-            clicked: () -> boolean,
-            hovered: () -> boolean
-        }
-        States = {
-            index: State<any>,
-            isOpened: State<boolean>?
-        }
-        ```
-    ]=]
-    Iris.Combo = wrapper("Combo")
-
-    --[=[
-        @within Combo
-        @prop ComboArray Iris.Combo
-        @tag Widget
-        @tag HasChildren
-        @tag HasState
-        
-        A selection box to choose a value from an array.
-        
-        ```lua
-        hasChildren = true
-        hasState = true
-        Arguments = {
-            Text: string,
-            NoButton: boolean? = false, -- hide the dropdown button.
-            NoPreview: boolean? = false -- hide the preview field.
-        }
-        Events = {
-            opened: () -> boolean,
-            closed: () -> boolean,
-            clicked: () -> boolean,
-            hovered: () -> boolean
-        }
-        States = {
-            index: State<any>,
-            isOpened: State<boolean>?
-        }
-        Extra = {
-            selectionArray: { any } -- the array to generate a combo from.
-        }
-        ```
-    ]=]
-    Iris.ComboArray = function<T>(arguments: Types.WidgetArguments, states: Types.WidgetStates?, selectionArray: { T })
-        local defaultState
-        if states == nil then
-            defaultState = Iris.State(selectionArray[1])
-        else
-            defaultState = states
-        end
-        local thisWidget = Iris.Internal._Insert("Combo", arguments, defaultState)
-        local sharedIndex = thisWidget.state.index
-        for _, Selection in selectionArray do
-            Iris.Internal._Insert("Selectable", { Selection, Selection }, { index = sharedIndex })
-        end
-        Iris.End()
-
-        return thisWidget
-    end
-
-    --[=[
-        @within Combo
-        @prop ComboEnum Iris.Combo
-        @tag Widget
-        @tag HasChildren
-        @tag HasState
-        
-        A selection box to choose a value from an Enum.
-        
-        ```lua
-        hasChildren = true
-        hasState = true
-        Arguments = {
-            Text: string,
-            NoButton: boolean? = false, -- hide the dropdown button.
-            NoPreview: boolean? = false -- hide the preview field.
-        }
-        Events = {
-            opened: () -> boolean,
-            closed: () -> boolean,
-            clicked: () -> boolean,
-            hovered: () -> boolean
-        }
-        States = {
-            index: State<any>,
-            isOpened: State<boolean>?
-        }
-        Extra = {
-            enumType: Enum -- the enum to generate a combo from.
-        }
-        ```
-    ]=]
-    Iris.ComboEnum = function(arguments: Types.WidgetArguments, states: Types.WidgetStates?, enumType: Enum)
-        local defaultState
-        if states == nil then
-            defaultState = Iris.State(enumType:GetEnumItems()[1])
-        else
-            defaultState = states
-        end
-        local thisWidget = Iris.Internal._Insert("Combo", arguments, defaultState)
-        local sharedIndex = thisWidget.state.index
-        for _, Selection in enumType:GetEnumItems() do
-            Iris.Internal._Insert("Selectable", { Selection.Name, Selection }, { index = sharedIndex })
-        end
-        Iris.End()
-
-        return thisWidget
-    end
-
-    --[=[
-        @private
-        @within Slider
-        @prop InputEnum Iris.InputEnum
-        @tag Widget
-        @tag HasState
-        
-        A field which allows the user to slide a grip to enter a number within a range.
-        You can ctrl + click to directly input a number, like InputNum.
-        
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string? = "InputEnum",
-            Increment: number? = 1,
-            Min: number? = 0,
-            Max: number? = 100,
-            Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.
-        }
-        Events = {
-            numberChanged: () -> boolean,
-            hovered: () -> boolean
-        }
-        States = {
-            number: State<number>?,
-            editingText: State<boolean>?,
-            enumItem: EnumItem
-        }
-        ```
-    ]=]
-    Iris.InputEnum = Iris.ComboEnum
-
-    --[[
-        ---------------------------------
-            [SECTION] Plot Widget API
-        ---------------------------------
-    ]]
-    --[=[
-        @class Plot
-        Plot Widget API
-    ]=]
-
-    --[=[
-        @within Plot
-        @prop ProgressBar Iris.ProgressBar
-        @tag Widget
-        @tag HasState
-
-        A progress bar line with a state value to show the current state.
-
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string? = "Progress Bar",
-            Format: string? = nil -- optional to override with a custom progress such as `29/54`
-        }
-        Events = {
-            hovered: () -> boolean,
-            changed: () -> boolean
-        }
-        States = {
-            progress: State<number>?
-        }
-        ```
-    ]=]
-    Iris.ProgressBar = wrapper("ProgressBar")
-
-    --[=[
-        @within Plot
-        @prop PlotLines Iris.PlotLines
-        @tag Widget
-        @tag HasState
-
-        A line graph for plotting a single line. Includes hovering to see a specific value on the graph,
-        and automatic scaling. Has an overlay text option at the top of the plot for displaying any
-        information.
-
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string? = "Plot Lines",
-            Height: number? = 0,
-            Min: number? = min, -- Iris will use the minimum value from the values
-            Max: number? = max, -- Iris will use the maximum value from the values
-            TextOverlay: string? = ""
-        }
-        Events = {
-            hovered: () -> boolean
-        }
-        States = {
-            values: State<{number}>?,
-            hovered: State<{number}>? -- read-only property
-        }
-        ```
-    ]=]
-    Iris.PlotLines = wrapper("PlotLines")
-
-    --[=[
-        @within Plot
-        @prop PlotHistogram Iris.PlotHistogram
-        @tag Widget
-        @tag HasState
-
-        A hisogram graph for showing values. Includes hovering to see a specific block on the graph,
-        and automatic scaling. Has an overlay text option at the top of the plot for displaying any
-        information. Also supports a baseline option, which determines where the blocks start from.
-
-        ```lua
-        hasChildren = false
-        hasState = true
-        Arguments = {
-            Text: string? = "Plot Histogram",
-            Height: number? = 0,
-            Min: number? = min, -- Iris will use the minimum value from the values
-            Max: number? = max, -- Iris will use the maximum value from the values
-            TextOverlay: string? = "",
-            BaseLine: number? = 0 -- by default, blocks swap side at 0
-        }
-        Events = {
-            hovered: () -> boolean
-        }
-        States = {
-            values: State<{number}>?,
-            hovered: State<{number}>? -- read-only property
-        }
-        ```
-    ]=]
-    Iris.PlotHistogram = wrapper("PlotHistogram")
-
-    --[[
-        ----------------------------------
-            [SECTION] Table Widget API
-        ----------------------------------
-    ]]
-    --[=[
-        @class Table
-        Table Widget API
-
-        Example usage for creating a simple table:
-        ```lua
-        Iris.Table({ 4, true })
-        do
-            Iris.SetHeaderColumnIndex(1)
-
-            -- for each row
-            for i = 0, 10 do
-
-                -- for each column
-                for j = 1, 4 do
-                    if i == 0 then
-                        -- 
-                        Iris.Text({ `H: {j}` })
-                    else
-                        Iris.Text({ `R: {i}, C: {j}` })
-                    end
-
-                    -- move the next column (and row when necessary)
-                    Iris.NextColumn()
-                end
-            end
-        ```
-    ]=]
-
-    --[=[
-        @within Table
-        @prop Table Iris.Table
-        @tag Widget
-        @tag HasChildren
-        
-        A layout widget which allows children to be displayed in configurable columns and rows. Highly configurable for many different
-        options, with options for custom width columns as configured by the user, or automatically use the best size.
-
-        When Resizable is enabled, the vertical columns can be dragged horizontally to increase or decrease space. This is linked to
-        the widths state, which controls the width of each column. This is also dependent on whether the FixedWidth argument is enabled.
-        By default, the columns will scale with the width of the table overall, therefore taking up a percentage, and the widths will be
-        in the range of 0 to 1 as a float. If FixedWidth is enabled, then the widths will be in pixels and have a value of > 2 as an
-        integer.
-
-        ProportionalWidth determines whether each column has the same width, or individual. By default, each column will take up an equal
-        proportion of the total table width. If true, then the columns will be allocated a width proportional to their total content size,
-        meaning wider columns take up a greater share of the total available space. For a fixed width table, by default each column will
-        take the max width of all the columns. When true, each column width will the minimum to fit the children within.
-
-        LimitTableWidth is used when FixedWidth is true. It will cut off the table horizontally after the last column.
-
-        :::info
-        Once the NumColumns is set, it is not possible to change it without some extra code. The best way to do this is by using
-        `Iris.PushConfig()` and `Iris.PopConfig()` which will automatically redraw the widget when the columns change.
-
-        ```lua
-        local numColumns = 4
-        Iris.PushConfig({ columns = numColumns })
-        Iris.Table({ numColumns, ...})
-        do
-            ...
-        end
-        Iris.End()
-        Iris.PopConfig()
-        ```
-
-        :::danger Error: nil
-        Always ensure that the number of elements in the widths state is greater or equal to the
-        new number of columns when changing the number of columns.
-        :::
-        :::
-        
-        ```lua
-        hasChildren = true
-        hasState = false
-        Arguments = {
-            NumColumns: number, -- number of columns in the table, cannot be changed
-            Header: boolean? = false, -- display a header row for each column
-            RowBackground: boolean? = false, -- alternating row background colours
-            OuterBorders: boolean? = false, -- outer border on the entire table
-            InnerBorders: boolean? = false, -- inner bordres on the entire table
-            Resizable: boolean? = false, -- the columns can be resized by dragging or state
-            FixedWidth: boolean? = false, -- columns takes up a fixed pixel width, rather than a proportion of the total available
-            ProportionalWidth: boolean? = false, -- minimises the width of each column individually
-            LimitTableWidth: boolean? = false, -- when a fixed width, cut of any unused space
-        }
-        Events = {
-            hovered: () -> boolean
-        }
-        States = {
-            widths: State<{ number }>? -- the widths of each column if Resizable
-        }
-        ```
-    ]=]
-    Iris.Table = wrapper("Table")
-
-    --[=[
-        @within Table
-        @function NextColumn
-        
-        In a table, moves to the next available cell. If the current cell is in the last column,
-        then moves to the cell in the first column of the next row.
-    ]=]
-    Iris.NextColumn = function()
-        local Table = Iris.Internal._GetParentWidget() :: Types.Table
-        assert(Table ~= nil, "Iris.NextColumn() can only called when directly within a table.")
-
-        local columnIndex = Table._columnIndex
-        if columnIndex == Table.arguments.NumColumns then
-            Table._columnIndex = 1
-            Table._rowIndex += 1
-        else
-            Table._columnIndex += 1
-        end
-        return Table._columnIndex
-    end
-
-    --[=[
-        @within Table
-        @function NextRow
-        
-        In a table, moves to the cell in the first column of the next row.
-    ]=]
-    Iris.NextRow = function()
-        local Table = Iris.Internal._GetParentWidget() :: Types.Table
-        assert(Table ~= nil, "Iris.NextRow() can only called when directly within a table.")
-        Table._columnIndex = 1
-        Table._rowIndex += 1
-        return Table._rowIndex
-    end
-
-    --[=[
-        @within Table
-        @function SetColumnIndex
-        @param index number
-        
-        In a table, moves to the cell in the given column in the same previous row.
-
-        Will erorr if the given index is not in the range of 1 to NumColumns.
-    ]=]
-    Iris.SetColumnIndex = function(index: number)
-        local Table = Iris.Internal._GetParentWidget() :: Types.Table
-        assert(Table ~= nil, "Iris.SetColumnIndex() can only called when directly within a table.")
-        assert((index >= 1) and (index <= Table.arguments.NumColumns), `The index must be between 1 and {Table.arguments.NumColumns}, inclusive.`)
-        Table._columnIndex = index
-    end
-
-    --[=[
-        @within Table
-        @function SetRowIndex
-        @param index number
-
-        In a table, moves to the cell in the given row with the same previous column.
-    ]=]
-    Iris.SetRowIndex = function(index: number)
-        local Table = Iris.Internal._GetParentWidget() :: Types.Table
-        assert(Table ~= nil, "Iris.SetRowIndex() can only called when directly within a table.")
-        assert(index >= 1, "The index must be greater or equal to 1.")
-        Table._rowIndex = index
-    end
-
-    --[=[
-        @within Table
-        @function NextHeaderColumn
-
-        In a table, moves to the cell in the next column in the header row (row index 0). Will loop around
-        from the last column to the first.
-    ]=]
-    Iris.NextHeaderColumn = function()
-        local Table = Iris.Internal._GetParentWidget() :: Types.Table
-        assert(Table ~= nil, "Iris.NextHeaderColumn() can only called when directly within a table.")
-
-        Table._rowIndex = 0
-        Table._columnIndex = (Table._columnIndex % Table.arguments.NumColumns) + 1
-
-        return Table._columnIndex
-    end
-
-    --[=[
-        @within Table
-        @function SetHeaderColumnIndex
-        @param index number
-
-        In a table, moves to the cell in the given column in the header row (row index 0).
-
-        Will erorr if the given index is not in the range of 1 to NumColumns.
-    ]=]
-    Iris.SetHeaderColumnIndex = function(index: number)
-        local Table = Iris.Internal._GetParentWidget() :: Types.Table
-        assert(Table ~= nil, "Iris.SetHeaderColumnIndex() can only called when directly within a table.")
-        assert((index >= 1) and (index <= Table.arguments.NumColumns), `The index must be between 1 and {Table.arguments.NumColumns}, inclusive.`)
-
-        Table._rowIndex = 0
-        Table._columnIndex = index
-    end
-
-    --[=[
-        @within Table
-        @function SetColumnWidth
-        @param index number
-        @param width number
-
-        In a table, sets the width of the given column to the given value by changing the
-        Table's widths state. When the FixedWidth argument is true, the width should be in
-        pixels >2, otherwise as a float between 0 and 1.
-
-        Will erorr if the given index is not in the range of 1 to NumColumns.
-    ]=]
-    Iris.SetColumnWidth = function(index: number, width: number)
-        local Table = Iris.Internal._GetParentWidget() :: Types.Table
-        assert(Table ~= nil, "Iris.SetColumnWidth() can only called when directly within a table.")
-        assert((index >= 1) and (index <= Table.arguments.NumColumns), `The index must be between 1 and {Table.arguments.NumColumns}, inclusive.`)
-
-        local oldValue = Table.state.widths.value[index]
-        Table.state.widths.value[index] = width
-        Table.state.widths:set(Table.state.widths.value, width ~= oldValue)
-    end
-end