Widget catalog

This catalog lists each view that a backend renders, in the order of composeui.core.view. Each name links to its API reference. The user guide shows how to use them. A column per backend says whether the backend renders the view (✓) or not (—).

Views

These views have a renderer of their own (their _renderer_key).

View	Renderer	Qt	Textual	Web	What it shows
StatusBar	status_bar	✓	✓	✓	A line at the bottom of the window that shows a short message to the user.
ActionView	action	✓	✓	✓	An entry of a menu or a toolbar that the user triggers, for example Save.
DialogView	dialog	✓	✓	✓	A modal message or confirmation, shown from open until the user answers.
ReplaceFileDialogView	dialog	✓	✓	✓	A question before saving over a file that exists, e.g. a path typed: Replace or Cancel.
SeparatorAction	separator	✓	✓	✓	A line between two groups of entries in a menu or a toolbar.
Menu	menu	✓	✓	✓	A menu of the window, with an entry for each of its action fields.
ToolBar	toolbar	✓	✓	✓	A row of actions at the top of the window, for the ones the user runs most.
NewAction	action	✓	✓	✓	The New action of the File menu, which starts a new study.
OpenFileAction	action	✓	✓	✓	The Open action of the File menu, which opens a study from a file.
PickFileAction	action	✓	✓	✓	An action picking a file to open; file_picked emits its path.
SaveAction	action	✓	✓	✓	The Save action of the File menu, which saves the study to a file.
SaveAsAction	action	✓	✓	✓	The Save As action of the File menu, which saves the study to a file.
ExitAppAction	action	✓	✓	✓	The Exit action of the File menu, which closes the app.
FileMenu	menu	✓	✓	✓	The File menu of the main view, with New, Open, Save, Save As and Exit.
LanguageMenu	menu	✓	✓	✓	A menu of the app’s languages, the one shown checked; triggering one shows it.
MainView	main	✓	✓	✓	The root view of an app: its window, with the menus, the status bar and the content.
InputView	input	✓	✓	✓	A field where the user types one line of text, for example a name.
TextAreaView	text_area	✓	✓	✓	A field where the user types several lines of text, for example a comment.
FloatInputView	float_input	✓	✓	✓	A field where the user types a decimal number, for example a length.
IntInputView	int_input	✓	✓	✓	A whole number, e.g. an hour of the day; a spin box where the toolkit has one.
DateInputView	date_input	✓	✓	✓	A date, e.g. a booking’s first day: typed in the main view’s language’s format.
SavePathInputView	save_path_input	✓	✓	✓	A path to save a file to, e.g. a report: typed, or picked from a save dialog.
FolderPathInputView	folder_path_input	✓	✓	✓	A folder’s path, e.g. where to write results: typed, or picked from a folder dialog.
FilePathInputView	file_path_input	✓	✓	✓	A file’s path, e.g. a data file to read: typed, or picked from a file dialog.
SliderView	slider	✓	✓	✓	A whole number picked by dragging a handle, e.g. a number of workers.
LogView	log	✓	✓	✓	A message to the user, for example an error, styled by its log_type.
LabelView	label	✓	✓	✓	A line of read-only text, for example a caption.
MarkdownView	markdown	✓	✓	✓	Read-only Markdown text, for example a help page.
ConsoleView	console	✓	✓	✓	Plain text that the app adds to as it comes, for example the output of a process.
CheckBoxView	checkbox	✓	✓	✓	A check box with a text, for an option that is on or off.
ButtonView	button	✓	✓	✓	A button the user clicks to act on what the page shows, e.g. to submit a form.
ProgressBarView	progress_bar	✓	✓	✓	How far a long task has gone, e.g. a computation working through its cases.
MetricView	metric	✓	✓	✓	A figure read at a glance, e.g. the jobs running, and how much it changed.
MapView	map	✓	—	✓	An interactive street map with geographic points drawn over its tiles.
ChartView	chart	✓	✓	✓	A chart of results, e.g. a quantity against time or a swept dimension.
TableView	table	✓	✓	✓	A table of text that the app formats cell by cell (see TableMixin).
RecordTableView	table	✓	✓	✓	A table of records, attrs instances, each a row with a cell per column.
SourceTableView	source_table	✓	✓	✓	A large table, whose rows a source keeps and the table reads a window at a time.
RadioGroupView	radio_group	✓	✓	✓	A group of radio buttons, for one choice among a few values.
ComboBoxView	combobox	✓	✓	✓	A drop-down list, for one choice among values.
FormView	form	✓	✓	✓	A form: its rows, one above the other, and the message of its cross-field checks.
GroupFormView	group_form	✓	✓	✓	A form in a box with a title, for example a group of related fields.
DialogButtonView	dialog_button	✓	✓	✓	A button of a dialog’s own, between Cancel and OK, e.g. Apply: a field of the dialog.
OkCancelDialogView	dialog	✓	✓	✓	A modal showing a view above its buttons: Cancel, its own, then OK.
TypedFormDialogView	form_dialog	✓	✓	✓	A modal holding a form, e.g. editing a record from its Edit button, with OK and Cancel.
FormDialogView	form_dialog	✓	✓	✓	A form dialog with a default empty FormView, with OK and Cancel.
ContentDialogView	content_dialog	✓	✓	✓	A modal holding a view, e.g. a table to pick a file from, with OK and Cancel.
HorizontalView	horizontal	✓	✓	✓	Its view fields laid out side by side, in a row.
VerticalView	vertical	✓	✓	✓	Its view fields laid out one above the other, in a column, as tall as their content.
SplitterView	splitter	✓	✓	✓	Its view fields in panes, side by side, the user dragging the border between two.
ExpanderView	expander	✓	✓	✓	A collapsible section: its title always shown, its view fields only while expanded.
TabPage	tab_page	✓	✓	✓	A tab of a TabView: its title on the tab, its view fields its content, in a column.
TabView	tabs	✓	✓	✓	Views shown a tab at a time, picked from a row of tabs, e.g. a record’s details and history.
GridView	grid	✓	✓	✓	Its view fields laid out in a grid: equally wide columns, rows as tall as their views.
PageView	page	✓	✓	✓	A page of the app, shown while its Router is on the page’s route.
Router	router	✓	✓	✓	Pages shown one at a time, picked from a toolbar with an entry per page.
SidebarView	sidebar	✓	✓	✓	A column of views beside the pages, shown whatever the page, e.g. a form creating a record.
ListView	list	✓	✓	✓	A view per record, laid out in a column, e.g. an expander per record.
TreeView	tree	✓	✓	✓	Nodes in a tree, e.g. a site’s buildings, their floors and their rooms.

Form rows

A form row is a field with its label, in a FormView. The form renders the row, and the field of the row has the renderer of the view in the second column (its _field_renderer_key).

View	Field renderer	Qt	Textual	Web	What it shows
RowInputView	input	✓	✓	✓	A row of a form with a field for one line of text, without a label.
LabelRowInputView	input	✓	✓	✓	A row of a form with a label and a field for one line of text.
RowTextAreaView	text_area	✓	✓	✓	A row of a form with a field for several lines of text, without a label.
LabelRowTextAreaView	text_area	✓	✓	✓	A row of a form with a label and a field for several lines of text.
RowFloatInputView	float_input	✓	✓	✓	A row of a form with a field for a decimal number, without a label.
LabelRowFloatInputView	float_input	✓	✓	✓	A row of a form with a label and a field for a decimal number.
RowIntInputView	int_input	✓	✓	✓	A row of a form with a field for a whole number, without a label.
LabelRowIntInputView	int_input	✓	✓	✓	A row of a form with a label and a field for a whole number.
RowDateInputView	date_input	✓	✓	✓	A row of a form with a date field, without a label.
LabelRowDateInputView	date_input	✓	✓	✓	A row of a form with a label and a date field.
RowFilePathInputView	file_path_input	✓	✓	✓	A row of a form with a file path field, without a label.
LabelRowFilePathInputView	file_path_input	✓	✓	✓	A row of a form with a label and a file path field.
RowSavePathInputView	save_path_input	✓	✓	✓	A row of a form with a field of a path to save a file to, without a label.
LabelRowSavePathInputView	save_path_input	✓	✓	✓	A row of a form with a label and a field of a path to save a file to.
RowFolderPathInputView	folder_path_input	✓	✓	✓	A row of a form with a folder path field, without a label.
LabelRowFolderPathInputView	folder_path_input	✓	✓	✓	A row of a form with a label and a folder path field.
RowSliderView	slider	✓	✓	✓	A row of a form with a slider, without a label.
LabelRowSliderView	slider	✓	✓	✓	A row of a form with a label and a slider.
RowCheckBoxView	checkbox	✓	✓	✓	A row of a form with a check box, without a label.
LabelRowCheckBoxView	checkbox	✓	✓	✓	A row of a form with a label and a check box.
RowRadioGroupView	radio_group	✓	✓	✓	A row of a form with a group of radio buttons, without a label.
LabelRowRadioGroupView	radio_group	✓	✓	✓	A row of a form with a label and a group of radio buttons.
RowComboBoxView	combobox	✓	✓	✓	A row of a form with a drop-down list, without a label.
LabelRowComboBoxView	combobox	✓	✓	✓	A row of a form with a label and a drop-down list.