Valid Options

Valid Layout Options (options)

Any column can define the grow, width, and hidden options.

JSON Schema

Definition
{
  "$id": "https://dlvhdr.github.io/gh-dash/configuration/layout/options/schema.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "grow": {
      "description": "Select whether the column should grow to fill available space.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/layout/options/#grow",
      "title": "Grow Column",
      "type": "boolean"
    },
    "hidden": {
      "description": "Select whether the column should be hidden from view.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/layout/options/#hidden",
      "title": "Hide Column",
      "type": "boolean"
    },
    "width": {
      "description": "Select the column's width by cell count.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/layout/options/#width",
      "minimum": 0,
      "title": "Column Width",
      "type": "integer"
    }
  },
  "title": "Valid Layout Options",
  "type": "object"
}

Grow Column (grow)

Specify whether the column should grow to fill the available space.

Set this value to true and the column’s width expands to fill any leftover space in the terminal after accounting for other columns and the preview pane. Set this value to false to use the value of width instead.

We recommend only setting this for one column in a given section layout.

Column Width (width)

Specify the column’s width by character count. Because the dashboard expects the terminal font to be monospace, this is a reliable way to ensure a minimum width for readability.

Hide Column (hidden)

Specify whether the column should be hidden from view. Set this value to true to hide the column or true to show it.