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.

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

Mapbox-gl-geocoder v4 examples #8053

Merged

Conversation

scottsfarley93
Copy link
Contributor

@scottsfarley93 scottsfarley93 commented Mar 19, 2019

Launch Checklist

This PR adds several examples to demonstrate the functionality added in v4 of the mapbox-gl-geocoder. Specifically, new examples include:

  • A mapbox-gl-geocoder with a custom rendering function
  • A mapbox-gl-geocoder with language localization
  • A mapbox-gl-geocoder with custom flyTo animation properties

Additionally, several examples will be updated, including:

  • Updating the Set a point after geocode result to use the new built-in marker functionality in the gl-geocoder
  • Updating Remove the Bias geocoder results around the map view to use the built-in trackProximity functionality in the gl-geocoder

Note: This is a WIP and these examples will not work until we have a working release candidate for version 4 available on api.mapbox.com.

  • briefly describe the changes in this PR

\cc @katydecorah @yuletide @kbauhaus

@andrewharvey
Copy link
Collaborator

Updating the Bias geocoder results around the map view to use the built-in trackProximity functionality in the gl-geocoder

Whops, I forgot that's now done with trackProximity. I'd suggest we just remove this example since per mapbox/mapbox-gl-geocoder#195, it does this by default now.

addToMap: true,
markerOptions: {
color: 'orange',
draggable: true
Copy link
Collaborator

Choose a reason for hiding this comment

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

What's the reasoning behind draggable: true? I get it shows options you can pass in, but I'm not sure if this makes sense as a default.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Entirely as an example of being able to pass in options. Perhaps just the color option would suffice as an illustrative example.

@andrewharvey
Copy link
Collaborator

andrewharvey commented Mar 27, 2019

Screenshot from 2019-03-27 14-24-06
Screenshot from 2019-03-27 14-24-18

Yes, in a proper implementation you could write your own render function, but in the interests of keeping the example simple and minimal we should just drop the comma.

Copy link
Contributor

@katydecorah katydecorah left a comment

Choose a reason for hiding this comment

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

@scottsfarley93 these example are looking great! I left two small suggestions.

I pushed the lint fixes, but it looks like there is now an error with flow that doesn't seem related. We may need to have someone on GL team rerun the test (I don't have permission to do so).

margin-right: 10px;
}
.geocoder-dropdown-text{
color: darkgray;
Copy link
Contributor

Choose a reason for hiding this comment

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

This color value's contrast is very low, which will make it difficult for users with low vision to read. Maybe go with a darker gray? Or a fun purple #5a3fc0 ?

Suggested change
color: darkgray;
color: #666;

[`result`](https://github.com/mapbox/mapbox-gl-geocoder/blob/master/API.md#on)
event from [mapbox-gl-geocoder](https://github.com/mapbox/mapbox-gl-geocoder)
and place a point on the coordinate results.
Style a [Marker](https://docs.mapbox.com/mapbox-gl-js/api/#marker) to use to mark the location of the [mapbox-gl-geocoder](https://github.com/mapbox/mapbox-gl-geocoder)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Style a [Marker](https://docs.mapbox.com/mapbox-gl-js/api/#marker) to use to mark the location of the [mapbox-gl-geocoder](https://github.com/mapbox/mapbox-gl-geocoder)
Style a [Marker](https://docs.mapbox.com/mapbox-gl-js/api/#marker) used to mark the location of the [mapbox-gl-geocoder](https://github.com/mapbox/mapbox-gl-geocoder)

Scott Farley added 2 commits April 9, 2019 09:27
@scottsfarley93 scottsfarley93 changed the title [WIP] mapbox-gl-geocoder v4 examples Mapbox-gl-geocoder v4 examples Apr 9, 2019
@scottsfarley93 scottsfarley93 merged commit 6e6a005 into publisher-production Apr 9, 2019
@scottsfarley93 scottsfarley93 deleted the mapbox-gl-geocoder-version4-examples branch April 9, 2019 17:45
vakila pushed a commit that referenced this pull request May 30, 2019
* Set default thumbnail for examples page for development (#8025)

* Set default thumbnail

* Add a little guidance about creating example images

* creates placeholder.png

* v0.54.0-beta.1 (#8084)

* CP removeFeatureState fix (#8090)

* Empty out features whose states have been removed instead of removing the feature object. This allows updating the buffers for features whose state has been removed, but also requires keep track of previously removed features.

* Update Changelog

* v0.54.0 (#8115)

* Example for `fill-pattern` (#8022)

* move docs dependencies to dev (#8121) (#8129)

* Mapbox-gl-geocoder v4 examples (#8053)

* add geocoder custom render example

* language localize example

* Update marker demo to use built-in marker function

* remove proximity bias for gl-geocoder example because this is now default behavior

* update point from geocode demo to set custom marker color

* update examples to use new mapbox-gl-geocoder API options

* lint new examples

* Update examples to gl-geocoder 4.0.0 api

* Options should be added to the geocoder, not the map

* lint examples

* remove templating syntax

* lint fixes

* @katydecorah 's code review fixes

* Studio does support rtl plugin (#8135)

* Update comment for setRTLTextPlugin (#8143)

* update comment for setRTLTextPlugin

* clarify wording in example

* update one more frame after canvas source paused (#8130) (#8163)

* update one more frame after canvas source paused

Calling `canvasSource.pause()` lets us know we can stop pulling in
updates from it. Since it is possible that changes were made to the
canvas source since the last render we should pull in one more update
before stopping. This also lets you call play and pause immediately to
render just one frame:

ctx.fillRect(10, 10, 50, 50);
canvasSource.play();
canvasSource.pause();

* add test

* don't render changes made after canvasSource.pause()

* optimize

* optimize

* Bugfix - removeFeatureState fails with target.id === 0 (#8150) (#8164)

* Fix an edge case where 0 target.id would fail to clear the feature state

* Check for number & string explicitly

* Add tests for 0 feature ID

* Fix logical check

* v0.54.0-beta.2 (#8166)

* [docs] meta updates for search (#8142)

* update docs-page-shell, update page-shell; update page meta

* Update react-page-shell.js

* remove contentType from examples page

* Update react-page-shell.js

* Update react-page-shell.js

* [docs] token refactor in docs-page-shell (#8174)

* Update page-shell-script.js

* do not force production page shell

* remove hardcoded token from example, add unit test to look for access token in example html files

* [docs] token refactor in docs-page-shell (#8174) (#8181)

* Update page-shell-script.js

* do not force production page shell

* remove hardcoded token from example, add unit test to look for access token in example html files

* Fix disappearing controls in Safari 12+ (#8193) (#8194)

* workaround for a Safari 12 bug with disappearing controls

* fix css lint

* v0.54.0 (take two) (#8184)

* v0.54.0

* update changelog once more

* fix imagery endpoint on WMS example (#8203)

* mapbox-gl-geocoder@v4.2.0 (#8212)

* [docs] add trailing slash to `pathname` so resolved URL matches the canonical (#8228)

* Update documentation.yml (#8230)

* update mapbox-gl-geocoder to v4.3.0 (#8231)

* @mapbox/mapbox gl style spec@13.7.0 (#8264)

* Prepare @mapbox/mapbox-gl-style-spec@13.7.0

* Add changelog of relevant items

* Add sku token to Mapbox API tile requests (#14) (#8276)

* v1.0.0 (#8277)

* [docs] update docs-page-shell (#8254)

* fix pathname

* Update react-page-shell.js
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants