Skip to content

Commit 25ebf52

Browse files
committed
refactor: update docs and remove overlay component
1 parent 2b06ed0 commit 25ebf52

88 files changed

Lines changed: 482 additions & 643 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

apps/showcase/docs/styled/components/accordion/features.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Accordion groups content into collapsible panels.
44
component: accordion
55
---
66

7-
<DocDemoViewer name="accordion:basic-demo" mode="collapsible"/>
7+
<DocDemoViewer name="accordion:basic-demo" mode="collapsible" hideName />
88

99
## Usage
1010

@@ -27,6 +27,12 @@ import { Accordion } from '@primereact/ui/accordion';
2727

2828
## Examples
2929

30+
### Basic
31+
32+
A simple accordion with expandable panels controlled via the `value` prop.
33+
34+
<DocDemoViewer name="accordion:basic-demo" />
35+
3036
### Multiple
3137

3238
Each `Accordion.Panel` should define a unique `value`. By default, a single panel is open at a time. Enable `multiple` on `Accordion.Root` to allow multiple panels to stay open.

apps/showcase/docs/styled/components/animateonscroll/features.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: AnimateOnScroll applies enter and leave animations to elements as t
44
component: animateonscroll
55
---
66

7-
<DocDemoViewer name="animateonscroll:basic-demo" mode="collapsible" />
7+
<DocDemoViewer name="animateonscroll:basic-demo" mode="collapsible" hideName />
88

99
## Usage
1010

@@ -18,6 +18,12 @@ import { AnimateOnScroll } from '@primereact/ui/animateonscroll';
1818

1919
## Examples
2020

21+
### Basic
22+
23+
Elements animate into view as they enter the viewport during scroll.
24+
25+
<DocDemoViewer name="animateonscroll:basic-demo" />
26+
2127
### Enter & Leave
2228

2329
Animation classes are defined with the `enterClassName` and `leaveClassName` properties. This example uses animations from the `tailwindcss-primeui` plugin, but any valid CSS animation is supported.

apps/showcase/docs/styled/components/autocomplete/features.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: AutoComplete is an input component that provides real-time suggesti
44
component: autocomplete
55
---
66

7-
<DocDemoViewer name="autocomplete:basic-demo" mode="collapsible"/>
7+
<DocDemoViewer name="autocomplete:basic-demo" mode="collapsible" hideName />
88

99
## Usage
1010

@@ -39,6 +39,12 @@ import { AutoComplete } from '@primereact/ui/autocomplete';
3939

4040
## Examples
4141

42+
### Basic
43+
44+
An input that filters and suggests options as the user types.
45+
46+
<DocDemoViewer name="autocomplete:basic-demo" />
47+
4248
### Sizes
4349

4450
Use the `size` property to change the size of an autocomplete.

apps/showcase/docs/styled/components/avatar/features.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Avatar represents people using icons, labels and images.
44
component: avatar
55
---
66

7-
<DocDemoViewer name="avatar:basic-demo" mode="collapsible"/>
7+
<DocDemoViewer name="avatar:basic-demo" mode="collapsible" hideName />
88

99
## Usage
1010

@@ -24,6 +24,12 @@ import { AvatarGroup } from '@primereact/ui/avatargroup';
2424

2525
## Examples
2626

27+
### Basic
28+
29+
Displays a user representation using an image, icon, or label initials.
30+
31+
<DocDemoViewer name="avatar:basic-demo" />
32+
2733
### Fallback
2834

2935
The `Avatar.Fallback` component displays a label or an icon when an image fails to load or when an image is not preferred.

apps/showcase/docs/styled/components/badge/features.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Badge is a small status indicator for another element.
44
component: badge
55
---
66

7-
<DocDemoViewer name="badge:basic-demo" mode="collapsible"/>
7+
<DocDemoViewer name="badge:basic-demo" mode="collapsible" hideName />
88

99
## Usage
1010

@@ -18,6 +18,12 @@ import { Badge } from '@primereact/ui/badge';
1818

1919
## Examples
2020

21+
### Basic
22+
23+
A small overlay on another element to indicate a count or status.
24+
25+
<DocDemoViewer name="badge:basic-demo" />
26+
2127
### Severity
2228

2329
The `severity` property defines the visual style of a badge.

apps/showcase/docs/styled/components/breadcrumb/features.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Breadcrumb provides contextual information about page hierarchy.
44
component: breadcrumb
55
---
66

7-
<DocDemoViewer name="breadcrumb:basic-demo" mode="collapsible"/>
7+
<DocDemoViewer name="breadcrumb:basic-demo" mode="collapsible" hideName />
88

99
## Usage
1010

@@ -23,6 +23,12 @@ import { Breadcrumb } from '@primereact/ui/breadcrumb';
2323

2424
## Examples
2525

26+
### Basic
27+
28+
Shows the current location within a navigational hierarchy.
29+
30+
<DocDemoViewer name="breadcrumb:basic-demo" />
31+
2632
### Route
2733

2834
A breadcrumb can be used with routing libraries to navigate between pages.

apps/showcase/docs/styled/components/button/features.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Button is an extension to standard input element with icons and the
44
component: button
55
---
66

7-
<DocDemoViewer name="button:basic-demo" mode="collapsible"/>
7+
<DocDemoViewer name="button:basic-demo" mode="collapsible" hideName />
88

99
## Usage
1010

@@ -21,6 +21,12 @@ import { ButtonGroup } from '@primereact/ui/buttongroup';
2121

2222
## Examples
2323

24+
### Basic
25+
26+
A standard button with label, icon, and various severity options.
27+
28+
<DocDemoViewer name="button:basic-demo" />
29+
2430
### Icons
2531

2632
<DocDemoViewer name="button:icon-demo" />

apps/showcase/docs/styled/components/card/features.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Card is a flexible container component.
44
component: card
55
---
66

7-
<DocDemoViewer name="card:basic-demo" mode="collapsible" />
7+
<DocDemoViewer name="card:basic-demo" mode="collapsible" hideName />
88

99
## Usage
1010

@@ -27,6 +27,12 @@ import { Card } from '@primereact/ui/card';
2727

2828
## Examples
2929

30+
### Basic
31+
32+
A container with a header, body, and footer for structured content.
33+
34+
<DocDemoViewer name="card:basic-demo" />
35+
3036
### With Form
3137

3238
Use `Card`, `Card.Body`, `Card.Caption`, `Card.Title`, `Card.Subtitle`, `Card.Content`, `Card.Footer`, to create a simple card.

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Carousel is a content slider featuring various customization option
44
component: carousel
55
---
66

7-
<DocDemoViewer name="carousel:basic-demo" mode="collapsible"/>
7+
<DocDemoViewer name="carousel:basic-demo" mode="collapsible" hideName />
88

99
## Usage
1010

@@ -25,6 +25,12 @@ import { Carousel } from '@primereact/ui/carousel';
2525

2626
## Examples
2727

28+
### Basic
29+
30+
Cycles through a set of items with navigation controls.
31+
32+
<DocDemoViewer name="carousel:basic-demo" />
33+
2834
### Alignment
2935

3036
Use the `align` property to align the carousel items. `slidesPerPage` property is used to control the number of slides visible per page.

apps/showcase/docs/styled/components/checkbox/features.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Checkbox is an extension to standard checkbox element with theming.
44
component: checkbox
55
---
66

7-
<DocDemoViewer name="checkbox:basic-demo" mode="collapsible"/>
7+
<DocDemoViewer name="checkbox:basic-demo" mode="collapsible" hideName />
88

99
## Usage
1010

@@ -22,6 +22,12 @@ import { Checkbox } from '@primereact/ui/checkbox';
2222

2323
## Examples
2424

25+
### Basic
26+
27+
Toggles a boolean value with an associated label.
28+
29+
<DocDemoViewer name="checkbox:basic-demo" />
30+
2531
### Sizes
2632

2733
Use the `size` property to change the size of a checkbox.

0 commit comments

Comments
 (0)