|
1 | | -## Notehing |
2 | | -[Makes nothing at the client but allows noting at the studio!] |
| 1 | +## Notehing - Page Annotations |
| 2 | +Makes nothing at the client but allows noting at the studio! |
3 | 3 |
|
4 | 4 | ## Features |
5 | | -[feature highlights] |
| 5 | +* Add **notes and annotations** directly within the Mendix Studio Pro page editor. |
| 6 | +* Renders **absolutely nothing** on the client-side, ensuring zero performance impact and zero DOM footprint. |
| 7 | +* Customize your notes with a **Title** and multi-line **Content**. |
| 8 | +* Select a visual **Style** (Info, Success, Warning, Danger) for easy identification. |
| 9 | +* Toggle the note to act as a **Container** (drop-zone) to group other widgets. |
| 10 | +* The container's "Content" property is dynamically hidden in the properties panel when not in use. |
| 11 | + |
| 12 | +> **⚠️ Important Security Warning:** |
| 13 | +> While this widget renders nothing on the client, the text you enter in the `noteTitle` and `noteContent` properties is still **included in your application's JavaScript bundle**. This means a technical user with access to browser developer tools could potentially find and read this text. |
| 14 | +> |
| 15 | +> **NEVER enter sensitive information, passwords, API keys, or any confidential data into this widget.** |
6 | 16 |
|
7 | 17 | ## Usage |
8 | | -[step by step instructions] |
| 18 | +1. Download the widget from the Mendix Marketplace into your project. |
| 19 | +2. Open a page in Mendix Studio Pro. |
| 20 | +3. Drag the "Notehing" widget from the toolbox onto your page. |
| 21 | +4. In the "Properties" panel, configure the `Title`, `Content`, and `Style`. |
| 22 | +5. (Optional) Check "Act as a container" to place other widgets inside it. |
| 23 | +6. If enabled, drag your other widgets into the "Content" drop-zone that appears. |
| 24 | +7. Run your application. Your notes will only be visible in Studio Pro, not to the end-user. |
9 | 25 |
|
10 | | -## Demo project |
11 | | -[link to sandbox] |
| 26 | +## Website |
| 27 | +[\[Introduction Website\]](https://notehing.lightningcell.net/) |
12 | 28 |
|
13 | 29 | ## Issues, suggestions and feature requests |
14 | | -[link to GitHub issues] |
| 30 | +Please report any issues, suggestions, or feature requests on the project's GitHub Issues page. |
15 | 31 |
|
16 | 32 | ## Development and contribution |
17 | 33 |
|
18 | 34 | 1. Install NPM package dependencies by using: `npm install`. If you use NPM v7.x.x, which can be checked by executing `npm -v`, execute: `npm install --legacy-peer-deps`. |
19 | 35 | 1. Run `npm start` to watch for code changes. On every change: |
20 | | - - the widget will be bundled; |
21 | | - - the bundle will be included in a `dist` folder in the root directory of the project; |
22 | | - - the bundle will be included in the `deployment` and `widgets` folder of the Mendix test project. |
| 36 | + - the widget will be bundled; |
| 37 | + - the bundle will be included in a `dist` folder in the root directory of the project; |
| 38 | + - the bundle will be included in the `deployment` and `widgets` folder of the Mendix test project. |
23 | 39 |
|
24 | | -[specify contribution] |
| 40 | +To contribute, please open a pull request or create an issue to discuss your idea. |
0 commit comments