Skip to content

Commit eefcbf2

Browse files
authored
Merge pull request #2280 from shibisuriya/chore/doc-update
chore: wrote disableOneColumnMode's doc clearly
2 parents d99a9f5 + 1393bed commit eefcbf2

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

doc/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ gridstack.js API
9494
- `column` - Integer > 0 (default 12) which can change on the fly with `column(N)` API, or `'auto'` for nested grids to size themselves to the parent grid container (to make sub-items are the same size). See [column](http://gridstackjs.com/demo/column.html) and [nested](http://gridstackjs.com/demo/nested.html)
9595
- `class`?: string - additional class on top of '.grid-stack' (which is required for our CSS) to differentiate this instance
9696
- `disableDrag` - disallows dragging of widgets (default: `false`).
97-
- `disableOneColumnMode` - disables the oneColumnMode when the grid width is less than minW (default: 'false')
97+
- `disableOneColumnMode` - Prevents the grid container from being displayed in "one column mode", even when the container's width is smaller than the value of oneColumnSize (default value of oneColumnSize is 768px). By default, this option is set to "false".
9898
- `disableResize` - disallows resizing of widgets (default: `false`).
9999
- `dragIn` - specify the class of items that can be dragged into grids
100100
* example: `dragIn: '.newWidget'`.
@@ -121,7 +121,7 @@ gridstack.js API
121121
- `minRow` - minimum rows amount which is handy to prevent grid from collapsing when empty. Default is `0`. You can also do this with `min-height` CSS attribute on the grid div in pixels, which will round to the closest row.
122122
- `nonce` - If you are using a nonce-based Content Security Policy, pass your nonce here and
123123
GridStack will add it to the <style> elements it creates.
124-
- `oneColumnSize` - minimal width. If grid width is less than or equal to, grid will be shown in one-column mode (default: `768`)
124+
- `oneColumnSize` - When the width of the grid is equal to or less than the value set in oneColumnSize, the grid will be displayed in one-column mode. By default, the value of this option is set to "768".
125125
- `oneColumnModeDomSort` - set to `true` if you want oneColumnMode to use the DOM order and ignore x,y from normal multi column layouts during sorting. This enables you to have custom 1 column layout that differ from the rest. (default?: `false`)
126126
- `placeholderClass` - class for placeholder (default: `'grid-stack-placeholder'`)
127127
- `placeholderText` - placeholder default content (default: `''`)

0 commit comments

Comments
 (0)