mattermost-mobile/app/hooks/useBannerGestureRootPosition.ts
Rahim Rahman 5887c3ab46
feat(MM-65625): floating banner (#9162)
* feat: implement floating banner system

- Add FloatingBanner component with gesture support and keyboard awareness
- Implement BannerManager singleton for banner lifecycle management
- Create floating banner screen with SafeAreaProvider integration
- Add comprehensive banner configuration types and positioning
- Update Banner component to use modern gesture handling
- Enhance BannerItem with improved typography and spacing (40px height)
- Add ConnectionBanner improvements with better sizing
- Remove ConnectionBanner from channel list (moved to floating system)
- Update screens constants (remove FLOATING_BANNER - handled as overlay)
- Add i18n support for limited network connection message

The system provides:
- Auto-hide functionality with customizable duration
- Position-aware rendering (top/bottom with keyboard adjustment)
- Tablet-specific offset handling
- Swipe-to-dismiss with configurable thresholds
- Custom component support alongside default banner items
- Comprehensive test coverage with device-specific scenarios

* docs: add floating banner system documentation and cleanup

- Add comprehensive floating-banner.md with architecture diagrams
- Remove incompatible connection_banner/index.ts file
- Update device.ts hooks for better keyboard handling
- Simplify screens/index.tsx floating banner registration
- Update test/setup.ts to remove deprecated keyboard mocks
- Clean up keyboard height logic and ESLint issues

The documentation covers:
- System architecture and component relationships
- API reference and usage patterns
- Performance considerations and best practices
- Integration points and troubleshooting guide
- Comprehensive testing strategy

All tests now pass with the updated setup.

* fix issue with translation file

* some self cleanup.

* renamed index.tsx => Banner.tsx

* creaete meaningful tests for Banner component and all the hooks.

* fix tests

* cleanup based on initial review by AI

* dismissible was set to true, changing to what was configured.

* making title and message optional

* addressed some comments in PR

* more fixes based on PR review.

* added future enhancement

* dismissOverlay will be awaited
* delay dismissing overlay so we don't have to show a new one all the time

* make the banner stackable

* Fix issue with last banner dismissal delayed by 2s

* update floating-banner test

* clean-up based on review by @enahum

* fix failing test

* fix failiing tests

* rename confusing var

* fixed issue with swipe not working on android

* fix issue w/ android not registering touch events behind the overlay

* fix failing test

* animate the banner moving up when bottom banner first appear.

* removed unused functions and update tests

* add useMemo and useCallback

* update jsdoc to say dismissable is default true

* fix failing test
2025-10-12 09:33:51 -06:00

64 lines
2.3 KiB
TypeScript

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.
import {useMemo} from 'react';
import {Platform, type ViewStyle} from 'react-native';
import {
FLOATING_BANNER_BOTTOM_OFFSET_PHONE_IOS,
FLOATING_BANNER_BOTTOM_OFFSET_PHONE_ANDROID,
FLOATING_BANNER_BOTTOM_OFFSET_WITH_KEYBOARD_IOS,
FLOATING_BANNER_BOTTOM_OFFSET_WITH_KEYBOARD_ANDROID,
FLOATING_BANNER_TABLET_EXTRA_BOTTOM_OFFSET,
TABLET_SIDEBAR_WIDTH,
} from '@constants/view';
import {useIsTablet, useKeyboardHeight, useWindowDimensions} from '@hooks/device';
import type {FloatingBannerPosition} from '@components/floating_banner/types';
const BANNER_TABLET_WIDTH_PERCENTAGE = 96;
type UseBannerGestureRootPositionParams = {
position: FloatingBannerPosition;
containerHeight: number;
};
export const useBannerGestureRootPosition = ({position, containerHeight}: UseBannerGestureRootPositionParams): ViewStyle => {
const isTablet = useIsTablet();
const keyboardHeight = useKeyboardHeight();
const {width: windowWidth} = useWindowDimensions();
const isTop = position === 'top';
const baseBottomOffset = Platform.OS === 'android' ? FLOATING_BANNER_BOTTOM_OFFSET_PHONE_ANDROID : FLOATING_BANNER_BOTTOM_OFFSET_PHONE_IOS;
const bottomOffset = isTablet ? (baseBottomOffset + FLOATING_BANNER_TABLET_EXTRA_BOTTOM_OFFSET) : baseBottomOffset;
return useMemo(() => {
const baseStyle: ViewStyle = {height: containerHeight};
if (isTablet) {
const diffWidth = windowWidth - TABLET_SIDEBAR_WIDTH;
const tabletWidth = (BANNER_TABLET_WIDTH_PERCENTAGE / 100) * diffWidth;
baseStyle.maxWidth = tabletWidth;
baseStyle.alignSelf = 'center';
}
if (isTop) {
return {...baseStyle, top: 0};
}
if (Platform.OS === 'android') {
return {
...baseStyle,
bottom: FLOATING_BANNER_BOTTOM_OFFSET_WITH_KEYBOARD_ANDROID,
};
}
return {
...baseStyle,
bottom: (keyboardHeight > 0 ? FLOATING_BANNER_BOTTOM_OFFSET_WITH_KEYBOARD_IOS : bottomOffset) + keyboardHeight,
};
}, [isTop, keyboardHeight, bottomOffset, containerHeight, isTablet, windowWidth]);
};
export const testExports = {
BANNER_TABLET_WIDTH_PERCENTAGE,
};