Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix some minor errors #258

Merged
merged 2 commits into from
Jan 2, 2024
Merged

docs: fix some minor errors #258

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d8403c
docs: fix some minor errors
meteorlxy Jul 14, 2023
955a219
Merge branch 'master' into docs/tweaks
tschoffelen Jan 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,15 +230,15 @@ showLocation({
cancelText: 'This is the cancel button text', // optional (default: 'Cancel')
appsWhiteList: ['google-maps'], // optionally you can set which apps to show (default: will show all supported apps installed on device)
naverCallerName: 'com.example.myapp', // to link into Naver Map You should provide your appname which is the bundle ID in iOS and applicationId in android.
// appTitles: { 'google-maps': 'My custom Google Maps title' }, // optionally you can override default app titles
// app: 'uber', // optionally specify specific app to use
appTitles: { 'google-maps': 'My custom Google Maps title' }, // optionally you can override default app titles
app: 'uber', // optionally specify specific app to use
Comment on lines -233 to +234
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the idea here was the disable these by default, in case someone just copies the code snippet without looking and is confused about the fact that a specific app is opened rather than showing the list of options.

But maybe that means we should have a short simple example and then one that shows all the available options?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops sorry I ignored your reply before.

We already have "optionally" comments after these options. Other optional options are not commented, so IMO it could be better to keep these 2 options consistent, i.e. uncommented.

image

directionsMode: 'walk', // optional, accepted values are 'car', 'walk', 'public-transport' or 'bike'
});
```

Notes:

- The `sourceLatitude/sourceLongitude` options only work if you specify both. Currently supports all apps except Waze.
- The `sourceLatitude` / `sourceLongitude` options only work if you specify both. Currently supports all apps except Waze.
- `directionsMode` works on google-maps and apple-maps (on the latter, `bike` mode will not work). Without setting it, the app will decide based on his own settings.
- If you set `directionsMode` but do not set `sourceLatitude` and `sourceLongitude`, google-maps and apple-maps will still enter directions mode, and use the current location as starting point.

Expand Down Expand Up @@ -304,6 +304,6 @@ const Demo = () => {
</b>
<br>
<sub>
Custom consulting sessions availabe for implementation support or feature development.
Custom consulting sessions available for implementation support or feature development.
</sub>
</div>
Loading