Skip to content

Commit b284abf

Browse files
authored
Winter cleanups (#212)
* update dependencies * Prettier some files * Update module screenshots * Cleanup markdown a little
1 parent 0106d74 commit b284abf

20 files changed

+123
-112
lines changed

development/core-module-file.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -283,9 +283,10 @@ When this module is called, it has 2 arguments:
283283
- `payload` - AnyType - The payload of a notification.
284284

285285
**Note 1:** When a node helper sends a notification, all modules of that module
286-
type receive the same notifications.<br>
287-
**Note 2:** The socket connection is
288-
established as soon as the module sends its first message using
286+
type receive the same notifications.
287+
288+
**Note 2:** The socket connection is established as soon as the module sends its
289+
first message using
289290
[sendSocketNotification](#this-sendsocketnotification-notification-payload).
290291

291292
**Example:**
@@ -316,8 +317,7 @@ module.
316317
### `this.file(filename)`
317318

318319
**_filename_ String** - The name of the file you want to create the path
319-
for.<br>
320-
**Returns String**
320+
for.<br> **Returns String**
321321

322322
If you want to create a path to a file in your module folder, use the `file()`
323323
method. It returns the path to the filename given as the attribute. Is method
@@ -345,22 +345,24 @@ start: function() {
345345
...
346346
```
347347

348-
**_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
348+
**_options_ Object** - (_Introduced in version: 2.25.0._) Optional. Allows you
349+
to determine the animation speed and animation type options, whenever your
350+
module needs to be updated
349351

350-
| options | type | description |
351-
| ------- | ---- | ----------- |
352-
| speed | Number | animation speed in ms |
352+
| options | type | description |
353+
| ------- | ------ | ------------------------------------ |
354+
| speed | Number | animation speed in ms |
353355
| animate | Object | animate IN and OUT rules (see below) |
354356

355-
356357
**animate Object**
357358

358-
| animate | type | description |
359-
| ------- | ---- | ----------- |
360-
| 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)) |
359+
| animate | type | description |
360+
| ------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
361+
| 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)) |
361362
| 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)) |
362363

363364
As an example:
365+
364366
```javascript
365367
...
366368
this.updateDom( {
@@ -377,8 +379,8 @@ As an example:
377379

378380
### `this.sendNotification(notification, payload)`
379381

380-
**_notification_ String** - The notification identifier.<br>
381-
**_payload_ AnyType** - Optional. A notification payload.
382+
- `notification` - String - The notification identifier.
383+
- `payload` - AnyType - (Optional) A notification payload.
382384

383385
If you want to send a notification to all other modules, use the
384386
`sendNotification(notification, payload)`. All other modules will receive the
@@ -395,8 +397,8 @@ this.sendNotification("MYMODULE_READY_FOR_ACTION", { foo: bar });
395397

396398
### `this.sendSocketNotification(notification, payload)`
397399

398-
**_notification_ String** - The notification identifier.<br>
399-
**_payload_ AnyType** - Optional. A notification payload.
400+
- `notification` - String - The notification identifier.
401+
- `payload` - AnyType - (Optional) A notification payload.
400402

401403
If you want to send a notification to the node_helper, use the
402404
`sendSocketNotification(notification, payload)`. Only the node_helper of this

development/node-helper.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -147,12 +147,12 @@ module.
147147

148148
### `this.sendSocketNotification(notification, payload)`
149149

150-
**_notification_ String** - The notification identifier.<br>
151-
**_payload_ AnyType** - Optional. A notification payload.
150+
- `notification` - String - The notification identifier.
151+
- `payload` - AnyType - (Optional) The payload of a notification.
152152

153153
If you want to send a notification to your module, use the
154-
`sendSocketNotification(notification, payload)`.<br>
155-
Only the module of your module type will receive the socket notification.
154+
`sendSocketNotification(notification, payload)`. Only the module of your module
155+
type will receive the socket notification.
156156

157157
**Note:** Since all instances of your module will receive the notifications,
158158
it's your task to make sure the right module responds to your messages.

getting-started/installation.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ installers can be found under:
1414

1515
## Manual Installation
1616

17-
1. Download and install the latest _Node.js_ version, see the official documentation:
17+
1. Download and install the latest _Node.js_ version, see the official
18+
documentation:
19+
1820
- [Linux based distributions](https://github.com/nodesource/distributions)
1921
- [Others](https://nodejs.org/en/download)
2022

modules/animate.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# Animation Guide
2+
23
(_Introduced in version: 2.25.0_)
34

45
::: tip Preview of animation
56
check the [animate.css](https://animate.style/) library to see a preview of the animation name result
67
:::
78

89
::: warning Where animation can be used?
10+
911
- [global module configuration](configuration.html#animated) of a module
1012
- [this.hide()](../development/core-module-file.html#this-hide-speed-callback-options) function in core module file
1113
- [this.show()](../development/core-module-file.html#this-show-speed-callback-options) function in core module file

0 commit comments

Comments
 (0)