Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Definition
Namespace: Microsoft.CommandPalette.Extensions
The IListPage interface represents a page in the Command Palette that displays a list of items. It is used to present a collection of items in a structured format, allowing users to interact with and select from the list.
Properties
| Property | Type | Description |
|---|---|---|
| EmptyContent | ICommandItem | The content to display when the list is empty. This property can be used to provide a message or action for the user when there are no items to display. |
| Filters | IFilters | The filters applied to the list. This property allows users to refine the items displayed in the list based on specific criteria. |
| GridProperties | IGridProperties | The properties of the grid layout used to display the list items. This property defines how the items are arranged and presented in the grid. |
| HasMoreItems | Boolean | Indicates whether there are more items to load in the list. This property is used to determine if additional items can be fetched or displayed. |
| PlaceholderText | String | The text to display when the list is empty or no items match the current filters. This property provides context to the user about the state of the list. |
| SearchText | String | The text used to filter the list items. This property allows users to search for specific items within the list. |
| ShowDetails | Boolean | Indicates whether to show detailed information about the items in the list. This property can be used to toggle between a summary view and a detailed view of the items. |
Methods
| Method | Description |
|---|---|
| GetItems() | Retrieves the items to be displayed in the list. This method is used to fetch the data that populates the list. |
| LoadMore() | Loads more items into the list. This method is used to fetch additional data when the user requests more items, such as when scrolling or clicking a "Load More" button. |
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Windows developer