|
| 1 | +# Change Log |
| 2 | + |
| 3 | +All notable changes to this project will be documented in this file starting with v0.8.6. |
| 4 | +This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0. |
| 5 | + |
| 6 | +Changes are grouped as follows: |
| 7 | +- **Added** for new features. |
| 8 | +- **Changed** for changes in existing functionality. |
| 9 | +- **Deprecated** for once-stable features to be removed in upcoming releases. |
| 10 | +- **Removed** for deprecated features removed in this release. |
| 11 | +- **Fixed** for any bug fixes. |
| 12 | +- **Security** to invite users to upgrade in case of vulnerabilities. |
| 13 | + |
| 14 | +<!-- |
| 15 | +Whitespace conventions: |
| 16 | +- 4 spaces before ## titles |
| 17 | +- 2 spaces before ### titles |
| 18 | +- 1 spaces before normal text |
| 19 | + --> |
| 20 | + |
| 21 | +## [0.12.0] - Unreleased |
| 22 | + |
| 23 | +### Added |
| 24 | + |
| 25 | +- `React::Server` is provided as a module wrapping the original `ReactDOMServer` API, require `react/server` to use it. (#186) |
| 26 | +- `React::Config` is introduced, `environment` is the only config option provided for now. See [#204](https://github.com/ruby-hyperloop/hyper-react/issues/204) for usage details. |
| 27 | + |
| 28 | +### Changed |
| 29 | + |
| 30 | +- State syntax is now consistent with Hyperloop::Store, old syntax is deprecated. (#209, #97) |
| 31 | + |
| 32 | +### Deprecated |
| 33 | + |
| 34 | +- Current ref callback behavior is deprecated. Require `"react/ref_callback"` to get the updated behavior. (#188) |
| 35 | +- `Hyperstack::Component::ReactAPI.render_to_string` & `Hyperstack::Component::ReactAPI.render_to_static_markup` is deprecated, use `React::Server.render_to_string` & `React::Server.render_to_static_markup` instead. (#186) |
| 36 | +- `react/react-source` is deprecated, use `react/react-source-browser` or `react/react-source-server` instead. For most usecase, `react/react-source-browser` is sufficient. If you are using the built-in server side rendering feature, the actual `ReactDOMServer` is already provided by the `react-rails` gem. Therefore, unless you are building a custom server side rendering mechanism, it's not suggested to use `react/react-source-server` in browser code. (#186) |
| 37 | + |
| 38 | +### Removed |
| 39 | + |
| 40 | +- `react-latest` & `react-v1x` is removed. Use `react/react-source-browser` or `react/react-source-server` instead. |
| 41 | +- Support for Ruby < 2.0 is removed. (#201) |
| 42 | + |
| 43 | +### Fixed |
| 44 | + |
| 45 | +- [NativeLibrary] Passing native JS object as props will raise exception. (#195) |
| 46 | +- Returns better error message if result of rendering block is not suitable (#207) |
| 47 | +- Batch all state changes and execute *after* rendering cycle (#206, #178) (Code is now moved to Hyper::Store) |
| 48 | + You can revert to the old behavior by defining the `React::State::ALWAYS_UPDATE_STATE_AFTER_RENDER = false` |
| 49 | +- Memory Leak in render context fixed (#192) |
| 50 | + |
| 51 | + |
| 52 | +## [0.11.0] - 2016-12-13 |
| 53 | + |
| 54 | +### Changed |
| 55 | + |
| 56 | +- The whole opal-activesuppport is not loaded by default now. This gave us about 18% size reduction on the built file. If your code rely on any of the module which is not required by hyper-react, you need to require it yourself. (#135) |
| 57 | + |
| 58 | +### Deprecated |
| 59 | + |
| 60 | +- Current `Hyperstack::Component::ReactAPI.render` behavior is deprecated. Require `"react/top_level_render"` to get the updated behavior. (#187) |
| 61 | +- `React.is_valid_element` is deprecated in favor of `Hyperstack::Component::ReactAPI.is_valid_element?`. |
| 62 | +- `expect(component).to render('<div />')` is now deprecated in favor of `expect(component).to render_static_html('<div />')`, which is much clearer. |
| 63 | + |
| 64 | +### Fixed |
| 65 | + |
| 66 | +- `ReferenceError: window is not defined` error in prerender context with react-rails v1.10.0. (#196) |
| 67 | +- State might not be updated using `React::Observable` from a param. (#175) |
| 68 | +- Arity checking failed for `_react_param_conversion` & `React::Element#initialize` (#167) |
| 69 | + |
| 70 | + |
| 71 | +## [0.10.0] - 2016-10-30 |
| 72 | + |
| 73 | +### Changed |
| 74 | + |
| 75 | +- This gem is now renamed to `hyper-react`, see [UPGRADING](UPGRADING.md) for details. |
| 76 | + |
| 77 | +### Fixed |
| 78 | + |
| 79 | +- ReactJS functional stateless component could not be imported from `NativeLibrary`. Note that functional component is only supported in React v14+. (#162) |
| 80 | +- Prerender log got accumulated between reqeusts. (#176) |
| 81 | + |
| 82 | +## [0.9.0] - 2016-10-19 |
| 83 | + |
| 84 | +### Added |
| 85 | + |
| 86 | +- `react/react-source` is the suggested way to include ReactJS sources now. Simply require `react/react-source` immediately before the `require "reactrb"` in your Opal code will make it work. |
| 87 | + |
| 88 | +### Deprecated |
| 89 | + |
| 90 | +- `react-latest` & `react-v1x` is deprecated. Use `react/react-source` instead. |
| 91 | + |
| 92 | +### Removed |
| 93 | + |
| 94 | +- `opal-browser` is removed from runtime dependency. (#133) You will have to add `gem 'opal-browser'` to your gemfile (recommended) or remove all references to opal-browser from your manifest files. |
| 95 | + |
| 96 | +### Fixed |
| 97 | + |
| 98 | +- `$window#on` in `opal-jquery` is broken. (#166) |
| 99 | +- `Element#render` trigger unnecessary re-mounts when called multiple times. (#170) |
| 100 | +- Gets rid of react warnings about updating state during render (#155) |
| 101 | +- Multiple HAML classes (i.e. div.foo.bar) was not working (regression introduced in 0.8.8) |
| 102 | +- Don't send nil (null) to form components as the value string (#157) |
| 103 | +- Process `params` (props) correctly when using `Element#on` or `Element#render` (#158) |
| 104 | +- Deprecate shallow param compare (#156) |
| 105 | + |
| 106 | + |
| 107 | +## [0.8.8] - 2016-07-13 |
| 108 | + |
| 109 | +### Added |
| 110 | + |
| 111 | +- More helpful error messages on render failures (#152) |
| 112 | +- `Element#on('<my_event_name>')` subscribes to `my_event_name` (#153) |
| 113 | + |
| 114 | +### Changed |
| 115 | + |
| 116 | +- `Element#on(:event)` subscribes to `on_event` for reactrb components and `onEvent` for native components. (#153) |
| 117 | + |
| 118 | +### Deprecated |
| 119 | + |
| 120 | +- `Element#on(:event)` subscription to `_onEvent` is deprecated. Once you have changed params named `_on...` to `on_...` you can `require 'reactrb/new-event-name-convention.rb'` to avoid spurious react warning messages. (#153) |
| 121 | + |
| 122 | + |
| 123 | +### Fixed |
| 124 | + |
| 125 | +- The `Element['#container'].render...` method generates a spurious react error (#154) |
| 126 | + |
| 127 | + |
| 128 | + |
| 129 | + |
| 130 | +## [0.8.7] - 2016-07-08 |
| 131 | + |
| 132 | + |
| 133 | +### Fixed |
| 134 | + |
| 135 | +- Opal 0.10.x compatibility |
| 136 | + |
| 137 | + |
| 138 | +## [0.8.6] - 2016-06-30 |
| 139 | + |
| 140 | + |
| 141 | +### Fixed |
| 142 | + |
| 143 | +- Method missing within a component was being reported as `incorrect const name` (#151) |
0 commit comments