react-native-safe-area-context
- Version 5.6.2
- Published
- 231 kB
- No dependencies
- MIT license
Install
npm i react-native-safe-area-contextyarn add react-native-safe-area-contextpnpm add react-native-safe-area-contextOverview
A flexible way to handle safe area, also works on Android and web.
Index
Variables
Functions
Interfaces
Type Aliases
Variables
variable initialWindowMetrics
const initialWindowMetrics: Metrics;variable initialWindowSafeAreaInsets
const initialWindowSafeAreaInsets: EdgeInsets;Deprecated
variable SafeAreaConsumer
const SafeAreaConsumer: React.Consumer<EdgeInsets>;Deprecated
variable SafeAreaContext
const SafeAreaContext: React.Context<EdgeInsets>;Deprecated
variable SafeAreaFrameContext
const SafeAreaFrameContext: React.Context<Rect>;variable SafeAreaInsetsContext
const SafeAreaInsetsContext: React.Context<EdgeInsets>;variable SafeAreaView
const SafeAreaView: React.ForwardRefExoticComponent<any>;Functions
function SafeAreaListener
SafeAreaListener: ({ onChange, style, children, ...others}: SafeAreaListenerProps) => React.JSX.Element;function SafeAreaProvider
SafeAreaProvider: ({ children, initialMetrics, initialSafeAreaInsets, style, ...others}: SafeAreaProviderProps) => React.JSX.Element;function useSafeArea
useSafeArea: () => EdgeInsets;Deprecated
function useSafeAreaFrame
useSafeAreaFrame: () => Rect;function useSafeAreaInsets
useSafeAreaInsets: () => EdgeInsets;function withSafeAreaInsets
withSafeAreaInsets: <T>( WrappedComponent: React.ComponentType<any>) => React.ForwardRefExoticComponent<any>;Interfaces
interface EdgeInsets
interface EdgeInsets {}interface NativeSafeAreaProviderProps
interface NativeSafeAreaProviderProps extends ViewProps {}property children
children?: React.ReactNode;property onInsetsChange
onInsetsChange: InsetChangeNativeCallback;interface NativeSafeAreaViewProps
interface NativeSafeAreaViewProps extends ViewProps {}interface Rect
interface Rect {}interface SafeAreaListenerProps
interface SafeAreaListenerProps extends ViewProps {}property onChange
onChange: (data: { insets: EdgeInsets; frame: Rect }) => void;interface SafeAreaProviderProps
interface SafeAreaProviderProps extends ViewProps {}property children
children?: React.ReactNode;property initialMetrics
initialMetrics?: Metrics | null;property initialSafeAreaInsets
initialSafeAreaInsets?: EdgeInsets | null;Deprecated
Type Aliases
type Edge
type Edge = 'top' | 'right' | 'bottom' | 'left';type EdgeMode
type EdgeMode = 'off' | 'additive' | 'maximum';type EdgeRecord
type EdgeRecord = Partial<Record<Edge, EdgeMode>>;type Edges
type Edges = readonly Edge[] | Readonly<EdgeRecord>;type InsetChangedEvent
type InsetChangedEvent = NativeSyntheticEvent<Metrics>;type InsetChangeNativeCallback
type InsetChangeNativeCallback = (event: InsetChangedEvent) => void;type NativeSafeAreaViewInstance
type NativeSafeAreaViewInstance = InstanceType<typeof NativeSafeAreaView>;type SafeAreaViewProps
type SafeAreaViewProps = NativeSafeAreaViewProps;type WithSafeAreaInsetsProps
type WithSafeAreaInsetsProps = { insets: EdgeInsets;};Package Files (5)
Dependencies (0)
No dependencies.
Dev Dependencies (30)
- @commitlint/config-conventional
- @jest/globals
- @react-native/babel-preset
- @react-native/eslint-config
- @react-native/eslint-plugin-specs
- @release-it/conventional-changelog
- @testing-library/react-native
- @types/react
- @types/react-dom
- @typescript-eslint/eslint-plugin
- @typescript-eslint/parser
- babel-plugin-module-resolver
- clang-format
- commitlint
- eslint
- eslint-config-prettier
- eslint-plugin-ft-flow
- eslint-plugin-jest
- eslint-plugin-prettier
- eslint-plugin-testing-library
- husky
- jest
- prettier
- react
- react-dom
- react-native
- react-native-builder-bob
- react-test-renderer
- release-it
- typescript
Peer Dependencies (2)
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/react-native-safe-area-context.
- Markdown[](https://www.jsdocs.io/package/react-native-safe-area-context)
- HTML<a href="https://www.jsdocs.io/package/react-native-safe-area-context"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 3570 ms. - Missing or incorrect documentation? Open an issue for this package.
