Skip to content

Commit cb056e9

Browse files
authored
feat: docusaurus plugin to generate component api docs (#2797)
1 parent 305b6d9 commit cb056e9

File tree

182 files changed

+1877
-1631
lines changed

Some content is hidden

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

182 files changed

+1877
-1631
lines changed

docs/api/accordion-group.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: "ion-accordion-group"
33
---
4-
import Props from '@site/static/auto-generated/accordion-group/props.md';
5-
import Events from '@site/static/auto-generated/accordion-group/events.md';
6-
import Methods from '@site/static/auto-generated/accordion-group/methods.md';
7-
import Parts from '@site/static/auto-generated/accordion-group/parts.md';
8-
import CustomProps from '@site/static/auto-generated/accordion-group/custom-props.md';
9-
import Slots from '@site/static/auto-generated/accordion-group/slots.md';
4+
import Props from '@ionic-internal/component-api/v7/accordion-group/props.md';
5+
import Events from '@ionic-internal/component-api/v7/accordion-group/events.md';
6+
import Methods from '@ionic-internal/component-api/v7/accordion-group/methods.md';
7+
import Parts from '@ionic-internal/component-api/v7/accordion-group/parts.md';
8+
import CustomProps from '@ionic-internal/component-api/v7/accordion-group/custom-props.md';
9+
import Slots from '@ionic-internal/component-api/v7/accordion-group/slots.md';
1010

1111
import EncapsulationPill from '@components/page/api/EncapsulationPill';
1212

docs/api/accordion.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: "ion-accordion"
33
---
4-
import Props from '@site/static/auto-generated/accordion/props.md';
5-
import Events from '@site/static/auto-generated/accordion/events.md';
6-
import Methods from '@site/static/auto-generated/accordion/methods.md';
7-
import Parts from '@site/static/auto-generated/accordion/parts.md';
8-
import CustomProps from '@site/static/auto-generated/accordion/custom-props.md';
9-
import Slots from '@site/static/auto-generated/accordion/slots.md';
4+
import Props from '@ionic-internal/component-api/v7/accordion/props.md';
5+
import Events from '@ionic-internal/component-api/v7/accordion/events.md';
6+
import Methods from '@ionic-internal/component-api/v7/accordion/methods.md';
7+
import Parts from '@ionic-internal/component-api/v7/accordion/parts.md';
8+
import CustomProps from '@ionic-internal/component-api/v7/accordion/custom-props.md';
9+
import Slots from '@ionic-internal/component-api/v7/accordion/slots.md';
1010

1111
<head>
1212
<title>Ion-Accordion Components: How to Build & Examples | Ionic</title>

docs/api/action-sheet.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: "ion-action-sheet"
33
---
4-
import Props from '@site/static/auto-generated/action-sheet/props.md';
5-
import Events from '@site/static/auto-generated/action-sheet/events.md';
6-
import Methods from '@site/static/auto-generated/action-sheet/methods.md';
7-
import Parts from '@site/static/auto-generated/action-sheet/parts.md';
8-
import CustomProps from '@site/static/auto-generated/action-sheet/custom-props.md';
9-
import Slots from '@site/static/auto-generated/action-sheet/slots.md';
4+
import Props from '@ionic-internal/component-api/v7/action-sheet/props.md';
5+
import Events from '@ionic-internal/component-api/v7/action-sheet/events.md';
6+
import Methods from '@ionic-internal/component-api/v7/action-sheet/methods.md';
7+
import Parts from '@ionic-internal/component-api/v7/action-sheet/parts.md';
8+
import CustomProps from '@ionic-internal/component-api/v7/action-sheet/custom-props.md';
9+
import Slots from '@ionic-internal/component-api/v7/action-sheet/slots.md';
1010

1111
<head>
1212
<title>ion-action-sheet | Action Sheet Dialog for iOS and Android Apps</title>

docs/api/alert.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ title: "ion-alert"
44
import Tabs from '@theme/Tabs';
55
import TabItem from '@theme/TabItem';
66

7-
import Props from '@site/static/auto-generated/alert/props.md';
8-
import Events from '@site/static/auto-generated/alert/events.md';
9-
import Methods from '@site/static/auto-generated/alert/methods.md';
10-
import Parts from '@site/static/auto-generated/alert/parts.md';
11-
import CustomProps from '@site/static/auto-generated/alert/custom-props.md';
12-
import Slots from '@site/static/auto-generated/alert/slots.md';
7+
import Props from '@ionic-internal/component-api/v7/alert/props.md';
8+
import Events from '@ionic-internal/component-api/v7/alert/events.md';
9+
import Methods from '@ionic-internal/component-api/v7/alert/methods.md';
10+
import Parts from '@ionic-internal/component-api/v7/alert/parts.md';
11+
import CustomProps from '@ionic-internal/component-api/v7/alert/custom-props.md';
12+
import Slots from '@ionic-internal/component-api/v7/alert/slots.md';
1313

1414
<head>
1515
<title>ion-alert: Ionic API Alert Buttons with Custom Message Prompts</title>

docs/api/app.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: "ion-app"
33
---
4-
import Props from '@site/static/auto-generated/app/props.md';
5-
import Events from '@site/static/auto-generated/app/events.md';
6-
import Methods from '@site/static/auto-generated/app/methods.md';
7-
import Parts from '@site/static/auto-generated/app/parts.md';
8-
import CustomProps from '@site/static/auto-generated/app/custom-props.md';
9-
import Slots from '@site/static/auto-generated/app/slots.md';
4+
import Props from '@ionic-internal/component-api/v7/app/props.md';
5+
import Events from '@ionic-internal/component-api/v7/app/events.md';
6+
import Methods from '@ionic-internal/component-api/v7/app/methods.md';
7+
import Parts from '@ionic-internal/component-api/v7/app/parts.md';
8+
import CustomProps from '@ionic-internal/component-api/v7/app/custom-props.md';
9+
import Slots from '@ionic-internal/component-api/v7/app/slots.md';
1010

1111
<head>
1212
<title>ion-app: Container Element for an Ionic Application</title>

docs/api/avatar.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
title: "ion-avatar"
33
---
44

5-
import Props from '@site/static/auto-generated/avatar/props.md';
6-
import Events from '@site/static/auto-generated/avatar/events.md';
7-
import Methods from '@site/static/auto-generated/avatar/methods.md';
8-
import Parts from '@site/static/auto-generated/avatar/parts.md';
9-
import CustomProps from '@site/static/auto-generated/avatar/custom-props.md';
10-
import Slots from '@site/static/auto-generated/avatar/slots.md';
5+
import Props from '@ionic-internal/component-api/v7/avatar/props.md';
6+
import Events from '@ionic-internal/component-api/v7/avatar/events.md';
7+
import Methods from '@ionic-internal/component-api/v7/avatar/methods.md';
8+
import Parts from '@ionic-internal/component-api/v7/avatar/parts.md';
9+
import CustomProps from '@ionic-internal/component-api/v7/avatar/custom-props.md';
10+
import Slots from '@ionic-internal/component-api/v7/avatar/slots.md';
1111

1212
<head>
1313
<title>ion-avatar: Circular Application Avatar Icon Component</title>

docs/api/back-button.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: "ion-back-button"
33
---
4-
import Props from '@site/static/auto-generated/back-button/props.md';
5-
import Events from '@site/static/auto-generated/back-button/events.md';
6-
import Methods from '@site/static/auto-generated/back-button/methods.md';
7-
import Parts from '@site/static/auto-generated/back-button/parts.md';
8-
import CustomProps from '@site/static/auto-generated/back-button/custom-props.md';
9-
import Slots from '@site/static/auto-generated/back-button/slots.md';
4+
import Props from '@ionic-internal/component-api/v7/back-button/props.md';
5+
import Events from '@ionic-internal/component-api/v7/back-button/events.md';
6+
import Methods from '@ionic-internal/component-api/v7/back-button/methods.md';
7+
import Parts from '@ionic-internal/component-api/v7/back-button/parts.md';
8+
import CustomProps from '@ionic-internal/component-api/v7/back-button/custom-props.md';
9+
import Slots from '@ionic-internal/component-api/v7/back-button/slots.md';
1010

1111
<head>
1212
<title>Back Button | ion-back-button: Custom Menu Icon for Applications</title>

docs/api/backdrop.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: "ion-backdrop"
33
---
4-
import Props from '@site/static/auto-generated/backdrop/props.md';
5-
import Events from '@site/static/auto-generated/backdrop/events.md';
6-
import Methods from '@site/static/auto-generated/backdrop/methods.md';
7-
import Parts from '@site/static/auto-generated/backdrop/parts.md';
8-
import CustomProps from '@site/static/auto-generated/backdrop/custom-props.md';
9-
import Slots from '@site/static/auto-generated/backdrop/slots.md';
4+
import Props from '@ionic-internal/component-api/v7/backdrop/props.md';
5+
import Events from '@ionic-internal/component-api/v7/backdrop/events.md';
6+
import Methods from '@ionic-internal/component-api/v7/backdrop/methods.md';
7+
import Parts from '@ionic-internal/component-api/v7/backdrop/parts.md';
8+
import CustomProps from '@ionic-internal/component-api/v7/backdrop/custom-props.md';
9+
import Slots from '@ionic-internal/component-api/v7/backdrop/slots.md';
1010

1111
import EncapsulationPill from '@components/page/api/EncapsulationPill';
1212

docs/api/badge.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: "ion-badge"
33
---
4-
import Props from '@site/static/auto-generated/badge/props.md';
5-
import Events from '@site/static/auto-generated/badge/events.md';
6-
import Methods from '@site/static/auto-generated/badge/methods.md';
7-
import Parts from '@site/static/auto-generated/badge/parts.md';
8-
import CustomProps from '@site/static/auto-generated/badge/custom-props.md';
9-
import Slots from '@site/static/auto-generated/badge/slots.md';
4+
import Props from '@ionic-internal/component-api/v7/badge/props.md';
5+
import Events from '@ionic-internal/component-api/v7/badge/events.md';
6+
import Methods from '@ionic-internal/component-api/v7/badge/methods.md';
7+
import Parts from '@ionic-internal/component-api/v7/badge/parts.md';
8+
import CustomProps from '@ionic-internal/component-api/v7/badge/custom-props.md';
9+
import Slots from '@ionic-internal/component-api/v7/badge/slots.md';
1010

1111
<head>
1212
<title>Badges | ion-badge: iOS & Android App Notification Badge Icons</title>

docs/api/breadcrumb.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: "ion-breadcrumb"
33
---
4-
import Props from '@site/static/auto-generated/breadcrumb/props.md';
5-
import Events from '@site/static/auto-generated/breadcrumb/events.md';
6-
import Methods from '@site/static/auto-generated/breadcrumb/methods.md';
7-
import Parts from '@site/static/auto-generated/breadcrumb/parts.md';
8-
import CustomProps from '@site/static/auto-generated/breadcrumb/custom-props.md';
9-
import Slots from '@site/static/auto-generated/breadcrumb/slots.md';
4+
import Props from '@ionic-internal/component-api/v7/breadcrumb/props.md';
5+
import Events from '@ionic-internal/component-api/v7/breadcrumb/events.md';
6+
import Methods from '@ionic-internal/component-api/v7/breadcrumb/methods.md';
7+
import Parts from '@ionic-internal/component-api/v7/breadcrumb/parts.md';
8+
import CustomProps from '@ionic-internal/component-api/v7/breadcrumb/custom-props.md';
9+
import Slots from '@ionic-internal/component-api/v7/breadcrumb/slots.md';
1010

1111
import EncapsulationPill from '@components/page/api/EncapsulationPill';
1212

docs/api/breadcrumbs.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: "ion-breadcrumbs"
33
---
4-
import Props from '@site/static/auto-generated/breadcrumbs/props.md';
5-
import Events from '@site/static/auto-generated/breadcrumbs/events.md';
6-
import Methods from '@site/static/auto-generated/breadcrumbs/methods.md';
7-
import Parts from '@site/static/auto-generated/breadcrumbs/parts.md';
8-
import CustomProps from '@site/static/auto-generated/breadcrumbs/custom-props.md';
9-
import Slots from '@site/static/auto-generated/breadcrumbs/slots.md';
4+
import Props from '@ionic-internal/component-api/v7/breadcrumbs/props.md';
5+
import Events from '@ionic-internal/component-api/v7/breadcrumbs/events.md';
6+
import Methods from '@ionic-internal/component-api/v7/breadcrumbs/methods.md';
7+
import Parts from '@ionic-internal/component-api/v7/breadcrumbs/parts.md';
8+
import CustomProps from '@ionic-internal/component-api/v7/breadcrumbs/custom-props.md';
9+
import Slots from '@ionic-internal/component-api/v7/breadcrumbs/slots.md';
1010

1111

1212

docs/api/button.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: "ion-button"
33
---
4-
import Props from '@site/static/auto-generated/button/props.md';
5-
import Events from '@site/static/auto-generated/button/events.md';
6-
import Methods from '@site/static/auto-generated/button/methods.md';
7-
import Parts from '@site/static/auto-generated/button/parts.md';
8-
import CustomProps from '@site/static/auto-generated/button/custom-props.md';
9-
import Slots from '@site/static/auto-generated/button/slots.md';
4+
import Props from '@ionic-internal/component-api/v7/button/props.md';
5+
import Events from '@ionic-internal/component-api/v7/button/events.md';
6+
import Methods from '@ionic-internal/component-api/v7/button/methods.md';
7+
import Parts from '@ionic-internal/component-api/v7/button/parts.md';
8+
import CustomProps from '@ionic-internal/component-api/v7/button/custom-props.md';
9+
import Slots from '@ionic-internal/component-api/v7/button/slots.md';
1010

1111
<head>
1212
<title>ion-button: Design and Style Buttons with Custom CSS Properties</title>

docs/api/buttons.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: "ion-buttons"
33
---
4-
import Props from '@site/static/auto-generated/buttons/props.md';
5-
import Events from '@site/static/auto-generated/buttons/events.md';
6-
import Methods from '@site/static/auto-generated/buttons/methods.md';
7-
import Parts from '@site/static/auto-generated/buttons/parts.md';
8-
import CustomProps from '@site/static/auto-generated/buttons/custom-props.md';
9-
import Slots from '@site/static/auto-generated/buttons/slots.md';
4+
import Props from '@ionic-internal/component-api/v7/buttons/props.md';
5+
import Events from '@ionic-internal/component-api/v7/buttons/events.md';
6+
import Methods from '@ionic-internal/component-api/v7/buttons/methods.md';
7+
import Parts from '@ionic-internal/component-api/v7/buttons/parts.md';
8+
import CustomProps from '@ionic-internal/component-api/v7/buttons/custom-props.md';
9+
import Slots from '@ionic-internal/component-api/v7/buttons/slots.md';
1010

1111
<head>
1212
<title>ion-buttons: Toolbar Element with Named Slots for Buttons</title>

docs/api/card-content.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: "ion-card-content"
33
---
4-
import Props from '@site/static/auto-generated/card-content/props.md';
5-
import Events from '@site/static/auto-generated/card-content/events.md';
6-
import Methods from '@site/static/auto-generated/card-content/methods.md';
7-
import Parts from '@site/static/auto-generated/card-content/parts.md';
8-
import CustomProps from '@site/static/auto-generated/card-content/custom-props.md';
9-
import Slots from '@site/static/auto-generated/card-content/slots.md';
4+
import Props from '@ionic-internal/component-api/v7/card-content/props.md';
5+
import Events from '@ionic-internal/component-api/v7/card-content/events.md';
6+
import Methods from '@ionic-internal/component-api/v7/card-content/methods.md';
7+
import Parts from '@ionic-internal/component-api/v7/card-content/parts.md';
8+
import CustomProps from '@ionic-internal/component-api/v7/card-content/custom-props.md';
9+
import Slots from '@ionic-internal/component-api/v7/card-content/slots.md';
1010

1111
import EncapsulationPill from '@components/page/api/EncapsulationPill';
1212

docs/api/card-header.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: "ion-card-header"
33
---
4-
import Props from '@site/static/auto-generated/card-header/props.md';
5-
import Events from '@site/static/auto-generated/card-header/events.md';
6-
import Methods from '@site/static/auto-generated/card-header/methods.md';
7-
import Parts from '@site/static/auto-generated/card-header/parts.md';
8-
import CustomProps from '@site/static/auto-generated/card-header/custom-props.md';
9-
import Slots from '@site/static/auto-generated/card-header/slots.md';
4+
import Props from '@ionic-internal/component-api/v7/card-header/props.md';
5+
import Events from '@ionic-internal/component-api/v7/card-header/events.md';
6+
import Methods from '@ionic-internal/component-api/v7/card-header/methods.md';
7+
import Parts from '@ionic-internal/component-api/v7/card-header/parts.md';
8+
import CustomProps from '@ionic-internal/component-api/v7/card-header/custom-props.md';
9+
import Slots from '@ionic-internal/component-api/v7/card-header/slots.md';
1010

1111
import EncapsulationPill from '@components/page/api/EncapsulationPill';
1212

docs/api/card-subtitle.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: "ion-card-subtitle"
33
---
4-
import Props from '@site/static/auto-generated/card-subtitle/props.md';
5-
import Events from '@site/static/auto-generated/card-subtitle/events.md';
6-
import Methods from '@site/static/auto-generated/card-subtitle/methods.md';
7-
import Parts from '@site/static/auto-generated/card-subtitle/parts.md';
8-
import CustomProps from '@site/static/auto-generated/card-subtitle/custom-props.md';
9-
import Slots from '@site/static/auto-generated/card-subtitle/slots.md';
4+
import Props from '@ionic-internal/component-api/v7/card-subtitle/props.md';
5+
import Events from '@ionic-internal/component-api/v7/card-subtitle/events.md';
6+
import Methods from '@ionic-internal/component-api/v7/card-subtitle/methods.md';
7+
import Parts from '@ionic-internal/component-api/v7/card-subtitle/parts.md';
8+
import CustomProps from '@ionic-internal/component-api/v7/card-subtitle/custom-props.md';
9+
import Slots from '@ionic-internal/component-api/v7/card-subtitle/slots.md';
1010

1111
import EncapsulationPill from '@components/page/api/EncapsulationPill';
1212

docs/api/card-title.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: "ion-card-title"
33
---
4-
import Props from '@site/static/auto-generated/card-title/props.md';
5-
import Events from '@site/static/auto-generated/card-title/events.md';
6-
import Methods from '@site/static/auto-generated/card-title/methods.md';
7-
import Parts from '@site/static/auto-generated/card-title/parts.md';
8-
import CustomProps from '@site/static/auto-generated/card-title/custom-props.md';
9-
import Slots from '@site/static/auto-generated/card-title/slots.md';
4+
import Props from '@ionic-internal/component-api/v7/card-title/props.md';
5+
import Events from '@ionic-internal/component-api/v7/card-title/events.md';
6+
import Methods from '@ionic-internal/component-api/v7/card-title/methods.md';
7+
import Parts from '@ionic-internal/component-api/v7/card-title/parts.md';
8+
import CustomProps from '@ionic-internal/component-api/v7/card-title/custom-props.md';
9+
import Slots from '@ionic-internal/component-api/v7/card-title/slots.md';
1010

1111
import EncapsulationPill from '@components/page/api/EncapsulationPill';
1212

docs/api/card.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: "ion-card"
33
---
4-
import Props from '@site/static/auto-generated/card/props.md';
5-
import Events from '@site/static/auto-generated/card/events.md';
6-
import Methods from '@site/static/auto-generated/card/methods.md';
7-
import Parts from '@site/static/auto-generated/card/parts.md';
8-
import CustomProps from '@site/static/auto-generated/card/custom-props.md';
9-
import Slots from '@site/static/auto-generated/card/slots.md';
4+
import Props from '@ionic-internal/component-api/v7/card/props.md';
5+
import Events from '@ionic-internal/component-api/v7/card/events.md';
6+
import Methods from '@ionic-internal/component-api/v7/card/methods.md';
7+
import Parts from '@ionic-internal/component-api/v7/card/parts.md';
8+
import CustomProps from '@ionic-internal/component-api/v7/card/custom-props.md';
9+
import Slots from '@ionic-internal/component-api/v7/card/slots.md';
1010

1111
import EncapsulationPill from '@components/page/api/EncapsulationPill';
1212

docs/api/checkbox.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
title: "ion-checkbox"
33
---
44

5-
import Props from '@site/static/auto-generated/checkbox/props.md';
6-
import Events from '@site/static/auto-generated/checkbox/events.md';
7-
import Methods from '@site/static/auto-generated/checkbox/methods.md';
8-
import Parts from '@site/static/auto-generated/checkbox/parts.md';
9-
import CustomProps from '@site/static/auto-generated/checkbox/custom-props.md';
10-
import Slots from '@site/static/auto-generated/checkbox/slots.md';
5+
import Props from '@ionic-internal/component-api/v7/checkbox/props.md';
6+
import Events from '@ionic-internal/component-api/v7/checkbox/events.md';
7+
import Methods from '@ionic-internal/component-api/v7/checkbox/methods.md';
8+
import Parts from '@ionic-internal/component-api/v7/checkbox/parts.md';
9+
import CustomProps from '@ionic-internal/component-api/v7/checkbox/custom-props.md';
10+
import Slots from '@ionic-internal/component-api/v7/checkbox/slots.md';
1111

1212
<head>
1313
<title>ion-checkboxes: Ionic App Component to Select Multiple Options</title>

0 commit comments

Comments
 (0)