@jobber/components-native 0.107.3 → 0.108.1
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/dist/docs/ContentOverlay/ContentOverlay.md +4 -0
- package/dist/docs/InputTime/InputTime.md +8 -0
- package/dist/docs/ProgressBar/ProgressBar.md +9 -0
- package/dist/package.json +2 -2
- package/dist/src/ContentOverlay/ContentOverlay.js +15 -10
- package/dist/src/ContentOverlay/computeContentOverlayBehavior.js +7 -4
- package/dist/src/ContentOverlay/computeContentOverlayBehavior.test.js +31 -0
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/dist/types/src/ContentOverlay/ContentOverlay.d.ts +1 -1
- package/dist/types/src/ContentOverlay/computeContentOverlayBehavior.d.ts +1 -0
- package/dist/types/src/ContentOverlay/types.d.ts +23 -0
- package/package.json +2 -2
- package/src/ContentOverlay/ContentOverlay.tsx +57 -33
- package/src/ContentOverlay/computeContentOverlayBehavior.test.ts +40 -0
- package/src/ContentOverlay/computeContentOverlayBehavior.ts +8 -4
- package/src/ContentOverlay/types.ts +28 -0
|
@@ -50,6 +50,9 @@ where it will be a maximum width of 640px and be centered on the screen.
|
|
|
50
50
|
| `children` | `ReactNode` | Yes | — | Content to be passed into the overlay |
|
|
51
51
|
| `accessibilityLabel` | `string` | No | `"Close {title} modal"` | Optional accessibilityLabel describing the overlay. This will read out when the overlay is opened. |
|
|
52
52
|
| `adjustToContentHeight` | `boolean` | No | `false` | If true, automatically adjusts the overlay height to the content height. This will disable the ability to drag the ov... |
|
|
53
|
+
| `allowDragWithBeforeExit` | `boolean` | No | `false` | When `true`, `onBeforeExit` intercepts the dismiss button and back press but does not disable drag. Drag-to-dismiss b... |
|
|
54
|
+
| `enableContentPanningGesture` | `boolean` | No | — | Whether pan on the content area drags the sheet. Set `false` to let nested scrollables own the gesture. Defaults to t... |
|
|
55
|
+
| `enablePanDownToClose` | `boolean` | No | — | Whether panning down on the content area closes the sheet. Set false to prevent the sheet from being closed by pannin... |
|
|
53
56
|
| `fullScreen` | `boolean` | No | `false` | Force overlay height to fill the screen. Width not impacted. |
|
|
54
57
|
| `isDraggable` | `boolean` | No | `true` | If false, hides the handle and turns off dragging. |
|
|
55
58
|
| `keyboardShouldPersistTaps` | `boolean` | No | `false` | Allows taps to be registered behind keyboard if enabled |
|
|
@@ -61,4 +64,5 @@ where it will be a maximum width of 640px and be centered on the screen.
|
|
|
61
64
|
| `ref` | `Ref<{ open?: () => void; close?: () => void; }>` | No | — | Ref to the content overlay component. |
|
|
62
65
|
| `scrollEnabled` | `boolean` | No | `false` | Enables scrolling in the content body of overlay |
|
|
63
66
|
| `showDismiss` | `boolean` | No | `false` | Display the dismiss button in the header of the overlay. |
|
|
67
|
+
| `snapPoints` | `(string | number)[]` | No | — | Explicit snap points for the overlay (percentages or pixel values). When provided, `adjustToContentHeight` is ignored... |
|
|
64
68
|
| `title` | `string` | No | — | Title of overlay, appears in the header next to the close button. |
|
|
@@ -29,6 +29,14 @@ number automatically fills in the rest of the time. For example, typing `2` will
|
|
|
29
29
|
fill in `2:00 PM` and typing `1` waits for a few milliseconds in case the user
|
|
30
30
|
wants to type `10`, `11`, or `12`.
|
|
31
31
|
|
|
32
|
+
## Sizes and the placeholder
|
|
33
|
+
|
|
34
|
+
Consistent with other inputs, `size="small"` does not show the floating mini
|
|
35
|
+
label. The placeholder appears while the field is empty and unfocused, and is
|
|
36
|
+
hidden while the field is being edited or has a value, keeping the field at its
|
|
37
|
+
small height throughout. The default and `large` sizes float the placeholder up
|
|
38
|
+
as a mini label while editing or once a value is set.
|
|
39
|
+
|
|
32
40
|
|
|
33
41
|
## Props
|
|
34
42
|
|
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
# Progress Bar
|
|
2
2
|
|
|
3
|
+
> **Deprecated.** Use [ProgressIndicator](/components/ProgressIndicator) for new
|
|
4
|
+
> work. `ProgressIndicator` is the supported determinate progress indicator
|
|
5
|
+
> going forward — it offers the same semantic with a cleaner prop surface
|
|
6
|
+
> (`value` / `max` instead of `currentStep` / `totalSteps`,
|
|
7
|
+
> `variation="continuous"` instead of `"progress"`, plain `className` / `style`
|
|
8
|
+
> instead of `UNSAFE_*`), theme-adaptive tokens, and a unified
|
|
9
|
+
> `<div role="progressbar">` structure across continuous and stepped variations.
|
|
10
|
+
> `ProgressBar` continues to work unchanged for existing call sites.
|
|
11
|
+
|
|
3
12
|
A ProgressBar is a visual indicator of how close something is to completion.
|
|
4
13
|
|
|
5
14
|
## Design & usage guidelines
|
package/dist/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@jobber/components-native",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.108.1",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"description": "React Native implementation of Atlantis",
|
|
6
6
|
"repository": {
|
|
@@ -124,5 +124,5 @@
|
|
|
124
124
|
"react-native-screens": ">=4.18.0",
|
|
125
125
|
"react-native-svg": ">=12.0.0"
|
|
126
126
|
},
|
|
127
|
-
"gitHead": "
|
|
127
|
+
"gitHead": "7d8b08e91839f535411288b03a8603f2df310a8e"
|
|
128
128
|
}
|
|
@@ -23,7 +23,7 @@ import { useIsScreenReaderEnabled } from "../hooks";
|
|
|
23
23
|
import { IconButton } from "../IconButton";
|
|
24
24
|
import { Heading } from "../Heading";
|
|
25
25
|
import { useAtlantisI18n } from "../hooks/useAtlantisI18n";
|
|
26
|
-
import { useAtlantisTheme } from "../AtlantisThemeContext";
|
|
26
|
+
import { AtlantisThemeContextProvider, useAtlantisTheme, } from "../AtlantisThemeContext";
|
|
27
27
|
/**
|
|
28
28
|
* Signals whether keyboard handling inside a ContentOverlay is delegated to
|
|
29
29
|
* a keyboard-aware scroll view (e.g. BottomSheetKeyboardAwareScrollView).
|
|
@@ -46,7 +46,7 @@ function getModalBackgroundColor(variation, tokens) {
|
|
|
46
46
|
}
|
|
47
47
|
}
|
|
48
48
|
// eslint-disable-next-line max-statements
|
|
49
|
-
export function ContentOverlay({ children, title, accessibilityLabel, fullScreen = false, showDismiss = false, isDraggable = true, adjustToContentHeight = false, keyboardShouldPersistTaps = false, scrollEnabled = false, modalBackgroundColor = "surface", onClose, onOpen, onBeforeExit, loading = false, ref, }) {
|
|
49
|
+
export function ContentOverlay({ children, title, accessibilityLabel, fullScreen = false, showDismiss = false, isDraggable = true, adjustToContentHeight = false, keyboardShouldPersistTaps = false, scrollEnabled = false, modalBackgroundColor = "surface", onClose, onOpen, onBeforeExit, allowDragWithBeforeExit = false, enablePanDownToClose, enableContentPanningGesture, snapPoints: customSnapPoints, loading = false, ref, }) {
|
|
50
50
|
const insets = useSafeAreaInsets();
|
|
51
51
|
const { width: windowWidth } = useWindowDimensions();
|
|
52
52
|
const bottomSheetModalRef = useRef(null);
|
|
@@ -54,13 +54,14 @@ export function ContentOverlay({ children, title, accessibilityLabel, fullScreen
|
|
|
54
54
|
const [currentPosition, setCurrentPosition] = useState(-1);
|
|
55
55
|
const styles = useStyles();
|
|
56
56
|
const { t } = useAtlantisI18n();
|
|
57
|
-
const { tokens } = useAtlantisTheme();
|
|
57
|
+
const { theme, tokens } = useAtlantisTheme();
|
|
58
58
|
const isScreenReaderEnabled = useIsScreenReaderEnabled();
|
|
59
59
|
const behavior = computeContentOverlayBehavior({
|
|
60
60
|
fullScreen,
|
|
61
61
|
adjustToContentHeight,
|
|
62
62
|
isDraggable,
|
|
63
63
|
hasOnBeforeExit: onBeforeExit !== undefined,
|
|
64
|
+
allowDragWithBeforeExit,
|
|
64
65
|
showDismiss,
|
|
65
66
|
}, {
|
|
66
67
|
isScreenReaderEnabled,
|
|
@@ -76,12 +77,15 @@ export function ContentOverlay({ children, title, accessibilityLabel, fullScreen
|
|
|
76
77
|
const scrollViewRef = useRef(null);
|
|
77
78
|
// enableDynamicSizing will add another snap point of the content height
|
|
78
79
|
const snapPoints = useMemo(() => {
|
|
80
|
+
if (customSnapPoints && customSnapPoints.length > 0) {
|
|
81
|
+
return customSnapPoints;
|
|
82
|
+
}
|
|
79
83
|
// There is a bug with "restore" behavior after keyboard is dismissed.
|
|
80
84
|
// https://github.com/gorhom/react-native-bottom-sheet/issues/2465
|
|
81
85
|
// providing a 100% snap point "fixes" it for now, but there is an approved PR to fix it
|
|
82
86
|
// that just needs to be merged and released: https://github.com/gorhom/react-native-bottom-sheet/pull/2511
|
|
83
87
|
return ["100%"];
|
|
84
|
-
}, []);
|
|
88
|
+
}, [customSnapPoints]);
|
|
85
89
|
const onCloseController = () => {
|
|
86
90
|
var _a;
|
|
87
91
|
if (!onBeforeExit) {
|
|
@@ -174,12 +178,13 @@ export function ContentOverlay({ children, title, accessibilityLabel, fullScreen
|
|
|
174
178
|
const backdropComponent = useMemo(() => function ContentOverlayBackdrop(props) {
|
|
175
179
|
return (React.createElement(Backdrop, Object.assign({}, props, { pressBehavior: isCloseableOnOverlayTap ? "close" : "none" })));
|
|
176
180
|
}, [isCloseableOnOverlayTap]);
|
|
177
|
-
return (React.createElement(BottomSheetModal, { ref: bottomSheetModalRef, containerComponent: Platform.OS === "ios" ? Container : undefined, onChange: handleChange, style: sheetStyle, backgroundStyle: backgroundStyle, handleStyle: styles.handleWrapper, handleIndicatorStyle: handleIndicatorStyles, backdropComponent: backdropComponent, snapPoints: snapPoints, enablePanDownToClose: effectiveIsDraggable, enableContentPanningGesture: effectiveIsDraggable, enableHandlePanningGesture: effectiveIsDraggable, enableDynamicSizing: behavior.initialHeight === "contentHeight", keyboardBehavior: "interactive", keyboardBlurBehavior: "restore", topInset: topInset, onDismiss: () => onClose === null || onClose === void 0 ? void 0 : onClose() },
|
|
178
|
-
React.createElement(
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
181
|
+
return (React.createElement(BottomSheetModal, { ref: bottomSheetModalRef, containerComponent: Platform.OS === "ios" ? Container : undefined, onChange: handleChange, style: sheetStyle, backgroundStyle: backgroundStyle, handleStyle: styles.handleWrapper, handleIndicatorStyle: handleIndicatorStyles, backdropComponent: backdropComponent, snapPoints: snapPoints, enablePanDownToClose: enablePanDownToClose !== null && enablePanDownToClose !== void 0 ? enablePanDownToClose : effectiveIsDraggable, enableContentPanningGesture: enableContentPanningGesture !== null && enableContentPanningGesture !== void 0 ? enableContentPanningGesture : effectiveIsDraggable, enableHandlePanningGesture: effectiveIsDraggable, enableDynamicSizing: !customSnapPoints && behavior.initialHeight === "contentHeight", keyboardBehavior: "interactive", keyboardBlurBehavior: "restore", topInset: topInset, onDismiss: () => onClose === null || onClose === void 0 ? void 0 : onClose() },
|
|
182
|
+
React.createElement(AtlantisThemeContextProvider, { dangerouslyOverrideTheme: theme },
|
|
183
|
+
React.createElement(ContentOverlayKeyboardContext.Provider, { value: scrollEnabled }, scrollEnabled ? (React.createElement(BottomSheetKeyboardAwareScrollView, { ref: scrollViewRef, contentContainerStyle: { paddingBottom: insets.bottom }, keyboardShouldPersistTaps: keyboardShouldPersistTaps ? "handled" : "never", showsVerticalScrollIndicator: false, onScroll: handleOnScroll, stickyHeaderIndices: [0], bottomOffset: KEYBOARD_TOP_PADDING_AUTO_SCROLL },
|
|
184
|
+
renderHeader(),
|
|
185
|
+
React.createElement(View, { testID: "ATL-Overlay-Children" }, children))) : (React.createElement(BottomSheetView, null,
|
|
186
|
+
renderHeader(),
|
|
187
|
+
React.createElement(View, { style: { paddingBottom: insets.bottom }, testID: "ATL-Overlay-Children" }, children)))))));
|
|
183
188
|
}
|
|
184
189
|
function Backdrop(bottomSheetBackdropProps) {
|
|
185
190
|
const styles = useStyles();
|
|
@@ -42,14 +42,17 @@ function computeInitialHeight(config, isDraggable) {
|
|
|
42
42
|
}
|
|
43
43
|
/**
|
|
44
44
|
* Draggability determination:
|
|
45
|
-
* - hasOnBeforeExit: true → false (
|
|
45
|
+
* - hasOnBeforeExit: true && !allowDragWithBeforeExit → false (legacy override)
|
|
46
|
+
* - hasOnBeforeExit: true && allowDragWithBeforeExit → use isDraggable prop value
|
|
46
47
|
* - Otherwise → use isDraggable prop value
|
|
47
48
|
*
|
|
48
|
-
*
|
|
49
|
-
* and dragging would bypass that interception.
|
|
49
|
+
* The legacy override exists because onBeforeExit needs to intercept close
|
|
50
|
+
* attempts, and dragging would bypass that interception. Consumers that
|
|
51
|
+
* explicitly accept the asymmetry (e.g. button-press confirmation,
|
|
52
|
+
* drag-dismiss silent) can opt out via `allowDragWithBeforeExit`.
|
|
50
53
|
*/
|
|
51
54
|
function computeIsDraggable(config) {
|
|
52
|
-
if (config.hasOnBeforeExit) {
|
|
55
|
+
if (config.hasOnBeforeExit && !config.allowDragWithBeforeExit) {
|
|
53
56
|
return false;
|
|
54
57
|
}
|
|
55
58
|
return config.isDraggable;
|
|
@@ -5,6 +5,7 @@ const defaultConfig = {
|
|
|
5
5
|
adjustToContentHeight: false,
|
|
6
6
|
isDraggable: true,
|
|
7
7
|
hasOnBeforeExit: false,
|
|
8
|
+
allowDragWithBeforeExit: false,
|
|
8
9
|
showDismiss: false,
|
|
9
10
|
};
|
|
10
11
|
const defaultState = {
|
|
@@ -69,6 +70,36 @@ describe("computeContentOverlayBehavior", () => {
|
|
|
69
70
|
const result = computeContentOverlayBehavior(config, state);
|
|
70
71
|
expect(result.isDraggable).toBe(false);
|
|
71
72
|
});
|
|
73
|
+
it("respects isDraggable=true when onBeforeExit is present and allowDragWithBeforeExit=true", () => {
|
|
74
|
+
const config = aConfig({
|
|
75
|
+
isDraggable: true,
|
|
76
|
+
hasOnBeforeExit: true,
|
|
77
|
+
allowDragWithBeforeExit: true,
|
|
78
|
+
});
|
|
79
|
+
const state = aState();
|
|
80
|
+
const result = computeContentOverlayBehavior(config, state);
|
|
81
|
+
expect(result.isDraggable).toBe(true);
|
|
82
|
+
});
|
|
83
|
+
it("respects isDraggable=false when onBeforeExit is present and allowDragWithBeforeExit=true", () => {
|
|
84
|
+
const config = aConfig({
|
|
85
|
+
isDraggable: false,
|
|
86
|
+
hasOnBeforeExit: true,
|
|
87
|
+
allowDragWithBeforeExit: true,
|
|
88
|
+
});
|
|
89
|
+
const state = aState();
|
|
90
|
+
const result = computeContentOverlayBehavior(config, state);
|
|
91
|
+
expect(result.isDraggable).toBe(false);
|
|
92
|
+
});
|
|
93
|
+
it("still overrides to false when onBeforeExit is present and allowDragWithBeforeExit=false (default)", () => {
|
|
94
|
+
const config = aConfig({
|
|
95
|
+
isDraggable: true,
|
|
96
|
+
hasOnBeforeExit: true,
|
|
97
|
+
allowDragWithBeforeExit: false,
|
|
98
|
+
});
|
|
99
|
+
const state = aState();
|
|
100
|
+
const result = computeContentOverlayBehavior(config, state);
|
|
101
|
+
expect(result.isDraggable).toBe(false);
|
|
102
|
+
});
|
|
72
103
|
});
|
|
73
104
|
describe("showDismiss", () => {
|
|
74
105
|
it("returns true when showDismiss prop is true", () => {
|