react-native-snackbar/lib/typescript/src/index.d.ts

Material Design "Snackbar" component for Android and iOS.

import type { ColorValue } from 'react-native';
import { type SnackbarEvent } from './NativeSnackbar';
export type { SnackbarEvent } from './NativeSnackbar';
/**
 * An optional, actionable button on the Snackbar.
 */
export interface SnackbarAction {
    /**
     * Button text.
     */
    text: string;
    /**
     * Button text color.
     * Accepts various forms of colors such as hex, literals, rgba, etc.
     */
    textColor?: ColorValue;
    /**
     * Function called when the user taps the button.
     */
    onPress?(): void;
}
/**
 * Snackbar configuration options.
 */
export interface SnackBarOptions {
    /**
     * Snackbar text.
     */
    text: string;
    /**
     * Number of text lines to display on the snackbar.
     * Default 2 lines are shown.
     */
    numberOfLines?: number;
    /**
     * Align text center
     */
    textAlignCenter?: boolean;
    /**
     * Length of time the Snackbar stays on screen.
     * One of Snackbar.LENGTH_SHORT, Snackbar.LENGTH_LONG, Snackbar.LENGTH_INDEFINITE, or
     * a custom length in milliseconds.
     */
    duration?: number;
    /**
     * Margin from bottom, defaults to 0.
     */
    marginBottom?: number;
    /**
     * Snackbar text color.
     * Accepts various forms of colors such as hex, literals, rgba, etc.
     */
    textColor?: ColorValue;
    /**
     * Background color of the snackbar.
     * Accepts color strings such as hex, literals, rgba
     */
    backgroundColor?: ColorValue;
    /**
     * [Android] The basename of a .ttf font from assets/fonts/.
     */
    fontFamily?: string;
    /**
     * Action button configuration options.
     */
    action?: SnackbarAction;
    /**
     * Rtl the snackbar
     *
     * [Android only, API 17+] Whether the Snackbar should render right-to-left
     * @requires `android:supportsRtl="true"`
     * @see https://android-developers.googleblog.com/2013/03/native-rtl-support-in-android-42.html
     * @see https://github.com/MortezaHeydari97/react-native-snackbar/blob/main/example
     */
    rtl?: boolean;
}
export declare const Snackbar: {
    /**
     * Snackbar duration of about one second (varies per device).
     */
    LENGTH_SHORT: number;
    /**
     * Snackbar duration of about three seconds (varies per device).
     */
    LENGTH_LONG: number;
    /**
     * Snackbar duration that lasts forever (until dismissed, replaced, or action button is tapped).
     */
    LENGTH_INDEFINITE: number;
    /**
     * Indicates that the Snackbar was dismissed via a swipe.
     */
    DISMISS_EVENT_SWIPE: number;
    /**
     * Indicates that the Snackbar was dismissed via an action click.
     */
    DISMISS_EVENT_ACTION: number;
    /**
     * Indicates that the Snackbar was dismissed via a timeout.
     */
    DISMISS_EVENT_TIMEOUT: number;
    /**
     * Indicates that the Snackbar was dismissed via a call to {@link #dismiss()}.
     */
    DISMISS_EVENT_MANUAL: number;
    /**
     * Indicates that the Snackbar was dismissed from a new Snackbar being shown.
     */
    DISMISS_EVENT_CONSECUTIVE: number;
    /**
     * Indicates that Snackbar appears.
     */
    SHOW_EVENT: number;
    /**
     * Shows a native Snackbar component.
     */
    show(options: SnackBarOptions): void;
    /**
     * Dismisses any and all active Snackbars.
     */
    dismiss(): void;
    /**
     * Observe Snackbar visibility changes.
     */
    onSnackbarVisibility(handler: (event: SnackbarEvent) => void): import("react-native").EventSubscription;
};
//# sourceMappingURL=index.d.ts.map