このプロジェクトについて

react-native-spotlight-tourは、スポットライト効果を伴うガイド付き製品ツアーや導入ウォークスルーを作成するためのReact Nativeライブラリです。Android、iOS、webと互換性があり、ハイライトされた要素の周囲にツールチップコンテンツを配置するためにFloating UIを使用します。 開発者はツアーステップをTourStep配列として定義し、アプリケーションコンテンツをSpotlightTourProviderでラップします。AttachStepコンポーネントはUI要素をステップインデックスにリンクし、useSpotlightTourフックは開始、停止、次のステップへの移動、前のステップへの戻りなどの制御を公開します。offset、shift、flipを含むFloating UIミドルウェアは、ツアー全体に対してグローバルに設定することも、個々のステップで上書きすることもできます。 このライブラリは、オーバーレイの色と不透明度、bounce、fade、slideなどのスポットライトの動き、背景押下時の挙動のカスタマイズをサポートします。組み込みのTourBoxコンポーネントは、タイトル、ナビゲーションラベル、スタイリングオプションを備えた設定可能なツールチップコンテナを提供します。ステップはレンダリング前にアクションを実行することもでき、完全にカスタムなレンダー関数を使用することもできます。 インストールはnpmまたはyarnで利用できます。ドキュメントに記載されている要件は、React 16.8.0以降、React Native 0.50.0以降、react-native-svg 12.1.0以降です。バージョン3では、パッケージ名が@stackbuilders/react-native-spotlight-tourからreact-native-spotlight-tourに変更され、古い配置用propsがFloating UI設定に置き換えられました。このプロジェクトはMITライセンスで、APIドキュメントとサンプルアプリケーションが含まれています。