Skip to content

Luau API symbol index

The signatures on these pages come from the shipped omniwm.d.luau; handwritten sections explain behavior, defaults, limits, and failure states. Start with a widget, a menu, or an island before looking up details here.

Topic Find
UI elements Containers, text, icons, images, inputs, sliders, paths
Layout and styling Common properties, palette colors, materials, host targets
Context and data Widget lifecycle, selected data, formatting, actions, all feed records
Input and motion Events, native feedback, gestures, keyboard focus, springs
Components and configuration Manifests, lifecycle hooks, views, catalog, schema and configuration actions
Async services, HTTP, JSON, and storage Cancellation, request bounds, HTTP, timers, encoding, durable state
Resources and desktop services Assets, Resource handles, drag/drop, clipboard, native file UI
Providers Native process opt-in, JSON Lines, ordered actions, file envelopes
Effects and shaders Metal programs, motion recipes, texture effects, reveal masks

Each symbol links to its complete declaration. Field links target the owning type’s declaration; its surrounding topic describes their use. Specialized element properties extend Props, so shared fields such as key, w, onClick, and animate are listed there.

SymbolKindFields
Aligntype
Animatetypeduration, curve, response, bounce
Assettype
AudioApptypeid, name, playing, volume, muted
AudioAppstypeaccess, apps
AudioOutputtypeid, name, transport, default
Bartypemonitor, island, drag, badges, style, workspaces, scratchpads
BarDragtypesources, workspaces, icons, gaps
BarItemtypeid, bundle, name, focused, count, hidden, badge, floating, windows
BarScratchpadtypecompact, id, name, focused, revealed, visible, windows
BarStyletypeheight, labels, backgrounds, accents, inactive, position, vertical, notch, notchWidth, level, offsetX, offsetY, autoHide, reveal, opacity, transparent, solidBlack, accentColor, textColor, statsButton, secureInput, previews, hideInFullscreen
BarWindowtypeid, title, focused, hidden
BarWorkspacetypeid, name, focused, windows
Bluetoothtypepower, access, devices
BluetoothDevicetypeid, name, kind, connected, battery, left, right, case
Calendartypeaccess, events, month
CalendarEventtypeid, title, calendar, color, start, end, allDay, location, time, day
CalendarMonthtypetitle, year, month, days, offset, today, weekdays, marked
Clicktype
Colortype
ComponentActivitytypepriority, since, label, views, alert
ComponentCatalogEntrytypewidget, title, icon, views, options, source, overrides, error
ComponentInfotypeid, widget, title, enabled, options, status, error
ComponentInstancetypeid, widget, options, state, provider
ComponentOptiontypetype, title, default, min, max, step, maxLength, choices
ComponentPropstypeid, view, props
ComponentValuetype
ConfigCallbacktype
ConfigResulttypeok, id, revision, error
Contexttypedata, select, state, format, instance, view
Curvetype
Datatypeclock, date, seconds, cpu, memory, battery, charging, gpu, disk, network, volume, muted, vars, weather, workspace, app, bundle, title, workspaces, bar, settings, hiddenBar, system, outputs, audioApps, media, calendar, power, inputSource, privacy, wifi, bluetooth, user, thermal, networkHistory, appearance, lyrics, spectrum, tempo, island, components, catalog, settingsSchema, reminders, badges, menuApp
DesktopCallbacktype
DesktopResulttypeok, error, items
DragOutEventtypephase, operation
DropEventtypeitems, x, y
DropHoverEventtypephase, types
Elementtypekind
Entertypeopacity, scale, dx, dy, from, to, curve, stretch, d
Eventtypebutton, shift, option, control, command, dx, dy, precise, value, phase, x, y, clicks, vx, vy, committed, momentum, key, characters, text, focused, repeat
Fonttype
Formattypenumber, percent, bytes, date, offset
Gesturetypetrack, axis, source, threshold, lockDistance, dominance, commit
GestureRangetyperubber
HiddenBartypeenabled, available, rehide, items, maxWidth, maxHeight, cell, vertical, menu
HiddenBarItemtypeid, name, image, w, h
HiddenBarMenutypetitle, backID, rows
HiddenBarMenuRowtypeid, title, enabled, mark, shortcut, submenu, separator
HTTPRequesttypeurl, method, headers, body, response, maxBytes, timeout
HTTPResulttypeok, status, headers, text, json, bytes, error
IconPropstypeapp, window, pid, placeholder, color
ImagePropstypeimage, thumbnail, playing, speed
InputHandlertype
InputSourcetypeid, name, short, sources
InputSourceEntrytypeid, name, short
Islandtypedisplay, size, notch, menuBar, scale, main, visible, fullscreen, focused, drag, navigation
IslandNavigationtypeworkspace, name, layout, focused, windows
jsonnamespace
json.decodemember
json.encodemember
json.nullmember
Materialtype
Mediatypetitle, artist, album, app, bundle, pid, playing, duration, elapsed, rate, sampledAt, artwork, shuffle, repeatMode
Motiontype
omniwmnamespace
omniwm.aftermember
omniwm.assetmember
omniwm.clipboardnamespace
omniwm.clipboard.copymember
omniwm.clipboard.readmember
omniwm.componentsnamespace
omniwm.components.activitymember
omniwm.components.addmember
omniwm.components.enablemember
omniwm.components.movemember
omniwm.components.removemember
omniwm.components.setmember
omniwm.confignamespace
omniwm.config.setmember
omniwm.httpmember
omniwm.l10nmember
omniwm.logmember
omniwm.openmember
omniwm.pickmember
omniwm.providernamespace
omniwm.provider.sendmember
omniwm.quicklookmember
omniwm.resourcesnamespace
omniwm.resources.persistmember
omniwm.resources.restoremember
omniwm.revealmember
omniwm.runmember
omniwm.sharemember
omniwm.storenamespace
omniwm.store.getmember
omniwm.store.setmember
omniwm.store.statusmember
PathPropstyped, viewBox, evenOdd
Powertypesource, remaining, full, charged, lowPower, cycles, health, temperature, watts, adapter
Presencetypeopacity, scale, dx, dy, animate
ProgressPropstypevalue, color
Propstypeaccepts, onDrop, onDropHover, dragItems, onDragOut, appear, exit, key, rotate, loop, trail, w, h, grow, gap, pad, center, fill, material, blurRadius, saturation, bridge, attach, open, close, enter, mask, border, borderWidth, radius, opacity, hover, hoverScale, hoverOpacity, help, animate, hoverAnimate, hoverMaterial, onClick, onRightClick, onScroll, onPress, pressScale, pressOpacity, pressFill, pressAnimate, onHover, hoverDelay, hoverGrace, gesture, onGesture, gestureEvents, scrollMomentum, focusable, focusRing, keys, onKey, onOutsidePress, popout, align, dx, dy, scale, shadow, shadowRadius, target, menu, preview, drag, drop, scroll
ProviderEventtypekind, name, value
ProviderResulttypefiles, ok, value, error
ProviderStatetypestatus, error, exitCode, state
Remindertypeid, title, list, color, due, allDay, priority, canComplete
Reminderstypeaccess, items, total, truncated, error
Resourcetypeid, name, kind, uti, size, state, error, persistence
ResourceKindtype
ServiceHandletypecancel
ShaderPropstypesource, texture, values, fps, audio
SliderPropstypevalue, color, onChange
StoreStatustypestate, revision, committedRevision, error
SymbolPropstypename, size, weight, color
Systemtypememory, disk, uptime, host, displays
SystemDisplaytypew, h, hz
TextInputPropstypekey, text, placeholder, multiline, maxLength, focus, style, font, size, weight, color, onChange, onCommit, onCancel, onFocus
TextPropstypetext, style, font, filled, size, weight, maxWidth, lines, color, reserve
TextStyletype
TriggerEventtypesource, name, value
uinamespace
ui.boxmember
ui.columnmember
ui.componentmember
ui.iconmember
ui.imagemember
ui.inputmember
ui.pathmember
ui.popoutmember
ui.progressmember
ui.rowmember
ui.shadermember
ui.slidermember
ui.stackmember
ui.symbolmember
ui.textmember
Weathertypetemp, feels, high, low, rain, wind, humidity, sunrise, sunset, code, day, unit, condition, symbol, place, status, hours, days
WeatherDaytypetime, code, label, high, low, condition, symbol, rain
WeatherHourtypetime, code, label, temp, condition, symbol, day, rain
Weighttype
WiFitypepower, connected, ssid, rssi, band, channel, security, location
Workspacetypeid, name, focused, visible, windows