PR Section Layout (`pr`)

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.

Metadata

ID: https://dlvhdr.github.io/gh-dash/configuration/layout/pr/schema.json
Type: object

JSON Schema

Definition

{
  "$id": "https://dlvhdr.github.io/gh-dash/configuration/layout/pr/schema.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "default": {
    "assignees": {
      "hidden": true,
      "width": 20
    },
    "author": {
      "width": 15
    },
    "base": {
      "hidden": true,
      "width": 15
    },
    "lines": {
      "width": 16
    },
    "repo": {
      "width": 15
    },
    "updatedAt": {
      "width": 7
    }
  },
  "description": "Defines the columns a PR section displays in its table.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/layout/pr/",
  "properties": {
    "assignees": {
      "default": {
        "hidden": true,
        "width": 20
      },
      "description": "Defines options for the assignees column in a PR section.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/layout/pr/#assignees",
      "oneOf": [
        {
          "$ref": "https://dlvhdr.github.io/gh-dash/configuration/layout/options/schema.json"
        }
      ],
      "title": "PR Assignees Column",
      "type": "object"
    },
    "author": {
      "default": {
        "width": 15
      },
      "description": "Defines options for the author column in a PR section.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/layout/pr/#author",
      "oneOf": [
        {
          "$ref": "https://dlvhdr.github.io/gh-dash/configuration/layout/options/schema.json"
        }
      ],
      "title": "PR Author Column",
      "type": "object"
    },
    "base": {
      "default": {
        "hidden": true,
        "width": 15
      },
      "description": "Defines options for the base column in a PR section.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/layout/pr/#base",
      "oneOf": [
        {
          "$ref": "https://dlvhdr.github.io/gh-dash/configuration/layout/options/schema.json"
        }
      ],
      "title": "PR Base Column",
      "type": "object"
    },
    "ci": {
      "description": "Defines options for the ci column in a PR section.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/layout/pr/#ci",
      "oneOf": [
        {
          "$ref": "https://dlvhdr.github.io/gh-dash/configuration/layout/options/schema.json"
        }
      ],
      "title": "PR Continuous Integration Column",
      "type": "object"
    },
    "lines": {
      "default": {
        "width": 16
      },
      "description": "Defines options for the lines column in a PR section.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/layout/pr/#lines",
      "oneOf": [
        {
          "$ref": "https://dlvhdr.github.io/gh-dash/configuration/layout/options/schema.json"
        }
      ],
      "title": "PR Lines Column",
      "type": "object"
    },
    "repo": {
      "default": {
        "width": 15
      },
      "description": "Defines options for the repo column in a PR section.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/layout/pr/#repo",
      "oneOf": [
        {
          "$ref": "https://dlvhdr.github.io/gh-dash/configuration/layout/options/schema.json"
        }
      ],
      "title": "PR Repo Column",
      "type": "object"
    },
    "reviewStatus": {
      "description": "Defines options for the review status column in a PR section.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/layout/pr/#reviewStatus",
      "oneOf": [
        {
          "$ref": "https://dlvhdr.github.io/gh-dash/configuration/layout/options/schema.json"
        }
      ],
      "title": "PR Review Status Column",
      "type": "object"
    },
    "state": {
      "description": "Defines options for the state column in a PR section.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/layout/pr/#state",
      "oneOf": [
        {
          "$ref": "https://dlvhdr.github.io/gh-dash/configuration/layout/options/schema.json"
        }
      ],
      "title": "PR State Column",
      "type": "object"
    },
    "title": {
      "description": "Defines options for the title column in a PR section.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/layout/pr/#title",
      "oneOf": [
        {
          "$ref": "https://dlvhdr.github.io/gh-dash/configuration/layout/options/schema.json"
        }
      ],
      "title": "PR Title Column",
      "type": "object"
    },
    "updatedAt": {
      "default": {
        "width": 7
      },
      "description": "Defines options for the updated at column in a PR section.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/layout/pr/#updatedAt",
      "oneOf": [
        {
          "$ref": "https://dlvhdr.github.io/gh-dash/configuration/layout/options/schema.json"
        }
      ],
      "title": "PR Updated At Column",
      "type": "object"
    }
  },
  "title": "PR Section Layout",
  "type": "object"
}

Default Value

assignees:
  hidden: true
  width: 20
author:
  width: 15
base:
  hidden: true
  width: 15
lines:
  width: 16
repo:
  width: 15
updatedAt:
  width: 7

By default, PR views display the following columns in the order they’re listed:

updatedAt with a width of 7 columns.
state with a width of 3 columns.
repo with a width of 15 columns.
title, set to grow to fill available space.
author with a width of 10 columns.
reviewStatus with a width of 3 columns.
ci with a width of 3 columns.
lines with a width of 16 columns.

Even though the state, title, comments, and reactions settings aren’t explicitly defined in your configuration file, they’re added to the table unless you set their hidden option to false.

PR Updated At Column (`updatedAt`)

This column displays how recently the PR was updated. The entry shows the time elapsed since the last update, like 1h or 3d.

The heading for this column is .

Metadata

Type: object
Must be one of: Valid Layout Options (Schema)
Any column can define the grow, width, and hidden options.
For more information, see Valid Layout Options.

Default Value

width: 7

PR State Column (`state`)

This column displays the PR’s state as one of the following icons:

When a PR is open and ready for review, the icon is  and the color is #42a0fa.
When a PR is in draft mode, the icon is  and the color is set to the value of theme.colors.text.faint.
When a PR is merged, the icon is  and the color is #a371f7.
When a PR is closed without merging, the icon is  and the color is #c38080.

This heading for this column is .

Metadata

Type: object
Must be one of: Valid Layout Options (Schema)
Any column can define the grow, width, and hidden options.
For more information, see Valid Layout Options.

PR Repo Column (`repo`)

This column displays the name of the repository the PR is filed in. The entry shows the name of the repository without the owner, like gh-dash for the https://github.com/dlvhdr/gh-dash repository.

The heading for this column is .

Metadata

Type: object
Must be one of: Valid Layout Options (Schema)
Any column can define the grow, width, and hidden options.
For more information, see Valid Layout Options.

Default Value

width: 15

PR Title Column (`title`)

This column displays the PR’s number followed by its title. This column is always displayed unless you set hidden to false. By default, it grows to fill the available space in the terminal after accounting for other column widths.

The heading for this column is Title.

The theme.colors.text.primary setting defines the issue number’s color.

Metadata

Type: object
Must be one of: Valid Layout Options (Schema)
Any column can define the grow, width, and hidden options.
For more information, see Valid Layout Options.

PR Author Column (`author`)

This column displays the username for the person who created the PR.

The heading for this column is Author.

Metadata

Type: object
Must be one of: Valid Layout Options (Schema)
Any column can define the grow, width, and hidden options.
For more information, see Valid Layout Options.

Default Value

width: 15

PR Assignees Column (`assignees`)

This column displays the usernames for the people assigned to the PR.

The heading for this column is Assignees.

Metadata

Type: object
Must be one of: Valid Layout Options (Schema)
Any column can define the grow, width, and hidden options.
For more information, see Valid Layout Options.

Default Value

hidden: true
width: 20

PR Base Column (`base`)

This column displays the base branch the PR is targeting, like main.

The heading for this column is Base.

Metadata

Type: object
Must be one of: Valid Layout Options (Schema)
Any column can define the grow, width, and hidden options.
For more information, see Valid Layout Options.

Default Value

hidden: true
width: 15

PR Review Status Column (`reviewStatus`)

This column displays the review status of a PR as an icon:

When the PR hasn’t been reviewed, the icon is  and the color is the value of theme.colors.text.faint.
When the PR is approved, the icon is 󰄬 and the color is the value of theme.colors.text.primary.
When the PR has requested changes, the icon is 󰌑 and the color is the value of theme.colors.text.warning.

The heading for this column is 󰯢.

Metadata

Type: object
Must be one of: Valid Layout Options (Schema)
Any column can define the grow, width, and hidden options.
For more information, see Valid Layout Options.

PR Continuous Integration Column (`ci`)

This column displays the CI status of a PR as an icon:

When the checks haven’t finished running, the icon is  and the color is the value of theme.colors.text.faint.
When the checks have all passed, the icon is  and the color is the value of theme.colors.text.success.
When at least one check failed, the icon is 󰅙 and the color is the value of theme.colors.text.warning.

The heading for this column is .

Metadata

Type: object
Must be one of: Valid Layout Options (Schema)
Any column can define the grow, width, and hidden options.
For more information, see Valid Layout Options.

PR Lines Column (`lines`)

This column displays the line changes for a PR. The column represents the changes as <added> / -<removed>. For example, 66 / -46 indicates 66 lines added and 46 lines removed.

The heading for this column is .

Metadata

Type: object
Must be one of: Valid Layout Options (Schema)
Any column can define the grow, width, and hidden options.
For more information, see Valid Layout Options.

Default Value

width: 16