Skip to content

refactor(reviews): refactor ReviewForm for more flexible rendering #2753

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.

Sign up for GitHub

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

Merged
matthewvolk merged 1 commit into from
Dec 9, 2025
Merged

refactor(reviews): refactor ReviewForm for more flexible rendering #2753

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/metal-chicken-share.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@bigcommerce/catalyst-core": minor
---

Refactor the `ReviewForm` to accept `trigger` prop instead of `formButtonLabel` for flexible rendering.
14 changes: 11 additions & 3 deletions core/vibes/soul/sections/reviews/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { Stream, Streamable } from '@/vibes/soul/lib/streamable';
import { Button } from '@/vibes/soul/primitives/button';
import { CursorPagination, CursorPaginationInfo } from '@/vibes/soul/primitives/cursor-pagination';
import { Rating } from '@/vibes/soul/primitives/rating';
import { StickySidebarLayout } from '@/vibes/soul/sections/sticky-sidebar-layout';
Expand Down Expand Up @@ -67,7 +68,6 @@ export function Reviews({
return (
<ReviewsEmptyState
action={action}
formButtonLabel={formButtonLabel}
formEmailLabel={formEmailLabel}
formModalTitle={formModalTitle}
formNameLabel={formNameLabel}
Expand Down Expand Up @@ -124,7 +124,6 @@ export function Reviews({
</Stream>
<ReviewForm
action={action}
formButtonLabel={formButtonLabel}
formEmailLabel={formEmailLabel}
formModalTitle={formModalTitle}
formNameLabel={formNameLabel}
Expand All @@ -136,6 +135,11 @@ export function Reviews({
streamableImages={streamableImages}
streamableProduct={streamableProduct}
streamableUser={streamableUser}
trigger={
<Button className="mx-auto mt-8" size="small" variant="tertiary">
{formButtonLabel}
</Button>
}
/>
</>
}
Expand Down Expand Up @@ -225,7 +229,6 @@ export function ReviewsEmptyState({
<p className="text-center">{message}</p>
<ReviewForm
action={action}
formButtonLabel={formButtonLabel}
formEmailLabel={formEmailLabel}
formModalTitle={formModalTitle}
formNameLabel={formNameLabel}
Expand All @@ -237,6 +240,11 @@ export function ReviewsEmptyState({
streamableImages={streamableImages}
streamableProduct={streamableProduct}
streamableUser={streamableUser}
trigger={
<Button className="mx-auto mt-8" size="small" variant="tertiary">
{formButtonLabel}
</Button>
}
/>
</div>
</StickySidebarLayout>
Expand Down
10 changes: 3 additions & 7 deletions core/vibes/soul/sections/reviews/review-form.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export type SubmitReviewAction = Action<
interface Props {
productId: number;
action: SubmitReviewAction;
formButtonLabel?: string;
trigger: React.ReactNode;
formModalTitle?: string;
formSubmitLabel?: string;
formRatingLabel?: string;
Expand All @@ -43,7 +43,7 @@ interface Props {
export const ReviewForm = ({
productId,
action,
formButtonLabel = 'Write a review',
trigger,
formModalTitle = 'Write a review',
formSubmitLabel = 'Submit',
formRatingLabel = 'Rating',
Expand Down Expand Up @@ -107,11 +107,7 @@ export const ReviewForm = ({
isOpen={isOpen}
setOpen={setIsOpen}
title={formModalTitle}
trigger={
<Button className="mx-auto mt-8" size="small" variant="tertiary">
{formButtonLabel}
</Button>
}
trigger={trigger}
>
<div className="flex flex-col gap-6 md:flex-row md:gap-8">
<div className="shrink-0 md:w-48">
Expand Down