From 899925e98248d9ad04a400c0b423a533d7d801a1 Mon Sep 17 00:00:00 2001 From: Troy Morehouse Date: Sat, 12 Oct 2019 13:04:07 -0300 Subject: [PATCH 01/12] chore(docs): add missing table docs for cell scope property `fields` --- src/components/table/package.json | 34 ++++++++++++++++++++++++------- 1 file changed, 27 insertions(+), 7 deletions(-) diff --git a/src/components/table/package.json b/src/components/table/package.json index 3e4313a8801..83c239b3f40 100644 --- a/src/components/table/package.json +++ b/src/components/table/package.json @@ -518,6 +518,11 @@ "prop": "unformatted", "description": "The raw value for this key in the item record (null or undefined if a virtual column), before being passed to the field's formatter function" }, + { + "prop": "field", + "type": "Object", + "description": "the field's normalized definition object (from the fields prop)" + }, { "prop": "detailsShowing", "type": "Boolean", @@ -557,6 +562,11 @@ "prop": "unformatted", "description": "The raw value for this key in the item record (null or undefined if a virtual column), before being passed to the field's formatter function" }, + { + "prop": "field", + "type": "Object", + "description": "the field's normalized definition object (from the fields prop)" + }, { "prop": "detailsShowing", "type": "Boolean", @@ -587,7 +597,7 @@ { "prop": "field", "type": "Object", - "description": "the field's definition object (from the fields prop)" + "description": "the field's normalized definition object (from the fields prop)" }, { "prop": "label", @@ -623,7 +633,7 @@ { "prop": "field", "type": "Object", - "description": "the field's definition object (from the fields prop)" + "description": "the field's normalized definition object (from the fields prop)" }, { "prop": "label", @@ -660,7 +670,7 @@ { "prop": "field", "type": "Object", - "description": "the field's definition object (from the fields prop)" + "description": "the field's normalized definition object (from the fields prop)" }, { "prop": "label", @@ -1224,6 +1234,11 @@ "prop": "unformatted", "description": "The raw value for this key in the item record (null or undefined if a virtual column), before being passed to the field's formatter function" }, + { + "prop": "field", + "type": "Object", + "description": "the field's normalized definition object (from the fields prop)" + }, { "prop": "detailsShowing", "type": "Boolean", @@ -1258,6 +1273,11 @@ "prop": "unformatted", "description": "The raw value for this key in the item record (null or undefined if a virtual column), before being passed to the field's formatter function" }, + { + "prop": "field", + "type": "Object", + "description": "the field's normalized definition object (from the fields prop)" + }, { "prop": "detailsShowing", "type": "Boolean", @@ -1283,7 +1303,7 @@ { "prop": "field", "type": "Object", - "description": "the field's definition object (from the fields prop)" + "description": "the field's normalized definition object (from the fields prop)" }, { "prop": "label", @@ -1309,7 +1329,7 @@ { "prop": "field", "type": "Object", - "description": "the field's definition object (from the fields prop)" + "description": "the field's normalized definition object (from the fields prop)" }, { "prop": "label", @@ -1336,7 +1356,7 @@ { "prop": "field", "type": "Object", - "description": "the field's definition object (from the fields prop)" + "description": "the field's normalized definition object (from the fields prop)" }, { "prop": "label", @@ -1357,7 +1377,7 @@ { "prop": "field", "type": "Object", - "description": "the field's definition object (from the fields prop)" + "description": "the field's normalized definition object (from the fields prop)" }, { "prop": "label", From 31d3168aa83baafff1b5800c66608e440e4bbdc8 Mon Sep 17 00:00:00 2001 From: Troy Morehouse Date: Sat, 12 Oct 2019 13:16:12 -0300 Subject: [PATCH 02/12] Update README.md --- src/components/table/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/src/components/table/README.md b/src/components/table/README.md index c15172bf752..4338ab4b4bd 100644 --- a/src/components/table/README.md +++ b/src/components/table/README.md @@ -890,6 +890,7 @@ The slot's scope variable (`data` in the above sample) will have the following p | `item` | Object | The entire raw record data (i.e. `items[index]`) for this row (before any formatter is applied) | | `value` | Any | The value for this key in the record (`null` or `undefined` if a virtual column), or the output of the field's [`formatter` function](#formatter-callback) | | `unformatted` | Any | The raw value for this key in the item record (`null` or `undefined` if a virtual column), before being passed to the field's [`formatter` function](#formatter-callback) | +| `field` | Object | The field's normalized field definition object | | `detailsShowing` | Boolean | Will be `true` if the row's `row-details` scoped slot is visible. See section [Row details support](#row-details-support) below for additional information | | `toggleDetails` | Function | Can be called to toggle the visibility of the rows `row-details` scoped slot. See section [Row details support](#row-details-support) below for additional information | | `rowSelected` | Boolean | Will be `true` if the row has been selected. See section [Row select support](#row-select-support) for additional information | From f33a2846ff7de7c8b1130dbf78c9011ae41003e4 Mon Sep 17 00:00:00 2001 From: Troy Morehouse Date: Sat, 12 Oct 2019 13:34:18 -0300 Subject: [PATCH 03/12] Update package.json --- src/components/table/package.json | 40 +++++++++++++++---------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/src/components/table/package.json b/src/components/table/package.json index 83c239b3f40..663ce98e521 100644 --- a/src/components/table/package.json +++ b/src/components/table/package.json @@ -521,7 +521,7 @@ { "prop": "field", "type": "Object", - "description": "the field's normalized definition object (from the fields prop)" + "description": "The field's normalized definition object (from the fields prop)" }, { "prop": "detailsShowing", @@ -565,7 +565,7 @@ { "prop": "field", "type": "Object", - "description": "the field's normalized definition object (from the fields prop)" + "description": "The field's normalized definition object (from the fields prop)" }, { "prop": "detailsShowing", @@ -597,7 +597,7 @@ { "prop": "field", "type": "Object", - "description": "the field's normalized definition object (from the fields prop)" + "description": "The field's normalized definition object (from the fields prop)" }, { "prop": "label", @@ -633,7 +633,7 @@ { "prop": "field", "type": "Object", - "description": "the field's normalized definition object (from the fields prop)" + "description": "The field's normalized definition object (from the fields prop)" }, { "prop": "label", @@ -670,7 +670,7 @@ { "prop": "field", "type": "Object", - "description": "the field's normalized definition object (from the fields prop)" + "description": "The field's normalized definition object (from the fields prop)" }, { "prop": "label", @@ -701,7 +701,7 @@ { "prop": "field", "type": "Object", - "description": "the field's definition object (from the fields prop)" + "description": "The field's normalized definition object (from the fields prop)" }, { "prop": "label", @@ -731,7 +731,7 @@ { "prop": "columns", "type": "Number", - "description": "the number of columns in the table" + "description": "The number of columns in the table" }, { "prop": "fields", @@ -849,7 +849,7 @@ { "prop": "columns", "type": "Number", - "description": "the number of columns in the table" + "description": "The number of columns in the table" }, { "prop": "fields", @@ -875,7 +875,7 @@ { "prop": "columns", "type": "Number", - "description": "the number of columns in the table" + "description": "The number of columns in the table" }, { "prop": "fields", @@ -891,7 +891,7 @@ { "prop": "columns", "type": "Number", - "description": "the number of columns in the table" + "description": "The number of columns in the table" }, { "prop": "fields", @@ -907,7 +907,7 @@ { "prop": "columns", "type": "Number", - "description": "the number of columns in the table" + "description": "The number of columns in the table" }, { "prop": "fields", @@ -1237,7 +1237,7 @@ { "prop": "field", "type": "Object", - "description": "the field's normalized definition object (from the fields prop)" + "description": "The field's normalized definition object (from the fields prop)" }, { "prop": "detailsShowing", @@ -1276,7 +1276,7 @@ { "prop": "field", "type": "Object", - "description": "the field's normalized definition object (from the fields prop)" + "description": "The field's normalized definition object (from the fields prop)" }, { "prop": "detailsShowing", @@ -1303,7 +1303,7 @@ { "prop": "field", "type": "Object", - "description": "the field's normalized definition object (from the fields prop)" + "description": "The field's normalized definition object (from the fields prop)" }, { "prop": "label", @@ -1329,7 +1329,7 @@ { "prop": "field", "type": "Object", - "description": "the field's normalized definition object (from the fields prop)" + "description": "The field's normalized definition object (from the fields prop)" }, { "prop": "label", @@ -1356,7 +1356,7 @@ { "prop": "field", "type": "Object", - "description": "the field's normalized definition object (from the fields prop)" + "description": "The field's normalized definition object (from the fields prop)" }, { "prop": "label", @@ -1377,7 +1377,7 @@ { "prop": "field", "type": "Object", - "description": "the field's normalized definition object (from the fields prop)" + "description": "The field's normalized definition object (from the fields prop)" }, { "prop": "label", @@ -1397,7 +1397,7 @@ { "prop": "columns", "type": "Number", - "description": "the number of columns in the table" + "description": "The number of columns in the table" }, { "prop": "fields", @@ -1439,7 +1439,7 @@ { "prop": "columns", "type": "Number", - "description": "the number of columns in the table" + "description": "The number of columns in the table" }, { "prop": "fields", @@ -1465,7 +1465,7 @@ { "prop": "columns", "type": "Number", - "description": "the number of columns in the table" + "description": "The number of columns in the table" }, { "prop": "fields", From f8f7fc9b24a61b0fb66eaf1310eb995f0da2cb84 Mon Sep 17 00:00:00 2001 From: Troy Morehouse Date: Sat, 12 Oct 2019 14:04:23 -0300 Subject: [PATCH 04/12] Update componentdoc.vue --- docs/components/componentdoc.vue | 39 ++++++++++++++++++++++++++++---- 1 file changed, 35 insertions(+), 4 deletions(-) diff --git a/docs/components/componentdoc.vue b/docs/components/componentdoc.vue index f4185d05b7e..3b9f8b61598 100644 --- a/docs/components/componentdoc.vue +++ b/docs/components/componentdoc.vue @@ -21,6 +21,29 @@ + +
Component aliases @@ -132,8 +155,9 @@ sort-icon-left striped > -