Skip to content

Commit 1a4b56e

Browse files
tanerengiiintanerengiiin
committed
feat: add carousel and toast docs
1 parent 632a24a commit 1a4b56e

9 files changed

Lines changed: 890 additions & 370 deletions

File tree

‎apps/showcase/assets/apidoc/index.json‎

Lines changed: 369 additions & 369 deletions
Large diffs are not rendered by default.

‎apps/showcase/docs/components/carousel/api.mdx‎

Lines changed: 181 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,181 @@
1+
---
2+
title: Carousel API
3+
description: API documentation for Carousel component
4+
component: carousel
5+
---
6+
7+
## Carousel
8+
9+
### Props
10+
11+
<DocTable name="Carousel" category="api" type="props" />
12+
13+
### State
14+
15+
<DocTable name="Carousel" category="api" type="state" />
16+
17+
### Exposes
18+
19+
<DocTable name="Carousel" category="api" type="exposes" />
20+
21+
### Interfaces
22+
23+
<DocTable name="Carousel" category="api" type="interfaces" />
24+
25+
### Types
26+
27+
<DocTable name="Carousel" category="api" type="types" />
28+
29+
## CarouselContent
30+
31+
### Props
32+
33+
<DocTable name="CarouselContent" category="api" type="props" />
34+
35+
### State
36+
37+
<DocTable name="CarouselContent" category="api" type="state" />
38+
39+
### Exposes
40+
41+
<DocTable name="CarouselContent" category="api" type="exposes" />
42+
43+
### Interfaces
44+
45+
<DocTable name="CarouselContent" category="api" type="interfaces" />
46+
47+
### Types
48+
49+
<DocTable name="CarouselContent" category="api" type="types" />
50+
51+
## CarouselItem
52+
53+
### Props
54+
55+
<DocTable name="CarouselItem" category="api" type="props" />
56+
57+
### State
58+
59+
<DocTable name="CarouselItem" category="api" type="state" />
60+
61+
### Exposes
62+
63+
<DocTable name="CarouselItem" category="api" type="exposes" />
64+
65+
### Interfaces
66+
67+
<DocTable name="CarouselItem" category="api" type="interfaces" />
68+
69+
### Types
70+
71+
<DocTable name="CarouselItem" category="api" type="types" />
72+
73+
## CarouselIndicators
74+
75+
### Props
76+
77+
<DocTable name="CarouselIndicators" category="api" type="props" />
78+
79+
### State
80+
81+
<DocTable name="CarouselIndicators" category="api" type="state" />
82+
83+
### Exposes
84+
85+
<DocTable name="CarouselIndicators" category="api" type="exposes" />
86+
87+
### Interfaces
88+
89+
<DocTable name="CarouselIndicators" category="api" type="interfaces" />
90+
91+
### Types
92+
93+
<DocTable name="CarouselIndicators" category="api" type="types" />
94+
95+
## CarouselIndicator
96+
97+
### Props
98+
99+
<DocTable name="CarouselIndicator" category="api" type="props" />
100+
101+
### State
102+
103+
<DocTable name="CarouselIndicator" category="api" type="state" />
104+
105+
### Exposes
106+
107+
<DocTable name="CarouselIndicator" category="api" type="exposes" />
108+
109+
### Interfaces
110+
111+
<DocTable name="CarouselIndicator" category="api" type="interfaces" />
112+
113+
### Types
114+
115+
<DocTable name="CarouselIndicator" category="api" type="types" />
116+
117+
## CarouselNext
118+
119+
### Props
120+
121+
<DocTable name="CarouselNext" category="api" type="props" />
122+
123+
### State
124+
125+
<DocTable name="CarouselNext" category="api" type="state" />
126+
127+
### Exposes
128+
129+
<DocTable name="CarouselNext" category="api" type="exposes" />
130+
131+
### Interfaces
132+
133+
<DocTable name="CarouselNext" category="api" type="interfaces" />
134+
135+
### Types
136+
137+
<DocTable name="CarouselNext" category="api" type="types" />
138+
139+
## CarouselPrev
140+
141+
### Props
142+
143+
<DocTable name="CarouselPrev" category="api" type="props" />
144+
145+
### State
146+
147+
<DocTable name="CarouselPrev" category="api" type="state" />
148+
149+
### Exposes
150+
151+
<DocTable name="CarouselPrev" category="api" type="exposes" />
152+
153+
### Interfaces
154+
155+
<DocTable name="CarouselPrev" category="api" type="interfaces" />
156+
157+
### Types
158+
159+
<DocTable name="CarouselPrev" category="api" type="types" />
160+
161+
## useCarousel
162+
163+
### Props
164+
165+
<DocTable name="useCarousel" category="api" type="props" />
166+
167+
### State
168+
169+
<DocTable name="useCarousel" category="api" type="state" />
170+
171+
### Exposes
172+
173+
<DocTable name="useCarousel" category="api" type="exposes" />
174+
175+
### Interfaces
176+
177+
<DocTable name="useCarousel" category="api" type="interfaces" />
178+
179+
### Types
180+
181+
<DocTable name="useCarousel" category="api" type="types" />

‎apps/showcase/docs/components/carousel/features.mdx‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,14 @@ import { Carousel } from 'primereact/carousel';
1111
```
1212

1313
```tsx
14-
<Button>Button</Button>
14+
<Carousel>
15+
<Carousel.Content>
16+
<Carousel.Item></Carousel.Item>
17+
</Carousel.Content>
18+
<Carousel.Indicators />
19+
<Carousel.Prev></Carousel.Prev>
20+
<Carousel.Next></Carousel.Next>
21+
</Carousel>
1522
```
1623

1724
## Examples

‎apps/showcase/docs/components/carousel/pt.mdx‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: Carousel Pass Through
3+
description: Pass Through documentation for Carousel component
4+
component: carousel
5+
---
6+
7+
## Viewer
8+
9+
Some sections may not be visible due to the availability of the particular feature.
10+
11+
<DocPTViewer name="carousel-pt" components={['Carousel', 'CarouselContent', 'CarouselIndicator', 'CarouselIndicators', 'CarouselNext', 'CarouselPrev']} />
12+
13+
## Carousel PT Options
14+
15+
<DocTable name="Carousel" category="pt" />
16+
17+
## CarouselContent PT Options
18+
19+
<DocTable name="CarouselContent" category="pt" />
20+
21+
## CarouselIndicator PT Options
22+
23+
<DocTable name="CarouselIndicator" category="pt" />
24+
25+
## CarouselIndicators PT Options
26+
27+
<DocTable name="CarouselIndicators" category="pt" />
28+
29+
## CarouselNext PT Options
30+
31+
<DocTable name="CarouselNext" category="pt" />
32+
33+
## CarouselPrev PT Options
34+
35+
<DocTable name="CarouselPrev" category="pt" />

‎apps/showcase/docs/components/carousel/theming.mdx‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: Carousel Theming
3+
description: Theming documentation for Carousel component
4+
component: carousel
5+
---
6+
7+
## Styled
8+
9+
### Carousel CSS Classes
10+
11+
List of class names used in the styled mode.
12+
13+
<DocTable name="Carousel" category="style" />
14+
15+
### CarouselContent CSS Classes
16+
17+
List of class names used in the styled mode.
18+
19+
<DocTable name="CarouselContent" category="style" />
20+
21+
### CarouselIndicators CSS Classes
22+
23+
List of class names used in the styled mode.
24+
25+
<DocTable name="CarouselIndicators" category="style" />
26+
27+
### CarouselIndicator CSS Classes
28+
29+
List of class names used in the styled mode.
30+
31+
<DocTable name="CarouselIndicator" category="style" />
32+
33+
### CarouselNext CSS Classes
34+
35+
List of class names used in the styled mode.
36+
37+
<DocTable name="CarouselNext" category="style" />
38+
39+
### CarouselPrev CSS Classes
40+
41+
List of class names used in the styled mode.
42+
43+
<DocTable name="CarouselPrev" category="style" />
44+
45+
### Design Tokens
46+
47+
List of design tokens.
48+
49+
<DocTable name="Carousel" category="token" />
50+
51+
## Unstyled
52+
53+
Theming is implemented with the pass through properties in unstyled mode.

0 commit comments

Comments
 (0)