@maplibre/maplibre-react-native 10.0.0-alpha.24 → 10.0.0-alpha.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (173) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/CONTRIBUTING.md +1 -1
  3. package/android/build.gradle +51 -16
  4. package/docs/Annotation.md +8 -17
  5. package/docs/BackgroundLayer.md +136 -128
  6. package/docs/Callout.md +5 -4
  7. package/docs/Camera.md +38 -39
  8. package/docs/CircleLayer.md +413 -388
  9. package/docs/FillExtrusionLayer.md +303 -292
  10. package/docs/FillLayer.md +266 -251
  11. package/docs/HeadingIndicator.md +5 -4
  12. package/docs/HeatmapLayer.md +179 -172
  13. package/docs/ImageSource.md +5 -4
  14. package/docs/Images.md +5 -4
  15. package/docs/Light.md +131 -123
  16. package/docs/LineLayer.md +525 -498
  17. package/docs/MapView.md +23 -42
  18. package/docs/MarkerView.md +5 -4
  19. package/docs/NativeUserLocation.md +5 -4
  20. package/docs/PointAnnotation.md +7 -10
  21. package/docs/RasterLayer.md +318 -310
  22. package/docs/RasterSource.md +5 -4
  23. package/docs/ShapeSource.md +16 -15
  24. package/docs/Style.md +5 -4
  25. package/docs/SymbolLayer.md +1501 -1406
  26. package/docs/UserLocation.md +10 -13
  27. package/docs/VectorSource.md +10 -9
  28. package/docs/coordinates.md +4 -3
  29. package/docs/docs.json +49 -88
  30. package/docs/location.md +4 -3
  31. package/docs/offlineManager.md +29 -44
  32. package/docs/snapshotManager.md +7 -6
  33. package/ios/RCTMLN/RCTMLNCamera.h +0 -3
  34. package/ios/RCTMLN/RCTMLNCamera.m +1 -1
  35. package/ios/RCTMLN/RCTMLNCameraManager.m +0 -3
  36. package/javascript/MLNModule.ts +9 -0
  37. package/javascript/Maplibre.ts +1 -1
  38. package/javascript/components/{annotations/Annotation.tsx → Annotation.tsx} +5 -5
  39. package/javascript/components/Camera.tsx +257 -388
  40. package/javascript/components/UserLocation.tsx +1 -1
  41. package/javascript/hooks/useNativeRef.ts +2 -1
  42. package/javascript/types/CameraMode.ts +6 -0
  43. package/package.json +16 -24
  44. package/scripts/codegen.ts +340 -0
  45. package/scripts/templates/MaplibreStyles.ts.ejs +8 -7
  46. package/scripts/templates/RCTMLNStyle.h.ejs +4 -3
  47. package/scripts/templates/RCTMLNStyle.m.ejs +11 -10
  48. package/scripts/templates/RCTMLNStyleFactory.java.ejs +12 -11
  49. package/scripts/templates/component.md.ejs +88 -85
  50. package/scripts/templates/index.d.ts.ejs +2 -1
  51. package/scripts/templates/styleMap.ts.ejs +2 -1
  52. package/scripts/utils/{DocJSONBuilder.js → DocJSONBuilder.ts} +133 -128
  53. package/scripts/utils/{JSDocNodeTree.js → JSDocNodeTree.ts} +14 -13
  54. package/scripts/utils/MarkdownBuilder.ts +44 -0
  55. package/scripts/utils/{template-globals.js → TemplateHelpers.ts} +66 -95
  56. package/scripts/utils/getNativeVersion.ts +53 -0
  57. package/tsconfig.json +2 -3
  58. package/.husky/pre-commit +0 -5
  59. package/android/rctmln/.settings/org.eclipse.buildship.core.prefs +0 -2
  60. package/android/rctmln/build.gradle +0 -64
  61. package/android/rctmln/proguard-rules.pro +0 -25
  62. package/docs/OfflineManager.md +0 -246
  63. package/react-native.config.js +0 -10
  64. package/scripts/download-style-spec.sh +0 -15
  65. package/scripts/generate-docs.js +0 -396
  66. package/scripts/utils/MarkdownBuilder.js +0 -37
  67. package/style-spec/v8.json +0 -6645
  68. /package/android/{rctmln/src → src}/main/AndroidManifest.xml +0 -0
  69. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/RCTMLNPackage.java +0 -0
  70. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/AbstractEvent.java +0 -0
  71. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/AbstractEventEmitter.java +0 -0
  72. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/AbstractMapFeature.java +0 -0
  73. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/annotation/MarkerView.java +0 -0
  74. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/annotation/MarkerViewManager.java +0 -0
  75. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/annotation/RCTMLNCallout.java +0 -0
  76. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/annotation/RCTMLNCalloutManager.java +0 -0
  77. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/annotation/RCTMLNMarkerView.java +0 -0
  78. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/annotation/RCTMLNMarkerViewManager.java +0 -0
  79. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/annotation/RCTMLNPointAnnotation.java +0 -0
  80. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/annotation/RCTMLNPointAnnotationManager.java +0 -0
  81. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/camera/CameraStop.java +0 -0
  82. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/camera/CameraUpdateItem.java +0 -0
  83. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/camera/CameraUpdateQueue.java +0 -0
  84. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/camera/RCTMLNCamera.java +0 -0
  85. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/camera/RCTMLNCameraManager.java +0 -0
  86. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/camera/constants/CameraMode.java +0 -0
  87. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/images/RCTMLNImages.java +0 -0
  88. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/images/RCTMLNImagesManager.java +0 -0
  89. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/location/LocationComponentManager.java +0 -0
  90. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/location/RCTMLNNativeUserLocation.java +0 -0
  91. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/location/RCTMLNNativeUserLocationManager.java +0 -0
  92. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/mapview/LayerSourceInfo.java +0 -0
  93. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/mapview/RCTMLNAndroidTextureMapView.java +0 -0
  94. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/mapview/RCTMLNAndroidTextureMapViewManager.java +0 -0
  95. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/mapview/RCTMLNMapView.java +0 -0
  96. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/mapview/RCTMLNMapViewManager.java +0 -0
  97. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/mapview/helpers/CameraChangeTracker.java +0 -0
  98. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/RCTMLNStyle.java +0 -0
  99. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/RCTMLNStyleFactory.java +0 -0
  100. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/RCTMLNStyleFunctionParser.java +0 -0
  101. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/RCTMLNStyleValue.java +0 -0
  102. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTLayer.java +0 -0
  103. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNBackgroundLayer.java +0 -0
  104. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNBackgroundLayerManager.java +0 -0
  105. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNCircleLayer.java +0 -0
  106. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNCircleLayerManager.java +0 -0
  107. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNFillExtrusionLayer.java +0 -0
  108. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNFillExtrusionLayerManager.java +0 -0
  109. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNFillLayer.java +0 -0
  110. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNFillLayerManager.java +0 -0
  111. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNHeatmapLayer.java +0 -0
  112. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNHeatmapLayerManager.java +0 -0
  113. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNLineLayer.java +0 -0
  114. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNLineLayerManager.java +0 -0
  115. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNRasterLayer.java +0 -0
  116. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNRasterLayerManager.java +0 -0
  117. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNSymbolLayer.java +0 -0
  118. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNSymbolLayerManager.java +0 -0
  119. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/light/RCTMLNLight.java +0 -0
  120. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/light/RCTMLNLightManager.java +0 -0
  121. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNImageSource.java +0 -0
  122. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNImageSourceManager.java +0 -0
  123. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNRasterSource.java +0 -0
  124. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNRasterSourceManager.java +0 -0
  125. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNShapeSource.java +0 -0
  126. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNShapeSourceManager.java +0 -0
  127. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNTileSource.java +0 -0
  128. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNTileSourceManager.java +0 -0
  129. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNVectorSource.java +0 -0
  130. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNVectorSourceManager.java +0 -0
  131. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTSource.java +0 -0
  132. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/AbstractEvent.java +0 -0
  133. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/AndroidCallbackEvent.java +0 -0
  134. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/EventEmitter.java +0 -0
  135. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/FeatureClickEvent.java +0 -0
  136. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/IEvent.java +0 -0
  137. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/ImageMissingEvent.java +0 -0
  138. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/LocationEvent.java +0 -0
  139. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/MapChangeEvent.java +0 -0
  140. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/MapClickEvent.java +0 -0
  141. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/MapUserTrackingModeEvent.java +0 -0
  142. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/OfflineEvent.java +0 -0
  143. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/PointAnnotationClickEvent.java +0 -0
  144. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/PointAnnotationDragEvent.java +0 -0
  145. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/constants/EventKeys.java +0 -0
  146. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/constants/EventTypes.java +0 -0
  147. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/http/CustomHeadersInterceptor.java +0 -0
  148. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/location/LocationManager.java +0 -0
  149. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/location/UserLocation.java +0 -0
  150. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/location/UserLocationVerticalAlignment.java +0 -0
  151. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/location/UserTrackingMode.java +0 -0
  152. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/location/UserTrackingState.java +0 -0
  153. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/modules/RCTMLNLocationModule.java +0 -0
  154. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/modules/RCTMLNLogging.java +0 -0
  155. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/modules/RCTMLNModule.java +0 -0
  156. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/modules/RCTMLNOfflineModule.java +0 -0
  157. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/modules/RCTMLNSnapshotModule.java +0 -0
  158. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/BitmapUtils.java +0 -0
  159. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/ClusterPropertyEntry.java +0 -0
  160. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/ConvertUtils.java +0 -0
  161. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/DownloadMapImageTask.java +0 -0
  162. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/ExpressionParser.java +0 -0
  163. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/GeoJSONUtils.java +0 -0
  164. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/GeoViewport.java +0 -0
  165. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/ImageEntry.java +0 -0
  166. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/ResourceUtils.java +0 -0
  167. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/SimpleEventCallback.java +0 -0
  168. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/SphericalMercator.java +0 -0
  169. /package/android/{rctmln/src → src}/main/res/drawable/empty.xml +0 -0
  170. /package/android/{rctmln/src → src}/main/res/drawable/empty_drawable.png +0 -0
  171. /package/android/{rctmln/src → src}/main/res/drawable-xxhdpi/red_marker.png +0 -0
  172. /package/android/{rctmln/src → src}/main/res/layout/annotation.xml +0 -0
  173. /package/android/{rctmln/src → src}/main/res/values/strings.xml +0 -0
@@ -1,5 +1,6 @@
1
1
  <%
2
2
  const layers = locals.layers;
3
+ const helpers = locals.helpers;
3
4
  -%>
4
5
  // DO NOT MODIFY
5
6
  // THIS FILE IS AUTOGENERATED
@@ -29,7 +30,7 @@ public class RCTMLNStyleFactory {
29
30
  public static final String SHOULD_ADD_IMAGE_KEY = "shouldAddImage";
30
31
 
31
32
  <%_ for (const layer of layers) { _%>
32
- public static void <%- setLayerMethodName(layer) -%>(final <%- getLayerType(layer, 'android') -%> layer, RCTMLNStyle style) {
33
+ public static void <%- helpers.setLayerMethodName(layer) -%>(final <%- helpers.getLayerType(layer, 'android') -%> layer, RCTMLNStyle style) {
33
34
  List<String> styleKeys = style.getAllStyleKeys();
34
35
 
35
36
  if (styleKeys.size() == 0) {
@@ -46,16 +47,16 @@ public class RCTMLNStyleFactory {
46
47
  style.addImage(styleValue, new DownloadMapImageTask.OnAllImagesLoaded() {
47
48
  @Override
48
49
  public void onAllImagesLoaded() {
49
- RCTMLNStyleFactory.set<%- pascalCase(prop.name) -%>(layer, styleValue);
50
+ RCTMLNStyleFactory.set<%- helpers.pascalCase(prop.name) -%>(layer, styleValue);
50
51
  }
51
52
  });
52
53
  <%_ } else { _%>
53
- RCTMLNStyleFactory.set<%- pascalCase(prop.name) -%>(layer, styleValue);
54
+ RCTMLNStyleFactory.set<%- helpers.pascalCase(prop.name) -%>(layer, styleValue);
54
55
  <%_ } _%>
55
56
  break;
56
57
  <%_ if (prop.transition) { _%>
57
58
  case "<%= prop.name %>Transition":
58
- RCTMLNStyleFactory.set<%- pascalCase(prop.name) -%>Transition(layer, styleValue);
59
+ RCTMLNStyleFactory.set<%- helpers.pascalCase(prop.name) -%>Transition(layer, styleValue);
59
60
  break;
60
61
  <%_ } _%>
61
62
  <%_ } _%>
@@ -66,12 +67,12 @@ public class RCTMLNStyleFactory {
66
67
 
67
68
  <%_ for (const layer of layers) { _%>
68
69
  <%_ for (const prop of layer.properties) { _%>
69
- public static void set<%- pascalCase(prop.name) -%>(<%- getLayerType(layer, 'android') -%> layer, RCTMLNStyleValue styleValue) {
70
+ public static void set<%- helpers.pascalCase(prop.name) -%>(<%- helpers.getLayerType(layer, 'android') -%> layer, RCTMLNStyleValue styleValue) {
70
71
  <%_ if (layer.name === 'light' && prop.name === 'position') { _%>
71
72
  Float[] values = styleValue.getFloatArray(VALUE_KEY);
72
- layer.set<%- pascalCase(prop.name) -%>(Position.fromPosition(values[0], values[1], values[2]));
73
+ layer.set<%- helpers.pascalCase(prop.name) -%>(Position.fromPosition(values[0], values[1], values[2]));
73
74
  <%_ } else if (layer.name === 'light') { _%>
74
- layer.set<%- pascalCase(prop.name) -%>(<%- androidGetConfigType(androidInputType(prop.type, prop.value), prop) -%>);
75
+ layer.set<%- helpers.pascalCase(prop.name) -%>(<%- helpers.androidGetConfigType(helpers.androidInputType(prop.type, prop.value), prop) -%>);
75
76
  <%_ } else if (prop.name === 'visibility') { _%>
76
77
  layer.setProperties(PropertyFactory.visibility(styleValue.getString(VALUE_KEY)));
77
78
  <%_ } else if (prop.type === 'resolvedImage') { _%>
@@ -82,22 +83,22 @@ public class RCTMLNStyleFactory {
82
83
  layer.setProperties(PropertyFactory.<%= prop.name %>(styleValue.getExpression()));
83
84
  }
84
85
  } else {
85
- layer.setProperties(PropertyFactory.<%= prop.name %>(<%- androidGetConfigType(androidInputType(prop.type, prop.value), prop) -%>));
86
+ layer.setProperties(PropertyFactory.<%= prop.name %>(<%- helpers.androidGetConfigType(helpers.androidInputType(prop.type, prop.value), prop) -%>));
86
87
  }
87
88
  <%_ } else { _%>
88
89
  if (styleValue.isExpression()) {
89
90
  layer.setProperties(PropertyFactory.<%= prop.name %>(styleValue.getExpression()));
90
91
  } else {
91
- layer.setProperties(PropertyFactory.<%= prop.name %>(<%- androidGetConfigType(androidInputType(prop.type, prop.value), prop) -%>));
92
+ layer.setProperties(PropertyFactory.<%= prop.name %>(<%- helpers.androidGetConfigType(helpers.androidInputType(prop.type, prop.value), prop) -%>));
92
93
  }
93
94
  <%_ } _%>
94
95
  }
95
96
 
96
97
  <%_ if (prop.transition) { %>
97
- public static void set<%- pascalCase(prop.name) -%>Transition(<%- getLayerType(layer, 'android') -%> layer, RCTMLNStyleValue styleValue) {
98
+ public static void set<%- helpers.pascalCase(prop.name) -%>Transition(<%- helpers.getLayerType(layer, 'android') -%> layer, RCTMLNStyleValue styleValue) {
98
99
  TransitionOptions transition = styleValue.getTransition();
99
100
  if (transition != null) {
100
- layer.set<%- pascalCase(prop.name) -%>Transition(transition);
101
+ layer.set<%- helpers.pascalCase(prop.name) -%>Transition(transition);
101
102
  }
102
103
  }
103
104
 
@@ -1,122 +1,125 @@
1
1
  <%
2
2
  const component = locals.component;
3
+ const helpers = locals.helpers;
3
4
  -%>
4
- <!-- This file was autogenerated from <%- component.name %>.js do not modify -->
5
- ## <MapLibreGL.<%- component.name %> />
6
- ### <%- replaceNewLine(component.description) %>
5
+ <!-- DO NOT MODIFY! -->
6
+ <!-- This file is auto-generated from <%- component.filePath %> -->
7
+ # `<MapLibreGL.<%- component.name %> />`
8
+ <%- helpers.replaceNewLine(component.description) %>
7
9
 
8
10
  <%_ if (component.props && component.props.length) { _%>
9
- ### props
11
+ ## Props
10
12
  | Prop | Type | Default | Required | Description |
11
13
  | ---- | :--: | :-----: | :------: | :----------: |
12
- <%- propMarkdownTableRows(component) %>
14
+ <%- helpers.propMarkdownTableRows(component) %>
13
15
  <%_ } _%>
14
16
 
15
17
  <%_ if (component.methods && component.methods.length) { _%>
16
- ### methods
18
+ ## Methods
17
19
  <%_ for (let method of component.methods) { _%>
18
- #### <%- getMarkdownMethodSignature(method) %>
20
+ ### <%- helpers.getMarkdownMethodSignature(method) %>
19
21
 
20
- <%- replaceNewLine(method.description) %>
22
+ <%- helpers.replaceNewLine(method.description) %>
21
23
 
22
- ##### arguments
24
+ <%_ if (method.params && method.params.length) { _%>
25
+ #### Arguments
23
26
  | Name | Type | Required | Description |
24
27
  | ---- | :--: | :------: | :----------: |
25
- <%- methodMarkdownTableRow(method) %>
28
+ <%- helpers.methodMarkdownTableRow(method) %>
29
+ <%_ } _%>
26
30
 
27
- <%- getMarkdownMethodExamples(method) %>
31
+ <%- helpers.getMarkdownMethodExamples(method) %>
28
32
  <%_ } _%>
29
33
  <%_ } _%>
30
34
 
31
35
  <%_ if (component.styles && component.styles.length) { _%>
32
- ### styles
36
+ ## Styles
33
37
 
34
38
  <%_ for (let i = 0; i < component.styles.length; i++) { _%>
35
39
  <%
36
40
  const style = component.styles[i];
37
41
  -%>
38
- * <a href="#name<%- i > 0 ? '-' + i : '' -%>"><%- style.name %></a><br/>
42
+ * <a href="#name<%- i > 0 ? '-' + i : '' -%>">`<%- style.name %>`</a><br/>
39
43
  <%_ } _%>
40
44
 
41
45
  <%_ for (let style of component.styles) { _%>
42
- ___
43
46
 
44
- #### Name
45
- `<%- style.name %>`
47
+ ### `<%- style.name %>`
46
48
 
47
- #### Description
48
49
  <%- style.description %>
49
50
 
50
- #### Type
51
- `<%- style.type %>`
52
- <%_ if (exists(style.default)) { _%>
53
- #### Default Value
54
- `<%= getStyleDefaultValue(style) %>`
55
- <%_ } _%>
56
-
57
- <%_ if (style.type === 'enum') { _%>
58
- #### Supported Values
59
- <%_ for (var i = 0; i < style.values.length; i++) { _%>
60
- **<%- style.values[i].value %>** - <%- style.values[i].doc %><br />
61
- <%_ } _%>
62
-
63
- <%_ } _%>
64
- <%_ if (exists(style.units)) { _%>
65
- #### Units
66
- `<%- style.units %>`
67
-
68
- <%_ } _%>
69
- <%_ if (exists(style.minimum)) { _%>
70
- #### Minimum
71
- `<%- style.minimum %>`
72
-
73
- <%_ } _%>
74
-
75
- <%_ if (exists(style.maximum)) { _%>
76
- #### Maximum
77
- `<%- style.maximum %>`
78
-
79
- <%_ } _%>
80
- <%_ if (style.requires.length) { _%>
81
- #### Requires
82
- `<%- style.requires.join(', ') %>`
83
-
84
- <%_ } _%>
85
- <%_ if (style.disabledBy.length) { _%>
86
- #### Disabled By
87
- `<%- style.disabledBy.join(', ') %>`
88
-
89
- <%_ } _%>
90
- <%_ if (style.allowedFunctionTypes.length) { _%>
91
- #### Supported Style Functions
92
- `<%- style.allowedFunctionTypes.join(', ') %>`
93
- <%_ } _%>
94
- <%_ if (style.expression) { _%>
95
- #### Expression
51
+ <dl>
52
+ <dt>Type</dt>
53
+ <dd>
54
+ <code><%- style.type %></code>
55
+ </dd>
56
+ <%_ if (helpers.exists(style.default)) { _%>
57
+ <dt>Default Value</dt>
58
+ <dd><code><%= helpers.getStyleDefaultValue(style) %></code></dd>
59
+ <%_ } _%>
60
+ <%_ if (style.type === 'enum') { _%>
61
+ <dt>Supported Values</dt>
62
+ <dd>
63
+ <ul>
64
+ <%_ for (var i = 0; i < style.values.length; i++) { _%>
65
+ <li>
66
+ <code><%- style.values[i].value %></code>: <%- style.values[i].doc %>
67
+ </li>
68
+ <%_ } _%>
69
+ <%_ } _%>
70
+ </ul>
71
+ </dd>
72
+ <%_ if (helpers.exists(style.units)) { _%>
73
+ <dt>Units</dt>
74
+ <dd><code><%- style.units %></code></dd>
75
+ <%_ } _%>
76
+ <%_ if (helpers.exists(style.minimum)) { _%>
77
+ <dt>Minimum</dt>
78
+ <dd><code><%- style.minimum %></code></dd>
79
+ <%_ } _%>
80
+ <%_ if (helpers.exists(style.maximum)) { _%>
81
+ <dt>Maximum</dt>
82
+ <dd><code><%- style.maximum %></code></dd>
83
+ <%_ } _%>
84
+ <%_ if (style.requires.length) { _%>
85
+ <dt>Requires</dt>
86
+ <dd><code><%- style.requires.join(', ') %></code></dd>
87
+ <%_ } _%>
88
+ <%_ if (style.disabledBy.length) { _%>
89
+ <dt>Disabled By</dt>
90
+ <dd><code><%- style.disabledBy.join(', ') %></code></dd>
91
+ <%_ } _%>
92
+ <%_ if (style.allowedFunctionTypes.length) { _%>
93
+ <dt>Supported Style Functions</dt>
94
+ <dd><code><%- style.allowedFunctionTypes.join(', ') %></code></dd>
95
+ <%_ } _%>
96
+ <%_ if (style.expression) { _%>
97
+ <dt>Expression Parameters</dt>
98
+ <dd><code><%- (style.expression.parameters || []).join(', ') %></code></dd>
99
+ <%_ } _%>
100
+ </dl>
96
101
 
97
- Parameters: `<%- (style.expression.parameters || []).join(', ') %>`
98
- <%_ } _%>
99
102
  <%_ if (style.transition) { _%>
100
- ___
101
-
102
- #### Name
103
-
104
- `<%- style.name %>Transition`
105
-
106
- #### Description
107
-
108
- The transition affecting any changes to this layer’s <%- style.name %> propery.
109
-
110
- #### Type
111
-
112
- `{ duration, delay }`
113
-
114
- #### Units
115
- `milliseconds`
116
-
117
- #### Default Value
118
- `{duration: 300, delay: 0}`
119
-
103
+ ### `<%- style.name %>Transition`
104
+
105
+ The transition affecting any changes to this layer’s <%- style.name %> property.
106
+
107
+ <dl>
108
+ <dt>Type</dt>
109
+ <dd>
110
+ <code>{ duration, delay }</code>
111
+ </dd>
112
+
113
+ <dt>Units</dt>
114
+ <dd>
115
+ <code>milliseconds</code>
116
+ </dd>
117
+
118
+ <dt>Default Value</dt>
119
+ <dd>
120
+ <code>{duration: 300, delay: 0}</code>
121
+ </dd>
122
+ </dl>
120
123
  <%_ } %>
121
124
  <%_ } _%>
122
125
  <%_ } _%>
@@ -1,5 +1,6 @@
1
1
  <%
2
2
  const layers = locals.layers;
3
+ const helpers = locals.helpers;
3
4
  -%>
4
5
  // DO NOT MODIFY
5
6
  // THIS FILE IS AUTOGENERATED
@@ -20,7 +21,7 @@ const styleMap = {
20
21
  <%_ for (let layer of layers) { _%>
21
22
  <%_ for (let prop of layer.properties) { _%>
22
23
  <%_ if (!['color', 'colorTransition', 'visibility'].includes(prop.name)) { _%>
23
- <%= prop.name %>: <%- jsStyleType(prop) %>,
24
+ <%= prop.name %>: <%- helpers.jsStyleType(prop) %>,
24
25
  <%_ if (prop.transition) { _%>
25
26
  <%= prop.name %>Transition: StyleTypes.Transition,
26
27
  <%_ } _%>
@@ -1,5 +1,6 @@
1
1
  <%
2
2
  const layers = locals.layers;
3
+ const helpers = locals.helpers;
3
4
  -%>
4
5
  /* eslint-disable */
5
6
  // DO NOT MODIFY
@@ -33,7 +34,7 @@ const styleMap = {
33
34
  <%_ for (let layer of layers) { _%>
34
35
  <%_ for (let prop of layer.properties) { _%>
35
36
  <%_ if (prop.name !== 'visibility') { _%>
36
- <%= prop.name %>: <%- jsStyleType(prop) %>,
37
+ <%= prop.name %>: <%- helpers.jsStyleType(prop) %>,
37
38
  <%_ if (prop.transition) { _%>
38
39
  <%= prop.name %>Transition: StyleTypes.Transition,
39
40
  <%_ } _%>