New-UDToggleButtonGroup

Résumé

Un bouton bascule peut être utilisé pour regrouper des options connexes.

Syntaxe

New-UDToggleButtonGroup [[-Id] <String>] [[-Color] <String>] [-Disabled] [-Exclusive] [-FullWidth] [[-OnChange] <Endpoint>] [[-Size] <String>] [[-Orientation] <String>] [[-Sx] <Hashtable>] [[-Value] <String[]>] [-Children] <ScriptBlock> [<CommonParameters>]

Description

Un bouton bascule peut être utilisé pour regrouper des options connexes.

Paramètres

-Id

L'ID du composant. Si aucun n'est spécifié, un GUID aléatoire sera assigné.

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

-Color

La couleur du composant. Les valeurs valides sont 'standard', 'primary', 'secondary', 'error', 'info', 'success', 'warning'.

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

-Disabled

Si spécifié, le composant sera désactivé.

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

-Exclusive

Si spécifié, le composant n'autorisera qu'une seule sélection.

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

-FullWidth

Si spécifié, le composant occupera toute la largeur de son conteneur.

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

-OnChange

Le terminal à appeler lorsque la valeur du composant change.

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

-Size

La taille du composant. Les valeurs valides sont 'small', 'medium', 'large'.

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

-Orientation

L'orientation du composant. Les valeurs valides sont 'horizontal', 'vertical'.

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

-Sx

Le style du composant.

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

-Value <String[]>

La valeur du composant.

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

-Children

Le contenu du composant. Utilisez New-UDToggleButton pour créer des boutons bascule.

Required?                    true
Position?                    8
Default value
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 : Sélection exclusive

New-UDToggleButtonGroup -Content {
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    }
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    }
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    } -Id 'test'
} -Exclusive

Avec la sélection exclusive, la sélection d'une option désélectionne toutes les autres.

Exemple 2 : Sélection multiple

New-UDToggleButtonGroup -Content {
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    }
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    }
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    } -Id 'test'
}

Avec la sélection multiple, la sélection d'une option ne désélectionne aucune autre.

Exemple 3 : Taille

New-UDToggleButtonGroup -Content {
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    }
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    }
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    } -Id 'test'
} -Size 'small'

La petite taille équivaut au style de bouton bascule dense.

Exemple 4 : Orientation

New-UDToggleButtonGroup -Content {
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    }
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    }
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    } -Id 'test'
} -Orientation 'vertical'

L'orientation verticale peut être utilisée pour afficher une colonne de boutons bascule.

Exemple 5 : OnChange

New-UDToggleButtonGroup -Content {
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    }
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    }
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    } -Id 'test'
} -OnChange {
    Show-UDToast -Message "You selected $EventData"
}

Le terminal OnChange est appelé lorsque la valeur du composant change. Les données de l'événement correspondent à la valeur du composant.