Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add rating field #2636

Merged
merged 11 commits into from
Feb 13, 2025
2 changes: 2 additions & 0 deletions packages/components/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,8 @@ export { default as RadioGroup, RadioOption } from './molecules/RadioGroup'
export type { RadioGroupProps, RadioOptionProps } from './molecules/RadioGroup'
export { default as Rating } from './molecules/Rating'
export type { RatingProps } from './molecules/Rating'
export { default as RatingField } from './molecules/RatingField'
export type { RatingFieldProps } from './molecules/RatingField'
export { default as RegionBar } from './molecules/RegionBar'
export type { RegionBarProps } from './molecules/RegionBar'

Expand Down
71 changes: 71 additions & 0 deletions packages/components/src/molecules/RatingField/RatingField.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
import React from 'react'
import type { MutableRefObject } from 'react'
import { Label, Rating, type RatingProps } from '../..'

interface DefaultProps {
/**
* ID to find this component in testing tools (e.g.: cypress, testing library, and jest).
*/
testId?: string
/**
* ID to identify input and corresponding label.
*/
id: string
/**
* The text displayed to identify the input rating.
*/
label: string
/**
* The error message displayed when an error occurs.
*/
error?: string
/**
* Component's ref.
*/
ratingRef?: MutableRefObject<HTMLUListElement | null>
}

export type RatingFieldProps = DefaultProps & RatingProps

const RatingField = ({
id,
label,
error,
disabled,
length = 5,
value = 0,
onChange,
ratingRef,
testId = 'fs-rating-field',
...otherProps
}: RatingFieldProps) => {
const shouldDisplayError = !disabled && error && error !== ''

return (
<div
data-fs-rating-field
data-fs-rating-field-error={shouldDisplayError}
data-fs-rating-field-disabled={disabled}
data-testid={testId}
>
<Label data-fs-rating-field-label htmlFor={id}>
{label}
</Label>
<Rating
id={id}
data-fs-rating-field-input
ref={ratingRef}
length={length}
value={value}
onChange={onChange}
disabled={disabled}
{...otherProps}
/>
{shouldDisplayError && (
<span data-fs-rating-field-error-message>{error}</span>
)}
</div>
)
}

export default RatingField
2 changes: 2 additions & 0 deletions packages/components/src/molecules/RatingField/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export { default } from './RatingField'
export type { RatingFieldProps } from './RatingField'
5 changes: 5 additions & 0 deletions packages/ui/src/components/molecules/Rating/styles.scss
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,12 @@
--fs-rating-actionable-icon-height : var(--fs-rating-actionable-icon-width);
--fs-rating-actionable-icon-color : var(--fs-rating-color-empty);
--fs-rating-actionable-icon-color-selected : var(--fs-rating-color);
--fs-rating-button-min-height : var(--fs-spacing-5);

// --------------------------------------------------------
// Structural Styles
// --------------------------------------------------------

display: flex;

[data-fs-icon] {
Expand All @@ -31,6 +33,8 @@
}

[data-fs-rating-button] {
--fs-button-small-min-height: var(--fs-rating-button-min-height);

color: unset;

&[disabled] [data-fs-button-wrapper] {
Expand Down Expand Up @@ -92,6 +96,7 @@
[data-fs-icon] {
width: var(--fs-rating-actionable-icon-width);
height: var(--fs-rating-actionable-icon-height);
color: var(--fs-rating-actionable-color);
color: var(--fs-rating-actionable-icon-color);
}
}
Expand Down
44 changes: 44 additions & 0 deletions packages/ui/src/components/molecules/RatingField/styles.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
[data-fs-rating-field] {
// --------------------------------------------------------
// Design Tokens for Rating Field
// --------------------------------------------------------

// Label
--fs-rating-field-label-color : var(--fs-color-text-light);
--fs-rating-field-label-size : var(--fs-text-size-2);
--fs-rating-field-label-line-height : var(--fs-text-size-4);

// Error
--fs-rating-field-error-message-size : var(--fs-text-size-legend);
--fs-rating-field-error-message-line-height : 1.1;
--fs-rating-field-error-message-color : var(--fs-color-danger-text);

// --------------------------------------------------------
// Structural Styles
// --------------------------------------------------------
display: flex;
flex-direction: column;

[data-fs-rating-field-label] {
margin-bottom: var(--fs-spacing-0);
font-size: var(--fs-rating-field-label-size);
line-height: var(--fs-rating-field-label-line-height);
color: var(--fs-rating-field-label-color);
}

[data-fs-rating-field-error-message] {
margin-top: var(--fs-spacing-0);
font-size: var(--fs-rating-field-error-message-size);
line-height: var(--fs-rating-field-error-message-line-height);
color: var(--fs-rating-field-error-message-color);
}

// --------------------------------------------------------
// Variants Styles
// --------------------------------------------------------
&[data-fs-rating-field-error="true"] {
[data-fs-rating-item="empty"] [data-fs-icon] {
color: var(--fs-rating-field-error-message-color);
}
}
}
1 change: 1 addition & 0 deletions packages/ui/src/styles/components.scss
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
@import "../components/molecules/QuantitySelector/styles";
@import "../components/molecules/RadioField/styles";
@import "../components/molecules/Rating/styles";
@import "../components/molecules/RatingField/styles";
@import "../components/molecules/RegionBar/styles";
@import "../components/molecules/SearchAutoComplete/styles";
@import "../components/molecules/SearchDropdown/styles";
Expand Down
Loading