@fluentui/react-rating 9.0.0

package/CHANGELOG.md

@@ -0,0 +1,172 @@
+# Change Log - @fluentui/react-rating
+
+This log was last generated on Fri, 15 Mar 2024 21:37:57 GMT and should not be manually modified.
+
+<!-- Start content -->
+
+## [9.0.0](https://github.com/microsoft/fluentui/tree/@fluentui/react-rating_v9.0.0)
+
+Fri, 15 Mar 2024 21:37:57 GMT 
+[Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-rating-preview_v0.4.0..@fluentui/react-rating_v9.0.0)
+
+### Minor changes
+
+- 'feat: Release Rating to stable. ([PR #30740](https://github.com/microsoft/fluentui/pull/30740) by ololubek@microsoft.com)
+- Bump @fluentui/react-jsx-runtime to v9.0.33 ([PR #30740](https://github.com/microsoft/fluentui/pull/30740) by beachball)
+- Bump @fluentui/react-theme to v9.1.18 ([PR #30740](https://github.com/microsoft/fluentui/pull/30740) by beachball)
+- Bump @fluentui/react-tabster to v9.19.4 ([PR #30740](https://github.com/microsoft/fluentui/pull/30740) by beachball)
+- Bump @fluentui/react-utilities to v9.18.4 ([PR #30740](https://github.com/microsoft/fluentui/pull/30740) by beachball)
+
+## [0.4.0](https://github.com/microsoft/fluentui/tree/@fluentui/react-rating-preview_v0.4.0)
+
+Thu, 07 Mar 2024 19:33:24 GMT
+[Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-rating-preview_v0.3.2..@fluentui/react-rating-preview_v0.4.0)
+
+### Minor changes
+
+- breaking: Update icon api type to ElementType ([PR #30666](https://github.com/microsoft/fluentui/pull/30666) by ololubek@microsoft.com)
+- Bump @fluentui/react-jsx-runtime to v9.0.32 ([PR #30687](https://github.com/microsoft/fluentui/pull/30687) by beachball)
+- Bump @fluentui/react-theme to v9.1.17 ([PR #30687](https://github.com/microsoft/fluentui/pull/30687) by beachball)
+- Bump @fluentui/react-tabster to v9.19.3 ([PR #30687](https://github.com/microsoft/fluentui/pull/30687) by beachball)
+- Bump @fluentui/react-utilities to v9.18.3 ([PR #30687](https://github.com/microsoft/fluentui/pull/30687) by beachball)
+
+### Patches
+
+- chore: Update jsdocs and stories in Rating ([PR #30653](https://github.com/microsoft/fluentui/pull/30653) by ololubek@microsoft.com)
+
+## [0.3.2](https://github.com/microsoft/fluentui/tree/@fluentui/react-rating-preview_v0.3.2)
+
+Wed, 28 Feb 2024 02:34:18 GMT
+[Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-rating-preview_v0.3.1..@fluentui/react-rating-preview_v0.3.2)
+
+### Patches
+
+- fix: Add focus border styling to Rating ([PR #30581](https://github.com/microsoft/fluentui/pull/30581) by ololubek@microsoft.com)
+- fix: update RatingItem styling to use flex to align all items properly ([PR #30638](https://github.com/microsoft/fluentui/pull/30638) by ololubek@microsoft.com)
+- fix: Add flex wrap to Rating and RatingDisplay ([PR #30639](https://github.com/microsoft/fluentui/pull/30639) by ololubek@microsoft.com)
+- Bump @fluentui/react-jsx-runtime to v9.0.31 ([PR #30639](https://github.com/microsoft/fluentui/pull/30639) by beachball)
+- Bump @fluentui/react-tabster to v9.19.2 ([PR #30639](https://github.com/microsoft/fluentui/pull/30639) by beachball)
+- Bump @fluentui/react-utilities to v9.18.2 ([PR #30639](https://github.com/microsoft/fluentui/pull/30639) by beachball)
+
+## [0.3.1](https://github.com/microsoft/fluentui/tree/@fluentui/react-rating-preview_v0.3.1)
+
+Tue, 20 Feb 2024 14:22:24 GMT
+[Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-rating-preview_v0.3.0..@fluentui/react-rating-preview_v0.3.1)
+
+### Patches
+
+- fix: remove component assignment from prop destructuring ([PR #30520](https://github.com/microsoft/fluentui/pull/30520) by seanmonahan@microsoft.com)
+- fix: update vertical styling for RatingDisplay to fix vertical alignment ([PR #30465](https://github.com/microsoft/fluentui/pull/30465) by ololubek@microsoft.com)
+- Bump @fluentui/react-jsx-runtime to v9.0.30 ([PR #30543](https://github.com/microsoft/fluentui/pull/30543) by beachball)
+- Bump @fluentui/react-tabster to v9.19.1 ([PR #30543](https://github.com/microsoft/fluentui/pull/30543) by beachball)
+- Bump @fluentui/react-utilities to v9.18.1 ([PR #30543](https://github.com/microsoft/fluentui/pull/30543) by beachball)
+
+## [0.3.0](https://github.com/microsoft/fluentui/tree/@fluentui/react-rating-preview_v0.3.0)
+
+Tue, 06 Feb 2024 17:55:19 GMT
+[Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-rating-preview_v0.2.1..@fluentui/react-rating-preview_v0.3.0)
+
+### Minor changes
+
+- chore: Simplify high contrast visuals for RatingItem, and remove iconOutline from RatingDisplay ([PR #30457](https://github.com/microsoft/fluentui/pull/30457) by behowell@microsoft.com)
+- Bump @fluentui/react-tabster to v9.19.0 ([PR #30392](https://github.com/microsoft/fluentui/pull/30392) by beachball)
+
+### Patches
+
+- chore: add accesibility props to Rating and RatingDisplay ([PR #30414](https://github.com/microsoft/fluentui/pull/30414) by ololubek@microsoft.com)
+- chore: add accessibility props to Rating and RatingDisplay ([PR #30421](https://github.com/microsoft/fluentui/pull/30421) by ololubek@microsoft.com)
+
+## [0.2.1](https://github.com/microsoft/fluentui/tree/@fluentui/react-rating-preview_v0.2.1)
+
+Tue, 30 Jan 2024 23:16:54 GMT
+[Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-rating-preview_v0.2.0..@fluentui/react-rating-preview_v0.2.1)
+
+### Patches
+
+- Bump @fluentui/react-jsx-runtime to v9.0.29 ([PR #29983](https://github.com/microsoft/fluentui/pull/29983) by beachball)
+- Bump @fluentui/react-tabster to v9.18.0 ([PR #29983](https://github.com/microsoft/fluentui/pull/29983) by beachball)
+- Bump @fluentui/react-utilities to v9.18.0 ([PR #29983](https://github.com/microsoft/fluentui/pull/29983) by beachball)
+
+## [0.2.0](https://github.com/microsoft/fluentui/tree/@fluentui/react-rating-preview_v0.2.0)
+
+Fri, 26 Jan 2024 10:40:21 GMT
+[Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-rating-preview_v0.1.6..@fluentui/react-rating-preview_v0.2.0)
+
+### Minor changes
+
+- feat: Add RatingDisplay component ([PR #30323](https://github.com/microsoft/fluentui/pull/30323) by ololubek@microsoft.com)
+
+## [0.1.6](https://github.com/microsoft/fluentui/tree/@fluentui/react-rating-preview_v0.1.6)
+
+Tue, 23 Jan 2024 15:11:00 GMT
+[Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-rating-preview_v0.1.5..@fluentui/react-rating-preview_v0.1.6)
+
+### Patches
+
+- Bump @fluentui/react-jsx-runtime to v9.0.28 ([PR #30359](https://github.com/microsoft/fluentui/pull/30359) by beachball)
+- Bump @fluentui/react-tabster to v9.17.4 ([PR #30359](https://github.com/microsoft/fluentui/pull/30359) by beachball)
+- Bump @fluentui/react-utilities to v9.17.0 ([PR #30359](https://github.com/microsoft/fluentui/pull/30359) by beachball)
+
+## [0.1.5](https://github.com/microsoft/fluentui/tree/@fluentui/react-rating-preview_v0.1.5)
+
+Thu, 18 Jan 2024 14:25:03 GMT
+[Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-rating-preview_v0.1.4..@fluentui/react-rating-preview_v0.1.5)
+
+### Patches
+
+- Bump @fluentui/react-jsx-runtime to v9.0.27 ([PR #30046](https://github.com/microsoft/fluentui/pull/30046) by beachball)
+- Bump @fluentui/react-tabster to v9.17.3 ([PR #30046](https://github.com/microsoft/fluentui/pull/30046) by beachball)
+- Bump @fluentui/react-utilities to v9.16.1 ([PR #30046](https://github.com/microsoft/fluentui/pull/30046) by beachball)
+
+## [0.1.4](https://github.com/microsoft/fluentui/tree/@fluentui/react-rating-preview_v0.1.4)
+
+Wed, 17 Jan 2024 16:18:50 GMT
+[Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-rating-preview_v0.1.3..@fluentui/react-rating-preview_v0.1.4)
+
+### Patches
+
+- Bump @fluentui/react-jsx-runtime to v9.0.26 ([PR #30339](https://github.com/microsoft/fluentui/pull/30339) by beachball)
+- Bump @fluentui/react-tabster to v9.17.2 ([PR #30339](https://github.com/microsoft/fluentui/pull/30339) by beachball)
+- Bump @fluentui/react-utilities to v9.16.0 ([PR #30339](https://github.com/microsoft/fluentui/pull/30339) by beachball)
+
+## [0.1.3](https://github.com/microsoft/fluentui/tree/@fluentui/react-rating-preview_v0.1.3)
+
+Tue, 16 Jan 2024 13:14:23 GMT
+[Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-rating-preview_v0.1.2..@fluentui/react-rating-preview_v0.1.3)
+
+### Patches
+
+- Scaffold RatingDisplay ([PR #30283](https://github.com/microsoft/fluentui/pull/30283) by ololubek@microsoft.com)
+- Bump @fluentui/react-jsx-runtime to v9.0.25 ([PR #30299](https://github.com/microsoft/fluentui/pull/30299) by beachball)
+- Bump @fluentui/react-tabster to v9.17.1 ([PR #30299](https://github.com/microsoft/fluentui/pull/30299) by beachball)
+
+## [0.1.2](https://github.com/microsoft/fluentui/tree/@fluentui/react-rating-preview_v0.1.2)
+
+Thu, 11 Jan 2024 09:04:29 GMT
+[Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-rating-preview_v0.1.1..@fluentui/react-rating-preview_v0.1.2)
+
+### Patches
+
+- chore: Updating doc stories and API. ([PR #30092](https://github.com/microsoft/fluentui/pull/30092) by ololubek@microsoft.com)
+
+## [0.1.1](https://github.com/microsoft/fluentui/tree/@fluentui/react-rating-preview_v0.1.1)
+
+Mon, 08 Jan 2024 16:24:24 GMT
+[Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-rating-preview_v0.1.0..@fluentui/react-rating-preview_v0.1.1)
+
+### Patches
+
+- Bump @fluentui/react-jsx-runtime to v9.0.24 ([PR #30179](https://github.com/microsoft/fluentui/pull/30179) by beachball)
+- Bump @fluentui/react-tabster to v9.17.0 ([PR #30179](https://github.com/microsoft/fluentui/pull/30179) by beachball)
+- Bump @fluentui/react-utilities to v9.15.6 ([PR #30179](https://github.com/microsoft/fluentui/pull/30179) by beachball)
+
+## [0.1.0](https://github.com/microsoft/fluentui/tree/@fluentui/react-rating-preview_v0.1.0)
+
+Wed, 03 Jan 2024 09:26:43 GMT
+
+### Minor changes
+
+- 'feat: release rating to preview ([PR #30153](https://github.com/microsoft/fluentui/pull/30153) by ololubek@microsoft.com)
+- Bump @fluentui/react-jsx-runtime to v9.0.23 ([PR #30163](https://github.com/microsoft/fluentui/pull/30163) by beachball)
+- Bump @fluentui/react-tabster to v9.16.1 ([PR #30163](https://github.com/microsoft/fluentui/pull/30163) by beachball)
+- Bump @fluentui/react-utilities to v9.15.5 ([PR #30163](https://github.com/microsoft/fluentui/pull/30163) by beachball)

package/LICENSE

@@ -0,0 +1,15 @@
+@fluentui/react-rating-preview
+
+Copyright (c) Microsoft Corporation
+
+All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ""Software""), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED _AS IS_, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+Note: Usage of the fonts and icons referenced in Fluent UI React is subject to the terms listed at https://aka.ms/fluentui-assets-license

package/README.md

@@ -0,0 +1,38 @@
+# @fluentui/react-rating
+
+**React Rating components for [Fluent UI React](https://react.fluentui.dev)**
+
+A `Rating` component allows users to provide a rating for a particular item.
+
+This component displays a set of stars or other symbols that represent the rating value. Users can interact with the component to select a rating by clicking on the stars or using touch gestures.
+
+### Usage
+
+Import `Rating` or `RatingDisplay`:
+
+```js
+// From @fluentui/react-components
+import { Rating, RatingDisplay } from '@fluentui/react-components';
+
+// Directly from @fluentui/react-rating
+import { Rating, RatingDisplay } from '@fluentui/react-rating';
+```
+
+#### Examples
+
+```jsx
+<Rating />
+
+<RatingDisplay />
+```
+
+See [Fluent UI Storybook](https://react.fluentui.dev/) for more detailed usage examples.
+
+Alternatively, run Storybook locally with:
+
+1. `yarn start`
+2. Select `react-rating` from the list.
+
+### Specification
+
+See [Spec.md](./docs/Spec.md).

package/dist/index.d.ts

@@ -0,0 +1,291 @@
+/// <reference types="react" />
+
+import type { ComponentProps } from '@fluentui/react-utilities';
+import type { ComponentState } from '@fluentui/react-utilities';
+import type { EventData } from '@fluentui/react-utilities';
+import type { EventHandler } from '@fluentui/react-utilities';
+import type { ForwardRefComponent } from '@fluentui/react-utilities';
+import * as React_2 from 'react';
+import type { Slot } from '@fluentui/react-utilities';
+import type { SlotClassNames } from '@fluentui/react-utilities';
+
+/**
+ * Rating is a wrapper for one or more rating items that will be used to set a rating value.
+ */
+export declare const Rating: ForwardRefComponent<RatingProps>;
+
+export declare const ratingClassNames: SlotClassNames<RatingSlots>;
+
+export declare type RatingContextValues = {
+    ratingItem: RatingItemContextValue;
+};
+
+/**
+ * RatingDisplay is a wrapper for one or more rating items that will be used to display a rating value
+ * as well as the label for the rating.
+ */
+export declare const RatingDisplay: ForwardRefComponent<RatingDisplayProps>;
+
+export declare const ratingDisplayClassNames: SlotClassNames<RatingDisplaySlots>;
+
+export declare type RatingDisplayContextValues = {
+    ratingItem: RatingItemContextValue;
+};
+
+/**
+ * RatingDisplay Props
+ */
+export declare type RatingDisplayProps = ComponentProps<RatingDisplaySlots> & {
+    /**
+     * Color of the rating items (stars).
+     * @default neutral
+     */
+    color?: 'brand' | 'marigold' | 'neutral';
+    /**
+     * Renders a single filled star, with the value written next to it.
+     * @default false
+     */
+    compact?: boolean;
+    /**
+     * The number of ratings represented by the rating value.
+     * This will be formatted with a thousands separator (if applicable) and displayed next to the value.
+     */
+    count?: number;
+    /**
+     * The icon used for rating items.
+     * @default StarFilled
+     */
+    icon?: React_2.ElementType;
+    /**
+     * The max value of the rating. This controls the number of rating items displayed.
+     * Must be a whole number greater than 1.
+     * @default 5
+     */
+    max?: number;
+    /**
+     * Sets the size of the RatingDisplay items.
+     * @default medium
+     */
+    size?: 'small' | 'medium' | 'large' | 'extra-large';
+    /**
+     * The value of the rating
+     */
+    value?: number;
+};
+
+export declare type RatingDisplaySlots = {
+    root: NonNullable<Slot<'div'>>;
+    valueText?: Slot<'span'>;
+    countText?: Slot<'span'>;
+};
+
+/**
+ * State used in rendering RatingDisplay
+ */
+export declare type RatingDisplayState = ComponentState<RatingDisplaySlots> & Required<Pick<RatingDisplayProps, 'color' | 'compact' | 'icon' | 'max' | 'size'>> & Pick<RatingDisplayProps, 'value'>;
+
+/**
+ * RatingItem is an item that will be used to set or display a rating value.
+ */
+export declare const RatingItem: ForwardRefComponent<RatingItemProps>;
+
+export declare const ratingItemClassNames: SlotClassNames<RatingItemSlots>;
+
+declare type RatingItemContextValue = Partial<Pick<RatingState, 'name' | 'hoveredValue' | 'value'>> & Pick<RatingState, 'color' | 'iconFilled' | 'iconOutline' | 'itemLabel' | 'step' | 'size'> & Partial<Pick<RatingDisplayState, 'compact'>> & {
+    interactive?: boolean;
+};
+
+/**
+ * RatingItem Props
+ */
+export declare type RatingItemProps = ComponentProps<Partial<RatingItemSlots>> & {
+    /**
+     * The positive whole number value that is displayed by this RatingItem
+     */
+    value?: number;
+};
+
+export declare const RatingItemProvider: React_2.Provider<RatingItemContextValue | undefined>;
+
+export declare type RatingItemSlots = {
+    /**
+     * The root slot of the RatingItem.
+     * Default html element is span
+     */
+    root: NonNullable<Slot<'span'>>;
+    /**
+     * Icon displayed when the rating value is greater than or equal to the item's value.
+     */
+    selectedIcon?: NonNullable<Slot<'div'>>;
+    /**
+     * Icon displayed when the rating value is less than the item's value.
+     */
+    unselectedIcon?: NonNullable<Slot<'div'>>;
+    /**
+     * Radio input slot used for half star precision
+     */
+    halfValueInput?: NonNullable<Slot<'input'>>;
+    /**
+     * Radio input slot used for full star precision
+     */
+    fullValueInput?: NonNullable<Slot<'input'>>;
+};
+
+/**
+ * State used in rendering RatingItem
+ */
+export declare type RatingItemState = ComponentState<RatingItemSlots> & Required<Pick<RatingItemProps, 'value'>> & Pick<RatingState, 'color' | 'step' | 'size'> & {
+    iconFillWidth: number;
+    appearance: 'outline' | 'filled';
+};
+
+/**
+ * Data for the onChange event for Rating.
+ */
+export declare type RatingOnChangeEventData = EventData<'change', React_2.FormEvent<HTMLDivElement>> & {
+    /**
+     * The new value of the rating.
+     */
+    value: number;
+};
+
+/**
+ * Rating Props
+ */
+export declare type RatingProps = Omit<ComponentProps<Partial<RatingSlots>>, 'onChange'> & {
+    /**
+     * Controls the color of the Rating.
+     * @default neutral
+     */
+    color?: 'brand' | 'marigold' | 'neutral';
+    /**
+     * Default value of the Rating
+     */
+    defaultValue?: number;
+    /**
+     * The icon to display when the rating value is greater than or equal to the item's value.
+     */
+    iconFilled?: React_2.ElementType;
+    /**
+     * The icon to display when the rating value is less than the item's value.
+     */
+    iconOutline?: React_2.ElementType;
+    /**
+     * Prop to generate the aria-label for the rating inputs.
+     * @default (rating) =\> `${rating}`
+     */
+    itemLabel?: (rating: number) => string;
+    /**
+     * The max value of the rating. This controls the number of rating items displayed.
+     * Must be a whole number greater than 1.
+     * @default 5
+     */
+    max?: number;
+    /**
+     * Name for the Radio inputs. If not provided, one will be automatically generated
+     */
+    name?: string;
+    /**
+     * Callback when the rating value is changed by the user.
+     */
+    onChange?: EventHandler<RatingOnChangeEventData>;
+    /**
+     * Sets the precision to allow half-filled shapes in Rating
+     * @default 1
+     */
+    step?: 0.5 | 1;
+    /**
+     * Sets the size of the Rating items.
+     * @default extra-large
+     */
+    size?: 'small' | 'medium' | 'large' | 'extra-large';
+    /**
+     * The value of the rating
+     */
+    value?: number;
+};
+
+export declare type RatingSlots = {
+    root: NonNullable<Slot<'div'>>;
+};
+
+/**
+ * State used in rendering Rating
+ */
+export declare type RatingState = ComponentState<RatingSlots> & Required<Pick<RatingProps, 'color' | 'iconFilled' | 'iconOutline' | 'name' | 'step' | 'size' | 'value'>> & Pick<RatingProps, 'itemLabel'> & {
+    hoveredValue?: number | undefined;
+};
+
+/**
+ * Render the final JSX of Rating
+ */
+export declare const renderRating_unstable: (state: RatingState, contextValues: RatingContextValues) => JSX.Element;
+
+/**
+ * Render the final JSX of RatingDisplay
+ */
+export declare const renderRatingDisplay_unstable: (state: RatingDisplayState, contextValues: RatingDisplayContextValues) => JSX.Element;
+
+/**
+ * Render the final JSX of RatingItem
+ */
+export declare const renderRatingItem_unstable: (state: RatingItemState) => JSX.Element;
+
+/**
+ * Create the state required to render Rating.
+ *
+ * The returned state can be modified with hooks such as useRatingStyles_unstable,
+ * before being passed to renderRating_unstable.
+ *
+ * @param props - props from this instance of Rating
+ * @param ref - reference to root HTMLElement of Rating
+ */
+export declare const useRating_unstable: (props: RatingProps, ref: React_2.Ref<HTMLDivElement>) => RatingState;
+
+export declare const useRatingContextValues: (ratingState: RatingState) => RatingContextValues;
+
+/**
+ * Create the state required to render RatingDisplay.
+ *
+ * The returned state can be modified with hooks such as useRatingDisplayStyles_unstable,
+ * before being passed to renderRatingDisplay_unstable.
+ *
+ * @param props - props from this instance of RatingDisplay
+ * @param ref - reference to root HTMLDivElement of RatingDisplay
+ */
+export declare const useRatingDisplay_unstable: (props: RatingDisplayProps, ref: React_2.Ref<HTMLDivElement>) => RatingDisplayState;
+
+export declare const useRatingDisplayContextValues: (state: RatingDisplayState) => RatingDisplayContextValues;
+
+/**
+ * Apply styling to the RatingDisplay slots based on the state
+ */
+export declare const useRatingDisplayStyles_unstable: (state: RatingDisplayState) => RatingDisplayState;
+
+/**
+ * Create the state required to render RatingItem.
+ *
+ * The returned state can be modified with hooks such as useRatingItemStyles_unstable,
+ * before being passed to renderRatingItem_unstable.
+ *
+ * @param props - props from this instance of RatingItem
+ * @param ref - reference to root HTMLElement of RatingItem
+ */
+export declare const useRatingItem_unstable: (props: RatingItemProps, ref: React_2.Ref<HTMLSpanElement>) => RatingItemState;
+
+/**
+ * Get the value of the RatingContext.
+ */
+export declare const useRatingItemContextValue_unstable: () => RatingItemContextValue;
+
+/**
+ * Apply styling to the RatingItem slots based on the state
+ */
+export declare const useRatingItemStyles_unstable: (state: RatingItemState) => RatingItemState;
+
+/**
+ * Apply styling to the Rating slots based on the state
+ */
+export declare const useRatingStyles_unstable: (state: RatingState) => RatingState;
+
+export { }

package/lib/Rating.js

@@ -0,0 +1 @@
+export * from './components/Rating/index';

package/lib/Rating.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["Rating.ts"],"sourcesContent":["export * from './components/Rating/index';\n"],"names":[],"mappings":"AAAA,cAAc,4BAA4B"}

package/lib/RatingDisplay.js

@@ -0,0 +1 @@
+export * from './components/RatingDisplay/index';

package/lib/RatingDisplay.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["RatingDisplay.ts"],"sourcesContent":["export * from './components/RatingDisplay/index';\n"],"names":[],"mappings":"AAAA,cAAc,mCAAmC"}

package/lib/RatingItem.js

@@ -0,0 +1 @@
+export * from './components/RatingItem/index';

package/lib/RatingItem.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["RatingItem.ts"],"sourcesContent":["export * from './components/RatingItem/index';\n"],"names":[],"mappings":"AAAA,cAAc,gCAAgC"}

package/lib/components/Rating/Rating.js

@@ -0,0 +1,14 @@
+import * as React from 'react';
+import { useRating_unstable } from './useRating';
+import { renderRating_unstable } from './renderRating';
+import { useRatingStyles_unstable } from './useRatingStyles.styles';
+import { useRatingContextValues } from './useRatingContextValues';
+/**
+ * Rating is a wrapper for one or more rating items that will be used to set a rating value.
+ */ export const Rating = /*#__PURE__*/ React.forwardRef((props, ref)=>{
+    const state = useRating_unstable(props, ref);
+    const contextValues = useRatingContextValues(state);
+    useRatingStyles_unstable(state);
+    return renderRating_unstable(state, contextValues);
+});
+Rating.displayName = 'Rating';

package/lib/components/Rating/Rating.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["Rating.tsx"],"sourcesContent":["import * as React from 'react';\nimport type { ForwardRefComponent } from '@fluentui/react-utilities';\nimport { useRating_unstable } from './useRating';\nimport { renderRating_unstable } from './renderRating';\nimport { useRatingStyles_unstable } from './useRatingStyles.styles';\nimport type { RatingProps } from './Rating.types';\nimport { useRatingContextValues } from './useRatingContextValues';\n\n/**\n * Rating is a wrapper for one or more rating items that will be used to set a rating value.\n */\nexport const Rating: ForwardRefComponent<RatingProps> = React.forwardRef((props, ref) => {\n  const state = useRating_unstable(props, ref);\n  const contextValues = useRatingContextValues(state);\n\n  useRatingStyles_unstable(state);\n  return renderRating_unstable(state, contextValues);\n});\n\nRating.displayName = 'Rating';\n"],"names":["React","useRating_unstable","renderRating_unstable","useRatingStyles_unstable","useRatingContextValues","Rating","forwardRef","props","ref","state","contextValues","displayName"],"mappings":"AAAA,YAAYA,WAAW,QAAQ;AAE/B,SAASC,kBAAkB,QAAQ,cAAc;AACjD,SAASC,qBAAqB,QAAQ,iBAAiB;AACvD,SAASC,wBAAwB,QAAQ,2BAA2B;AAEpE,SAASC,sBAAsB,QAAQ,2BAA2B;AAElE;;CAEC,GACD,OAAO,MAAMC,uBAA2CL,MAAMM,UAAU,CAAC,CAACC,OAAOC;IAC/E,MAAMC,QAAQR,mBAAmBM,OAAOC;IACxC,MAAME,gBAAgBN,uBAAuBK;IAE7CN,yBAAyBM;IACzB,OAAOP,sBAAsBO,OAAOC;AACtC,GAAG;AAEHL,OAAOM,WAAW,GAAG"}

package/lib/components/Rating/Rating.types.js

@@ -0,0 +1 @@
+import * as React from 'react';

package/lib/components/Rating/Rating.types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["Rating.types.ts"],"sourcesContent":["import * as React from 'react';\nimport type { ComponentProps, ComponentState, EventData, EventHandler, Slot } from '@fluentui/react-utilities';\nimport { RatingItemContextValue } from '../RatingItem/RatingItem.types';\n\nexport type RatingSlots = {\n  root: NonNullable<Slot<'div'>>;\n};\n\n/**\n * Rating Props\n */\nexport type RatingProps = Omit<ComponentProps<Partial<RatingSlots>>, 'onChange'> & {\n  /**\n   * Controls the color of the Rating.\n   * @default neutral\n   */\n  color?: 'brand' | 'marigold' | 'neutral';\n  /**\n   * Default value of the Rating\n   */\n  defaultValue?: number;\n  /**\n   * The icon to display when the rating value is greater than or equal to the item's value.\n   */\n  iconFilled?: React.ElementType;\n  /**\n   * The icon to display when the rating value is less than the item's value.\n   */\n  iconOutline?: React.ElementType;\n  /**\n   * Prop to generate the aria-label for the rating inputs.\n   * @default (rating) =\\> `${rating}`\n   */\n  itemLabel?: (rating: number) => string;\n  /**\n   * The max value of the rating. This controls the number of rating items displayed.\n   * Must be a whole number greater than 1.\n   * @default 5\n   */\n  max?: number;\n  /**\n   * Name for the Radio inputs. If not provided, one will be automatically generated\n   */\n  name?: string;\n  /**\n   * Callback when the rating value is changed by the user.\n   */\n  onChange?: EventHandler<RatingOnChangeEventData>;\n  /**\n   * Sets the precision to allow half-filled shapes in Rating\n   * @default 1\n   */\n  step?: 0.5 | 1;\n  /**\n   * Sets the size of the Rating items.\n   * @default extra-large\n   */\n  size?: 'small' | 'medium' | 'large' | 'extra-large';\n  /**\n   * The value of the rating\n   */\n  value?: number;\n};\n\n/**\n * Data for the onChange event for Rating.\n */\nexport type RatingOnChangeEventData = EventData<'change', React.FormEvent<HTMLDivElement>> & {\n  /**\n   * The new value of the rating.\n   */\n  value: number;\n};\n\n/**\n * State used in rendering Rating\n */\nexport type RatingState = ComponentState<RatingSlots> &\n  Required<Pick<RatingProps, 'color' | 'iconFilled' | 'iconOutline' | 'name' | 'step' | 'size' | 'value'>> &\n  Pick<RatingProps, 'itemLabel'> & {\n    hoveredValue?: number | undefined;\n  };\n\nexport type RatingContextValues = {\n  ratingItem: RatingItemContextValue;\n};\n"],"names":["React"],"mappings":"AAAA,YAAYA,WAAW,QAAQ"}

package/lib/components/Rating/index.js

@@ -0,0 +1,6 @@
+export * from './Rating';
+export * from './Rating.types';
+export * from './renderRating';
+export * from './useRating';
+export * from './useRatingStyles.styles';
+export * from './useRatingContextValues';

package/lib/components/Rating/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["index.ts"],"sourcesContent":["export * from './Rating';\nexport * from './Rating.types';\nexport * from './renderRating';\nexport * from './useRating';\nexport * from './useRatingStyles.styles';\nexport * from './useRatingContextValues';\n"],"names":[],"mappings":"AAAA,cAAc,WAAW;AACzB,cAAc,iBAAiB;AAC/B,cAAc,iBAAiB;AAC/B,cAAc,cAAc;AAC5B,cAAc,2BAA2B;AACzC,cAAc,2BAA2B"}

package/lib/components/Rating/renderRating.js

@@ -0,0 +1,12 @@
+  import { jsx as _jsx } from "@fluentui/react-jsx-runtime/jsx-runtime";
+import { assertSlots } from '@fluentui/react-utilities';
+import { RatingItemProvider } from '../../contexts/RatingItemContext';
+/**
+ * Render the final JSX of Rating
+ */ export const renderRating_unstable = (state, contextValues)=>{
+    assertSlots(state);
+    return /*#__PURE__*/ _jsx(RatingItemProvider, {
+        value: contextValues.ratingItem,
+        children: /*#__PURE__*/ _jsx(state.root, {})
+    });
+};

package/lib/components/Rating/renderRating.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["renderRating.tsx"],"sourcesContent":["/** @jsxRuntime automatic */\n/** @jsxImportSource @fluentui/react-jsx-runtime */\n\nimport { assertSlots } from '@fluentui/react-utilities';\nimport type { RatingState, RatingSlots, RatingContextValues } from './Rating.types';\nimport { RatingItemProvider } from '../../contexts/RatingItemContext';\n\n/**\n * Render the final JSX of Rating\n */\nexport const renderRating_unstable = (state: RatingState, contextValues: RatingContextValues) => {\n  assertSlots<RatingSlots>(state);\n\n  return (\n    <RatingItemProvider value={contextValues.ratingItem}>\n      <state.root />\n    </RatingItemProvider>\n  );\n};\n"],"names":["assertSlots","RatingItemProvider","renderRating_unstable","state","contextValues","value","ratingItem","root"],"mappings":"AAAA,0BAA0B,GAC1B,iDAAiD;AAEjD,SAASA,WAAW,QAAQ,4BAA4B;AAExD,SAASC,kBAAkB,QAAQ,mCAAmC;AAEtE;;CAEC,GACD,OAAO,MAAMC,wBAAwB,CAACC,OAAoBC;IACxDJ,YAAyBG;IAEzB,qBACE,KAACF;QAAmBI,OAAOD,cAAcE,UAAU;kBACjD,cAAA,KAACH,MAAMI,IAAI;;AAGjB,EAAE"}