@bolttech/atoms-testimonial-card

Testimonial Card Component

The TestimonialCard component is a versatile React component designed to display user testimonials or reviews with customizable content.

Table of Contents

• Installation
• Usage
• Props
• Example
• Contributing

Installation

To use the TestimonialCard component in your React application, follow these steps:

Installation

npm install @bolttech/frontend-foundations @bolttech/atoms-testimonial-card

or

yarn add @bolttech/frontend-foundations @bolttech/atoms-testimonial-card

Once you have the required dependencies installed, you can start using the TestimonialCard component in your React application.

Usage

The TestimonialCard component provides a flexible and customizable way to display user testimonials or reviews with various content elements.

To use the component, import it and include it in your JSX:

import React from 'react';
import {TestimonialCard} from '@bolttech/atoms-testimonial-card';
import {bolttechTheme, BolttechThemeProvider} from "@bolttech/frontend-foundations"; // You can import your TestimonialCard component here

function App() {
  return (
    <BolttechThemeProvider theme={bolttechTheme}>
      <TestimonialCard
        title="Great Product"
        description="I am amazed by the quality and features of this product. Highly recommended!"
        userName="John Doe"
        userLocation="New York, USA"
        dataTestId="testimonial-card"
      />
    </BolttechThemeProvider>
  );
}

export default App;

Props

The TestimonialCard component accepts the following props:

Prop	Type	Description
title	string	The title of the testimonial.
description	string	The main content of the testimonial.
image	ReactNode	An optional image or avatar associated with the testimonial.
userName	string	The name of the user providing the testimonial.
userLocation	string	The location of the user providing the testimonial.
id	string	The id attribute for the testimonial card container.
dataTestId	string	The data-testid attribute for testing purposes.

Example

Here's an example of using the TestimonialCard component:

<TestimonialCard
  title="Great Product"
  description="I am amazed by the quality and features of this product. Highly recommended!"
  userName="John Doe"
  userLocation="New York, USA"
  dataTestId="testimonial-card"
/>

This will render a testimonial card with the provided title, description, user information, and optional image or avatar.

Contributing

Contributions to the TestimonialCard component are welcome. If you find any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request on the project's Bitbucket repository.