diff --git a/docs/renderers.md b/docs/renderers.md index 63e6f11ae..db33ad78b 100644 --- a/docs/renderers.md +++ b/docs/renderers.md @@ -68,6 +68,7 @@ amis 页面是通过 JSON 配置出来的,是由一个一个渲染模型组成 - [Service](./renderers/Service.md): 功能型容器,自身不负责展示内容,主要职责在于通过配置的 api 拉取数据 - [Chart](./renderers/Chart.md): 图表渲染器 - [Collapse](./renderers/Collapse.md): 折叠器 +- [Carousel](./renderers/Carousel.md): 轮播图 - [Audio](./renderers/Audio.md): 音频播放器 - [Video](./renderers/Video.md): 视频播放器 - [Table](./renderers/Table.md): 表格展示 diff --git a/docs/renderers/Carousel.md b/docs/renderers/Carousel.md new file mode 100644 index 000000000..d92323a27 --- /dev/null +++ b/docs/renderers/Carousel.md @@ -0,0 +1,43 @@ +### Carousel + +轮播图 + +- `type` 请设置成 `carousel` +- `className` 外层 Dom 的类名 +- `options` 轮播面板数据,默认`[]`,支持以下模式 + - 图片 + - `image` 图片链接 + - `imageClassName` 图片类名 + - `title` 图片标题 + - `titleClassName` 图片标题类名 + - `description` 图片描述 + - `descriptionClassName` 图片描述类名 + - `html` HTML 自定义,同[Tpl](./Tpl.md)一致 +- `auto` 是否自动轮播,默认`true` +- `interval` 切换动画间隔,默认`5s` +- `duration` 切换动画时长,默认`0.5s` +- `width` 宽度,默认`auto` +- `height` 高度,默认`200px` +- `controls` 显示左右箭头、底部圆点索引,默认`['dots', 'arrows']` +- `controlsTheme` 左右箭头、底部圆点索引颜色,默认`light`,另有`dark`模式 +- `animation` 切换动画效果,默认`fade`,另有`slide`模式 + +```schema:height="350" scope="body" +{ + "type": "carousel", + "controlTheme": "light", + "height": "300", + "animation": "slide", + "options": [ + { + "image": "https://video-react.js.org/assets/poster.png" + }, + { + "html": "