wix-style-react
Version:
49 lines (48 loc) • 1.74 kB
JavaScript
export default {
description:
'A star rating bar allows the user to rate the quality of an item or an experience, such as a purchased product, completed service or received meal from a restaurant.',
do: [
'Use it to collect feedback about the quality an item or a service',
'Use it to display the rating of an item or a service',
],
dont: [
'Don’t use it to rate the experience with an item or service on an emotional level, use <FacesRatingBar/> instead',
],
featureExamples: [
{
title: 'Mode',
description: `Specify the mode of component:<br/>
 - \` interactive\` (default) - used to collect individual feedback<br/>
 - \`readOnly\` - used to display overall rating`,
example: '_mode',
},
{
title: 'Size',
description: `Control the size of a component:<br/>
 - \`large\` <br/>
 - \`medium\` <br/>
 - \`small\` <br/>
 - \`tiny\` <br/>
<br/>
Interactive mode, which requires input from the user, supports large size only.`,
example: '_size',
},
{
title: 'Captions',
description: `Give more context to the rating scale by providing value labels. Captions will be shown only if all 5 labels are defined.`,
example: '_captions',
},
],
commonUseCaseExamples: [
{
title: 'Collecting feedback',
description: `Use an interactive rating bar to collect feedback from your users.`,
example: '_collectingFeedback',
},
{
title: 'Displaying feedback',
description: `Use read-only mode to display individual or general ratings of an item or service.`,
example: '_displayingFeedback',
},
],
};