Table
Table component for Universal Apps
Tables display sets of data. They can be fully customized.
Tables display information in a way that’s easy to scan, so that users can look for patterns and insights. They can be embedded in primary content, such as cards.
Simple Table
A simple example with no frills. Table columns are defined from the data.
Table with Custom Columns
Define custom columns for your table.
Table with Custom Column Rendering
Define column rendering. Sorting and exporting still work for the table.
Table Column Width
Column width can be defined using the -Width parameter. You can also decide to truncate columns that extend past that width.
Filters
You can configure custom filters per column. The table supports text, select, fuzzy , slider, range, date , number, and autocomplete filters.
Static Options for Select Filters
When using server-side processing, the available filters may not display the full range of options since the select dropdown only has access to the current page of results. To avoid this, you can use the -Options parameter on New-UDTableColumn.
Search
To enable search, use the -ShowSearch parameter on New-UDTable.
When using custom columns, you will need to add the -IncludeInSearch parameter to the columns you'd like to include in the search.
Table with server-side processing
Process data on the server so you can perform paging, filtering, sorting and searching in systems like SQL. To implement a server-side table, you will use the -LoadData parameter. This parameter accepts a ScriptBlock. The $EventData variable includes information about the state of the table. You can use cmdlets to process the data based on this information.
$EventData Structure
The $EventData object contains the following properties.
Filters
Hashtable[] @{ id = 'fieldName'
value = 'filterValue' }
A list of filter values. Each hashtable has an Id and a Value property.
OrderBy
Hashtable @{ field = "fieldName" }
Property name to sort by.
OrderDirection
string
asc or desc depending on the sort order.
Page
int
The current page (starting with 0).
PageSize
int
The selected page size.
Properties
string[]
An array of properties being shown in the table.
Search
string
A search string provided by the user.
TotalCount
int
The total number of records before filtering or paging.
Example
Retrieving Displayed Data
You may want to allow the user to take action on the current set of displayed data. To do so, use Get-UDElement in the input object you want to retrieve the data from and get the table by Id. Once you have the element, you can use the Data property of the element to get an array of currently displayed rows.
Paging
By default, paging is disable and tables will grow based on how many rows of data you provide. You can enable paging by using the -ShowPagination cmdlet (alias -Paging). You can configure the page size using the -PageSize cmdlet.
Disable Page Size All
By default, the page size selector provides an option to show all rows. If you want to prevent users from doing this, use the -DisablePageSizeAll cmdlet.
Pagination Location
You can change the location of the pagination control by using the -PaginationLocation parameter. It accepts top, bottom and both.
Page Sizes
The page size, by default, is set to 5. Users can adjust the number of rows per page by using the Rows per page drop down. You can adjust the default page size by using the -PageSize parameter. To adjust the values available within the Rows per page drop down, you can use an array of integers pass to the -PageSizeOptions parameter.
Sorting
To enable sorting for a table, use the -ShowSort parameter. When you enable sorting, you will be able to click the table headers to sort the table by clicking the headers. By default, multi-sort is enabled. To multi-hold shift and click a column header.
You can control which columns can be sorted by using New-UDTableColumn and -ShowSort parameter.
Disable Sort Remove
By default, the sorting of a table has 3 states. Unsorted, ascending and descending. If you would like to disable the unsorted state, use the -DisableSortRemove parameter of New-UDTable.
Selection
Tables support selection of rows. You can create an event handler for the OnRowSelected parameter to receive when a new row is selected or unselected or you can use Get-UDElement to retrieve the current set of selected rows.
The following example creates a table with row selection enabled. A toast is show when clicking the row or when clicking the GET Rows button.
The $EventData variable for the -OnRowSelected event will include all the columns as properties and a selected property as to whether the row was selected or unselected.
For example, the service table data would look like this.
Collapsible Rows
You can include additional information within the table by using the -OnRowExpand parameter of New-UDTable. It accepts a ScriptBlock that you can use to return additional components.
Exporting
Tables support exporting the data within the table. You can export as CSV, XLSX, JSON or PDF. You can define which columns to include in an export and choose to export just the current page or all the data within the table.
Hidden Columns
Hidden columns allow you to include data that is not displayed in the table but is included in the exported data.
The following hides the StartType column from the user but includes it in the export.
Server-Side Exporting
You can control the export functionality with a PowerShell script block. This is useful when exporting from server-side sources like SQL server tables.
In this example, I have a SQL table that contains podcasts. When exporting, you will receive information about the current state of the table to allow you to customize what data is exported.
Customizing Export Options
You can decide which export options to present to your users using the -ExportOption cmdlet. The following example would only show the CSV export option.
Customizing Labels
You can use the -TextOption parameter along with the New-UDTableTextOption cmdlet to set text fields within the table.
Refresh with a button
Data Parameter
You can externally refresh a table by putting the table within a dynamic region and using Sync-UDElement.
This example creates a button to refresh the table.
LoadData Parameter
If you use the -LoadData parameter, you can sync the table directly. This has the benefit of maintaining the table state, such as the page and filtering, after the refresh.
Show Refresh Button
You can use the -ShowRefresh parameter to provide a refresh button for server-side tables.
Alternating Row Colors
You can use a theme to create a table with alternating row colors.
API
Last updated
Was this helpful?