@edgepdf/viewer-js 0.0.34 → 0.1.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 EdgePDF
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/README.md

@@ -1,6 +1,6 @@
 # @edgepdf/viewer-js
 
-Core JavaScript library for the EdgePDF viewer, providing Leaflet map integration for displaying and interacting with PDF/image tiles.
+A powerful, self-contained JavaScript library for viewing large PDF documents in the browser. Provides smooth navigation, zoom controls, and interactive marker management without requiring any external dependencies.
 
 ## Installation
 
@@ -12,7 +12,18 @@ pnpm add @edgepdf/viewer-js
 yarn add @edgepdf/viewer-js
 ```
 
-**Note:** Leaflet is bundled with this library, so you don't need to install it separately. **CSS styles are automatically injected** when you import the library - no manual CSS import needed!
+**Note:** All dependencies are bundled with this library. **CSS styles are automatically injected** when you import the library - no manual CSS import needed!
+
+## Features
+
+- ⚡ **Zero Configuration**: Works out of the box with sensible defaults
+- 📦 **Self-Contained**: All dependencies bundled - no external CSS or scripts needed
+- 🎯 **Precise Control**: Programmatic zoom, pan, and focus capabilities
+- 📍 **Rich Markers**: Support for draggable, editable markers with tooltips and custom icons
+- 🔄 **Data Management**: Import/export marker data for persistence
+- 🎨 **Customizable**: Flexible API for styling and behavior customization
+- 📱 **Touch-Friendly**: Full support for touch gestures on mobile devices
+- ♿ **Accessible**: Keyboard navigation and ARIA labels included
 
 ## Quick Start
 
@@ -46,7 +57,7 @@ const markerManager = viewer.getMarkerManager();
 if (markerManager) {
   // Create a marker
   const marker = markerManager.createMarker({
-    position: [1500, 1000], // [lat, lng] in Leaflet coordinates
+    position: [1500, 1000], // [y, x] coordinates
     label: 'My Marker',
   });
 }
@@ -92,7 +103,7 @@ viewer.initialize();
 
 ### EdgePdfViewer
 
-Main class for initializing and managing Leaflet map instances.
+Main class for initializing and managing interactive map instances for PDF viewing.
 
 #### Constructor
 
@@ -108,7 +119,7 @@ new EdgePdfViewer(options: {
 
 - `container` - HTML element that will contain the map
 - `config` - Viewer configuration with tile URL and image info
-- `mapOptions` - Optional Leaflet map options (center, zoom, etc.)
+- `mapOptions` - Optional map options (center, zoom, etc.)
 
 **Throws:**
 
@@ -121,17 +132,17 @@ new EdgePdfViewer(options: {
 
 ##### `initialize(): void`
 
-Initializes the Leaflet map with custom CRS (Coordinate Reference System). Sets up a custom CRS.Simple coordinate system suitable for displaying image tiles without geographic coordinates.
+Initializes the viewer and prepares it for displaying the PDF document. Call this method after creating the viewer instance.
 
 **Throws:**
 
-- `Error` if map initialization fails
+- `Error` if initialization fails
 
 ##### `getMap(): L.Map | null`
 
-Gets the Leaflet map instance.
+Gets the map instance.
 
-**Returns:** The Leaflet map instance, or `null` if not initialized
+**Returns:** The map instance, or `null` if not initialized
 
 ##### `isInitialized(): boolean`
 
@@ -182,6 +193,7 @@ Focuses on a marker by panning and zooming to its position.
 **Returns:** `true` if focus was successful, `false` if marker not found or viewer not initialized
 
 **Example:**
+
 ```typescript
 // Focus with offset to account for overlay
 viewer.focusMarker('marker-123', { offsetLeft: 100, offsetTop: 50 });
@@ -195,7 +207,7 @@ Disposes of the map instance and cleans up resources. This should be called when
 
 ### MarkerManager
 
-Manages markers on the Leaflet map. Access via `viewer.getMarkerManager()`.
+Manages markers on the interactive map. Access via `viewer.getMarkerManager()`.
 
 #### Methods
 
@@ -205,7 +217,7 @@ Creates a new marker from coordinates.
 
 **Parameters:**
 
-- `options.position?: LeafletCoords` - Leaflet coordinates [lat, lng]
+- `options.position?: LeafletCoords` - Map coordinates [y, x]
 - `options.imageCoords?: ImageCoords` - Image pixel coordinates {x, y}
 - `options.label?: string` - Marker label/tooltip text
 - `options.description?: string` - Marker description
@@ -268,7 +280,7 @@ Updates a marker's position.
 **Parameters:**
 
 - `id` - Marker ID
-- `position` - New Leaflet coordinates [lat, lng]
+- `position` - New map coordinates [y, x]
 
 **Returns:** `true` if marker was updated, `false` if not found
 
@@ -399,6 +411,7 @@ Focuses on a marker by panning and zooming to its position.
 **Returns:** `true` if focus was successful, `false` if marker not found
 
 **Example:**
+
 ```typescript
 // Focus with offset to account for overlay
 markerManager.focusMarker('marker-123', { offsetLeft: 100, offsetTop: 50 });
@@ -671,11 +684,13 @@ type IconType = 'pin-gray' | 'pin-yellow';
 
 ## Coordinate System
 
-The viewer uses Leaflet's `CRS.Simple` coordinate system, which treats coordinates as pixel positions rather than geographic lat/lng. This is ideal for displaying image tiles:
+The viewer uses a simple pixel-based coordinate system for positioning markers:
+
+- **Format**: `[y, x]` - array with vertical position first, horizontal position second
+- **Range**: X from 0 to image width, Y from 0 to image height
+- **Origin**: Top-left corner at `[0, 0]`
 
-- X-axis: horizontal pixel position (0 to image width)
-- Y-axis: vertical pixel position (0 to image height)
-- Origin: top-left corner (0, 0)
+**Note**: You can also use image pixel coordinates `{x, y}` when creating markers - the viewer will automatically convert them to the appropriate format.
 
 ## Examples
 

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import './styles.css';
+import './inject-css';
 export * from './lib/viewer.js';
 export { EdgePdfViewer } from './lib/viewer.js';
 export { TileLayerManager } from './lib/tile-layer-manager.js';