About The Project

A simple image carousel element built in TS

Built With

Getting Started

Simple plug and play, install the package and use it according to the usage guide.

  npm i @silentstrom2k/image-carousel

Prerequisites

You must have node installed, otherwise wth you doing here? Might as well update npm while you're at it.

• npm

  npm install npm@latest -g

Usage

• Create your Image Carousel object by

  const carousel = imageCarousel();

• You can images by:

  import valid_path from 'path/to/your_image.jpg';
  carousel.addImage(valid_path);

• And you can generate the div element which you can insert into your webpage

  const carouselDiv = carousel.getElement(); // returns a div of the menubar
  
  const body = document.querySelector('body');
  body?.appendChild(carouselDiv);

Roadmap

Ability to resize the image carousel

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! 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

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Reach out by raising an issue

Project Link: https://github.com/silentstorm2k/image-carousel

Acknowledgments

• png image from pngtree.com/
• Picture icons created by Pixel perfect - Flaticon