Show raw api
{
"functions": [],
"properties": [],
"types": [
{
"name": "GradientProps",
"desc": "",
"fields": [
{
"name": "Enabled",
"lua_type": "boolean?",
"desc": "Whether the gradient is enabled."
},
{
"name": "Color",
"lua_type": "ColorSequence?",
"desc": "The color sequence of the gradient."
},
{
"name": "Offset",
"lua_type": "UDim?",
"desc": "The offset of the gradient."
},
{
"name": "Rotation",
"lua_type": "number?",
"desc": "The rotation of the gradient."
},
{
"name": "Transparency",
"lua_type": "NumberSequence?",
"desc": "The transparency sequence of the gradient."
}
],
"source": {
"line": 17,
"path": "src/Components/Base.luau"
}
},
{
"name": "PaddingProps",
"desc": "",
"fields": [
{
"name": "Enabled",
"lua_type": "boolean?",
"desc": "Whether the padding is enabled."
},
{
"name": "All",
"lua_type": "UDim?",
"desc": "The padding applied to all sides."
},
{
"name": "Top",
"lua_type": "UDim?",
"desc": "The padding applied to the top side."
},
{
"name": "Left",
"lua_type": "UDim?",
"desc": "The padding applied to the left side."
},
{
"name": "Right",
"lua_type": "UDim?",
"desc": "The padding applied to the right side."
},
{
"name": "Bottom",
"lua_type": "UDim?",
"desc": "The padding applied to the bottom side."
}
],
"source": {
"line": 29,
"path": "src/Components/Base.luau"
}
},
{
"name": "CornerProps",
"desc": "",
"fields": [
{
"name": "Enabled",
"lua_type": "boolean?",
"desc": "Whether the corner is enabled."
},
{
"name": "Radius",
"lua_type": "UDim?",
"desc": "The radius of the corner."
}
],
"source": {
"line": 37,
"path": "src/Components/Base.luau"
}
},
{
"name": "StrokeProps",
"desc": "",
"fields": [
{
"name": "Enabled",
"lua_type": "boolean?",
"desc": "Whether the stroke is enabled."
},
{
"name": "Thickness",
"lua_type": "number?",
"desc": "The thickness of the stroke."
},
{
"name": "Color",
"lua_type": "Color3?",
"desc": "The color of the stroke."
},
{
"name": "Transparency",
"lua_type": "number?",
"desc": "The transparency of the stroke."
},
{
"name": "LineJoinMode",
"lua_type": "Enum.LineJoinMode?",
"desc": "The line join mode of the stroke."
},
{
"name": "ApplyStrokeMode",
"lua_type": "Enum.ApplyStrokeMode?",
"desc": "The apply stroke mode of the stroke."
},
{
"name": "Gradient",
"lua_type": "GradientProps?",
"desc": "The gradient applied to the stroke."
}
],
"source": {
"line": 50,
"path": "src/Components/Base.luau"
}
},
{
"name": "AspectProps",
"desc": "",
"fields": [
{
"name": "Enabled",
"lua_type": "boolean?",
"desc": "Whether the aspect ratio constraint is enabled."
},
{
"name": "Ratio",
"lua_type": "number?",
"desc": "The aspect ratio."
},
{
"name": "Type",
"lua_type": "Enum.AspectType?",
"desc": "The aspect type."
},
{
"name": "DominantAxis",
"lua_type": "Enum.DominantAxis?",
"desc": "The dominant axis."
}
],
"source": {
"line": 60,
"path": "src/Components/Base.luau"
}
},
{
"name": "ScaleProps",
"desc": "",
"fields": [
{
"name": "Enabled",
"lua_type": "boolean?",
"desc": "Whether the scale is enabled."
},
{
"name": "Scale",
"lua_type": "number?",
"desc": "The scale factor."
}
],
"source": {
"line": 68,
"path": "src/Components/Base.luau"
}
},
{
"name": "FlexProps",
"desc": "",
"fields": [
{
"name": "Enabled",
"lua_type": "boolean?",
"desc": "Whether the flex item is enabled."
},
{
"name": "Mode",
"lua_type": "Enum.UIFlexMode?",
"desc": "The flex mode."
},
{
"name": "ItemLineAlignment",
"lua_type": "Enum.ItemLineAlignment?",
"desc": "The alignment of items along the line."
},
{
"name": "GrowRatio",
"lua_type": "number?",
"desc": "The grow ratio of the flex item."
},
{
"name": "ShrinkRatio",
"lua_type": "number?",
"desc": "The shrink ratio of the flex item."
}
],
"source": {
"line": 79,
"path": "src/Components/Base.luau"
}
},
{
"name": "ListProps",
"desc": "",
"fields": [
{
"name": "Enabled",
"lua_type": "boolean?",
"desc": "Whether the list layout is enabled."
},
{
"name": "Padding",
"lua_type": "UDim?",
"desc": "The padding between items in the list."
},
{
"name": "FillDirection",
"lua_type": "Enum.FillDirection?",
"desc": "The fill direction of the list."
},
{
"name": "SortOrder",
"lua_type": "Enum.SortOrder?",
"desc": "The sort order of the list."
},
{
"name": "Wraps",
"lua_type": "boolean?",
"desc": "Whether the list wraps."
},
{
"name": "HorizontalAlignment",
"lua_type": "Enum.HorizontalAlignment?",
"desc": "The horizontal alignment of the list."
},
{
"name": "HorizontalFlex",
"lua_type": "boolean?",
"desc": "Whether horizontal flex is enabled."
},
{
"name": "VerticalAlignment",
"lua_type": "Enum.VerticalAlignment?",
"desc": "The vertical alignment of the list."
},
{
"name": "VerticalFlex",
"lua_type": "boolean?",
"desc": "Whether vertical flex is enabled."
},
{
"name": "ItemLineAlignment",
"lua_type": "Enum.ItemLineAlignment?",
"desc": "The alignment of items along the line."
}
],
"source": {
"line": 95,
"path": "src/Components/Base.luau"
}
},
{
"name": "GridProps",
"desc": "",
"fields": [
{
"name": "Enabled",
"lua_type": "boolean?",
"desc": "Whether the grid layout is enabled."
},
{
"name": "CellPadding",
"lua_type": "UDim2?",
"desc": "The padding between cells in the grid."
},
{
"name": "CellSize",
"lua_type": "UDim2?",
"desc": "The size of each cell in the grid."
},
{
"name": "FillDirection",
"lua_type": "Enum.FillDirection?",
"desc": "The fill direction of the grid."
},
{
"name": "FillDirectionMaxCells",
"lua_type": "number?",
"desc": "The maximum number of cells in the fill direction."
},
{
"name": "SortOrder",
"lua_type": "Enum.SortOrder?",
"desc": "The sort order of the grid."
},
{
"name": "StartCorner",
"lua_type": "Enum.StartCorner?",
"desc": "The starting corner of the grid."
},
{
"name": "HorizontalAlignment",
"lua_type": "Enum.HorizontalAlignment?",
"desc": "The horizontal alignment of the grid."
},
{
"name": "VerticalAlignment",
"lua_type": "Enum.VerticalAlignment?",
"desc": "The vertical alignment of the grid."
}
],
"source": {
"line": 110,
"path": "src/Components/Base.luau"
}
},
{
"name": "TableProps",
"desc": "",
"fields": [
{
"name": "Enabled",
"lua_type": "boolean?",
"desc": "Whether the table layout is enabled."
},
{
"name": "Padding",
"lua_type": "UDim?",
"desc": "The padding between items in the table."
},
{
"name": "FillEmptySpaceColumns",
"lua_type": "boolean?",
"desc": "Whether empty space in columns is filled."
},
{
"name": "FillEmptySpaceRows",
"lua_type": "boolean?",
"desc": "Whether empty space in rows is filled."
},
{
"name": "FillDirection",
"lua_type": "Enum.FillDirection?",
"desc": "The fill direction of the table."
},
{
"name": "SortOrder",
"lua_type": "Enum.SortOrder?",
"desc": "The sort order of the table."
},
{
"name": "MajorAxis",
"lua_type": "Enum.TableMajorAxis?",
"desc": "The major axis of the table."
},
{
"name": "HorizontalAlignment",
"lua_type": "Enum.HorizontalAlignment?",
"desc": "The horizontal alignment of the table."
},
{
"name": "VerticalAlignment",
"lua_type": "Enum.VerticalAlignment?",
"desc": "The vertical alignment of the table."
}
],
"source": {
"line": 125,
"path": "src/Components/Base.luau"
}
},
{
"name": "PageProps",
"desc": "",
"fields": [
{
"name": "Enabled",
"lua_type": "boolean?",
"desc": "Whether the page layout is enabled."
},
{
"name": "Animated",
"lua_type": "boolean?",
"desc": "Whether the page transitions are animated."
},
{
"name": "Circular",
"lua_type": "boolean?",
"desc": "Whether the pages are circular."
},
{
"name": "EasingDirection",
"lua_type": "Enum.EasingDirection?",
"desc": "The easing direction for transitions."
},
{
"name": "EasingStyle",
"lua_type": "Enum.EasingStyle?",
"desc": "The easing style for transitions."
},
{
"name": "Padding",
"lua_type": "UDim?",
"desc": "The padding between pages."
},
{
"name": "TweenTime",
"lua_type": "number?",
"desc": "The time for page transitions."
},
{
"name": "FillDirection",
"lua_type": "Enum.FillDirection?",
"desc": "The fill direction of the pages."
},
{
"name": "SortOrder",
"lua_type": "Enum.SortOrder?",
"desc": "The sort order of the pages."
},
{
"name": "HorizontalAlignment",
"lua_type": "Enum.HorizontalAlignment?",
"desc": "The horizontal alignment of the pages."
},
{
"name": "VerticalAlignment",
"lua_type": "Enum.VerticalAlignment?",
"desc": "The vertical alignment of the pages."
},
{
"name": "GamepadInputEnabled",
"lua_type": "boolean?",
"desc": "Whether gamepad input is enabled."
},
{
"name": "ScrollWheelInputEnabled",
"lua_type": "boolean?",
"desc": "Whether scroll wheel input is enabled."
},
{
"name": "TouchInputEnabled",
"lua_type": "boolean?",
"desc": "Whether touch input is enabled."
}
],
"source": {
"line": 145,
"path": "src/Components/Base.luau"
}
},
{
"name": "SizeLimitProps",
"desc": "",
"fields": [
{
"name": "Enabled",
"lua_type": "boolean?",
"desc": "Whether the size constraint is enabled."
},
{
"name": "Max",
"lua_type": "Vector2?",
"desc": "The maximum size."
},
{
"name": "Min",
"lua_type": "Vector2?",
"desc": "The minimum size."
}
],
"source": {
"line": 154,
"path": "src/Components/Base.luau"
}
},
{
"name": "TextSizeLimitProps",
"desc": "",
"fields": [
{
"name": "Enabled",
"lua_type": "boolean?",
"desc": "Whether the text size constraint is enabled."
},
{
"name": "Max",
"lua_type": "number?",
"desc": "The maximum text size."
},
{
"name": "Min",
"lua_type": "number?",
"desc": "The minimum text size."
}
],
"source": {
"line": 163,
"path": "src/Components/Base.luau"
}
},
{
"name": "BaseProps",
"desc": "",
"fields": [
{
"name": "ClassName",
"lua_type": "string?",
"desc": "The class name of the component."
},
{
"name": "Name",
"lua_type": "string?",
"desc": "The name of the component."
},
{
"name": "Parent",
"lua_type": "Instance?",
"desc": "The parent instance of the component."
},
{
"name": "Position",
"lua_type": "UDim2?",
"desc": "The position of the component."
},
{
"name": "Rotation",
"lua_type": "number?",
"desc": "The rotation of the component."
},
{
"name": "AnchorPoint",
"lua_type": "Vector2?",
"desc": "The anchor point of the component."
},
{
"name": "Size",
"lua_type": "UDim2?",
"desc": "The size of the component."
},
{
"name": "AutomaticSize",
"lua_type": "Enum.AutomaticSize?",
"desc": "The automatic size of the component."
},
{
"name": "Visible",
"lua_type": "boolean?",
"desc": "Whether the component is visible."
},
{
"name": "ZIndex",
"lua_type": "number?",
"desc": "The ZIndex of the component."
},
{
"name": "LayoutOrder",
"lua_type": "number?",
"desc": "The layout order of the component."
},
{
"name": "ClipsDescendants",
"lua_type": "boolean?",
"desc": "Whether the component clips its descendants."
},
{
"name": "Active",
"lua_type": "boolean?",
"desc": "Whether the component is active."
},
{
"name": "Selectable",
"lua_type": "boolean?",
"desc": "Whether the component is selectable."
},
{
"name": "Interactable",
"lua_type": "boolean?",
"desc": "Whether the component is interactable."
},
{
"name": "BackgroundColor3",
"lua_type": "Color3?",
"desc": "The background color of the component."
},
{
"name": "BackgroundTransparency",
"lua_type": "number?",
"desc": "The background transparency of the component."
},
{
"name": "NextSelectionDown",
"lua_type": "GuiObject?",
"desc": "The next selection down."
},
{
"name": "NextSelectionUp",
"lua_type": "GuiObject?",
"desc": "The next selection up."
},
{
"name": "NextSelectionRight",
"lua_type": "GuiObject?",
"desc": "The next selection right."
},
{
"name": "NextSelectionLeft",
"lua_type": "GuiObject?",
"desc": "The next selection left."
},
{
"name": "SelectionImageObject",
"lua_type": "GuiObject?",
"desc": "The selection image object."
},
{
"name": "SelectionOrder",
"lua_type": "number?",
"desc": "The selection order."
},
{
"name": "SizeConstraint",
"lua_type": "Enum.SizeConstraint?",
"desc": "The size constraint of the component."
},
{
"name": "AutoLocalize",
"lua_type": "boolean?",
"desc": "Whether the component auto-localizes."
},
{
"name": "RootLocalizationTable",
"lua_type": "LocalizationTable?",
"desc": "The root localization table."
},
{
"name": "SelectionBehaviorDown",
"lua_type": "Enum.SelectionBehavior?",
"desc": "The selection behavior down."
},
{
"name": "SelectionBehaviorUp",
"lua_type": "Enum.SelectionBehavior?",
"desc": "The selection behavior up."
},
{
"name": "SelectionBehaviorRight",
"lua_type": "Enum.SelectionBehavior?",
"desc": "The selection behavior right."
},
{
"name": "SelectionBehaviorLeft",
"lua_type": "Enum.SelectionBehavior?",
"desc": "The selection behavior left."
},
{
"name": "SelectionGroup",
"lua_type": "boolean?",
"desc": "Whether the component is part of a selection group."
},
{
"name": "Corner",
"lua_type": "CornerProps?",
"desc": "The corner properties."
},
{
"name": "Padding",
"lua_type": "PaddingProps?",
"desc": "The padding properties."
},
{
"name": "Stroke",
"lua_type": "StrokeProps?",
"desc": "The stroke properties."
},
{
"name": "Gradient",
"lua_type": "GradientProps?",
"desc": "The gradient properties."
},
{
"name": "Aspect",
"lua_type": "AspectProps?",
"desc": "The aspect ratio properties."
},
{
"name": "Scale",
"lua_type": "ScaleProps?",
"desc": "The scale properties."
},
{
"name": "List",
"lua_type": "ListProps?",
"desc": "The list layout properties."
},
{
"name": "Grid",
"lua_type": "GridProps?",
"desc": "The grid layout properties."
},
{
"name": "Table",
"lua_type": "TableProps?",
"desc": "The table layout properties."
},
{
"name": "Page",
"lua_type": "PageProps?",
"desc": "The page layout properties."
},
{
"name": "Flex",
"lua_type": "FlexProps?",
"desc": "The flex layout properties."
},
{
"name": "SizeLimit",
"lua_type": "SizeLimitProps?",
"desc": "The size limit properties."
},
{
"name": "TextSizeLimit",
"lua_type": "TextSizeLimitProps?",
"desc": "The text size limit properties."
}
],
"source": {
"line": 216,
"path": "src/Components/Base.luau"
}
}
],
"name": "Base",
"desc": "The foundational component of OnyxUI, from which all other components are built off of. Props supported here typically work in all other components.",
"source": {
"line": 6,
"path": "src/Components/Base.luau"
}
}