Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yshmarov/hotwire_native_rails
A Hotwire Native generator for Rails applications
https://github.com/yshmarov/hotwire_native_rails
hotwire hotwire-native rails
Last synced: 1 day ago
JSON representation
A Hotwire Native generator for Rails applications
- Host: GitHub
- URL: https://github.com/yshmarov/hotwire_native_rails
- Owner: yshmarov
- License: mit
- Created: 2024-11-27T18:31:23.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-01-12T20:44:41.000Z (25 days ago)
- Last Synced: 2025-01-29T15:07:11.882Z (8 days ago)
- Topics: hotwire, hotwire-native, rails
- Language: Ruby
- Homepage: https://superails.com/playlists/turbo-native
- Size: 70.3 KB
- Stars: 90
- Watchers: 2
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Hotwire Native Rails generator
Power pack to make your Rails app [Hotwire Native](https://native.hotwired.dev)
## Installation
Install the gem:
```sh
bundle add hotwire_native_rails
```
Run the generator:
```sh
rails g hotwire_native
```
## Usage
Recommended to use with [my fork of iOS Hotwire Native starter app](https://github.com/yshmarov/hotwire-native-ios/tree/superails-extensions-2/Demo).
#### Helpers
- `viewport_meta_tag` - forbid zooming on mobile/native
- use `data: { turbo_action: replace_if_native }` to submit authentication forms & forms in modals
- `:mobile` request variant. `index.html+mobile.erb`
- override `link_to` to not open internal links in in-app browser on native app
- conditionally override page `` for native apps
#### CSS
- `hotwire-native:` css variant (works with CSS and Tailwind)
#### Bridge Components
- install Hotwire Native Bridge (works with Importmaps and Node)
- add default bridge components (`Form`, `Menu`, `Button`)
- add `Nav` (UIMenu) component
- add `Review Prompt` component
- `bridge_form_with` - easily apply Bridge `Form` component
#### Path Configuration
- `path_configuration_controller` for `ios` and `android`
- Tabs controller - re-route native tabs
## Development
Run the local version of the gem:
```ruby
gem 'hotwire_native_rails', path: '/Users/myusername/Documents/GitHub.nosync/hotwire_native_rails'
```
Make a release to rubygems:
```sh
# 1. update version in version.rb
# 2. zip the gem
gem build hotwire_native_rails.gemspec
# 3. push the zip to rubygems
gem push hotwire_native_rails-0.4.0.gem
```
- [Github source](https://github.com/yshmarov/hotwire_native_rails)
- [Rubygems source](https://rubygems.org/gems/hotwire_native_rails)