aspect-grid-collageify 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,104 @@
+interface PlacedImage {
+    id: string;
+    src: string;
+    name: string;
+    gridX: number;
+    gridY: number;
+    span: number;
+    borderRadius2K?: number;
+    shadowBlur2K?: number;
+    shadowOffset2K?: number;
+    shadowOpacity?: number;
+}
+interface CollageConfig {
+    containerRatio: string;
+    customContainerW?: number;
+    customContainerH?: number;
+    imageRatio: string;
+    customImageW?: number;
+    customImageH?: number;
+    gridColumns: number;
+    padding2K: number;
+    gap2K: number;
+    containerBgColor?: string;
+    useTransparentBg?: boolean;
+    images: PlacedImage[];
+    showGridlines?: boolean;
+    placementSize?: "small" | "medium" | "large";
+    imageBorderRadius2K?: number;
+    imageShadowBlur2K?: number;
+    imageShadowOffset2K?: number;
+    imageShadowOpacity?: number;
+}
+declare class AspectGridCollageify {
+    private config;
+    private canvas;
+    private ctx;
+    private imageCache;
+    private loadingImages;
+    private activeImageId;
+    private draggedImageId;
+    private dragStartOffset;
+    private dragCurrentPos;
+    private draggedOverCell;
+    private hoveredPlaceholder;
+    private isDragging;
+    private changeCallbacks;
+    private activeCallbacks;
+    private clickCallbacks;
+    constructor(config: CollageConfig, canvasElement?: HTMLCanvasElement);
+    getConfig(): CollageConfig;
+    updateConfig(newConfig: Partial<CollageConfig>): void;
+    getImages(): PlacedImage[];
+    setImages(images: PlacedImage[]): void;
+    getActiveImageId(): string | null;
+    setActiveImageId(id: string | null): void;
+    onImagesChanged(callback: (images: PlacedImage[]) => void): void;
+    onActiveImageChanged(callback: (id: string | null) => void): void;
+    onCellClicked(callback: (x: number, y: number) => void): void;
+    private triggerChange;
+    private triggerActiveChange;
+    private triggerCellClick;
+    private getOrLoadImage;
+    private preloadAllImages;
+    canPlaceImage(imgId: string | null, x: number, y: number, spanSize: number, gridRows: number): boolean;
+    addImage(img: PlacedImage): void;
+    removeImage(imgId: string): void;
+    updateImage(imgId: string, updates: Partial<PlacedImage>): void;
+    modifyImageSpan(imgId: string, delta: number, gridRows: number): boolean;
+    stepImagePosition(imgId: string, dir: "up" | "down" | "left" | "right", gridRows: number): boolean;
+    pushDownBelow(imgId: string, gridRows: number): boolean;
+    pullUpBelow(imgId: string): boolean;
+    calculateLayout(width: number, height: number): {
+        scale: number;
+        padding: number;
+        gap: number;
+        cellW: number;
+        cellH: number;
+        gridRows: number;
+        offsetX: number;
+        offsetY: number;
+        gridW: number;
+        gridH: number;
+        containerRatioVal: number;
+        imageRatioVal: number;
+    };
+    private initEvents;
+    private hitTest;
+    private getImageRect;
+    private getCurrentTargetSpan;
+    getPlaceholders(targetSpan: number, gridRows: number): Array<{
+        gridX: number;
+        gridY: number;
+        span: number;
+    }>;
+    render(drawUI?: boolean): void;
+    /**
+     * The master draw function: compiles background, images, and overlays.
+     * Can be shared between interactive Canvas on the page and high-res offscreen Canvas.
+     */
+    draw(ctx: CanvasRenderingContext2D, width: number, height: number, drawUI: boolean): void;
+    exportPNG(targetWidth?: number): Promise<string>;
+}
+
+export { AspectGridCollageify, type CollageConfig, type PlacedImage };