Skip to content

Commit

Permalink
feat(mobile): disable swipe back gesture when there is no back in header
Browse files Browse the repository at this point in the history
  • Loading branch information
CatsJuice committed Nov 22, 2024
1 parent ad10690 commit 387a90a
Show file tree
Hide file tree
Showing 23 changed files with 260 additions and 26 deletions.
13 changes: 12 additions & 1 deletion packages/frontend/apps/ios/App/App.xcodeproj/project.pbxproj
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
9D90BE2D2CCB9876006677DB /* Main.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 9D90BE222CCB9876006677DB /* Main.storyboard */; };
9D90BE2E2CCB9876006677DB /* public in Resources */ = {isa = PBXBuildFile; fileRef = 9D90BE232CCB9876006677DB /* public */; };
C4C413792CBE705D00337889 /* Pods_App.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = AF277DCFFFF123FFC6DF26C7 /* Pods_App.framework */; };
E93B276C2CED92B1001409B8 /* NavigationGesturePlugin.swift in Sources */ = {isa = PBXBuildFile; fileRef = E93B276B2CED92B1001409B8 /* NavigationGesturePlugin.swift */; };
/* End PBXBuildFile section */

/* Begin PBXFileReference section */
Expand All @@ -35,6 +36,7 @@
9D90BE232CCB9876006677DB /* public */ = {isa = PBXFileReference; lastKnownFileType = folder; path = public; sourceTree = "<group>"; };
AF277DCFFFF123FFC6DF26C7 /* Pods_App.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_App.framework; sourceTree = BUILT_PRODUCTS_DIR; };
AF51FD2D460BCFE21FA515B2 /* Pods-App.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-App.release.xcconfig"; path = "Pods/Target Support Files/Pods-App/Pods-App.release.xcconfig"; sourceTree = "<group>"; };
E93B276B2CED92B1001409B8 /* NavigationGesturePlugin.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NavigationGesturePlugin.swift; sourceTree = "<group>"; };
FC68EB0AF532CFC21C3344DD /* Pods-App.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-App.debug.xcconfig"; path = "Pods/Target Support Files/Pods-App/Pods-App.debug.xcconfig"; sourceTree = "<group>"; };
/* End PBXFileReference section */

Expand Down Expand Up @@ -65,7 +67,6 @@
504EC3051FED79650016851F /* Products */,
7F8756D8B27F46E3366F6CEA /* Pods */,
27E2DDA53C4D2A4D1A88CE4A /* Frameworks */,
9D6A85312CCF6D6B00DAB35F /* Recovered References */,
);
indentWidth = 2;
sourceTree = "<group>";
Expand Down Expand Up @@ -101,6 +102,7 @@
9D90BE1A2CCB9876006677DB /* plugins */ = {
isa = PBXGroup;
children = (
E93B276A2CED9298001409B8 /* NavigationGesture */,
9D90BE192CCB9876006677DB /* Cookie */,
);
path = plugins;
Expand All @@ -122,6 +124,14 @@
path = App;
sourceTree = "<group>";
};
E93B276A2CED9298001409B8 /* NavigationGesture */ = {
isa = PBXGroup;
children = (
E93B276B2CED92B1001409B8 /* NavigationGesturePlugin.swift */,
);
path = NavigationGesture;
sourceTree = "<group>";
};
/* End PBXGroup section */

/* Begin PBXNativeTarget section */
Expand Down Expand Up @@ -234,6 +244,7 @@
isa = PBXSourcesBuildPhase;
buildActionMask = 2147483647;
files = (
E93B276C2CED92B1001409B8 /* NavigationGesturePlugin.swift in Sources */,
9D90BE252CCB9876006677DB /* CookieManager.swift in Sources */,
9D90BE262CCB9876006677DB /* CookiePlugin.swift in Sources */,
9D6A85332CCF6DA700DAB35F /* HashcashPlugin.swift in Sources */,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@ class AFFiNEViewController: CAPBridgeViewController {

override func viewDidLoad() {
super.viewDidLoad()
webView?.allowsBackForwardNavigationGestures = true
// disable by default, enable manually when there is a "back" button in page-header
webView?.allowsBackForwardNavigationGestures = false
}

override func capacitorDidLoad() {
bridge?.registerPluginInstance(CookiePlugin())
bridge?.registerPluginInstance(HashcashPlugin())
bridge?.registerPluginInstance(NavigationGesturePlugin())
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
import Foundation
import Capacitor

@objc(NavigationGesturePlugin)
public class NavigationGesturePlugin: CAPPlugin, CAPBridgedPlugin {
public let identifier = "NavigationGesturePlugin"
public let jsName = "NavigationGesture"
public let pluginMethods: [CAPPluginMethod] = [
CAPPluginMethod(name: "isEnabled", returnType: CAPPluginReturnPromise),
CAPPluginMethod(name: "enable", returnType: CAPPluginReturnPromise),
CAPPluginMethod(name: "disable", returnType: CAPPluginReturnPromise)
]

@objc func isEnabled(_ call: CAPPluginCall) {
let enabled = self.bridge?.webView?.allowsBackForwardNavigationGestures ?? true
call.resolve(["value": enabled])
}

@objc func enable(_ call: CAPPluginCall) {
DispatchQueue.main.sync {
self.bridge?.webView?.allowsBackForwardNavigationGestures = true
call.resolve([:])
}
}

@objc func disable(_ call: CAPPluginCall) {
DispatchQueue.main.sync {
self.bridge?.webView?.allowsBackForwardNavigationGestures = false
call.resolve([:])
}
}
}
20 changes: 15 additions & 5 deletions packages/frontend/apps/ios/src/app.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { AffineContext } from '@affine/core/components/context';
import { AppFallback } from '@affine/core/mobile/components/app-fallback';
import { configureMobileModules } from '@affine/core/mobile/modules';
import { NavigationGestureProvider } from '@affine/core/mobile/modules/navigation-gesture';
import { VirtualKeyboardProvider } from '@affine/core/mobile/modules/virtual-keyboard';
import { router } from '@affine/core/mobile/router';
import { configureCommonModules } from '@affine/core/modules';
Expand Down Expand Up @@ -32,8 +33,10 @@ import { Suspense } from 'react';
import { RouterProvider } from 'react-router-dom';

import { configureFetchProvider } from './fetch';
import { ModalConfigProvider } from './modal-config';
import { Cookie } from './plugins/cookie';
import { Hashcash } from './plugins/hashcash';
import { NavigationGesture } from './plugins/navigation-gesture';

const future = {
v7_startTransition: true,
Expand Down Expand Up @@ -86,6 +89,11 @@ framework.impl(VirtualKeyboardProvider, {
Keyboard.removeAllListeners();
},
});
framework.impl(NavigationGestureProvider, {
isEnabled: () => NavigationGesture.isEnabled(),
enable: () => NavigationGesture.enable(),
disable: () => NavigationGesture.disable(),
});
const frameworkProvider = framework.provider();

// setup application lifecycle events, and emit application start event
Expand Down Expand Up @@ -132,11 +140,13 @@ export function App() {
<FrameworkRoot framework={frameworkProvider}>
<I18nProvider>
<AffineContext store={getCurrentStore()}>
<RouterProvider
fallbackElement={<AppFallback />}
router={router}
future={future}
/>
<ModalConfigProvider>
<RouterProvider
fallbackElement={<AppFallback />}
router={router}
future={future}
/>
</ModalConfigProvider>
</AffineContext>
</I18nProvider>
</FrameworkRoot>
Expand Down
28 changes: 28 additions & 0 deletions packages/frontend/apps/ios/src/modal-config.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import { ModalConfigContext } from '@affine/component';
import { NavigationGestureService } from '@affine/core/mobile/modules/navigation-gesture';
import { useService } from '@toeverything/infra';
import { type PropsWithChildren,useCallback } from 'react';

export const ModalConfigProvider = ({ children }: PropsWithChildren) => {
const navigationGesture = useService(NavigationGestureService);

const onOpenChange = useCallback(
(open: boolean) => {
const prev = navigationGesture.enabled$.value;
if (open && !prev) {
navigationGesture.setEnabled(false);
return () => {
navigationGesture.setEnabled(prev);
};
}
return;
},
[navigationGesture]
);

return (
<ModalConfigContext.Provider value={{ onOpenChange }}>
{children}
</ModalConfigContext.Provider>
);
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
export interface NavigationGesturePlugin {
isEnabled: () => Promise<boolean>;
enable: () => Promise<void>;
disable: () => Promise<void>;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { registerPlugin } from '@capacitor/core';

import type { NavigationGesturePlugin } from './definitions';

const NavigationGesture =
registerPlugin<NavigationGesturePlugin>('NavigationGesture');

export * from './definitions';
export { NavigationGesture };
11 changes: 11 additions & 0 deletions packages/frontend/component/src/ui/modal/context.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { createContext } from 'react';

export interface ModalConfig {
/**
* add global callback for modal open/close
*/
onOpenChange?: (open: boolean) => void;
}
export const ModalConfigContext = createContext<ModalConfig>({});

export const InsideModalContext = createContext<number>(0);
1 change: 1 addition & 0 deletions packages/frontend/component/src/ui/modal/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
export * from './confirm-modal';
export * from './context';
export * from './modal';
export * from './overlay-modal';
export * from './prompt-modal';
26 changes: 24 additions & 2 deletions packages/frontend/component/src/ui/modal/modal.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,19 @@ import * as VisuallyHidden from '@radix-ui/react-visually-hidden';
import { assignInlineVars } from '@vanilla-extract/dynamic';
import clsx from 'clsx';
import type { CSSProperties } from 'react';
import { forwardRef, useCallback, useEffect, useState } from 'react';
import {
forwardRef,
useCallback,
useContext,
useEffect,
useState,
} from 'react';

import { startScopedViewTransition } from '../../utils';
import type { IconButtonProps } from '../button';
import { IconButton } from '../button';
import { SafeArea } from '../safe-area';
import { InsideModalContext, ModalConfigContext } from './context';
import * as styles from './styles.css';

export interface ModalProps extends DialogProps {
Expand Down Expand Up @@ -123,6 +130,7 @@ function createContainer() {

export const ModalInner = forwardRef<HTMLDivElement, ModalProps>(
(props, ref) => {
const modalConfig = useContext(ModalConfigContext);
const {
modal,
portalOptions,
Expand Down Expand Up @@ -164,6 +172,10 @@ export const ModalInner = forwardRef<HTMLDivElement, ModalProps>(
null
);

useEffect(() => {
modalConfig.onOpenChange?.(open ?? false);
}, [modalConfig, open]);

useEffect(() => {
if (open) {
const container = createContainer();
Expand Down Expand Up @@ -304,10 +316,20 @@ export const ModalInner = forwardRef<HTMLDivElement, ModalProps>(
ModalInner.displayName = 'ModalInner';

export const Modal = forwardRef<HTMLDivElement, ModalProps>((props, ref) => {
const insideModal = useContext(InsideModalContext);
if (!props.open) {
return;
}
return <ModalInner {...props} ref={ref} />;
return (
<InsideModalContext.Provider value={insideModal + 1}>
<ModalInner {...props} ref={ref} />
</InsideModalContext.Provider>
);
});

Modal.displayName = 'Modal';

export const useIsInsideModal = () => {
const context = useContext(InsideModalContext);
return context > 0;
};
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { Button, Modal } from '@affine/component';
import { PageHeader } from '@affine/core/mobile/components';
import { useI18n } from '@affine/i18n';
import clsx from 'clsx';
import {
Expand All @@ -8,7 +9,6 @@ import {
type ReactNode,
} from 'react';

import { PageHeader } from '../page-header';
import * as styles from './styles.css';

interface ConfigModalProps {
Expand Down
1 change: 0 additions & 1 deletion packages/frontend/core/src/components/mobile/index.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
export * from './config-modal';
export * from './page-header';
1 change: 1 addition & 0 deletions packages/frontend/core/src/mobile/components/index.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
export * from './app-tabs';
export * from './doc-card';
export * from './page-header';
export * from './rename';
export * from './search-input';
export * from './search-result';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
import { IconButton, SafeArea } from '@affine/component';
import { ArrowLeftSmallIcon } from '@blocksuite/icons/rc';
import { IconButton, SafeArea, useIsInsideModal } from '@affine/component';
import { ArrowLeftSmallIcon, CloseIcon } from '@blocksuite/icons/rc';
import { useService } from '@toeverything/infra';
import clsx from 'clsx';
import {
forwardRef,
type HtmlHTMLAttributes,
type ReactNode,
useCallback,
useEffect,
} from 'react';

import { NavigationGestureService } from '../../modules/navigation-gesture';
import * as styles from './styles.css';

export interface PageHeaderProps
Expand Down Expand Up @@ -60,6 +63,20 @@ export const PageHeader = forwardRef<HTMLDivElement, PageHeaderProps>(
},
ref
) {
const navigationGesture = useService(NavigationGestureService);
const isInsideModal = useIsInsideModal();

useEffect(() => {
if (isInsideModal) return;

const prev = navigationGesture.enabled$.value;
navigationGesture.setEnabled(!!back);

return () => {
navigationGesture.setEnabled(prev);
};
}, [back, isInsideModal, navigationGesture]);

const handleRouteBack = useCallback(() => {
backAction ? backAction() : history.back();
}, [backAction]);
Expand All @@ -83,7 +100,7 @@ export const PageHeader = forwardRef<HTMLDivElement, PageHeaderProps>(
size={24}
style={{ padding: 10 }}
onClick={handleRouteBack}
icon={<ArrowLeftSmallIcon />}
icon={isInsideModal ? <CloseIcon /> : <ArrowLeftSmallIcon />}
data-testid="page-header-back"
/>
) : null}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import {
Scrollable,
useThemeColorMeta,
} from '@affine/component';
import { PageHeader } from '@affine/core/components/mobile';
import { PageHeader } from '@affine/core/mobile/components';
import { useI18n } from '@affine/i18n';
import { ArrowRightSmallIcon } from '@blocksuite/icons/rc';
import { cssVarV2 } from '@toeverything/theme/v2';
Expand Down
2 changes: 2 additions & 0 deletions packages/frontend/core/src/mobile/modules/index.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
import type { Framework } from '@toeverything/infra';

import { configureMobileNavigationGestureModule } from './navigation-gesture';
import { configureMobileSearchModule } from './search';
import { configureMobileVirtualKeyboardModule } from './virtual-keyboard';

export function configureMobileModules(framework: Framework) {
configureMobileSearchModule(framework);
configureMobileVirtualKeyboardModule(framework);
configureMobileNavigationGestureModule(framework);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import type { Framework } from '@toeverything/infra';

import { NavigationGestureProvider } from './providers/navigation-gesture';
import { NavigationGestureService } from './services/navigation-gesture';

export { NavigationGestureProvider, NavigationGestureService };

export function configureMobileNavigationGestureModule(framework: Framework) {
framework.service(
NavigationGestureService,
f => new NavigationGestureService(f.getOptional(NavigationGestureProvider))
);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import { createIdentifier } from '@toeverything/infra';

export interface NavigationGestureProvider {
isEnabled: () => Promise<boolean>;
enable: () => Promise<void>;
disable: () => Promise<void>;
}

export const NavigationGestureProvider =
createIdentifier<NavigationGestureProvider>('NavigationGestureProvider');
Loading

0 comments on commit 387a90a

Please sign in to comment.