zpt

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>ZPT-JS API reference</title> <script type="module" src="../js/zpt.js"></script> <link rel="stylesheet" type="text/css" href="../docs.css"> </head> <body> <div data-use-macro="'page@templates.html'" data-define="footer-macro 'footer'"> <div data-fill-slot="'page-header'"> <h1>ZPT-JS reference</h1> </div> <article data-fill-slot="'article'"> <h2>Configuration options</h2> <ul> <li><a href="configuration-command.html">command</a>. The action to run. Available options are <code>preload</code>, <code>fullRender</code> (default), <code>partialRender</code> and <code>update</code>.</li> <li><a href="configuration-declaredRemotePageUrls.html">declaredRemotePageUrls</a>. A list of URLs within external macros.</li> <li><a href="configuration-dictionary.html">dictionary</a>. An object containing key/value pairs accesible by the template.</li> <li><a href="configuration-dictionaryActions.html">dictionaryActions</a>. An array of objects with instructions to update the dictionary. ZPT-JS will also update HTML!</li> <li><a href="configuration-dictionaryChanges.html">dictionaryChanges</a>. An object containing key/value pairs with changes over the dictionary. ZPT-JS will also update HTML!</li> <li><a href="configuration-goToURLHash.html">goToURLHash</a>. Update the <code>location.href</code> to the current URL hash.</li> <li><a href="configuration-i18n.html">i18n</a>. An object to make it easy to preload i18n files.</li> <li><a href="configuration-indexExpressions.html">indexExpressions</a>. ZPT-JS builds an index with all the expressions and their dependencies depending on this value.</li> <li><a href="configuration-maxFolderDictionaries.html">maxFolderDictionaries</a>. Sets the number of folder dictionaries to read.</li> <li><a href="configuration-root.html">root</a>. The node(s) of the DOM to process a full render.</li> <li><a href="configuration-target.html">target</a>. The node(s) of the DOM to process a partial render.</li> <li><a href="configuration-notRemoveGeneratedTags.html">notRemoveGeneratedTags</a>. Sets whether ZPT-JS will remove the previously generated tags before processing.</li> </ul> <h2>Attributes</h2> <ul> <li> <a href="attributes-all.html">All the attributes</a>. The complete list of ZPT-JS attributes and their ZPT attributes. </li> <li> <a href="attributes-evaluationOrder.html">Evaluation order</a>. The order used by ZPT-JS to evaluate each attribute. </li> <li> <em>Template Attribute Language (TAL)</em>: <ul> <li><a href="attributes-TALAttributes.html">TALAttributes</a>. Replaces the value of an attribute (or creates an attribute) with a dynamic value.</li> <li><a href="attributes-TALCondition.html">TALCondition</a>. Includes the statement element in the template only if the condition is met, and omits it otherwise.</li> <li><a href="attributes-TALContent.html">TALContent</a>. Inserts text or structure in place of its children.</li> <li><a href="attributes-TALDeclare.html">TALDeclare</a>. Declares a list of variables and some settings about them.</li> <li><a href="attributes-TALDefine.html">TALDefine</a>. Defines variables.</li> <li><a href="attributes-TALOmitTag.html">TALOmitTag</a>. Leaves the contents of an element in place while omitting the surrounding start and end tags.</li> <li><a href="attributes-TALOnError.html">TALOnError</a>. Provides error handling for your template.</li> <li><a href="attributes-TALRepeat.html">TALRepeat</a>. Replicates a sub-tree of your document once for each item in an array.</li> <li><a href="attributes-TALReplace.html">TALReplace</a>. Replaces an element with dynamic content.</li> </ul> </li> <li> <em>Macro Expansion Tag Attribute Language (METAL)</em>: <ul> <li><a href="attributes-METALDefineMacro.html">METALDefineMacro</a>. Defines a macro.</li> <li><a href="attributes-METALDefineSlot.html">METALDefineSlot</a>. Defines a macro customization point or slot.</li> <li><a href="attributes-METALFillSlot.html">METALFillSlot</a>. Customizes a macro by replacing a slot in the macro with the statement element (and its content).</li> <li><a href="attributes-METALUseMacro.html">METALUseMacro</a>. Replaces the statement element with a macro.</li> </ul> </li> <li> <em>I18N attributes</em>: <ul> <li><a href="attributes-I18nDomain.html">I18nDomain</a>. Defines one or more expressions that evaluate to one or more sources of i18n resources.</li> <li><a href="attributes-I18nLanguage.html">I18nLanguage</a>. Defines an expression that evaluates to the current language to use in translations.</li> </ul> </li> </ul> <h2>Expressions</h2> <ul> <li> <a href="expressions-arithmethic.html">Arithmethic expressions</a>: <code>+</code>, <code>-</code>, <code>*</code>, <code>/</code> and <code>%</code>. </li> <li> <a href="expressions-boolean.html">Boolean expressions</a>: <code>and</code>, <code>cond</code>, <code>not</code> and <code>or</code>. </li> <li> <a href="expressions-comparison.html">Comparison expressions</a>: <code>eq</code>, <code>gt</code>, <code>in</code> and <code>lt</code>. </li> <li> <a href="expressions-i18n.html">I18n expressions</a>: <code>tr</code>, <code>trCurrency</code>, <code>trDate</code> and <code>trNumber</code>. </li> <li> <a href="expressions-path.html">Path expressions</a>: <ul> <li>Array expressions</li> <li>Function expressions</li> <li>Indirection expressions</li> <li>List expressions</li> <li>Literal expressions</li> <li>Method expressions</li> <li>Property expressions</li> <li>Range expressions</li> <li>Variable expressions</li> </ul> </li> <li> <em>Scripting expressions</em>. <ul> <li><a href="expressions-js.html">js:</a> Javascript expressions.</li> <li><a href="expressions-query.html">query:</a> Query expressions.</li> </ul> </li> <li> <em>Misc expressions</em>. <ul> <li><a href="expressions-exists.html">exists:</a> Test for the existence of paths.</li> <li><a href="expressions-format.html">format:</a> Makes it easy to format values.</li> <li><a href="expressions-string.html">string:</a> Interpret the expression string as text.</li> </ul> </li> </ul> <h2>Misc</h2> <ul> <li><a href="reactiveDictionaries.html">Reactive dictionaries</a>. Make it easy to use ZPT-JS adding to it reactive support.</li> <li><a href="context.html">The context object</a>. The context groups some important general settings.</li> </ul> </article> </div> </body> </html>