Skip to content

Latest commit

 

History

History
48 lines (31 loc) · 3.32 KB

README.md

File metadata and controls

48 lines (31 loc) · 3.32 KB
Raw

Turbo Native for Android

Note: The Hotwire frameworks are presented in beta form. We're using them all in production with HEY, but expect that significant changes might be made in response to early feedback. ✌️❤️

Build high-fidelity hybrid apps with native navigation and a single shared web view. Turbo Native for Android provides the tooling to wrap your Turbo 7-enabled web app in a native Android shell. It manages a single WebView instance across multiple Fragment destinations, 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 WebView.
  • 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 Play 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

  1. Android SDK 24+ is required as the minSdkVersion in your build.gradle.
  2. This library is written entirely in Kotlin, and your app should use Kotlin as well. Compatibility with Java is not provided or supported.
  3. This library supports web apps using either Turbo 7 or Turbolinks 5.
  4. Turbo (or Turbolinks) is exposed on the window object on the WebView page being loaded.

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

Getting Started

The best way to get started with Turbo Android is 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, open the directory in Android Studio, and build the demo module to your Android device. 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.

See the instructions to build the project yourself.

Documentation

  1. Installation
  2. Overview
  3. Quick Start
  4. Path Configuration
  5. Navigation
  6. Advanced Options

Contributing

Turbo Android 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 Basecamp.

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.

© 2020 Basecamp, LLC