From 43ec5013f69808a14cfb2d3c128ee722bd5cf0d9 Mon Sep 17 00:00:00 2001 From: Alain Dumesny Date: Thu, 14 Sep 2023 08:17:01 -0700 Subject: [PATCH] doc update --- doc/README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/README.md b/doc/README.md index 9ba59b6c9..eff5f89d0 100644 --- a/doc/README.md +++ b/doc/README.md @@ -57,6 +57,7 @@ gridstack.js API - [`removeWidget(el, removeDOM = true, triggerEvent = true)`](#removewidgetel-removedom--true-triggerevent--true) - [`removeAll(removeDOM = true)`](#removeallremovedom--true) - [`resizable(el, val)`](#resizableel-val) + - [`resizeToContent(el: GridItemHTMLElement, useAttrSize = false)`](#resizetocontentel-griditemhtmlelement-useattrsize--false) - [`save(saveContent = true, saveGridOpt = false): GridStackWidget[] | GridStackOptions`](#savesavecontent--true-savegridopt--false-gridstackwidget--gridstackoptions) - [`setAnimation(doAnimate)`](#setanimationdoanimate) - [`setStatic(staticValue)`](#setstaticstaticvalue) @@ -563,6 +564,12 @@ Enables/Disables user resizing of specific grid element. If you want all items, - `el` - widget to modify - `val` - if `true` widget will be resizable. +### `resizeToContent(el: GridItemHTMLElement, useAttrSize = false)` + +Updates widget height to match the content height to avoid v-scrollbar or dead space. +Note: this assumes only 1 child under `resizeToContentParent='.grid-stack-item-content'` (sized to gridItem minus padding) that is at the entire content size wanted. +- `useAttrSize` set to `true` if GridStackNode.h should be used instead of actual container height when we don't need to wait for animation to finish to get actual DOM heights + ### `save(saveContent = true, saveGridOpt = false): GridStackWidget[] | GridStackOptions` saves the current layout returning a list of widgets for serialization which might include any nested grids.