Getting started

Installation
Ensure you have Webpacker and React installed. Add the following to your Gemfile and run bundle
# Gemfile
gem 'superglue'
Run the installation generator
rails superglue:install:web
Generate a scaffold
rails generate scaffold post body:string --force --no-template-engine --superglue
Configuration
The rails superglue:install:web step adds a preconfigured entry point in app/javascript/packs/application.js.
Custom Reducers
The generator will also add a reducer.js file for any custom reducer you'd like to add. Included in the reducer is a pagesReducer for any cross-page optimistic updates, and a applicationRootReducer for the entire store. The latter is used for Redux Persist, which you can customize to your needs.
Custom Visit and Remote
The visit and remote thunks can be customized in app/javascript/packs/application_visit.js. Functionality like loading indicators can be added there.
Configuring Reloads
Superglue will do a hard reload whenever a successful response returns new asset fingerprints. Add an initializer to control how Superglue tracks Sprockets and Webpack assets:
# defaults
Superglue.configure do |config|
  config.track_sprockets_assets = ['application.js', 'application.css']
  config.track_pack_assets = ['application.js']
end

Demo Application

navigation

Last modified 7mo ago

Copy link

Outline

Installation

Configuration

Custom Reducers

Custom Visit and Remote

Configuring Reloads