{"_id":"react-apple-mapkit","_rev":"29-d543e2939ada28297b763ba7c7988513","name":"react-apple-mapkit","dist-tags":{"latest":"1.2.8"},"versions":{"1.2.2":{"name":"react-apple-mapkit","version":"1.2.2","keywords":["react","apple","mapkit","maps","typescript"],"author":{"name":"Ziya Akhundov"},"license":"MIT","_id":"react-apple-mapkit@1.2.2","maintainers":[{"name":"programmersschool","email":"programmersschoolaz@gmail.com"}],"homepage":"https://github.com/ZiyaAkhundov/react-apple-mapkit#readme","bugs":{"url":"https://github.com/ZiyaAkhundov/react-apple-mapkit/issues"},"dist":{"shasum":"57c0c858b04f202f1ff672d8dd32154ef9c149d8","tarball":"https://registry.npmjs.org/react-apple-mapkit/-/react-apple-mapkit-1.2.2.tgz","fileCount":45,"integrity":"sha512-5WuOxVrmSwBzbTKY+rEWBahvHkUUVHuliC4Z/ZyP6Am5q+mvn/xYqnLIecWeZQNC78EUWFQG13HDqkzy6VG2ug==","signatures":[{"sig":"MEUCIFSAXDA4b3NOSrfJ1Da2rcHcjvrV9Qt7Jz8Cy5IPcF8ZAiEA8+yksnjdh4nFtMKNqZ7acymBhqmzs3ImxTaCz57nLno=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":60449},"main":"dist/index.js","type":"module","types":"dist/index.d.ts","gitHead":"4966e3ad5fa06718ee0b8b85107c9bf1aba21d83","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsc","prepare":"npm run build","prepublishOnly":"npm run build"},"_npmUser":{"name":"programmersschool","email":"programmersschoolaz@gmail.com"},"repository":{"url":"git+https://github.com/ZiyaAkhundov/react-apple-mapkit.git","type":"git"},"_npmVersion":"11.0.0","description":"A React wrapper for Apple MapKit JS.","directories":{},"_nodeVersion":"22.12.0","_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.8.2","@types/react":"^19.0.10","@types/react-dom":"^19.0.4"},"peerDependencies":{"react":"^19.0.0","react-dom":"^19.0.0"},"_npmOperationalInternal":{"tmp":"tmp/react-apple-mapkit_1.2.2_1741753334827_0.2148485405414673","host":"s3://npm-registry-packages-npm-production"}},"1.2.3":{"name":"react-apple-mapkit","version":"1.2.3","keywords":["react","apple","mapkit","maps","typescript"],"author":{"name":"Ziya Akhundov"},"license":"MIT","_id":"react-apple-mapkit@1.2.3","maintainers":[{"name":"programmersschool","email":"programmersschoolaz@gmail.com"}],"homepage":"https://github.com/ZiyaAkhundov/react-apple-mapkit#readme","bugs":{"url":"https://github.com/ZiyaAkhundov/react-apple-mapkit/issues"},"dist":{"shasum":"ab37b975f49e1c02eaa7b7d473193cca0b4244b9","tarball":"https://registry.npmjs.org/react-apple-mapkit/-/react-apple-mapkit-1.2.3.tgz","fileCount":45,"integrity":"sha512-r+lgFHxiAicWfWMXWcZDuiKkQz69d500FK9e3qLNlK5WRgLxoX0+4tW5TJcfD6RYp+XXMMmf+vSZ/8mvG7vq0A==","signatures":[{"sig":"MEUCICB46FjKfcCI23C7T6bgdwNtuCRGlkN3wxvyIlwCdcjHAiEAjJIHnctLGxpC96+rjWiCo6DoJhQd49C4fWmMtJ5g56U=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":60442},"main":"dist/index.js","type":"module","types":"dist/index.d.ts","gitHead":"4966e3ad5fa06718ee0b8b85107c9bf1aba21d83","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsc","prepare":"npm run build","prepublishOnly":"npm run build"},"_npmUser":{"name":"programmersschool","email":"programmersschoolaz@gmail.com"},"repository":{"url":"git+https://github.com/ZiyaAkhundov/react-apple-mapkit.git","type":"git"},"_npmVersion":"11.0.0","description":"A React wrapper for Apple MapKit JS.","directories":{},"_nodeVersion":"22.12.0","dependencies":{"react":"^18.0.0","react-dom":"^18.0.0"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.8.2","@types/react":"^18.0.0","@types/react-dom":"^18.0.0"},"_npmOperationalInternal":{"tmp":"tmp/react-apple-mapkit_1.2.3_1741753978607_0.3633289612539665","host":"s3://npm-registry-packages-npm-production"}},"1.2.4":{"name":"react-apple-mapkit","version":"1.2.4","keywords":["react","apple","mapkit","maps","typescript"],"author":{"name":"Ziya Akhundov"},"license":"MIT","_id":"react-apple-mapkit@1.2.4","maintainers":[{"name":"programmersschool","email":"programmersschoolaz@gmail.com"}],"homepage":"https://github.com/ZiyaAkhundov/react-apple-mapkit#readme","bugs":{"url":"https://github.com/ZiyaAkhundov/react-apple-mapkit/issues"},"dist":{"shasum":"3c044bb1f5a267f3da172aec716bf0e7460d01e5","tarball":"https://registry.npmjs.org/react-apple-mapkit/-/react-apple-mapkit-1.2.4.tgz","fileCount":45,"integrity":"sha512-Gajqh6UEAcvXiQmZU35CtOZVmCskG/k3ULLv+MOZpeeet1mSMm9wPytsJoN5w1Vx0WqPhhmdEU4XJA/5Xy0Ahw==","signatures":[{"sig":"MEYCIQCKttAnpaGGN26UCR1xkFt2rVzEpBDWiB0L31A46ZRUUgIhAICp8hFvYEAwsZbGSZqf1oe43tmaZ6rZv01bOtK3ZZtm","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":60416},"main":"dist/index.js","type":"module","types":"dist/index.d.ts","gitHead":"4966e3ad5fa06718ee0b8b85107c9bf1aba21d83","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsc","prepare":"npm run build","prepublishOnly":"npm run build"},"_npmUser":{"name":"programmersschool","email":"programmersschoolaz@gmail.com"},"repository":{"url":"git+https://github.com/ZiyaAkhundov/react-apple-mapkit.git","type":"git"},"_npmVersion":"11.0.0","description":"A React wrapper for Apple MapKit JS.","directories":{},"_nodeVersion":"22.12.0","dependencies":{"react":"^18.3.1","react-dom":"^18.3.1","typescript":"^5.8.2","@types/react":"^18.3.18","@types/react-dom":"^18.3.5"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/react-apple-mapkit_1.2.4_1741754672107_0.8526081111957917","host":"s3://npm-registry-packages-npm-production"}},"1.2.6":{"name":"react-apple-mapkit","version":"1.2.6","keywords":["react","apple","mapkit","maps","typescript"],"author":{"name":"Ziya Akhundov"},"license":"MIT","_id":"react-apple-mapkit@1.2.6","maintainers":[{"name":"programmersschool","email":"programmersschoolaz@gmail.com"}],"homepage":"https://github.com/ZiyaAkhundov/react-apple-mapkit#readme","bugs":{"url":"https://github.com/ZiyaAkhundov/react-apple-mapkit/issues"},"dist":{"shasum":"2a7c1695049844b026778823ff7cb302cb35f69c","tarball":"https://registry.npmjs.org/react-apple-mapkit/-/react-apple-mapkit-1.2.6.tgz","fileCount":81,"integrity":"sha512-jv61jEaz5iDrx4QvF3PPTbYIUGAXoXhoE+BiF06TTMHhfH1HIcsELVDfg7HoQ+zisUzH3kZWXEfeFxO2XiM9cw==","signatures":[{"sig":"MEUCIQDRYkUdZi6B/hy85U9KtN65rcdT1uOuynBanF6pl6p4OAIgZ21PV3nrJQoAIB5UL7bpyg0jbTx6MMzO1QNBja/SQ3w=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":66892},"main":"dist/index.js","type":"module","types":"dist/index.d.ts","gitHead":"4966e3ad5fa06718ee0b8b85107c9bf1aba21d83","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsc","prepare":"npm run build","prepublishOnly":"npm run build"},"_npmUser":{"name":"programmersschool","email":"programmersschoolaz@gmail.com"},"repository":{"url":"git+https://github.com/ZiyaAkhundov/react-apple-mapkit.git","type":"git"},"_npmVersion":"11.0.0","description":"A React wrapper for Apple MapKit JS.","directories":{},"_nodeVersion":"22.12.0","_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.8.2","@types/react":"^19.0.10","@types/react-dom":"^19.0.4"},"peerDependencies":{"react":"^19.0.0","react-dom":"^19.0.0"},"_npmOperationalInternal":{"tmp":"tmp/react-apple-mapkit_1.2.6_1741757634507_0.816718556869171","host":"s3://npm-registry-packages-npm-production"}},"1.2.7":{"name":"react-apple-mapkit","version":"1.2.7","keywords":["react","apple","mapkit","maps","typescript"],"author":{"name":"Ziya Akhundov"},"license":"MIT","_id":"react-apple-mapkit@1.2.7","maintainers":[{"name":"programmersschool","email":"programmersschoolaz@gmail.com"}],"homepage":"https://github.com/ZiyaAkhundov/react-apple-mapkit#readme","bugs":{"url":"https://github.com/ZiyaAkhundov/react-apple-mapkit/issues"},"dist":{"shasum":"262355942717b18c284b4888f196f01fae201eb7","tarball":"https://registry.npmjs.org/react-apple-mapkit/-/react-apple-mapkit-1.2.7.tgz","fileCount":81,"integrity":"sha512-fRWkP+zCQ/w8m2Nch0uPyiXvgDIuRMALZ/Bcc3d3QxEPoK46TfCvF0aiTLQKlwdkRnUO73ackQDn9+BHdlJGOw==","signatures":[{"sig":"MEUCIF1DQopX3Qq1q8nxvK7esm1LNBJpynjKo4aApRLZefzBAiEAnQ6ru2/BUULmabeFIhe09thMY8Kmx23En9jcJ2P5kl4=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":67103},"main":"dist/index.js","type":"module","types":"dist/index.d.ts","gitHead":"34c81e31b7da04f454191c413d2adaa7a193e7c9","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsc","prepare":"npm run build","prepublishOnly":"npm run build"},"_npmUser":{"name":"programmersschool","email":"programmersschoolaz@gmail.com"},"repository":{"url":"git+https://github.com/ZiyaAkhundov/react-apple-mapkit.git","type":"git"},"_npmVersion":"11.0.0","description":"A React wrapper for Apple MapKit JS.","directories":{},"_nodeVersion":"22.12.0","_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.8.2","@types/react":"^19.0.10","@types/react-dom":"^19.0.4"},"peerDependencies":{"react":"^19.0.0","react-dom":"^19.0.0"},"_npmOperationalInternal":{"tmp":"tmp/react-apple-mapkit_1.2.7_1741758960853_0.8494202383359486","host":"s3://npm-registry-packages-npm-production"}},"1.2.8":{"name":"react-apple-mapkit","version":"1.2.8","description":"A lightweight React wrapper for Apple MapKit JS with an easy-to-use API.","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"build":"tsc","prepare":"npm run build","prepublishOnly":"npm run build","test":"echo \"Error: no test specified\" && exit 1"},"keywords":["react","apple","mapkit","maps","typescript"],"author":{"name":"Ziya Akhundov"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/ZiyaAkhundov/react-apple-mapkit.git"},"bugs":{"url":"https://github.com/ZiyaAkhundov/react-apple-mapkit/issues"},"homepage":"https://github.com/ZiyaAkhundov/react-apple-mapkit#readme","peerDependencies":{"react":"^19.0.0","react-dom":"^19.0.0"},"devDependencies":{"@types/react":"^19.0.10","@types/react-dom":"^19.0.4","typescript":"^5.8.2"},"type":"module","_id":"react-apple-mapkit@1.2.8","gitHead":"cbca7d3928d25c752da7a796aef9d223e5a134b3","_nodeVersion":"22.12.0","_npmVersion":"11.0.0","dist":{"integrity":"sha512-x9T1AWgWBUn1tRYBhxDUvBlRw2gXV4bIaTpOL+kASGDpU1fHh72+ij/6rqYr0sGeR+z5raUmGuE6OdAAXVXs4w==","shasum":"c8e11383f93716672dadddceebbf2f3382442161","tarball":"https://registry.npmjs.org/react-apple-mapkit/-/react-apple-mapkit-1.2.8.tgz","fileCount":81,"unpackedSize":67171,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDljBwLVYeqLXJv/eWy6+qh1hvOU62DYVhw8FksrG7JtgIhAPK/86Jprp1yVK3LmPT0b4qJliMOhZ/gjj41ZHAOhSwu"}]},"_npmUser":{"name":"programmersschool","email":"programmersschoolaz@gmail.com"},"directories":{},"maintainers":[{"name":"programmersschool","email":"programmersschoolaz@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/react-apple-mapkit_1.2.8_1741859233789_0.32333544947162784"},"_hasShrinkwrap":false}},"time":{"created":"2025-03-12T04:22:14.826Z","modified":"2025-03-13T09:47:14.114Z","1.0.0":"2025-03-09T15:07:04.933Z","1.0.1":"2025-03-09T15:53:12.442Z","1.0.2":"2025-03-09T16:30:45.898Z","1.0.3":"2025-03-09T16:34:09.920Z","1.0.4":"2025-03-09T16:43:35.845Z","1.0.5":"2025-03-09T16:45:01.557Z","1.0.6":"2025-03-09T17:23:54.307Z","1.0.7":"2025-03-09T17:32:49.873Z","1.0.8":"2025-03-09T17:35:21.107Z","1.0.9":"2025-03-09T17:36:16.437Z","1.1.0":"2025-03-10T08:54:33.224Z","1.1.1":"2025-03-10T09:00:56.951Z","1.1.2":"2025-03-10T09:13:51.729Z","1.1.3":"2025-03-10T09:15:10.981Z","1.1.4":"2025-03-10T09:17:39.291Z","1.1.5":"2025-03-10T09:18:59.044Z","1.1.6":"2025-03-10T09:46:55.788Z","1.1.7":"2025-03-10T09:49:57.615Z","1.1.8":"2025-03-10T09:54:37.656Z","1.1.9":"2025-03-10T09:57:31.476Z","1.2.0":"2025-03-10T10:07:38.945Z","1.2.1":"2025-03-10T10:21:03.038Z","1.2.2":"2025-03-12T04:22:14.986Z","1.2.3":"2025-03-12T04:32:58.810Z","1.2.4":"2025-03-12T04:44:32.327Z","1.2.6":"2025-03-12T05:33:54.721Z","1.2.7":"2025-03-12T05:56:01.045Z","1.2.8":"2025-03-13T09:47:13.950Z"},"bugs":{"url":"https://github.com/ZiyaAkhundov/react-apple-mapkit/issues"},"author":{"name":"Ziya Akhundov"},"license":"MIT","homepage":"https://github.com/ZiyaAkhundov/react-apple-mapkit#readme","keywords":["react","apple","mapkit","maps","typescript"],"repository":{"type":"git","url":"git+https://github.com/ZiyaAkhundov/react-apple-mapkit.git"},"description":"A lightweight React wrapper for Apple MapKit JS with an easy-to-use API.","maintainers":[{"name":"programmersschool","email":"programmersschoolaz@gmail.com"}],"readme":"# **MapKit React Integration**\r\nA comprehensive library to seamlessly integrate **Apple MapKit JS** with **React**. This library provides TypeScript support and rich configuration options for maps, markers, and annotations.\r\n\r\n---\r\n\r\n## **Table of Contents**\r\n1. [Installation](#installation)\r\n2. [Getting Started](#getting-started)\r\n3. [Configuration](#configuration)\r\n - [Map Configuration](#map-configuration)\r\n - [Marker Configuration](#marker-configuration)\r\n - [Annotation Configuration](#annotation-configuration)\r\n4. [Event Handling](#event-handling)\r\n5. [Examples](#examples)\r\n6. [API Reference](#api-reference)\r\n7. [License](#license)\r\n\r\n---\r\n\r\n## **1. Installation**\r\nInstall the package using npm or yarn:\r\n\r\n```bash\r\nnpm install react-apple-mapkit\r\n```\r\n\r\nor\r\n\r\n```bash\r\nyarn add react-apple-mapkit\r\n```\r\n\r\n---\r\n\r\n## **2. Getting Started**\r\n\r\n### **Initialization**\r\nBefore using the map, you need to initialize MapKit with an authentication token.\r\n\r\n```tsx\r\nimport React from 'react';\r\nimport Map from 'react-apple-mapkit';\r\n\r\nconst App = () => {\r\n return (\r\n \r\n );\r\n};\r\n\r\nexport default App;\r\n```\r\n\r\n---\r\n\r\n## **3. Configuration**\r\n\r\n### **3.1 Map Configuration**\r\n| **Prop** | **Type** | **Default** | **Description** |\r\n|-----------------------------------|-------------------------------------|----------------------------------|---------------------------------------------------------------------------|\r\n| `token` | `string` | **Required** | MapKit JS API token. |\r\n| `mapType` | `standard`, `mutedStandard`, `hybrid`, `satellite` | `standard` | Map type. |\r\n| `distances` | `adaptive`, `metric`, `imperial` | `adaptive` | Distance measurement system. |\r\n| `showsCompass` | `FeatureVisibility` | `adaptive` | Compass visibility. |\r\n| `showsScale` | `FeatureVisibility` | `hidden` | Scale visibility. |\r\n| `cameraBoundary` | `CoordinateRegion` | `null` | Restrict map camera boundary. |\r\n| `cameraZoomRange` | `{ min: number, max: number }` | `{ min: 0, max: Infinity }` | Define zoom limits for the camera. |\r\n| `paddingTop`, `paddingRight`, `paddingBottom`, `paddingLeft` | `number` | `0` | Map padding. |\r\n| `onRegionChangeStart` | `(region: CoordinateRegion) => void`| `undefined` | Event triggered at region change start. |\r\n| `onRegionChangeEnd` | `(region: CoordinateRegion) => void`| `undefined` | Event triggered at region change end. |\r\n\r\n---\r\n\r\n### **3.2 Marker Configuration**\r\n| **Prop** | **Type** | **Default** | **Description** |\r\n|----------------------------------|---------------------------------------|--------------------------------|----------------------------------------------------------------------------|\r\n| `latitude` | `number` | **Required** | Marker latitude. |\r\n| `longitude` | `number` | **Required** | Marker longitude. |\r\n| `title` | `string` | `\"\"` | Marker title. |\r\n| `subtitle` | `string` | `\"\"` | Marker subtitle. |\r\n| `color` | `string` | `#fb0000` | Marker color. |\r\n| `glyphColor` | `string` | `#ffffff` | Glyph text color. |\r\n| `collisionMode` | `'Rectangle'` or `'Circle'` or `null` | `null` | Collision detection mode. |\r\n| `subtitleVisibility` | `FeatureVisibility` | `adaptive` | Subtitle visibility. |\r\n| `titleVisibility` | `FeatureVisibility` | `adaptive` | Title visibility. |\r\n\r\n---\r\n\r\n### **3.3 Annotation Configuration**\r\n| **Prop** | **Type** | **Default** | **Description** |\r\n|----------------------------------|--------------------------------------|---------------------------------|----------------------------------------------------------------------------|\r\n| `latitude` | `number` | **Required** | Annotation latitude. |\r\n| `longitude` | `number` | **Required** | Annotation longitude. |\r\n| `title` | `string` | `\"\"` | Annotation title. |\r\n| `subtitle` | `string` | `\"\"` | Annotation subtitle. |\r\n| `collisionMode` | `'Rectangle'` or `'Circle'` or `null`| `null` | Collision detection mode. |\r\n| `calloutElement` | `ReactNode` | `undefined` | Custom callout content. |\r\n| `calloutOffsetX`, `calloutOffsetY` | `number` | `0` | Callout offset adjustments. |\r\n\r\n---\r\n\r\n## **4. Event Handling**\r\nEvents can be easily attached to map and markers.\r\n\r\n### **Map Events**\r\n| **Event** | **Description** |\r\n|---------------------------------|----------------------------------------------------------------------------|\r\n| `onLoad` | Triggered when the map is loaded. |\r\n| `onRegionChangeStart` | Triggered at the start of region change. |\r\n| `onRegionChangeEnd` | Triggered at the end of region change. |\r\n| `onSingleTap` | Triggered on single tap. |\r\n\r\n### **Marker Events**\r\n| **Event** | **Description** |\r\n|---------------------------------|----------------------------------------------------------------------------|\r\n| `onSelect` | Triggered when a marker is selected. |\r\n| `onDeselect` | Triggered when a marker is deselected. |\r\n| `onDragStart` | Triggered when dragging starts. |\r\n| `onDragEnd` | Triggered when dragging ends. |\r\n\r\n---\r\n\r\n## **5. Examples**\r\n\r\n### **Basic Map**\r\n```tsx\r\nimport React from 'react';\r\nimport Map from 'react-apple-mapkit';\r\n\r\nconst App = () => (\r\n \r\n);\r\n\r\nexport default App;\r\n```\r\n\r\n### **Map with Marker**\r\n```tsx\r\nimport React from 'react';\r\nimport Map from 'react-apple-mapkit';\r\nimport Marker from 'react-apple-mapkit/Marker';\r\n\r\nconst App = () => (\r\n \r\n);\r\n\r\nexport default App;\r\n```\r\n\r\n---\r\n\r\n## **6. API Reference**\r\n\r\n### **Coordinate**\r\nRepresents a point on the Earth’s surface.\r\n```ts\r\ninterface Coordinate {\r\n latitude: number;\r\n longitude: number;\r\n}\r\n```\r\n\r\n### **CoordinateRegion**\r\nRepresents a geographic region.\r\n```ts\r\ninterface CoordinateRegion {\r\n centerLatitude: number;\r\n centerLongitude: number;\r\n latitudeDelta: number;\r\n longitudeDelta: number;\r\n}\r\n```\r\n\r\n---\r\n\r\n## **7. License**\r\nThis project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.\r\n\r\n---\r\n\r\nFor more detailed information, visit the [official documentation](https://developer.apple.com/documentation/mapkitjs). 🎉","readmeFilename":"README.md"}