Skip to content

docs(api): use v8 demos instead of v7 demos for latest playgrounds #3759

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 19, 2024
Merged

docs(api): use v8 demos instead of v7 demos for latest playgrounds #3759

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa35305
docs(radio): copy using-comparewith v7 demo to v8
brandyscarney Jul 19, 2024
2ca7bc8
docs(toast): copy swipe-gesture v7 demo to v8
brandyscarney Jul 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/api/radio.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ import LabelPlacement from '@site/static/usage/v8/radio/label-placement/index.md

By default, the radio group uses strict equality (`===`) to determine if an option is selected. This can be overridden by providing a property name or a function to the `compareWith` property.

import UsingComparewith from '@site/static/usage/v7/radio/using-comparewith/index.md';
import UsingComparewith from '@site/static/usage/v8/radio/using-comparewith/index.md';

<UsingComparewith />

Expand Down Expand Up @@ -110,7 +110,7 @@ Using the modern syntax involves removing the `ion-label` and passing the label
import Migration from '@site/static/usage/v8/radio/migration/index.md';

<Migration />


:::note
In past versions of Ionic, `ion-item` was required for `ion-radio` to function properly. Starting in Ionic 7.0, `ion-radio` should only be used in an `ion-item` when the item is placed in an `ion-list`. Additionally, `ion-item` is no longer required for `ion-radio` to function properly.
Expand Down
4 changes: 2 additions & 2 deletions docs/api/toast.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,10 @@ import PositionAnchor from '@site/static/usage/v8/toast/position-anchor/index.md

Toasts can be swiped to dismiss by using the `swipeGesture` property. This feature is position-aware, meaning the direction that users need to swipe will change based on the value of the `position` property. Additionally, the distance users need to swipe may be impacted by the `positionAnchor` property.

import SwipeGesture from '@site/static/usage/v7/toast/swipe-gesture/index.md';
import SwipeGesture from '@site/static/usage/v8/toast/swipe-gesture/index.md';

<SwipeGesture />

## Layout

Button containers within the toast can be displayed either on the same line as the message or stacked on separate lines using the `layout` property. The stacked layout should be used with buttons that have long text values. Additionally, buttons in a stacked toast layout can use a `side` value of either `start` or `end`, but not both.
Expand Down
9 changes: 9 additions & 0 deletions static/usage/v8/radio/using-comparewith/angular/example_component_html.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
```html
<ion-list>
<ion-radio-group [compareWith]="compareWith" (ionChange)="handleChange($event)">
<ion-item *ngFor="let food of foods; trackBy: trackItems">
<ion-radio [value]="food">{{ food.name }}</ion-radio>
</ion-item>
</ion-radio-group>
</ion-list>
```
39 changes: 39 additions & 0 deletions static/usage/v8/radio/using-comparewith/angular/example_component_ts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
```ts
import { Component } from '@angular/core';

@Component({
selector: 'app-example',
templateUrl: 'example.component.html',
})
export class ExampleComponent {
foods = [
{
id: 1,
name: 'Apples',
type: 'fruit',
},
{
id: 2,
name: 'Carrots',
type: 'vegetable',
},
{
id: 3,
name: 'Cupcakes',
type: 'dessert',
},
];

compareWith(o1, o2) {
return o1.id === o2.id;
}

handleChange(ev) {
console.log('Current value:', JSON.stringify(ev.target.value));
}

trackItems(index: number, item: any) {
return item.id;
}
}
```
67 changes: 67 additions & 0 deletions static/usage/v8/radio/using-comparewith/demo.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Radio</title>
<link rel="stylesheet" href="../../common.css" />
<script src="../../common.js"></script>
<script type="module" src="https://cdn.jsdelivr.net/npm/@ionic/core@8/dist/ionic/ionic.esm.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@ionic/core@8/css/ionic.bundle.css" />
</head>

<body>
<ion-app>
<ion-content>
<div class="container">
<ion-list>
<ion-radio-group></ion-radio-group>
</ion-list>
</div>
</ion-content>
</ion-app>

<script>
const foods = [
{
id: 1,
name: 'Apples',
type: 'fruit',
},
{
id: 2,
name: 'Carrots',
type: 'vegetable',
},
{
id: 3,
name: 'Cupcakes',
type: 'dessert',
},
];

const compareWithFn = (o1, o2) => {
return o1.id === o2.id;
};

const radioGroupEl = document.querySelector('ion-radio-group');
radioGroupEl.compareWith = compareWithFn;

foods.forEach((option, i) => {
const radio = document.createElement('ion-radio');

radio.value = option;
radio.textContent = option.name;

const item = document.createElement('ion-item');
item.appendChild(radio);

radioGroupEl.appendChild(item);
});

radioGroupEl.addEventListener('ionChange', () => {
console.log('Current value:', JSON.stringify(radioGroupEl.value));
});
</script>
</body>
</html>
25 changes: 25 additions & 0 deletions static/usage/v8/radio/using-comparewith/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import Playground from '@site/src/components/global/Playground';

import javascript from './javascript.md';
import react from './react.md';
import vue from './vue.md';

import angular_example_component_html from './angular/example_component_html.md';
import angular_example_component_ts from './angular/example_component_ts.md';

<Playground
version="8"
code={{
javascript,
react,
vue,
angular: {
files: {
'src/app/example.component.html': angular_example_component_html,
'src/app/example.component.ts': angular_example_component_ts,
},
},
}}
src="usage/v8/radio/using-comparewith/demo.html"
showConsole={true}
/>
48 changes: 48 additions & 0 deletions static/usage/v8/radio/using-comparewith/javascript.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
```html
<ion-list>
<ion-radio-group></ion-radio-group>
</ion-list>

<script>
const foods = [
{
id: 1,
name: 'Apples',
type: 'fruit',
},
{
id: 2,
name: 'Carrots',
type: 'vegetable',
},
{
id: 3,
name: 'Cupcakes',
type: 'dessert',
},
];

const compareWithFn = (o1, o2) => {
return o1.id === o2.id;
};

const radioGroupEl = document.querySelector('ion-radio-group');
radioGroupEl.compareWith = compareWithFn;

foods.forEach((option, i) => {
const radio = document.createElement('ion-radio');

radio.value = option;
radio.textContent = option.name;

const item = document.createElement('ion-item');
item.appendChild(radio);

radioGroupEl.appendChild(item);
});

radioGroupEl.addEventListener('ionChange', () => {
console.log('Current value:', JSON.stringify(radioGroupEl.value));
});
</script>
```
52 changes: 52 additions & 0 deletions static/usage/v8/radio/using-comparewith/react.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
```tsx
import React from 'react';
import { IonItem, IonList, IonRadio, IonRadioGroup } from '@ionic/react';

interface Food {
id: number;
name: string;
type: string;
}

const foods: Food[] = [
{
id: 1,
name: 'Apples',
type: 'fruit',
},
{
id: 2,
name: 'Carrots',
type: 'vegetable',
},
{
id: 3,
name: 'Cupcakes',
type: 'dessert',
},
];

const compareWith = (o1: Food, o2: Food) => {
return o1.id === o2.id;
};

function Example() {
return (
<IonList>
<IonRadioGroup
compareWith={compareWith}
onIonChange={(ev) => console.log('Current value:', JSON.stringify(ev.detail.value))}
>
{foods.map((food) => (
<IonItem>
<IonRadio key={food.id} value={food}>
{food.name}
</IonRadio>
</IonItem>
))}
</IonRadioGroup>
</IonList>
);
}
export default Example;
```
54 changes: 54 additions & 0 deletions static/usage/v8/radio/using-comparewith/vue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
```html
<template>
<ion-list>
<ion-radio-group :compareWith="compareWith" @ionChange="handleChange($event)">
<ion-item v-for="food in foods">
<ion-radio :value="food">{{ food.name }}</ion-radio>
</ion-item>
</ion-radio-group>
</ion-list>
</template>

<script lang="ts">
import { IonItem, IonList, IonRadio, IonRadioGroup } from '@ionic/vue';
import { defineComponent } from 'vue';

export default defineComponent({
components: {
IonItem,
IonList,
IonRadio,
IonRadioGroup,
},
data() {
return {
foods: [
{
id: 1,
name: 'Apples',
type: 'fruit',
},
{
id: 2,
name: 'Carrots',
type: 'vegetable',
},
{
id: 3,
name: 'Cupcakes',
type: 'dessert',
},
],
};
},
methods: {
compareWith(o1, o2) {
return o1.id === o2.id;
},
handleChange(ev) {
console.log('Current value:', JSON.stringify(ev.detail.value));
},
},
});
</script>
```
17 changes: 17 additions & 0 deletions static/usage/v8/toast/swipe-gesture/angular.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
```html
<ion-content class="ion-padding">
<ion-button id="open-toast">Open Toast</ion-button>
<ion-toast
message="This toast can be swiped to dismiss"
trigger="open-toast"
swipeGesture="vertical"
position="bottom"
positionAnchor="footer"
></ion-toast>
</ion-content>
<ion-footer id="footer">
<ion-toolbar>
<ion-title>Footer</ion-title>
</ion-toolbar>
</ion-footer>
```
35 changes: 35 additions & 0 deletions static/usage/v8/toast/swipe-gesture/demo.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Toast</title>
<link rel="stylesheet" href="../../../common.css" />
<script src="../../../common.js"></script>
<script type="module" src="https://cdn.jsdelivr.net/npm/@ionic/core@8/dist/ionic/ionic.esm.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@ionic/core@8/css/ionic.bundle.css" />
</head>

<body>
<ion-app>
<ion-content>
<div class="container">
<ion-button id="open-toast">Open Toast</ion-button>
<ion-toast
message="This toast can be swiped to dismiss"
trigger="open-toast"
swipe-gesture="vertical"
position="bottom"
position-anchor="footer"
></ion-toast>
</div>
</ion-content>

<ion-footer id="footer">
<ion-toolbar>
<ion-title>Footer</ion-title>
</ion-toolbar>
</ion-footer>
</ion-app>
</body>
</html>
Loading