Update docs for release v2.25

Author: rejas

.vuepress/config.js

@@ -53,6 +53,7 @@ module.exports = {
             ],
           },
           "modules/customcss",
+          "modules/animate"
         ],
       },
       {

development/core-module-file.md

@@ -229,7 +229,7 @@ will return the user's configured header.
 If you want to use the original user's configured header, reference
 `this.data.header`.
 
-**NOTE:** If the user did not configure a default header, no header will be
+**Note:** If the user did not configure a default header, no header will be
 displayed and thus this method will not be called.
 
 **Example:**
@@ -283,7 +283,8 @@ When this module is called, it has 2 arguments:
 - `payload` - AnyType - The payload of a notification.
 
 **Note 1:** When a node helper sends a notification, all modules of that module
-type receive the same notifications. <br> **Note 2:** The socket connection is
+type receive the same notifications.<br>
+**Note 2:** The socket connection is
 established as soon as the module sends its first message using
 [sendSocketNotification](#this-sendsocketnotification-notification-payload).
 
@@ -315,14 +316,15 @@ module.
 ### `this.file(filename)`
 
 **_filename_ String** - The name of the file you want to create the path
-for.<br> **Returns String**
+for.<br>
+**Returns String**
 
 If you want to create a path to a file in your module folder, use the `file()`
 method. It returns the path to the filename given as the attribute. Is method
 comes in handy when configuring the [getScripts](#getscripts) and
 [getStyles](#getstyles) methods.
 
-### `this.updateDom(speed)`
+### `this.updateDom(speed|options)`
 
 **_speed_ Number** - Optional. Animation speed in milliseconds.<br>
 
@@ -343,10 +345,40 @@ start: function() {
 ...
 ```
 
+**_options_ Object** - (_Introduced in version: 2.25.0._) Optional. Allows you to determine the animation speed and animation type options, whenever your module needs to be updated
+
+| options | type | description |
+| ------- | ---- | ----------- |
+| speed   | Number | animation speed in ms |
+| animate | Object | animate IN and OUT rules (see below) |
+
+
+**animate Object**
+
+| animate | type | description |
+| ------- | ---- | ----------- |
+| in      | String | Animate name when module will be shown (after dom update), it will use an `animateIn` type name (see [Animation Guide](../modules/animate#animatein)) |
+| out     | String | Animate name when module will be hidden (before dom update), it will use an `animateOut` type name (see [Animation Guide](../modules/animate#animateout)) |
+
+As an example:
+```javascript
+...
+  this.updateDom( {
+    options: {
+      speed: 1000, // animation duration
+      animate: {
+        in: "backInDown", // animation when module shown (after update)
+        out: "backOutUp" // animatation when module will hide (before update)
+      }
+    }
+  })
+...
+```
+
 ### `this.sendNotification(notification, payload)`
 
-**_notification_ String** - The notification identifier.<br> **_payload_
-AnyType** - Optional. A notification payload.<br>
+**_notification_ String** - The notification identifier.<br>
+**_payload_ AnyType** - Optional. A notification payload.
 
 If you want to send a notification to all other modules, use the
 `sendNotification(notification, payload)`. All other modules will receive the
@@ -363,8 +395,8 @@ this.sendNotification("MYMODULE_READY_FOR_ACTION", { foo: bar });
 
 ### `this.sendSocketNotification(notification, payload)`
 
-**_notification_ String** - The notification identifier.<br> **_payload_
-AnyType** - Optional. A notification payload.<br>
+**_notification_ String** - The notification identifier.<br>
+**_payload_ AnyType** - Optional. A notification payload.
 
 If you want to send a notification to the node_helper, use the
 `sendSocketNotification(notification, payload)`. Only the node_helper of this
@@ -379,10 +411,9 @@ this.sendSocketNotification("SET_CONFIG", this.config);
 ### `this.hide(speed, callback, options)`
 
 **_speed_ Number** - Optional (Required when setting callback or options), The
-speed of the hide animation in milliseconds. **_callback_ Function** - Optional,
-The callback after the hide animation is finished. **_options_ Function** -
-Optional, Object with additional options for the hide action (see below).
-(_Introduced in version: 2.1.0._)
+speed of the hide animation in milliseconds.<br>
+**_callback_ Function** - Optional, The callback after the hide animation is finished.<br>
+**_options_ Function** - Optional, Object with additional options for the hide action (see below). (_Introduced in version: 2.1.0._)
 
 To hide a module, you can call the `hide(speed, callback)` method. You can call
 the hide method on the module instance itself using `this.hide()`, but of course
@@ -396,21 +427,23 @@ Possible configurable options:
   modules identifier as the locksString: `this.identifier`. See _visibility
   locking_ below.
 
-**Note 1:** If the hide animation is cancelled, for instance because the show
+- `animate` - String - (_Introduced in version: 2.25.0._) Hide the module with a special animate. It will use an `animateOut` type name. All animations name are available in [Animation Guide](../modules/animate.html#animateout)
+
+::: warning Notes:
+- If the hide animation is cancelled, for instance because the show
 method is called before the hide animation was finished, the callback will not
-be called.<br> **Note 2:** If the hide animation is hijacked (an other method
-calls hide on the same module), the callback will not be called.<br> **Note 3:**
-If the dom is not yet created, the hide method won't work. Wait for the
-`DOM_OBJECTS_CREATED`
-[notification](#notificationreceived-notification-payload-sender).
+be called.<br>
+- If the hide animation is hijacked (an other method calls hide on the same module),the callback will not be called.<br>
+- If the dom is not yet created, the hide method won't work. Wait for the
+`DOM_OBJECTS_CREATED` [notification](#notificationreceived-notification-payload-sender).<br>
+- If an `animateOut` is defined in global module configuration, `animate` string will be ignored
+:::
 
 ### `this.show(speed, callback, options)`
 
-**_speed_ Number** - Optional (Required when setting callback or options), The
-speed of the show animation in milliseconds. **_callback_ Function** - Optional,
-The callback after the show animation is finished. **_options_ Function** -
-Optional, Object with additional options for the show action (see below).
-(_Introduced in version: 2.1.0._)
+**_speed_ Number** - Optional (Required when setting callback or options), The speed of the show animation in milliseconds.<br>
+**_callback_ Function** - Optional, The callback after the show animation is finished.<br>
+**_options_ Function** - Optional, Object with additional options for the show action (see below). (_Introduced in version: 2.1.0._)
 
 To show a module, you can call the `show(speed, callback)` method. You can call
 the show method on the module instance itself using `this.show()`, but of course
@@ -428,14 +461,18 @@ Possible configurable options:
 - `onError(error)` - Function - If a module is hidden with other lock strings
   and can therefore not be shown the onError callback triggers with an error
   object, if specified in the options (_Introduced in version: 2.15.0_).
+- `animate` - String - (_Introduced in version: 2.25.0._) Show the module with a special animation. It will use an `animateIn` type name. All animations name are available in [Animation Guide](../modules/animate.html#animatein)
 
-**Note 1:** If the show animation is canceled, for instance because the hide
+::: warning Notes:
+- If the show animation is canceled, for instance because the hide
 method is called before the show animation was finished, the callback will not
-be called.<br> **Note 2:** If the show animation is hijacked (an other method
-calls show on the same module), the callback will not be called.<br> **Note 3:**
-If the dom is not yet created, the show method won't work. Wait for the
-`DOM_OBJECTS_CREATED`
-[notification](#notificationreceived-notification-payload-sender).
+be called.<br>
+- If the show animation is hijacked (an other method
+calls show on the same module), the callback will not be called.<br>
+- If the dom is not yet created, the show method won't work. Wait for the
+`DOM_OBJECTS_CREATED` [notification](#notificationreceived-notification-payload-sender).<br>
+- If an `animateIn` is defined in global module configuration, `animate` string will be ignored
+:::
 
 ### Visibility locking
 
@@ -559,7 +596,7 @@ Comments in translation files could help other translators.
 
 #### `this.translate(identifier, variables)`
 
-**_identifier_ String** - Identifier of the string that should be translated.
+**_identifier_ String** - Identifier of the string that should be translated.<br>
 **_variables_ Object** - Object of variables to be used in translation.
 
 This improved and backwards compatible way to handle translations behaves like
@@ -574,15 +611,15 @@ var timeUntilEnd = moment(event.endDate, "x").fromNow(true);
 this.translate("RUNNING", { "timeUntilEnd": timeUntilEnd) }); // Will return a translated string for the identifier RUNNING, replacing `{timeUntilEnd}` with the contents of the variable `timeUntilEnd` in the order that translator intended.
 ```
 
-**Example English .json file:**
+**Example English.json file:**
 
 ```javascript
 {
 	"RUNNING": "Ends in {timeUntilEnd}",
 }
 ```
 
-**Example Finnish .json file:**
+**Example Finnish.json file:**
 
 ```javascript
 {
@@ -605,7 +642,7 @@ this.translate("RUNNING", {
 )}); // Will return a translated string for the identifier RUNNING, replacing `{timeUntilEnd}` with the contents of the variable `timeUntilEnd` in the order that translator intended. (has a fallback)
 ```
 
-**Example Swedish .json file that does not have the variable in it:**
+**Example Swedish.json file that does not have the variable in it:**
 
 ```javascript
 {

development/node-helper.md

@@ -147,12 +147,12 @@ module.
 
 ### `this.sendSocketNotification(notification, payload)`
 
-**_notification_ String** - The notification identifier.<br> **_payload_
-AnyType** - Optional. A notification payload.<br>
+**_notification_ String** - The notification identifier.<br>
+**_payload_ AnyType** - Optional. A notification payload.
 
-If you want to send a notification to all your modules, use the
-`sendSocketNotification(notification, payload)`. Only the module of your module
-type will receive the socket notification.
+If you want to send a notification to your module, use the
+`sendSocketNotification(notification, payload)`.<br>
+Only the module of your module type will receive the socket notification.
 
 **Note:** Since all instances of your module will receive the notifications,
 it's your task to make sure the right module responds to your messages.
@@ -163,6 +163,10 @@ it's your task to make sure the right module responds to your messages.
 this.sendSocketNotification("SET_CONFIG", this.config);
 ```
 
+::: warning Reminder
+`sendSocketNotification` sends a notification from the helper to all the instances of your module.
+:::
+
 ## Using native node modules in your node_helper
 
 If you want use `native node modules` within electron you need to recompile them

getting-started/requirements.md

@@ -30,5 +30,7 @@ Raspberry Pi OS versions based on Debian "Stretch" are also no longer supported.
 
 ## Node
 
-Node 18 is required, all older versions have reached end of life and will not
+::: warning NOTE Node 18 is required!
+All older versions (Node 16 and below) have reached end of life and will not
 work.
+:::