Skip to content

Commit

Permalink
Allow web's SafeAreaView to forward ref to its underlying view (#383)
Browse files Browse the repository at this point in the history
* feat: allow web's SafeAreaView to forward ref

* refactor: remove unnecessary return type

* refactor: remove return type for SafeAreaView
  • Loading branch information
antoine-cottineau committed Apr 29, 2023
1 parent 207d894 commit ceb5e57
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 27 deletions.
5 changes: 5 additions & 0 deletions src/SafeArea.types.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import type * as React from 'react';
import type { NativeSyntheticEvent, ViewProps } from 'react-native';
import NativeSafeAreaView from './specs/NativeSafeAreaView';

export type Edge = 'top' | 'right' | 'bottom' | 'left';

Expand Down Expand Up @@ -36,3 +37,7 @@ export interface NativeSafeAreaViewProps extends ViewProps {
mode?: 'padding' | 'margin';
edges?: ReadonlyArray<Edge>;
}

export type NativeSafeAreaViewInstance = InstanceType<
typeof NativeSafeAreaView
>;
36 changes: 18 additions & 18 deletions src/SafeAreaView.tsx
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
import * as React from 'react';
import type { NativeSafeAreaViewProps } from './SafeArea.types';
import type {
NativeSafeAreaViewInstance,
NativeSafeAreaViewProps,
} from './SafeArea.types';
import NativeSafeAreaView from './specs/NativeSafeAreaView';

type NativeSafeAreaViewInstance = InstanceType<typeof NativeSafeAreaView>;

export type SafeAreaViewProps = NativeSafeAreaViewProps;

export const SafeAreaView: React.ForwardRefExoticComponent<
SafeAreaViewProps & React.RefAttributes<NativeSafeAreaViewInstance>
> = React.forwardRef<NativeSafeAreaViewInstance, SafeAreaViewProps>(
({ edges, ...props }, ref) => {
return (
<NativeSafeAreaView
{...props}
// Codegen doesn't support default values for array types so
// set it here.
edges={edges ?? ['bottom', 'left', 'right', 'top']}
ref={ref}
/>
);
},
);
export const SafeAreaView = React.forwardRef<
NativeSafeAreaViewInstance,
SafeAreaViewProps
>(({ edges, ...props }, ref) => {
return (
<NativeSafeAreaView
{...props}
// Codegen doesn't support default values for array types so
// set it here.
edges={edges ?? ['bottom', 'left', 'right', 'top']}
ref={ref}
/>
);
});
20 changes: 11 additions & 9 deletions src/SafeAreaView.web.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
import * as React from 'react';
import { View, StyleSheet } from 'react-native';
import { useSafeAreaInsets } from './SafeAreaContext';
import type { Edge, NativeSafeAreaViewProps } from './SafeArea.types';
import type {
Edge,
NativeSafeAreaViewInstance,
NativeSafeAreaViewProps,
} from './SafeArea.types';

// prettier-ignore
const TOP = 0b1000,
Expand All @@ -19,12 +23,10 @@ const edgeBitmaskMap: Record<Edge, number> = {
left: LEFT,
};

export function SafeAreaView({
style = {},
mode,
edges,
...rest
}: NativeSafeAreaViewProps) {
export const SafeAreaView = React.forwardRef<
NativeSafeAreaViewInstance,
NativeSafeAreaViewProps
>(({ style = {}, mode, edges, ...rest }, ref) => {
const insets = useSafeAreaInsets();

const edgeBitmask =
Expand Down Expand Up @@ -81,5 +83,5 @@ export function SafeAreaView({
}
}, [style, insets, mode, edgeBitmask]);

return <View style={appliedStyle} {...rest} />;
}
return <View style={appliedStyle} {...rest} ref={ref} />;
});

0 comments on commit ceb5e57

Please sign in to comment.