Skip to content

TUI Navigation Guide#

General Structure:#

  1. The TUI consists of many tabs, each tab may or may not contain nested tabs.
  2. The TUI consists of one main navigation bar which contains (Auth Server, FIDO, SCIM, Scripts, Users, and Jans CLI)

image

  1. The tab currently in focus is highlighted at the top. ex:

image

Note:

  • in the image provided below SCIM is focused
  • We can notice that there is a cursor mark on the first of the Navigation bar line, which indicates that the focus currently in this widget cursor_line

General Purpose shortcuts#

  • f1 :
    Open help dialog (currently, help dialog is static, in the near future it will dynamically change according to the current position inside the TUI )

f1

  • ESC :
    Close any dialog or even nested dialog

esc

  • Ctrl+c(Terminate) :
    Terminate the program (SIGINT)

General Navigation shortcuts#

  • tab(Next):
    focus on the next field or widget.

tab

  • shift + tab(Previous):
    focus on the previous field or widget

shift_tab

  • PageUp(Next tab):
    Jump to the next tab in dialogs (ex: Client dialog)

Note:
the focus must be inside the current tab
 In the Gif provided, the focus was inside the tab itself before we can press the PageUp key
* If the focus is on the tab name itself, we can navigate to other tabs by the Up key and Down key

page_down

  • PageDown(Previous tab) :
    Jump to the previous tab in dialogs (ex: Client dialog)
    Note:
  • the focus must be inside the current tab
  • In the Gif provided, the focus was inside the tab itself before we can press the PageDown key
  • If the focus is on the tab name itself, we can navigate to other tabs by the Up key and Down key

page_up

Main tabs Navigation shortcuts#

  • Alt + key
    You can navigate to any tab inside the TUI by using the Alt key followed by a certain letter from the tab you want to navigate too

Note:
the colored character inside each Tab name is the specified letter for the navigation.
 you can't navigate from a tab in the main top navigation bar to a nested navigation bar inside another tab, you must navigate to it first.

examples on the navigation letters for the main navigation bar:

  • Auth Server -> A
  • FIDO -> F
  • SCIM -> C
  • Scripts -> r
  • Users -> U
  • Jans CLI -> J

navigation

Custom widget shortcuts#

Note:
* This section contains any widgets with special shortcuts and behavior

Lists (Vertical Nav bar)#

currently, we have about 6 List widgets

Note:
Any list widget can be navigated between its items by the Up key and Down key
 There are some shortcuts here that can be used in most but not all List widgets

  • delete:
    can be used to delete a certain item

  • d:
    can be used to view all the selected item data in the JSON format

  • Enter:
    can be used to edit the current item

ex:

image

  • p: can be used to update user's password.

Clipboard - April 3, 2023 9_29 PM

Date Widgets#

The date widget can be used to select a date and time. ex (Client Expiration Date)

image

  • tab, shift + tab:
    can be used to navigate between date and time

image

  • Up, Down, Right, and Left arrows:
    can be used to change the date and time

Note: * in the date section, if you navigate to the right border and then pressed Right, the year will be increased.
in the date section, if you navigate to the left border and then pressed Left, the year will be decreased.
 in the date section, if you navigate to the up border and then pressed Up, the month will be decreased.
* in the date section, if you navigate to the down border and then pressed Down, the month will be increased.

date_wid_year

  • in the time section, you can navigate between hour, minute, and second by the Right key and the Left key.
  • in the time section, you can increase the time (hour, minute, or second) by the Up key and the Down key.

date_wid_time

Label Widgets#

The label widget is used with scopes to show certain items instead of a long one, it is similar to the list widget

  • tab, shift + tab:
    can be used to navigate between the button and the labels

  • Right key and Left key
    can be used to navigate between the labels

  • d:
    can be used to view all the data of the selected label

  • delete:
    can be used to delete a certain label

image

Logout and Exit#

Exit will close the TUI screen while logout will force re-authentication of TUI using device-code.

Navigate to Jans TUI on upper right corner of the screen and hit enter.

Last update: 2023-11-17
Created: 2023-02-28