Reference
Every exported component and public API entry point is indexed here. Pages include authored details when available and are discovered from the AppKit and UIKit Lua modules.
| Component | Summary |
|---|---|
| Alert | Presents a native alert and returns the selected response. |
| applicationSupportDirectory | The app's own folder in Application Support (name is one path |
| Arc | Draws a circular arc in screen coordinates. |
| bookmark | A security-scoped bookmark for path, as text to store; nil and a |
| Button | A push button backed by a native button control. |
| CodeView | Displays source in a read-only native text view. |
| Color | Resolves a semantic name ("primary", "accent") or #RRGGBB hex to a color. |
| ColorPicker | Selects a color using the platform color control. |
| ContentUnavailable | Presents a native empty, unavailable, or no-results state. |
| ControlGroup | Groups related controls into a compact row. |
| copyToClipboard | Puts text on the general pasteboard, as AppKit.copyToClipboard does. |
| Curve | Renders a data-driven curve in a native drawing surface. |
| DatePicker | Selects a date or time value. |
| DisclosureGroup | Shows a header that expands or collapses its child content. |
| Divider | Draws a horizontal or vertical native divider. |
| FlowStack | Wraps child views into additional rows or columns as space runs out. |
| Font | Resolves a font value for assignment to a text view's font. |
| ForEach | ForEach API entry point. |
| Form | Arranges controls as a settings or data-entry form. |
| Gauge | Shows a value within a range as a read-only capacity bar. |
| GlassEffect | Embeds a view in the current system glass effect. |
| GlassEffectContainer | Groups nearby native glass surfaces into one system effect. |
| Grid | Aligns child views into rows and columns. |
| Group | Group API entry point. |
| GroupBox | Groups related controls inside a titled native box. |
| homeDirectory | The person's home folder, from the user database. Inside the App |
| HostingController | HostingController API entry point. |
| HSplit | Places panes side by side in a native split view. |
| HStack | Arranges child views horizontally with sibling spacing. |
| Image | Displays a raster or vector image asset. |
| Label | Combines an icon and title in a standard platform label. |
| LabeledContent | Pairs a descriptive label with its value or child controls. |
| latestEventId | The newest file system event ID; store it and pass it as since later. |
| Layout | Layout API entry point. |
| LazyVGrid | A vertical grid that builds cells only as they scroll into view. |
| LazyVStack | A vertical stack that builds rows only as they scroll into view. |
| LinearGradient | Fills content with a linear gradient, as SwiftUI's LinearGradient. |
| Link | Opens or navigates to a destination when activated. |
| List | Displays rows of data in a native table or list control. |
| MaterialView | Displays content using a native visual material. |
| Menu | Presents commands in a native pop-up menu. |
| MeshGradient | Renders a native animated color mesh from a grid of control points. |
| NavigationLink | Navigates to a destination within a navigation stack. |
| NavigationStack | Manages a stack of screens and navigation transitions. |
| OutlineGroup | Builds a nested disclosure hierarchy from tree data. |
| OutlineView | Displays hierarchical rows in a native outline control. |
| Page | A navigation destination: one content view plus its title, toolbar items |
| PageControl | Page dots, as UIPageControl draws them; AppKit has no such class. |
| Panel | Creates a floating utility panel with native AppKit panel behavior. |
| Paragraph | Long-form prose set as a book sets it: selectable text with explicit |
| parsePropertyList | Parses property-list text or data, such as diskutil -plist output; nil when invalid. |
| PathView | Displays a filesystem path as a navigable or inspectable view. |
| Picker | Selects one value from a set of options. |
| pickFile | The standard open panel for one file; returns its path or nil. |
| pickFolder | The standard open panel for one folder; returns its path or nil. |
| PointerView | A transparent view reporting clicks and hover positions. |
| Preview | Creates a fixed-size preview root for the IDE canvas. |
| ProgressStart | ProgressStart API entry point. |
| ProgressStop | ProgressStop API entry point. |
| ProgressView | Shows determinate or indeterminate progress. |
| resolveBookmark | Resolves a bookmark from AppKit.bookmark: the item's current path and |
| SafeAreaInset | Pins the second child to a safe-area edge while the first child uses the remaining space. |
| sceneGraph | Reconciles a SceneView's graph with new Node, Camera and Light records. |
| SceneView | Displays a SceneKit scene described by Node, Camera and Light records. |
| ScrollView | Adds native scrolling around one content view. |
| SearchField | Provides native search input and search-specific behavior. |
| Section | Groups related content and may display a header. |
| SectorChart | Draws a pie or donut chart from SectorMark records (SwiftUI Charts). |
| Separator | Draws a native separator between adjacent content. |
| setCommands | Installs the application menu bar from a <Commands> spec: standard |
| ShaderView | Draws a Metal fragment shader every display frame, like SwiftUI's |
| Sheet | Creates a sheet window for presentation from a parent window. |
| showWindow | Shows a window again after window:hide(), making it key; like the |
| Slider | Selects a numeric value within a continuous range. |
| Spacer | Consumes flexible space between neighboring views. |
| Stepper | Increments or decrements a numeric value. |
| SwipeRow | A native swipeable table row that can sit inside a VStack or another stack. |
| SystemImage | Displays an SF Symbol using the platform image system. |
| TabView | Presents mutually exclusive content in native tabs. |
| Text | A view that displays one or more lines of read-only text. |
| TextEditor | Edits multiline text. |
| TextField | Edits a single line of text. |
| TimelineView | Hosts content on the requested update schedule. |
| Title | Displays prominent window or section title text. |
| Toggle | Represents an on/off value with a native switch or checkbox. |
| ToolbarItem | Creates or retrieves an item in a window toolbar. |
| ToolbarProgress | ToolbarProgress API entry point. |
| Treemap | Draws a squarified treemap from TreemapNode records. |
| uptime | Seconds of monotonic system time, for measuring real intervals: a |
| volumeCapacity | Returns the volume's capacities in bytes: total, available (free), |
| VSplit | Places panes vertically in a native split view. |
| VStack | A view that arranges its subviews in a vertical line. |
| watch | Watches files or directory trees for changes (FSEvents). |
| Waveform | Draws a sound file's waveform under a tempo grid, with WaveformMarker |
| waveformMarkers | Gives a waveform new WaveformMarker records in place. |
| WebView | Displays a native WKWebView and optionally binds it to a WebPage. |
| Window | Creates the app window and hosts the rendered root view. |
| ZStack | Layers child views in the same coordinate area. |