@frontend-sdk/bigcommerce-reviews - v0.25.1

Interfaces

• Review
• SubmissionStatusFailure
• SubmissionStatusSuccess
• UseBigCommerceReviewsProps

Type aliases

ProductId

Ƭ ProductId: string

---

ReviewStatus

Ƭ ReviewStatus: "pending" | "approved" | "disapproved"

---

SiteId

Ƭ SiteId: string

---

SubmissionStatus

Ƭ SubmissionStatus: SubmissionStatusSuccess | SubmissionStatusFailure

Functions

useBigCommerceReviews

▸ Const useBigCommerceReviews(__namedParameters): BigCommerceReviews

Parameters

Returns

BigCommerceReviews

Interface: Review

Properties

email

• Optional Readonly email: string

---

name

• Optional Readonly name: string

---

rating

• Optional Readonly rating: ReviewRating

---

text

• Optional Readonly text: string

---

title

• Readonly title: string

Interface: SubmissionStatusFailure

Properties

tag

• Readonly tag: "SubmissionStatusFailure"

---

text

• Readonly text: string

Interface: SubmissionStatusSuccess

Properties

tag

• Readonly tag: "SubmissionStatusSuccess"

---

text

• Readonly text: ReviewStatus

Interface: UseBigCommerceReviewsProps

Properties

siteId

• Readonly siteId: string