The rating input component is used to allow the user to select a rating value within a specified range of values.
Example
Displays or allows input of star ratings.
code
<script type="module">
import '@blueprintui/components/include/rating.js';
</script>
<bp-field>
<label>rating</label>
<bp-rating value="3"></bp-rating>
</bp-field>Vertical
Demonstrates the rating component in vertical form layout.
code
<bp-form-group layout="vertical">
<bp-field>
<label>label</label>
<bp-rating value="3"></bp-rating>
<bp-field-message>message text</bp-field-message>
</bp-field>
<bp-field>
<label>disabled</label>
<bp-rating value="3" disabled></bp-rating>
<bp-field-message>disabled message</bp-field-message>
</bp-field>
<bp-field status="error">
<label>error</label>
<bp-rating value="3"></bp-rating>
<bp-field-message status="error">error message</bp-field-message>
</bp-field>
<bp-field status="success">
<label>success</label>
<bp-rating value="3"></bp-rating>
<bp-field-message status="success">success message</bp-field-message>
</bp-field>
</bp-form-group>Horizontal
Demonstrates the rating component in horizontal form layout.
code
<bp-form-group layout="horizontal">
<bp-field layout="horizontal">
<label>label</label>
<bp-rating value="3"></bp-rating>
<bp-field-message>message text</bp-field-message>
</bp-field>
<bp-field layout="horizontal">
<label>disabled</label>
<bp-rating value="3" disabled></bp-rating>
<bp-field-message>disabled message</bp-field-message>
</bp-field>
<bp-field layout="horizontal" status="error">
<label>error</label>
<bp-rating value="3"></bp-rating>
<bp-field-message status="error">error message</bp-field-message>
</bp-field>
<bp-field layout="horizontal" status="success">
<label>success</label>
<bp-rating value="3"></bp-rating>
<bp-field-message status="success">success message</bp-field-message>
</bp-field>
</bp-form-group>Compact
Demonstrates the rating component in compact form layout.
code
<bp-form-group layout="compact">
<bp-field layout="compact">
<label>label</label>
<bp-rating value="3"></bp-rating>
<bp-field-message>message text</bp-field-message>
</bp-field>
<bp-field layout="compact">
<label>disabled</label>
<bp-rating value="3" disabled></bp-rating>
<bp-field-message>disabled message</bp-field-message>
</bp-field>
<bp-field layout="compact" status="error">
<label>error</label>
<bp-rating value="3"></bp-rating>
<bp-field-message status="error">error message</bp-field-message>
</bp-field>
<bp-field layout="compact" status="success">
<label>success</label>
<bp-rating value="3"></bp-rating>
<bp-field-message status="success">success message</bp-field-message>
</bp-field>
</bp-form-group>Install
NPM
// npm package
import '@blueprintui/components/include/rating.js';CDN
<script type="module">
import 'https://cdn.jsdelivr.net/npm/@blueprintui/components/include/rating.js/+esm';
</script>Accessibility
- The rating input component should be fully accessible to users using keyboard navigation.
- When a user navigates to the rating input component, they should be able to adjust the value by using the arrow keys.
- The rating input component should also be labeled and provide a clear indication of the current value, minimum and maximum values, and what the range input represents to users.
bp-rating
Events
| Name | Types | Description |
|---|---|---|
input | InputEvent | occurs when the value changes |
change | InputEvent | occurs when the value changes |
Properties
| Name | Types | Description |
|---|---|---|
value | string | number | FormData | File | Defines the current rating value selected by the user |
min | number | Defines the minimum rating value in the range of permitted values |
max | number | Defines the maximum rating value in the range of permitted values |
disabled | boolean | determines if element is mutable or focusable |
required | boolean | indicates that the user must specify a value for the input before the owning form can be submitted |
readonly | boolean | makes the element not mutable, meaning the user can not edit the control |
multiple | boolean | determines he form control accepts one or more values |
autocomplete | string | provide automated assistance in filling out form field values, and guidance to the browser as to the type of information expected in the field |
type | string | string specifying the type of control to render |
formNoValidate | boolean | determines if the form control is novalidate |
name | string | represents the name of the current |
pattern | string | regular expression the form control's value should match |
placeholder | string | defines a short hint to help the user with data entry when a form control has no value |
minLength | number | defines minimum number of characters |
maxLength | number | defines maximum number of characters |
size | number | determines number of characters |
formAssociated | boolean | |
valueAsNumber | ||
composedLabel | ||
focus | ||
reset |
Attributes
| Name | Types | Description |
|---|---|---|
value | string | number | FormData | File | Defines the current rating value selected by the user |
min | number | Defines the minimum rating value in the range of permitted values |
max | number | Defines the maximum rating value in the range of permitted values |
disabled | boolean | determines if element is mutable or focusable |
required | boolean | indicates that the user must specify a value for the input before the owning form can be submitted |
readonly | boolean | makes the element not mutable, meaning the user can not edit the control |
multiple | boolean | determines he form control accepts one or more values |
autocomplete | string | provide automated assistance in filling out form field values, and guidance to the browser as to the type of information expected in the field |
type | string | string specifying the type of control to render |
formNoValidate | boolean | determines if the form control is novalidate |
pattern | string | regular expression the form control's value should match |
placeholder | string | defines a short hint to help the user with data entry when a form control has no value |
minLength | number | defines minimum number of characters |
maxLength | number | defines maximum number of characters |
size | number | determines number of characters |
CSS Properties
| Name | Types | Description |
|---|---|---|
--background | ||
--selected-background |