Defaults

Default Options (defaults)

These settings define the default behavior for the dashboard. You can override many of these settings on a per-section basis.

Metadata

ID

https://dlvhdr.github.io/gh-dash/configuration/defaults/schema.json

Type

object

JSON Schema

Definition
{
  "$id": "https://dlvhdr.github.io/gh-dash/configuration/defaults/schema.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "default": {
    "issuesLimit": 20,
    "preview": {
      "open": true,
      "width": 50
    },
    "prsLimit": 20,
    "refetchIntervalMinutes": 30,
    "view": "prs"
  },
  "description": "Define options that can be overridden per-section.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/defaults/",
  "properties": {
    "dateFormat": {
      "default": 30,
      "description": "Specifies how dates are formatted.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/defaults/#dateFormat",
      "minimum": 1,
      "title": "Date format",
      "type": "integer"
    },
    "issuesLimit": {
      "default": 20,
      "description": "Global limit on the number of issues fetched for the dashboard\n\nhttps://dlvhdr.github.io/gh-dash/configuration/defaults/#issuesLimit",
      "minimum": 1,
      "title": "Issue Fetch Limit",
      "type": "integer"
    },
    "layout": {
      "description": "Defines the layout for the work item tables in the dashboard.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/defaults/#layout",
      "properties": {
        "issues": {
          "$ref": "https://dlvhdr.github.io/gh-dash/configuration/layout/issue/schema.json"
        },
        "prs": {
          "$ref": "https://dlvhdr.github.io/gh-dash/configuration/layout/pr/schema.json"
        }
      },
      "title": "Layout Options",
      "type": "object"
    },
    "preview": {
      "description": "Defaults for the preview pane\n\nhttps://dlvhdr.github.io/gh-dash/configuration/defaults/#preview",
      "properties": {
        "open": {
          "default": true,
          "description": "Whether to have the preview pane open by default when the dashboard loads.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/defaults/#open",
          "title": "Open on Load",
          "type": "boolean"
        },
        "width": {
          "default": 50,
          "description": "Specifies the width of the preview pane in columns.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/defaults/#width",
          "minimum": 1,
          "title": "Preview Pane Width",
          "type": "integer"
        }
      },
      "title": "Preview Pane",
      "type": "object"
    },
    "prsLimit": {
      "default": 20,
      "description": "Global limit on the number of PRs fetched for the dashboard\n\nhttps://dlvhdr.github.io/gh-dash/configuration/defaults/#prsLimit",
      "minimum": 1,
      "title": "PR Fetch Limit",
      "type": "integer"
    },
    "refetchIntervalMinutes": {
      "default": 30,
      "description": "Specifies how often to refetch PRs and Issues in minutes.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/defaults/#refetchIntervalMinutes",
      "minimum": 1,
      "title": "Refetch Interval in Minutes",
      "type": "integer"
    },
    "view": {
      "default": "prs",
      "description": "Specifies whether the dashboard should display the PRs or Issues view on load.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/defaults/#view",
      "enum": [
        "issues",
        "prs"
      ],
      "title": "Default View",
      "type": "string"
    }
  },
  "title": "Default Options",
  "type": "object"
}

<h2 id="defaults.default">Default Value</h2>

issuesLimit: 20
preview:
  open: true
  width: 50
prsLimit: 20
refetchIntervalMinutes: 30
view: prs

By default, the dashboard is configured to:

  • Display the preview pane with a width of 50 columns for all work items.
  • Only fetch 20 PRs and issues at a time for each section.
  • Display the PRs view when the dashboard loads.
  • Refetch PRs and issues for each section every 30 minutes.
  • Display dates using relative values.

For more details on the default layouts, see the documentation for PR and issue layout definitions.

Layout Options (layout)

This setting defines the layout for the work item tables in the dashboard. You can override these settings in any section you define in the prSections or issueSections settings.

They determine which columns are displayed and how.

Metadata

Type

object

PR Section Layout (prs)

You can define how a PR section displays items in its table by setting options for the available columns. You can define a column’s width, whether it grows to fill available space, and whether the column should be visible at all.

Note that if the length of a column’s text exceeds the defined column width, the view truncates the column’s text to two characters shorter than the column’s width. For example, if the width is 6, gh-dash displays as gh-d.

Column headings have their color defined by the theme.colors.text.primary setting.

For more information, see PR Section Layout

Issue Section Layout (issues)

You can define how an issue section displays items in its table by setting options for the available columns. You can define a column’s width, whether it grows to fill available space, and whether the column should be visible at all.

Note that if the length of a column’s text exceeds the defined column width, the view truncates the column’s text to two characters shorter than the column’s width. For example, if the width is 6, gh-dash displays as gh-d.

Column headings have their color defined by the theme.colors.text.primary setting.

For more information, see Issue Section Layout

PR Fetch Limit (prsLimit)

This setting defines how many PRs the dashboard should fetch for each section when:

Metadata

Type

integer

Must be ≥

1

Preview Pane (preview)

These settings define the how the preview pane displays in the dashboard. You can specify whether the preview pane is open by default and how many columns wide it should be when displayed.

Metadata

Type

object

Open on Load (open)

Specifies whether the preview pane should be open by default for the selected work item when the dashboard loads. You can always use the toggle preview pane command to toggle the preview pane’s visibility.

By default, the dashboard displays the preview pane.

Metadata

Type

boolean

Preview Pane Width (width)

Specifies how many columns wide the preview pane should be when displayed.

By default, the preview pane is 50 columns wide.

Metadata

Type

integer

Must be ≥

1

Issue Fetch Limit (issuesLimit)

This setting defines how many issues the dashboard should fetch for each section when:

Metadata

Type

integer

Must be ≥

1

Refetch Interval in Minutes (refetchIntervalMinutes)

This setting defines how often the dashboard should fetch issues and PRs from GitHub. The dashboard fetches work items for every section in the active view when the dashboard loads and the first time you switch to the inactive view.

After the dashboard fetches the work items for the first time, it waits until this setting’s defined interval elapses before fetching the work items again.

By default, the dashboard refetches work items every 30 minutes.

You can always use the refresh current section or refresh all sections command to refetch work items in the current view. If you change the search query for a view, the dashboard fetches results for the updated query immediately.

Metadata

Type

integer

Must be ≥

1

Date format (dateFormat)

This setting defines how dates are formatted. The format can be either be “relative” or a go time format.

By default, the format is “relative” which fits just inside the default column width of updated at in the issues and pull request layouts.

You may need to adjust the layout column width depending on your format.

Metadata

Type

integer

Must be ≥

1

Default View (view)

This setting defines whether the dashboard should display the PRs or Issues view when it first loads.

By default, the dashboard displays the PRs view.

Metadata

Type

string

Enums

issues
prs