Skip to content

improved method documentation #3113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adumesny merged 1 commit into from
Aug 10, 2025
Merged

improved method documentation #3113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2,307 changes: 1,574 additions & 733 deletions docs/api/index.md
View file
Open in desktop

Large diffs are not rendered by default.

40 changes: 20 additions & 20 deletions docs/html/assets/highlight.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
:root {
--light-hl-0: #000000;
--dark-hl-0: #D4D4D4;
--light-hl-1: #001080;
--dark-hl-1: #9CDCFE;
--light-hl-2: #A31515;
--dark-hl-2: #CE9178;
--light-hl-3: #098658;
--dark-hl-3: #B5CEA8;
--light-hl-4: #0000FF;
--dark-hl-4: #569CD6;
--light-hl-5: #0070C1;
--dark-hl-5: #4FC1FF;
--light-hl-6: #795E26;
--dark-hl-6: #DCDCAA;
--light-hl-7: #008000;
--dark-hl-7: #6A9955;
--light-hl-8: #000000;
--dark-hl-8: #C8C8C8;
--light-hl-9: #AF00DB;
--dark-hl-9: #C586C0;
--light-hl-0: #001080;
--dark-hl-0: #9CDCFE;
--light-hl-1: #000000;
--dark-hl-1: #D4D4D4;
--light-hl-2: #795E26;
--dark-hl-2: #DCDCAA;
--light-hl-3: #A31515;
--dark-hl-3: #CE9178;
--light-hl-4: #008000;
--dark-hl-4: #6A9955;
--light-hl-5: #098658;
--dark-hl-5: #B5CEA8;
--light-hl-6: #0000FF;
--dark-hl-6: #569CD6;
--light-hl-7: #0070C1;
--dark-hl-7: #4FC1FF;
--light-hl-8: #AF00DB;
--dark-hl-8: #C586C0;
--light-hl-9: #000000;
--dark-hl-9: #C8C8C8;
--light-hl-10: #267F99;
--dark-hl-10: #4EC9B0;
--light-code-background: #FFFFFF;
Expand Down
2 changes: 1 addition & 1 deletion docs/html/assets/search.js
View file
Open in desktop

Large diffs are not rendered by default.

25 changes: 22 additions & 3 deletions docs/html/classes/DDBaseImplement.html
View file
Open in desktop

Large diffs are not rendered by default.

27 changes: 24 additions & 3 deletions docs/html/classes/DDDraggable.html
View file
Open in desktop

Large diffs are not rendered by default.

29 changes: 25 additions & 4 deletions docs/html/classes/DDDroppable.html
View file
Open in desktop

Large diffs are not rendered by default.

31 changes: 26 additions & 5 deletions docs/html/classes/DDGridStack.html
View file
Open in desktop

Large diffs are not rendered by default.

26 changes: 18 additions & 8 deletions docs/html/classes/DDManager.html
View file
Open in desktop

Large diffs are not rendered by default.

27 changes: 24 additions & 3 deletions docs/html/classes/DDResizable.html
View file
Open in desktop

Large diffs are not rendered by default.

371 changes: 258 additions & 113 deletions docs/html/classes/GridStack.html
View file
Open in desktop

Large diffs are not rendered by default.

197 changes: 163 additions & 34 deletions docs/html/classes/GridStackEngine.html
View file
Open in desktop

Large diffs are not rendered by default.

170 changes: 139 additions & 31 deletions docs/html/classes/Utils.html
View file
Open in desktop

Large diffs are not rendered by default.

12 changes: 7 additions & 5 deletions docs/html/interfaces/Breakpoint.html
View file
Open in desktop

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions docs/html/interfaces/DDDragOpt.html
View file
Open in desktop

Large diffs are not rendered by default.

8 changes: 5 additions & 3 deletions docs/html/interfaces/DDElementHost.html
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/html/interfaces/DDRemoveOpt.html
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/html/interfaces/DDResizeOpt.html
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/DDUIData.html
View file
Open in desktop

Large diffs are not rendered by default.

8 changes: 5 additions & 3 deletions docs/html/interfaces/GridItemHTMLElement.html
View file
Open in desktop

Large diffs are not rendered by default.

28 changes: 14 additions & 14 deletions docs/html/interfaces/GridStackMoveOpts.html
View file
Open in desktop

Large diffs are not rendered by default.

46 changes: 23 additions & 23 deletions docs/html/interfaces/GridStackNode.html
View file
Open in desktop

Large diffs are not rendered by default.

80 changes: 40 additions & 40 deletions docs/html/interfaces/GridStackOptions.html
View file
Open in desktop

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions docs/html/interfaces/GridStackPosition.html
View file
Open in desktop

Large diffs are not rendered by default.

38 changes: 19 additions & 19 deletions docs/html/interfaces/GridStackWidget.html
View file
Open in desktop

Large diffs are not rendered by default.

9 changes: 7 additions & 2 deletions docs/html/interfaces/HTMLElementExtendOpt.html
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/Position.html
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/Rect.html
View file
Open in desktop

Large diffs are not rendered by default.

16 changes: 9 additions & 7 deletions docs/html/interfaces/Responsive.html
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/Size.html
View file
Open in desktop

Large diffs are not rendered by default.

120 changes: 60 additions & 60 deletions docs/html/sitemap.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,242 +2,242 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://gridstack.github.io/gridstack.js/index.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/hierarchy.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/types/AddRemoveFcn.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/interfaces/Breakpoint.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/interfaces/CellPosition.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/types/ColumnOptions.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/types/CompactOptions.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/classes/DDBaseImplement.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/types/DDCallback.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/classes/DDDraggable.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/interfaces/DDDragOpt.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/types/DDDropOpt.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/classes/DDDroppable.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/interfaces/DDDroppableOpt.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/classes/DDElement.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/interfaces/DDElementHost.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/classes/DDGridStack.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/types/DDKey.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/classes/DDManager.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/types/DDOpts.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/interfaces/DDRemoveOpt.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/classes/DDResizable.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/classes/DDResizableHandle.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/interfaces/DDResizableHandleOpt.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/interfaces/DDResizableOpt.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/interfaces/DDResizeOpt.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/interfaces/DDUIData.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/types/DDValue.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/interfaces/DragTransform.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/types/EventCallback.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/variables/gridDefaults.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/interfaces/GridHTMLElement.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/interfaces/GridItemHTMLElement.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/classes/GridStack.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/types/GridStackDroppedHandler.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/types/GridStackElement.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/types/GridStackElementHandler.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/classes/GridStackEngine.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/interfaces/GridStackEngineOptions.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/types/GridStackEvent.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/types/GridStackEventHandler.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/types/GridStackEventHandlerCallback.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/interfaces/GridStackMoveOpts.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/interfaces/GridStackNode.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/types/GridStackNodesHandler.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/interfaces/GridStackOptions.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/interfaces/GridStackPosition.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/interfaces/GridStackWidget.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/interfaces/HeightData.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/interfaces/HTMLElementExtendOpt.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/interfaces/MousePosition.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/types/numberOrString.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/interfaces/Position.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/interfaces/Rect.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/types/RenderFcn.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/types/ResizeToContentFcn.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/interfaces/Responsive.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/types/SaveFcn.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/interfaces/Size.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
<url>
<loc>https://gridstack.github.io/gridstack.js/classes/Utils.html</loc>
<lastmod>2025-08-10T05:11:43.191Z</lastmod>
<lastmod>2025-08-10T06:03:46.621Z</lastmod>
</url>
</urlset>
Loading