Sprig

Changed

• Updated htmx to version 1.9.2 (changelog).
• Improved autocomplete documentation in the playground.

Fixed

• Fixed a bug in which the htmx file was not being published even if it did not already exist locally (#305).

Added

• Added the sprig.setConfig template variable that allows you to set configuration options for htmx (via a meta tag).
• Added the s-on attribute that allows you to respond to events directly on an element.

Changed

• Updated htmx to version 1.9.0 (release notes).
• The htmx file is now loaded locally rather than from a CDN, to reduce dependency on third-party sites (#303).

Fixed

• Fixed rendered markup not being escaped in the Sprig playground.

Added

• Added the s-history attribute that prevents sensitive data being saved to the history cache.

Changed

• Updated htmx to version 1.8.5 (release notes).

Added

• Added the sprig.triggerRefreshOnLoad template variable that triggers a refresh event on all components on page load (#279).

Added

• Added the s-validate attribute that forces an element to validate itself before it submits a request.
• Added the sprig.isHistoryRestoreRequest template variable that returns whether the request is for history restoration after a miss in the local history cache a client-side redirect without reloading the page.

Changed

• Updated htmx to version 1.8.4 (changelog).
• Swapped out the Twigfield package for the Code Editor package (#278).
• Improved the autocomplete API.

Fixed

• Fixed a bug in which Sprig requests were failing in live preview requests (#269).

Added

• Added the s-replace-url attribute that allows you to replace the current url of the browser location history.
• Added the s-select-oob attribute that selects one or more elements from a server response to swap in via an out-of-band swap.
• Added the sprig.location(url) template variable that triggers a client-side redirect without reloading the page.
• Added the sprig.replaceUrl(url) template variable that replaces the current URL in the location bar.
• Added the sprig.reswap(value) template variable that allows you to change the swap behaviour.

Changed

• Updated htmx to version 1.8.0 (release notes).

Added

• Added the Twigfield package that adds full autocomplete to the code editor in the playground (#235 ❤️@nystudio107).

Changed

• Improved attribute autocomplete in the playground.

Changed

• Improved the styling of variables panes in the playground.

Added

• Added compatibility with Craft 4.

Changed

• Restyled invalid variable error messages.

Removed

• Removed the deprecated sprig.element, sprig.elementName, sprig.elementValue and sprig.eventTarget tags.
• Removed the deprecated s-vars attribute.

Fixed

• Fixed the minimum PHP requirement format to allow for PHP 8 (#215).

Changed

• Changed the minimum PHP requirement to 7.1.

Fixed

• Fixed an issue where the Autocomplete helper could throw an exception if it encountered a ReflectionUnionType (#213).

Fixed

• Fixed nested components being parsed twice, resulting in duplicate attributes (#208).

Fixed

• Fixed an issue that caused htmx 1.7.0 to log console errors in some edge cases (#202).

Added

• Added the s-sync attribute that allows you to synchronize AJAX requests between multiple elements.
• Added the s-disinherit attribute that allows you to control attribute inheritance.

Changed

• Updated htmx to version 1.7.0 (release notes).

Changed

• The response format is now explicitly set to HTML, to avoid a scenario in which it might be interpreted as JSON.

Added

• Added a sprig.isBoosted template variable that returns whether this is a boosted request (requires htmx 1.6.0 or later).
• Added a sprig.retarget() template variable that overrides the element to target via a CSS selector (requires htmx 1.6.1 or later).

Changed

• Updated htmx to version 1.6.1 (release notes).

Fixed

• Fixed an issue in which attributes with spaces before or after the = were not being correctly parsed (#178).

Fixed

• Fixed a bug in which attributes could be double encoded in nested components (#176, #178).

Fixed

• Fixed a bug in which using s-action could throw an exception when parsed (#177).

Fixed

• Fixed a bug in which using s-vals with JSON encoded variables could throw an exception when parsed (#176).

Added

• Added sample components to the playground (#174 ❤️@nystudio107).

Changed

• Increased the minimum required Craft version to 3.3.0.
• The s-val:* attribute can now contain square brackets, for example s-val:fields[handle]="value".
• General performance optimisations.

Fixed

• Fixed a bug in which comments and script tags containing sprig could throw an exception when parsed (#3).

Fixed

• Fixed multibyte character strings not being correctly converted (#173).

Changed

• Optimised the performance and overhead of parsing large Sprig components (#2 ❤️@nystudio107).

Fixed

• Fixed an error in the CLI due to an undefined alias in Sprig core (#170).

The core functionality of Sprig has been split out into the Sprig Core package.

Added

• Added Craft API autocomplete and documentation to the code editor in the Sprig playground (#157 ❤️@nystudio107).
• Sprig components now pass the token parameter along so that they work seamlessly in a live preview scenario (#162).

Changed

• Split the core functionality of Sprig into the Sprig Core package that can be used by Craft plugins/modules without requiring that the Sprig plugin is installed.
• Removed the hxDataPrefix config setting, opting to prefix hx- attributes with data- by default.
• Updated htmx to version 1.6.0 (release notes).
• An unminified version of htmx is now loaded from a CDN rather than locally when in a development environment.
• Improved the performance of loading the htmx script from the CDN (#166).

Changed

• The PaginateVariable class now extends Craft’s Paginate class, adding more functionality and better compatibility with other plugins.

Variables passed into Sprig components are now automatically JSON decoded, so you should remove any usage of the json_decode filter from Sprig components.

Added

• Added the ability to pass variables as arrays into Sprig components, so you can now do this:

  {{ sprig('_components/entries', {entryIds: [1, 2, 3]}) }}
  

Changed

• Variables passed into Sprig components are now automatically JSON decoded.

Added

• Added the s-request attribute that allows you to configure various aspects of the request.

Changed

• Updated htmx to version 1.5.0 (release notes).
• Improved autocomplete suggestions in playground.

Changed

• The CSRF token is now regenerated if the password is updated for the current user (#136).
• CSRF tokens are now sent as request headers instead of body params.
• Use of the javascript: prefix is disallowed for security reasons and results in an exception being thrown.
• Updated htmx to version 1.4.1 (release notes).

Fixed

• Fixed double encoding of ampersands in element attributes (#133).

Fixed

• Fixed an error that could occur when registering a new user.

Changed

• Sprig overrides the currentUser global variable with a fresh version if the current user is updated using the users/save-user controller action (#81).

Added

• Added the ability to prefix both sprig and s- attributes with data- for more valid HTML (#117).
• Added the hxDataPrefix config setting that forces Sprig to use the data- prefix for hx- attributes.
• Added the s-disable attribute that disables htmx processing for a given element and its children.

Changed

• Updated htmx to version 1.3.3 (release notes).

• Added the s-headers attribute that allows you to add to the headers that will be submitted with an AJAX request.

Changed

• Updated htmx to version 1.2.1 (release notes).

Changed

• Component classes are now created using the createObject method (#93).
• Variables returned by controller actions called variables are now merged in to template variables (#94).

Fixed

• Fixed compatibility with Craft pre version 3.5.0 (#91).

Fixed

• Fixed missing variable methods (#79).

Added

• Added the following return variables when controller actions are called.
  • success (boolean) whether the action succeeded.
  • flashes (array) flash messages set by the action, keyed by type (notice or error).
  • id (integer) the ID of the model if one was successfully created/updated.
  • modelName (model) a model that failed validation, for example entry when entries/save-entry fails or user when users/save-user fails.
• Added a new s-preserve attribute that ensures that an element remains unchanged even when the component is re-rendered.
• Added a subresource integrity attribute to the htmx script tag when fetching from a CDN for added security.

Changed

• Updated htmx to version 1.1.0 (release notes).
• Requires Craft 3.1.19 or higher.

Removed

• The sprig.hyperscript function has been removed. Use the htmx JS API or import hyperscript in your templates manually instead.

Deprecated

• The errors variable has been deprecation. Use the getErrors() method on the model that is returned when validation fails.

{# OLD way of handling errors #}
{% if errors.title is defined %}
    {{ errors.title|first }}
{% endif

{# NEW way of handling errors (assumes `entry` failed validation) #}
{% if entry.hasErrors('title') %}
    {{ entry.getFirstError('title') }}
{% endif %}

• The sprig.element, sprig.elementName, sprig.elementValue and sprig.eventTarget tags have been deprecated, will each return a blank string since being removed from htmx 1.1.0, and should be removed from templates.

Added

• Added a new s-encoding attribute that can be used to set the encoding of requests to multipart/form-data for file uploads (#9).

Changed

• Updated htmx to version 1.0.2 (release notes).

Deprecated

• The sprig.hyperscript function has been deprecated. Use the htmx JS API or import hyperscript in your templates manually instead.

Changed

• Updated htmx to version 1.0.0 (release notes).

Fixed

• Fixed a bug that was preventing the s-push-url attribute from being parsed (#62).

The s-vars attribute has been deprecated for security reasons, use the new s-vals or s-val:* attribute instead (read the details here). The magic _url and _events variables have been removed, use the new sprig.pushUrl() and sprig.triggerEvents() functions instead.

Added

• Added new s-vals and s-val:* attributes that add values to a request and that should be used instead of the deprecated s-vars.
• Added a new s-replace attribute that replaces only the specified element in the component.
• Added a sprig.paginate() template variable that paginates an element query.
• Added a sprig.pushUrl() template variable that pushes a URL into the history stack.
• Added a sprig.redirect() template variable that redirects the browser to a URL.
• Added a sprig.refresh() template variable that refreshes the browser.
• Added a sprig.triggerEvents() template variable that triggers client-side events.

Changed

• Updated htmx to version 0.4.0 (release notes).
• Removed the magic _url variable, use the new sprig.pushUrl() function instead.
• Removed the magic _events variable, use the new sprig.triggerEvents() function instead.
• Made minor tweaks to default playground.

Fixed

• Fixed how array variables are handled in the playground.

Deprecated

• The s-vars attribute has been deprecated for security reasons. Use the new s-vals or s-val:* attribute instead.

Security

• Fixed a potential XSS vulnerability.

Added

• Added a config setting to enable or disable the playground on a per environment basis.

Added

• Added a warning message if devMode is not enabled.

Changed

• Updated htmx to version 0.2.0 (release notes).

• Migration schema version release for beta updates.

Added

• Added the Sprig playground.
• Added a new Sprig logo.

Fixed

• Fixed an issue with the schema version in project config (#42).

Added

• Added beforeCreateComponent and afterCreateComponent events to ComponentsService.

Changed

• Duplicate IDs in components no longer throw an error (#40).
• Removed the sprig.request template variable, use sprig.isRequest instead.
• Removed the sprig.include template variable, use sprig.isInclude instead.

Changed

• Uses a HTML5 compatible DOM parser.

Fixed

• Fixed a bug in which HTML tags would be stripped when inside of <script> tags (#34).

Changed

• Uses htmx 0.1.2 and hyperscript 0.0.2 (release notes).

Changed

• Controller actions that return models are now dealt with accordingly.

Deprecated

• The sprig.include template variable has been deprecated and will be removed in version 1.0.0. Use sprig.isInclude instead.
• The sprig.request template variable has been deprecated and will be removed in version 1.0.0. Use sprig.isRequest instead.

Changed

• Requests to controller actions are now forced to be AJAX requests.

Fixed

• Fixed an error that could occur if a controller action did not return a JSON response (#26).

Added

• Added the sprig.hyperscript tag.

Changed

• Invalid variable exceptions include suggestions for how code could be fixed.

Added

• Added a default class="sprig-component" to all components.

Changed

• An exception is now thrown if an array, object or value that cannot be converted to a string is passed into a Sprig component as a variable.

The ability to override the component trigger using the trigger attribute has been removed. Use s-trigger instead.

Added

• Added the ability to override all s- attributes on the component.

Changed

• Removed the ability to override the component trigger using the trigger attribute.

Added

• Added the ability to override the component trigger using the trigger attribute.

Changed

• CSRF tokens are now added as vars instead of input fields (#6).
• The current site is now maintained when rendering components (#13).

Added

• Added support for nesting components (#6).
• Added a refresh event trigger to components.

Changed

• Request parameters are not hashed as variables when a component is created initially (#5).

Added

• Added the sprig.htmxVersion variable back in.
• Added unit tests to ensure that both local and remote versions of htmx exist.

Changed

• Requires htmx 0.0.8 (release notes).
• Uses the htmx script from unpkg.com unless in a dev environment, in which case it uses a local version.

Added

• Added unit tests.

Changed

• Returns a 400 error when submitted data is determined to be tampered.
• Replaced htmx script from unpkg.com with a local version.
• Removed the sprig.htmxVersion variable.

Added

• Added the sprig.htmxVersion variable.

Changed

• Request parameters are now added as variables to the initial sprig include.
• Removed the ability to load extensions using the sprig.script tag.

Added

• Added the ability to pass protected variables into components by prefixing them with an underscore.

Changed

• Requires htmx 0.0.7 (release notes).

Added

• Added the s-vars attribute.

Fixed

• Fixed characters not being encoded in UTF-8 in rendered components (#2).
• Fixed a bug that could throw an error when creating a component class.

Added

• Added the ability to send events and a URL back in the response header.
• Added the ability to load extensions using the sprig.script tag.

Changed

• Renamed the protected property template to _template in the component class.
• Removed the error-url from the list of available attributes since it was dropped in htmx 0.0.6.

Added

• Added the sprig.include variable.

Changed

• Requires htmx 0.0.6 (release notes).

• Initial release.