About The Project

A simple react carousel

Getting Started

This is a simple carousel component to be used in react

Install the package

npm install react-teahouse

Prepare a list of items of the following type

export type Item = {
  id: number;
  title: string;
  subtitle?: string;
  intro: string;
  desc: string;
  src: string;
};

src could be either a path to an image in the /public folder (example: some_path/my_image.png) or a url to a transparent image

Try out your first component

import { Carousel } from "react-teahouse";
import { items } from "./resources/items.json";
export const App = () => {
return (
     <Carousel listItems={items}/>
 )

Roadmap

• [ ] Add Changelog
• [ ] Add text position options

Contributing

Feel free to open issues, add features or fix bugs. Any contributions you make are greatly appreciated. Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Samuel - https://linkedin.com/in/samwmd

Github Link: https://github.com/sam-wmd/react-teahouse

Acknowledgments

The OG creator 🐐: Lundev