v4.1.3

CHANGELOG.md

@@ -1,3 +1,11 @@
+## 4.1.3 - Released on 2025-05-17
+
+### Features
+
+- Added TypeScript module typing
+
+<br>
+
 ## 4.1.2 - Released on 2025-05-17
 
 ### Fixes

package.json

@@ -1,6 +1,6 @@
 {
   "name": "prismium-src",
-  "version": "4.1.2",
+  "version": "4.1.3",
   "description": "A modern JavaScript accordion library with smooth animations. Easily integrates with React, Vue, and vanilla JavaScript.",
   "type": "module",
   "scripts": {

src/copy/package.json

@@ -15,15 +15,18 @@
       "vue": ["./types/vue.d.ts"]
     }
   },
+
   "exports": {
     ".": {
       "types": "./types/index.d.ts",
       "import": "./prismium-core.mjs"
     },
+
     "./bundle": {
       "types": "./types/index.d.ts",
       "import": "./prismium-bundle.mjs"
     },
+
     "./css": "./prismium.css",
     "./css/bundle": "./prismium-bundle.css",
 
@@ -38,7 +41,10 @@
     "./theme/ocean": "./themes/ocean.css",
     "./theme/sunset": "./themes/sunset.css",
 
-    "./modules": "./modules/index.mjs",
+    "./modules": {
+      "types": "./types/modules/index.d.ts",
+      "import": "./modules/index.mjs"
+    },
 
     "./react": {
       "types": "./types/react.d.ts",
@@ -50,10 +56,12 @@
       "import": "./vue/index.mjs"
     }
   },
+
   "repository": {
     "type": "git",
     "url": "git+https://github.com/koirodev/prismium.git"
   },
+
   "keywords": @keywords,
   "author": "@author",
   "license": "MIT",

src/types/modules/effectsModule.d.ts

@@ -0,0 +1,172 @@
+import { PrismiumEffect, PrismiumModule } from '../index';
+import Prismium from '../core';
+
+/**
+ * Options for the EffectsModule
+ */
+export interface EffectsModuleOptions {
+  /**
+   * Animation effect type
+   */
+  effect?: PrismiumEffect;
+
+  /**
+   * Animation effect selectors
+   */
+  effectSelectors?: string | string[];
+
+  /**
+   * Animation effect ignore selectors
+   */
+  effectIgnore?: string | string[];
+
+  /**
+   * Animation effect line by line
+   */
+  effectLineByLine?: {
+    speed?: number;
+    easing?: string;
+    delay?: number;
+    scale?: number;
+    y?: number | string;
+    x?: number | string;
+    opacity?: number;
+  };
+
+  /**
+   * Animation effect fade scale
+   */
+  effectFadeScale?: {
+    speed?: number;
+    easing?: string;
+    scale?: number;
+    opacity?: number;
+  };
+
+  /**
+   * Animation effect slide
+   */
+  effectSlide?: {
+    speed?: number;
+    easing?: string;
+    directions?: 'up' | 'down' | 'left' | 'right';
+    distance?: number | string;
+    opacity?: number;
+  };
+
+  /**
+   * Animation effect stagger
+   */
+  effectStagger?: {
+    speed?: number;
+    easing?: string;
+    delay?: number;
+    directions?: Array<'up' | 'right' | 'down' | 'left'>;
+    distance?: number | string;
+    opacity?: number;
+  };
+
+  /**
+   * Animation effect wave
+   */
+  effectWave?: {
+    speed?: number;
+    easing?: string;
+    delay?: number;
+    amplitude?: string | number;
+    frequency?: number;
+    opacity?: number;
+  };
+
+  /**
+   * Animation effect flip
+   */
+  effectFlip?: {
+    speed?: number;
+    easing?: string;
+    delay?: number;
+    perspective?: number | string;
+    rotation?: number | string;
+    opacity?: number;
+  };
+
+  /**
+   * Animation effect zoom
+   */
+  effectZoom?: {
+    speed?: number;
+    easing?: string;
+    delay?: number;
+    scale?: number;
+    opacity?: number;
+    origins?: string[];
+  };
+
+  /**
+   * Animation effect cascade
+   */
+  effectCascade?: {
+    speed?: number;
+    easing?: string;
+    delay?: number;
+    rotation?: number;
+    distance?: number | string;
+    opacity?: number;
+  };
+
+  /**
+   * Animation effect custom
+   */
+  effectCustom?: {
+    speed?: number;
+    delay?: number;
+    setup?: (
+      prismium: Prismium,
+      child: HTMLElement,
+      index: number,
+      total: number,
+      isOpening: boolean
+    ) => void;
+    open?: (
+      prismium: Prismium,
+      child: HTMLElement,
+      index: number,
+      total: number
+    ) => void;
+    close?: (
+      prismium: Prismium,
+      child: HTMLElement,
+      index: number,
+      total: number
+    ) => void;
+    cleanup?: (
+      prismium: Prismium,
+      child: HTMLElement,
+      index: number,
+      total: number,
+      isOpening: boolean
+    ) => void;
+  };
+}
+
+/**
+ * Effects module for Prismium
+ * Adds animation effects to accordion content
+ */
+export interface EffectsModule extends PrismiumModule {
+  /**
+   * Module name
+   */
+  name: 'effects';
+
+  /**
+   * Default options for effects
+   */
+  defaultOptions: EffectsModuleOptions;
+
+  /**
+   * Install the effects module
+   * @param instance - The Prismium instance
+   */
+  install(instance: Prismium): void;
+}

src/types/modules/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Type definitions for Prismium modules
+ */
+
+import { EffectsModule } from './effectsModule';
+
+/**
+ * Export all modules types
+ */
+export { EffectsModule };
+
+/**
+ * Type for the EffectsModule export
+ */
+export declare const EffectsModule: EffectsModule;