## 自定義字段 提供給開發者新增自己想要的表單字段類型`type`，在調用表單構建器`field`方法時使用。注意：`type`名不能與系統提供的類型名沖突，否者會被系統類型覆蓋。 ## 使用 * 定義自定義字段和可重寫方法 ```javascript // 必須使用模塊FormField并繼承 layui.define(['FormField'], function (exports) { let FormField = layui.FormField; class DemoField extends FormField { constructor(options) { super(options); } // 定義額外的args參數 defineExtraArgs() { return {}; } // 進一步處理args // 例：可以在此處加上默認的字段驗證規則 handleArgs(args) { return args; } // 定義字段外部包裹元素html結構，id和__layout__必須 defineBoxHtml() { let that = this; return `<div class="layui-form-item yunj-form-item" id="${that.id}">__layout__</div>`; } // 返回字段標題的html結構 layoutLabel() { let that = this; let labelHtml = ''; if (!that.args.hasOwnProperty("title")) return labelHtml; if (that.args.verify && that.args.verify.indexOf('require') !== -1) labelHtml += `<span class="require">*</span>`; labelHtml += that.args.title; return `<label class="layui-form-label">${labelHtml}</label>`; } // 返回字段控件的html結構 layoutControl() { let that = this; // 可根據屬性that.args來設置結構 return `<div class="layui-input-inline yunj-form-item-control">...</div>`; } // 返回字段簡介的html結構 layoutDesc() { let that = this; if (!that.args.hasOwnProperty("desc")) return ""; return `<div class="yunj-form-item-desc">${that.args.desc}</div>`; } // 渲染前執行 async renderBefore() { return 'done'; } // 渲染后執行 async renderDone() { return 'done'; } // 渲染完后設置值 renderDoneSetValue(val) { let that = this; that.setValue(val); }; // 設置值 setValue(val = '', isReset = false) { let that=this; // that.fieldBoxEl 為當前控件外部父元素 that.fieldBoxEl.find(....).val(val); } // 獲取值 getValue() { let that=this; // that.fieldBoxEl 為當前控件外部父元素 return that.fieldBoxEl.find(...).val(); } // 定義額外的事件綁定 defineExtraEventBind() { } } // 模塊名需以 FormField+首字母大寫 exports('FormFieldDemo', DemoField); }); ``` * 自定義字段可調用方法 ```javascript layui.use(['yunj'], function () { let win = window; let doc = document; yunj.formField("demo",{ "formId":"test", "key":"demo_test", "args":{title:"測試字段"} }).then(field=>{ // field為返回字段對象，可通過字段對象調用常用方法 ... }); } ``` 常用方法如下： * **field.render(parentSelector, fieldOutLayout)** 字段渲染 參數： | key | 類型 | 必須 | 說明 | | --- | --- | --- | --- | | parentSelector | string | Y | 外部父容器的jquery選擇器 | | fieldOutLayout | string | N | 外部附加結構，例`<div>__layout__</div>`，__layout__必須 | 返回值：promise對象 > 示例：新增一個字段類型`showTime`，用來顯示表單的操作時間。 * 首先，創建php文件：\application\demo\libs\control\field\ShowTime.php ```php namespace app\demo\libs\control\field; use yunj\control\field\YunjField; class ShowTime extends YunjField { private static $instance; public static function instance(){ if (!self::$instance instanceof self){ self::$instance = new self(); } return self::$instance; } // 定義額外配置項（無額外配置項可不寫） protected function defineExtraArgs(): array { return [ 'format' => 'Y-m-d H:i:s', // 時間格式 ]; } // 處理配置項（不需要處理可不寫） protected function handleArgs(array $args) : array{ return $args; } } ``` * 其次，創建js文件：/public/static/demo/js/modules/field/show-time.js ```javascript layui.define(['FormField'], function (exports) { let FormField = layui.FormField; class FormFieldShowTime extends FormField { constructor(obj={}) { super(obj); } // 控件結構 layoutControl() { let that = this; let controlHtml = `<input type="text" name="${that.id}" ${that.args.required ? 'lay-verify="required"' : ''} placeholder="${that.args.placeholder}" value="" readonly autocomplete="off" class="layui-input">`; return `<div class="layui-input-inline yunj-input-inline">${controlHtml}</div>`; } // 設置值 setValue(val=''){ let that=this; if(!val){ let currTimestamp=yunj.currTimestamp(true); val=yunj.timestampFormat(currTimestamp,that.args.format); } that.fieldBoxEl.find(`input:text[name=${that.id}]`).val(val); } // 獲取值 getValue(){ let that=this; return that.fieldBoxEl.find(`input:text[name=${that.id}]`).val(); } } exports('FormFieldShowTime', FormFieldShowTime); }); ``` * 然后，添加配置：\application\yunj\config\control.php ```php return [ // 表單字段 'fields'=>[ 'showTime'=>[ 'args'=>'\\app\\demo\\libs\\control\\field\\ShowTime', 'module'=>'/static/demo/js/modules/show-time', ], ], ]; ``` * 最后，調用表單構建器配置字段 ```php $builder=YF('general_example') ->tab(['base'=>'基礎','other'=>'其他']) ->field(function ($tab){ $field=[ 'demoShowTime'=>[ 'title'=>'操作時間', 'type'=>'showTime', //'value'=>'2020-12-03 19:17:12', ],... ]; return $field; }) ``` > 結果展示：