UNPKG

zero-ai

Version:
621 lines (363 loc) 16.8 kB
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>art - Zero UI框架专用前端文档</title> <meta name="description" content="前端开发框架,官方地址:http://www.vertx-ui.cn" /> <meta name="keywords" content="zero,zero-ui,vert.x" /> <meta name="keyword" content="zero,zero-ui,vert.x" /> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/prettify.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc.css"> <link type="text/css" rel="stylesheet" href="styles/zero.css"> <script src="scripts/nav.js" defer></script> <meta name="viewport" content="width=device-width, initial-scale=1.0"> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger" /> <label for="nav-trigger" class="navicon-button x"> <div class="navicon"></div> </label> <label for="nav-trigger" class="overlay"></label> <nav > <input type="text" id="nav-search" placeholder="Search" /> <h2><a href="index.html">Home</a></h2><h2><a href="http://www.vertxai.cn/document/doc-web/index.html" target="_blank" class="menu-item" id="website_link" >「Api」Zero Ai</a></h2><h2><a href="http://www.vertxui.cn/document/doc-web/index.html" target="_blank" class="menu-item" id="website_link" >「Api」Zero Ui</a></h2><h2><a href="http://www.vertxui.cn/document/doc-web-extension/index.html" target="_blank" class="menu-item" id="website_link" >「Api」Zero Ui Extension</a></h2><h2><a href="http://www.vertxui.cn" target="_blank" class="menu-item" id="website_link" >「Home」Zero UI</a></h2><h2><a href="http://www.vertxai.cn" target="_blank" class="menu-item" id="website_link" >「Home」Zero Ai</a></h2><h2><a href="http://www.vertxup.cn" target="_blank" class="menu-item" id="website_link" >「Home」Zero Framework</a></h2><h2><a href="http://www.origin-x.cn" target="_blank" class="menu-item" id="website_link" >「Home」Origin X Engine</a></h2><h3>Classes</h3><ul><li><a href="E.html">E</a></li></ul><h3>Modules</h3><ul><li><a href="module-__epic.html">__epic</a></li><li><a href="module-ai.html">ai</a><ul class='methods'><li data-type='method'><a href="module-ai.html#.csv">csv</a></li><li data-type='method'><a href="module-ai.html#.data">data</a></li><li data-type='method'><a href="module-ai.html#.init">init</a></li><li data-type='method'><a href="module-ai.html#.key">key</a></li><li data-type='method'><a href="module-ai.html#.md5">md5</a></li><li data-type='method'><a href="module-ai.html#.str">str</a></li><li data-type='method'><a href="module-ai.html#.sync">sync</a></li><li data-type='method'><a href="module-ai.html#.uk">uk</a></li><li data-type='method'><a href="module-ai.html#.uuid">uuid</a></li></ul></li><li><a href="module-aj.html">aj</a><ul class='methods'><li data-type='method'><a href="module-aj.html#.bundle">bundle</a></li><li data-type='method'><a href="module-aj.html#.init">init</a></li><li data-type='method'><a href="module-aj.html#.mod">mod</a></li><li data-type='method'><a href="module-aj.html#.perm">perm</a></li><li data-type='method'><a href="module-aj.html#.plugin">plugin</a></li><li data-type='method'><a href="module-aj.html#.rs">rs</a></li></ul></li><li><a href="module-art.html">art</a><ul class='methods'><li data-type='method'><a href="module-art.html#.complex">complex</a></li><li data-type='method'><a href="module-art.html#.form">form</a></li></ul></li></ul> </nav> <div id="main"> <h1 class="page-title">art</h1> <section> <header> </header> <article> <div class="container-overview"> <dl class="details"> </dl> <div class="description usertext"><h2>art命令</h2> <h3>1. 基本使用</h3> <p>art命令的专用语法如下:</p> <pre class="prettyprint source lang-shell"><code>art &lt;command> [options1|options2|options3...] </code></pre> <h3>2. 命令列表</h3> <table> <thead> <tr> <th>命令执行</th> <th style="text-align:left">含义</th> </tr> </thead> <tbody> <tr> <td>art complex</td> <td style="text-align:left">「模块」生成<code>ExListComplex</code>专用模块。</td> </tr> <tr> <td>art form</td> <td style="text-align:left">「组件」生成<code>ExForm</code>专用组件。</td> </tr> </tbody> </table> <h3>3. 标准化配置</h3> <pre class="prettyprint source lang-js"><code>{ module: 'ZT环境变量设置的模块', language: 'Z_LANGUAGE语言环境变量设置,默认「cn」', pathRoot: '系统根据执行目录计算的当前项目根目录', pathResource: '资源目录', pathUi: '生成代码目录', namespace: 'Cab.json中所需的名空间值', input: { params: { MODULE: '当前模块的文字描述名称', API: '构造标准接口`/api/xxx`的RESTful接口专用路径替换部分。', IDENTIFIER: '模型的统一标识符,最终会绑定到identifier中。' }, tpl: { type: '使用的模板tpl文件目录,cab/下的目录名', source: '「单文件」单文件的拷贝源', target: '「单文件」单文件的目标拷贝文件' } }, runtime: { namespaceFile: 'Cab.json文件生成路径', resource: '资源文件的根目录', resourceFiles: { 'fileName1': '资源文件地址,json后缀,模板则是fileName1.tpl文件', 'fileName2': '......' }, ui: '代码文件根目录', uiFiles: { 'fileName1': '代码文件地址,js后缀,模板则是fileName1.tpl文件', 'fileName2': '......' } } } </code></pre> <h3>4. 标准化模板参数</h3> <blockquote> <p><code>tpl</code>文件中替换的部分会使用配置文件中的参数来替换。</p> </blockquote> <table> <thead> <tr> <th style="text-align:left">参数</th> <th>替换部分</th> <th style="text-align:left">含义</th> </tr> </thead> <tbody> <tr> <td style="text-align:left">MODULE</td> <td><code>#MODULE#</code></td> <td style="text-align:left">当前模块的文字描述名称。</td> </tr> <tr> <td style="text-align:left">API</td> <td><code>#API#</code></td> <td style="text-align:left">构造标准接口<code>/api/xxx</code>的RESTful接口专用路径替换部分。</td> </tr> <tr> <td style="text-align:left">IDENTIFIER</td> <td><code>#IDENTIFIER#</code></td> <td style="text-align:left">模型的统一标识符,最终会绑定到identifier中。</td> </tr> <tr> <td style="text-align:left">NAME</td> <td><code>#NAME#</code></td> <td style="text-align:left">绑定文件设定,直接赋值<code>input.params.NAME = tpl.target</code>生成单文件专用。</td> </tr> <tr> <td style="text-align:left">SIGMA</td> <td><code>#SIGMA</code></td> <td style="text-align:left">SIGMA统一标识符,用于标识租户、应用。</td> </tr> <tr> <td style="text-align:left">ROLE_ID</td> <td><code>#ROLE_ID#</code></td> <td style="text-align:left">操作的角色ID。</td> </tr> <tr> <td style="text-align:left">PREFIX</td> <td></td> <td style="text-align:left">生成文件专用参数,不在模板中。</td> </tr> <tr> <td style="text-align:left">SHEET</td> <td></td> <td style="text-align:left">工作专用的Sheet名,不在模板中。</td> </tr> </tbody> </table></div> </div> <h3 class="subsection-title">Methods</h3> <h4 class="name" id=".complex"><span class="type-signature">(static) </span>complex<span class="signature">()</span><span class="type-signature"></span></h4> <dl class="details"> </dl> <div class="description usertext"> <h2><code>art complex</code></h2> <h3>1. 命令</h3> <pre class="prettyprint source lang-shell"><code>art complex </code></pre> <table> <thead> <tr> <th>短参</th> <th>全参</th> <th>类型</th> <th>默认</th> <th style="text-align:left">含义</th> </tr> </thead> <tbody> <tr> <td>-c</td> <td>--config</td> <td>String</td> <td><code>ui.json</code></td> <td style="text-align:left">配置文件路径。</td> </tr> </tbody> </table> <h3>2. 介绍</h3> <p>使用该命令生成完整的<code>ExListComplex</code>完整组件页。</p> <h3>3. 执行</h3> <pre class="prettyprint source lang-shell"><code>art complex # ...省略部分... [Zero AI] Zero AI 系统启动...... [Zero AI] Zero AI 加载输入参数: { &quot;config&quot;: &quot;ui.json&quot; } [Zero AI] 「启用ZT环境」,当前模块:generated/test,特殊命令只能在ZT环境使用。 [Zero AI] Zero AI 0. 基础环境...... [Zero AI] 环境变量:ZT = generated/test [Zero AI] 模块信息:generated/test [Zero AI] 语言信息:cn [Zero AI] 项目目录:&lt;项目根目录> [Zero AI] Zero AI 1. 目录检查...... [Zero AI] Zero AI 2. 文件表: [Zero AI] UI.Add = &lt;项目根目录>/src/cab/cn/components/generated/test/UI.Add.json [Zero AI] UI.Edit = &lt;项目根目录>/src/cab/cn/components/generated/test/UI.Edit.json [Zero AI] UI.Filter = &lt;项目根目录>/src/cab/cn/components/generated/test/UI.Filter.json [Zero AI] UI = &lt;项目根目录>/src/cab/cn/components/generated/test/UI.json [Zero AI] UI = &lt;项目根目录>/src/components/generated/test/UI.js [Zero AI] Op = &lt;项目根目录>/src/components/generated/test/Op.js [Zero AI] UI.Form = &lt;项目根目录>/src/components/generated/test/UI.Form.js [Zero AI] Zero AI 3. 执行React命令...... [Zero AI] Zero AI 3.1. 创建名空间文件...... [Zero AI] (Sync)成功将数据写入到文件:&lt;项目根目录>/src/components/generated/test/Cab.json! [Zero AI] Zero AI 3.2. 构造资源文件...... [Zero AI] (Sync)成功将数据写入到文件:&lt;项目根目录>/src/cab/cn/components/generated/test/UI.Add.json! [Zero AI] (Sync)成功将数据写入到文件:&lt;项目根目录>/src/cab/cn/components/generated/test/UI.Edit.json! [Zero AI] (Sync)成功将数据写入到文件:&lt;项目根目录>/src/cab/cn/components/generated/test/UI.Filter.json! [Zero AI] (Sync)成功将数据写入到文件:&lt;项目根目录>/src/cab/cn/components/generated/test/UI.json! [Zero AI] Zero AI 3.3. 构造界面文件...... [Zero AI] (Sync)成功将数据写入到文件:&lt;项目根目录>/src/components/generated/test/UI.js! [Zero AI] (Sync)成功将数据写入到文件:&lt;项目根目录>/src/components/generated/test/Op.js! [Zero AI] (Sync)成功将数据写入到文件:&lt;项目根目录>/src/components/generated/test/UI.Form.js! [Zero AI] Zero AI 4. 命令执行完成!!! </code></pre> <p>代码执行完成后会在项目中生成Zero UI专用模块<code>generated/test</code>的所有页面以及组件。</p> <ul> <li>执行代码之前先执行<code>export ZT=generated/test</code>确保<code>ZT</code>环境变量有值。</li> <li>执行位置可以是当前项目中的任意一个路径,脚本会自己计算当前项目的根目录(Zero UI专用)。</li> <li>该命令执行时模板文件位置位于<code>src/cab/list</code>目录中,且模板文件以<code>tpl</code>结尾。</li> </ul> <h3>4. 生成的文件说明</h3> <table> <thead> <tr> <th style="text-align:left">文件名</th> <th style="text-align:left">模板</th> <th style="text-align:left">含义</th> </tr> </thead> <tbody> <tr> <td style="text-align:left">Cab.json</td> <td style="text-align:left"></td> <td style="text-align:left">名空间关联文件,计算得来。</td> </tr> <tr> <td style="text-align:left">UI.Add.json</td> <td style="text-align:left">UI.Add.json.tpl</td> <td style="text-align:left">「无字段」添加表单专用资源文件。</td> </tr> <tr> <td style="text-align:left">UI.Edit.json</td> <td style="text-align:left">UI.Edit.json.tpl</td> <td style="text-align:left">「无字段」编辑表单专用资源文件。</td> </tr> <tr> <td style="text-align:left">UI.Filter.json</td> <td style="text-align:left">UI.Filter.json.tpl</td> <td style="text-align:left">过滤表单专用资源文件(高级搜索用)。</td> </tr> <tr> <td style="text-align:left">UI.json</td> <td style="text-align:left">UI.json.tpl</td> <td style="text-align:left">主界面资源文件。</td> </tr> <tr> <td style="text-align:left">UI.js</td> <td style="text-align:left">UI.js.tpl</td> <td style="text-align:left">主界面脚本文件。</td> </tr> <tr> <td style="text-align:left">Op.js</td> <td style="text-align:left">Op.js.tpl</td> <td style="text-align:left">Action/Callback专用Js事件脚本。</td> </tr> <tr> <td style="text-align:left">UI.Form.js</td> <td style="text-align:left">UI.Form.js.tpl</td> <td style="text-align:left">三个表单合一的专用Js脚本。</td> </tr> </tbody> </table> </div> <h4 class="name" id=".form"><span class="type-signature">(static) </span>form<span class="signature">()</span><span class="type-signature"></span></h4> <dl class="details"> </dl> <div class="description usertext"> <h2><code>art form</code></h2> <h3>1. 命令</h3> <pre class="prettyprint source lang-shell"><code>art form -u &lt;ui> </code></pre> <table> <thead> <tr> <th>短参</th> <th>全参</th> <th>类型</th> <th>默认</th> <th style="text-align:left">含义</th> </tr> </thead> <tbody> <tr> <td>-u</td> <td>--ui</td> <td>String</td> <td></td> <td style="text-align:left">生成的文件名,最终生成<code>&lt;Name&gt;.json/&lt;Name&gt;.js</code></td> </tr> <tr> <td>-c</td> <td>--config</td> <td>String</td> <td><code>ui.json</code></td> <td style="text-align:left">配置文件路径。</td> </tr> </tbody> </table> <h3>2. 介绍</h3> <p>使用该命令生成完整的<code>ExForm</code>完整表单组件页。</p> <h3>3. 执行</h3> <pre class="prettyprint source lang-shell"><code>art form -u UI.Basic # ...省略部分... [Zero AI] Zero AI 系统启动...... [Zero AI] Zero AI 加载输入参数: { &quot;config&quot;: &quot;ui.json&quot;, &quot;ui&quot;: &quot;UI.Basic&quot; } [Zero AI] 「启用ZT环境」,当前模块:generated/test,特殊命令只能在ZT环境使用。 [Zero AI] Zero AI 0. 基础环境...... [Zero AI] 环境变量:ZT = generated/test [Zero AI] 模块信息:generated/test [Zero AI] 语言信息:cn [Zero AI] 项目目录:&lt;项目根目录> [Zero AI] Zero AI 1. 目录检查...... [Zero AI] Zero AI 2. 文件表: [Zero AI] Zero AI 3. 执行React命令...... [Zero AI] Zero AI 3.1. 创建名空间文件...... [Zero AI] Zero AI 3.2. 构造资源文件...... [Zero AI] (Sync)成功将数据写入到文件:&lt;项目根目录>/src/cab/cn/components/generated/test/UI.Basic.json! [Zero AI] Zero AI 3.3. 构造界面文件...... [Zero AI] (Sync)成功将数据写入到文件:&lt;项目根目录>/src/components/generated/test/UI.Basic.js! [Zero AI] Zero AI 4. 命令执行完成!!! </code></pre> <p>代码执行完成后会在项目中生成Zero UI专用模块<code>generated/test</code>中唯一的两个页面。</p> <ul> <li>执行代码之前先执行<code>export ZT=generated/test</code>确保<code>ZT</code>环境变量有值。</li> <li>该命令执行时模板文件位置位于<code>src/cab/form</code>目录中,且模板文件以<code>tpl</code>结尾。</li> <li>生成的<code>UI.js</code>的按钮部分直接位于当前文件中,并且默认包含了<code>ADD, EDIT, DELETE</code>三个核心按钮。</li> </ul> <h3>4. 生成的文件说明</h3> </div> </article> </section> </div> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Sun Jul 23 2023 12:31:31 GMT+0800 (China Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme. </footer> <script>prettyPrint();</script> <script src="scripts/polyfill.js"></script> <script src="scripts/linenumber.js"></script> <script src="scripts/search.js" defer></script> </body> </html>