Documentation

Learn how to get the most out of Ruby Native. These guides cover common features you can add after your first preview.

Try Ruby Native

#Getting started

  • Setup - configure your app and layout
  • Tabs - tab bar, eager loading, and tab routing
  • Icons - SF Symbols on iOS and Material Symbols on Android
  • Navigation bar - native navbar with buttons, menus, and submit buttons
  • Form handling - skip form pages when navigating back
  • Keyboard - hide the iOS toolbar above the keyboard
  • Inertia (React & Vue) - setup for apps using React or Vue instead of ERB

#More features

  • Appearance - colors, dark mode, edge-to-edge content, and landscape orientation
  • Error screen - customize and translate the offline and error fallback screens
  • Authentication - keep sessions alive for native users
  • OAuth - sign in with Google, GitHub, and other providers
  • Linked domains - tap-to-open in app and password autofill (iOS)
  • Back buttons - add native back navigation with a single CSS class
  • Root pages - land a page with nothing behind it and no back button
  • Floating action button - native FAB above the tab bar
  • Menus - attach native menus to any element on the page
  • Barcode scanner - scan QR codes and barcodes with the device camera
  • Haptics - trigger device vibrations on user interaction
  • Push notifications - request permission, register tokens, and send notifications
  • Badges - update app icon and tab bar badges from page loads
  • Toasts - show flash notices as native toasts
  • In-app review - ask for an App Store or Google Play rating in-app
  • In-app purchases - sell subscriptions through StoreKit
  • Permissions - camera, photo library, and microphone access
  • Screenshots - capture phone screenshots for both stores from one flow
  • CLI - deploy builds and auto-deploy from CI

#Native screen transitions

Want push/pop animations and swipe-to-go-back between screens? Advanced Mode adds native navigation transitions on top of everything above. No extra JavaScript or dependencies, just a one-line change in config/ruby_native.yml.

#iOS

The iOS guides cover enrolling in the Apple Developer Program, setting up App Store Connect, and the credentials Ruby Native needs to build your app.

#Android

The Android guides cover creating your Google Play Developer account, connecting Play Console, and internal testing.

#Go live

Ready to ship? The pre-flight checklists for the App Store and Google Play cover payments, privacy questionnaires, store listings, and review.