Skip to content

lightningcell/notehing

Repository files navigation

Notehing - Page Annotations

Makes nothing at the client but allows noting at the studio!

Features

  • Add notes and annotations directly within the Mendix Studio Pro page editor.
  • Renders absolutely nothing on the client-side, ensuring zero performance impact and zero DOM footprint.
  • Customize your notes with a Title and multi-line Content.
  • Select a visual Style (Info, Success, Warning, Danger) for easy identification.
  • Toggle the note to act as a Container (drop-zone) to group other widgets.
  • The container's "Content" property is dynamically hidden in the properties panel when not in use.

⚠️ Important Security Warning: 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.

NEVER enter sensitive information, passwords, API keys, or any confidential data into this widget.

Usage

  1. Download the widget from the Mendix Marketplace into your project.
  2. Open a page in Mendix Studio Pro.
  3. Drag the "Notehing" widget from the toolbox onto your page.
  4. In the "Properties" panel, configure the Title, Content, and Style.
  5. (Optional) Check "Act as a container" to place other widgets inside it.
  6. If enabled, drag your other widgets into the "Content" drop-zone that appears.
  7. Run your application. Your notes will only be visible in Studio Pro, not to the end-user.

Website

[Introduction Website]

Issues, suggestions and feature requests

Please report any issues, suggestions, or feature requests on the project's GitHub Issues page.

Development and contribution

  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.
  2. Run npm start to watch for code changes. On every change:    
  • the widget will be bundled;

  • the bundle will be included in a dist folder in the root directory of the project;

  • the bundle will be included in the deployment and widgets folder of the Mendix test project.

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