diff --git a/package.json b/package.json index d548669..418b1a4 100644 --- a/package.json +++ b/package.json @@ -1,12 +1,14 @@ { "name": "@wide/modulus", - "version": "2.1.2", + "version": "2.2.0", "description": "Robust Web Component interface", "license": "MIT", "author": "Aymeric Assier (https://github.com/myeti)", "contributors": [ "Aymeric Assier (https://github.com/myeti)", - "Julien Martins Da Costa (https://github.com/jdacosta)" + "Julien Martins Da Costa (https://github.com/jdacosta)", + "Sébastien Robillard (https://github.com/robiseb)", + "Kévin Poccard Soudard (https://github.com/kevpoccs)" ], "repository": { "type": "git", diff --git a/readme.md b/readme.md index 46c83e7..12ea7ae 100644 --- a/readme.md +++ b/readme.md @@ -103,22 +103,44 @@ Use the `[data-call]` helper with a formatted value `name#id.method`: will internally trigger: ```js -modulus.seek('modal', '#register').open() +modulus.seek('modal', '#register').open({ el, e, data }) ``` -#### Parameters -Use the `[data-call.params]` to pass some predefined values: - | Value | Description | -|---|---|---|---| -| `$event` | `Event` object of the event listener method callback | -| `$el` | Element object binded to the event | +|---|---| +| `el` | HTMLElement object binded to the event | +| `e` | `Event` object of the event listener method callback | +| `data` | Optional parameters defined in `[data-call.params]` | + +#### Parameters +Use the `[data-call.params]` to pass custom values: ```html - + ``` +> ⚠️ Note: `data-call.params` is waiting a JSON format only +Exmple with the previous HTML code: +```js +modulus.component('modal', class extends Component { + run() { + // ... + } + + /** + * Open modal and do some stuff + * + * @params {HTMLElement} el + * @params {Event} e + * @params {Object|null} [data] + */ + open({ el, e, data }) { + // el: