https://github.com/kayviaharriott/card-carousel-reactjs
A card carousel component for reactjs
https://github.com/kayviaharriott/card-carousel-reactjs
card carousel carousel-component mui reactjs typescript vite
Last synced: 2 months ago
JSON representation
A card carousel component for reactjs
- Host: GitHub
- URL: https://github.com/kayviaharriott/card-carousel-reactjs
- Owner: KayviaHarriott
- Created: 2024-07-22T18:22:57.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-07-23T10:22:48.000Z (10 months ago)
- Last Synced: 2025-01-20T00:47:24.203Z (4 months ago)
- Topics: card, carousel, carousel-component, mui, reactjs, typescript, vite
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/card-carousel-reactjs
- Size: 69.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Card Carousel
Create a card carousel using this component by giving it a list of ReactNode items.
## Installation
```
npm install card-carousel-reactjs
```
## Usage
To use the CardCarousel component, import it into your project and pass an array of ReactNode items to it.
```js
import CardCarousel from 'card-carousel-reactjs';
// Use the CardCarousel component
Card One,
Card Two,
Card Three,
Card Four,
Card Five,
]}
/>
```
## Props
The CardCarousel component accepts the following props:
- items (required): An array of ReactNode items to be displayed in the carousel.
- width (optional): The width of each card. Default is 350px.
- height (optional): The height of each card. Default is 150px.
## Example
To customize the width and height of the carousel items:
```js
Card One,
Card Two,
Card Three,
]}
width={400}
height={200}
/>
```
## Contributing
Contributions will be welcomed soon... once issues are created!