|
1 | | -# HTMLSnippet |
2 | | - |
3 | | -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. |
4 | | - |
5 | | -## Contributing |
6 | | - |
7 | | -For more information on contributing to this repository visit [Contributing to a GitHub repository](https://docs.mendix.com/howto/collaboration-requirements-management/contribute-to-a-github-repository)! |
8 | | - |
9 | | -## Typical usage scenario |
10 | | - |
11 | | -- Display a predefined HTML document |
12 | | -- Load a Java Applet |
13 | | -- Manipulate the styling using JavaScript rather than theming. |
14 | | - |
15 | | -## Features and limitations |
16 | | - |
17 | | -- Embed raw HTML |
18 | | -- Embed raw JavaScript |
19 | | -- Load external HTML / JS file |
20 | | - |
21 | | -## Dependencies |
22 | | - |
23 | | -- Mendix 5.x environment |
24 | | - |
25 | | -## Properties |
26 | | - |
27 | | -- **Content Type [ HTML, JavaScript, JavaScript with jQuery ] :** |
28 | | - Select how the snippet should be rendered. The JavaScript with jQuery option will make sure that your code can leverage [jQuery v3.3.1](https://blog.jquery.com/2018/01/20/jquery-3-3-1-fixed-dependencies-in-release-tag/) for example: |
29 | | - |
30 | | -```js |
31 | | -//e.g. this code snippet will set the color of all your paragraph tags on the page to red. |
32 | | -$('p').css('color', 'red') |
33 | | -// or |
34 | | -jQuery('p').css('color', 'red') |
35 | | -``` |
36 | | - |
37 | | -- **Contents :** |
38 | | - The HTML or Javascript to embed. |
39 | | -- **External File :** |
40 | | - The path to the HTML or JavaScript file you want to add. The root is the theme folder. Will override the Contents section if used. With the newly added "/p/" native deeplinks, you may want to start your file path with a "/" to prevent any 404s caused by this deeplink. |
41 | | -- **On click microflow :** |
42 | | - The microflow which should be executed on click. This can be used to, for example, show a page when the snippet is being clicked. |
43 | | -- **Documentation :** |
44 | | - Documentation of this widget. Should explain its purpose. |
45 | | -- **Refresh on context change:** |
46 | | - Refresh when the context changes |
47 | | -- **Refresh on context update:** |
48 | | - Refresh when the context updates (works only when context change is true) |
49 | | -- **Enclose HTML with DIV:** |
50 | | - When adding HTML, the widget will wrap it with a DIV. If this is set to false, it will just replace the content of the widget. (For compatibility purposes this is set true on default) |
| 1 | +Please see [HTML/JavaScript Snippet](https://docs.mendix.com/appstore/widgets/html-javascript-snippet) in the Mendix documentation for details. |
0 commit comments