Sprig

Changed

• Updated htmx to version 2.0.3 (changelog).
• The fetch function is now called inside an event listener when calling sprig.triggerRefreshOnLoad(), making it more robust.
• Reverted some variable method name changes to improve autocompletion in PhpStorm.

Fixed

• Fixed the ability to pass a JSON encoded string into the sprig.triggerEvents() function (#15).

Added

• Added the ability to assign an ID to a component by passing a string as the third argument to the sprig() function.

Changed

• Updated htmx to version 2.0.2 (changelog).

Fixed

• Fixed the positioning of the JavaScript output by the sprig.triggerRefreshOnLoad function.

Deprecated

• Deprecated sprig.getIsBoosted, sprig.getIsError, sprig.getIsHistoryRestoreRequest, sprig.getIsInclude, sprig.getIsRequest, sprig.getIsSuccess. Use sprig.isBoosted, sprig.isError, sprig.isHistoryRestoreRequest, sprig.isInclude, sprig.isRequest, sprig.isSuccess instead.

Changed

• The sprig.registerJs(js) function now executes the registered JavaScript after htmx settles, and is now the recommended way of outputting JavaScript in Sprig components.
• Components no longer render markup added via {% html %}, {% css %} and {% js %} tags during Sprig requests.

Added

• Added the component configurations to a Sprig variable in the browser console when devMode is enabled.
• Added the ability to pass any value into s-method, including the put, patch and delete verbs.
• Added the sprig.registerJs(js) function.

Changed

• The sprig.triggerRefresh(selector, variables) function now prevents cyclical requests.

Changed

• The sprig.swapOob() function now accepts a string, in addition to a template to be rendered, in the second argument.

Added

• Added the sprig.swapOob(selector, template, variables) function that swaps a template out-of-band.
• Added the sprig.triggerRefresh(selector, variables) function that triggers a refresh on a Sprig component.

Changed

• Components now render markup added via {% html %}, {% css %} and {% js %} tags.
• The sprig.triggerRefreshOnLoad(selector) function now appends output to the end of the body and should be called using {% do sprig.triggerRefreshOnLoad(selector) %}.

This update introduces htmx 2. Read about the changes →

Added

• Added the s-inherit attribute that allows you to control and enable automatic attribute inheritance for child nodes, if it has been disabled by default.

Changed

• Updated htmx to version 2.0.1 (2.0.0 release notes).
• The htmx file is now output even when Sprig components are used inside of {% cache %} tags (#329).

Fixed

• Fixed the check for whether devMode is enabled in the Sprig playground.

Removed

• Removed the s-sse and s-ws attributes.

Changed

• Made it possible to pass a fully namespaced component class into the sprig() function (#14).
• Updated htmx to version 1.9.12 (changelog).

Fixed

• Fixed a bug in which variables passed into a component were being converted to strings (#369).

Fixed

• Fixed a bug in which some sprig variables were incorrectly persisting across requests (#363).

Template caches and static page caches should be cleared after performing this update.

Added

• Added compatibility with Craft 5.

Changed

• Changed how the component configuration is encoded.

Removed

• Removed the sprig.script variable.
• Removed the s-on attribute.
• Removed the success variable. Use sprig.isSuccess or sprig.isError instead.
• Removed the flashes variable. Use sprig.message instead.
• Removed the id variable. Use sprig.modelId instead.