react-native-actions-sheet/dist/src/provider.d.ts

A Cross Platform(Android & iOS) ActionSheet with a robust and flexible api, native performance and zero dependency code for react native. Create anything you want inside ActionSheet.

import React, { ReactNode } from 'react';
import { ActionSheetRef, Sheets } from './types';
export declare const providerRegistryStack: string[];
/**
 * An object that holds all the sheet components against their ids.
 */
export declare const sheetsRegistry: {
    [context: string]: {
        [id: string]: React.ElementType;
    };
};
export interface SheetProps<SheetId extends keyof Sheets = never> {
    sheetId: SheetId | (string & {});
    payload?: Sheets[SheetId]['payload'];
}
export declare function registerSheet<SheetId extends keyof Sheets = never>(id: SheetId | (string & {}), Sheet: React.ElementType, ...contexts: string[]): void;
/**
 * The SheetProvider makes available the sheets in a given context. The default context is
 * `global`. However if you want to render a Sheet within another sheet or if you want to render
 * Sheets in a modal. You can use a seperate Provider with a custom context value.
 *
 * For example
```ts
// Define your SheetProvider in the component/modal where
// you want to show some Sheets.
<SheetProvider context="local-context" />

// Then register your sheet when for example the
// Modal component renders.

registerSheet('local-sheet', LocalSheet,'local-context');

```
 * @returns
 */
export declare function SheetProvider({ context, children, }: {
    context?: string;
    children?: ReactNode;
}): React.JSX.Element;
export declare const SheetRefContext: React.Context<React.RefObject<ActionSheetRef>>;
/**
 * Get id of the current context.
 */
export declare const useProviderContext: () => string;
/**
 * Get id of the current sheet
 */
export declare const useSheetIDContext: () => string;
/**
 * Get the current Sheet's internal ref.
 * @returns
 */
export declare function useSheetRef<SheetId extends keyof Sheets = never>(id?: SheetId | (string & {})): React.MutableRefObject<ActionSheetRef<SheetId>>;
/**
 * Get the payload this sheet was opened with.
 * @returns
 */
export declare function useSheetPayload<SheetId extends keyof Sheets = never>(id?: SheetId | (string & {})): Sheets[SheetId]["payload"];
//# sourceMappingURL=provider.d.ts.map