# editable

**Repository Path**: funsent/editable

## Basic Information

- **Project Name**: editable
- **Description**: Javascript实现的可编辑表格插件（快速录单插件）
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2023-04-16
- **Last Updated**: 2023-09-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: JavaScript, editable, Web

## README

# funsent-editable

## jQuery实现的的轻量级可编辑表格插件，适用于快速录单等应用场景，支持键盘操作

---

#### 开发缘由和插件介绍

工作中经常碰到一种需求场景，当我们在添加数据记录的时候，其附带的一些数据需要以关联数据（在数据库中表现为关联的数据表）形式一同添加，比如在采购单录单、添加人员基本信息时需要一同填写人员的履历、经验和获奖证书等情况，而这些关联数据本身又是一条一条的记录，所以亟需一种可编辑的子表格，能方便嵌入到现有表单中。

网络上这种类似的功能插件很多，但不是太复杂就是操作太繁琐，也往往和录单本身需要的功能初心相悖，所以自己就做了一个类似的插件，以便可以重复使用。这个插件完全是用在web前端页面的，可方便嵌入到web应用中，考虑到时间问题，所以用了jQuery实现，有点类似于easyui的datagrid，但easyui的datagrid默认不支持键盘操作和新增删除列，需要自己扩展，索性就自己单独实现一个轻量的类datagrid插件，应该说适合自己的才是最好的。

#### 插件演示

[demo演示地址](https://funsent.github.io/editable/)

> 以上演示地址使用的是 GitHub Pages 服务

![editable demo 演示](tests/demo.png)

![editable多实例 实际项目中的演示](tests/instances.png)

#### 插件使用

1.  严格按照如下方式建立页面结构

```html
<div> <!-- 这层结构是必须的 -->
    <table id="editable1">
        <thead> <!-- thead是必须的 -->
            <tr>
                <th style="width:40px;"></th> <!-- 注意是th不是td -->
                <th style="width:100px;">证书名称</th>
                <th style="width:100px;">证书编号</th>
                <th style="width:100px;">颁发日期</th>
                <th style="width:100px;">颁发机构</th>
                <th style="width:100px;">备注</th>
            </tr>
        </thead>

        <tbody> <!-- tbody是必须的 -->
            <tr>
                <td></td> <!-- 这里才是td -->
                <td></td>
                <td></td>
                <td></td>
                <td></td>
                <td></td>
            </tr>
        </tbody>
    </table>

    <table id="editable2">
        <thead> <!-- thead是必须的 -->
            <tr>
                <th style="width:40px;"></th> <!-- 注意是th不是td -->
                <th style="width:100px;">证书名称</th>
                <th style="width:100px;">证书编号</th>
                <th style="width:100px;">颁发日期</th>
                <th style="width:100px;">颁发机构</th>
                <th style="width:100px;">备注</th>
            </tr>
        </thead>

        <tbody> <!-- tbody是必须的 -->
            <tr>
                <td></td> <!-- 这里才是td -->
                <td></td>
                <td></td>
                <td></td>
                <td></td>
                <td></td>
            </tr>
        </tbody>
    </table>
</div>
```

2.  引入jQuery.js、layer.js、laydate.js、editable.js


```shell
# git clone https://gitee.com/funsent/editable.git
```

```javascript
<script src="js/jquery.min.js"></script>
<link rel="stylesheet" type="text/css" href="js/laydate/laydate.css" />
<script src="js/laydate/laydate.js"></script>
<script src="js/layer/layer.js"></script>
<script src="../src/editable.js"></script>
```

> jQuery、layer、laydate 可自行到相关官网下载，或使用editable插件目录的现有文件


3.  初始化，两个table转成可编辑的表格

```javascript
let values = {0:'禁用', 1:'启用'}; // select下拉框的可选数据来源

funsent.editable.init('#editable1', {
    tag: 'editable1_tag',
    row_number: 3,
    editable_row_max: 10,
    enable_keyboard: true,
    enable_tab_insert: true,
    enable_button: true,
    columns: [
        0,//{type:'checkbox', name:'id', value:'', readonly:false},
        {type:'text', name:'name', value:'', align:'left', readonly:false},
        {type:'text', name:'certno', value:'', align:'left', readonly:false},
        {type:'date', name:'issue_time', value:'', align:'center', readonly:true},
        {type:'text', name:'issue_body', value:'', align:'left', readonly:false},
        {type:'select', name:'remark', value:'1', align:'left', readonly:false, values:values, style:{padding:'4px 4px 5px'}},
    ]
});

funsent.editable.init('#editable2', {
    tag: 'editable2_tag',
    row_number: 3,
    editable_row_max: 10,
    enable_keyboard: true,
    enable_tab_insert: true,
    enable_button: true,
    columns: [
        {type:'checkbox', name:'id', value:'', readonly:false},
        {type:'text', name:'name', value:'', align:'left', readonly:false},
        {type:'text', name:'certno', value:'', align:'left', readonly:false},
        {type:'date', name:'issue_time', value:'', align:'center', readonly:true},
        {type:'text', name:'issue_body', value:'', align:'left', readonly:false},
        {type:'select', name:'remark', value:'1', align:'left', readonly:false, values:values, style:{padding:'4px 4px 5px'}},
    ]
});
```
> 以上步骤后就完成了editable插件的页面载入和使用

4.  数据收集

> 如果需要提交表单数据到后台，可用如下方法

```javascript
// 获取方法一：参数以字符串样式给出
let arr = funsent.editable.data('#editable1'); // 获取editable1数据
let arr = funsent.editable.data('#editable2'); // 获取editable2数据

// 获取方法二: 参数以dom对象或jQuery对象形式给出
let arr = funsent.editable.data(document.querySelector('#editable1')); // 获取editable1数据
let arr = funsent.editable.data(document.querySelector('#editable2')); // 获取editable2数据
let arr = funsent.editable.data($('#editable1')); // 获取editable1数据
let arr = funsent.editable.data($('#editable2')); // 获取editable2数据

// 获取方法三：参数以实例化顺序索引给出
let arr = funsent.editable.data(0); // 获取editable1数据
let arr = funsent.editable.data(1); // 获取editable2数据

// 获取方法四：参数以自定义标签给出
let arr = funsent.editable.data({tag:'editable1_tag'}); // 获取editable1数据
let arr = funsent.editable.data({tag:'editable2_tag'}); // 获取editable2数据
```

>  返回的是json对象数组，如果提交到服务器后，则请自行处理

5. 数据填充（回填）

```javascript

// 输入填充格式，如果从后台返回，则需要时对象数组形式传入
let records = [
    {name:"", age:"", address""},
    {name:"", age:"", address""},
    {name:"", age:"", address""},
    {name:"", age:"", address""}
];

// 同样有如下几种填充方式，任选一种
funsent.editable.fill('#editable1', records);
funsent.editable.fill(document.querySelector('#editable1'), records);
funsent.editable.fill($('#editable1'), records);
funsent.editable.fill(0, records);
funsent.editable.fill({tag:'editable1_tag'}, records);
```

> fill方法返回true表示成功，false表示失败

#### 数据调试

```javascript
// 新增的info方法用于输出editable内部存储的数据格式，供大家开发调试时使用
console.log(funsent.editable.info());
```

#### 已实现列类型

1. 序号列（不可编辑，由插件内部自动维护序号）
2. 原始数据列（不可编辑，保持原有td元素的值，或者可选择设置空字符串值）
3. 复选框checkbox列（编辑列，始终居中，可传入默认值，支持常用样式定义）
4. 下拉选择select列（编辑列，可传入默认值和下拉数据源，支持常用样式定义）
5. 普通文本text列（编辑列，可传入默认值，支持常用样式定义）
6. 日期选择date列（编辑列，普通文本text列的变种，默认只选不写）

#### 插件特性

- 支持列配置，通过传入对象数组配置列，有点类似于datagrid的传参方式
- 支持参数配置，通过调用config方法，传入json对象格式的参数
- 支持工具按钮，目前实现了上方插入行、下方插入行、删除行这三个功能
- 支持键盘按键操作，支持上下左右方向键、回车键、TAB键等操作
- 支持最后一个元素上按TAB键新增行功能（这点在快速录单中特别需要）
- 支持获取列数据，可用于表单提交
- 支持序号自维护（这点也是客户特别需要的）
- 支持某行某列不启用编辑功能
- 支持是否启用按键、是否启用工具按钮等独立配置参数、
- 支持module方式引入


#### 意见建议

**联系方式**
QQ: 2018708，微信：younggf

> 加好友时请备注：editable插件