# rh-carousel

**Repository Path**: wzyrh/rh-carousel

## Basic Information

- **Project Name**: rh-carousel
- **Description**: vue3轮播图,vue3多张轮播图,多张图片一起轮播, carousel
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-06-29
- **Last Updated**: 2023-06-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Vue 3 + TypeScript + Vite

### vue3 的轮播图

支持 1 张，2 张，多张一起轮播
![alt 实例](./dome.png)

#### npm 安装

> npm install rh-carousel

#### pnpm 安装

> pnpm install rh-carousel

#### yarn 安装

> yarn add rh-carousel

```js
/** main.js */
import "rh-carousel/lib/style.css"; // main.js 引入样式
import { createApp } from "vue";
// 全局注册
import Carousel from "rh-carousel";
createApp(App).use(Carousel);
// -----
//局部引入
import { RCascader, RCarouselItem } from "rh-carousel";
```

```js
// 组件内使用
<RCascader :viewNum="3" width="1200px">
    <RCarouselItem>
      <div style="padding: 20px; height: 100%;">
        <div class="bg1">111</div>
      </div>
    </RCarouselItem>
    <RCarouselItem>
      <div style="padding: 20px; height: 100%;">
        <div class="bg2">2222</div>
      </div>
    </RCarouselItem>
    <RCarouselItem>
      <div style="padding: 20px; height: 100%;">
        <div class="bg3">3333</div>
      </div>
    </RCarouselItem>
    <RCarouselItem>
      <div style="padding: 20px; height: 100%;">
        <div class="bg4">4444</div>
      </div>
    </RCarouselItem>
    <RCarouselItem>
      <div style="padding: 20px; height: 100%;">
        <div class="bg5">5555</div>
      </div>
    </RCarouselItem>
    <template #left>111</template>
  </RCascader>
```

# RCascader Props（属性）

| 属性     | 说明           | 默认值 | 类型           |
| -------- | -------------- | ------ | -------------- |
| width    | 轮播图的宽度   | 500px  | String, Number |
| height   | 轮播图的高度度 | 300px  | String, Number |
| viewNum  | 可视数量       | 3      | Number         |
| interval | 自动轮播的时间 | 3000   | Number         |
| autoPlay | 是否自动轮播 | true   | Boolean         |

# RCascader Slots（插槽）

| 插槽     | 说明           |
| -------- | -------------- |
| default    | 轮播图的子项，必须是\<RCarouselItem\>   |
| left   | 左按钮 <template #left>icon\</template>| 
| right  | 右按钮 <template #right>icon\</template>      |

# RCarouselItem Props（属性）

轮播图子项

暂无属性
# RCarouselItem Slots（插槽）
| 插槽     | 说明           |
| -------- | -------------- |
| default    | 每一项的具体内容   |