Skip to content

Commit 4db4a20

Browse files
committed
fix: update warning messages in README.md and Notehing.xml for clarity on sensitive data
1 parent c4984c7 commit 4db4a20

File tree

2 files changed

+14
-6
lines changed

2 files changed

+14
-6
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,12 @@ Please report any issues, suggestions, or feature requests on the project's GitH
3232
## Development and contribution
3333

3434
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`.
35-
1. Run `npm start` to watch for code changes. On every change:
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.
35+
2. Run `npm start` to watch for code changes. On every change:
36+
   
37+
- the widget will be bundled;
38+
39+
- the bundle will be included in a `dist` folder in the root directory of the project;
40+
41+
- the bundle will be included in the `deployment` and `widgets` folder of the Mendix test project.
3942

4043
To contribute, please open a pull request or create an issue to discuss your idea.

src/Notehing.xml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,12 @@
2020
</property>
2121
<property key="noteContent" type="string" multiline="true" required="false">
2222
<caption>Content</caption>
23-
<description>The main content of the note. This will only be visible in Studio Pro.</description>
23+
<description>The main content of the note. This will only be visible in Studio Pro.
24+
25+
WARNING: 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.
26+
NEVER enter sensitive information, passwords, API keys, or any confidential data into this widget.
27+
</description>
28+
2429
</property>
2530
<property key="noteStyle" type="enumeration" defaultValue="info">
2631
<caption>Style</caption>
@@ -32,7 +37,7 @@
3237
<enumerationValue key="danger">Danger</enumerationValue>
3338
</enumerationValues>
3439
</property>
35-
<property key="showInDesignMode" type="boolean" defaultValue="true">
40+
<property key="showInDesignMode" type="boolean" defaultValue="false">
3641
<caption>Show in design mode</caption>
3742
<description>When enabled, this note will be visible in Studio Pro design mode.</description>
3843
</property>

0 commit comments

Comments
 (0)