Filters Widgets

This module contains the widgets used for the filters of the search functionality used in the main screen.

ProjectSelectionInput

class ProjectSelectionInput(projects: list)

Bases: textual.widgets.Select

A Select widget to select a project from a list of projects.

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.

projects: textual.reactive.Reactive[dict | None]

‘reactive(…)’

A dictionary with 2 keys: projects: list and selection: str | None

IssueTypeSelectionInput

class IssueTypeSelectionInput(types: list)

Bases: textual.widgets.Select

A Select widget for selecting the type of work item among a list of possible types.

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.

IssueStatusSelectionInput

class IssueStatusSelectionInput(statuses: list, **kwargs)

Bases: textual.widgets.Select

A Select widget for selecting the status of a work item among a list of possible statuses.

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.

WorkItemInputWidget

class WorkItemInputWidget(value: str | None = None)

Bases: textual.widgets.Input

An input widget that holds 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).

IssueSearchCreatedFromWidget

class IssueSearchCreatedFromWidget(widget_id: str | None = None, valid_empty: bool = True)

Bases: jiratui.widgets.base.DateInput

An input widget that holds a date value to search work items created on or after this date.

Initialization

Initialise the MaskedInput widget.

Parameters:

template – Template string.
value – An optional default value for the input.
placeholder – Optional placeholder text for the input.
validators – An iterable of validators that the MaskedInput 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.
name – Optional name for the masked 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).

IssueSearchCreatedUntilWidget

class IssueSearchCreatedUntilWidget(widget_id: str | None = None, valid_empty: bool = True)

Bases: jiratui.widgets.base.DateInput

An input widget that holds a date value to search work items created on or before this date.

Initialization

Initialise the MaskedInput widget.

Parameters:

template – Template string.
value – An optional default value for the input.
placeholder – Optional placeholder text for the input.
validators – An iterable of validators that the MaskedInput 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.
name – Optional name for the masked 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).

OrderByWidget

class OrderByWidget(options: list, initial_value: str | None = None)

Bases: textual.widgets.Select

A Select widget to display different alternatives to sort search results.

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.

ActiveSprintCheckbox

class ActiveSprintCheckbox(value: bool = False)

Bases: textual.widgets.Checkbox

A check box to search work items in the active sprint.

Initialization

Initialise the toggle.

Parameters:

label – The label for the toggle.
value – The initial value of the toggle.
button_first – Should the button come before the label, or after?
name – The name of the toggle.
id – The ID of the toggle in the DOM.
classes – The CSS classes of the toggle.
disabled – Whether the button is disabled or not.
tooltip – RenderableType | None = None,
compact – Show a compact button.

JQLSearchWidget

class JQLSearchWidget

Bases: textual.widgets.Input

An input widget that holds a JQL expression.

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).