manuthecoder-react-native-spotlight-tour/dist/lib/components/attach-step/AttachStep.component.d.ts

React Native library to implement a highly customizable app tour feature with an awesome spotlight effect

import { type ReactElement, type ReactNode, type RefObject } from "react";
import { type LayoutChangeEvent, type StyleProp, type ViewStyle } from "react-native";
export interface ChildProps {
    /**
     * A React children, if any.
     */
    children?: ReactNode;
    /**
     * Native components layout change event.
     *
     * @param event The layout event.
     */
    onLayout?: (event: LayoutChangeEvent) => void;
    /**
     * A React reference.
     */
    ref: RefObject<unknown>;
}
export interface AttachStepProps {
    /**
     * The element in which the spotlight will be to wrapped to in the specified
     * step of the tour.
     */
    children: ReactElement<ChildProps>;
    /**
     * When `AttachStep` wraps a Functional Component, it needs to add an
     * additional `View` on top of it to be able to measure the layout upon
     * render. This prop allows to define the behavior of the width of such
     * `View`. When set to `false`, it adjusts to its contents, when set to
     * `true`, it stretches out and tries to fill it view.
     *
     * **Note:** This property has no effect when it's applied to native
     * components or components created using `React.forwardRef`, which pass
     * the `ref` to another native component.
     *
     * @default false
     */
    fill?: boolean;
    /**
     * The index of the `steps` array to which the step is attached to.
     * It can be a single index or multiple ones.
     */
    index: Array<number> | number;
    /**
     * Style applied to AttachStep wrapper
     */
    style?: StyleProp<ViewStyle>;
}
/**
 * React functional component used to attach and step to another component by
 * only wrapping it. Use its props to customize the behavior.
 *
 * @param props the component props
 * @returns an AttachStep React element
 */
export declare function AttachStep({ children, fill, index, style }: AttachStepProps): ReactElement;