react-on-rails
Advanced tools
react-on-rails - npm Package Compare versions
Comparing version 4.0.0-beta.1 to 4.0.0-beta.2
@@ -10,8 +10,15 @@ # Change Log | ||
| - Added controller `module ReactOnRails::Controller`. Adds method `redux_store` to setup redux stores in the view. | ||
| - Added option `defer: true` for view helper `redux_store`. This allows the view helper to specify the props for store hydration, yet still render the props at the bottom of the view. | ||
| - Added view helper `redux_store_hydration_data` to render the props on the application's layout, near the bottom. This allows for the client hydration data to be parsed after the server rendering, which may result in a faster load time. | ||
| - Added helpers `env_stylesheet_link_tag` and `env_javascript_include_tag` to support hot reloading Rails. See the [README.md](./README.md) for more details and see the example application in `spec/dummy`. | ||
| - The checker for outdated bundles before running tests will default to including the directory with `server_bundle_js_file`. | ||
| - Better support for Turbolinks 5! | ||
| - Fixed generator check of uncommitted code for foreign languages. See [#303](https://github.com/shakacode/react_on_rails/pull/303) by [nmatyukov](https://github.com/nmatyukov). | ||
| - Added several parameters used for ensuring webpack assets are built for running tests: | ||
| - `config.generated_assets_dir`: Directory where your generated webpack assets go. You can have only **one** directory for this. | ||
| - `config.webpack_generated_files`: List of files that will get created in the `generated_assets_dir`. The test runner helper will ensure these generated files are newer than any of the files in the client directory. | ||
| ##### Changed | ||
| - Generator default for webpack generated assets is now `app/assets/webpack` as we use this for both JavaScript and CSS generated assets. | ||
| ##### Fixed | ||
| - The test runner assets up to date checker might see only the server rendering file, and assume that all assets are up to date. | ||
| - The test runner assets up to date checker is greatly improved. | ||
| - Lots of doc updates! | ||
@@ -21,4 +28,5 @@ - Improved the **spec/dummy** sample app so that it supports CSS modules, hot reloading, etc, and it can server as a template for a new ReactOnRails installation. | ||
| ##### Breaking Changes | ||
| - Deprecated `redux_store` called from views. Call this method from your controller actions and place `redux_store_hydration_data` on your layout, near the bottom. | ||
| - Removed the config default of the `config.server_bundle_js_file`. The default is blank, meaning no server rendering. | ||
| - Deprecated calling `redux_store(store_name, props)`. The API has changed. Use `redux_store(store_name, props: props, defer: false)` A new option called `defer` allows the rendering of store hydration at the bottom of the your layout. Place `redux_store_hydration_data` on your layout. | ||
| - `config.server_bundle_js_file` has changed. The default value is now blank, meaning no server rendering. Addtionally, if you specify the file name, you should not include the path, as that should be specified in the `config.generated_assets_dir`. | ||
| - `config.generated_assets_dirs` has been renamed to `config.generated_assets_dir` (singular) and it only takes one directory. | ||
@@ -25,0 +33,0 @@ |
@@ -90,8 +90,3 @@ 'use strict'; | ||
| var trace = JSON.parse(el.getAttribute('data-trace')); | ||
| var expectTurboLinks = JSON.parse(el.getAttribute('data-expect-turbo-links')); | ||
| if (!turbolinksInstalled() && expectTurboLinks) { | ||
| console.warn('WARNING: NO TurboLinks detected in JS, but it is in your Gemfile'); | ||
| } | ||
| try { | ||
@@ -98,0 +93,0 @@ var domNode = document.getElementById(domNodeId); |
| { | ||
| "name": "react-on-rails", | ||
| "version": "4.0.0-beta.1", | ||
| "version": "4.0.0-beta.2", | ||
| "description": "react-on-rails JavaScript for react_on_rails Ruby gem", | ||
@@ -50,3 +50,2 @@ "main": "node_package/lib/ReactOnRails.js", | ||
| "clean": "node_package/scripts/clean", | ||
| "symlink-node-package": "node_package/scripts/symlink-node-package", | ||
| "prepublish": "npm run build", | ||
@@ -53,0 +52,0 @@ "build": "node_package/scripts/build", |
| [](https://travis-ci.org/shakacode/react_on_rails) [](https://gemnasium.com/shakacode/react_on_rails) [](https://badge.fury.io/rb/react_on_rails) [](https://badge.fury.io/js/react-on-rails) [](https://codeclimate.com/github/shakacode/react_on_rails) [](https://coveralls.io/github/shakacode/react_on_rails?branch=master) | ||
| # NEWS | ||
| * 4.0.0 Highlights | ||
| * Better support for Turbolinks 5. | ||
| * Controller rendering of shared redux stores. | ||
| * 2016-02-28: We added a [Projects page](PROJECTS.md). Please edit the page your project or [email us](mailto:contact@shakacode.com) and we'll add you. We also love stars as it helps us attract new users and contributors. [jbhatab](https://github.com/jbhatab) is leading an effort to ease the onboarding process for newbies with simpler project generators. See [#245](https://github.com/shakacode/react_on_rails/issues/245). | ||
@@ -174,3 +176,3 @@ * 3.0.6 shipped on Tuesday, 2016-03-01. Please see the [Changelog](CHANGELOG.md) for details, and let us know if you see any issues! [Migration steps from 1.x](https://github.com/shakacode/react_on_rails/blob/master/CHANGELOG.md#migration-steps-v1-to-v2). [Migration steps from 2.x](https://github.com/shakacode/react_on_rails/blob/master/CHANGELOG.md#migration-steps-v2-to-v3). | ||
| ## How it Works | ||
| The generator installs your webpack files in the `client` folder. Foreman uses webpack to compile your code and output the bundled results to `app/assets/javascripts/generated`, which are then loaded by sprockets. These generated bundle files have been added to your `.gitignore` for your convenience. | ||
| The generator installs your webpack files in the `client` folder. Foreman uses webpack to compile your code and output the bundled results to `app/assets/webpack`, which are then loaded by sprockets. These generated bundle files have been added to your `.gitignore` for your convenience. | ||
@@ -226,3 +228,3 @@ Inside your Rails views, you can now use the `react_component` helper method provided by React on Rails. You can pass props directly to the react component helper. You can also initialize a Redux store with view helper `redux_store` so that the store can be shared amongst multiple React components. Your best bet is to scan the code inside of the [/spec/dummy](spec/dummy) sample app. | ||
| ## ReactOnRails View Helpers API | ||
| Once the bundled files have been generated in your `app/assets/javascripts/generated` folder and you have exposed your components globally, you will want to run your code in your Rails views using the included helper method. | ||
| Once the bundled files have been generated in your `app/assets/webpack` folder and you have exposed your components globally, you will want to run your code in your Rails views using the included helper method. | ||
@@ -579,2 +581,7 @@ This is how you actually render the React components you exposed to `window` inside of `clientRegistration` (and `global` inside of `serverRegistration` if you are server rendering). | ||
| ## Dependencies | ||
| + Ruby 2.1 or greater | ||
| + Rails 3.2 or greater | ||
| + Node 5.5 or great | ||
| ## Contributing | ||
@@ -581,0 +588,0 @@ Bug reports and pull requests are welcome. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to our version of the [Contributor Covenant Code of Conduct](docs/code_of_conduct.md)). |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by1.34%
88166
- Number of lines in readme file
- increased by1.16%
609
Worsened metrics
- Lines of code
- decreased by-0.59%
678