Skip to content

Latest commit

 

History

History
247 lines (146 loc) · 7.78 KB

CHANGELOG.md

File metadata and controls

247 lines (146 loc) · 7.78 KB
Raw

Change Log

2.2.1b - Add support for HTML minification using django-hmin

Added

  • New settings REACTOR_USE_HMIN (default: False) if enable and django-hmin is installed components will be rendered in minified HTML to save bandwidth.

2.2.0b - Improve serialization of forms

Changed

  • Building system now uses poetry
  • Compression of assets is with uglify-es
  • When serializing input[type=radio] it will read the value on the input and send it
  • When serializing input[type=checkbox] it will read the value of that input and add it to the list, or return false or true if it is checked

2.1.6b0 - Use orjson for serialization.

Added

  • Added a json.Encoder for backwards compatibility

2.1.5b0 - Use orjson for serialization.

Fixed

  • Fix not re-rendering and element when clicked

2.1.3b0 - Use orjson for serialization.

Added

  • :keep directive on an input will preserve the value of the input across renders

2.1.2b0 - Use orjson for serialization.

Changed

  • Started using orjson for serialization of JSON
  • Add better testing

2.1.1b0 - Allow the serializer to handle numpy.int types

Added

  • Now the JSONEncoder used can handle all the int types of numpy.

2.1.0b0 - Templates simplification and performance improvements

Changed

  • Performance improvements in the front-end using HTMLElement.closest to lookup parent component and form.
  • Performance improvements by using pysimdjson.
  • Rename Component.refresh -> Component._refresh.
  • Rename Component.build -> Component._build.
  • Rename Component.dispatch -> Component._dispatch.
  • Rename Component.update -> Component._update.
  • Rename Component.render -> Component._render.
  • Rename Component.render_diff -> Component._render_diff.
  • Rename Component.subscriptions -> Component._subcriptions.
  • Rename Component.refresh -> Component._refresh.
  • Now in the component template you don't need to use this, you can access directly members of the component that are public (that do not start with "_"). The this attribute will be removed in version 2.2.
  • As you can't us {{ this }} anymore, use {{ header }} instead.
  • When AuthComponent or StaffComponent detect an unauthorized user they do not send a redirect to the login URL, they just destroy themselves.
  • Removed :keep in favor of :override, if the user has the focus on an input reactor will not update it's value, add the directive :override replace what ever the user has there.

Added

  • Compnent._get_template loads the template from Component.template_names as it works in django generic views.
  • Component._get_context returns the context used to rendering the template.
  • Serialization of multi-select to send to the back-end.
  • Component.header returns the string to put on the head of the component.

Fixed

  • Now a component does not serialize the all it's children state, just it's direct state to send to the server.

2.0.0b0 - Changing the way reactor is loaded

Migration guide:

  • You will have to rewrite your project/asgi.py to something simpler:
import os

os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'tutorial.settings')

from reactor.asgi import get_asgi_application  # noqa

application = get_asgi_application()
  • The Reactor WebSocket URL changed from /reactor to /__reactor__.
  • You need to explicitly register the reactor URL in your project/urls.py:
from django.contrib import admin
from django.urls import path, include
from reactor.channels import ReactorConsumer

urlpatterns = [
    path('admin/', admin.site.urls),
]

websocket_urlpatterns = [
    # Temporal, to keep compatibility with old client while deploying
    path('reactor', ReactorConsumer),

    # Final URL, remove the previous one in the next deployment and use this one instead
    path('__reactor__', ReactorConsumer),
]
  • Now you can place your components in a live.py module inside your application.

Added

  • Auto-load of the live.py file in all Django installed applications, aiming to discover the Reactor components.
  • reactor.asgi.get_asgi_application that will load the WebSocket URLs from your project.urls.websocket_urlpatterns.

Removed

  • reactor.urls in favor of explicitly registering the URL where the Reactor consumer us.

Changed:

  • REACTOR_USE_HTML_DIFF is now enabled by default.

1.10.0b0 - Granular control over auto broadcast

Changed

  • The settings REACTOR_AUTO_BROADCAST can be a bool or a dict, if it is a bool it will enable/disable completely the auto broadcast of model changes. When a dict can be like:
AUTO_BROADCAST = {
    # model_a
    # model_a.del
    # model_a.new
    'MODEL': True,

    # model_a.1234
    'MODEL_PK': True,

    # model_b.1234.model_a_set
    # model_b.1234.model_a_set.new
    # model_b.1234.model_a_set.del
    'RELATED': True,

    # model_b.1234.model_a_set
    # model_a.1234.model_b_set
    'M2M': True,
}

Each key controls an specific broadcast type, if a keys is missing False is assumed.

  • Template directive :override is gone, use :keep to preserve the value of an input, select or textarea HTML element from render to render.

1.9.0b0 - Middleware for turbolinks

Added

  • Method Component.send_parent to send an event to the parent component.

Removed

  • Template filter tojson_safe, use piping of tojson into safe instead.

Changed

  • Template filter tojson now supports an integer argument corresponding to the indent parameter in json.dumps.
  • In the front-end there is the assumption that components IDs are unique, so this was also implemented as this in the back-end.

1.8.4b0 - Middleware for turbolinks

Added

1.8.3b0 - Syntax sugar

Added

  • Instead of writing <div is="x-component" id="{{ this.id }}" state="{{ this.serialize|tojson }}">, now you can do <div {{ this|safe }} >.

1.8.2b0 - Hot fix

Fixed

  • Fix missing transpilation when a DOM node was added

1.8.1b0 - DOM hooks

Added new reactor events

  • @reactor-added, when an HTML element is added
  • @reactor-updated, when an HTML element is updated

Changed

  • @reactor-init, is not triggered on any HTML element of a component when this one is initialized (appears for first time in the DOM).

1.8.0b0 - Bring back optional diffing using difflib

Added

  • New setting REACTOR_USE_HTML_DIFF (default: False), it will use difflib to send the HTML diff, is a line based diff not a character based one but is very fast, not like diff_match_patch

1.7.0b0 - Remove diffing, was very slow

Removed

  • Dependency on diff_match_patch had been removed, diffing was very very very slow.

1.6.1b0 - Numpy support

Added

  • Add capability to serializer numpy.array and numpy.float as the component state.

1.6.0b0 - Migration to Turbolinks

Added

  • REACTOR_INCLUDE_TURBOLINKS is a new setting, by default to False, when enabled will load Turbolinks as part of the reactor headers and the reactor redirects (Component.send_redirect) will use Turbolinks.visit. This also affects all the links in your application, check out the documentation of Turbolinks.

Removed

  • :load directive had been removed in favor of Tubolinks.

1.5.1b0 - Improve broadcasting with parameters

Added

  • Component.update(origin, type, **kwargs) is called when there is an update coming from broadcast and it receive whatever kwargs where passed to reactor.broadcast. You could override this method to handle the update in the way you want, the default behavior is to call Component.refresh.

Change

  • reactor.broadcast, now can receive parameters.