Merge pull request #1246 from Sight-wcg/patch-docs

部分文档细节优化

docs/carousel/index.md

@@ -64,7 +64,7 @@ inst.reload(options); // 轮播重载
 </div>
 
 
-<h3 id="goto" lay-toc="{level: 2}">切换</h3>
+<h3 id="goto" lay-toc="{level: 2}">切换 <sup>2.8+</sup></h3>
 
 `inst.goto(index);`
 

docs/class/index.md

@@ -75,7 +75,7 @@ toc: true
 | layui-bg-orange | 橙 | <div class="layui-bg-orange">&nbsp;</div> |
 | layui-bg-green |  绿 | <div class="layui-bg-green">&nbsp;</div> |
 | layui-bg-blue |  蓝 | <div class="layui-bg-blue">&nbsp;</div> |
-| layui-bg-purple | 紫 | <div class="layui-bg-purple">&nbsp;</div> |
+| layui-bg-purple <sup>2.8+</sup> | 紫 | <div class="layui-bg-purple">&nbsp;</div> |
 | layui-bg-black | 深 | <div class="layui-bg-black">&nbsp;</div> |
 | layui-bg-gray |  浅 | <div class="layui-bg-gray">&nbsp;</div> |
 
@@ -104,7 +104,7 @@ toc: true
 | layui-font-orange | <span class="layui-font-orange">橙</span> |
 | layui-font-green | <span class="layui-font-green">绿</span> |
 | layui-font-blue | <span class="layui-font-blue">蓝</span> |
-| layui-font-purple | <span class="layui-font-purple">紫</span> |
+| layui-font-purple <sup>2.8+</sup> | <span class="layui-font-purple">紫</span> |
 | layui-font-black | <span class="layui-font-black">深</span> |
 | layui-font-gray | <span class="layui-font-gray">浅</span> |
 

docs/laydate/detail/options.md

@@ -89,7 +89,7 @@ range: ['#start', '#end']
 <td>rangeLinked <sup>2.8+</sup></td>
 <td>
 
-是否开启日期范围选择时的区间联动标注模式，该必须开启 `range` 属性后生效。日期范围默认采用的是*左右面板独立选择模式*，设置该属性后，将采用*左右面板联动选择模式*。
+是否开启日期范围选择时的区间联动标注模式，该模式必须开启 `range` 属性才能生效。日期范围默认采用的是*左右面板独立选择模式*，设置该属性后，将采用*左右面板联动选择模式*。
 <br>效果详见： [#示例](#demo-range)
 
 </td>
@@ -356,7 +356,7 @@ max: 7 // 最大日期为 7 天后
 <td>zIndex</td>
 <td>
   
-设置组件面板的层叠顺序。一般用于解决与其它元素的互相被遮掩的问题。若 `positio: 'tatic'` 时，则该属性无效。
+设置组件面板的层叠顺序。一般用于解决与其它元素的互相被遮掩的问题。若 `position: 'static'` 时，则该属性无效。
 
 </td>
 <td>number</td>
@@ -465,7 +465,7 @@ btns: ['clear', 'confirm']
 
 <div id="options.theme" class="ws-anchor">
 
-设置组件面板主题。除了默认主题，还内置主题： `molv` `grid` ，且支持直接传入自定义的主题色。
+设置组件面板主题。除了默认主题，还内置主题： `molv` `grid` `circle`<sup>2.8+</sup> ，且支持直接传入自定义的主题色。
 
 </div> 
 
@@ -508,7 +508,9 @@ theme: ['grid', '#FF5722']
 <td>
   
 <div id="options.mark" class="ws-anchor">
+
 自定义日期标记。该属性是对 `calendar` 属性的进一步延伸，灵活度更高。属性可批量设置多个日期标记，如：
+
 </div>
 
 ```

docs/laydate/examples/theme.md

@@ -18,6 +18,12 @@
         <input type="text" class="layui-input" id="ID-laydate-theme-grid" placeholder="yyyy-MM-dd">
       </div>
     </div>
+    <div class="layui-inline">
+      <label class="layui-form-label">圆圈高亮主题</label>
+      <div class="layui-input-inline">
+        <input type="text" class="layui-input" id="ID-laydate-theme-circle" placeholder="yyyy-MM-dd">
+      </div>
+    </div>
     <div class="layui-inline">
       <label class="layui-form-label">混合主题</label>
       <div class="layui-input-inline">
@@ -50,6 +56,12 @@ layui.use(function(){
     theme: 'grid'
   });
 
+  // 圆圈高亮主题
+  laydate.render({
+    elem: 'ID-laydate-theme-circle',
+    theme: 'circle' // 2.8+新增主题
+  });
+
   // 混合主题
   laydate.render({
     elem: '#ID-laydate-theme-multi',

docs/laydate/index.md

@@ -36,7 +36,7 @@ toc: true
 | [laydate.getInst(id)](#getInst) <sup>2.8+</sup> | 获取组件对应的渲染实例。 |
 | [laydate.unbind(id)](#close) <sup>2.8+</sup> | 对目标元素解除当前实例的绑定。 |
 | [laydate.close(id)](#close) <sup>2.7+</sup> | 关闭日期面板。 |
-| [laydate.getEndDate(month, year)](#getEndDate) | 获取某月的最后一天 |
+| [laydate.getEndDate(month, year)](#getEndDate) | 获取某月的最后一天。 |
 
 <h3 id="render" lay-toc="{level: 2}">渲染</h3>
 
@@ -106,7 +106,7 @@ laydate.hint('test', {
 
 - 参数 `id` : 组件渲染时定义的 `id` 属性值
 
-该方法用于在获取 laydate 对应 id 的渲染实例，以获得该实例对应的成员属性。
+该方法用于获取 laydate 对应 id 的渲染实例，以获得该实例对应的成员属性。
 
 ```
 var laydate = layui.laydate;
@@ -128,7 +128,7 @@ console.log(inst); // 实例对象
 
 - 参数 `id` : 组件渲染时定义的 `id` 属性值
 
-该方法用于对目标元素对应的实例的完全解除，即触发元素事件时，不再执行组件渲染。
+该方法用于对目标元素对应的实例的绑定完全解除，即触发元素事件时，不再执行组件渲染。
 
 ```
 var laydate = layui.laydate;

docs/menu/index.md

@@ -43,7 +43,7 @@ toc: true
 | 属性 | 描述 |
 | --- | --- |
 | title | 设置菜单标题。默认读取标题容器内容中的文本。 |
-| type | 设置菜单类型。可选值如下：<ul><li>若不设定，则表示为常规菜单项</li><li>`type:'group` 菜单组，子菜单为纵向层级</li><li>`type:'parent'` 父级菜单，子菜单为横向层级</li></ul> |
+| type | 设置菜单类型。可选值如下：<ul><li>若不设定，则表示为常规菜单项</li><li>`type:'group'` 菜单组，子菜单为纵向层级</li><li>`type:'parent'` 父级菜单，子菜单为横向层级</li></ul> |
 | isAllowSpread | 子菜单是否允许展开收缩操作。默认 `true` |
 
 <h3 id="on" lay-toc="{}" class="ws-bold">事件</h3>

docs/table/index.md

@@ -493,7 +493,7 @@ table.hideCol('test', false); // `true` or `false`
 | [row / rowDouble](#on-row) | 行单击和双击事件 |
 | [rowContextmenu](#on-rowContextmenu) <sup>2.8+</sup> | 行右键菜单事件 |
 | [edit](#on-edit) | 单元格编辑事件 |
-| [tool](#on-tool) 🔥 | 单元格工具事件。可在该事件中实现行的更新与删除操作。 |
+| [tool / toolDouble](#on-tool) 🔥 | 单元格工具事件。可在该事件中实现行的更新与删除操作。 |
 | [checkbox](#on-checkbox) | 复选框事件 |
 | [radio](#on-radio) | 单选框事件 |
 | [pagebar](#on-pagebar) <sup>2.7+</sup> | 尾部分页栏事件 |

docs/treeTable/detail/options.md

@@ -58,8 +58,8 @@ treeTable.render({
 | isParent | 自定义「是否属于父节点」的属性名 | string | `isParent` |
 | name | 自定义「节点」属性名 | string | `name` |
 | id | 自定义「节点索引」属性名 | string | `id` |
-| pid | 自定义「父节点索引」属性名 | string | `pid` |
-| rootIid | 自定义「根节点索引」属性名 | string | - |
+| pid | 自定义「父节点索引」属性名 | string | `parentId` |
+| rootId | 自定义「根节点索引」属性名 | string | - |
 
 </td>
     </tr>
@@ -121,8 +121,8 @@ treeTable.render({
 | type | 请求的接口类型，设置可缺省同上 | string | - |
 | contentType | 提交参数的数据类型，设置可缺省同上 | string | - |
 | headers | 提交请求头，设置可缺省同上 | object | - |
-| where | 提交参数的数据，设置可缺省同 | object | - |
-| autoParam | 自动参数，可以根据配置项以及当前节点的数据传参，如： `['type', 'age=age', 'pId=id']` ，那么其请求参数将包含: `{type: '父节点 type', age: '父节点 age', pId: '父节点 id'}` | array | - | 
+| where | 提交参数的数据，设置可缺省同上 | object | - |
+| autoParam | 自动参数，可以根据配置项以及当前节点的数据传参，如： `['type', 'age=age', 'parentId=id']` ，那么其请求参数将包含: `{type: '父节点 type', age: '父节点 age', parentId: '父节点 id'}` | array | - |
 
 </td>
     </tr>

docs/treeTable/index.md

@@ -36,7 +36,7 @@ toc: true
 | [treeTable.expandAll(id, expandFlag)](#expandAll)  | 展开或关闭全部节点（目前只支持关闭全部）。 |
 | [treeTable.setRowChecked(id, opts)](#setRowChecked) | 设置行选中状态 |
 | [treeTable.checkAllNodes(id, checked)](#checkAllNodes) | 全选或取消全选 |
-| [treeTable.on('event(filter)', callback)](#on) | treeTable 相关事件 |
+| [treeTable.on(\'event(filter)\', callback)](#on) | treeTable 相关事件 |
 
 <h3 id="render" lay-toc="{level: 2}">渲染</h3>
 
@@ -200,7 +200,7 @@ treeTable.addNodes('test', {
 | inherit | 子节点是否继承父节点的展开或关闭状态，`expandFlag` 属性必须为 `boolean` 型时才有效。 | boolean | `false` |
 | callbackFlag | 是否触发事件（`beforeExpand,onExpand`） | boolean | `false` |
 
-若操作的节点不是一个父节点，则返回 `null` ，否则返回操作之后的折叠状态。
+若操作的节点不是一个父节点，则返回 `null`，否则返回操作之后的折叠状态。
 
 ```js
 // 渲染

docs/upload/detail/options.md

@@ -143,7 +143,9 @@ acceptMime: 'image/jpeg, image/png` // 只筛选 jpg,png 格式图片
 <td>
 
 <div id="options.exts" class="ws-anchor">
+
 允许上传的文件后缀。一般结合 `accept` 属性来设定。
+
 </div>  
 
 - 假设 `accept: 'file'` 类型时，那么设置 `exts: 'zip|rar|7z'` 即代表只允许上传压缩格式的文件。
@@ -188,7 +190,7 @@ acceptMime: 'image/jpeg, image/png` // 只筛选 jpg,png 格式图片
   
 规定强制返回的数据格式。
 
-- 若值为 'json'，则强制校验 JSON 数据格式
+- 若值为 `'json'`，则强制校验 JSON 数据格式
 
 </td>
 <td>string</td>

docs/versions.md

@@ -181,12 +181,14 @@ toc: true
   - 优化 部分代码存在的冗余逻辑 # 1169
 - #### code
   - 新增 `preview` 属性，用于开启 Code 预览功能
-  - 新增 `previewStyle/codeStyle` 属性，用于设 Code 区域、预览区域的样式
+  - 新增 `style/previewStyle/codeStyle` 属性，用于设 Code 区域、预览区域的样式
   - 新增 `text` 属性，用于自定义默认文本
   - 新增 `header` 属性，用于是否开启 Code 区域的头部栏
   - 新增 `layout` 属性，用于设定开启预览时的标签排列方式
   - 新增 `tools` 属性，用于开启头部右侧区域工具栏（内置：全屏）
   - 新增 `toolsEvent` 属性，用于自定义工具栏事件
+  - 新增 `id` 属性，设置实例的唯一索引，以便用于其他操作
+  - 新增 `className` 属性，追加实例面板的 className，以便对其自定义样式
   - 新增 `done` 属性，即执行 Code 预览后的回调函数
 - #### laytpl
   - 新增 模板局部自定义标签符功能，可在 `laytpl(str, options)` 的第二个参数中设置