Table: fix params on docs (#11774)

* Table: fix params on docs

* Table: add missing definitions

* Table: fix row style definitions

* Update table.d.ts
pull/11783/head
杨奕 2018-06-28 11:53:16 +08:00 committed by hetech
parent 3319846ecc
commit 4c40128b8a
4 changed files with 38 additions and 8 deletions

View File

@ -1963,8 +1963,8 @@ You can customize row index in `type=index` columns.
| cell-style | function that returns custom style for a cell, or an object assigning custom style for every cell | Function({row, column, rowIndex, columnIndex})/Object | — | — |
| header-row-class-name | function that returns custom class names for a row in table header, or a string assigning class names for every row in table header | Function({row, rowIndex})/String | — | — |
| header-row-style | function that returns custom style for a row in table header, or an object assigning custom style for every row in table header | Function({row, rowIndex})/Object | — | — |
| header-cell-class-name | function that returns custom class names for a cell in table header, or a string assigning class names for every cell in table header | Function({row, rowIndex})/String | — | — |
| header-cell-style | function that returns custom style for a cell in table header, or an object assigning custom style for every cell in table header | Function({row, rowIndex})/Object | — | — |
| header-cell-class-name | function that returns custom class names for a cell in table header, or a string assigning class names for every cell in table header | Function({row, column, rowIndex, columnIndex})/String | — | — |
| header-cell-style | function that returns custom style for a cell in table header, or an object assigning custom style for every cell in table header | Function({row, column, rowIndex, columnIndex})/Object | — | — |
| row-key | key of row data, used for optimizing rendering. Required if `reserve-selection` is on. When its type is String, multi-level access is supported, e.g. `user.info.id`, but `user.info[0].id` is not supported, in which case `Function` should be used. | Function(row)/String | — | — |
| empty-text | Displayed text when data is empty. You can customize this area with `slot="empty"` | String | — | No Data |
| default-expand-all | whether expand all rows by default, only works when the table has a column type="expand" | Boolean | — | false |

View File

@ -1966,8 +1966,8 @@ Puede personalizar el índice de la fila con la propiedad `type=index` de las co
| cell-style | función que devuelve estilos personalizados para una celda, o un objeto asignado a estilos personalizados para cada celda | Function({row, column, rowIndex, columnIndex})/Object | — | — |
| header-row-class-name | función que devuelve nombre de clases personalizadas para una fila en la cabecera de la tabla, o una cadena asignando nombres de clases para cada fila en la cabecera de la tabla | Function({row, rowIndex})/String | — | — |
| header-row-style | función que devuelve estilos personalizados para una fila en la cabecera de la tabla, o un objeto asignando estilos personalizados para cada fila en la cabecera de la tabla | Function({row, rowIndex})/Object | — | — |
| header-cell-class-name | función que devuelve nombre de clases personalizadas para una celda en la cabecera de la tabla, o una cadena asignando nombres de clases para cada celda en la cabecera de la tabla | Function({row, rowIndex})/String | — | — |
| header-cell-style | función que devuelve estilos personalizados para una celda en la cabecera de la tabla, o un objeto asignando estilos personalizados para cada celda en la cabecera de la tabla | Function({row, rowIndex})/Object | — | — |
| header-cell-class-name | función que devuelve nombre de clases personalizadas para una celda en la cabecera de la tabla, o una cadena asignando nombres de clases para cada celda en la cabecera de la tabla | Function({row, column, rowIndex, columnIndex})/String | — | — |
| header-cell-style | función que devuelve estilos personalizados para una celda en la cabecera de la tabla, o un objeto asignando estilos personalizados para cada celda en la cabecera de la tabla | Function({row, column, rowIndex, columnIndex})/Object | — | — |
| row-key | clave de datos de la fila, utilizada para optimizar la representación de los datos. Es obligatorio `reserve-selection` esta habilitado. Cuando su tipo es string, se permite el acceso multinivel, por ejemplo, `user.info.id`, pero `user.info[0].id` no es permitido, en cuyo caso se debe usar una `function` | Function(row)/String | — | — |
| empty-text | Texto mostrado cuando no existen datos. Puede personalizar esta área con `slot="empty"` | String | — | No Data |
| default-expand-all | especifica si todas las filas se expanden por defeto, solo funciona cuando la tabla tiene una columna `type="expand"` | Boolean | — | false |

View File

@ -2024,7 +2024,7 @@
| header-row-class-name | 表头行的 className 的回调方法,也可以使用字符串为所有表头行设置一个固定的 className。 | Function({row, rowIndex})/String | — | — |
| header-row-style | 表头行的 style 的回调方法,也可以使用一个固定的 Object 为所有表头行设置一样的 Style。 | Function({row, rowIndex})/Object | — | — |
| header-cell-class-name | 表头单元格的 className 的回调方法,也可以使用字符串为所有表头单元格设置一个固定的 className。 | Function({row, column, rowIndex, columnIndex})/String | — | — |
| header-cell-style | 表头单元格的 style 的回调方法,也可以使用一个固定的 Object 为所有表头单元格设置一样的 Style。 | Function({row, rowIndex, rowIndex, columnIndex})/Object | — | — |
| header-cell-style | 表头单元格的 style 的回调方法,也可以使用一个固定的 Object 为所有表头单元格设置一样的 Style。 | Function({row, column, rowIndex, columnIndex})/Object | — | — |
| row-key | 行数据的 Key用来优化 Table 的渲染;在使用 reserve-selection 功能的情况下,该属性是必填的。类型为 String 时,支持多层访问:`user.info.id`,但不支持 `user.info[0].id`,此种情况请使用 `Function`。 | Function(row)/String | — | — |
| empty-text | 空数据时显示的文本内容,也可以通过 `slot="empty"` 设置 | String | — | 暂无数据 |
| default-expand-all | 是否默认展开所有行,当 Table 中存在 type="expand" 的 Column 的时候有效 | Boolean | — | false |

36
types/table.d.ts vendored
View File

@ -17,6 +17,18 @@ export interface SummaryMethodParams {
data: object
}
export interface rowCallbackParams {
row: object,
rowIndex: number
}
export interface cellCallbackParams {
row: object,
rowIndex: number,
column: object,
columnIndex: number
}
/** Table Component */
export declare class ElTable extends ElementUIComponent {
/** Table data */
@ -47,10 +59,28 @@ export declare class ElTable extends ElementUIComponent {
currentRowKey: string | number
/** Function that returns custom class names for a row, or a string assigning class names for every row */
rowClassName: string | ((row: object, index: number) => string)
rowClassName: string | ((param: rowCallbackParams) => string)
/** Function that returns custom style for a row, or a string assigning custom style for every row */
rowStyle: string | object | ((row: object, index: number) => object)
/** Function that returns custom style for a row, or an object assigning custom style for every row */
rowStyle: object | ((param: rowCallbackParams) => object)
/** Function that returns custom class names for a cell, or a string assigning class names for every cell */
cellClassName: string | ((param: cellCallbackParams) => string)
/** Function that returns custom style for a cell, or an object assigning custom style for every cell */
cellStyle: object | ((param: cellCallbackParams) => object)
/** Function that returns custom class names for a row in table header, or a string assigning class names for every row in table header */
headerRowClassName: string | ((param: rowCallbackParams) => string)
/** Function that returns custom style for a row in table header, or an object assigning custom style for every row in table header */
headerRowStyle: object | ((param: rowCallbackParams) => object)
/** Function that returns custom class names for a cell in table header, or a string assigning class names for every cell in table header */
headerCellClassName: string | ((param: cellCallbackParams) => string)
/** Function that returns custom style for a cell in table header, or an object assigning custom style for every cell in table header */
headerCellStyle: object | ((param: cellCallbackParams) => object)
/** Key of row data, used for optimizing rendering. Required if reserve-selection is on */
rowKey: (row: object) => any