Skip to content
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions docs/api-reference/configuration-deprecated.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Deprecated Configuration Options

This document lists configuration options that have been deprecated or removed from React on Rails.

For current configuration options, see [configuration.md](configuration.md).

## Removed Options

### immediate_hydration

**Status:** ⚠️ REMOVED in v17.0

This configuration option has been removed. Immediate hydration is now automatically enabled for Pro users and disabled for non-Pro users.

**Migration:** Remove any `config.immediate_hydration` lines from your configuration. Use per-component overrides if needed:

```ruby
# Pro users can disable for specific components:
react_component("MyComponent", immediate_hydration: false)

# Non-Pro users: immediate_hydration is ignored
```

See [CHANGELOG.md](../CHANGELOG.md) for details.

## Deprecated Options

### defer_generated_component_packs

**Type:** Boolean
**Default:** `false`
**Status:** ⚠️ DEPRECATED

**Deprecated:** Use `generated_component_packs_loading_strategy = :defer` instead.

**Migration:**

```ruby
# Old (deprecated):
config.defer_generated_component_packs = true

# New:
config.generated_component_packs_loading_strategy = :defer
```

See the [16.0.0 Release Notes](../upgrading/release-notes/16.0.0.md) for more details.

## Need Help?

- **Documentation:** [React on Rails Guides](https://www.shakacode.com/react-on-rails/docs/)
- **Support:** [ShakaCode Forum](https://forum.shakacode.com/)
- **Consulting:** [justin@shakacode.com](mailto:justin@shakacode.com)
40 changes: 40 additions & 0 deletions docs/api-reference/configuration-pro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# React on Rails Pro Configuration Options

This document describes configuration options specific to React on Rails Pro features.

For general React on Rails configuration options, see [configuration.md](configuration.md).

## React Server Components (RSC)

React Server Components and Streaming SSR are React on Rails Pro features.

For detailed configuration of RSC and streaming features, see the Pro package documentation:
[react_on_rails_pro/docs/configuration.md](https://github.com/shakacode/react_on_rails/blob/master/react_on_rails_pro/docs/configuration.md)

### Key Pro Configurations

These options are configured in the `ReactOnRailsPro.configure` block:

- `rsc_bundle_js_file` - Path to RSC bundle
- `react_client_manifest_file` - Client component manifest for RSC
- `react_server_client_manifest_file` - Server manifest for RSC
- `enable_rsc_support` - Enable React Server Components

### Example Configuration

```ruby
# config/initializers/react_on_rails_pro.rb
ReactOnRailsPro.configure do |config|
config.rsc_bundle_js_file = "rsc-bundle.js"
config.react_client_manifest_file = "client-manifest.json"
config.react_server_client_manifest_file = "server-manifest.json"
config.enable_rsc_support = true
end
```

See the Pro documentation for complete setup instructions.

## Need Help?

- **Pro Features:** [React on Rails Pro](https://www.shakacode.com/react-on-rails-pro/)
- **Consulting:** [justin@shakacode.com](mailto:justin@shakacode.com)
Loading
Loading