You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
38 lines
1.2 KiB
38 lines
1.2 KiB
# React Carousel |
|
|
|
![Release](https://github.com/trendyol/react-carousel/actions/workflows/publish.yml/badge.svg) |
|
![Pre-Release](https://github.com/trendyol/react-carousel/actions/workflows/betapublish.yml/badge.svg) |
|
[![codecov.io](https://codecov.io/github/Trendyol/react-carousel/coverage.svg?branch=master)](https://codecov.io/github/Trendyol/react-carousel?branch=master) |
|
[![badgen.net](https://badgen.net/bundlephobia/minzip/@trendyol-js/react-carousel)](https://badgen.net/bundlephobia/minzip/@trendyol-js/react-carousel) |
|
[![npm version](https://badge.fury.io/js/%40trendyol-js%2Freact-carousel.svg)](https://badge.fury.io/js/%40trendyol-js%2Freact-carousel) |
|
|
|
Please visit to [docs website](https://trendyol.github.io/react-carousel/docs/installation) for more details. |
|
|
|
# Installation |
|
|
|
``` |
|
npm i react react-dom @trendyol-js/react-carousel --save |
|
``` |
|
|
|
# Usage |
|
|
|
```jsx |
|
import React from 'react'; |
|
import ReactDOM from 'react-dom'; |
|
import { Carousel } from '@trendyol-js/react-carousel'; |
|
import { Item } from './yourItem'; |
|
|
|
ReactDOM.render( |
|
<Carousel> |
|
<Item /> |
|
<Item /> |
|
<Item /> |
|
<Item /> |
|
</Carousel>, |
|
document.getElementById('root'), |
|
); |
|
``` |
|
|
|
# License |
|
|
|
Distributed under the MIT License. See `LICENSE` for more information.
|
|
|