grid_stack_item: Grid Stack Item

View source: R/gridstackeR.R

grid_stack_itemR Documentation

Grid Stack Item

Description

This is a wrapper for the individual items to be displayed in the grid_stack Check the gridstack documentation for more information.

The default for all parameters is an empty string, this will make them disappear for gridstackjs

Usage

grid_stack_item(
  ...,
  id = NULL,
  auto_position = NULL,
  x = NULL,
  y = NULL,
  w = NULL,
  h = NULL,
  max_w = NULL,
  min_w = NULL,
  max_h = NULL,
  min_h = NULL,
  locked = NULL,
  no_resize = NULL,
  no_move = NULL,
  resize_handles = NULL,
  hide_overflow = TRUE
)

Arguments

...

content to include in the grid stack item

id

the id of the item, used for save and load functions, this param is propagated through to lower levels. If the id is provided, changes made to the item by the user will trigger reactive inputs for width, height (both in pixels), x, y, w, h (all 4 in number of columns/rows) (see Documentation for more information)

auto_position

if set to TRUE x and y attributes are ignored and the element is placed to the first available position. Having either x or y missing will also do that

x, y

element position in columns/rows. Note: if one is missing this will auto_position the item

w, h

element size in columns/rows

max_w, min_w, max_h, min_h

element constraints in column/row (default none)

locked

means another widget wouldn't be able to move it during dragging or resizing. The widget can still be dragged or resized by the user. You need to add no_resize and no_move attributes to completely lock the widget.

no_resize

if set to TRUE it disables element resizing

no_move

if set to TRUE it disables element moving

resize_handles

- widgets can have their own custom resize handles.

hide_overflow

hides the overflow of the item-content by default (i.e adds "overflow:hidden;" to the style) For example 'e,w' will make that particular widget only resize east and west.

Value

a grid_stack_item to be placed inside a grid_stack. This item is resizable and draggable by default.

Examples

## Not run: 
grid_stack_item(
h = 2, w = 2,
box(
  title = "gridstackeR", status = "success", solidHeader = TRUE, width = 12, height = "100%",
  div("Drag and scale the Boxes as desired")
)
)

## End(Not run)


petergandenberger/gridstackeR documentation built on April 27, 2023, 12:52 p.m.