> 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-udrating.md).

# New-UDRating

### Synopsis

Ratings provide insight regarding others' opinions and experiences, and can allow the user to submit a rating of their own.

### Syntax

```powershell
New-UDRating [[-Id] <String>] [[-DefaultValue] <Double>] [-Disabled] [[-EmptyLabelText] <String>] [-HighlightSelectedOnly] [[-Max] <Double>] [[-OnChange] <Endpoint>] [[-Precision] <Double>] [[-Size] <String>] [[-Value] <Double>] [<CommonParameters>]
```

### Description

Ratings provide insight regarding others' opinions and experiences, and can allow the user to submit a rating of their own.

### Parameters

#### -Id

An ID for this component. If not specified, a random GUID will be used.

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

#### -DefaultValue

The default value for this rating.

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

    -Disabled [<SwitchParameter>]
        Whether this rating is disabled.

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

#### -EmptyLabelText

The text to show when the rating is empty.

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

    -HighlightSelectedOnly [<SwitchParameter>]
        Whether to highlight the selected rating only.

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

#### -Max

The maximum value for this rating.

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

#### -OnChange

A script block to call when the rating is changed. The $EventData variable will be the new value.

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

#### -Precision

The precision of the rating. Defaults to 1.

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

#### -Size

The size of the rating. Can be small, medium, or large.

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

#### -Value

The current value of the rating.

```
Required?                    false
Position?                    8
Default value                0
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

    <CommonParameters>
        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

\-------------------------- EXAMPLE 1 --------------------------

```
PS >New-UDRating -Value 3 -Id 'rating1'

Basic Rating|Creates a basic rating component.




-------------------------- EXAMPLE 2 --------------------------

PS >New-UDRating -Value 3 -OnChange {
PS >    Show-UDToast -Message "Rating changed to $EventData"
PS > } -Id 'rating2'

OnChange|Creates a rating component with an OnChange script block.




-------------------------- EXAMPLE 3 --------------------------

PS >New-UDRating -Value 3 -Size large -Id 'rating3'

Size|Creates a large rating component.




-------------------------- EXAMPLE 4 --------------------------

PS >New-UDRating -Value 3 -Disabled -Id 'rating4'

Disabled|Creates a disabled rating component.




-------------------------- EXAMPLE 5 --------------------------

PS >New-UDRating -Value 3 -HighlightSelectedOnly -Id 'rating5'

Highlight Selected Only|Creates a rating component that only highlights the selected rating.
```


---

# 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-udrating.md?ask=<question>&goal=<endgoal>
```

`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.
