PR Layout
PR Section Layout
Section titled “PR Section Layout”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.
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.
updatedAt: width: 7repo: width: 15title: grow: trueauthor: width: 15assignees: width: 20 hidden: truebase: width: 15 hidden: truelines: width: 16
PR Updated At Column
Section titled “PR Updated At Column”Property | Type | Default |
---|---|---|
updatedAt | yaml |
|
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
PR State Column
Section titled “PR State Column”Property | Type | Default |
---|---|---|
state | yaml |
|
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 oftheme.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
PR Repo Column
Section titled “PR Repo Column”Property | Type | Default |
---|---|---|
repo | yaml |
|
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
PR Title Column
Section titled “PR Title Column”Property | Type | Default |
---|---|---|
title | yaml |
|
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.
PR Author Column
Section titled “PR Author Column”Property | Type | Default |
---|---|---|
author | yaml |
|
This column displays the username for the person who created the PR.
The heading for this column is Author
.
PR Author Role Icon
Section titled “PR Author Role Icon”Property | Type | Default |
---|---|---|
authorIcon | yaml |
|
This setting affects display of the role icon for the person who created the PR.
PR Assignees Column
Section titled “PR Assignees Column”Property | Type | Default |
---|---|---|
assignees | yaml |
|
This column displays the usernames for the people assigned to the PR.
The heading for this column is Assignees
.
PR Base Column
Section titled “PR Base Column”Property | Type | Default |
---|---|---|
base | yaml |
|
This column displays the base branch the PR is targeting, like main
.
The heading for this column is Base
.
PR Review Status Column
Section titled “PR Review Status Column”Property | Type | Default |
---|---|---|
reviewStatus | yaml |
|
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 oftheme.colors.text.faint
. - When the PR is approved, the icon is
and the color is the value oftheme.colors.text.primary
. - When the PR has requested changes, the icon is
and the color is the value oftheme.colors.text.warning
.
The heading for this column is
.
PR Continuous Integration Column
Section titled “PR Continuous Integration Column”Property | Type | Default |
---|---|---|
ci | yaml |
|
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 oftheme.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 oftheme.colors.text.warning
.
The heading for this column is
PR Lines Column
Section titled “PR Lines Column”Property | Type | Default |
---|---|---|
lines | yaml |
|
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
.