mapbox-gl-controls - npm Package Compare versions

Comparing version 2.0.0 to 2.1.0

lib/Base/Base.d.ts

@@ -12,5 +12,5 @@ import { Map } from 'mapbox-gl';
     onRemoveControl(): void;
-    private onAdd;
-    private onRemove;
+    onAdd(map: Map): HTMLDivElement;
+    onRemove(): void;
 }
 export default Base;

lib/CompassControl/CompassControl.d.ts

@@ -7,5 +7,2 @@ import Base from '../Base/Base';
 }
-/**
- * Compass control
- */
 export default class CompassControl extends Base {
@@ -12,0 +9,0 @@ button: Button;

lib/CompassControl/CompassControl.js

 import iconPointer from '../icons/pointer';
 import Base from '../Base/Base';
 import Button from '../Button/Button';
-/**
- * Compass control
- */
 export default class CompassControl extends Base {
@@ -8,0 +5,0 @@ constructor(options) {

lib/InspectControl/InspectControl.d.ts

 import { LngLat, MapboxGeoJSONFeature, MapMouseEvent } from 'mapbox-gl';
 import Base from '../Base/Base';
 import Button from '../Button/Button';
-/**
- * Inspect control to debug style layers and source
- */
 export default class InspectControl extends Base {
@@ -8,0 +5,0 @@ popupNode: HTMLDivElement;

lib/InspectControl/InspectControl.js

@@ -5,5 +5,2 @@ import Base from '../Base/Base';
 import iconInspect from '../icons/inspect';
-/**
- * Inspect control to debug style layers and source
- */
 export default class InspectControl extends Base {
@@ -10,0 +7,0 @@ constructor() {

lib/LanguageControl/LanguageControl.d.ts

@@ -12,5 +12,2 @@ import Base from '../Base/Base';
 }
-/**
- * Localize map. Language can be set dynamically with `.setLanguage(lang)` method.
- */
 export default class LanguageControl extends Base {
@@ -17,0 +14,0 @@ supportedLanguages: string[];

lib/LanguageControl/LanguageControl.js

@@ -5,5 +5,2 @@ import getLanguageField from './getLanguageField';
 const SUPPORTED_LANGUAGES = ['en', 'es', 'fr', 'de', 'ru', 'zh', 'pt', 'ar', 'ja', 'ko', 'mul'];
-/**
- * Localize map. Language can be set dynamically with `.setLanguage(lang)` method.
- */
 export default class LanguageControl extends Base {
@@ -10,0 +7,0 @@ constructor(options) {

lib/RulerControl/RulerControl.d.ts

@@ -30,5 +30,2 @@ import { Marker } from 'mapbox-gl';
 }
-/**
- * Fires map `ruler.on` and `ruler.off`events at the beginning and at the end of measuring.
- */
 export default class RulerControl extends Base {
@@ -35,0 +32,0 @@ isMeasuring: boolean;

lib/RulerControl/RulerControl.js

@@ -15,5 +15,2 @@ import mapboxgl from 'mapbox-gl';
 const HALO_COLOR = '#fff';
-/**
- * Fires map `ruler.on` and `ruler.off`events at the beginning and at the end of measuring.
- */
 export default class RulerControl extends Base {
@@ -20,0 +17,0 @@ constructor(options) {

lib/StylesControl/StylesControl.d.ts

@@ -10,3 +10,2 @@ import Base from '../Base/Base';
 }
-/** Adds style switcher similar to Google Maps. */
 export default class StylesControl extends Base {
@@ -13,0 +12,0 @@ styles: StyleOption[];

lib/StylesControl/StylesControl.js

 import Base from '../Base/Base';
 import { defaultStyleOptions } from './StyleOption';
 import Button from '../Button/Button';
-/** Adds style switcher similar to Google Maps. */
 export default class StylesControl extends Base {
@@ -6,0 +5,0 @@ constructor(options) {

lib/TooltipControl/TooltipControl.d.ts

@@ -9,5 +9,2 @@ import { LngLat, MapLayerEventType, MapMouseEvent } from 'mapbox-gl';
 }
-/**
- * Shows tooltip on hover on some layer or whole map.
- */
 export default class TooltipControl extends Base {
@@ -14,0 +11,0 @@ layer: string;

lib/TooltipControl/TooltipControl.js

 import Base from '../Base/Base';
-/**
- * Shows tooltip on hover on some layer or whole map.
- */
 export default class TooltipControl extends Base {
@@ -6,0 +3,0 @@ constructor(options) {

lib/ZoomControl/ZoomControl.d.ts

 import Base from '../Base/Base';
 import Button from '../Button/Button';
-/**
- * Zoom control
- */
 export default class ZoomControl extends Base {
@@ -7,0 +4,0 @@ zoomIn: Button;

lib/ZoomControl/ZoomControl.js

@@ -5,5 +5,2 @@ import Base from '../Base/Base';
 import iconMinus from '../icons/minus';
-/**
- * Zoom control
- */
 export default class ZoomControl extends Base {
@@ -10,0 +7,0 @@ constructor() {

package.json

 {
   "name": "mapbox-gl-controls",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "main": "./lib/index.js",
@@ -10,3 +10,3 @@ "description": "Controls for mapbox-gl",
     "build": "tsc && sass src/index.scss:lib/controls.css",
-    "docs": "rollup --config docs/rollup.config.js"
+    "docs": "cp lib/controls.css docs && rollup --config docs/rollup.config.js"
   },
@@ -35,3 +35,4 @@ "devDependencies": {
   "repository": "bravecow/mapbox-gl-controls",
+  "keywords": ["mapbox"],
   "license": "MIT"
 }

README.md

@@ -31,2 +31,4 @@ # Mapbox Controls
 
+Adds style switcher similar to Google Maps.
+
 ```javascript
@@ -73,2 +75,4 @@ import { StylesControl } from 'mapbox-gl-controls';
 
+Localize map. Language can be set dynamically with `.setLanguage(lang)` method.
+
 ```javascript
@@ -92,2 +96,6 @@ import { LanguageControl } from 'mapbox-gl-controls';
 
+Inspect control to debug style layers and source
+
+![Inspect Control](./docs/inspect.png)
+
 ```javascript
@@ -101,6 +109,17 @@ import { InspectControl } from 'mapbox-gl-controls';
 
+Shows tooltip on hover on some layer or whole map.
+
+![Tooltip Control](./docs/tooltip.png)
+
 ```javascript
 import { TooltipControl } from 'mapbox-gl-controls';
 
+map.addLayer({
+  id: '$fill',
+  type: 'fill',
+  source: { type: 'geojson', data: polygon },
+  paint: { 'fill-opacity': 0.3, 'fill-color': '#4264fb' },
+});
+
 map.addControl(new TooltipControl({ layer: '$fill' }));
 ```

src/Base/Base.ts

@@ -34,3 +34,3 @@ import { Map } from 'mapbox-gl';
 
-  private onAdd(map: Map) {
+  onAdd(map: Map) {
     this.map = map;
@@ -41,3 +41,3 @@ this.onAddControl();
 
-  private onRemove() {
+  onRemove() {
     this.onRemoveControl();
@@ -44,0 +44,0 @@ this.node.parentNode.removeChild(this.node);

src/CompassControl/CompassControl.ts

@@ -10,5 +10,2 @@ import iconPointer from '../icons/pointer';
 
-/**
- * Compass control
- */
 export default class CompassControl extends Base {
@@ -15,0 +12,0 @@ button: Button

src/InspectControl/InspectControl.ts

@@ -7,5 +7,2 @@ import { LngLat, MapboxGeoJSONFeature, MapMouseEvent, PointLike } from 'mapbox-gl';
 
-/**
- * Inspect control to debug style layers and source
- */
 export default class InspectControl extends Base {
@@ -12,0 +9,0 @@ popupNode: HTMLDivElement

src/LanguageControl/LanguageControl.ts

@@ -18,5 +18,2 @@ import getLanguageField from './getLanguageField';
 
-/**
- * Localize map. Language can be set dynamically with `.setLanguage(lang)` method.
- */
 export default class LanguageControl extends Base {
@@ -23,0 +20,0 @@ supportedLanguages: string[]

src/RulerControl/RulerControl.ts

@@ -44,5 +44,2 @@ import mapboxgl, { GeoJSONSource, Marker } from 'mapbox-gl';
 
-/**
- * Fires map `ruler.on` and `ruler.off`events at the beginning and at the end of measuring.
- */
 export default class RulerControl extends Base {
@@ -49,0 +46,0 @@ isMeasuring: boolean

src/StylesControl/StylesControl.ts

@@ -12,3 +12,2 @@ import Base from '../Base/Base';
 
-/** Adds style switcher similar to Google Maps. */
 export default class StylesControl extends Base {
@@ -15,0 +14,0 @@ styles: StyleOption[]

src/TooltipControl/TooltipControl.ts

@@ -11,5 +11,2 @@ import { LngLat, MapLayerEventType, MapMouseEvent } from 'mapbox-gl';
 
-/**
- * Shows tooltip on hover on some layer or whole map.
- */
 export default class TooltipControl extends Base {
@@ -16,0 +13,0 @@ layer: string

src/ZoomControl/ZoomControl.ts

@@ -6,5 +6,2 @@ import Base from '../Base/Base';
 
-/**
- * Zoom control
- */
 export default class ZoomControl extends Base {
@@ -11,0 +8,0 @@ zoomIn: Button

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

122

increased by18.45%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

108811

decreased by-7.23%

Number of package files

109

decreased by-0.91%

Lines of code

1962

decreased by-12.37%

No dependency changes