20260720172840
This commit is contained in:
1 parent
cda7f16d3a
commit
94207c77ff
3117 files changed
+201407
-1236
No files matched your search
@@ -0,0 +1,57 @@
|
||||
# Arrows for switching
|
||||
|
||||
## Description (en-US)
|
||||
|
||||
Show the arrows for switching.
|
||||
|
||||
## Source
|
||||
|
||||
```vue
|
||||
<template>
|
||||
<a-carousel arrows :infinite="false">
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
1
|
||||
</h3>
|
||||
</div>
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
2
|
||||
</h3>
|
||||
</div>
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
3
|
||||
</h3>
|
||||
</div>
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
4
|
||||
</h3>
|
||||
</div>
|
||||
</a-carousel>
|
||||
<br>
|
||||
<a-carousel arrows dot-placement="start" :infinite="false">
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
1
|
||||
</h3>
|
||||
</div>
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
2
|
||||
</h3>
|
||||
</div>
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
3
|
||||
</h3>
|
||||
</div>
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
4
|
||||
</h3>
|
||||
</div>
|
||||
</a-carousel>
|
||||
</template>
|
||||
```
|
||||
@@ -0,0 +1,34 @@
|
||||
# Scroll automatically
|
||||
|
||||
## Description (en-US)
|
||||
|
||||
Timing of scrolling to the next card/picture.
|
||||
|
||||
## Source
|
||||
|
||||
```vue
|
||||
<template>
|
||||
<a-carousel autoplay>
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
1
|
||||
</h3>
|
||||
</div>
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
2
|
||||
</h3>
|
||||
</div>
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
3
|
||||
</h3>
|
||||
</div>
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
4
|
||||
</h3>
|
||||
</div>
|
||||
</a-carousel>
|
||||
</template>
|
||||
```
|
||||
@@ -0,0 +1,40 @@
|
||||
# Basic
|
||||
|
||||
## Description (en-US)
|
||||
|
||||
Basic usage.
|
||||
|
||||
## Source
|
||||
|
||||
```vue
|
||||
<script setup lang="ts">
|
||||
function onChange(currentSlide: number) {
|
||||
console.log('current slide is', currentSlide)
|
||||
}
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<a-carousel :after-change="onChange">
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
1
|
||||
</h3>
|
||||
</div>
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
2
|
||||
</h3>
|
||||
</div>
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
3
|
||||
</h3>
|
||||
</div>
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
4
|
||||
</h3>
|
||||
</div>
|
||||
</a-carousel>
|
||||
</template>
|
||||
```
|
||||
+34
@@ -0,0 +1,34 @@
|
||||
# Progress of dots
|
||||
|
||||
## Description (en-US)
|
||||
|
||||
Show progress of dots.
|
||||
|
||||
## Source
|
||||
|
||||
```vue
|
||||
<template>
|
||||
<a-carousel :autoplay="{ dotDuration: true }" :autoplay-speed="5000">
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
1
|
||||
</h3>
|
||||
</div>
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
2
|
||||
</h3>
|
||||
</div>
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
3
|
||||
</h3>
|
||||
</div>
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
4
|
||||
</h3>
|
||||
</div>
|
||||
</a-carousel>
|
||||
</template>
|
||||
```
|
||||
@@ -0,0 +1,34 @@
|
||||
# Fade in
|
||||
|
||||
## Description (en-US)
|
||||
|
||||
Slides use fade for transition.
|
||||
|
||||
## Source
|
||||
|
||||
```vue
|
||||
<template>
|
||||
<a-carousel effect="fade">
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
1
|
||||
</h3>
|
||||
</div>
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
2
|
||||
</h3>
|
||||
</div>
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
3
|
||||
</h3>
|
||||
</div>
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
4
|
||||
</h3>
|
||||
</div>
|
||||
</a-carousel>
|
||||
</template>
|
||||
```
|
||||
@@ -0,0 +1,57 @@
|
||||
# Position
|
||||
|
||||
## Description (en-US)
|
||||
|
||||
There are 4 position options available.
|
||||
|
||||
## Source
|
||||
|
||||
```vue
|
||||
<script setup lang="ts">
|
||||
import type { CarouselProps } from 'antdv-next'
|
||||
import { ref } from 'vue'
|
||||
|
||||
type DotPlacement = CarouselProps['dotPlacement']
|
||||
|
||||
const dotPlacement = ref<DotPlacement>('top')
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<a-radio-group v-model:value="dotPlacement" style="margin-bottom: 8px">
|
||||
<a-radio-button value="top">
|
||||
Top
|
||||
</a-radio-button>
|
||||
<a-radio-button value="bottom">
|
||||
Bottom
|
||||
</a-radio-button>
|
||||
<a-radio-button value="start">
|
||||
Start
|
||||
</a-radio-button>
|
||||
<a-radio-button value="end">
|
||||
End
|
||||
</a-radio-button>
|
||||
</a-radio-group>
|
||||
<a-carousel :dot-placement="dotPlacement">
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
1
|
||||
</h3>
|
||||
</div>
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
2
|
||||
</h3>
|
||||
</div>
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
3
|
||||
</h3>
|
||||
</div>
|
||||
<div>
|
||||
<h3 class="custom-carousel-item">
|
||||
4
|
||||
</h3>
|
||||
</div>
|
||||
</a-carousel>
|
||||
</template>
|
||||
```
|
||||
@@ -0,0 +1,67 @@
|
||||
---
|
||||
title: Carousel
|
||||
description: A set of carousel areas.
|
||||
---
|
||||
|
||||
## When To Use
|
||||
- When there is a group of content on the same level.
|
||||
- When there is insufficient content space, it can be used to save space in the form of a revolving door.
|
||||
- Commonly used for a group of pictures/cards.
|
||||
|
||||
## Demos
|
||||
|
||||
| Demo | Path |
|
||||
| --- | --- |
|
||||
| Basic | demo/basic.md |
|
||||
| Position | demo/placement.md |
|
||||
| Scroll automatically | demo/autoplay.md |
|
||||
| Fade in | demo/fade.md |
|
||||
| Arrows for switching | demo/arrows.md |
|
||||
| Progress of dots | demo/dot-duration.md |
|
||||
|
||||
## API
|
||||
|
||||
Common props ref:[Common props](../../docs/vue/common-props.md)
|
||||
|
||||
### Props
|
||||
|
||||
| Property | Description | Type | Default | Version | [Global Config](../config-provider/docs.md#component-config) |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| effect | Transition effect | CarouselEffect | `scrollx` | - | × |
|
||||
| id | - | string | - | - | × |
|
||||
| slickGoTo | - | number | - | - | × |
|
||||
| dotPosition | The position of the dots, which can be one of `top` `bottom` `left` `right` `start` `end`, Please use `dotPlacement` instead | DotPlacement \| 'left' \| 'right' | `bottom` | - | × |
|
||||
| dotPlacement | The position of the dots, which can be one of `top` `bottom` `start` `end` | DotPlacement | `bottom` | - | × |
|
||||
| dots | Whether to show the dots at the bottom of the gallery, `object` for `dotsClass` | boolean \| { class?: string } | true | - | × |
|
||||
| waitForAnimate | Whether to wait for the animation when switching | boolean | false | - | × |
|
||||
| autoplay | Whether to scroll automatically, you can specify `autoplay={{ dotDuration: true }}` to display the progress bar | boolean \| { dotDuration?: boolean } | false | - | × |
|
||||
| prevArrow | - | VueNode | - | - | × |
|
||||
| nextArrow | - | VueNode | - | - | × |
|
||||
|
||||
### Events
|
||||
|
||||
| Event | Description | Type | Version |
|
||||
| --- | --- | --- | --- |
|
||||
| init | - | NonNullable<Settings['onInit']> | - |
|
||||
| reInit | - | NonNullable<Settings['onReInit']> | - |
|
||||
| edge | - | NonNullable<Settings['onEdge']> | - |
|
||||
| swipe | - | NonNullable<Settings['onSwipe']> | - |
|
||||
| lazyLoad | - | NonNullable<Settings['onLazyLoad']> | - |
|
||||
| lazyLoadError | - | NonNullable<Settings['onLazyLoadError']> | - |
|
||||
|
||||
### Slots
|
||||
|
||||
| Slot | Description | Type | Version |
|
||||
| --- | --- | --- | --- |
|
||||
| prevArrow | - | () => any | - |
|
||||
| nextArrow | - | () => any | - |
|
||||
|
||||
### Methods
|
||||
|
||||
| Method | Description | Type | Version |
|
||||
| --- | --- | --- | --- |
|
||||
| goTo | - | (slide: number, dontAnimate?: boolean) => void | - |
|
||||
| next | - | () => void | - |
|
||||
| prev | - | () => void | - |
|
||||
| autoPlay | - | (playType?: 'update' \| 'leave' \| 'blur') => void | - |
|
||||
| innerSlider | - | any | - |
|
||||
@@ -0,0 +1,32 @@
|
||||
# carousel Token
|
||||
|
||||
Use these variables through `theme.components.Carousel`. This document lists definitions only and does not include values.
|
||||
|
||||
```vue
|
||||
<a-config-provider
|
||||
:theme="{
|
||||
token: {
|
||||
// Global token configuration
|
||||
},
|
||||
components: {
|
||||
Carousel: {
|
||||
// Token name: value
|
||||
},
|
||||
},
|
||||
}"
|
||||
>
|
||||
...
|
||||
</a-config-provider>
|
||||
```
|
||||
|
||||
## Token List
|
||||
|
||||
| Token | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| `dotWidth` | `string \| number` | Width of indicator |
|
||||
| `dotHeight` | `string \| number` | Height of indicator |
|
||||
| `dotGap` | `number` | gap between indicator |
|
||||
| `dotOffset` | `number` | dot offset to Carousel edge |
|
||||
| `dotActiveWidth` | `string \| number` | Width of active indicator |
|
||||
| `arrowSize` | `number` | Size of arrows |
|
||||
| `arrowOffset` | `number` | arrows offset to Carousel edge |
|
||||
Reference in new issue
Block a user