Skip to content

Commit 1421c7d

Browse files
committed
docs: update JSDoc coments
1 parent d3d35ee commit 1421c7d

File tree

2 files changed

+1
-19
lines changed

2 files changed

+1
-19
lines changed

src/components/carousel/CCarousel.tsx

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,56 +16,40 @@ import { CCarouselInner } from './CCarouselInner'
1616
export interface CCarouselProps extends HTMLAttributes<HTMLDivElement> {
1717
/**
1818
* Set 'animate' variable for created context. [docs]
19-
*
20-
* @type boolean
2119
*/
2220
animate?: boolean
2321
/**
2422
* A string of all className you want applied to the base component. [docs]
25-
*
26-
* @type string
2723
*/
2824
className?: string
2925
/**
3026
* Adding in the previous and next controls. [docs]
31-
*
32-
* @type: boolean
3327
*/
3428
controls?: boolean
3529
/**
3630
* Add darker controls, indicators, and captions. [docs]
37-
*
38-
* @type boolean
3931
*/
4032
dark?: boolean
4133
/**
4234
* The amount of time to delay between automatically cycling an item. If false, carousel will not automatically cycle. [docs]
43-
*
44-
* @type boolean | number
4535
*/
4636
interval?: boolean | number
4737
/**
4838
* index of the active item. [docs]
49-
*
50-
* @type number
5139
*/
5240
index?: number
5341
/**
5442
* Adding indicators at the bottom of the carousel for each item. [docs]
55-
*
56-
* @type boolean
5743
*/
5844
indicators?: boolean
5945
/**
6046
* On slide change callback. [docs]
61-
*
62-
* @type (a:number|string|null)=>void
6347
*/
6448
onSlideChange?: (a: number | string | null) => void
6549
/**
6650
* On slide change callback. [docs]
6751
*
68-
* @type 'slide' | 'crossfade'
52+
* @type {'slide' | 'crossfade'}
6953
* @default 'slide'
7054
*/
7155
transition?: 'slide' | 'crossfade'

src/components/carousel/CCarouselIndicators.tsx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ export interface CCarouselIndicatorsProps extends HTMLAttributes<HTMLOListElemen
1010
className?: string
1111
/**
1212
* Indicators section user classes. [docs]
13-
*
14-
* @type string
1513
*/
1614
indicatorsClass?: string
1715
}

0 commit comments

Comments
 (0)