Skip to content

Commit

Permalink
docs: improve markdown, and setup instructions
Browse files Browse the repository at this point in the history
* docs: improve markdown, and setup instructions

Fixes rnmapbox#2168
  • Loading branch information
KiwiKilian authored Sep 9, 2022
1 parent 3e247f1 commit 561e33f
Show file tree
Hide file tree
Showing 49 changed files with 1,749 additions and 1,902 deletions.
2 changes: 1 addition & 1 deletion README-v10.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ code ios/Podfile
pod 'React-Core', :path => '../node_modules/react-native/React', modular_headers: true
```

IOS:
iOS:

* Add `$(SDKROOT)/usr/lib/swift` to Library search paths.

20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,17 +91,25 @@ _See [iOS](ios/install.md) & [Android](android/install.md) setup guide for more

### Step 1 - Install Package:

#### Using `yarn`
Install the latest source from git:
```sh
# install with Yarn
# yarn add @rnmapbox/maps
yarn add rnmapbox/maps#main
```

#### Using `npm`
Install the latest source from git:
```sh
npm install --save rnmapbox/maps#main
```

# or install with NPM
# npm install @rnmapbox/maps --save
npm install rnmapbox/maps#main --save
#### Installing other versions
Replace `rnmapbox/maps#main` with the following to install other versions:
- `@rnmapbox/maps` installs the latest release

```

#### Using `expo`
Please follow the [Expo Guide](/plugin/install.md).

### Step 2 - Installation Guides:

Expand Down
16 changes: 8 additions & 8 deletions docs/Annotation.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- This file was autogenerated from Annotation.js do not modify -->
## <MapboxGL.Annotation />
###
# <MapboxGL.Annotation />

### props

## props
| Prop | Type | Default | Required | Description |
| ---- | :--: | :-----: | :------: | :----------: |
| id | `string` | `none` | `true` | FIX ME NO DESCRIPTION |
Expand All @@ -15,22 +15,22 @@
| style | `any` | `none` | `false` | FIX ME NO DESCRIPTION |
| icon | `union` | `none` | `false` | FIX ME NO DESCRIPTION |

### methods
#### onPress()
## methods
### onPress()



##### arguments
#### arguments
| Name | Type | Required | Description |
| ---- | :--: | :------: | :----------: |



#### symbolStyle()
### symbolStyle()



##### arguments
#### arguments
| Name | Type | Required | Description |
| ---- | :--: | :------: | :----------: |

Expand Down
26 changes: 14 additions & 12 deletions docs/Annotations.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
Comparsion of various annotations available in React native mapbox:
# Annotations Comparison

|*Feature* | *SymbolLayer* |*PointAnnotation* |*MarkerView* |*CircleLayer* |
|-----------------------|--------------------|--------------------------------------|-------------------------|---------------------|
|Can use images | &check; | | | |
|RN Views as childern | iOS: static |iOS: interactive <br/> android: static|interactive | |
|Interactions | click |iOS: full <br/> android: click & drag & callout | supports full interactivity in the sense that inside MarkerViews one can place any RN View, which can be interacted with. Not to be misunderstood with drag n drop interactivity. | click |
|Control Z-index | &check; |iOS: always on top, android: n/a |always on top | &check; |
|Clustering | &check; | | | &check; |
|Style with expressions | &check; | | | &check; |
|iOS implementation | [MGLStyleSymbolLayer](https://docs.mapbox.com/ios/api/maps/5.8.0/Classes/MGLSymbolStyleLayer.html) |[MGLAnnotationView](https://docs.mapbox.com/ios/api/maps/5.8.0/Classes/MGLAnnotationView.html) |[MGLAnnotationView](https://docs.mapbox.com/ios/api/maps/5.8.0/Classes/MGLAnnotationView.html) |[MGLCircleStyleLayer](https://docs.mapbox.com/ios/api/maps/5.8.0/Classes/MGLCircleStyleLayer.html) |
|android implementation | [SymbolLayer](https://docs.mapbox.com/android/api/map-sdk/9.0.0/com/mapbox/mapboxsdk/style/layers/SymbolLayer.html)|[annotation.Symbol](https://docs.mapbox.com/android/api/plugins/annotation/0.8.0/com/mapbox/mapboxsdk/plugins/annotation/Symbol.html)|[annotation.Marker](https://docs.mapbox.com/android/api/plugins/markerview/0.4.0/com/mapbox/mapboxsdk/plugins/markerview/MarkerView.html) |[CircleLayer](https://docs.mapbox.com/android/api/map-sdk/9.0.0/com/mapbox/mapboxsdk/style/layers/CircleLayer.html)|
Comparsion of various annotations available in React native mapbox:

| *Feature* | *SymbolLayer* | *PointAnnotation* |*MarkerView* |*CircleLayer* |
|------------------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------|-------------------------|---------------------|
| Can use images | &check; | | | |
| RN Views as children | iOS: static | iOS: interactive <br/> Android: static |interactive | |
| Interactions | click | iOS: full <br/> Android: click & drag & callout | supports full interactivity in the sense that inside MarkerViews one can place any RN View, which can be interacted with. Not to be misunderstood with drag n drop interactivity. | click |
| Control Z-index | &check; | iOS: always on top, Android: n/a |always on top | &check; |
| Clustering | &check; | | | &check; |
| Style with expressions | &check; | | | &check; |
| iOS implementation | [MGLStyleSymbolLayer](https://docs.mapbox.com/ios/api/maps/5.8.0/Classes/MGLSymbolStyleLayer.html) | [MGLAnnotationView](https://docs.mapbox.com/ios/api/maps/5.8.0/Classes/MGLAnnotationView.html) |[MGLAnnotationView](https://docs.mapbox.com/ios/api/maps/5.8.0/Classes/MGLAnnotationView.html) |[MGLCircleStyleLayer](https://docs.mapbox.com/ios/api/maps/5.8.0/Classes/MGLCircleStyleLayer.html) |
| Android implementation | [SymbolLayer](https://docs.mapbox.com/android/api/map-sdk/9.0.0/com/mapbox/mapboxsdk/style/layers/SymbolLayer.html)| [annotation.Symbol](https://docs.mapbox.com/android/api/plugins/annotation/0.8.0/com/mapbox/mapboxsdk/plugins/annotation/Symbol.html) |[annotation.Marker](https://docs.mapbox.com/android/api/plugins/markerview/0.4.0/com/mapbox/mapboxsdk/plugins/markerview/MarkerView.html) |[CircleLayer](https://docs.mapbox.com/android/api/map-sdk/9.0.0/com/mapbox/mapboxsdk/style/layers/CircleLayer.html)|

Related links:

* iOS [markers and annotations](https://docs.mapbox.com/ios/maps/overview/markers-and-annotations/)
* android [annotation plugin](https://docs.mapbox.com/android/plugins/overview/annotation/)
* Android [annotation plugin](https://docs.mapbox.com/android/plugins/overview/annotation/)
Loading

0 comments on commit 561e33f

Please sign in to comment.