@bolttech/molecules-carousel NPM

Carousel Component

The Carousel component is a React component that displays a carousel of testimonial cards with swipe navigation and indicators. It's designed to showcase testimonial data in an interactive and visually appealing manner.

Installation

To use the Carousel component, you need to install the required dependencies:

npm install @bolttech/frontend-foundations @bolttech/molecules-carousel

yarn add @bolttech/frontend-foundations @bolttech/molecules-carousel

Usage

You can utilize the Carousel component by importing it and providing an array of testimonial data. Here's an example:

import React from 'react';
import {Carousel} from '@bolttech/molecules-carousel';
import {bolttechTheme, BolttechThemeProvider} from "@bolttech/frontend-foundations"; // Adjust the path to your component

const testimonialData = [
  {
    id: 'testimonial1',
    title: 'Great Experience',
    description: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',
    image: <img src="avatar1.jpg" alt="User Avatar"/>,
    userName: 'John Doe',
    userLocation: 'New York, USA',
  },
  // ... more testimonial data objects
];

function App() {
  return (
    <BolttechThemeProvider theme={bolttechTheme}>
      <Carousel data={testimonialData}/>
    </BolttechThemeProvider>
  );
}

export default App;

Props

The Carousel component accepts the following props:

Prop	Type	Description
`data`	`array`	An array of testimonial data objects to be displayed in the carousel.
`dataTestId`	`string`	The data-testid attribute for testing purposes.

Each testimonial data object should have the following properties:

Property	Type	Description
`id`	`string`	A unique identifier for the testimonial card.
`title`	`string`	The title text that will be displayed as the header of the testimonial card.
`description`	`string`	The description text that will be displayed below the title.
`image`	`ReactElement`	An HTML image component to be displayed at the bottom of the testimonial card.
`userName`	`string`	The name of the user who provided the testimonial.
`userLocation`	`string`	The location of the user who provided the testimonial.

Functionality

The Carousel component offers the following functionality:

Swipe Navigation: Navigate left or right by swiping.
Navigation Buttons: Left and right navigation buttons for manual navigation.
Indicators: Indicators at the bottom to show the currently active testimonial card.

Contribution

Contributions to the Carousel component are welcomed. If you encounter issues or have suggestions for improvements, feel free to open an issue or submit a pull request on the component's Bitbucket repository.