Skip to content

UINavigation

The UINavigation class provides methods and properties for managing Navigation View in the Application Center. It corresponds to the tree control on the left side. Navigation View lists all available applications in the system (that user has right to access).

Properties:

  • source: any
    Represents the source of the navigation tree. You will never need to populate it yourself. It is used in StartApp. Modifying it might cause the Application Center to become corrupted.
  • focused: UINavigationNode
    The currently focused node in the navigation tree. This represents the node (application) that is currently selected or focused.
  • root: UINavigationNode
    The root node of the navigation tree, representing the starting point or top-level element in the navigation structure. It points to StartApp.
  • searchBox: boolean
    A flag that indicates whether the search box is visible in the Navigation View. If true, the search box is displayed; otherwise, it is hidden.

Methods:

  • show()
    Displays the Navigation View, making the navigation elements visible to the user.
  • hide()
    Hides the Navigation View, making the navigation elements invisible to the user.
  • find(appOrClassOrComparer: string | App | Class): UINavigationNode
    Searches for and returns the first node in the navigation tree that matches the provided string, app, or class. Returns the matching UINavigationNode if found, or undefined if no match is found.
  • appOrClassOrComparer: A string, app, or class used to find the matching navigation node.
  • findAll(appOrClassOrComparer: string | App | Class | ((n: UINavigationNode) => boolean)): UINavigationNode[]
    Searches for and returns all nodes in the navigation tree that match the provided string, app, class, or a custom comparison function. Returns an array of UINavigationNode objects that match the criteria.
  • appOrClassOrComparer: A string, app, class, or a custom comparison function that evaluates whether a node should be included in the result.