@yamada-ui/carousel 0.3.18 → 0.3.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/carousel-indicators.d.mts +1 -1
- package/dist/carousel-indicators.d.ts +1 -1
- package/dist/carousel-slide.d.mts +2 -2
- package/dist/carousel-slide.d.ts +2 -2
- package/dist/carousel.d.mts +6 -6
- package/dist/carousel.d.ts +6 -6
- package/dist/use-carousel.d.mts +8 -8
- package/dist/use-carousel.d.ts +8 -8
- package/package.json +7 -7
|
@@ -11,7 +11,7 @@ type CarouselIndicatorsOptions = {
|
|
|
11
11
|
isSelected: boolean;
|
|
12
12
|
}>;
|
|
13
13
|
};
|
|
14
|
-
type CarouselIndicatorsProps = Omit<HTMLUIProps<
|
|
14
|
+
type CarouselIndicatorsProps = Omit<HTMLUIProps<"div">, "children"> & CarouselIndicatorsOptions;
|
|
15
15
|
declare const CarouselIndicators: _yamada_ui_core.Component<"div", CarouselIndicatorsProps>;
|
|
16
16
|
|
|
17
17
|
export { CarouselIndicators, CarouselIndicatorsProps };
|
|
@@ -11,7 +11,7 @@ type CarouselIndicatorsOptions = {
|
|
|
11
11
|
isSelected: boolean;
|
|
12
12
|
}>;
|
|
13
13
|
};
|
|
14
|
-
type CarouselIndicatorsProps = Omit<HTMLUIProps<
|
|
14
|
+
type CarouselIndicatorsProps = Omit<HTMLUIProps<"div">, "children"> & CarouselIndicatorsOptions;
|
|
15
15
|
declare const CarouselIndicators: _yamada_ui_core.Component<"div", CarouselIndicatorsProps>;
|
|
16
16
|
|
|
17
17
|
export { CarouselIndicators, CarouselIndicatorsProps };
|
|
@@ -10,9 +10,9 @@ type CarouselSlideOptions = {
|
|
|
10
10
|
/**
|
|
11
11
|
* The CSS `width` property.
|
|
12
12
|
*/
|
|
13
|
-
size?: CSSUIObject[
|
|
13
|
+
size?: CSSUIObject["width"];
|
|
14
14
|
};
|
|
15
|
-
type CarouselSlideProps = HTMLUIProps<
|
|
15
|
+
type CarouselSlideProps = HTMLUIProps<"div"> & UseCarouselSlideProps & CarouselSlideOptions;
|
|
16
16
|
declare const CarouselSlide: _yamada_ui_core.Component<"div", CarouselSlideProps>;
|
|
17
17
|
|
|
18
18
|
export { CarouselSlide, CarouselSlideProps };
|
package/dist/carousel-slide.d.ts
CHANGED
|
@@ -10,9 +10,9 @@ type CarouselSlideOptions = {
|
|
|
10
10
|
/**
|
|
11
11
|
* The CSS `width` property.
|
|
12
12
|
*/
|
|
13
|
-
size?: CSSUIObject[
|
|
13
|
+
size?: CSSUIObject["width"];
|
|
14
14
|
};
|
|
15
|
-
type CarouselSlideProps = HTMLUIProps<
|
|
15
|
+
type CarouselSlideProps = HTMLUIProps<"div"> & UseCarouselSlideProps & CarouselSlideOptions;
|
|
16
16
|
declare const CarouselSlide: _yamada_ui_core.Component<"div", CarouselSlideProps>;
|
|
17
17
|
|
|
18
18
|
export { CarouselSlide, CarouselSlideProps };
|
package/dist/carousel.d.mts
CHANGED
|
@@ -14,20 +14,20 @@ type CarouselOptions = {
|
|
|
14
14
|
*
|
|
15
15
|
* @default 'horizontal'
|
|
16
16
|
*/
|
|
17
|
-
orientation?: Token<
|
|
17
|
+
orientation?: Token<"vertical" | "horizontal">;
|
|
18
18
|
/**
|
|
19
19
|
* The alignment of the carousel.
|
|
20
20
|
*
|
|
21
21
|
* @default 'center'
|
|
22
22
|
*/
|
|
23
|
-
align?: Token<
|
|
23
|
+
align?: Token<"start" | "center" | "end" | number>;
|
|
24
24
|
/**
|
|
25
25
|
* Clear leading and trailing empty space that causes excessive scrolling.
|
|
26
26
|
* Use trimSnaps to only use snap points that trigger scrolling or keepSnaps to keep them.
|
|
27
27
|
*
|
|
28
28
|
* @default ''
|
|
29
29
|
*/
|
|
30
|
-
containScroll?: Token<
|
|
30
|
+
containScroll?: Token<"trimSnaps" | "keepSnaps" | "">;
|
|
31
31
|
/**
|
|
32
32
|
* The number of slides that should be scrolled with next or previous buttons.
|
|
33
33
|
*
|
|
@@ -100,11 +100,11 @@ type CarouselOptions = {
|
|
|
100
100
|
/**
|
|
101
101
|
* The CSS `width` property.
|
|
102
102
|
*/
|
|
103
|
-
slideSize?: CSSUIProps[
|
|
103
|
+
slideSize?: CSSUIProps["width"];
|
|
104
104
|
/**
|
|
105
105
|
* Props for carousel inner element.
|
|
106
106
|
*/
|
|
107
|
-
innerProps?: HTMLUIProps<
|
|
107
|
+
innerProps?: HTMLUIProps<"div">;
|
|
108
108
|
/**
|
|
109
109
|
* If `true`, display the carousel control buttons.
|
|
110
110
|
*
|
|
@@ -134,7 +134,7 @@ type CarouselOptions = {
|
|
|
134
134
|
*/
|
|
135
135
|
indicatorsProps?: CarouselIndicatorsProps;
|
|
136
136
|
};
|
|
137
|
-
type CarouselProps = ThemeProps<
|
|
137
|
+
type CarouselProps = ThemeProps<"Carousel"> & Omit<HTMLUIProps<"div">, "onChange" | "draggable"> & Pick<UseCarouselProps, "index" | "defaultIndex" | "onChange" | "onScrollProgress"> & CarouselOptions;
|
|
138
138
|
declare const Carousel: _yamada_ui_core.Component<"div", CarouselProps>;
|
|
139
139
|
|
|
140
140
|
export { Carousel, CarouselProps };
|
package/dist/carousel.d.ts
CHANGED
|
@@ -14,20 +14,20 @@ type CarouselOptions = {
|
|
|
14
14
|
*
|
|
15
15
|
* @default 'horizontal'
|
|
16
16
|
*/
|
|
17
|
-
orientation?: Token<
|
|
17
|
+
orientation?: Token<"vertical" | "horizontal">;
|
|
18
18
|
/**
|
|
19
19
|
* The alignment of the carousel.
|
|
20
20
|
*
|
|
21
21
|
* @default 'center'
|
|
22
22
|
*/
|
|
23
|
-
align?: Token<
|
|
23
|
+
align?: Token<"start" | "center" | "end" | number>;
|
|
24
24
|
/**
|
|
25
25
|
* Clear leading and trailing empty space that causes excessive scrolling.
|
|
26
26
|
* Use trimSnaps to only use snap points that trigger scrolling or keepSnaps to keep them.
|
|
27
27
|
*
|
|
28
28
|
* @default ''
|
|
29
29
|
*/
|
|
30
|
-
containScroll?: Token<
|
|
30
|
+
containScroll?: Token<"trimSnaps" | "keepSnaps" | "">;
|
|
31
31
|
/**
|
|
32
32
|
* The number of slides that should be scrolled with next or previous buttons.
|
|
33
33
|
*
|
|
@@ -100,11 +100,11 @@ type CarouselOptions = {
|
|
|
100
100
|
/**
|
|
101
101
|
* The CSS `width` property.
|
|
102
102
|
*/
|
|
103
|
-
slideSize?: CSSUIProps[
|
|
103
|
+
slideSize?: CSSUIProps["width"];
|
|
104
104
|
/**
|
|
105
105
|
* Props for carousel inner element.
|
|
106
106
|
*/
|
|
107
|
-
innerProps?: HTMLUIProps<
|
|
107
|
+
innerProps?: HTMLUIProps<"div">;
|
|
108
108
|
/**
|
|
109
109
|
* If `true`, display the carousel control buttons.
|
|
110
110
|
*
|
|
@@ -134,7 +134,7 @@ type CarouselOptions = {
|
|
|
134
134
|
*/
|
|
135
135
|
indicatorsProps?: CarouselIndicatorsProps;
|
|
136
136
|
};
|
|
137
|
-
type CarouselProps = ThemeProps<
|
|
137
|
+
type CarouselProps = ThemeProps<"Carousel"> & Omit<HTMLUIProps<"div">, "onChange" | "draggable"> & Pick<UseCarouselProps, "index" | "defaultIndex" | "onChange" | "onScrollProgress"> & CarouselOptions;
|
|
138
138
|
declare const Carousel: _yamada_ui_core.Component<"div", CarouselProps>;
|
|
139
139
|
|
|
140
140
|
export { Carousel, CarouselProps };
|
package/dist/use-carousel.d.mts
CHANGED
|
@@ -9,16 +9,16 @@ type CarouselContext = {
|
|
|
9
9
|
carousel: EmblaCarouselType | undefined;
|
|
10
10
|
indexes: number[];
|
|
11
11
|
selectedIndex: number;
|
|
12
|
-
orientation:
|
|
12
|
+
orientation: "vertical" | "horizontal";
|
|
13
13
|
includeGapInSize: boolean;
|
|
14
14
|
slidesToScroll: number;
|
|
15
15
|
slideSize: string | number;
|
|
16
|
-
gap: CSSUIProps[
|
|
16
|
+
gap: CSSUIProps["gap"];
|
|
17
17
|
styles: Record<string, CSSUIObject>;
|
|
18
18
|
};
|
|
19
19
|
declare const CarouselProvider: react.Provider<CarouselContext>;
|
|
20
20
|
declare const useCarouselContext: () => CarouselContext;
|
|
21
|
-
type UseCarouselProps = Omit<HTMLUIProps<
|
|
21
|
+
type UseCarouselProps = Omit<HTMLUIProps<"div">, "onChange" | "draggable" | "gap"> & {
|
|
22
22
|
/**
|
|
23
23
|
* The index of the carousel slide.
|
|
24
24
|
*/
|
|
@@ -38,20 +38,20 @@ type UseCarouselProps = Omit<HTMLUIProps<'div'>, 'onChange' | 'draggable' | 'gap
|
|
|
38
38
|
*
|
|
39
39
|
* @default 'horizontal'
|
|
40
40
|
*/
|
|
41
|
-
orientation?:
|
|
41
|
+
orientation?: "vertical" | "horizontal";
|
|
42
42
|
/**
|
|
43
43
|
* The alignment of the carousel.
|
|
44
44
|
*
|
|
45
45
|
* @default 'center'
|
|
46
46
|
*/
|
|
47
|
-
align?:
|
|
47
|
+
align?: "start" | "center" | "end" | number;
|
|
48
48
|
/**
|
|
49
49
|
* Clear leading and trailing empty space that causes excessive scrolling.
|
|
50
50
|
* Use trimSnaps to only use snap points that trigger scrolling or keepSnaps to keep them.
|
|
51
51
|
*
|
|
52
52
|
* @default ''
|
|
53
53
|
*/
|
|
54
|
-
containScroll?:
|
|
54
|
+
containScroll?: "trimSnaps" | "keepSnaps" | "";
|
|
55
55
|
/**
|
|
56
56
|
* The number of slides that should be scrolled with next or previous buttons.
|
|
57
57
|
*
|
|
@@ -126,7 +126,7 @@ type UseCarouselProps = Omit<HTMLUIProps<'div'>, 'onChange' | 'draggable' | 'gap
|
|
|
126
126
|
*
|
|
127
127
|
* @default 'md'
|
|
128
128
|
*/
|
|
129
|
-
gap?: CSSUIProps[
|
|
129
|
+
gap?: CSSUIProps["gap"];
|
|
130
130
|
/**
|
|
131
131
|
* The carousel slide width.
|
|
132
132
|
*
|
|
@@ -160,7 +160,7 @@ declare const useCarouselSlide: ({ index }: UseCarouselSlideProps) => {
|
|
|
160
160
|
};
|
|
161
161
|
type UseCarouselSlideReturn = ReturnType<typeof useCarouselSlide>;
|
|
162
162
|
type UseCarouselControlProps = IconButtonProps & {
|
|
163
|
-
operation:
|
|
163
|
+
operation: "prev" | "next";
|
|
164
164
|
};
|
|
165
165
|
declare const useCarouselControl: ({ operation, ...rest }: UseCarouselControlProps) => {
|
|
166
166
|
getControlProps: PropGetter;
|
package/dist/use-carousel.d.ts
CHANGED
|
@@ -9,16 +9,16 @@ type CarouselContext = {
|
|
|
9
9
|
carousel: EmblaCarouselType | undefined;
|
|
10
10
|
indexes: number[];
|
|
11
11
|
selectedIndex: number;
|
|
12
|
-
orientation:
|
|
12
|
+
orientation: "vertical" | "horizontal";
|
|
13
13
|
includeGapInSize: boolean;
|
|
14
14
|
slidesToScroll: number;
|
|
15
15
|
slideSize: string | number;
|
|
16
|
-
gap: CSSUIProps[
|
|
16
|
+
gap: CSSUIProps["gap"];
|
|
17
17
|
styles: Record<string, CSSUIObject>;
|
|
18
18
|
};
|
|
19
19
|
declare const CarouselProvider: react.Provider<CarouselContext>;
|
|
20
20
|
declare const useCarouselContext: () => CarouselContext;
|
|
21
|
-
type UseCarouselProps = Omit<HTMLUIProps<
|
|
21
|
+
type UseCarouselProps = Omit<HTMLUIProps<"div">, "onChange" | "draggable" | "gap"> & {
|
|
22
22
|
/**
|
|
23
23
|
* The index of the carousel slide.
|
|
24
24
|
*/
|
|
@@ -38,20 +38,20 @@ type UseCarouselProps = Omit<HTMLUIProps<'div'>, 'onChange' | 'draggable' | 'gap
|
|
|
38
38
|
*
|
|
39
39
|
* @default 'horizontal'
|
|
40
40
|
*/
|
|
41
|
-
orientation?:
|
|
41
|
+
orientation?: "vertical" | "horizontal";
|
|
42
42
|
/**
|
|
43
43
|
* The alignment of the carousel.
|
|
44
44
|
*
|
|
45
45
|
* @default 'center'
|
|
46
46
|
*/
|
|
47
|
-
align?:
|
|
47
|
+
align?: "start" | "center" | "end" | number;
|
|
48
48
|
/**
|
|
49
49
|
* Clear leading and trailing empty space that causes excessive scrolling.
|
|
50
50
|
* Use trimSnaps to only use snap points that trigger scrolling or keepSnaps to keep them.
|
|
51
51
|
*
|
|
52
52
|
* @default ''
|
|
53
53
|
*/
|
|
54
|
-
containScroll?:
|
|
54
|
+
containScroll?: "trimSnaps" | "keepSnaps" | "";
|
|
55
55
|
/**
|
|
56
56
|
* The number of slides that should be scrolled with next or previous buttons.
|
|
57
57
|
*
|
|
@@ -126,7 +126,7 @@ type UseCarouselProps = Omit<HTMLUIProps<'div'>, 'onChange' | 'draggable' | 'gap
|
|
|
126
126
|
*
|
|
127
127
|
* @default 'md'
|
|
128
128
|
*/
|
|
129
|
-
gap?: CSSUIProps[
|
|
129
|
+
gap?: CSSUIProps["gap"];
|
|
130
130
|
/**
|
|
131
131
|
* The carousel slide width.
|
|
132
132
|
*
|
|
@@ -160,7 +160,7 @@ declare const useCarouselSlide: ({ index }: UseCarouselSlideProps) => {
|
|
|
160
160
|
};
|
|
161
161
|
type UseCarouselSlideReturn = ReturnType<typeof useCarouselSlide>;
|
|
162
162
|
type UseCarouselControlProps = IconButtonProps & {
|
|
163
|
-
operation:
|
|
163
|
+
operation: "prev" | "next";
|
|
164
164
|
};
|
|
165
165
|
declare const useCarouselControl: ({ operation, ...rest }: UseCarouselControlProps) => {
|
|
166
166
|
getControlProps: PropGetter;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@yamada-ui/carousel",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.20",
|
|
4
4
|
"description": "Yamada UI carousel component",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"yamada",
|
|
@@ -36,12 +36,12 @@
|
|
|
36
36
|
},
|
|
37
37
|
"dependencies": {
|
|
38
38
|
"embla-carousel-react": "^7.0.0",
|
|
39
|
-
"@yamada-ui/button": "0.3.
|
|
40
|
-
"@yamada-ui/core": "0.12.
|
|
41
|
-
"@yamada-ui/icon": "0.3.
|
|
42
|
-
"@yamada-ui/use-controllable-state": "0.3.
|
|
43
|
-
"@yamada-ui/use-token": "0.3.
|
|
44
|
-
"@yamada-ui/use-value": "0.2.
|
|
39
|
+
"@yamada-ui/button": "0.3.18",
|
|
40
|
+
"@yamada-ui/core": "0.12.6",
|
|
41
|
+
"@yamada-ui/icon": "0.3.16",
|
|
42
|
+
"@yamada-ui/use-controllable-state": "0.3.1",
|
|
43
|
+
"@yamada-ui/use-token": "0.3.10",
|
|
44
|
+
"@yamada-ui/use-value": "0.2.16",
|
|
45
45
|
"@yamada-ui/utils": "0.3.3"
|
|
46
46
|
},
|
|
47
47
|
"devDependencies": {
|