# RyUI

> Build iOS and Android apps in Go. RyUI renders with each platform's own widgets, UIKit and Material 3, updated by fine-grained signals, with live reload on your phone and builds for the App Store and Google Play.

Individual Markdown pages are listed below. All documentation is also available at https://ryui.egoist.dev/llms-full.txt.

## Documentation

- [RyUI documentation](https://ryui.egoist.dev/docs.md): RyUI makes native iOS and Android apps in Go. An app's interface is Go functions that return views; RyUI shows them with each platform's own widgets (UIKit on iOS, Android Views and Material 3 on Android), and updates only the views that read a signal when it changes.
- [Accessibility](https://ryui.egoist.dev/docs/accessibility.md): RyUI shows the platform's own widgets, so most of what VoiceOver, TalkBack and the text size settings need is there without code. This page covers what you get for free, and the props for the rest: labels, roles, grouping, custom actions, adjustable views, announcements, text size and Reduce Motion, and how to test it.
- [Components](https://ryui.egoist.dev/docs/components.md): A component is a Go function that returns a ui.Node. This page covers the views package ui gives you, grouped by what they do, and the packages next to it for Markdown and SVG. Each one is the platform's own widget where the platform has one (UIKit on iOS, Material 3 on Android). How views are sized and placed is in Layout; screens, tabs and sheets are in Navigation.
- [Concepts](https://ryui.egoist.dev/docs/concepts.md): A RyUI app is Go functions that build its views once, and signals that hold its state. This page covers how they fit: the root component, signals and what they update, showing and repeating views, owners and cleanup, the main thread, and the environment.
- [Data](https://ryui.egoist.dev/docs/data.md): An app keeps its data in a few places: small values in ryui/store, records in SQLite with ryui/sqlite, secrets in the platform's keychain with ryui/secure, and files of its own with Go's os. This page covers each, the network through net/http, and which calls may block the main thread.
- [Development](https://ryui.egoist.dev/docs/development.md): ryui dev runs an app on the iOS simulator or an Android emulator or phone, and reloads it as you save. This page covers how it does that, what a reload keeps, devices, assets and logs, what it can't reload, the problems you may meet, and RyUI's own GUI tests and benchmarks.
- [Device and services](https://ryui.egoist.dev/docs/device.md): RyUI's packages reach what the phone has beyond views: the camera, codes, photos, location, notifications, sound, the network's state, the shared library, work in the background, shares from other apps and JavaScript. This page covers each package: what it does, its API, the permissions it brings and how it behaves on each platform.
- [Getting started](https://ryui.egoist.dev/docs/getting-started.md): RyUI needs Go and each platform's own tools. Then one command makes an app, and another runs it, reloading as you save.
- [Layout and style](https://ryui.egoist.dev/docs/layout.md): A ui.Style says how a view is laid out and how it looks. Layout is CSS flexbox, in points; the look is colors, corners, borders, shadows and text. This page covers both, and styles that change.
- [Motion and gestures](https://ryui.egoist.dev/docs/motion.md): RyUI animates with each platform's own machinery: UIView animations on iOS, animators on Android. You change state inside ui.Animate, and what that change moves on screen animates. This page covers animating changes, transitions in and out, shared elements, frame-driven animation, gestures, haptics and Reduce Motion.
- [Native code](https://ryui.egoist.dev/docs/native.md): An app can bring Swift and Kotlin of its own: native views, shown in Go with ui.Native, and native modules, whose methods Go calls with ui.Call. This page covers both, on each platform, with a complete example.
- [Navigation](https://ryui.egoist.dev/docs/navigation.md): An app's structure is made of stacks of screens, tabs, sheets, alerts and menus. Each one is the platform's own: a UINavigationController on iOS, a top app bar with Material transitions and predictive back on Android. This page covers them, along with the back gesture, and the links and shares that open the app. examples/navigation has all of them.
- [What RyUI has, against SwiftUI and Expo](https://ryui.egoist.dev/docs/parity.md): Each row is something apps often need: how SwiftUI and Expo do it, and what RyUI has for it.
- [Shipping](https://ryui.egoist.dev/docs/shipping.md): ryui build makes the builds the stores take, from the app's directory (or the one given), into its dist.