lightning-base-components 1.14.2-alpha → 1.14.6-alpha

package/src/lightning/datatable/rowNumber.js

@@ -4,22 +4,22 @@ import labelRowNumber from '@salesforce/label/LightningDatatable.rowNumber';
 import { formatLabel } from 'lightning/utils';
 import { normalizeBoolean } from 'lightning/utilsPrivate';
 
+export const TOOLTIP_ALLOWANCE = 20;
 const CHAR_WIDTH = 10;
 const ROWNUMBER_PADDING = 12;
-const TOOLTIP_ALLOWANCE = 20;
-const COLUMN_TYPE = 'rowNumber';
+const ROW_NUMBER_COLUMN_TYPE = 'rowNumber';
 const i18n = {
     rowLevelErrorAssistiveText: labelRowLevelErrorAssistiveText,
     rowNumber: labelRowNumber,
 };
 
-export function isRowNumberColumn(column) {
-    return column.type === COLUMN_TYPE;
-}
-
+/**
+ * Returns the initial default column definition
+ * for the row number column
+ */
 export function getRowNumberColumnDef() {
     return {
-        type: COLUMN_TYPE,
+        type: ROW_NUMBER_COLUMN_TYPE,
         ariaLabel: i18n.rowNumber,
         sortable: false,
         initialWidth: 52,
@@ -31,39 +31,57 @@ export function getRowNumberColumnDef() {
     };
 }
 
-export function getRowNumberState() {
-    return {
-        showRowNumberColumn: false,
-        rowNumberOffset: 0,
-    };
-}
-
 /**
- * showRowNumberColumn
+ * Retrieves showRowNumberColumn from the state
+ * Can be used to determine if the datatable should
+ * show the row number column or not
  */
 export function hasRowNumberColumn(state) {
     return state.showRowNumberColumn;
 }
+
+/**
+ * Normalizes the passed in `value` to a boolean and
+ * sets it to showRowNumberColumn in the state
+ */
 export function setShowRowNumberColumn(state, value) {
     state.showRowNumberColumn = normalizeBoolean(value);
 }
 
 /**
- * rowNumberOffset
+ * Retrieves rowNumberOffset from the state
  */
-
 export function getRowNumberOffset(state) {
     return state.rowNumberOffset;
 }
+
+/**
+ * Normalizes the passed in value to a non-negative number
+ * and sets it to the rowNumberOffset in the state.
+ * If the value is invalid, it falls back to 0.
+ */
 export function setRowNumberOffset(state, value) {
     state.rowNumberOffset = normalizeNumberAttribute(
         'rowNumberOffset',
         value,
         'non-negative',
-        getRowNumberState().rowNumberOffset
+        0 // default rowNumberOffset value
     );
 }
 
+export function isRowNumberColumn(column) {
+    return column.type === ROW_NUMBER_COLUMN_TYPE;
+}
+
+/**
+ * Calculates the width of the row number column
+ * This takes into account the number of digits in the row number
+ * (ex. 3 for 100 rows), padding in the cell and
+ * space allowance for the error tooltip which is rendered in this cell
+ *
+ * @param {Object} state - datatable's state object
+ * @returns
+ */
 export function getAdjustedRowNumberColumnWidth(state) {
     const numOfRows = state.rows.length;
     const offset = state.rowNumberOffset;
@@ -76,12 +94,19 @@ export function getAdjustedRowNumberColumnWidth(state) {
     );
 }
 
+/**
+ * Retrieves the column index of the row number column
+ * Returns -1 if the row number column is not present
+ *
+ * @param {Object} state - datatable's state object
+ * @returns {Number} index of row number column. Returns -1 if not present
+ */
 export function getRowNumberColumnIndex(state) {
     if (hasRowNumberColumn(state) && state.columns.length > 0) {
         const columns = state.columns;
         for (let i = 0; i < columns.length; i++) {
             const column = columns[i];
-            if (column.type === COLUMN_TYPE) {
+            if (column.type === ROW_NUMBER_COLUMN_TYPE) {
                 return i;
             }
         }
@@ -89,6 +114,15 @@ export function getRowNumberColumnIndex(state) {
     return -1;
 }
 
+/**
+ * Constructs and returns the column definition for the row number column
+ * Column definition contains the row number column's row type and
+ * the error object containing the title, error messages and alt text
+ *
+ * @param {Object} rowErrors - object containing metadata of errors in the row
+ * @param {String} rowTitle - value of the cell which has the scope of the row/rowheader
+ * @returns
+ */
 export function getRowNumberErrorColumnDef(rowErrors, rowTitle) {
     const { title, messages } = rowErrors;
 
@@ -105,7 +139,7 @@ export function getRowNumberErrorColumnDef(rowErrors, rowTitle) {
     );
 
     return {
-        type: COLUMN_TYPE,
+        type: ROW_NUMBER_COLUMN_TYPE,
         typeAttributes: {
             error: { title, messages, alternativeText },
         },