New-UDAutocomplete

Synopsis

L'autocomplétion est une saisie de texte normale enrichie d'un panneau d'options suggérées.

Syntaxe

New-UDAutocomplete [-Id <String>] [-Label <String>] [-Value <Object>] [-OnChange <Endpoint>] [-Options <Object>] [-FullWidth] [-AutoSelect] [-Variant <String>] [-Multiple] [-ClassName <String>] [-Icon <Object>] [-OnEnter <Endpoint>] [-Disabled] [<CommonParameters>]

New-UDAutocomplete [-Id <String>] [-Label <String>] [-Value <Object>] [-OnChange <Endpoint>] -OnLoadOptions <Endpoint> [-FullWidth] [-AutoSelect] [-Variant <String>] [-Multiple] [-ClassName <String>] [-Icon <Object>] [-OnEnter <Endpoint>] [-Disabled] [<CommonParameters>]

Description

Les zones de texte d'autocomplétion peuvent servir à permettre à l'utilisateur de sélectionner parmi une longue liste d'éléments statiques ou dynamiques. La saisie dans la zone de texte filtrera la liste.

Paramètres

-Id

L'ID du composant. Il s'agit par défaut d'un GUID aléatoire.

Required?                    false
Position?                    named
Default value                ([Guid]::NewGuid())
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Label

L'étiquette à afficher pour la zone de texte.

Required?                    false
Position?                    named
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Value

La valeur de la zone de texte.

Required?                    false
Position?                    named
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-OnChange

Un bloc de script qui est invoqué lorsque la sélection change.

Required?                    false
Position?                    named
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-OnLoadOptions

Un bloc de script qui est appelé lorsque l'utilisateur commence à taper dans la zone de texte. La variable $Body contiendra le texte saisi. Vous devriez retourner un tableau JSON de valeurs résultant de ce que l'utilisateur a tapé.

Required?                    true
Position?                    named
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Options

Options statiques à afficher dans la liste déroulante de sélection. Lorsque l'utilisateur tape, ces options seront filtrées.

Required?                    false
Position?                    named
Default value                @()
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-FullWidth

Si le composant doit occuper toute la largeur de son parent.

Required?                    false
Position?                    named
Default value                False
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-AutoSelect

Si le composant doit automatiquement être sélectionné lorsqu'il n'y avait qu'une seule option au total dans le tableau d'options.

Required?                    false
Position?                    named
Default value                False
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Variant

La variante de la zone de texte. Les valeurs valides sont : "filled", "outlined", "standard"

Required?                    false
Position?                    named
Default value                standard
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Multiple

Si plusieurs éléments peuvent être sélectionnés.

Required?                    false
Position?                    named
Default value                False
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-ClassName

Une classe CSS à appliquer au composant.

Required?                    false
Position?                    named
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Icon

L'icône à afficher avant la zone de texte. Utilisez New-UDIcon pour créer la valeur de ce paramètre.

Required?                    false
Position?                    named
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-OnEnter

Un bloc de script à appeler lorsque l'utilisateur appuie sur entrée dans la zone de texte d'autocomplétion.

Required?                    false
Position?                    named
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Disabled

Si cette autocomplétion est désactivée.

Required?                    false
Position?                    named
Default value                False
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

Paramètres communs

Cette applet de commande prend en charge les paramètres communs : Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable et OutVariable. Pour plus d'informations, consultez about_CommonParameters.

Sorties

Exemples

Exemple 1 : Autocomplétion de base

New-UDAutocomplete -Options @('Test', 'Test2', 'Test3', 'Test4') -Id 'autocomplete1' -FullWidth

La valeur doit être choisie parmi un ensemble prédéfini de valeurs autorisées.

Exemple 2

New-UDAutocomplete -Options @("Test", "No", "Yes") -Multiple  -Id 'autocomplete2' -FullWidth

Multi-Select|Allow the user to select multiple values.

Exemple 3 : Variantes

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

Changer le style de la zone de texte d'autocomplétion.

Exemple 4 : Gestion des changements

New-UDAutocomplete -Options @("Test", "No", "Yes") -OnChange {
   Show-UDToast $EventData
}  -Id 'autocomplete6' -FullWidth

Exécuter du PowerShell lorsque l'autocomplétion change.

Exemple 5 : OnEnter

New-UDAutocomplete -Options @("Test", "No", "Yes") -OnEnter {
   Show-UDToast $EventData
} -Id 'autocomplete7' -FullWidth

Exécuter du PowerShell lorsque l'utilisateur appuie sur entrée.

Exemple 6 : Options asynchrones

New-UDAutocomplete -OnLoadOptions {
  @('Test', 'Test2', 'Test3', 'Test4') | Where-Object { $_ -match $Body } | ConvertTo-Json
} -Id 'autocomplete8' -FullWidth

Crée une autocomplétion avec un ensemble d'options filtrées dynamiquement

Exemple 7

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