gk-rn-onboarding v1.0.4

gk-rn-onboarding Package

gk-rn-onboarding is a customizable onboarding screen component for React Native applications.

Installation

You can install the package via npm or yarn:

npm install gk-rn-onboarding

or

yarn add gk-rn-onboarding

Usage

Import the OnboardingScreen component and use it in your application.

import React, { useState } from "react";
import { View } from "react-native";
import { OnboardingScreen, Slide } from "gk-rn-onboarding";

const slides: Slide[] = [
  {
    title: "Welcome",
    subtitle: "Introduction",
    description: "This is the first slide",
    image: require("./assets/image1.png"),
    backgroundColor: "#fff",
  },
  {
    title: "Learn",
    subtitle: "Educational",
    description: "This is the second slide",
    image: require("./assets/image2.png"),
    backgroundColor: "#f7f7f7",
  },
];

const App = () => {
  const [isOnboardingOpen, setOnboardingOpen] = useState(true);

  return (
    <View style={{ flex: 1 }}>
      <OnboardingScreen
        slides={slides}
        isOpen={isOnboardingOpen}
        setIsOpen={setOnboardingOpen}
        onComplete={() => console.log("Onboarding complete")}
      />
    </View>
  );
};

export default App;

Props

OnboardingScreen

Slide

Customization

You can customize the onboarding screen by providing your own components for buttons, text, titles, subtitles, and images. Use the corresponding props to pass your custom components.

Example

const CustomButton = ({ onPress, text }: ButtonProps) => (
  <TouchableOpacity
    onPress={onPress}
    style={{ padding: 10, backgroundColor: "blue" }}
  >
    <Text style={{ color: "white" }}>{text}</Text>
  </TouchableOpacity>
);

const App = () => {
  const [isOnboardingOpen, setOnboardingOpen] = useState(true);

  return (
    <View style={{ flex: 1 }}>
      <OnboardingScreen
        slides={slides}
        isOpen={isOnboardingOpen}
        setIsOpen={setOnboardingOpen}
        ButtonComponent={CustomButton}
        onComplete={() => console.log("Onboarding complete")}
      />
    </View>
  );
};

export default App;

License

MIT