[docgen] Update README.md

skip-checks: true

Author: Github Actions

README.md

@@ -128,21 +128,29 @@ require('dressing').setup({
 
     -- These are passed to nvim_open_win
     anchor = "SW",
-    relative = "cursor",
-    row = 0,
-    col = 0,
     border = "rounded",
+    -- 'editor' and 'win' will default to being centered
+    relative = "cursor",
 
     -- These can be integers or a float between 0 and 1 (e.g. 0.4 for 40%)
     prefer_width = 40,
-    max_width = nil,
-    min_width = 20,
+    width = nil,
+    -- min_width and max_width can be a list of mixed types.
+    -- min_width = {20, 0.2} means "the greater of 20 columns or 20% of total"
+    max_width = { 140, 0.9 },
+    min_width = { 20, 0.2 },
 
     -- Window transparency (0-100)
     winblend = 10,
     -- Change default highlight groups (see :help winhl)
     winhighlight = "",
 
+    override = function(conf)
+      -- This is the config that will be passed to nvim_open_win.
+      -- Change values here to customize the layout
+      return conf
+    end,
+
     -- see :help dressing_get_config
     get_config = nil,
   },
@@ -193,23 +201,30 @@ require('dressing').setup({
     builtin = {
       -- These are passed to nvim_open_win
       anchor = "NW",
-      relative = "cursor",
-      row = 0,
-      col = 0,
       border = "rounded",
+      -- 'editor' and 'win' will default to being centered
+      relative = "editor",
 
       -- Window transparency (0-100)
       winblend = 10,
       -- Change default highlight groups (see :help winhl)
       winhighlight = "",
 
       -- These can be integers or a float between 0 and 1 (e.g. 0.4 for 40%)
+      -- the min_ and max_ options can be a list of mixed types.
+      -- max_width = {140, 0.8} means "the lesser of 140 columns or 80% of total"
       width = nil,
-      max_width = 0.8,
-      min_width = 40,
+      max_width = { 140, 0.8 },
+      min_width = { 40, 0.2 },
       height = nil,
       max_height = 0.9,
-      min_height = 10,
+      min_height = { 10, 0.2 },
+
+      override = function(conf)
+        -- This is the config that will be passed to nvim_open_win.
+        -- Change values here to customize the layout
+        return conf
+      end,
     },
 
     -- Used to override format_item. See :help dressing-format

doc/dressing.txt

@@ -18,21 +18,29 @@ Configure dressing.nvim by calling the setup() function.
     
         -- These are passed to nvim_open_win
         anchor = "SW",
-        relative = "cursor",
-        row = 0,
-        col = 0,
         border = "rounded",
+        -- 'editor' and 'win' will default to being centered
+        relative = "cursor",
     
         -- These can be integers or a float between 0 and 1 (e.g. 0.4 for 40%)
         prefer_width = 40,
-        max_width = nil,
-        min_width = 20,
+        width = nil,
+        -- min_width and max_width can be a list of mixed types.
+        -- min_width = {20, 0.2} means "the greater of 20 columns or 20% of total"
+        max_width = { 140, 0.9 },
+        min_width = { 20, 0.2 },
     
         -- Window transparency (0-100)
         winblend = 10,
         -- Change default highlight groups (see :help winhl)
         winhighlight = "",
     
+        override = function(conf)
+          -- This is the config that will be passed to nvim_open_win.
+          -- Change values here to customize the layout
+          return conf
+        end,
+    
         -- see :help dressing_get_config
         get_config = nil,
       },
@@ -83,23 +91,30 @@ Configure dressing.nvim by calling the setup() function.
         builtin = {
           -- These are passed to nvim_open_win
           anchor = "NW",
-          relative = "cursor",
-          row = 0,
-          col = 0,
           border = "rounded",
+          -- 'editor' and 'win' will default to being centered
+          relative = "editor",
     
           -- Window transparency (0-100)
           winblend = 10,
           -- Change default highlight groups (see :help winhl)
           winhighlight = "",
     
           -- These can be integers or a float between 0 and 1 (e.g. 0.4 for 40%)
+          -- the min_ and max_ options can be a list of mixed types.
+          -- max_width = {140, 0.8} means "the lesser of 140 columns or 80% of total"
           width = nil,
-          max_width = 0.8,
-          min_width = 40,
+          max_width = { 140, 0.8 },
+          min_width = { 40, 0.2 },
           height = nil,
           max_height = 0.9,
-          min_height = 10,
+          min_height = { 10, 0.2 },
+    
+          override = function(conf)
+            -- This is the config that will be passed to nvim_open_win.
+            -- Change values here to customize the layout
+            return conf
+          end,
         },
     
         -- Used to override format_item. See :help dressing-format