@prosperitainova/dumbo-react-native
Version:
Dumbo for React Native Library
34 lines • 1.73 kB
TypeScript
import React from 'react';
import { ViewProps } from 'react-native';
/** Props for ViewWrapper component */
export type ViewWrapperProps = {
/** Children to load */
children?: React.ReactNode;
/** Indicate if top navigation is in use (TopNavigationBar) */
hasTopNavigation?: boolean;
/** Indicate if bottom navigation is in use (BottomNavigationBar or any BottomToolbar) */
hasBottomNavigation?: boolean;
/** Override top background (for custom uses) */
topBackgroundColor?: string;
/** Override bottom background (for custom uses) */
bottomBackgroundColor?: string;
/** Override default status bar style (for dark backgrounds use 'light-content' and for light background use 'dark-content'). Will rely on useDarkMode otherwise */
statusBarStyle?: 'light-content' | 'dark-content';
/** Direct props to set on the React Native component (including iOS and Android specific props). Most use cases should not need this. */
componentProps?: ViewProps;
};
/**
* The ViewWrapper component provides a unified way to load main views without worrying about StatusBar or safe zone stylings.
* For most usages simply indicate if you are using Navigation for top and bottom.
* For Layout views that are full screen (Landing for example) you do not need to wrap them in this.
*
* {@link https://github.com/carbon-design-system/carbon-react-native/blob/main/example/src/Views/ViewWrapper.tsx | Example code}
*/
export declare class ViewWrapper extends React.Component<ViewWrapperProps> {
private get topColor();
private get bottomColor();
private get needsBottomCover();
private get styles();
render(): React.ReactNode;
}
//# sourceMappingURL=index.d.ts.map