> 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-udbadge.md). # New-UDBadge New-UDBadge creates a small badge component in PowerShell Universal that displays a count or status indicator in the corner of its child element. ### Synopsis Badge generates a small badge to the top-right of its child(ren). ### Syntax ```powershell New-UDBadge [[-Id] ] [[-Color] ] [[-Children] ] [[-BadgeContent] ] [-Invisible] [[-Max] ] [[-Overlap] ] [-ShowZero] [[-Variant] ] [[-Location] ] [[-Sx] ] [] ``` ### Description Badge generates a small badge to the top-right of its child(ren). ### Parameters #### -Id The ID of the component. It defaults to a random GUID. ``` Required? false Position? 1 Default value ([Guid]::NewGuid()).ToString() Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -Color The color of the badge. Valid values are: "default", "primary", "secondary", "error", "info", "success", "warning" ``` Required? false Position? 2 Default value primary Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -Children The content that the badge is attached to. ``` Required? false Position? 3 Default value {} Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -BadgeContent The content to display within the badge. ``` Required? false Position? 4 Default value {} Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -Invisible Whether the badge is invisible. ``` Required? false Position? named Default value False Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -Max The maximum number to display. If the number is greater than this, it will display as "99+". Default is 99. ``` Required? false Position? 5 Default value 99 Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -Overlap The overlap of the badge. Valid values are: "circular", "rectangular" ``` Required? false Position? 6 Default value rectangular Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -ShowZero Whether to show the badge when the badgeContent is 0. ``` Required? false Position? named Default value False Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -Variant The variant of the badge. Valid values are: "standard", "dot" ``` Required? false Position? 7 Default value standard Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -Location The location of the badge. Valid values are: "topright", "topleft", "bottomright", "bottomleft" ``` Required? false Position? 8 Default value topright Accept pipeline input? false Aliases Accept wildcard characters? false ``` #### -Sx ``` Required? false Position? 9 Default value 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). ### Notes General notes \[Component("Badge", "Badge", "Creates a new badge.")] ### Examples #### Example 1: Primary badge ```powershell New-UDBadge -Color primary -BadgeContent { 4 } -Children { New-UDButton -Text "Primary" } -Id 'badge1' ``` Displays a badge with the text "4" on a primary button. #### Example 2: Color ```powershell New-UDBadge -Color secondary -BadgeContent { 4 } -Children { New-UDIcon -Icon Envelope -Size 2x } -Id 'badge2' New-UDBadge -Color error -BadgeContent { 4 } -Children { New-UDIcon -Icon Envelope -Size 2x } -Id 'badge3' ``` Changes the color of the badge. #### Example 3: ShowZero ```powershell New-UDBadge -ShowZero -BadgeContent { 0 } -Children { New-UDIcon -Icon Envelope -Size 2x } -Id 'badge4' ``` Shows the badge when the badgeContent is 0. #### Example 4: Max ```powershell New-UDBadge -Max 10 -BadgeContent { 11 } -Children { New-UDIcon -Icon Envelope -Size 2x } -Id 'badge5' ``` The maximum number to display. If the number is greater than this, it will display as "99+". Default is 99. #### Example 5: Overlap ```powershell New-UDBadge -Overlap circular -BadgeContent { 4 } -Children { New-UDIcon -Icon Envelope -Size 2x } -Id 'badge6' ``` The overlap of the badge. #### Example 6: Dot ```powershell New-UDBadge -Variant dot -BadgeContent { 4 } -Children { New-UDIcon -Icon Envelope -Size 2x } -Id 'badge7' ``` Display a dot badge. --- # 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-udbadge.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.