Skip to main content

Intro

Note

The Directory application is deployed on customer servers upon request. If you are interested in using this application, please contact our support team at sales@wallboard.info.

Important

This custom application is actively being developed, and the information in this documentation may be subject to change. If you encounter any issues or have any questions, reach out to our support team at support@wallboard.info.

The Directory application provides an efficient and user-friendly way to browse, search, and filter a directory of contacts or other information. It is designed to handle large datasets while ensuring a seamless and responsive experience across multiple devices.

Features​

  • Interactive Search – Quickly locate contacts using built-in search functionality.
  • Real-time Filtering – Dynamically refine search results as you type.
  • Responsive Design – Optimized for various screen sizes and devices.
  • Smooth Data Handling – Efficiently processes and loads data for a seamless user experience.

Prerequisites​

Before using the Directory widget, ensure that the following requirements are met:

  • A valid data source containing contact information.
  • Basic knowledge of configuring the widget (covered in the settings section).

Sensor Events​

The Directory widget emits several sensor events to communicate changes and user interactions.

Default Sensor Events​

When the widget is loaded, it automatically sends out two sensor events:

  1. DirectoryCurrentPage – Indicates which page is currently displayed.
  2. DirectoryPage – Provides details on the total number of available pages and the currently selected page. This event is primarily used by the Form widget or any other widget to display navigation buttons.

Both events are triggered whenever the user navigates through the directory.

Item Selection Event​

  • ItemSelected – Triggered when a user clicks on an entry. The event value contains the selected entry’s details in JSON format.

External Commands​

The Directory widget supports several external commands to enhance interactivity and navigation:

These commands allow users to move between pages within the directory:

  • Next Page – Moves to the next page (if navigation is enabled).
  • Previous Page – Moves to the previous page (if navigation is enabled).
  • Go to Page – Jumps to a specific page, provided it exists and navigation is enabled.

Sorting Commands​

Control how directory entries are sorted:

  • Set Sort By – Defines which field is used for sorting. Available options:
    • First
    • Second
    • Third
    • Fourth
  • Set Sort Order – Specifies the sorting order. Available options:
    • original
    • originalReversed
    • abc
    • abcReversed

Search and Filtering Commands​

  • Search in Directory – Dynamically filters entries based on the provided search term. To reset the search, send an empty value.
  • Jump to First Appearance – Scrolls to the first occurrence of a specified value within the directory entries (if found).

For further assistance, please contact support@wallboard.info.

Last updated on