react-magazine 1.0.0

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

@@ -0,0 +1,144 @@
+import type { PageFlip } from 'page-flip';
+/** Page state */
+export type PageState = 'user_fold' | 'fold_corner' | 'flipping' | 'read';
+/** Page orientation */
+export type PageOrientation = 'portrait' | 'landscape';
+/** Page density - hard pages don't bend */
+export type PageDensity = 'hard' | 'soft';
+/** Size type */
+export type SizeType = 'fixed' | 'stretch';
+/** Flip corner type */
+export type FlipCorner = 'top' | 'bottom';
+/** Flip setting interface */
+export interface IFlipSetting {
+    /** Page number from which to start viewing */
+    startPage: number;
+    /** Whether the book will be stretched under the parent element or not */
+    size: SizeType;
+    /** Page width */
+    width: number;
+    /** Page height */
+    height: number;
+    /** Min width for responsive */
+    minWidth: number;
+    /** Max width for responsive */
+    maxWidth: number;
+    /** Min height for responsive */
+    minHeight: number;
+    /** Max height for responsive */
+    maxHeight: number;
+    /** Draw shadows or not when page flipping */
+    drawShadow: boolean;
+    /** Flipping animation time in ms */
+    flippingTime: number;
+    /** Enable switching to portrait mode */
+    usePortrait: boolean;
+    /** Initial value to z-index */
+    startZIndex: number;
+    /** If this value is true, the parent element will be equal to the size of the book */
+    autoSize: boolean;
+    /** Shadow intensity (1: max intensity, 0: hidden shadows) */
+    maxShadowOpacity: number;
+    /** If this value is true, the first and the last pages will be marked as hard and will be shown in single page mode */
+    showCover: boolean;
+    /** Disable content scrolling when touching a book on mobile devices */
+    mobileScrollSupport: boolean;
+    /** Set the forward event of clicking on child elements (buttons, links) */
+    clickEventForward: boolean;
+    /** Using mouse and touch events to page flipping */
+    useMouseEvents: boolean;
+    /** Minimum distance to trigger swipe */
+    swipeDistance: number;
+    /** If this value is true, fold the corners of the book when the mouse pointer is over them */
+    showPageCorners: boolean;
+    /** If this value is true, flipping by clicking on the whole book will be locked. Only on corners */
+    disableFlipByClick: boolean;
+}
+/** Book state */
+export interface IBookState {
+    page: number;
+    mode: PageOrientation;
+}
+/** Flip event data */
+export interface FlipEvent {
+    /** Current page index (0-based) */
+    data: number;
+    /** The PageFlip object */
+    object: PageFlip;
+}
+/** Orientation change event data */
+export interface OrientationEvent {
+    /** New orientation */
+    data: PageOrientation;
+    /** The PageFlip object */
+    object: PageFlip;
+}
+/** State change event data */
+export interface StateEvent {
+    /** New page state */
+    data: PageState;
+    /** The PageFlip object */
+    object: PageFlip;
+}
+/** Event props */
+export interface IEventProps {
+    /** Called when page is flipped */
+    onFlip?: (e: FlipEvent) => void;
+    /** Called when orientation changes (portrait/landscape) */
+    onChangeOrientation?: (e: OrientationEvent) => void;
+    /** Called when page state changes */
+    onChangeState?: (e: StateEvent) => void;
+    /** Called when the book is initialized */
+    onInit?: (e: FlipEvent) => void;
+    /** Called when pages are updated */
+    onUpdate?: (e: FlipEvent) => void;
+}
+/** Page flip instance - exposes the PageFlip object and helper methods */
+export interface PageFlipInstance {
+    /** Get the underlying PageFlip object */
+    pageFlip: () => PageFlip | null;
+    /** Flip to next page with animation */
+    flipNext: (corner?: FlipCorner) => void;
+    /** Flip to previous page with animation */
+    flipPrev: (corner?: FlipCorner) => void;
+    /** Flip to specific page with animation */
+    flip: (pageNum: number, corner?: FlipCorner) => void;
+    /** Turn to specific page without animation */
+    turnToPage: (pageNum: number) => void;
+    /** Get current page index (0-based) */
+    getCurrentPageIndex: () => number;
+    /** Get total page count */
+    getPageCount: () => number;
+    /** Get current orientation */
+    getOrientation: () => PageOrientation | null;
+    /** Get current page state */
+    getState: () => PageState | null;
+}
+/** Props for the Page component */
+export interface PageProps {
+    /** Page number (for display purposes) */
+    number?: number;
+    /** Page density - hard or soft */
+    density?: PageDensity;
+    /** Page content */
+    children?: React.ReactNode;
+    /** Additional className */
+    className?: string;
+    /** Additional style */
+    style?: React.CSSProperties;
+}
+/** Props for the PageCover component */
+export interface PageCoverProps {
+    /** Page number (for display purposes) */
+    number?: number;
+    /** Page content */
+    children?: React.ReactNode;
+    /** Additional className */
+    className?: string;
+    /** Additional style */
+    style?: React.CSSProperties;
+    /** Whether this is front or back cover */
+    position?: 'front' | 'back';
+}
+export type { PageFlip };
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAE1C,iBAAiB;AACjB,MAAM,MAAM,SAAS,GAAG,WAAW,GAAG,aAAa,GAAG,UAAU,GAAG,MAAM,CAAC;AAE1E,uBAAuB;AACvB,MAAM,MAAM,eAAe,GAAG,UAAU,GAAG,WAAW,CAAC;AAEvD,2CAA2C;AAC3C,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,CAAC;AAE1C,gBAAgB;AAChB,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;AAE3C,uBAAuB;AACvB,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,QAAQ,CAAC;AAE1C,6BAA6B;AAC7B,MAAM,WAAW,YAAY;IAC3B,8CAA8C;IAC9C,SAAS,EAAE,MAAM,CAAC;IAClB,yEAAyE;IACzE,IAAI,EAAE,QAAQ,CAAC;IACf,iBAAiB;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,kBAAkB;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,gCAAgC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,gCAAgC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,6CAA6C;IAC7C,UAAU,EAAE,OAAO,CAAC;IACpB,oCAAoC;IACpC,YAAY,EAAE,MAAM,CAAC;IACrB,wCAAwC;IACxC,WAAW,EAAE,OAAO,CAAC;IACrB,+BAA+B;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,sFAAsF;IACtF,QAAQ,EAAE,OAAO,CAAC;IAClB,6DAA6D;IAC7D,gBAAgB,EAAE,MAAM,CAAC;IACzB,uHAAuH;IACvH,SAAS,EAAE,OAAO,CAAC;IACnB,uEAAuE;IACvE,mBAAmB,EAAE,OAAO,CAAC;IAC7B,2EAA2E;IAC3E,iBAAiB,EAAE,OAAO,CAAC;IAC3B,oDAAoD;IACpD,cAAc,EAAE,OAAO,CAAC;IACxB,wCAAwC;IACxC,aAAa,EAAE,MAAM,CAAC;IACtB,8FAA8F;IAC9F,eAAe,EAAE,OAAO,CAAC;IACzB,oGAAoG;IACpG,kBAAkB,EAAE,OAAO,CAAC;CAC7B;AAED,iBAAiB;AACjB,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,eAAe,CAAC;CACvB;AAED,sBAAsB;AACtB,MAAM,WAAW,SAAS;IACxB,mCAAmC;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,0BAA0B;IAC1B,MAAM,EAAE,QAAQ,CAAC;CAClB;AAED,oCAAoC;AACpC,MAAM,WAAW,gBAAgB;IAC/B,sBAAsB;IACtB,IAAI,EAAE,eAAe,CAAC;IACtB,0BAA0B;IAC1B,MAAM,EAAE,QAAQ,CAAC;CAClB;AAED,8BAA8B;AAC9B,MAAM,WAAW,UAAU;IACzB,qBAAqB;IACrB,IAAI,EAAE,SAAS,CAAC;IAChB,0BAA0B;IAC1B,MAAM,EAAE,QAAQ,CAAC;CAClB;AAED,kBAAkB;AAClB,MAAM,WAAW,WAAW;IAC1B,kCAAkC;IAClC,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,SAAS,KAAK,IAAI,CAAC;IAChC,2DAA2D;IAC3D,mBAAmB,CAAC,EAAE,CAAC,CAAC,EAAE,gBAAgB,KAAK,IAAI,CAAC;IACpD,qCAAqC;IACrC,aAAa,CAAC,EAAE,CAAC,CAAC,EAAE,UAAU,KAAK,IAAI,CAAC;IACxC,0CAA0C;IAC1C,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,SAAS,KAAK,IAAI,CAAC;IAChC,oCAAoC;IACpC,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,SAAS,KAAK,IAAI,CAAC;CACnC;AAED,0EAA0E;AAC1E,MAAM,WAAW,gBAAgB;IAC/B,yCAAyC;IACzC,QAAQ,EAAE,MAAM,QAAQ,GAAG,IAAI,CAAC;IAChC,uCAAuC;IACvC,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE,UAAU,KAAK,IAAI,CAAC;IACxC,2CAA2C;IAC3C,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE,UAAU,KAAK,IAAI,CAAC;IACxC,2CAA2C;IAC3C,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,UAAU,KAAK,IAAI,CAAC;IACrD,8CAA8C;IAC9C,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IACtC,uCAAuC;IACvC,mBAAmB,EAAE,MAAM,MAAM,CAAC;IAClC,2BAA2B;IAC3B,YAAY,EAAE,MAAM,MAAM,CAAC;IAC3B,8BAA8B;IAC9B,cAAc,EAAE,MAAM,eAAe,GAAG,IAAI,CAAC;IAC7C,6BAA6B;IAC7B,QAAQ,EAAE,MAAM,SAAS,GAAG,IAAI,CAAC;CAClC;AAED,mCAAmC;AACnC,MAAM,WAAW,SAAS;IACxB,yCAAyC;IACzC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kCAAkC;IAClC,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,mBAAmB;IACnB,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,2BAA2B;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,uBAAuB;IACvB,KAAK,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;CAC7B;AAED,wCAAwC;AACxC,MAAM,WAAW,cAAc;IAC7B,yCAAyC;IACzC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mBAAmB;IACnB,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,2BAA2B;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,uBAAuB;IACvB,KAAK,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IAC5B,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;CAC7B;AAGD,YAAY,EAAE,QAAQ,EAAE,CAAC"}

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "react-magazine",
+  "version": "1.0.0",
+  "description": "A lightweight React component for realistic page-flip animations, featuring built-in navigation controls, full TypeScript support, and easy style customization.",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
+    },
+    "./styles.css": "./dist/styles.css"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "sideEffects": [
+    "*.css"
+  ],
+  "scripts": {
+    "build": "npm run clean && npm run build:esm && npm run build:cjs && npm run build:types && npm run build:css",
+    "build:esm": "rollup -c rollup.config.mjs --environment FORMAT:esm",
+    "build:cjs": "rollup -c rollup.config.mjs --environment FORMAT:cjs",
+    "build:types": "tsc --emitDeclarationOnly --declaration --declarationDir dist/types",
+    "build:css": "node -e \"require('fs').mkdirSync('dist', {recursive: true}); require('fs').copyFileSync('src/styles.css', 'dist/styles.css')\"",
+    "clean": "node -e \"require('fs').rmSync('dist', {recursive: true, force: true})\"",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "page-flip": "^2.0.7"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0 || ^19.0.0",
+    "react-dom": "^18.0.0 || ^19.0.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^25.0.7",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-typescript": "^11.1.5",
+    "@types/react": "^19.0.0",
+    "@types/react-dom": "^19.0.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "rollup": "^4.9.0",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "tslib": "^2.6.2",
+    "typescript": "^5.3.0"
+  },
+  "keywords": [
+    "react",
+    "pageflip",
+    "flipbook",
+    "magazine",
+    "book",
+    "page-turn",
+    "page-flip",
+    "flip-book",
+    "typescript",
+    "react-component"
+  ],
+  "author": "Gnanaprakash",
+  "license": "MIT",
+  "homepage": "https://github.com/Gnanaprakash-Dev/react-magazine#readme",
+  "bugs": {
+    "url": "https://github.com/Gnanaprakash-Dev/react-magazine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Gnanaprakash-Dev/react-magazine.git"
+  }
+}