## テーブル 複数のデータを同じような形式で表示します。データを並べ替えたり、フィルタリングしたり、テーブルで比較したりすることができます。 ### 基本テーブル 基本テーブルはデータを表示するためだけのものです。 :::demo オブジェクトの配列で `el-table` の属性 `data` を設定した後、`el-table-column` の `prop` (配列 `data` に含まれるオブジェクトのキーに対応) を用いてテーブルのカラムにデータを挿入し、属性 `label` を用いてカラム名を定義することができます。また、属性 `width` を用いて列の幅を定義することもできる。 ```html ``` ::: ### 縞模様のテーブル 縞模様のテーブルは、異なる行の区別を容易にします。 :::demo 属性 `stripe` は `Boolean` を受け入れる。`true` の場合、テーブルは縞模様になる。 ```html ``` ::: ### ボーダー付きテーブル :::demo デフォルトでは、テーブルには垂直方向の境界線がありません。必要であれば、属性 `border` を `true` に設定することができる。 ```html ``` ::: ### ステータスのあるテーブル テーブルの内容を"成功、情報、警告、危険” などの状態に区別して強調できます。 :::demo 特定の行にカスタムクラスを追加するには、`el-table` の `row-class-name` を使います。そうすれば、カスタムクラスを使ってスタイルを設定することができます。 ```html ``` ::: ### ヘッダを固定したテーブル 行数が多い場合は固定ヘッダーを使用します。 :::demo `el-table` の `height` 属性を設定することで、他のコードを使わずにテーブルのヘッダを固定することができる。 ```html ``` ::: ### 列が固定されているテーブル カラムが多すぎる場合は、いくつかの列を固定することができます。 :::demo 属性 `fixed` は `el-table-column` で用いられる。 `true` の場合、列は左に固定される。また、'left' と 'right' の 2 つの文字列リテラルを受け取ることができ、どちらも対応する方向に固定されることを示す。 ```html ``` ::: ### 固定列とヘッダーを持つテーブル テーブルに入れるデータ量が膨大な場合は、ヘッダーとカラムを同時に固定することができます。 :::demo 上記 2 つの例を組み合わせて、カラムとヘッダーを同時に固定します。 ```html ``` ::: ### 固定ヘッダー(および列)を持つ流動的な高さのテーブル データが動的に変更された場合、テーブルの高さを固定ではなく最大にして、必要に応じてスクロールバーを表示したい場合があります。 :::demo `el-table`の属性 `max-height` を設定することで、テーブルのヘッダを固定することができる。テーブル本体は行の高さが最大の高さを超えた場合のみスクロールする。 ```html ``` ::: ### グルーピングテーブルヘッド データ構造が複雑な場合は、グループヘッダーを使用してデータ階層を表示することができます。 :::demo el-table-column の中に el-table-column を配置するだけで、グループヘッダーを実現することができます。 ```html ``` ::: ### シングル選択 1 行選択に対応しています。 :::demo テーブルは 1 行選択をサポートしています。これを有効にするには、`highlight-current-row` 属性を追加します。行の選択が変更されると `current-change` というイベントがトリガされ、そのパラメータは変更後の行と変更前の行である `currentRow` と `oldCurrentRow` である。行のインデックスを表示したい場合は、新しい `el-table-column` を追加して `type` 属性を `index` に代入すると、1 から始まるインデックスが表示されます。 ```html ``` ::: ### 複数選択 複数の行を選択することもできます。 :::demo 複数選択を有効にするのは簡単です: `el-table-column` に `type` を `selection` に設定して追加するだけです。複数選択とは別に、この例では `show-overflow-tooltip` を利用しています: デフォルトでは、内容が長すぎると複数行に分割されます。1 行にまとめたい場合は、`show-overflow-tooltip` 属性を利用します。`true` を設定すると、セル上にカーソルを置いたときに追加内容がツールチップに表示されます。 ```html ``` ::: ### 並び替え データを素早く、見つけやすいまたは比較しやすいようにソート出来ます。 :::demo 特定のカラムに `sortable` 属性を設定し、そのカラムに基づいてデータをソートする。これは `Boolean` を受け付け、デフォルト値は `false` である。テーブル属性 `default-sort` を設定して、デフォルトのソート列と順序を決定する。独自のソートルールを適用するには、`sort-method` や `sort-by` を用いる。バックエンドからのリモートソートが必要な場合は、`sortable` を `custom` に設定し、テーブル上で `sort-change` イベントをリッスンします。イベントハンドラではソートカラムとソート順にアクセスできるので、API からソートされたテーブルデータを取得することができます。この例では、特定のカラムの値を整形するために `formatter` という名前の別の属性を使います。これは 2 つのパラメータを持つ関数を受け入れます。 `row` と `column` の 2 つのパラメータを持つ関数を受け付ける。この関数は、`row` と `column` の 2 つのパラメータを持つ関数を受け付ける。 ```html ``` ::: ### フィルター テーブルをフィルタリングして、目的のデータを見つけます。 :::demo `el-table-column` に `filters` と `filter-method` という属性を設定すると、この列をフィルタリング可能な状態にする。`filters` は配列であり、`filter-method` はどの行を表示するかを決定する関数である。パラメータは 3 つある。`value`, `row`, `column` の 3 つのパラメータを持つ。 ```html ``` ::: ### カスタムカラムテンプレート テーブルのカラムをカスタマイズして、他のコンポーネントと統合できるようにします。 :::demo 行、列、$index、ストア(テーブルの状態管理)は、[slot](https://v3.vuejs.org/guide/component-slots.html)でアクセスできます。 ```html ``` ::: ### カスタムヘッダー付きのテーブル テーブルヘッダーをカスタマイズすることで、さらにカスタマイズできるようになります。 :::demo ヘッダー[slots](https://v3.vuejs.org/guide/component-slots.html)でヘッダーの見え方をカスタマイズすることができます。 ```html ``` ::: ### 拡張可能な行 行の内容が長すぎて横スクロールバーを表示したくない場合は、拡張可能な行の機能を利用することができます。 :::demo type="expand" と slot を追加して、拡張可能な行を有効にします。el-table-column のテンプレートは拡張された行の内容としてレンダリングされ、カスタムカラムテンプレートで `slot` を使用している場合と同じ属性にアクセスできます。 ```html ``` ::: ### ツリーデータとレイジーモード :::demo 木構造データを表示することができる。行に `children` フィールドが含まれている場合、その行は入れ子データとして扱われる。入れ子になったデータを表示するには、`row-key` というプロップが必要である。テーブルの `lazy` プロパティを true に設定し、関数 `load` を実行する。行に `hasChildren` 属性を指定することで、どの行に子を含むかを判断することができます。`children`も `hasChildren`も、`tree-props`で設定することができる。 ```html ``` ::: ### サマリー行 数字のテーブルの場合、各列の合計を表示するテーブルのフッターに追加行を追加することができます。 :::demo `show-summary` を `true` に設定することでサマリー行を追加することができる。デフォルトでは、サマリー行の最初のカラムは何も合計せずに常に 'Sum' を表示します (表示するテキストは `sum-text` で設定できます)。もちろん、独自の合計の振る舞いを定義することもできます。そのためには、`summary-method` に配列を返すメソッドを渡すと、配列の各要素がサマリー行の列に表示されます。この例の 2 番目の表に詳細なデモを示します。 ```html ``` ::: ### rowspan と colspan rowspan と colspan を設定すると、セルをマージすることができます。 :::demo `span-method` 属性を用いて rowspan と colspan を設定する。これはメソッドを受け取り、現在の行 `row`、現在の列 `column`、現在の行インデックス `rowIndex`、現在の列インデックス `columnIndex` を含むオブジェクトをそのメソッドに渡します。このメソッドは 2 つの数値の配列を返す必要があり、1 つ目の数値は `rowspan`、2 つ目の数値は `colspan` です。また、`rowspan` と `colspan` のプロップを持つオブジェクトを返すこともできる。 ```html ``` ::: ### Custom index `type=index` カラムで行のインデックスをカスタマイズすることができる。 :::demo 行のインデックスをカスタマイズするには、`el-table-column` の `type=index` で `index` 属性を用いる。これが数値に代入されている場合、すべてのインデックスはその数値のオフセットを持つことになる。また、各インデックス(`0`から始まる)をパラメータに持つメソッドも受け付けており、戻り値はインデックスとして表示される。 ```html ``` ::: ### Table Attributes | Attribute | Description | Type | Accepted Values | Default | | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | ------------------------------- | ------------------------------------------------------------------------------ | | data | Table data | array | — | — | | height | Table's height. By default it has an `auto` height. If its value is a number, the height is measured in pixels; if its value is a string, the value will be assigned to element's style.height, the height is affected by external styles | string / number | — | — | | max-height | Table's max-height. The legal value is a number or the height in px. | string / number | — | — | | stripe | whether Table is striped | boolean | — | false | | border | whether Table has vertical border | boolean | — | false | | size | size of Table | string | medium / small / mini | — | | fit | whether width of column automatically fits its container | boolean | — | true | | show-header | whether Table header is visible | boolean | — | true | | highlight-current-row | whether current row is highlighted | boolean | — | false | | current-row-key | key of current row, a set only prop | string / number | — | — | | row-class-name | function that returns custom class names for a row, or a string assigning class names for every row | function({ row, rowIndex }) / string | — | — | | row-style | function that returns custom style for a row, or an object assigning custom style for every row | function({ row, rowIndex }) / object | — | — | | cell-class-name | function that returns custom class names for a cell, or a string assigning class names for every cell | function({ row, column, rowIndex, columnIndex }) / string | — | — | | 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, 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 or display tree data. 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 `#empty` | string | — | No Data | | default-expand-all | whether expand all rows by default, works when the table has a column type="expand" or contains tree structure data | boolean | — | false | | expand-row-keys | set expanded rows by this prop, prop's value is the keys of expand rows, you should set row-key before using this prop | array | — | — | | default-sort | set the default sort column and order. property `prop` is used to set default sort column, property `order` is used to set default sort order | object | `order`: ascending / descending | if `prop` is set, and `order` is not set, then `order` is default to ascending | | tooltip-effect | tooltip `effect` property | string | dark / light | dark | | show-summary | whether to display a summary row | boolean | — | false | | sum-text | displayed text for the first column of summary row | string | — | Sum | | summary-method | custom summary method | function({ columns, data }) | — | — | | span-method | method that returns rowspan and colspan | function({ row, column, rowIndex, columnIndex }) | — | — | | select-on-indeterminate | controls the behavior of master checkbox in multi-select tables when only some rows are selected (but not all). If true, all rows will be selected, else deselected. | boolean | — | true | | indent | horizontal indentation of tree data | number | — | 16 | | lazy | whether to lazy loading data | boolean | — | — | | load | method for loading child row data, only works when `lazy` is true | function(row, treeNode, resolve) | — | — | | tree-props | configuration for rendering nested data | object | — | { hasChildren: 'hasChildren', children: 'children' } | ### Table Events | Event Name | Description | Parameters | | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | | select | triggers when user clicks the checkbox in a row | selection, row | | select-all | triggers when user clicks the checkbox in table header | selection | | selection-change | triggers when selection changes | selection | | cell-mouse-enter | triggers when hovering into a cell | row, column, cell, event | | cell-mouse-leave | triggers when hovering out of a cell | row, column, cell, event | | cell-click | triggers when clicking a cell | row, column, cell, event | | cell-dblclick | triggers when double clicking a cell | row, column, cell, event | | cell-contextmenu | triggers when user right clicks on a cell | row, column, cell, event | | row-click | triggers when clicking a row | row, column, event | | row-contextmenu | triggers when user right clicks on a row | row, column, event | | row-dblclick | triggers when double clicking a row | row, column, event | | header-click | triggers when clicking a column header | column, event | | header-contextmenu | triggers when user right clicks on a column header | column, event | | sort-change | triggers when Table's sorting changes | { column, prop, order } | | filter-change | column's key. If you need to use the filter-change event, this attribute is mandatory to identify which column is being filtered | filters | | current-change | triggers when current row changes | currentRow, oldCurrentRow | | header-dragend | triggers after changing a column's width by dragging the column header's border | newWidth, oldWidth, column, event | | expand-change | triggers when user expands or collapses a row (for expandable table, second param is expandedRows; for tree Table, second param is expanded) | row, (expandedRows \| expanded) | ### Table Methods | Method | Description | Parameters | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | | clearSelection | used in multiple selection Table, clear user selection | — | | toggleRowSelection | used in multiple selection Table, toggle if a certain row is selected. With the second parameter, you can directly set if this row is selected | row, selected | | toggleAllSelection | used in multiple selection Table, toggle select all and deselect all | — | | toggleRowExpansion | used in expandable Table or tree Table, toggle if a certain row is expanded. With the second parameter, you can directly set if this row is expanded or collapsed | row, expanded | | setCurrentRow | used in single selection Table, set a certain row selected. If called without any parameter, it will clear selection. | row | | clearSort | clear sorting, restore data to the original order | — | | clearFilter | clear filters of the columns whose `columnKey` are passed in. If no params, clear all filters | columnKeys | | doLayout | refresh the layout of Table. When the visibility of Table changes, you may need to call this method to get a correct layout | — | | sort | sort Table manually. Property `prop` is used to set sort column, property `order` is used to set sort order | prop: string, order: string | ### Table Slots | Name | Description | | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | append | Contents to be inserted after the last row. You may need this slot if you want to implement infinite scroll for the table. This slot will be displayed above the summary row if there is one. | ### Table-column Attributes | Attribute | Description | Type | Accepted Values | Default | | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | | type | type of the column. If set to `selection`, the column will display checkbox. If set to `index`, the column will display index of the row (staring from 1). If set to `expand`, the column will display expand icon. | string | selection / index / expand | — | | index | customize indices for each row, works on columns with `type=index` | number / function(index) | — | — | | label | column label | string | — | — | | column-key | column's key. If you need to use the filter-change event, you need this attribute to identify which column is being filtered | string | — | — | | prop | field name. You can also use its alias: `property` | string | — | — | | width | column width | string / number | — | — | | min-width | column minimum width. Columns with `width` has a fixed width, while columns with `min-width` has a width that is distributed in proportion | string / number | — | — | | fixed | whether column is fixed at left / right. Will be fixed at left if `true` | string / boolean | true / 'left' / 'right' | — | | render-header | render function for table header of this column | function({ column, $index }) | — | — | | sortable | whether column can be sorted. Remote sorting can be done by setting this attribute to 'custom' and listening to the `sort-change` event of Table | boolean / string | true / false / 'custom' | false | | sort-method | sorting method, works when `sortable` is `true`. Should return a number, just like Array.sort | function(a, b) | — | — | | sort-by | specify which property to sort by, works when `sortable` is `true` and `sort-method` is `undefined`. If set to an Array, the column will sequentially sort by the next property if the previous one is equal | function(row, index) / string / array | — | — | | sort-orders | the order of the sorting strategies used when sorting the data, works when `sortable` is `true`. Accepts an array, as the user clicks on the header, the column is sorted in order of the elements in the array | array | the elements in the array need to be one of the following: `ascending`, `descending` and `null` (restores to the original order) | ['ascending', 'descending', null] | | resizable | whether column width can be resized, works when `border` of `el-table` is `true` | boolean | — | false | | formatter | function that formats cell content | function(row, column, cellValue, index) | — | — | | show-overflow-tooltip | whether to hide extra content and show them in a tooltip when hovering on the cell | boolean | — | false | | align | alignment | string | left / center / right | left | | header-align | alignment of the table header. If omitted, the value of the above `align` attribute will be applied | string | left / center / right | — | | class-name | class name of cells in the column | string | — | — | | label-class-name | class name of the label of this column | string | — | — | | selectable | function that determines if a certain row can be selected, works when `type` is 'selection' | function(row, index) | — | — | | reserve-selection | whether to reserve selection after data refreshing, works when `type` is 'selection'. Note that `row-key` is required for this to work | boolean | — | false | | filters | an array of data filtering options. For each element in this array, `text` and `value` are required | array[{ text, value }] | — | — | | filter-placement | placement for the filter dropdown | string | top / top-start / top-end / bottom / bottom-star t /bottom-end / left / left-start / left-end / right / right-start / right-end | — | | filter-multiple | whether data filtering supports multiple options | boolean | — | true | | filter-method | data filtering method. If `filter-multiple` is on, this method will be called multiple times for each row, and a row will display if one of the calls returns `true` | function(value, row, column) | — | — | | filtered-value | filter value for selected data, might be useful when table header is rendered with `render-header` | array | — | — | ### Table-column Slots | Name | Description | | ------ | -------------------------------------------------------------------------------- | | — | Custom content for table columns. The scope parameter is { row, column, $index } | | header | Custom content for table header. The scope parameter is { column, $index } |