diff --git a/www/extensions/path-deps.md b/www/extensions/path-deps.md index dbaebd91..65fb2916 100644 --- a/www/extensions/path-deps.md +++ b/www/extensions/path-deps.md @@ -5,14 +5,14 @@ title: htmx - high power tools for html ## The `path-deps` Extension -This extension supports expressing inter-element dependencies based on paths, inspired by the +This extension supports expressing inter-element dependencies based on paths, inspired by the [intercooler.js dependencies mechanism.](http://intercoolerjs.org/docs.html#dependencies). When this extension is installed an element can express a dependency on another path by using the `path-deps` property and then setting `hx-trigger` to `path-deps`: ```html -
...
``` @@ -22,8 +22,8 @@ request like a `POST`) to `/foo/bar` or any sub-paths of that path. You can use a `*` to match any path component: ```html -
...
``` @@ -39,6 +39,23 @@ You can use a `*` to match any path component: ``` +#### Javascript API + +### Method - [`PathDeps.refresh()`](#refresh) + +This method manually triggers a refresh for the given path. + +##### Parameters + +* `path` - the path to refresh + +##### Example + +```js + // Trigger a refresh on all elements with the path-deps attribute '/path/to/refresh', including elements with a parent path, e.g. '/path' + PathDeps.refresh('/path/to/refresh'); +``` + #### Source