Search¶
While some Skuid data components (including the Deck, Form List, and Table), offer optional search within the model the component is assigned to, the Search component allows end users to globally search specified fields across any object accessible through a Skuid data source—even those not represented by models on the Skuid page.
Custom actions can be launched right from the Search bar using the Action Framework, for example, opening a record’s detail page for the selected search result.
Using the Search Component¶
Note
The content below assumes you have a Skuid page and at least one working model.
Add the Search component to facilitate global search across multiple objects. Once the component is added to the page, set the properties:
- Set the Search properties. (Basic tab)
- Identify which objects should be included in the search by adding them as a row action and add formatting for each model’s header and displays. (Return Objects tab)
That’s it—now users can search for content across multiple objects, with the search results organized by object.
Create a hotkey¶
Want a way to access the search box quickly and easily from anywhere on the page? Create a hotkey using the properties on the Focus Hotkeys tab. When a user types the key combination, the cursor will jump to the search box, allowing the user to begin typing their search text.
Note
Hotkeys work when browsing the page. If the end user is in the middle of a process or interacting with an element on the page—editing a text field, for example—the hotkey combination will not migrate the end user to the search box.
Add actions¶
Use the Action Framework to add user-launched actions to the Search component’s results list. Some examples of actions for the search bar include:
- Launching a record detail page for the selected item
- Opening an associated Skuid page.
- Opening an associated website page.
Types of actions available¶
Global actions¶
Actions created on the Search properties Global Action tab will appear as next to each search result and are activated by clicking their label or icon.
Object-specific actions¶
Object-specific actions are created on the Return Objects tab, under the specific return object. These work like the Global actions, but will only appear next to search results for the specific return object.
Best Practices¶
- For a clean and streamlined user experience, place the Search Component into a custom header.
- Use global actions when you want the end user to be able to launch a process for any item in the search returns list; use object-specific actions when you want them to launch actions that are specific to the object or data source.
Properties¶
(Just need to look up a property? Try going directly to the Property Library.)