-
Notifications
You must be signed in to change notification settings - Fork 3.2k
docs(radio): add helperText and errorText section through radio-group #4034
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.
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
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
2047c7a
docs(radio): add helperText and errorText section through radio-group
thetaPC 0d6c0b7
chore(radio): use dev build
thetaPC d679d84
Update static/usage/v8/radio/helper-error/demo.html
thetaPC 81fe51e
Update static/usage/v8/radio/helper-error/demo.html
thetaPC 662fc1f
chore(radio): remove dev build
thetaPC File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| { | ||
| "dependencies": { | ||
| "@ionic/core": "8.4.1", | ||
| "@ionic/core": "8.4.4-dev.11741632207.1cb10db6", | ||
| "ionicons": "7.4.0" | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
18 changes: 18 additions & 0 deletions
18
static/usage/v8/radio/helper-error/angular/example_component_html.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| ```html | ||
| <form [formGroup]="myForm" (ngSubmit)="onSubmit()"> | ||
| <ion-radio-group | ||
| formControlName="favFruit" | ||
| helperText="Select your favorite fruit" | ||
| errorText="This field is required" | ||
| > | ||
| <ion-radio value="grapes">Grapes</ion-radio><br /> | ||
| <ion-radio value="strawberries">Strawberries</ion-radio><br /> | ||
| <ion-radio value="pineapple">Pineapple</ion-radio><br /> | ||
| <ion-radio value="cherries">Cherries</ion-radio> | ||
| </ion-radio-group> | ||
|
|
||
| <br /> | ||
|
|
||
| <ion-button type="submit" size="small">Submit</ion-button> | ||
| </form> | ||
| ``` |
29 changes: 29 additions & 0 deletions
29
static/usage/v8/radio/helper-error/angular/example_component_ts.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| ```ts | ||
| import { Component } from '@angular/core'; | ||
| import { FormBuilder, FormGroup, Validators, ReactiveFormsModule } from '@angular/forms'; | ||
| import { IonRadioGroup, IonRadio, IonButton } from '@ionic/angular/standalone'; | ||
|
|
||
| @Component({ | ||
| selector: 'app-example', | ||
| standalone: true, | ||
| imports: [IonRadioGroup, IonRadio, IonButton, ReactiveFormsModule], | ||
| templateUrl: './example.component.html', | ||
| styleUrl: './example.component.css', | ||
| }) | ||
| export class ExampleComponent { | ||
| myForm: FormGroup; | ||
|
|
||
| constructor(private fb: FormBuilder) { | ||
| this.myForm = this.fb.group({ | ||
| favFruit: ['', Validators.required], | ||
| }); | ||
| } | ||
|
|
||
| onSubmit() { | ||
| // Mark the control as touched to trigger the error message. | ||
| // This is needed if the user submits the form without interacting | ||
| // with the toggle. | ||
| this.myForm.get('favFruit')!.markAsTouched(); | ||
| } | ||
| } | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
| <title>Input</title> | ||
| <link rel="stylesheet" href="../../common.css" /> | ||
| <script src="../../common.js"></script> | ||
| <script | ||
| type="module" | ||
| src="https://cdn.jsdelivr.net/npm/@ionic/[email protected]/dist/ionic/ionic.esm.js" | ||
| ></script> | ||
| <link | ||
| rel="stylesheet" | ||
| href="https://cdn.jsdelivr.net/npm/@ionic/[email protected]/css/ionic.bundle.css" | ||
| /> | ||
| </head> | ||
thetaPC marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| <body> | ||
| <div class="container"> | ||
| <form id="my-form"> | ||
| <ion-radio-group helper-text="Select your favorite fruit" error-text="This field is required"> | ||
| <ion-radio value="grapes">Grapes</ion-radio><br /> | ||
| <ion-radio value="strawberries">Strawberries</ion-radio><br /> | ||
| <ion-radio value="pineapple">Pineapple</ion-radio><br /> | ||
| <ion-radio value="cherries">Cherries</ion-radio> | ||
| </ion-radio-group> | ||
|
|
||
| <br /> | ||
|
|
||
| <ion-button type="submit" size="small">Submit</ion-button> | ||
| </form> | ||
| </div> | ||
|
|
||
| <script> | ||
| const form = document.getElementById('my-form'); | ||
| const favFruit = form.querySelector('ion-radio-group'); | ||
|
|
||
| form.addEventListener('submit', (event) => submit(event)); | ||
| favFruit.addEventListener('ionChange', (event) => validateRadioGroup(event)); | ||
|
|
||
| const validateRadioGroup = (event) => { | ||
| favFruit.classList.add('ion-touched'); | ||
|
|
||
| if (!event.detail.value) { | ||
| favFruit.classList.add('ion-invalid'); | ||
| favFruit.classList.remove('ion-valid'); | ||
| } else { | ||
| favFruit.classList.remove('ion-invalid'); | ||
| favFruit.classList.add('ion-valid'); | ||
| } | ||
| }; | ||
|
|
||
| const submit = (event) => { | ||
| event.preventDefault(); | ||
|
|
||
| validateRadioGroup({ detail: { value: favFruit.value } }); | ||
| }; | ||
| </script> | ||
| </body> | ||
| </html> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| 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/helper-error/demo.html" | ||
| /> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| ```html | ||
| <form id="my-form"> | ||
| <ion-radio-group helper-text="Select your favorite fruit" error-text="This field is required"> | ||
| <ion-radio value="grapes">Grapes</ion-radio><br /> | ||
| <ion-radio value="strawberries">Strawberries</ion-radio><br /> | ||
| <ion-radio value="pineapple">Pineapple</ion-radio><br /> | ||
| <ion-radio value="cherries">Cherries</ion-radio> | ||
| </ion-radio-group> | ||
|
|
||
| <br /> | ||
|
|
||
| <ion-button type="submit" size="small">Submit</ion-button> | ||
| </form> | ||
|
|
||
| <script> | ||
| const form = document.getElementById('my-form'); | ||
| const favFruit = form.querySelector('ion-radio-group'); | ||
|
|
||
| form.addEventListener('submit', (event) => submit(event)); | ||
| favFruit.addEventListener('ionChange', (event) => validateRadioGroup(event)); | ||
|
|
||
| const validateRadioGroup = (event) => { | ||
| favFruit.classList.add('ion-touched'); | ||
|
|
||
| if (!event.detail.value) { | ||
| favFruit.classList.add('ion-invalid'); | ||
| favFruit.classList.remove('ion-valid'); | ||
| } else { | ||
| favFruit.classList.remove('ion-invalid'); | ||
| favFruit.classList.add('ion-valid'); | ||
| } | ||
| }; | ||
|
|
||
| const submit = (event) => { | ||
| event.preventDefault(); | ||
|
|
||
| validateRadioGroup({ detail: { value: favFruit.value } }); | ||
| }; | ||
| </script> | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| ```tsx | ||
| import React, { useRef, useState } from 'react'; | ||
| import { IonRadioGroup, IonRadio, IonButton, RadioGroupCustomEvent } from '@ionic/react'; | ||
|
|
||
| function Example() { | ||
| const [isTouched, setIsTouched] = useState<boolean>(false); | ||
| const [isValid, setIsValid] = useState<boolean | undefined>(); | ||
|
|
||
| const favFruitRef = useRef<HTMLIonRadioGroupElement>(null); | ||
|
|
||
| const validateRadioGroup = (event: RadioGroupCustomEvent<{ value: string }>) => { | ||
| setIsTouched(true); | ||
| setIsValid(event.detail.value ? true : false); | ||
| }; | ||
|
|
||
| const submit = (event: React.FormEvent<HTMLFormElement>) => { | ||
| event.preventDefault(); | ||
|
|
||
| if (favFruitRef.current) { | ||
| validateRadioGroup({ detail: { value: favFruitRef.current.value } } as RadioGroupCustomEvent<{ | ||
| value: string; | ||
| }>); | ||
| } | ||
| }; | ||
|
|
||
| return ( | ||
| <> | ||
| <form onSubmit={submit}> | ||
| <IonRadioGroup | ||
| ref={favFruitRef} | ||
| className={`${isValid ? 'ion-valid' : ''} ${isValid === false ? 'ion-invalid' : ''} ${ | ||
| isTouched ? 'ion-touched' : '' | ||
| }`} | ||
| helperText="Select your favorite fruit" | ||
| errorText="This field is required" | ||
| onIonChange={(event) => validateRadioGroup(event)} | ||
| > | ||
| <IonRadio value="grapes">Grapes</IonRadio> | ||
| <br /> | ||
| <IonRadio value="strawberries">Strawberries</IonRadio> | ||
| <br /> | ||
| <IonRadio value="pineapple">Pineapple</IonRadio> | ||
| <br /> | ||
| <IonRadio value="cherries">Cherries</IonRadio> | ||
| </IonRadioGroup> | ||
|
|
||
| <br /> | ||
|
|
||
| <IonButton type="submit" size="small"> | ||
| Submit | ||
| </IonButton> | ||
| </form> | ||
| </> | ||
| ); | ||
| } | ||
|
|
||
| export default Example; | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| ```html | ||
| <template> | ||
| <form @submit.prevent="submit"> | ||
| <ion-radio-group | ||
| v-model="favFruit" | ||
| helper-text="Select your favorite fruit" | ||
| error-text="This field is required" | ||
| @ionChange="validateRadioGroup" | ||
| :class="{ 'ion-valid': isValid, 'ion-invalid': isValid === false, 'ion-touched': isTouched }" | ||
| > | ||
| <ion-radio value="grapes">Grapes</ion-radio><br /> | ||
| <ion-radio value="strawberries">Strawberries</ion-radio><br /> | ||
| <ion-radio value="pineapple">Pineapple</ion-radio><br /> | ||
| <ion-radio value="cherries">Cherries</ion-radio> | ||
| </ion-radio-group> | ||
|
|
||
| <br /> | ||
|
|
||
| <ion-button type="submit" size="small">Submit</ion-button> | ||
| </form> | ||
| </template> | ||
|
|
||
| <script lang="ts"> | ||
| import { defineComponent, ref } from 'vue'; | ||
| import { IonRadioGroup, IonRadio, IonButton, RadioGroupCustomEvent } from '@ionic/vue'; | ||
|
|
||
| export default defineComponent({ | ||
| components: { | ||
| IonRadioGroup, | ||
| IonRadio, | ||
| IonButton, | ||
| }, | ||
| setup() { | ||
| const favFruit = ref(''); | ||
| const isTouched = ref(false); | ||
| const isValid = ref<boolean | undefined>(); | ||
|
|
||
| const validateRadioGroup = (event: RadioGroupCustomEvent<{ value: string }>) => { | ||
| isTouched.value = true; | ||
| isValid.value = event.detail.value ? true : false; | ||
| }; | ||
|
|
||
| const submit = () => { | ||
| validateRadioGroup({ detail: { value: favFruit.value } } as RadioGroupCustomEvent<{ value: string }>); | ||
| }; | ||
|
|
||
| return { | ||
| favFruit, | ||
| isTouched, | ||
| isValid, | ||
| validateRadioGroup, | ||
| submit, | ||
| }; | ||
| }, | ||
| }); | ||
| </script> | ||
| ``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.