Documentation

Fields

• tab :: Bool

  Whether to open the buffer in a new tab.

• vertical :: Bool

  Whether to split the current window vertically, only relevant for non-floating windows.

• wrap :: Bool

  Whether to set the wrap option in the window, to disable breaking long lines.

• focus :: Bool

  Whether to move the cursor to the window after opening it.

• resize :: Bool

  Whether to adapt the buffer's size to the number of lines, for horizontal splits.

• bottom :: Bool

  Whether to place the window at the bottom of the stack, only relevant for non-floating windows.

• modify :: Bool

  Whether to set the modifiable option for the buffer.

• float :: Maybe FloatOptions

  If Just, creates a floating window with the given config.

• size :: Maybe Int

  The initial size of the window.

• maxSize :: Maybe Int

  When resizing automatically, do not exceed this size.

• syntax :: [Syntax]

  A set of syntax rules to apply to the buffer.

• mappings :: [Mapping]

  A set of key mappings to define buffer-locally. See Ribosome.Mappings.

• filetype :: Maybe Text

  The value for the filetype option.

• name :: ScratchId

  The ID of the scratch buffer.