Skip to content

docs(checkbox): show how to prevent toggling checkbox with link #3584

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
Apr 9, 2024
Merged

docs(checkbox): show how to prevent toggling checkbox with link #3584

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
e26cc61
docs(checkbox): add info for v8
liamdebeasi Apr 9, 2024
4e36a2a
docs(checkbox): add v7 example
liamdebeasi Apr 9, 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
8 changes: 8 additions & 0 deletions docs/api/checkbox.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,14 @@ import Justify from '@site/static/usage/v8/checkbox/justify/index.md';
import Indeterminate from '@site/static/usage/v8/checkbox/indeterminate/index.md';

<Indeterminate />

## Links inside of Labels

Checkbox labels can sometimes be accompanied with links. These links can provide more information related to the checkbox. However, clicking the link should not check the checkbox. To achieve this, we can use [stopPropagation](https://developer.mozilla.org/en-US/docs/Web/API/Event/stopPropagation) to prevent the click event from bubbling. When using this approach, the rest of the label still remains clickable.

import LabelLink from '@site/static/usage/v8/checkbox/label-link/index.md';

<LabelLink />

## Theming

Expand Down
3 changes: 3 additions & 0 deletions static/usage/v7/checkbox/label-link/angular.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```html
<ion-checkbox>I agree to the <a href="#" (click)="$event.stopPropagation()">terms and conditions</a></ion-checkbox>
```
24 changes: 24 additions & 0 deletions static/usage/v7/checkbox/label-link/demo.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Checkbox</title>
<link rel="stylesheet" href="../../common.css" />
<script src="../../common.js"></script>
<script type="module" src="https://cdn.jsdelivr.net/npm/@ionic/core@7/dist/ionic/ionic.esm.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@ionic/core@7/css/ionic.bundle.css" />
</head>

<body>
<ion-app>
<ion-content>
<div class="container">
<ion-checkbox
>I agree to the <a href="#" onclick="event.stopPropagation()">terms and conditions</a></ion-checkbox
>
</div>
</ion-content>
</ion-app>
</body>
</html>
17 changes: 17 additions & 0 deletions static/usage/v7/checkbox/label-link/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
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 from './angular.md';

<Playground
version="7"
code={{
javascript,
react,
vue,
angular,
}}
src="usage/v7/checkbox/label-link/demo.html"
/>
3 changes: 3 additions & 0 deletions static/usage/v7/checkbox/label-link/javascript.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```html
<ion-checkbox>I agree to the <a href="#" onclick="event.stopPropagation()">terms and conditions</a></ion-checkbox>
```
29 changes: 29 additions & 0 deletions static/usage/v7/checkbox/label-link/react.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
```tsx
import React, { useEffect, useRef } from 'react';
import { IonCheckbox } from '@ionic/react';

function Example() {
const ref = useRef<HTMLAnchorElement>(null);

/**
* IonCheckbox will be listening for the native click event here so we need
* to call stopPropagation when the native click event instead of when the
* synthetic click event fires.
*/
useEffect(() => {
ref.current?.addEventListener('click', (event) => {
event.stopPropagation();
});
}, [ref]);

return (
<IonCheckbox>
I agree to the{' '}
<a href="#" ref={ref}>
terms and conditions
</a>
</IonCheckbox>
);
}
export default Example;
```
14 changes: 14 additions & 0 deletions static/usage/v7/checkbox/label-link/vue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
```html
<template>
<ion-checkbox>I agree to the <a href="#" @click="$event.stopPropagation()">terms and conditions</a></ion-checkbox>
</template>

<script lang="ts">
import { IonCheckbox } from '@ionic/vue';
import { defineComponent } from 'vue';

export default defineComponent({
components: { IonCheckbox },
});
</script>
```
3 changes: 3 additions & 0 deletions static/usage/v8/checkbox/label-link/angular.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```html
<ion-checkbox>I agree to the <a href="#" (click)="$event.stopPropagation()">terms and conditions</a></ion-checkbox>
```
24 changes: 24 additions & 0 deletions static/usage/v8/checkbox/label-link/demo.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Checkbox</title>
<link rel="stylesheet" href="../../common.css" />
<script src="../../common.js"></script>
<script type="module" src="https://cdn.jsdelivr.net/npm/@ionic/core@next/dist/ionic/ionic.esm.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@ionic/core@next/css/ionic.bundle.css" />
</head>

<body>
<ion-app>
<ion-content>
<div class="container">
<ion-checkbox
>I agree to the <a href="#" onclick="event.stopPropagation()">terms and conditions</a></ion-checkbox
>
</div>
</ion-content>
</ion-app>
</body>
</html>
17 changes: 17 additions & 0 deletions static/usage/v8/checkbox/label-link/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
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 from './angular.md';

<Playground
version="8"
code={{
javascript,
react,
vue,
angular,
}}
src="usage/v8/checkbox/label-link/demo.html"
/>
3 changes: 3 additions & 0 deletions static/usage/v8/checkbox/label-link/javascript.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```html
<ion-checkbox>I agree to the <a href="#" onclick="event.stopPropagation()">terms and conditions</a></ion-checkbox>
```
29 changes: 29 additions & 0 deletions static/usage/v8/checkbox/label-link/react.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
```tsx
import React, { useEffect, useRef } from 'react';
import { IonCheckbox } from '@ionic/react';

function Example() {
const ref = useRef<HTMLAnchorElement>(null);

/**
* IonCheckbox will be listening for the native click event here so we need
* to call stopPropagation when the native click event instead of when the
* synthetic click event fires.
*/
useEffect(() => {
ref.current?.addEventListener('click', (event) => {
event.stopPropagation();
});
}, [ref]);

return (
<IonCheckbox>
I agree to the{' '}
<a href="#" ref={ref}>
terms and conditions
</a>
</IonCheckbox>
);
}
export default Example;
```
14 changes: 14 additions & 0 deletions static/usage/v8/checkbox/label-link/vue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
```html
<template>
<ion-checkbox>I agree to the <a href="#" @click="$event.stopPropagation()">terms and conditions</a></ion-checkbox>
</template>

<script lang="ts">
import { IonCheckbox } from '@ionic/vue';
import { defineComponent } from 'vue';

export default defineComponent({
components: { IonCheckbox },
});
</script>
```
8 changes: 8 additions & 0 deletions versioned_docs/version-v7/api/checkbox.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,14 @@ import Indeterminate from '@site/static/usage/v7/checkbox/indeterminate/index.md

<Indeterminate />

## Links inside of Labels

Checkbox labels can sometimes be accompanied with links. These links can provide more information related to the checkbox. However, clicking the link should not check the checkbox. To achieve this, we can use [stopPropagation](https://developer.mozilla.org/en-US/docs/Web/API/Event/stopPropagation) to prevent the click event from bubbling. When using this approach, the rest of the label still remains clickable.

import LabelLink from '@site/static/usage/v7/checkbox/label-link/index.md';

<LabelLink />

## Theming

### CSS Custom Properties
Expand Down