Skip to content
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

Jump to bottom

docs(fab): add playground for safe area workaround #3105

Merged
merged 7 commits into from
Sep 5, 2023
Merged

docs(fab): add playground for safe area workaround #3105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e0a6475
docs(fab): add playground for safe area workaround
mapsandapps Aug 31, 2023
5b13f71
Try to fix links
mapsandapps Aug 31, 2023
c41c634
Add safe area sizes for stackblitzes
mapsandapps Sep 1, 2023
46ac47f
Use both component & global css files
mapsandapps Sep 1, 2023
a884689
Use both scoped and global style tags
mapsandapps Sep 1, 2023
c856a9b
Add bottom
mapsandapps Sep 1, 2023
48bbb8e
Address PR feedback
mapsandapps Sep 5, 2023
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
27 changes: 26 additions & 1 deletion docs/api/fab.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,32 @@ import Positioning from '@site/static/usage/v7/fab/positioning/index.md';

<Positioning />

### Safe Area

If there is no `ion-header` or `ion-footer` component, the fab may be covered by a device's notch, status bar, or other device UI. In these cases, the [safe area](/docs/theming/advanced#safe-area-padding) on the top and bottom is not taken into account. This can be adjusted by using the [`--ion-safe-area-(dir)` variables](/docs/theming/advanced#application-variables).

When using a fab with `vertical` set to `"top"` without an `ion-header`, the top margin needs to be set:

```css
ion-fab {
margin-top: var(--ion-safe-area-top, 0);
}
```

And when using a fab with `vertical` set to `"bottom"` without an `ion-footer`, the bottom margin needs to be set:

```css
ion-fab {
margin-bottom: var(--ion-safe-area-bottom, 0);
}
```

If there is an `ion-header` (for a fab with `vertical` set to `"top"`) or `ion-footer` (for a fab with `vertical` set to `"bottom"`), no CSS adjustment is needed because the fab gets positioned relative to the header or footer.
mapsandapps marked this conversation as resolved.
Show resolved Hide resolved

import SafeArea from '@site/static/usage/v7/fab/safe-area/index.md';

<SafeArea />

## Button Sizing

Setting the `size` property of the main fab button to `"small"` will render it at a mini size. Note that this property will not have an effect when used with the inner fab buttons.
Expand Down Expand Up @@ -68,7 +94,6 @@ import CSSCustomProperties from '@site/static/usage/v7/fab/theming/css-custom-pr
import CSSShadowParts from '@site/static/usage/v7/fab/theming/css-shadow-parts/index.md';

<CSSShadowParts />


## Accessibility

Expand Down
6 changes: 6 additions & 0 deletions static/usage/v7/fab/safe-area/angular/example_component_css.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
```css
ion-fab {
margin-top: var(--ion-safe-area-top, 0);
margin-bottom: var(--ion-safe-area-bottom, 0);
}
```
7 changes: 7 additions & 0 deletions static/usage/v7/fab/safe-area/angular/example_component_html.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
```html
<ion-fab slot="fixed" vertical="top" horizontal="center">
<ion-fab-button>
<ion-icon name="add"></ion-icon>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The icons in the angular and javascript examples don't load in stackblitz because of #2892

</ion-fab-button>
</ion-fab>
```
10 changes: 10 additions & 0 deletions static/usage/v7/fab/safe-area/angular/global_css.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
```css
:root {
/**
* Setting the variables for DEMO purposes only.
* Values will be set automatically when building an iOS or Android app.
*/
--ion-safe-area-top: 20px;
--ion-safe-area-bottom: 20px;
}
```
28 changes: 28 additions & 0 deletions static/usage/v7/fab/safe-area/demo.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Fab</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" />

<style>
ion-fab {
margin-top: var(--ion-safe-area-top, 0);
}
</style>
</head>

<body>
<ion-app>
<ion-fab slot="fixed" vertical="top" horizontal="center">
<ion-fab-button>
<ion-icon name="add"></ion-icon>
</ion-fab-button>
</ion-fab>
</ion-app>
</body>
</html>
35 changes: 35 additions & 0 deletions static/usage/v7/fab/safe-area/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
import Playground from '@site/src/components/global/Playground';

import javascript from './javascript.md';

import react_main_tsx from './react/main_tsx.md';
import react_main_css from './react/main_css.md';

import vue from './vue.md';

import angular_example_component_html from './angular/example_component_html.md';
import angular_example_component_css from './angular/example_component_css.md';
import angular_global_css from './angular/global_css.md';

<Playground
version="7"
code={{
javascript,
react: {
files: {
'src/main.tsx': react_main_tsx,
'src/main.css': react_main_css,
},
},
vue,
angular: {
files: {
'src/app/example.component.html': angular_example_component_html,
'src/app/example.component.css': angular_example_component_css,
'src/global.css': angular_global_css,
},
},
}}
src="usage/v7/fab/safe-area/demo.html"
devicePreview={true}
/>
23 changes: 23 additions & 0 deletions static/usage/v7/fab/safe-area/javascript.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
```html
<ion-fab slot="fixed" vertical="top" horizontal="center">
<ion-fab-button>
<ion-icon name="add"></ion-icon>
</ion-fab-button>
</ion-fab>

<style>
:root {
/**
* Setting the variables for DEMO purposes only.
* Values will be set automatically when building an iOS or Android app.
*/
--ion-safe-area-top: 20px;
--ion-safe-area-bottom: 20px;
}

ion-fab {
margin-top: var(--ion-safe-area-top, 0);
margin-bottom: var(--ion-safe-area-bottom, 0);
}
</style>
```
15 changes: 15 additions & 0 deletions static/usage/v7/fab/safe-area/react/main_css.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
```css
:root {
/**
* Setting the variables for DEMO purposes only.
* Values will be set automatically when building an iOS or Android app.
*/
--ion-safe-area-top: 20px;
--ion-safe-area-bottom: 20px;
}

ion-fab {
margin-top: var(--ion-safe-area-top, 0);
margin-bottom: var(--ion-safe-area-bottom, 0);
}
```
18 changes: 18 additions & 0 deletions static/usage/v7/fab/safe-area/react/main_tsx.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
```tsx
import React from 'react';
import { IonFab, IonFabButton, IonIcon } from '@ionic/react';
import { add } from 'ionicons/icons';

import './main.css';

function Example() {
return (
<IonFab slot="fixed" vertical="top" horizontal="center">
<IonFabButton>
<IonIcon icon={add}></IonIcon>
</IonFabButton>
</IonFab>
);
}
export default Example;
```
44 changes: 44 additions & 0 deletions static/usage/v7/fab/safe-area/vue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
```html
<template>
<ion-fab slot="fixed" vertical="top" horizontal="center">
<ion-fab-button>
<ion-icon :icon="add"></ion-icon>
</ion-fab-button>
</ion-fab>
</template>

<script lang="ts">
import { IonFab, IonFabButton, IonIcon } from '@ionic/vue';
import { defineComponent } from 'vue';
import { add } from 'ionicons/icons';

export default defineComponent({
components: {
IonFab,
IonFabButton,
IonIcon,
},
setup() {
return { add };
},
});
</script>

<style>
:root {
/**
* Setting the variables for DEMO purposes only.
* Values will be set automatically when building an iOS or Android app.
*/
--ion-safe-area-top: 20px;
--ion-safe-area-bottom: 20px;
}
</style>

<style scoped>
ion-fab {
margin-top: var(--ion-safe-area-top, 0);
margin-bottom: var(--ion-safe-area-bottom, 0);
}
</style>
```
Loading