@rubixscript/react-native-onboarding 1.0.0 → 1.1.0

package/dist/types/index.d.ts

@@ -0,0 +1,191 @@
+import { ImageSourcePropType, ViewStyle, TextStyle, ImageStyle } from 'react-native';
+export type SlideType = 'image' | 'icon' | 'form' | 'video' | 'custom';
+export interface BaseSlideData {
+    id: string;
+    type: SlideType;
+    title?: string;
+    description?: string;
+    backgroundColor?: string;
+    gradientColors?: string[];
+}
+export interface ImageSlideData extends BaseSlideData {
+    type: 'image';
+    image: ImageSourcePropType;
+    imageResizeMode?: 'cover' | 'contain' | 'stretch' | 'center';
+    imageStyle?: ImageStyle;
+    overlayIcon?: {
+        name: string;
+        size?: number;
+        color?: string;
+    };
+}
+export interface IconSlideData extends BaseSlideData {
+    type: 'icon';
+    icon: {
+        name: string;
+        type?: 'ionicons' | 'material' | 'material-community' | 'font-awesome' | 'octicons' | 'feather';
+        size?: number;
+        color?: string;
+        backgroundColor?: string;
+        backgroundSize?: number;
+    };
+    subtitle?: string;
+}
+export interface FormFieldConfig {
+    key: string;
+    label: string;
+    placeholder: string;
+    type: 'text' | 'number' | 'email' | 'password' | 'select' | 'multiselect';
+    required?: boolean;
+    options?: Array<{
+        value: string;
+        label: string;
+        icon?: string;
+    }>;
+    validation?: (value: any) => boolean | string;
+    multiline?: boolean;
+    numberOfLines?: number;
+}
+export interface FormSlideData extends BaseSlideData {
+    type: 'form';
+    fields: FormFieldConfig[];
+    submitLabel?: string;
+    onSubmit?: (data: Record<string, any>) => void | Promise<void>;
+    customFormComponent?: React.ComponentType<FormSlideCustomProps>;
+}
+export interface VideoSlideData extends BaseSlideData {
+    type: 'video';
+    videoSource: string | {
+        uri: string;
+    };
+    autoPlay?: boolean;
+    loop?: boolean;
+    muted?: boolean;
+    poster?: ImageSourcePropType;
+}
+export interface CustomSlideData extends BaseSlideData {
+    type: 'custom';
+    component: React.ComponentType<any>;
+    props?: Record<string, any>;
+}
+export type SlideData = ImageSlideData | IconSlideData | FormSlideData | VideoSlideData | CustomSlideData;
+export interface OnboardingTheme {
+    colors: {
+        primary: string;
+        secondary: string;
+        background: string;
+        surface: string;
+        text: {
+            primary: string;
+            secondary: string;
+            inverse: string;
+        };
+        border: string;
+        overlay?: string;
+    };
+    typography: {
+        title: TextStyle;
+        description: TextStyle;
+        button: TextStyle;
+        label?: TextStyle;
+    };
+    spacing: {
+        xs: number;
+        sm: number;
+        md: number;
+        lg: number;
+        xl: number;
+        xxl: number;
+    };
+    borderRadius: {
+        sm: number;
+        md: number;
+        lg: number;
+        xl: number;
+        full: number;
+    };
+    shadows?: {
+        sm?: ViewStyle;
+        md?: ViewStyle;
+        lg?: ViewStyle;
+    };
+}
+export type NavigationStyle = 'dots' | 'progress-bar' | 'steps' | 'numbers' | 'none';
+export interface NavigationConfig {
+    style: NavigationStyle;
+    position?: 'top' | 'bottom' | 'floating';
+    showSkip?: boolean;
+    showBack?: boolean;
+    skipLabel?: string;
+    backLabel?: string;
+    nextLabel?: string;
+    doneLabel?: string;
+    containerStyle?: ViewStyle;
+}
+export type AnimationType = 'slide' | 'fade' | 'scale' | 'parallax' | 'cube' | 'none';
+export interface AnimationConfig {
+    type: AnimationType;
+    duration?: number;
+    easing?: (t: number) => number;
+    parallaxFactor?: number;
+}
+export interface StorageConfig {
+    key: string;
+    enabled: boolean;
+    onComplete?: () => void | Promise<void>;
+}
+export interface OnboardingConfig {
+    slides: SlideData[];
+    theme?: Partial<OnboardingTheme>;
+    navigation?: Partial<NavigationConfig>;
+    animation?: Partial<AnimationConfig>;
+    storage?: Partial<StorageConfig>;
+    onboardingComplete?: (data?: Record<string, any>) => void | Promise<void>;
+    onSlideChange?: (index: number) => void;
+    onSkip?: () => void | Promise<void>;
+    initialSlide?: number;
+    swipeEnabled?: boolean;
+    containerStyle?: ViewStyle;
+    safeAreaEnabled?: boolean;
+}
+export interface OnboardingProps extends OnboardingConfig {
+    visible: boolean;
+    darkMode?: boolean;
+}
+export interface FormSlideCustomProps {
+    data: FormSlideData;
+    theme: OnboardingTheme;
+    onSubmit: (data: Record<string, any>) => void;
+    isSubmitting?: boolean;
+    darkMode?: boolean;
+}
+export interface PaginationProps {
+    currentIndex: number;
+    totalSlides: number;
+    theme: OnboardingTheme;
+    config?: NavigationConfig;
+    style?: ViewStyle;
+}
+export interface NavigationButtonProps {
+    label: string;
+    onPress: () => void;
+    theme: OnboardingTheme;
+    variant?: 'primary' | 'secondary' | 'ghost';
+    disabled?: boolean;
+    loading?: boolean;
+    style?: ViewStyle;
+    textStyle?: TextStyle;
+}
+export type OnboardingPreset = 'onepage' | 'zaprecipe' | 'pomodo' | 'modern' | 'minimal' | 'gradient';
+export interface PresetConfig {
+    theme: OnboardingTheme;
+    navigation: NavigationConfig;
+    animation: AnimationConfig;
+    defaultSlideStyles: {
+        image?: ImageStyle;
+        icon?: ViewStyle;
+        title?: TextStyle;
+        description?: TextStyle;
+    };
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAY,MAAM,cAAc,CAAC;AAM/F,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;AAEvE,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,cAAe,SAAQ,aAAa;IACnD,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,mBAAmB,CAAC;IAC3B,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;IAC7D,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,WAAW,CAAC,EAAE;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED,MAAM,WAAW,aAAc,SAAQ,aAAa;IAClD,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE;QACJ,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,oBAAoB,GAAG,cAAc,GAAG,UAAU,GAAG,SAAS,CAAC;QAChG,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB,CAAC;IACF,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,GAAG,QAAQ,GAAG,aAAa,CAAC;IAC1E,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACjE,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,OAAO,GAAG,MAAM,CAAC;IAC9C,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,aAAc,SAAQ,aAAa;IAClD,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,eAAe,EAAE,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/D,mBAAmB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;CACjE;AAED,MAAM,WAAW,cAAe,SAAQ,aAAa;IACnD,IAAI,EAAE,OAAO,CAAC;IACd,WAAW,EAAE,MAAM,GAAG;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IACtC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC9B;AAED,MAAM,WAAW,eAAgB,SAAQ,aAAa;IACpD,IAAI,EAAE,QAAQ,CAAC;IACf,SAAS,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IACpC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC7B;AAED,MAAM,MAAM,SAAS,GAAG,cAAc,GAAG,aAAa,GAAG,aAAa,GAAG,cAAc,GAAG,eAAe,CAAC;AAM1G,MAAM,WAAW,eAAe;IAE9B,MAAM,EAAE;QACN,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,EAAE,MAAM,CAAC;QACnB,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE;YACJ,OAAO,EAAE,MAAM,CAAC;YAChB,SAAS,EAAE,MAAM,CAAC;YAClB,OAAO,EAAE,MAAM,CAAC;SACjB,CAAC;QACF,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IAGF,UAAU,EAAE;QACV,KAAK,EAAE,SAAS,CAAC;QACjB,WAAW,EAAE,SAAS,CAAC;QACvB,MAAM,EAAE,SAAS,CAAC;QAClB,KAAK,CAAC,EAAE,SAAS,CAAC;KACnB,CAAC;IAGF,OAAO,EAAE;QACP,EAAE,EAAE,MAAM,CAAC;QACX,EAAE,EAAE,MAAM,CAAC;QACX,EAAE,EAAE,MAAM,CAAC;QACX,EAAE,EAAE,MAAM,CAAC;QACX,EAAE,EAAE,MAAM,CAAC;QACX,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;IAGF,YAAY,EAAE;QACZ,EAAE,EAAE,MAAM,CAAC;QACX,EAAE,EAAE,MAAM,CAAC;QACX,EAAE,EAAE,MAAM,CAAC;QACX,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IAGF,OAAO,CAAC,EAAE;QACR,EAAE,CAAC,EAAE,SAAS,CAAC;QACf,EAAE,CAAC,EAAE,SAAS,CAAC;QACf,EAAE,CAAC,EAAE,SAAS,CAAC;KAChB,CAAC;CACH;AAMD,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,cAAc,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;AAErF,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,eAAe,CAAC;IACvB,QAAQ,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,UAAU,CAAC;IACzC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,SAAS,CAAC;CAC5B;AAMD,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAEtF,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,aAAa,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;IAC/B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAMD,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzC;AAMD,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,KAAK,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;IACjC,UAAU,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACvC,SAAS,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;IACrC,OAAO,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IACjC,kBAAkB,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1E,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACxC,MAAM,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,cAAc,CAAC,EAAE,SAAS,CAAC;IAC3B,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAMD,MAAM,WAAW,eAAgB,SAAQ,gBAAgB;IACvD,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,aAAa,CAAC;IACpB,KAAK,EAAE,eAAe,CAAC;IACvB,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,IAAI,CAAC;IAC9C,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC9B,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,eAAe,CAAC;IACvB,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,KAAK,EAAE,eAAe,CAAC;IACvB,OAAO,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,OAAO,CAAC;IAC5C,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAMD,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,CAAC;AAEtG,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,eAAe,CAAC;IACvB,UAAU,EAAE,gBAAgB,CAAC;IAC7B,SAAS,EAAE,eAAe,CAAC;IAC3B,kBAAkB,EAAE;QAClB,KAAK,CAAC,EAAE,UAAU,CAAC;QACnB,IAAI,CAAC,EAAE,SAAS,CAAC;QACjB,KAAK,CAAC,EAAE,SAAS,CAAC;QAClB,WAAW,CAAC,EAAE,SAAS,CAAC;KACzB,CAAC;CACH"}

package/dist/types/index.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,60 +1,73 @@
-{
-  "name": "@rubixscript/react-native-onboarding",
-  "version": "1.0.0",
-  "description": "A comprehensive React Native onboarding library with customizable slide types, animations, and themes",
-  "main": "src/index.ts",
-  "types": "src/index.ts",
-  "scripts": {
-    "test": "jest",
-    "lint": "eslint src --ext .ts,.tsx",
-    "type-check": "tsc --noEmit"
-  },
-  "keywords": [
-    "react-native",
-    "onboarding",
-    "walkthrough",
-    "tutorial",
-    "user-onboarding",
-    "expo",
-    "react",
-    "slides",
-    "carousel"
-  ],
-  "author": "RubixScript Team",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/rubixscript/react-native-onboarding.git"
-  },
-  "peerDependencies": {
-    "expo": ">=48.0.0",
-    "react": ">=18.0.0",
-    "react-native": ">=0.70.0",
-    "react-native-reanimated": ">=3.0.0"
-  },
-  "dependencies": {
-    "@expo/vector-icons": "^15.0.2",
-    "@react-native-async-storage/async-storage": ">=1.19.0",
-    "expo-blur": "~15.0.7",
-    "expo-linear-gradient": "~15.0.7"
-  },
-  "devDependencies": {
-    "@testing-library/react-native": "^12.0.0",
-    "@types/jest": "^29.5.0",
-    "@types/react": "~19.1.10",
-    "@types/react-native": "^0.73.0",
-    "@typescript-eslint/eslint-plugin": "^6.0.0",
-    "@typescript-eslint/parser": "^6.0.0",
-    "eslint": "^8.0.0",
-    "jest": "^29.0.0",
-    "typescript": "~5.9.2"
-  },
-  "files": [
-    "src",
-    "README.md",
-    "LICENSE"
-  ],
-  "engines": {
-    "node": ">=16.0.0"
-  }
-}
+{
+  "name": "@rubixscript/react-native-onboarding",
+  "version": "1.1.0",
+  "description": "A comprehensive React Native onboarding library with customizable slide types, animations, and themes",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "build:rollup": "rollup -c",
+    "prepublishOnly": "npm run build",
+    "test": "jest",
+    "lint": "eslint src --ext .ts,.tsx",
+    "type-check": "tsc --noEmit"
+  },
+  "keywords": [
+    "react-native",
+    "onboarding",
+    "walkthrough",
+    "tutorial",
+    "user-onboarding",
+    "expo",
+    "react",
+    "slides",
+    "carousel"
+  ],
+  "author": "RubixScript Team",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rubixscript/react-native-onboarding.git"
+  },
+  "peerDependencies": {
+    "expo": ">=48.0.0",
+    "react": ">=18.0.0",
+    "react-native": ">=0.70.0",
+    "react-native-reanimated": ">=3.0.0"
+  },
+  "dependencies": {
+    "@expo/vector-icons": "^15.0.2",
+    "@react-native-async-storage/async-storage": ">=1.19.0",
+    "expo-av": "~15.0.0",
+    "expo-blur": "~15.0.7",
+    "expo-linear-gradient": "~15.0.7",
+    "react-native-reanimated": ">=3.0.0",
+    "react-native-safe-area-context": "~5.0.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^28.0.0",
+    "@rollup/plugin-node-resolve": "^15.3.0",
+    "@rollup/plugin-typescript": "^12.1.0",
+    "@testing-library/react-native": "^12.0.0",
+    "@types/jest": "^29.5.0",
+    "@types/react": "~19.1.10",
+    "@types/react-native": "^0.73.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "eslint": "^8.0.0",
+    "jest": "^29.0.0",
+    "rollup": "^4.28.0",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "tslib": "^2.8.1",
+    "typescript": "~5.9.2"
+  },
+  "files": [
+    "dist",
+    "src",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=16.0.0"
+  }
+}