158 lines
12 KiB
Lua
158 lines
12 KiB
Lua
--=====================================--
|
|
-- only used for types with lua_ls, if you're using a different LSP (or none), you can remove this file --
|
|
--=====================================--
|
|
|
|
--=====================================--
|
|
-- For Animation.lua
|
|
--=====================================--
|
|
---@class AnimationProps
|
|
---@field duration number -- Duration in seconds
|
|
---@field start table -- Starting values (can contain: width, height, opacity, x, y, gap, imageOpacity, backgroundColor, borderColor, textColor, padding, margin, cornerRadius, transform, etc.)
|
|
---@field final table -- Final values (same properties as start)
|
|
---@field easing string? -- Easing function name: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInExpo", "easeOutExpo" (default: "linear")
|
|
---@field onStart fun(animation:Animation, element:Element?)? -- Called when animation starts
|
|
---@field onUpdate fun(animation:Animation, element:Element?, progress:number)? -- Called each frame with progress (0-1)
|
|
---@field onComplete fun(animation:Animation, element:Element?)? -- Called when animation completes
|
|
---@field onCancel fun(animation:Animation, element:Element?)? -- Called when animation is cancelled
|
|
---@field transform table? -- Additional transform properties (legacy support)
|
|
---@field transition table? -- Transition properties (legacy support)
|
|
local AnimationProps = {}
|
|
|
|
---@class TransformProps
|
|
---@field scale {x?:number, y?:number}?
|
|
---@field rotate number?
|
|
---@field translate {x?:number, y?:number}?
|
|
---@field skew {x?:number, y?:number}?
|
|
|
|
---@class TransitionProps
|
|
---@field duration number?
|
|
---@field easing string?
|
|
|
|
--=====================================--
|
|
-- For Element.lua
|
|
--=====================================--
|
|
---@class ElementProps
|
|
---@field id string? -- Unique identifier for the element (auto-generated in immediate mode if not provided)
|
|
---@field parent Element? -- Parent element for hierarchical structure
|
|
---@field x number|string? -- X coordinate of the element (default: 0)
|
|
---@field y number|string? -- Y coordinate of the element (default: 0)
|
|
---@field z number? -- Z-index for layering (default: 0)
|
|
---@field width number|string? -- Width of the element (default: calculated automatically)
|
|
---@field height number|string? -- Height of the element (default: calculated automatically)
|
|
---@field top number|string? -- Offset from top edge (CSS-style positioning)
|
|
---@field right number|string? -- Offset from right edge (CSS-style positioning)
|
|
---@field bottom number|string? -- Offset from bottom edge (CSS-style positioning)
|
|
---@field left number|string? -- Offset from left edge (CSS-style positioning)
|
|
---@field border Border? -- Border configuration for the element
|
|
---@field borderColor Color? -- Color of the border (default: black)
|
|
---@field opacity number? -- Element opacity 0-1 (default: 1)
|
|
---@field visibility "visible"|"hidden"? -- Element visibility (default: "visible")
|
|
---@field backgroundColor Color? -- Background color (default: transparent)
|
|
---@field cornerRadius number|{topLeft:number?, topRight:number?, bottomLeft:number?, bottomRight:number?}? -- Corner radius: number (all corners) or table for individual corners (default: 0)
|
|
---@field gap number|string? -- Space between children elements (default: 0)
|
|
---@field padding {top:number|string?, right:number|string?, bottom:number|string?, left:number|string?, horizontal:number|string?, vertical:number|string?}? -- Padding around children (default: {top=0, right=0, bottom=0, left=0})
|
|
---@field margin {top:number|string?, right:number|string?, bottom:number|string?, left:number|string?, horizontal:number|string?, vertical:number|string?}? -- Margin around element (default: {top=0, right=0, bottom=0, left=0})
|
|
---@field text string? -- Text content to display (default: nil)
|
|
---@field textAlign TextAlign? -- Alignment of the text content (default: START)
|
|
---@field textColor Color? -- Color of the text content (default: black or theme text color)
|
|
---@field textSize number|string? -- Font size: number (px), string with units ("2vh", "10%"), or preset ("xxs"|"xs"|"sm"|"md"|"lg"|"xl"|"xxl"|"3xl"|"4xl") (default: "md" or 12px)
|
|
---@field minTextSize number? -- Minimum text size in pixels for auto-scaling
|
|
---@field maxTextSize number? -- Maximum text size in pixels for auto-scaling
|
|
---@field fontFamily string? -- Font family name from theme or path to font file (default: theme default or system default, inherits from parent)
|
|
---@field autoScaleText boolean? -- Whether text should auto-scale with window size (default: true)
|
|
---@field positioning Positioning? -- Layout positioning mode: "absolute"|"relative"|"flex"|"grid" (default: RELATIVE)
|
|
---@field flexDirection FlexDirection? -- Direction of flex layout: "horizontal"|"vertical" (default: HORIZONTAL)
|
|
---@field justifyContent JustifyContent? -- Alignment of items along main axis (default: FLEX_START)
|
|
---@field alignItems AlignItems? -- Alignment of items along cross axis (default: STRETCH)
|
|
---@field alignContent AlignContent? -- Alignment of lines in multi-line flex containers (default: STRETCH)
|
|
---@field flexWrap FlexWrap? -- Whether children wrap to multiple lines: "nowrap"|"wrap"|"wrap-reverse" (default: NOWRAP)
|
|
---@field justifySelf JustifySelf? -- Alignment of the item itself along main axis (default: AUTO)
|
|
---@field alignSelf AlignSelf? -- Alignment of the item itself along cross axis (default: AUTO)
|
|
---@field onEvent fun(element:Element, event:InputEvent)? -- Callback function for interaction events
|
|
---@field onEventDeferred boolean? -- Whether onEvent callback should be deferred until after canvases are released (default: false)
|
|
---@field onFocus fun(element:Element)? -- Callback when element receives focus
|
|
---@field onFocusDeferred boolean? -- Whether onFocus callback should be deferred (default: false)
|
|
---@field onBlur fun(element:Element)? -- Callback when element loses focus
|
|
---@field onBlurDeferred boolean? -- Whether onBlur callback should be deferred (default: false)
|
|
---@field onTextInput fun(element:Element, text:string)? -- Callback when text is input
|
|
---@field onTextInputDeferred boolean? -- Whether onTextInput callback should be deferred (default: false)
|
|
---@field onTextChange fun(element:Element, text:string)? -- Callback when text content changes
|
|
---@field onTextChangeDeferred boolean? -- Whether onTextChange callback should be deferred (default: false)
|
|
---@field onEnter fun(element:Element)? -- Callback when Enter key is pressed
|
|
---@field onEnterDeferred boolean? -- Whether onEnter callback should be deferred (default: false)
|
|
---@field transform TransformProps? -- Transform properties for animations and styling
|
|
---@field transition TransitionProps? -- Transition settings for animations
|
|
---@field gridRows number? -- Number of rows in the grid (default: 1)
|
|
---@field gridColumns number? -- Number of columns in the grid (default: 1)
|
|
---@field columnGap number|string? -- Gap between grid columns (default: 0)
|
|
---@field rowGap number|string? -- Gap between grid rows (default: 0)
|
|
---@field theme string? -- Theme name to use (e.g., "space", "metal"). Defaults to theme from flexlove.init()
|
|
---@field themeComponent string? -- Theme component to use (e.g., "panel", "button", "input"). If nil, no theme is applied
|
|
---@field disabled boolean? -- Whether the element is disabled (default: false)
|
|
---@field active boolean? -- Whether the element is active/focused (for inputs, default: false)
|
|
---@field disableHighlight boolean? -- Whether to disable the pressed state highlight overlay (default: false, or true when using themeComponent)
|
|
---@field contentAutoSizingMultiplier {width:number?, height:number?}? -- Multiplier for auto-sized content dimensions (default: sourced from theme or {1, 1})
|
|
---@field scaleCorners number? -- Scale multiplier for 9-patch corners/edges. E.g., 2 = 2x size (overrides theme setting)
|
|
---@field scalingAlgorithm "nearest"|"bilinear"? -- Scaling algorithm for 9-patch corners: "nearest" (sharp/pixelated) or "bilinear" (smooth) (overrides theme setting)
|
|
---@field contentBlur {intensity:number, quality:number}? -- Blur the element's content including children (intensity: 0-100, quality: 1-10, default: nil)
|
|
---@field backdropBlur {intensity:number, quality:number}? -- Blur content behind the element (intensity: 0-100, quality: 1-10, default: nil)
|
|
---@field editable boolean? -- Whether the element is editable (default: false)
|
|
---@field multiline boolean? -- Whether the element supports multiple lines (default: false)
|
|
---@field textWrap boolean|"word"|"char"? -- Text wrapping mode (default: false for single-line, "word" for multi-line)
|
|
---@field maxLines number? -- Maximum number of lines (default: nil)
|
|
---@field maxLength number? -- Maximum text length in characters (default: nil)
|
|
---@field placeholder string? -- Placeholder text when empty (default: nil)
|
|
---@field passwordMode boolean? -- Whether to display text as password (default: false, disables multiline)
|
|
---@field inputType "text"|"number"|"email"|"url"? -- Input type for validation (default: "text")
|
|
---@field textOverflow "clip"|"ellipsis"|"scroll"? -- Text overflow behavior (default: "clip")
|
|
---@field scrollable boolean? -- Whether text is scrollable (default: false for single-line, true for multi-line)
|
|
---@field autoGrow boolean? -- Whether element auto-grows with text (default: false for single-line, true for multi-line)
|
|
---@field selectOnFocus boolean? -- Whether to select all text on focus (default: false)
|
|
---@field cursorColor Color? -- Cursor color (default: nil, uses textColor)
|
|
---@field selectionColor Color? -- Selection background color (default: nil, uses theme or default)
|
|
---@field cursorBlinkRate number? -- Cursor blink rate in seconds (default: 0.5)
|
|
---@field overflow "visible"|"hidden"|"scroll"|"auto"? -- Overflow behavior (default: "hidden")
|
|
---@field overflowX "visible"|"hidden"|"scroll"|"auto"? -- X-axis overflow (overrides overflow)
|
|
---@field overflowY "visible"|"hidden"|"scroll"|"auto"? -- Y-axis overflow (overrides overflow)
|
|
---@field scrollbarWidth number? -- Width of scrollbar track in pixels (default: 12)
|
|
---@field scrollbarColor Color? -- Scrollbar thumb color (default: Color.new(0.5, 0.5, 0.5, 0.8))
|
|
---@field scrollbarTrackColor Color? -- Scrollbar track color (default: Color.new(0.2, 0.2, 0.2, 0.5))
|
|
---@field scrollbarRadius number? -- Corner radius for scrollbar (default: 6)
|
|
---@field scrollbarPadding number? -- Padding between scrollbar and edge (default: 2)
|
|
---@field scrollSpeed number? -- Pixels per wheel notch (default: 20)
|
|
---@field hideScrollbars boolean|{vertical:boolean, horizontal:boolean}? -- Hide scrollbars (boolean for both, or table for individual control, default: false)
|
|
---@field imagePath string? -- Path to image file (auto-loads via ImageCache)
|
|
---@field image love.Image? -- Image object to display
|
|
---@field objectFit "fill"|"contain"|"cover"|"scale-down"|"none"? -- Image fit mode (default: "fill")
|
|
---@field objectPosition string? -- Image position like "center center", "top left", "50% 50%" (default: "center center")
|
|
---@field imageOpacity number? -- Image opacity 0-1 (default: 1, combines with element opacity)
|
|
---@field imageRepeat "no-repeat"|"repeat"|"repeat-x"|"repeat-y"|"space"|"round"? -- Image repeat/tiling mode (default: "no-repeat")
|
|
---@field imageTint Color? -- Color to tint the image (default: nil/white, no tint)
|
|
---@field onImageLoad fun(element:Element, image:love.Image)? -- Callback when image loads successfully
|
|
---@field onImageLoadDeferred boolean? -- Whether onImageLoad callback should be deferred (default: false)
|
|
---@field onImageError fun(element:Element, error:string)? -- Callback when image fails to load
|
|
---@field onImageErrorDeferred boolean? -- Whether onImageError callback should be deferred (default: false)
|
|
---@field _scrollX number? -- Internal: scroll X position (restored in immediate mode)
|
|
---@field _scrollY number? -- Internal: scroll Y position (restored in immediate mode)
|
|
---@field userdata table? -- User-defined data storage for custom properties
|
|
local ElementProps = {}
|
|
|
|
---@class Border
|
|
---@field top boolean
|
|
---@field right boolean
|
|
---@field bottom boolean
|
|
---@field left boolean
|
|
local Border = {}
|
|
|
|
---@class TransformProps
|
|
---@field rotate number? Rotation in radians (default: 0)
|
|
---@field scaleX number? X-axis scale (default: 1)
|
|
---@field scaleY number? Y-axis scale (default: 1)
|
|
---@field translateX number? X translation in pixels (default: 0)
|
|
---@field translateY number? Y translation in pixels (default: 0)
|
|
---@field skewX number? X-axis skew in radians (default: 0)
|
|
---@field skewY number? Y-axis skew in radians (default: 0)
|
|
---@field originX number? Transform origin X (0-1, default: 0.5)
|
|
---@field originY number? Transform origin Y (0-1, default: 0.5)
|
|
local TransformProps
|