Skip to content

docs(badge, tab-bar): add playground to show usage of badges in tab-bar #4045

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 7 commits into from
Mar 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 12 additions & 0 deletions docs/api/badge.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,18 @@ import Basic from '@site/static/usage/v8/badge/basic/index.md';

<Basic />

## Badges in Tab Buttons

Badges can be added inside a tab button, often used to indicate notifications or highlight additional items associated with the element.

:::info
Empty badges are only available for `md` mode.
:::

import InsideTabBar from '@site/static/usage/v8/badge/inside-tab-bar/index.md';

<InsideTabBar />

## Theming

### Colors
Expand Down
12 changes: 12 additions & 0 deletions docs/api/tab-bar.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,18 @@ export default defineComponent({

</Tabs>

## Badges in Tab Buttons

Badges can be added inside a tab button, often used to indicate notifications or highlight additional items associated with the element.

:::info
Empty badges are only available for `md` mode.
:::

import InsideTabBar from '@site/static/usage/v8/badge/inside-tab-bar/index.md';

<InsideTabBar />

## Properties
<Props />

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
```html
<ion-tab-bar color="light">
<ion-tab-button tab="1">
<ion-icon name="heart"></ion-icon>
<ion-label>Favorites</ion-label>
<ion-badge color="danger"></ion-badge>
</ion-tab-button>

<ion-tab-button tab="2">
<ion-icon name="musical-note"></ion-icon>
<ion-label>Music</ion-label>
</ion-tab-button>

<ion-tab-button tab="3">
<ion-icon name="calendar"></ion-icon>
<ion-label>Calendar</ion-label>
<ion-badge color="danger">47</ion-badge>
</ion-tab-button>
</ion-tab-bar>
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
```ts
import { Component } from '@angular/core';
import { IonBadge, IonTabBar, IonTabButton, IonIcon, IonLabel } from '@ionic/angular/standalone';
import { addIcons } from 'ionicons';
import { heart, calendar, musicalNote } from 'ionicons/icons';

@Component({
selector: 'app-example',
templateUrl: 'example.component.html',
styleUrls: ['./example.component.css'],
imports: [IonBadge, IonTabBar, IonTabButton, IonIcon, IonLabel],
})
export class ExampleComponent {
constructor() {
/**
* Any icons you want to use in your application
* can be registered in app.component.ts and then
* referenced by name anywhere in your application.
*/
addIcons({ heart, calendar, musicalNote });
}
}
```
45 changes: 45 additions & 0 deletions static/usage/v8/badge/inside-tab-bar/demo.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Badge</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" />

<style>
ion-tab-bar {
flex: 1;
}
</style>
</head>

<body>
<ion-app>
<ion-content>
<div class="container">
<ion-tab-bar color="light">
<ion-tab-button tab="1">
<ion-icon name="heart"></ion-icon>
<ion-label>Favorites</ion-label>
<ion-badge color="danger"></ion-badge>
</ion-tab-button>

<ion-tab-button tab="2">
<ion-icon name="musical-note"></ion-icon>
<ion-label>Music</ion-label>
</ion-tab-button>

<ion-tab-button tab="3">
<ion-icon name="calendar"></ion-icon>
<ion-label>Calendar</ion-label>
<ion-badge color="danger">47</ion-badge>
</ion-tab-button>
</ion-tab-bar>
</div>
</ion-content>
</ion-app>
</body>
</html>
24 changes: 24 additions & 0 deletions static/usage/v8/badge/inside-tab-bar/index.md
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/badge/inside-tab-bar/demo.html"
/>
20 changes: 20 additions & 0 deletions static/usage/v8/badge/inside-tab-bar/javascript.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
```html
<ion-tab-bar color="light">
<ion-tab-button tab="1">
<ion-icon name="heart"></ion-icon>
<ion-label>Favorites</ion-label>
<ion-badge color="danger"></ion-badge>
</ion-tab-button>

<ion-tab-button tab="2">
<ion-icon name="musical-note"></ion-icon>
<ion-label>Music</ion-label>
</ion-tab-button>

<ion-tab-button tab="3">
<ion-icon name="calendar"></ion-icon>
<ion-label>Calendar</ion-label>
<ion-badge color="danger">47</ion-badge>
</ion-tab-button>
</ion-tab-bar>
```
29 changes: 29 additions & 0 deletions static/usage/v8/badge/inside-tab-bar/react.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
```tsx
import React from 'react';
import { IonBadge, IonTabBar, IonTabButton, IonIcon, IonLabel } from '@ionic/react';
import { heart, calendar, musicalNote } from 'ionicons/icons';

function Example() {
return (
<>
<IonTabBar color="light">
<IonTabButton tab="tab1">
<IonIcon icon={heart} />
<IonLabel>Favorites</IonLabel>
<IonBadge color="danger"></IonBadge>
</IonTabButton>
<IonTabButton tab="tab2">
<IonIcon icon={musicalNote} />
<IonLabel>Music</IonLabel>
</IonTabButton>
<IonTabButton tab="tab3">
<IonIcon icon={calendar} />
<IonLabel>Calendar</IonLabel>
<IonBadge color="danger">47</IonBadge>
</IonTabButton>
</IonTabBar>
</>
);
}
export default Example;
```
41 changes: 41 additions & 0 deletions static/usage/v8/badge/inside-tab-bar/vue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
```html
<template>
<ion-tab-bar color="light">
<ion-tab-button tab="1">
<ion-icon :icon="heart" />
<ion-label>Favorites</ion-label>
<ion-badge color="danger"></ion-badge>
</ion-tab-button>

<ion-tab-button tab="2">
<ion-icon :icon="musicalNote" />
<ion-label>Music</ion-label>
</ion-tab-button>

<ion-tab-button tab="3">
<ion-icon :icon="calendar" />
<ion-label>Calendar</ion-label>
<ion-badge color="danger">47</ion-badge>
</ion-tab-button>
</ion-tab-bar>
</template>

<script lang="ts">
import { IonBadge, IonTabBar, IonTabButton, IonIcon, IonLabel } from '@ionic/vue';
import { heart, calendar, musicalNote } from 'ionicons/icons';
import { defineComponent } from 'vue';

export default defineComponent({
components: {
IonBadge,
IonTabBar,
IonTabButton,
IonIcon,
IonLabel,
},
setup() {
return { heart, calendar, musicalNote };
},
});
</script>
```