This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
action:Custom_HTML_Prompt [2017/03/29 04:44] JMichaelTX Add keywords |
action:Custom_HTML_Prompt [2017/09/06 02:01] peternlewis |
||
---|---|---|---|
Line 9: | Line 9: | ||
===== How To Use ===== | ===== How To Use ===== | ||
+ | |||
- Create a standard HTML page with a form that uses [[token:Variable|Keyboard Maestro Variables]] in the Form Field //Name// attribute | - Create a standard HTML page with a form that uses [[token:Variable|Keyboard Maestro Variables]] in the Form Field //Name// attribute | ||
* If the Variable contains spaces, you must replace them with underscores (`_`) in the HTML code | * If the Variable contains spaces, you must replace them with underscores (`_`) in the HTML code | ||
Line 20: | Line 21: | ||
You design the HTML form using standard HTML code, which can be stored in either a file or as text in the Action. You can, of course, use any Web/HTML editor you like. If you'd like some suggestions, see the [[Custom_HTML_Prompt#WebHTML_Editors|Web/HTML Editors]] section at the bottom of this page for editors that others have found useful. | You design the HTML form using standard HTML code, which can be stored in either a file or as text in the Action. You can, of course, use any Web/HTML editor you like. If you'd like some suggestions, see the [[Custom_HTML_Prompt#WebHTML_Editors|Web/HTML Editors]] section at the bottom of this page for editors that others have found useful. | ||
- | |||
- | |||
- | ---- | ||
===== HTML Window Design ===== | ===== HTML Window Design ===== | ||
Line 57: | Line 55: | ||
Then you can control-click on elements and use Inspect Element and get an inspector window, including a Console tab. | Then you can control-click on elements and use Inspect Element and get an inspector window, including a Console tab. | ||
- | ---- | ||
===== Using Keyboard Maestro Variables in the HTML Form ===== | ===== Using Keyboard Maestro Variables in the HTML Form ===== | ||
- | |||
Keyboard Maestro ensures sync between *Keyboard Maestro Variables* and the HTML form field values. The **[[http://www.w3schools.com/Tags/att_input_name.asp|HTML name attribute]]** is used to identify the *Keyboard Maestro Variable*. For example, **''Web Name''** is the *Keyboard Maestro Variable* shown below in the HTML **[[http://www.w3schools.com/Tags/tag_input.asp|<input>]]** tag. You must replace spaces in the *Keyboard Maestro Variable* name with underscores when used on the HTML form. | Keyboard Maestro ensures sync between *Keyboard Maestro Variables* and the HTML form field values. The **[[http://www.w3schools.com/Tags/att_input_name.asp|HTML name attribute]]** is used to identify the *Keyboard Maestro Variable*. For example, **''Web Name''** is the *Keyboard Maestro Variable* shown below in the HTML **[[http://www.w3schools.com/Tags/tag_input.asp|<input>]]** tag. You must replace spaces in the *Keyboard Maestro Variable* name with underscores when used on the HTML form. | ||
Line 80: | Line 76: | ||
Note: Prior to 7.1 autofocus did not work for textarea types. | Note: Prior to 7.1 autofocus did not work for textarea types. | ||
- | The *Keyboard Maestro Variable* “//**HTML Result Button**//” is set to the parameter in the `Submit()` function. For example: | + | The [[token:HTMLResult|%HTMLResult%]] token (v8+) is set to the the parameter in the `Submit()` function, and can be used in actions later in this instance like any other text token. The deprecated _HTML Result Button_ variable is also set to the parameter. |
+ | |||
+ | For example: | ||
```html | ```html | ||
Line 89: | Line 87: | ||
Prior to version 7.1, the *Keyboard Maestro Variables* //**HTML Result Button**// was not changed when the window was closed by other than a Submit call - as of 7.1+ the variable is cleared when the window first appears. | Prior to version 7.1, the *Keyboard Maestro Variables* //**HTML Result Button**// was not changed when the window was closed by other than a Submit call - as of 7.1+ the variable is cleared when the window first appears. | ||
- | |||
==== Excluding Set and/or Saving of Form Fields ==== | ==== Excluding Set and/or Saving of Form Fields ==== | ||
Line 98: | Line 95: | ||
|*data-kmignoresubmit* |avoid saving form field back to the *Keyboard Maestro Variable*| | |*data-kmignoresubmit* |avoid saving form field back to the *Keyboard Maestro Variable*| | ||
|*data-kmignore* | avoid setting and saving the form field| | |*data-kmignore* | avoid setting and saving the form field| | ||
- | |||
- | |||
- | ---- | ||
===== Using JavaScript ===== | ===== Using JavaScript ===== | ||
Line 127: | Line 121: | ||
Prior to version 7.1, using SetVariable to set a value to something other than a string can [corrupt the variable](https://forum.keyboardmaestro.com/t/corrupted-variables-after-custom-html-setvariable-update-i-fixed-it-please-read/2881). | Prior to version 7.1, using SetVariable to set a value to something other than a string can [corrupt the variable](https://forum.keyboardmaestro.com/t/corrupted-variables-after-custom-html-setvariable-update-i-fixed-it-please-read/2881). | ||
+ | |||
+ | ==== Form Validation ==== | ||
+ | |||
+ | You can use HTML5’s form validation to automatically validate the fields. Specify their input types (eg "email" or "url" instead of "text"), as well as other properties like minimum/maximum numbers and so on, and then instead of simply: | ||
+ | |||
+ | onclick="window.KeyboardMaestro.Submit('OK')" | ||
+ | |||
+ | do something like: | ||
+ | |||
+ | onclick="if ( document.getElementById('myform').checkValidity() ) { window.KeyboardMaestro.Submit('OK') } else { document.getElementById('myform').reportValidity() }" | ||
==== Debugging JavaScript in the Form ==== | ==== Debugging JavaScript in the Form ==== | ||
Line 134: | Line 138: | ||
(!) Be aware that the system will not allow Keyboard Maestro Engine to see keys typed in its own windows so the [[trigger:Typed String | Typed String triggers]] will not work within Keyboard Maestro Engine windows. | (!) Be aware that the system will not allow Keyboard Maestro Engine to see keys typed in its own windows so the [[trigger:Typed String | Typed String triggers]] will not work within Keyboard Maestro Engine windows. | ||
- | |||
- | ---- | ||
- | ===== Downloads ==== | ||
- | - None | ||
- | |||
- | ---- | ||
- | |||
===== See Also ===== | ===== See Also ===== | ||
- | |||
- | ---- | ||
=== Actions === | === Actions === | ||
+ | * [[action:Alert|Alert]] action | ||
+ | * [[action:Show_Palette_of_Macros|Show Palette of Macros]] action | ||
* [[action:Prompt for User Input|Prompt for User Input]] | * [[action:Prompt for User Input|Prompt for User Input]] | ||
* [[:Actions|See all Actions]] | * [[:Actions|See all Actions]] | ||
- | ---- | + | === Tokens === |
+ | |||
+ | * [[token:AlertButton|%AlertButton%]] token | ||
+ | * [[token:PromptButton|%PromptButton%]] token | ||
+ | * [[token:HTMLResult|%HTMLResult%]] token | ||
+ | * [[:Tokens|All Tokens]] | ||
=== Forum === | === Forum === | ||
Line 174: | Line 176: | ||
* If your favorite Web/HTML editor is not listed here, and you would like to include it, post a request in the [[https://forum.keyboardmaestro.com/c/wiki|Keyboard Maestro Forum, Wiki section]]. | * If your favorite Web/HTML editor is not listed here, and you would like to include it, post a request in the [[https://forum.keyboardmaestro.com/c/wiki|Keyboard Maestro Forum, Wiki section]]. | ||
- | |||
- | --- | ||
**Keywords:* Custom HTML Prompt, User Prompt, HTML, Dialog | **Keywords:* Custom HTML Prompt, User Prompt, HTML, Dialog |