Skip to content

Commit 1307564

Browse files
committed
chore: version the docs for ionic 9
1 parent 1eaadf0 commit 1307564

File tree

3,749 files changed

+163764
-1015
lines changed

Some content is hidden

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

3,749 files changed

+163764
-1015
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 '@ionic-internal/component-api/v8/accordion-group/props.md';
5-
import Events from '@ionic-internal/component-api/v8/accordion-group/events.md';
6-
import Methods from '@ionic-internal/component-api/v8/accordion-group/methods.md';
7-
import Parts from '@ionic-internal/component-api/v8/accordion-group/parts.md';
8-
import CustomProps from '@ionic-internal/component-api/v8/accordion-group/custom-props.mdx';
9-
import Slots from '@ionic-internal/component-api/v8/accordion-group/slots.md';
4+
import Props from '@ionic-internal/component-api/v9/accordion-group/props.md';
5+
import Events from '@ionic-internal/component-api/v9/accordion-group/events.md';
6+
import Methods from '@ionic-internal/component-api/v9/accordion-group/methods.md';
7+
import Parts from '@ionic-internal/component-api/v9/accordion-group/parts.md';
8+
import CustomProps from '@ionic-internal/component-api/v9/accordion-group/custom-props.mdx';
9+
import Slots from '@ionic-internal/component-api/v9/accordion-group/slots.md';
1010

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

docs/api/accordion.md

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

1111
<head>
1212
<title>ion-accordion: Accordion Components: How to Build & Examples</title>
@@ -22,15 +22,15 @@ Accordions provide collapsible sections in your content to reduce vertical space
2222

2323
## Basic Usage
2424

25-
import Basic from '@site/static/usage/v8/accordion/basic/index.md';
25+
import Basic from '@site/static/usage/v9/accordion/basic/index.md';
2626

2727
<Basic />
2828

2929
## Toggle Accordions
3030

3131
Which accordion is open is controlled by setting the `value` property on `ion-accordion-group`. Setting this property allows developers to programmatically expand or collapse certain accordions.
3232

33-
import Toggle from '@site/static/usage/v8/accordion/toggle/index.md';
33+
import Toggle from '@site/static/usage/v9/accordion/toggle/index.md';
3434

3535
<Toggle />
3636

@@ -44,15 +44,15 @@ When using other components that emit `ionChange` inside of Accordion it is reco
4444

4545
Developers can listen for the `ionChange` event to be notified when accordions expand or collapse.
4646

47-
import ListenChanges from '@site/static/usage/v8/accordion/listen-changes/index.md';
47+
import ListenChanges from '@site/static/usage/v9/accordion/listen-changes/index.md';
4848

4949
<ListenChanges />
5050

5151
## Multiple Accordions
5252

5353
Developers can allow multiple accordions to be open at once with the `multiple` property.
5454

55-
import Multiple from '@site/static/usage/v8/accordion/multiple/index.md';
55+
import Multiple from '@site/static/usage/v9/accordion/multiple/index.md';
5656

5757
<Multiple />
5858

@@ -62,15 +62,15 @@ import Multiple from '@site/static/usage/v8/accordion/multiple/index.md';
6262

6363
Individual accordions can be disabled with the `disabled` property on `ion-accordion`.
6464

65-
import DisableIndividual from '@site/static/usage/v8/accordion/disable/individual/index.md';
65+
import DisableIndividual from '@site/static/usage/v9/accordion/disable/individual/index.md';
6666

6767
<DisableIndividual />
6868

6969
### Accordion Group
7070

7171
The accordion group can be disabled with the `disabled` property on `ion-accordion-group`.
7272

73-
import DisableGroup from '@site/static/usage/v8/accordion/disable/group/index.md';
73+
import DisableGroup from '@site/static/usage/v9/accordion/disable/group/index.md';
7474

7575
<DisableGroup />
7676

@@ -80,15 +80,15 @@ import DisableGroup from '@site/static/usage/v8/accordion/disable/group/index.md
8080

8181
Individual accordions can be disabled with the `readonly` property on `ion-accordion`.
8282

83-
import ReadonlyIndividual from '@site/static/usage/v8/accordion/readonly/individual/index.md';
83+
import ReadonlyIndividual from '@site/static/usage/v9/accordion/readonly/individual/index.md';
8484

8585
<ReadonlyIndividual />
8686

8787
### Accordion Group
8888

8989
The accordion group can be disabled with the `readonly` property on `ion-accordion-group`.
9090

91-
import ReadonlyGroup from '@site/static/usage/v8/accordion/readonly/group/index.md';
91+
import ReadonlyGroup from '@site/static/usage/v9/accordion/readonly/group/index.md';
9292

9393
<ReadonlyGroup />
9494

@@ -112,7 +112,7 @@ There are two built in expansion styles: `compact` and `inset`. This expansion s
112112

113113
When `expand="inset"`, the accordion group is given a border radius. On `md` mode, the entire accordion will shift down when it is opened.
114114

115-
import ExpansionStyles from '@site/static/usage/v8/accordion/customization/expansion-styles/index.md';
115+
import ExpansionStyles from '@site/static/usage/v9/accordion/customization/expansion-styles/index.md';
116116

117117
<ExpansionStyles />
118118

@@ -136,7 +136,7 @@ ion-accordion.accordion-expanded ion-item[slot="header"] {
136136
}
137137
```
138138

139-
import AdvancedExpansionStyles from '@site/static/usage/v8/accordion/customization/advanced-expansion-styles/index.md';
139+
import AdvancedExpansionStyles from '@site/static/usage/v9/accordion/customization/advanced-expansion-styles/index.md';
140140

141141
<AdvancedExpansionStyles />
142142

@@ -148,15 +148,15 @@ If you would like to manage the icon yourself or use an icon that is not an `ion
148148

149149
Regardless of which option you choose, the icon will automatically be rotated when you expand or collapse the accordion.
150150

151-
import Icons from '@site/static/usage/v8/accordion/customization/icons/index.md';
151+
import Icons from '@site/static/usage/v9/accordion/customization/icons/index.md';
152152

153153
<Icons />
154154

155155
### Theming
156156

157157
Since `ion-accordion` acts as a shell around the header and content elements, you can easily theme the accordion however you would like. You can theme the header by targeting the slotted `ion-item`. Since you are using `ion-item`, you also have access to all of the [ion-item CSS Variables](./item#css-custom-properties) and [ion-item Shadow Parts](./item#css-shadow-parts). Theming the content is also easily achieved by targeting the element that is in the `content` slot.
158158

159-
import Theming from '@site/static/usage/v8/accordion/customization/theming/index.md';
159+
import Theming from '@site/static/usage/v9/accordion/customization/theming/index.md';
160160

161161
<Theming />
162162

@@ -166,7 +166,7 @@ import Theming from '@site/static/usage/v8/accordion/customization/theming/index
166166

167167
By default, animations are enabled when expanding or collapsing an accordion item. Animations will be automatically disabled when the `prefers-reduced-motion` media query is supported and set to `reduce`. For browsers that do not support this, animations can be disabled by setting the `animated` config in your Ionic Framework app.
168168

169-
import AccessibilityAnimations from '@site/static/usage/v8/accordion/accessibility/animations/index.md';
169+
import AccessibilityAnimations from '@site/static/usage/v9/accordion/accessibility/animations/index.md';
170170

171171
<AccessibilityAnimations />
172172

docs/api/action-sheet.md

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

7-
import Props from '@ionic-internal/component-api/v8/action-sheet/props.md';
8-
import Events from '@ionic-internal/component-api/v8/action-sheet/events.md';
9-
import Methods from '@ionic-internal/component-api/v8/action-sheet/methods.md';
10-
import Parts from '@ionic-internal/component-api/v8/action-sheet/parts.md';
11-
import CustomProps from '@ionic-internal/component-api/v8/action-sheet/custom-props.mdx';
12-
import Slots from '@ionic-internal/component-api/v8/action-sheet/slots.md';
7+
import Props from '@ionic-internal/component-api/v9/action-sheet/props.md';
8+
import Events from '@ionic-internal/component-api/v9/action-sheet/events.md';
9+
import Methods from '@ionic-internal/component-api/v9/action-sheet/methods.md';
10+
import Parts from '@ionic-internal/component-api/v9/action-sheet/parts.md';
11+
import CustomProps from '@ionic-internal/component-api/v9/action-sheet/custom-props.mdx';
12+
import Slots from '@ionic-internal/component-api/v9/action-sheet/slots.md';
1313

1414
<head>
1515
<title>ion-action-sheet: Action Sheet Dialog for iOS and Android</title>
@@ -27,7 +27,7 @@ An Action Sheet is a dialog that displays a set of options. It appears on top of
2727

2828
`ion-action-sheet` can be used by writing the component directly in your template. This reduces the number of handlers you need to wire up in order to present the Action Sheet.
2929

30-
import Trigger from '@site/static/usage/v8/action-sheet/inline/trigger/index.md';
30+
import Trigger from '@site/static/usage/v9/action-sheet/inline/trigger/index.md';
3131

3232
<Trigger />
3333

@@ -37,15 +37,15 @@ The `isOpen` property on `ion-action-sheet` allows developers to control the pre
3737

3838
`isOpen` uses a one-way data binding, meaning it will not automatically be set to `false` when the Action Sheet is dismissed. Developers should listen for the `ionActionSheetDidDismiss` or `didDismiss` event and set `isOpen` to `false`. The reason for this is it prevents the internals of `ion-action-sheet` from being tightly coupled with the state of the application. With a one way data binding, the Action Sheet only needs to concern itself with the boolean value that the reactive variable provides. With a two way data binding, the Action Sheet needs to concern itself with both the boolean value as well as the existence of the reactive variable itself. This can lead to non-deterministic behaviors and make applications harder to debug.
3939

40-
import IsOpen from '@site/static/usage/v8/action-sheet/inline/isOpen/index.md';
40+
import IsOpen from '@site/static/usage/v9/action-sheet/inline/isOpen/index.md';
4141

4242
<IsOpen />
4343

4444
## Controller Action Sheets
4545

4646
The `actionSheetController` can be used in situations where more control is needed over when the Action Sheet is presented and dismissed.
4747

48-
import Controller from '@site/static/usage/v8/action-sheet/controller/index.md';
48+
import Controller from '@site/static/usage/v9/action-sheet/controller/index.md';
4949

5050
<Controller />
5151

@@ -59,7 +59,7 @@ A button can also be passed data via the `data` property on `ActionSheetButton`.
5959

6060
When the `didDismiss` event is fired, the `data` and `role` fields of the event detail can be used to gather information about how the Action Sheet was dismissed.
6161

62-
import RoleInfo from '@site/static/usage/v8/action-sheet/role-info-on-dismiss/index.md';
62+
import RoleInfo from '@site/static/usage/v9/action-sheet/role-info-on-dismiss/index.md';
6363

6464
<RoleInfo />
6565

@@ -83,15 +83,15 @@ We recommend passing a custom class to `cssClass` in the `create` method and usi
8383
}
8484
```
8585

86-
import Styling from '@site/static/usage/v8/action-sheet/theming/styling/index.md';
86+
import Styling from '@site/static/usage/v9/action-sheet/theming/styling/index.md';
8787

8888
<Styling />
8989

9090
### CSS Custom Properties
9191

9292
Any of the defined [CSS Custom Properties](#css-custom-properties-1) can be used to style the Action Sheet without needing to target individual elements.
9393

94-
import CssCustomProperties from '@site/static/usage/v8/action-sheet/theming/css-properties/index.md';
94+
import CssCustomProperties from '@site/static/usage/v9/action-sheet/theming/css-properties/index.md';
9595

9696
<CssCustomProperties />
9797

docs/api/alert.md

Lines changed: 13 additions & 13 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 '@ionic-internal/component-api/v8/alert/props.md';
8-
import Events from '@ionic-internal/component-api/v8/alert/events.md';
9-
import Methods from '@ionic-internal/component-api/v8/alert/methods.md';
10-
import Parts from '@ionic-internal/component-api/v8/alert/parts.md';
11-
import CustomProps from '@ionic-internal/component-api/v8/alert/custom-props.mdx';
12-
import Slots from '@ionic-internal/component-api/v8/alert/slots.md';
7+
import Props from '@ionic-internal/component-api/v9/alert/props.md';
8+
import Events from '@ionic-internal/component-api/v9/alert/events.md';
9+
import Methods from '@ionic-internal/component-api/v9/alert/methods.md';
10+
import Parts from '@ionic-internal/component-api/v9/alert/parts.md';
11+
import CustomProps from '@ionic-internal/component-api/v9/alert/custom-props.mdx';
12+
import Slots from '@ionic-internal/component-api/v9/alert/slots.md';
1313

1414
<head>
1515
<title>ion-alert: Ionic Alert Buttons with Custom Message Prompts</title>
@@ -26,7 +26,7 @@ An Alert is a dialog that presents users with information or collects informatio
2626

2727
`ion-alert` can be used by writing the component directly in your template. This reduces the number of handlers you need to wire up in order to present the Alert.
2828

29-
import Trigger from '@site/static/usage/v8/alert/presenting/trigger/index.md';
29+
import Trigger from '@site/static/usage/v9/alert/presenting/trigger/index.md';
3030

3131
<Trigger />
3232

@@ -36,15 +36,15 @@ The `isOpen` property on `ion-alert` allows developers to control the presentati
3636

3737
`isOpen` uses a one-way data binding, meaning it will not automatically be set to `false` when the Alert is dismissed. Developers should listen for the `ionAlertDidDismiss` or `didDismiss` event and set `isOpen` to `false`. The reason for this is it prevents the internals of `ion-alert` from being tightly coupled with the state of the application. With a one way data binding, the Alert only needs to concern itself with the boolean value that the reactive variable provides. With a two way data binding, the Alert needs to concern itself with both the boolean value as well as the existence of the reactive variable itself. This can lead to non-deterministic behaviors and make applications harder to debug.
3838

39-
import IsOpen from '@site/static/usage/v8/alert/presenting/isOpen/index.md';
39+
import IsOpen from '@site/static/usage/v9/alert/presenting/isOpen/index.md';
4040

4141
<IsOpen />
4242

4343
## Controller Alerts
4444

4545
The `alertController` can be used in situations where more control is needed over when the Alert is presented and dismissed.
4646

47-
import Controller from '@site/static/usage/v8/alert/presenting/controller/index.md';
47+
import Controller from '@site/static/usage/v9/alert/presenting/controller/index.md';
4848

4949
<Controller />
5050

@@ -54,7 +54,7 @@ In the array of `buttons`, each button includes properties for its `text`, and o
5454

5555
Optionally, a `role` property can be added to a button, such as `cancel`. If a `cancel` role is on one of the buttons, then if the alert is dismissed by tapping the backdrop, then it will fire the handler from the button with a cancel role.
5656

57-
import Buttons from '@site/static/usage/v8/alert/buttons/index.md';
57+
import Buttons from '@site/static/usage/v9/alert/buttons/index.md';
5858

5959
<Buttons />
6060

@@ -65,13 +65,13 @@ Alerts can also include several different inputs whose data can be passed back t
6565

6666
### Text Inputs Example
6767

68-
import TextInputs from '@site/static/usage/v8/alert/inputs/text-inputs/index.md';
68+
import TextInputs from '@site/static/usage/v9/alert/inputs/text-inputs/index.md';
6969

7070
<TextInputs />
7171

7272
### Radio Example
7373

74-
import Radios from '@site/static/usage/v8/alert/inputs/radios/index.md';
74+
import Radios from '@site/static/usage/v9/alert/inputs/radios/index.md';
7575

7676
<Radios />
7777

@@ -101,7 +101,7 @@ Any of the defined [CSS Custom Properties](#css-custom-properties) can be used t
101101
}
102102
```
103103

104-
import Customization from '@site/static/usage/v8/alert/customization/index.md';
104+
import Customization from '@site/static/usage/v9/alert/customization/index.md';
105105

106106
<Customization />
107107

docs/api/app.md

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

1111
<head>
1212
<title>ion-app: Container Element for an Ionic Application</title>
@@ -30,7 +30,7 @@ Using `ion-app` enables the following behaviors:
3030

3131
Ionic offers focus utilities for components with the `ion-focusable` class. These utilities automatically manage focus for components when certain keyboard keys, like <kbd>Tab</kbd>, are pressed. Components can also be programmatically focused in response to user actions using the `setFocus` method from `ion-app`.
3232

33-
import SetFocus from '@site/static/usage/v8/app/set-focus/index.md';
33+
import SetFocus from '@site/static/usage/v9/app/set-focus/index.md';
3434

3535
<SetFocus />
3636

docs/api/avatar.md

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

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

1212
<head>
1313
<title>ion-avatar: Circular Application Avatar Icon Component</title>
@@ -24,27 +24,27 @@ Avatars can be used by themselves or inside of any element. If placed inside of
2424

2525
## Basic Usage
2626

27-
import Basic from '@site/static/usage/v8/avatar/basic/index.md';
27+
import Basic from '@site/static/usage/v9/avatar/basic/index.md';
2828

2929
<Basic />
3030

3131
## Chip Avatar
3232

33-
import Chip from '@site/static/usage/v8/avatar/chip/index.md';
33+
import Chip from '@site/static/usage/v9/avatar/chip/index.md';
3434

3535
<Chip />
3636

3737
## Item Avatar
3838

39-
import Item from '@site/static/usage/v8/avatar/item/index.md';
39+
import Item from '@site/static/usage/v9/avatar/item/index.md';
4040

4141
<Item />
4242

4343
## Theming
4444

4545
### CSS Custom Properties
4646

47-
import CSSProps from '@site/static/usage/v8/avatar/theming/css-properties/index.md';
47+
import CSSProps from '@site/static/usage/v9/avatar/theming/css-properties/index.md';
4848

4949
<CSSProps />
5050

0 commit comments

Comments
 (0)