Skip to content

Latest commit

 

History

History
61 lines (37 loc) · 3.39 KB

README.md

File metadata and controls

61 lines (37 loc) · 3.39 KB
Raw

Turbo Native for iOS

Build high-fidelity hybrid apps with native navigation and a single shared web view. Turbo Native for iOS provides the tooling to wrap your Turbo 7-enabled web app in a native iOS shell. It manages a single WKWebView instance across multiple view controllers, giving you native navigation UI with all the client-side performance benefits of Turbo.

Features

  • Deliver fast, efficient hybrid apps. Avoid reloading JavaScript and CSS. Save memory by sharing one WKWebView.
  • Reuse mobile web views across platforms. Create your views once, on the server, in HTML. Deploy them to iOS, Android, and mobile browsers simultaneously. Ship new features without waiting on App Store approval.
  • Enhance web views with native UI. Navigate web views using native patterns. Augment web UI with native controls.
  • Produce large apps with small teams. Achieve baseline HTML coverage for free. Upgrade to native views as needed.

Requirements

Turbo iOS is written in Swift 5.3 and requires iOS 14 or higher. It supports web apps using either Turbo 7 or Turbolinks 5. The Turbo iOS framework has no dependencies.

Note: You should understand how Turbo works with web applications in the browser before attempting to use Turbo iOS. See the Turbo 7 documentation for details.

import { Turbo } from "@hotwired/turbo-rails"

Make sure your web app sets the window.Turbo global variable as it's required by the native apps (set automatically by turbo-rails).

Getting Started

The best way to get started with Turbo iOS to try out the demo app first to get familiar with the framework. The demo app walks you through all the basic Turbo flows as well as some advanced features. To run the demo, clone this repo and open Demo/Demo.xcodeproj in Xcode and run the Demo target. See Demo/README.md for more details about the demo. When you’re ready to start your own application, read through the rest of the documentation.

Installation

Add Turbo as a dependency through Xcode or directly to a Package.swift:

.package(url: "https://github.com/hotwired/turbo-ios", from: "<latest-version>")

You can also integrate the framework manually if your prefer, such as by adding the repo as a submodule, and linking Turbo.framework to your project.

Documentation

Contributing

Read the contributing guide to learn how to set up your development environment.

Turbo iOS is open-source software, freely distributable under the terms of an MIT-style license. The source code is hosted on GitHub. Development is sponsored by 37signals.

We welcome contributions in the form of bug reports, pull requests, or thoughtful discussions in the GitHub issue tracker.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

© 2023 37signals LLC