Related Work Items

IssueLinkTypeSelector

class IssueLinkTypeSelector(items: list[tuple[str, str]])

Bases: textual.widgets.Select

A custom Select widget for selecting the type of link between 2 items.

Initialization

Initialize the Select control.

Parameters:

• options – Options to select from. If no options are provided then allow_blank must be set to True.

• prompt – Text to show in the control when no option is selected.

• allow_blank – Enables or disables the ability to have the widget in a state with no selection made, in which case its value is set to the constant [Select.NULL][textual.widgets.Select.NULL].

• value – Initial value selected. Should be one of the values in options. If no initial value is set and allow_blank is False, the widget will auto-select the first available option.

• type_to_search – If True, typing will search for options.

• name – The name of the select control.

• id – The ID of the control in the DOM.

• classes – The CSS classes of the control.

• disabled – Whether the control is disabled or not.

• tooltip – Optional tooltip.

• compact – Enable compact select (without borders).

Raises:

EmptySelectError – If no options are provided and allow_blank is False.

LinkedWorkItemInputWidget

class LinkedWorkItemInputWidget

Bases: textual.widgets.Input

A custom Input widget for entering the key of a work item.

Initialization

Initialise the Input widget.

Parameters:

• value – An optional default value for the input.

• placeholder – Optional placeholder text for the input.

• highlighter – An optional highlighter for the input.

• password – Flag to say if the field should obfuscate its content.

• restrict – A regex to restrict character inputs.

• type – The type of the input.

• max_length – The maximum length of the input, or 0 for no maximum length.

• suggester – [Suggester][textual.suggester.Suggester] associated with this input instance.

• validators – An iterable of validators that the Input value will be checked against.

• validate_on – Zero or more of the values “blur”, “changed”, and “submitted”, which determine when to do input validation. The default is to do validation for all messages.

• valid_empty – Empty values are valid.

• select_on_focus – Whether to select all text on focus.

• name – Optional name for the input widget.

• id – Optional ID for the widget.

• classes – Optional initial classes for the widget.

• disabled – Whether the input is disabled or not.

• tooltip – Optional tooltip.

• compact – Enable compact style (without borders).

RelatedIssuesWidget

class RelatedIssuesWidget

Bases: textual.containers.VerticalScroll

A container for displaying the work items related to a work item.

See Also:

• Use Case: Relate Work Items

• Architecture

Initialization

Construct a scrollable container.

Parameters:

• children – Child widgets.

• name – The name of the widget.

• id – The ID of the widget in the DOM.

• classes – The CSS classes for the widget.

• disabled – Whether the widget is disabled or not.

• can_focus – Can this container be focused?

• can_focus_children – Can this container’s children be focused?

• can_maximized – Allow this container to maximize? None to use default logic.,

async action_link_work_item() → None

Opens a screen to adda link between two work items.

watch_issues(items: list[jiratui.models.RelatedJiraIssue] | None) → None

Updates the list of work items related to the currently-selected item.

Parameters:

items – the list of items related to the current work item.

Returns:

None

RelatedIssueCollapsible

class RelatedIssueCollapsible(*args, **kwargs)

Bases: textual.widgets.Collapsible

A collapsible to show a work item related to another item.

Initialization

Initialize a Collapsible widget.

Parameters:

• children – Contents that will be collapsed/expanded.

• title – Title of the collapsed/expanded contents.

• collapsed – Default status of the contents.

• collapsed_symbol – Collapsed symbol before the title.

• expanded_symbol – Expanded symbol before the title.

• name – The name of the collapsible.

• id – The ID of the collapsible in the DOM.

• classes – The CSS classes of the collapsible.

• disabled – Whether the collapsible is disabled or not.

class LinkDeleted

Bases: textual.message.Message

async delete_link() → None

Removes a link between two work items.

After removing a link this method will post the message jiratui.widgets.related_work_items.related_issues.RelatedIssueCollapsible.LinkDeleted to update the list of related issues in the parent widget.

Returns:

None