CLI previewInstall commands shown on this site are not released yet.

DocsComponentsCommerce

Rating

React example follows below.
ts
import { Rating } from "@grassroot/ui-react";
const [value, setValue] = React.useState(4);
<Rating value={value} onChange={setValue} label="Rate this trowel" />
<Rating value={4.5} readOnly size="sm" />

No translated snippet for this adapter yet.

ts
import { Component, signal } from "@angular/core";
import { GrassrootRating } from "@grassroot/ui-angular";
@Component({
selector: "app-example",
standalone: true,
imports: [GrassrootRating],
template: `
<grassroot-rating
[value]="value()"
(change)="value.set($event)"
label="Rate this trowel"
/>
<grassroot-rating [value]="4.5" [readOnly]="true" size="sm" />
`,
})
export class ExampleComponent {
readonly value = signal(4);
}
ts
<script lang="ts">
import { Rating } from "@grassroot/ui-svelte";
let value = $state(4);
</script>
<Rating value={value} onChange={(next) => (value = next)} label="Rate this trowel" />
<Rating value={4.5} readOnly size="sm" />
ts
import { createSignal } from "solid-js";
import { Rating } from "@grassroot/ui-solid";
export function Example() {
const [value, setValue] = createSignal(4);
return (
<>
<Rating value={value()} onChange={setValue} label="Rate this trowel" />
<Rating value={4.5} readOnly size="sm" />
</>
);
}

Installation

bash
pnpm dlx grassroot add ui/rating
bash
npx grassroot@latest add ui/rating
bash
yarn dlx grassroot add ui/rating
bash
bunx grassroot add ui/rating

API Reference

RatingProps
PropTypeDefault
valuenumber | undefined
defaultValuenumber | undefined
maxnumber | undefined5
readOnlyDisplay only (no input).boolean | undefinedtrue
onChange((value: number) => void) | undefined
size"sm" | "md" | "lg" | undefined"md"
labelAccessible name.string | undefined"Rating"
classNamestring | undefined