Repository navigation
docs(example): add snackSupported example metadata - #4416
Merged
Merged
Conversation
…les webSupported snackSupported defaults to webSupported and is emitted to the example doc front matter as snack_supported, so maps-docs can show an "Edit in Snack" link without keeping its own allowlist. GeoJSONSource and ImageOverlay opt out since Snack can't load their PNG assets.
8 tasks
4 of 8 tasks
This branch was previously deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds an optional
snackSupportedexample metadata flag for the "Edit in Snack" button proposed in rnmapbox/maps-docs#26, so maps-docs doesn't need its own allowlist. It defaults towebSupportedand is written to the example page front matter assnack_supported.Also sets
webSupported: trueon 9 examples that run in both the hosted web example app and Snack (MarkerView, MarkerViewPlacement, ViewportGestures, CameraGestureObserver, SetLanguage, ShowMapLocalStyle, StyleJson, ScalableImages, GlobeProjection). GeoJSONSource and ImageOverlay setsnackSupported: falsebecause Snack can't load their PNG assets by URL.Checklist
CONTRIBUTING.mdyarn generatein the root folder/exampleapp./example)The 9 newly flagged examples were checked in headless Chromium against https://rnmapbox.github.io/example-app/ (map renders, tiles load), and every example with
snack_supported: truewas opened in Snack from a local maps-docs build.