react-native-spotlight-guide
Version:
A modern, customizable and high-performance spotlight/walkthrough library for React Native with TypeScript support
23 lines (22 loc) • 585 B
TypeScript
import React from "react";
import { SpotlightGuideProps } from "../../types/spotlight.types";
/**
* SpotlightGuide Component
* A component that creates a spotlight effect to highlight UI elements with a guided tour.
*
* @component
* @example
* ```tsx
* <SpotlightGuide
* isVisible={true}
* content="This is a sample spotlight guide"
* spotlightShape="circle"
* onNext={() => console.log('Next')}
* >
* <View>
* <Text>Highlighted Content</Text>
* </View>
* </SpotlightGuide>
* ```
*/
export declare const SpotlightGuide: React.FC<SpotlightGuideProps>;