Skip to content

Commit 77edc20

Browse files
committed
Update README.md
1 parent 0230da0 commit 77edc20

File tree

1 file changed

+20
-24
lines changed

1 file changed

+20
-24
lines changed

README.md

Lines changed: 20 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,29 @@
1-
# App Store Widget Boilerplate
2-
3-
This boilerplate gives you all you need to start a new custom widget for Mendix 5.
4-
5-
The boilerplate contains:
6-
7-
- Directory structure.
8-
- Readme.md file.
9-
- License.
10-
- Javascript source.
11-
- XSD for package.xml, to configure properties of the widget, visible inside de Mendix business modeler.
1+
# HTMLSnippet
2+
This widget is useful to add a piece of HTML or JavaScript to a form. For example to embed a YouTube or Flash object. Furthermore it can be used to enhance styling by adding arbitrary HTML elements.
123

134
## Contributing
145

156
For more information on contributing to this repository visit [Contributing to a GitHub repository](https://world.mendix.com/display/howto50/Contributing+to+a+GitHub+repository)!
167

178
## Typical usage scenario
189

19-
Use this template to start building a widget for Mendix 5.
20-
Alter this README.md file and describe what your widget does.
21-
22-
## Description
10+
* Display a predefined HTML document
11+
* Load a Java Applet
12+
* Manipulate the styling using JavaScript rather than theming.
2313

24-
The javascript inside the widget has examples of:
14+
## Features and limitations
2515

26-
- Using CSS within a Widget.
27-
- Using templating.
28-
- Loading external library's.
29-
- DOM manipulation.
30-
- Event attaching.
31-
- Loading data.
32-
- Executing microflow and sending data.
33-
- Working with the context object (The object that is send by a contextview , for instance a dataview).
16+
* Embed raw HTML
17+
* Embed raw JavaScript
18+
19+
## Dependencies
20+
* Mendix 5.x environment
21+
22+
## Properties
23+
24+
* Content Type [ HTML, JavaScript ] :
25+
Defines whether this widget provides a piece of HTML or a piece of JavaScript.
26+
* Contents :
27+
The HTML or Javascript to embed.
28+
* Documentation :
29+
Documentation of this widget. Should explain its purpose.

0 commit comments

Comments
 (0)