> For the complete documentation index, see [llms.txt](https://docs.devolutions.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.devolutions.net/powershell-universal/powershell-commands/new-udautocomplete.md). # New-UDAutocomplete New-UDAutocomplete creates a text input component in PowerShell Universal enhanced with a filterable panel of suggested options. ### Synopsis The autocomplete is a normal text input enhanced by a panel of suggested options. ### Syntax ```powershell New-UDAutocomplete [-Id ] [-Label ] [-Value ] [-OnChange ] [-Options ] [-FullWidth] [-AutoSelect] [-Variant ] [-Multiple] [-ClassName ] [-Icon ] [-OnEnter ] [-Disabled] [] New-UDAutocomplete [-Id ] [-Label ] [-Value ] [-OnChange ] -OnLoadOptions [-FullWidth] [-AutoSelect] [-Variant ] [-Multiple] [-ClassName ] [-Icon ] [-OnEnter ] [-Disabled] [] ``` ### Description Autocomplete text boxes can be used to allow the user to select from a large list of static or dynamic items. Typing in the textbox will filter the list. ### Parameters #### -Id The ID of the component. It defaults to a random GUID. ``` Required? false Position? named Default value ([Guid]::NewGuid()) Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -Label The label to show for the textbox. ``` Required? false Position? named Default value Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -Value The value of the textbox. ``` Required? false Position? named Default value Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -OnChange A script block that is invoked when the selection changes. ``` Required? false Position? named Default value Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -OnLoadOptions A script block that is called when the user starts typing in the text box. The $Body variable will contain the typed text. You should return a JSON array of values that are a result of what the user has typed. ``` Required? true Position? named Default value Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -Options Static options to display in the selection drop down. When the user types, these options will be filtered. ``` Required? false Position? named Default value @() Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -FullWidth Whether the component should take up the full width of its parent. ``` Required? false Position? named Default value False Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -AutoSelect Whether the component should automatically be selected if there was only one total option with the options array. ``` Required? false Position? named Default value False Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -Variant The variant of the text box. Valid values are: "filled", "outlined", "standard" ``` Required? false Position? named Default value standard Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -Multiple Whether multiple items can be selected. ``` Required? false Position? named Default value False Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -ClassName A CSS class to apply to the component. ``` Required? false Position? named Default value Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -Icon The icon to display before the text box. Use New-UDIcon to create the value for this parameter. ``` Required? false Position? named Default value Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -OnEnter A script block to call when the user presses enter within the autocomplete textbox. ``` Required? false Position? named Default value Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -Disabled Whether this autocomplete is disabled. ``` Required? false Position? named Default value False Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### Common parameters This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see [about\_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ### Outputs ### Examples #### Example 1: Basic autocomplete ```powershell New-UDAutocomplete -Options @('Test', 'Test2', 'Test3', 'Test4') -Id 'autocomplete1' -FullWidth ``` The value must be chosen from a predefined set of allowed values. #### Example 2 ```powershell New-UDAutocomplete -Options @("Test", "No", "Yes") -Multiple -Id 'autocomplete2' -FullWidth Multi-Select|Allow the user to select multiple values. ``` #### Example 3: Variants ```powershell New-UDStack -Content { New-UDAutocomplete -Options @("Test", "No", "Yes") -Variant 'filled' -Id 'autocomplete3' -FullWidth New-UDAutocomplete -Options @("Test", "No", "Yes") -Variant 'outlined' -Id 'autocomplete4' -FullWidth New-UDAutocomplete -Options @("Test", "No", "Yes") -Variant 'standard' -Id 'autocomplete5' -FullWidth } -Direction 'column' -FullWidth ``` Change the the style of the autocomplete textbox. #### Example 4: Handling changes ```powershell New-UDAutocomplete -Options @("Test", "No", "Yes") -OnChange { Show-UDToast $EventData } -Id 'autocomplete6' -FullWidth ``` Execute PowerShell when the autocomplete changes. #### Example 5: OnEnter ```powershell New-UDAutocomplete -Options @("Test", "No", "Yes") -OnEnter { Show-UDToast $EventData } -Id 'autocomplete7' -FullWidth ``` Execute PowerShell when the user presses enter. #### Example 6: Asynchronous options ```powershell New-UDAutocomplete -OnLoadOptions { @('Test', 'Test2', 'Test3', 'Test4') | Where-Object { $_ -match $Body } | ConvertTo-Json } -Id 'autocomplete8' -FullWidth ``` Creates an autocomplete with a dynamically filtered set of options #### Example 7 ```powershell New-UDAutocomplete -Options @( New-UDAutocompleteOption -Name 'Test' -Value 'test' -Group 'Group1' New-UDAutocompleteOption -Name 'Test2' -Value 'test2' -Group 'Group1' New-UDAutocompleteOption -Name 'Test3' -Value 'test3' -Group 'Group2' New-UDAutocompleteOption -Name 'Test4' -Value 'test4' -Group 'Group2' ) -Id 'autocomplete9' -FullWidth ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.devolutions.net/powershell-universal/powershell-commands/new-udautocomplete.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.