feat(colDef): add initWidth argument

Author: nteetor

R/columns.R

@@ -65,6 +65,8 @@
 #'  Cells in the row names column are automatically marked up as row headers.
 #' @param minWidth Minimum width of the column in pixels. Defaults to 100.
 #' @param maxWidth Maximum width of the column in pixels.
+#' @param initWidth Initial width of the column in pixels. Cannot be specified
+#'   if `width` is specified.
 #' @param width Fixed width of the column in pixels. Overrides `minWidth` and `maxWidth`.
 #' @param align Horizontal alignment of content in the column. One of
 #'   `"left"`, `"right"`, `"center"`. By default, all numbers are right-aligned,
@@ -78,7 +80,7 @@
 #'
 #'   If a sticky column is in a column group, all columns in the group will
 #'   automatically be made sticky, including the column group header.
-#' 
+#'
 #'   Sticky columns do not work if `fullWidth` is set to `FALSE` in `reactable()`.
 #' @param class Additional CSS classes to apply to cells. Can also be an R function
 #'   that takes the cell value, row index, and column name as arguments, or a [JS()]
@@ -142,6 +144,7 @@ colDef <- function(
   rowHeader = FALSE,
   minWidth = 100,
   maxWidth = NULL,
+  initWidth = NULL,
   width = NULL,
   align = NULL,
   vAlign = NULL,
@@ -256,6 +259,22 @@ colDef <- function(
     stop("`maxWidth` must be numeric")
   }
 
+  if (!is.null(initWidth) && !is.numeric(initWidth)) {
+    stop("`initWidth` must be numeric")
+  }
+
+  if (!is.null(initWidth) && !is.null(width)) {
+    stop("`initWidth` cannot be specified if `width` is specified")
+  }
+
+  if (!is.null(initWidth) && !is.null(minWidth) && initWidth < minWidth) {
+    stop("`initWidth` must be greater than or equal to `minWidth`")
+  }
+
+  if (!is.null(initWidth) && !is.null(maxWidth) && initWidth > maxWidth) {
+    stop("`initWidth` must be less than or equal to `maxWidth`")
+  }
+
   if (!is.null(width) && !is.numeric(width)) {
     stop("`width` must be numeric")
   }
@@ -338,6 +357,7 @@ colDef <- function(
       rowHeader = if ("rowHeader" %in% userArgs) rowHeader,
       minWidth = if ("minWidth" %in% userArgs) minWidth,
       maxWidth = maxWidth,
+      initWidth = initWidth,
       width = width,
       align = align,
       vAlign = vAlign,
@@ -448,7 +468,7 @@ colGroup <- function(
   ))
 
   group <- tryCatch({
-    do.call(colDef, args)
+      do.call(colDef, args)
   }, error = function(e) e)
 
   if (inherits(group, "error")) {

inst/htmlwidgets/reactable.js

@@ -625,6 +625,14 @@ describe('buildColumnDefs', () => {
     expect(cols[0].maxWidth).toEqual(111)
     expect(cols[0].width).toEqual(111)
     expect(cols[0].disableResizing).toEqual(true)
+
+    // Initial width sets width, does not affect min or max width, leaves column resizable
+    cols = buildColumnDefs([{ id: 'x', initWidth: 120, minWidth: 100, maxWidth: 200, resizable: true }])
+    expect(cols[0].width).toEqual(120)
+    expect(cols[0].minWidth).toEqual(100)
+    expect(cols[0].maxWidth).toEqual(200)
+    expect(cols[0].resizable).toEqual(true)
+    expect(cols[0].disableResizing).toEqual(false)
   })
 
   test('header sort icons', () => {

inst/htmlwidgets/reactable.js.map

@@ -208,8 +208,8 @@ export function buildColumnDefs(columns, groups, tableProps = {}) {
     // maxWidth takes priority over minWidth
     col.minWidth = Math.min(col.minWidth, col.maxWidth)
 
-    // Start column width at min width / flex width, like in v6
-    col.width = col.minWidth
+    // Start column width at initial width, otherwise at min width / flex width, like in v6
+    col.width = col.initWidth || col.minWidth
 
     col.resizable = getFirstDefined(col.resizable, resizable)
     // Disable resizing on fixed width columns

inst/htmlwidgets/reactable.server.js

@@ -185,6 +185,15 @@ test_that("colDef minWidth", {
   expect_equal(colDef(minWidth = 100)$minWidth, 100)
 })
 
+test_that("colDef initWidth", {
+  expect_error(colDef(initWidth = "auto"), "`initWidth` must be numeric")
+  expect_equal(colDef()$initWidth, NULL)
+  expect_equal(colDef(initWidth = 150)$initWidth, 150)
+  expect_error(colDef(width = 100, initWidth = 120), "`initWidth` cannot be specified if `width` is specified")
+  expect_error(colDef(initWidth = 50), "`initWidth` must be greater than or equal to `minWidth`")
+  expect_error(colDef(maxWidth = 200, initWidth = 250), "`initWidth` must be less than or equal to `maxWidth`")
+})
+
 test_that("colDef vAlign", {
   expect_error(colDef(vAlign = TRUE), '`vAlign` must be one of "top", "center", "bottom"')
   expect_null(colDef()$vAlign)