@hzblj/kara-components 0.2.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +65 -0
- package/README.md +2 -3
- package/lib/module/molecules/navigation-bar/navigation-bar.android.js +65 -35
- package/lib/module/molecules/navigation-bar/navigation-bar.android.js.map +1 -1
- package/lib/module/molecules/navigation-bar/navigation-bar.ios.js +48 -13
- package/lib/module/molecules/navigation-bar/navigation-bar.ios.js.map +1 -1
- package/lib/module/organisms/sheet/index.js +2 -1
- package/lib/module/organisms/sheet/index.js.map +1 -1
- package/lib/module/organisms/sheet/sheet-header.js +7 -0
- package/lib/module/organisms/sheet/sheet-header.js.map +1 -0
- package/lib/module/organisms/sheet/sheet-scroll.js +62 -0
- package/lib/module/organisms/sheet/sheet-scroll.js.map +1 -0
- package/lib/module/organisms/sheet/sheet.js +136 -0
- package/lib/module/organisms/sheet/sheet.js.map +1 -0
- package/lib/module/organisms/sheet/split-sheet-children.js +21 -0
- package/lib/module/organisms/sheet/split-sheet-children.js.map +1 -0
- package/lib/module/organisms/sheet/use-sheet-header.js +118 -0
- package/lib/module/organisms/sheet/use-sheet-header.js.map +1 -0
- package/lib/typescript/molecules/navigation-bar/navigation-bar.types.d.ts +56 -17
- package/lib/typescript/organisms/sheet/index.d.ts +1 -0
- package/lib/typescript/organisms/sheet/sheet-header.d.ts +3 -0
- package/lib/typescript/organisms/sheet/sheet-scroll.d.ts +9 -0
- package/lib/typescript/organisms/sheet/sheet.d.ts +7 -1
- package/lib/typescript/organisms/sheet/sheet.types.d.ts +86 -3
- package/lib/typescript/organisms/sheet/split-sheet-children.d.ts +9 -0
- package/lib/typescript/organisms/sheet/use-sheet-header.d.ts +24 -0
- package/package.json +7 -5
- package/src/molecules/navigation-bar/navigation-bar.android.tsx +50 -23
- package/src/molecules/navigation-bar/navigation-bar.ios.tsx +54 -15
- package/src/molecules/navigation-bar/navigation-bar.types.ts +56 -17
- package/src/organisms/sheet/index.ts +1 -0
- package/src/organisms/sheet/sheet-header.tsx +6 -0
- package/src/organisms/sheet/sheet-scroll.tsx +69 -0
- package/src/organisms/sheet/sheet.tsx +140 -0
- package/src/organisms/sheet/sheet.types.ts +93 -3
- package/src/organisms/sheet/split-sheet-children.ts +23 -0
- package/src/organisms/sheet/use-sheet-header.tsx +135 -0
- package/lib/module/organisms/sheet/sheet.android.js +0 -26
- package/lib/module/organisms/sheet/sheet.android.js.map +0 -1
- package/lib/module/organisms/sheet/sheet.ios.js +0 -25
- package/lib/module/organisms/sheet/sheet.ios.js.map +0 -1
- package/lib/typescript/organisms/sheet/sheet.ios.d.ts +0 -2
- package/src/organisms/sheet/sheet.android.tsx +0 -25
- package/src/organisms/sheet/sheet.ios.tsx +0 -23
|
@@ -1,26 +1,65 @@
|
|
|
1
|
-
import type {ReactNode} from 'react'
|
|
1
|
+
import type {ReactNode, Ref} from 'react'
|
|
2
|
+
|
|
3
|
+
import type {IconName} from '../../atoms/icon'
|
|
4
|
+
|
|
5
|
+
type NavigationBarItemBase = {
|
|
6
|
+
onPress: () => void
|
|
7
|
+
/**
|
|
8
|
+
* iOS 26: neighbouring items on one side share a glass capsule; this gives the item its own. A close next to
|
|
9
|
+
* actions usually wants it. Material has no grouped capsules, so Android ignores it.
|
|
10
|
+
*/
|
|
11
|
+
separated?: boolean
|
|
12
|
+
/** iOS: the item's accessibility identifier; Android: its test tag. */
|
|
13
|
+
testID?: string
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* One item of the bar. `back` and `close` are the platform's own — a chevron and the system close item on iOS, the
|
|
18
|
+
* Material arrow and cross on Android — with `Back` / `Close` as their labels unless given others. `icon` is one of the
|
|
19
|
+
* app's icons and names itself for VoiceOver and TalkBack.
|
|
20
|
+
*/
|
|
21
|
+
export type NavigationBarItem =
|
|
22
|
+
| (NavigationBarItemBase & {label?: string; type: 'back' | 'close'})
|
|
23
|
+
| (NavigationBarItemBase & {icon: IconName; label: string; type: 'icon'})
|
|
24
|
+
|
|
25
|
+
export type NavigationBarSearchRef = {
|
|
26
|
+
/** Empties the field and ends editing. */
|
|
27
|
+
clear: () => void
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
/** A search field in place of the title — iOS only for now; Android keeps the title. */
|
|
31
|
+
export type NavigationBarSearch = {
|
|
32
|
+
onChangeText: (text: string) => void
|
|
33
|
+
onFocusChange?: (focused: boolean) => void
|
|
34
|
+
placeholder: string
|
|
35
|
+
ref?: Ref<NavigationBarSearchRef>
|
|
36
|
+
testID?: string
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
export type NavigationBarTitleAlignment = 'center' | 'leading'
|
|
2
40
|
|
|
3
41
|
/**
|
|
4
|
-
* A title with
|
|
5
|
-
* `UINavigationBar`, so the items press and render exactly like a native-stack header's
|
|
6
|
-
*
|
|
7
|
-
*
|
|
42
|
+
* A title with items on either side, for a header that is not a navigation screen's — `Sheet.Header` is built on it.
|
|
43
|
+
* On iOS a standalone `UINavigationBar`, so the items press and render exactly like a native-stack header's: on iOS 26
|
|
44
|
+
* neighbours share a glass capsule instead of swelling as standalone glass buttons do. On Android Material's top app
|
|
45
|
+
* bar. Where an item goes is the caller's choice — the bar places nothing by itself, so a close can sit on either side.
|
|
46
|
+
* The React Native tier: it needs no host.
|
|
8
47
|
*/
|
|
9
48
|
export type NavigationBarProps = {
|
|
10
|
-
/**
|
|
11
|
-
|
|
12
|
-
/**
|
|
13
|
-
|
|
14
|
-
/**
|
|
15
|
-
|
|
16
|
-
/** iOS: the close item's accessibility identifier. */
|
|
17
|
-
closeTestID?: string
|
|
18
|
-
/** Shows the back item. */
|
|
19
|
-
onBack?: () => void
|
|
20
|
-
/** Shows the close item. */
|
|
21
|
-
onClose?: () => void
|
|
49
|
+
/** Light items and title, for a bar laid over an image or a dark hero. */
|
|
50
|
+
inverted?: boolean
|
|
51
|
+
/** In screen order, from the leading edge. */
|
|
52
|
+
leadingItems?: NavigationBarItem[]
|
|
53
|
+
/** Replaces the title with a search field (iOS). */
|
|
54
|
+
search?: NavigationBarSearch
|
|
22
55
|
testID?: string
|
|
23
56
|
title?: string
|
|
57
|
+
/** `center` by default — iOS's own; `leading` is Material's top app bar. */
|
|
58
|
+
titleAlignment?: NavigationBarTitleAlignment
|
|
59
|
+
/** Fades the title out and in without moving the items — for a large title that scrolls under the bar. */
|
|
60
|
+
titleVisible?: boolean
|
|
61
|
+
/** In screen order, toward the trailing edge. */
|
|
62
|
+
trailingItems?: NavigationBarItem[]
|
|
24
63
|
}
|
|
25
64
|
|
|
26
65
|
export type NavigationBarComponent = (props: NavigationBarProps) => ReactNode
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import type {SheetHeaderProps} from './sheet.types'
|
|
2
|
+
|
|
3
|
+
/** A slot, never rendered: `Sheet` reads its props and builds the header into the native sheet's own header area. */
|
|
4
|
+
export const SheetHeader = (_props: SheetHeaderProps): never => {
|
|
5
|
+
throw new Error('[kara-ui] <Sheet.Header> must be a direct child of <Sheet>.')
|
|
6
|
+
}
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
import {useSx} from '@hzblj/kara-sx'
|
|
2
|
+
import {createContext, useCallback, useContext, useMemo} from 'react'
|
|
3
|
+
import {ScrollView} from 'react-native'
|
|
4
|
+
|
|
5
|
+
import type {SheetScrollContextValue, SheetScrollHandler, SheetScrollViewProps} from './sheet.types'
|
|
6
|
+
|
|
7
|
+
export const SheetScrollContext = createContext<SheetScrollContextValue | null>(null)
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* For a scroll view of your own inside a sheet (a `RnFlatList`, say): pad its content by `topInset`, render
|
|
11
|
+
* `largeTitle` first, and forward `onScroll` — which is what `<Sheet.ScrollView>` does.
|
|
12
|
+
*/
|
|
13
|
+
export const useSheetScroll = (): SheetScrollContextValue => {
|
|
14
|
+
const context = useContext(SheetScrollContext)
|
|
15
|
+
|
|
16
|
+
if (context === null) {
|
|
17
|
+
throw new Error('[kara-ui] useSheetScroll and <Sheet.ScrollView> must be used inside <Sheet>.')
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
return context
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
const NO_SX = {}
|
|
24
|
+
|
|
25
|
+
/** The sheet's scrolling body: starts below the header on iOS 26, carries a large title, and reports its scroll. */
|
|
26
|
+
export const SheetScrollView = ({
|
|
27
|
+
children,
|
|
28
|
+
content,
|
|
29
|
+
keyboardShouldPersistTaps,
|
|
30
|
+
onScroll,
|
|
31
|
+
testID,
|
|
32
|
+
}: SheetScrollViewProps) => {
|
|
33
|
+
const {largeTitle, onScroll: onSheetScroll, topInset} = useSheetScroll()
|
|
34
|
+
const contentStyle = useSx(content ?? NO_SX)
|
|
35
|
+
// The header's room goes on top of the content's own top padding, not in place of it.
|
|
36
|
+
const containerStyle = useMemo(() => {
|
|
37
|
+
if (topInset === 0) {
|
|
38
|
+
return contentStyle
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
const ownTop = typeof contentStyle.paddingTop === 'number' ? contentStyle.paddingTop : 0
|
|
42
|
+
|
|
43
|
+
return [contentStyle, {paddingTop: topInset + ownTop}]
|
|
44
|
+
}, [contentStyle, topInset])
|
|
45
|
+
|
|
46
|
+
const handleScroll = useCallback<SheetScrollHandler>(
|
|
47
|
+
event => {
|
|
48
|
+
onSheetScroll?.(event)
|
|
49
|
+
onScroll?.(event)
|
|
50
|
+
},
|
|
51
|
+
[onScroll, onSheetScroll]
|
|
52
|
+
)
|
|
53
|
+
|
|
54
|
+
return (
|
|
55
|
+
<ScrollView
|
|
56
|
+
contentContainerStyle={containerStyle}
|
|
57
|
+
contentInsetAdjustmentBehavior="never"
|
|
58
|
+
keyboardShouldPersistTaps={keyboardShouldPersistTaps}
|
|
59
|
+
nestedScrollEnabled
|
|
60
|
+
onScroll={onSheetScroll || onScroll ? handleScroll : undefined}
|
|
61
|
+
overScrollMode="always"
|
|
62
|
+
scrollEventThrottle={16}
|
|
63
|
+
testID={testID}
|
|
64
|
+
>
|
|
65
|
+
{largeTitle}
|
|
66
|
+
{children}
|
|
67
|
+
</ScrollView>
|
|
68
|
+
)
|
|
69
|
+
}
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
import {useAppTheme} from '@hzblj/kara-theme'
|
|
2
|
+
import {type DetentChangeEvent, TrueSheet} from '@lodev09/react-native-true-sheet'
|
|
3
|
+
import {useCallback, useEffect, useImperativeHandle, useLayoutEffect, useMemo, useRef} from 'react'
|
|
4
|
+
import {Platform, StyleSheet, View} from 'react-native'
|
|
5
|
+
import type {SheetComponent, SheetDetent, SheetProps} from './sheet.types'
|
|
6
|
+
import {SheetHeader} from './sheet-header'
|
|
7
|
+
import {SheetScrollContext, SheetScrollView} from './sheet-scroll'
|
|
8
|
+
import {splitSheetChildren} from './split-sheet-children'
|
|
9
|
+
import {useSheetHeader} from './use-sheet-header'
|
|
10
|
+
|
|
11
|
+
const FIT_CONTENT: SheetDetent[] = ['auto']
|
|
12
|
+
|
|
13
|
+
/** Material's extra-large shape for a bottom sheet; iOS keeps the system's own, which follows the device's corners. */
|
|
14
|
+
const CORNER_RADIUS = Platform.OS === 'android' ? 28 : undefined
|
|
15
|
+
|
|
16
|
+
/** Keeps the sheet's own native view out of the layout it is declared in. */
|
|
17
|
+
const styles = StyleSheet.create({
|
|
18
|
+
host: {position: 'absolute'},
|
|
19
|
+
})
|
|
20
|
+
|
|
21
|
+
const SheetRoot = ({
|
|
22
|
+
bg = 'surface.primary',
|
|
23
|
+
children,
|
|
24
|
+
detents = FIT_CONTENT,
|
|
25
|
+
dimmed = true,
|
|
26
|
+
dismissible = true,
|
|
27
|
+
draggable = true,
|
|
28
|
+
footer,
|
|
29
|
+
grabber = true,
|
|
30
|
+
onDetentChange,
|
|
31
|
+
onDismiss,
|
|
32
|
+
onPresent,
|
|
33
|
+
ref,
|
|
34
|
+
scrollable = false,
|
|
35
|
+
testID,
|
|
36
|
+
visible,
|
|
37
|
+
}: SheetProps) => {
|
|
38
|
+
const theme = useAppTheme()
|
|
39
|
+
const {content, header: headerProps} = useMemo(() => splitSheetChildren(children), [children])
|
|
40
|
+
const sheetHeader = useSheetHeader({header: headerProps, scrollable})
|
|
41
|
+
const sheetRef = useRef<TrueSheet>(null)
|
|
42
|
+
const presented = useRef(false)
|
|
43
|
+
/** A dismissal we asked for: `onDismiss` reports the user's, never ours. */
|
|
44
|
+
const programmaticDismiss = useRef(false)
|
|
45
|
+
|
|
46
|
+
useImperativeHandle(
|
|
47
|
+
ref,
|
|
48
|
+
() => ({
|
|
49
|
+
dismiss: () => {
|
|
50
|
+
presented.current = false
|
|
51
|
+
programmaticDismiss.current = true
|
|
52
|
+
return sheetRef.current?.dismiss() ?? Promise.resolve()
|
|
53
|
+
},
|
|
54
|
+
present: detentIndex => {
|
|
55
|
+
presented.current = true
|
|
56
|
+
return sheetRef.current?.present(detentIndex) ?? Promise.resolve()
|
|
57
|
+
},
|
|
58
|
+
resize: detentIndex => sheetRef.current?.resize(detentIndex) ?? Promise.resolve(),
|
|
59
|
+
}),
|
|
60
|
+
[]
|
|
61
|
+
)
|
|
62
|
+
|
|
63
|
+
useEffect(() => {
|
|
64
|
+
if (visible && !presented.current) {
|
|
65
|
+
presented.current = true
|
|
66
|
+
void sheetRef.current?.present()
|
|
67
|
+
} else if (!visible && presented.current) {
|
|
68
|
+
presented.current = false
|
|
69
|
+
programmaticDismiss.current = true
|
|
70
|
+
void sheetRef.current?.dismiss()
|
|
71
|
+
}
|
|
72
|
+
}, [visible])
|
|
73
|
+
|
|
74
|
+
// A sheet unmounted while presented would otherwise stay on screen, blocking everything under it.
|
|
75
|
+
useLayoutEffect(() => {
|
|
76
|
+
const sheet = sheetRef.current
|
|
77
|
+
|
|
78
|
+
return () => {
|
|
79
|
+
if (!presented.current) {
|
|
80
|
+
return
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
presented.current = false
|
|
84
|
+
programmaticDismiss.current = true
|
|
85
|
+
void sheet?.dismiss()
|
|
86
|
+
}
|
|
87
|
+
}, [])
|
|
88
|
+
|
|
89
|
+
const handleDidDismiss = useCallback(() => {
|
|
90
|
+
presented.current = false
|
|
91
|
+
|
|
92
|
+
if (programmaticDismiss.current) {
|
|
93
|
+
programmaticDismiss.current = false
|
|
94
|
+
return
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
onDismiss()
|
|
98
|
+
}, [onDismiss])
|
|
99
|
+
|
|
100
|
+
const handleDetentChange = useCallback(
|
|
101
|
+
(event: DetentChangeEvent) => onDetentChange?.(event.nativeEvent.index),
|
|
102
|
+
[onDetentChange]
|
|
103
|
+
)
|
|
104
|
+
|
|
105
|
+
return (
|
|
106
|
+
<View collapsable={false} pointerEvents="box-none" style={styles.host}>
|
|
107
|
+
<TrueSheet
|
|
108
|
+
backgroundColor={theme.color(bg)}
|
|
109
|
+
cornerRadius={CORNER_RADIUS}
|
|
110
|
+
detents={detents}
|
|
111
|
+
dimmed={dimmed}
|
|
112
|
+
dismissible={dismissible}
|
|
113
|
+
draggable={draggable}
|
|
114
|
+
footer={footer}
|
|
115
|
+
grabber={grabber}
|
|
116
|
+
header={sheetHeader.header}
|
|
117
|
+
headerStyle={sheetHeader.headerStyle}
|
|
118
|
+
onDetentChange={handleDetentChange}
|
|
119
|
+
onDidDismiss={handleDidDismiss}
|
|
120
|
+
onDidPresent={onPresent}
|
|
121
|
+
ref={sheetRef}
|
|
122
|
+
scrollable={scrollable}
|
|
123
|
+
scrollableOptions={sheetHeader.scrollableOptions}
|
|
124
|
+
testID={testID}
|
|
125
|
+
>
|
|
126
|
+
<SheetScrollContext.Provider value={sheetHeader.scrollContext}>
|
|
127
|
+
{sheetHeader.staticLargeTitle}
|
|
128
|
+
{content}
|
|
129
|
+
</SheetScrollContext.Provider>
|
|
130
|
+
</TrueSheet>
|
|
131
|
+
</View>
|
|
132
|
+
)
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* A native sheet with an optional native header. `visible` presents and dismisses it; a swipe or a tap outside calls
|
|
137
|
+
* `onDismiss`, which should set `visible` back. `<Sheet.Header>` (a direct child) gives it a bar with a title and
|
|
138
|
+
* items; `<Sheet.ScrollView>` is the body of a `scrollable` sheet.
|
|
139
|
+
*/
|
|
140
|
+
export const Sheet: SheetComponent = Object.assign(SheetRoot, {Header: SheetHeader, ScrollView: SheetScrollView})
|
|
@@ -1,10 +1,100 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type {ResponsiveViewSx} from '@hzblj/kara-sx'
|
|
2
|
+
import type {ColorToken} from '@hzblj/kara-theme'
|
|
3
|
+
import type {ReactElement, ReactNode, Ref} from 'react'
|
|
4
|
+
import type {NativeScrollEvent, NativeSyntheticEvent, ScrollViewProps} from 'react-native'
|
|
5
|
+
import type {NavigationBarItem, NavigationBarSearch} from '../../molecules/navigation-bar'
|
|
2
6
|
|
|
7
|
+
/** `auto` fits the content; a number is a fraction of the screen's height. */
|
|
8
|
+
export type SheetDetent = 'auto' | number
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* `center` is iOS's own, `leading` Material's. `large` puts the title above the content in a large face, and once
|
|
12
|
+
* that scrolls under the bar the bar's own title fades in — centred on iOS, leading on Android.
|
|
13
|
+
*/
|
|
14
|
+
export type SheetTitleStyle = 'center' | 'large' | 'leading'
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* The sheet's header: a `NavigationBar` with the title and items, and anything else that should stay put above the
|
|
18
|
+
* content (`children` — a segmented control, a search hint). On iOS 26 a scrollable sheet's content scrolls under it
|
|
19
|
+
* with the system's scroll edge effect; elsewhere it sits above the content.
|
|
20
|
+
*/
|
|
21
|
+
export type SheetHeaderProps = {
|
|
22
|
+
/** Pinned under the bar. */
|
|
23
|
+
children?: ReactNode
|
|
24
|
+
/** Light items and title, for a sheet with a dark or image background. */
|
|
25
|
+
inverted?: boolean
|
|
26
|
+
/** In screen order, from the leading edge. */
|
|
27
|
+
leadingItems?: NavigationBarItem[]
|
|
28
|
+
/** A search field in place of the title (iOS). */
|
|
29
|
+
search?: NavigationBarSearch
|
|
30
|
+
title?: string
|
|
31
|
+
/** `center` by default. */
|
|
32
|
+
titleStyle?: SheetTitleStyle
|
|
33
|
+
/** In screen order, toward the trailing edge — the close item, by convention. */
|
|
34
|
+
trailingItems?: NavigationBarItem[]
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
export type SheetRef = {
|
|
38
|
+
dismiss: () => Promise<void>
|
|
39
|
+
/** Presents at a detent — the first by default. */
|
|
40
|
+
present: (detentIndex?: number) => Promise<void>
|
|
41
|
+
/** Moves to another detent. */
|
|
42
|
+
resize: (detentIndex: number) => Promise<void>
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* A native sheet — `UISheetPresentationController` on iOS, Material's bottom sheet on Android — with an optional
|
|
47
|
+
* native header (`<Sheet.Header>` as a direct child). The React Native tier: it needs no host, and must not sit inside
|
|
48
|
+
* one; native atoms in its content go in an `Island`.
|
|
49
|
+
*/
|
|
3
50
|
export type SheetProps = {
|
|
51
|
+
/** The sheet's colour. `surface.primary` by default. */
|
|
52
|
+
bg?: ColorToken
|
|
4
53
|
children: ReactNode
|
|
5
|
-
|
|
54
|
+
/** Where the sheet can rest, smallest first. `['auto']` — fit the content — by default. */
|
|
55
|
+
detents?: SheetDetent[]
|
|
56
|
+
/** Dims what is behind. On by default. */
|
|
57
|
+
dimmed?: boolean
|
|
58
|
+
/** A swipe down or a tap outside closes it. On by default. */
|
|
59
|
+
dismissible?: boolean
|
|
60
|
+
/** It follows the finger between detents. On by default. */
|
|
61
|
+
draggable?: boolean
|
|
62
|
+
/** Pinned to the bottom, above the content and the keyboard. */
|
|
63
|
+
footer?: ReactElement
|
|
64
|
+
/** The drag handle. On by default. */
|
|
65
|
+
grabber?: boolean
|
|
66
|
+
/** The user dismissed it — `visible` going false does not call this. */
|
|
6
67
|
onDismiss: () => void
|
|
68
|
+
onDetentChange?: (detentIndex: number) => void
|
|
69
|
+
onPresent?: () => void
|
|
70
|
+
ref?: Ref<SheetRef>
|
|
71
|
+
/**
|
|
72
|
+
* The content is a scroll view (`<Sheet.ScrollView>`) the sheet drives: dragging past its top resizes the sheet,
|
|
73
|
+
* and a header scrolls with the iOS 26 edge effect. Off by default — set it with a scrolling body.
|
|
74
|
+
*/
|
|
75
|
+
scrollable?: boolean
|
|
76
|
+
testID?: string
|
|
7
77
|
visible: boolean
|
|
8
78
|
}
|
|
9
79
|
|
|
10
|
-
export type
|
|
80
|
+
export type SheetScrollHandler = (event: NativeSyntheticEvent<NativeScrollEvent>) => void
|
|
81
|
+
|
|
82
|
+
/** What a scroll view inside a sheet needs: the room the header takes, the large title, the scroll listener. */
|
|
83
|
+
export type SheetScrollContextValue = {
|
|
84
|
+
largeTitle: ReactNode
|
|
85
|
+
onScroll?: SheetScrollHandler
|
|
86
|
+
topInset: number
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
export type SheetScrollViewProps = Pick<ScrollViewProps, 'keyboardShouldPersistTaps'> & {
|
|
90
|
+
children: ReactNode
|
|
91
|
+
/** Styles the scrolling content — padding and gap belong here, as with `RnScrollView`. */
|
|
92
|
+
content?: ResponsiveViewSx
|
|
93
|
+
onScroll?: SheetScrollHandler
|
|
94
|
+
testID?: string
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
export type SheetComponent = ((props: SheetProps) => ReactNode) & {
|
|
98
|
+
Header: (props: SheetHeaderProps) => ReactNode
|
|
99
|
+
ScrollView: (props: SheetScrollViewProps) => ReactNode
|
|
100
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import {Children, isValidElement, type ReactElement, type ReactNode} from 'react'
|
|
2
|
+
import type {SheetHeaderProps} from './sheet.types'
|
|
3
|
+
import {SheetHeader} from './sheet-header'
|
|
4
|
+
|
|
5
|
+
type SheetChildren = {
|
|
6
|
+
content: ReactNode
|
|
7
|
+
header?: SheetHeaderProps
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
const isSheetHeader = (child: ReactNode): child is ReactElement<SheetHeaderProps> =>
|
|
11
|
+
isValidElement(child) && child.type === SheetHeader
|
|
12
|
+
|
|
13
|
+
/** Takes `<Sheet.Header>` out of the children: its props become the native header, the rest is the content. */
|
|
14
|
+
export const splitSheetChildren = (children: ReactNode): SheetChildren => {
|
|
15
|
+
const nodes = Children.toArray(children)
|
|
16
|
+
const header = nodes.find(isSheetHeader)
|
|
17
|
+
|
|
18
|
+
if (!header) {
|
|
19
|
+
return {content: children}
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
return {content: nodes.filter(node => node !== header), header: header.props}
|
|
23
|
+
}
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
import {isScrollEdgeEffectAvailable} from '@hzblj/kara-native'
|
|
2
|
+
import {spacing} from '@hzblj/kara-theme'
|
|
3
|
+
import {useCallback, useMemo, useRef, useState} from 'react'
|
|
4
|
+
import {type LayoutChangeEvent, Platform, type ViewStyle} from 'react-native'
|
|
5
|
+
|
|
6
|
+
import {Box} from '../../atoms/box'
|
|
7
|
+
import {RnText} from '../../atoms/rn-text'
|
|
8
|
+
import {NavigationBar, type NavigationBarTitleAlignment} from '../../molecules/navigation-bar'
|
|
9
|
+
import type {SheetHeaderProps, SheetScrollContextValue, SheetScrollHandler} from './sheet.types'
|
|
10
|
+
|
|
11
|
+
type UseSheetHeaderParams = {
|
|
12
|
+
header?: SheetHeaderProps
|
|
13
|
+
scrollable: boolean
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
/** The bar's own height (`NavigationBar`) plus the room above it, before the header has been measured. */
|
|
17
|
+
const ESTIMATED_HEADER_HEIGHT = (Platform.OS === 'ios' ? 56 : 64) + spacing.s16
|
|
18
|
+
|
|
19
|
+
/** Where a large title's bar title appears once it has scrolled away: the platform's own place for it. */
|
|
20
|
+
const COLLAPSED_TITLE_ALIGNMENT: NavigationBarTitleAlignment = Platform.OS === 'ios' ? 'center' : 'leading'
|
|
21
|
+
|
|
22
|
+
/** Lays the header over the content so the content can scroll under it — the edge effect needs it there. */
|
|
23
|
+
const OVERLAY_HEADER_STYLE: ViewStyle = {left: 0, position: 'absolute', right: 0, top: 0, zIndex: 1}
|
|
24
|
+
|
|
25
|
+
const SOFT_EDGE_EFFECTS = {bottomScrollEdgeEffect: 'soft', topScrollEdgeEffect: 'soft'} as const
|
|
26
|
+
|
|
27
|
+
const SheetLargeTitle = ({onLayout, title}: {onLayout: (event: LayoutChangeEvent) => void; title: string}) => (
|
|
28
|
+
<Box onLayout={onLayout} pb="s8" pt="s8" px="s16">
|
|
29
|
+
<RnText accessibilityRole="header" variant="headingM">
|
|
30
|
+
{title}
|
|
31
|
+
</RnText>
|
|
32
|
+
</Box>
|
|
33
|
+
)
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* Turns `<Sheet.Header>`'s props into what the native sheet takes: its header element, how that is laid out, the scroll
|
|
37
|
+
* edge effects, and the context a `<Sheet.ScrollView>` reads. On iOS 26 a scrollable sheet's header is laid over the
|
|
38
|
+
* content (which is then inset by the header's measured height) so the system's soft edge blurs what scrolls under it;
|
|
39
|
+
* everywhere else the header simply sits above the content.
|
|
40
|
+
*/
|
|
41
|
+
export const useSheetHeader = ({header: headerProps, scrollable}: UseSheetHeaderParams) => {
|
|
42
|
+
const title = headerProps?.title
|
|
43
|
+
const titleStyle = headerProps?.titleStyle ?? 'center'
|
|
44
|
+
const leadingItems = headerProps?.leadingItems
|
|
45
|
+
const trailingItems = headerProps?.trailingItems
|
|
46
|
+
const inverted = headerProps?.inverted
|
|
47
|
+
const search = headerProps?.search
|
|
48
|
+
const accessory = headerProps?.children
|
|
49
|
+
const hasBar = title !== undefined || !!leadingItems?.length || !!trailingItems?.length || !!search
|
|
50
|
+
const hasHeader = hasBar || !!accessory
|
|
51
|
+
const isOverlay = isScrollEdgeEffectAvailable() && hasHeader && scrollable
|
|
52
|
+
const isLargeTitle = titleStyle === 'large' && !!title
|
|
53
|
+
|
|
54
|
+
const [headerHeight, setHeaderHeight] = useState(hasBar ? ESTIMATED_HEADER_HEIGHT : 0)
|
|
55
|
+
const [largeTitleScrolledAway, setLargeTitleScrolledAway] = useState(false)
|
|
56
|
+
const largeTitleHeight = useRef(0)
|
|
57
|
+
|
|
58
|
+
const handleHeaderLayout = useCallback((event: LayoutChangeEvent) => {
|
|
59
|
+
setHeaderHeight(event.nativeEvent.layout.height)
|
|
60
|
+
}, [])
|
|
61
|
+
|
|
62
|
+
const handleLargeTitleLayout = useCallback((event: LayoutChangeEvent) => {
|
|
63
|
+
largeTitleHeight.current = event.nativeEvent.layout.height
|
|
64
|
+
}, [])
|
|
65
|
+
|
|
66
|
+
const handleScroll = useCallback<SheetScrollHandler>(event => {
|
|
67
|
+
if (largeTitleHeight.current === 0) {
|
|
68
|
+
return
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
setLargeTitleScrolledAway(event.nativeEvent.contentOffset.y >= largeTitleHeight.current)
|
|
72
|
+
}, [])
|
|
73
|
+
|
|
74
|
+
const titleAlignment: NavigationBarTitleAlignment = titleStyle === 'large' ? COLLAPSED_TITLE_ALIGNMENT : titleStyle
|
|
75
|
+
const titleVisible = !isLargeTitle || (scrollable && largeTitleScrolledAway)
|
|
76
|
+
|
|
77
|
+
const headerElement = useMemo(() => {
|
|
78
|
+
if (!hasHeader) {
|
|
79
|
+
return undefined
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
return (
|
|
83
|
+
<Box onLayout={isOverlay ? handleHeaderLayout : undefined} pt="s16">
|
|
84
|
+
{hasBar ? (
|
|
85
|
+
<NavigationBar
|
|
86
|
+
inverted={inverted}
|
|
87
|
+
leadingItems={leadingItems}
|
|
88
|
+
search={search}
|
|
89
|
+
title={title}
|
|
90
|
+
titleAlignment={titleAlignment}
|
|
91
|
+
titleVisible={titleVisible}
|
|
92
|
+
trailingItems={trailingItems}
|
|
93
|
+
/>
|
|
94
|
+
) : null}
|
|
95
|
+
{accessory}
|
|
96
|
+
</Box>
|
|
97
|
+
)
|
|
98
|
+
}, [
|
|
99
|
+
accessory,
|
|
100
|
+
handleHeaderLayout,
|
|
101
|
+
hasBar,
|
|
102
|
+
hasHeader,
|
|
103
|
+
inverted,
|
|
104
|
+
isOverlay,
|
|
105
|
+
leadingItems,
|
|
106
|
+
search,
|
|
107
|
+
title,
|
|
108
|
+
titleAlignment,
|
|
109
|
+
titleVisible,
|
|
110
|
+
trailingItems,
|
|
111
|
+
])
|
|
112
|
+
|
|
113
|
+
const largeTitle = useMemo(
|
|
114
|
+
() => (title && isLargeTitle ? <SheetLargeTitle onLayout={handleLargeTitleLayout} title={title} /> : null),
|
|
115
|
+
[handleLargeTitleLayout, isLargeTitle, title]
|
|
116
|
+
)
|
|
117
|
+
|
|
118
|
+
const scrollContext = useMemo<SheetScrollContextValue>(
|
|
119
|
+
() => ({
|
|
120
|
+
largeTitle: scrollable ? largeTitle : null,
|
|
121
|
+
onScroll: scrollable && isLargeTitle ? handleScroll : undefined,
|
|
122
|
+
topInset: isOverlay ? headerHeight : 0,
|
|
123
|
+
}),
|
|
124
|
+
[handleScroll, headerHeight, isLargeTitle, isOverlay, largeTitle, scrollable]
|
|
125
|
+
)
|
|
126
|
+
|
|
127
|
+
return {
|
|
128
|
+
header: headerElement,
|
|
129
|
+
headerStyle: isOverlay ? OVERLAY_HEADER_STYLE : undefined,
|
|
130
|
+
scrollableOptions: isOverlay ? SOFT_EDGE_EFFECTS : undefined,
|
|
131
|
+
scrollContext,
|
|
132
|
+
/** Without a scroll view to carry it, a large title simply leads the content. */
|
|
133
|
+
staticLargeTitle: scrollable ? null : largeTitle,
|
|
134
|
+
}
|
|
135
|
+
}
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
|
|
3
|
-
import { ModalBottomSheet } from '@expo/ui/jetpack-compose';
|
|
4
|
-
import { useAppTheme } from '@hzblj/kara-theme';
|
|
5
|
-
import { useHostGuard } from "../../host-context.js";
|
|
6
|
-
import { jsx as _jsx } from "react/jsx-runtime";
|
|
7
|
-
export const Sheet = ({
|
|
8
|
-
children,
|
|
9
|
-
fitToContents = true,
|
|
10
|
-
onDismiss,
|
|
11
|
-
visible
|
|
12
|
-
}) => {
|
|
13
|
-
useHostGuard('Sheet');
|
|
14
|
-
const theme = useAppTheme();
|
|
15
|
-
if (!visible) {
|
|
16
|
-
return null;
|
|
17
|
-
}
|
|
18
|
-
return /*#__PURE__*/_jsx(ModalBottomSheet, {
|
|
19
|
-
containerColor: theme.color('surface.primary'),
|
|
20
|
-
contentColor: theme.color('content.primary'),
|
|
21
|
-
onDismissRequest: onDismiss,
|
|
22
|
-
skipPartiallyExpanded: fitToContents,
|
|
23
|
-
children: children
|
|
24
|
-
});
|
|
25
|
-
};
|
|
26
|
-
//# sourceMappingURL=sheet.android.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"names":["ModalBottomSheet","useAppTheme","useHostGuard","jsx","_jsx","Sheet","children","fitToContents","onDismiss","visible","theme","containerColor","color","contentColor","onDismissRequest","skipPartiallyExpanded"],"sourceRoot":"../../../../src","sources":["organisms/sheet/sheet.android.tsx"],"mappings":";;AAAA,SAAQA,gBAAgB,QAAO,0BAA0B;AACzD,SAAQC,WAAW,QAAO,mBAAmB;AAE7C,SAAQC,YAAY,QAAO,uBAAoB;AAAA,SAAAC,GAAA,IAAAC,IAAA;AAG/C,OAAO,MAAMC,KAAqB,GAAGA,CAAC;EAACC,QAAQ;EAAEC,aAAa,GAAG,IAAI;EAAEC,SAAS;EAAEC;AAAmB,CAAC,KAAK;EACzGP,YAAY,CAAC,OAAO,CAAC;EACrB,MAAMQ,KAAK,GAAGT,WAAW,CAAC,CAAC;EAE3B,IAAI,CAACQ,OAAO,EAAE;IACZ,OAAO,IAAI;EACb;EAEA,oBACEL,IAAA,CAACJ,gBAAgB;IACfW,cAAc,EAAED,KAAK,CAACE,KAAK,CAAC,iBAAiB,CAAE;IAC/CC,YAAY,EAAEH,KAAK,CAACE,KAAK,CAAC,iBAAiB,CAAE;IAC7CE,gBAAgB,EAAEN,SAAU;IAC5BO,qBAAqB,EAAER,aAAc;IAAAD,QAAA,EAEpCA;EAAQ,CACO,CAAC;AAEvB,CAAC","ignoreList":[]}
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
|
|
3
|
-
import { BottomSheet } from '@expo/ui/swift-ui';
|
|
4
|
-
import { useHostGuard } from "../../host-context.js";
|
|
5
|
-
import { jsx as _jsx } from "react/jsx-runtime";
|
|
6
|
-
export const Sheet = ({
|
|
7
|
-
children,
|
|
8
|
-
fitToContents = true,
|
|
9
|
-
onDismiss,
|
|
10
|
-
visible
|
|
11
|
-
}) => {
|
|
12
|
-
useHostGuard('Sheet');
|
|
13
|
-
return /*#__PURE__*/_jsx(BottomSheet, {
|
|
14
|
-
fitToContents: fitToContents,
|
|
15
|
-
isPresented: visible,
|
|
16
|
-
onDismiss: onDismiss,
|
|
17
|
-
onIsPresentedChange: next => {
|
|
18
|
-
if (!next) {
|
|
19
|
-
onDismiss();
|
|
20
|
-
}
|
|
21
|
-
},
|
|
22
|
-
children: children
|
|
23
|
-
});
|
|
24
|
-
};
|
|
25
|
-
//# sourceMappingURL=sheet.ios.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"names":["BottomSheet","useHostGuard","jsx","_jsx","Sheet","children","fitToContents","onDismiss","visible","isPresented","onIsPresentedChange","next"],"sourceRoot":"../../../../src","sources":["organisms/sheet/sheet.ios.tsx"],"mappings":";;AAAA,SAAQA,WAAW,QAAO,mBAAmB;AAE7C,SAAQC,YAAY,QAAO,uBAAoB;AAAA,SAAAC,GAAA,IAAAC,IAAA;AAG/C,OAAO,MAAMC,KAAqB,GAAGA,CAAC;EAACC,QAAQ;EAAEC,aAAa,GAAG,IAAI;EAAEC,SAAS;EAAEC;AAAmB,CAAC,KAAK;EACzGP,YAAY,CAAC,OAAO,CAAC;EAErB,oBACEE,IAAA,CAACH,WAAW;IACVM,aAAa,EAAEA,aAAc;IAC7BG,WAAW,EAAED,OAAQ;IACrBD,SAAS,EAAEA,SAAU;IACrBG,mBAAmB,EAAEC,IAAI,IAAI;MAC3B,IAAI,CAACA,IAAI,EAAE;QACTJ,SAAS,CAAC,CAAC;MACb;IACF,CAAE;IAAAF,QAAA,EAEDA;EAAQ,CACE,CAAC;AAElB,CAAC","ignoreList":[]}
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
import {ModalBottomSheet} from '@expo/ui/jetpack-compose'
|
|
2
|
-
import {useAppTheme} from '@hzblj/kara-theme'
|
|
3
|
-
|
|
4
|
-
import {useHostGuard} from '../../host-context'
|
|
5
|
-
import type {SheetComponent, SheetProps} from './sheet.types'
|
|
6
|
-
|
|
7
|
-
export const Sheet: SheetComponent = ({children, fitToContents = true, onDismiss, visible}: SheetProps) => {
|
|
8
|
-
useHostGuard('Sheet')
|
|
9
|
-
const theme = useAppTheme()
|
|
10
|
-
|
|
11
|
-
if (!visible) {
|
|
12
|
-
return null
|
|
13
|
-
}
|
|
14
|
-
|
|
15
|
-
return (
|
|
16
|
-
<ModalBottomSheet
|
|
17
|
-
containerColor={theme.color('surface.primary')}
|
|
18
|
-
contentColor={theme.color('content.primary')}
|
|
19
|
-
onDismissRequest={onDismiss}
|
|
20
|
-
skipPartiallyExpanded={fitToContents}
|
|
21
|
-
>
|
|
22
|
-
{children}
|
|
23
|
-
</ModalBottomSheet>
|
|
24
|
-
)
|
|
25
|
-
}
|