break: condense and deprecate redundant styling-related props #473
Conversation
This file contains 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
✅ Deploy Preview for oslmap ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
jessicamcinchak
commented
Aug 6, 2024
| @@ -88,6 +88,9 @@ export class MyMap extends LitElement { | |||
| @property({ type: String }) | |||
| drawType: DrawTypeEnum = "Polygon"; | |||
|
|
|||
| /** | |||
| * @deprecated - please set `drawColor` regardless of `drawType` | |||
| */ | |||
There was a problem hiding this comment.
My thinking is we'll do a NPM prerelease with the @deprecated annotations, then fully remove them ahead of the stable release - sound like a decent plan?
jessicamcinchak
changed the title
DafyddLlyr
approved these changes
Aug 6, 2024
| let featureColor = feature.get("color") || this.geojsonColor; // Use the geojsonColor if no color property exists | ||
|
|
||
| // Read color from geojson feature `properties` if set or fallback to prop | ||
| let featureColor = feature.get("color") || this.geojsonColor; |
There was a problem hiding this comment.
nit: It looks like this could actually be a const?
Another "pre v1" task might be to set up linting here to catch a few of these type of things?
There was a problem hiding this comment.
Yep great shout - will handle in a followup PR 👍
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.
Our styling-related props haven't always been so consistent, so let's tidy them up with a v1 release in mind & flag some as deprecated.
Here's a quick overview of exisitng & changing style-related props based on various modes/functionalities:
drawColor(string) - fill automatically applied at 20% (used to be 10%)drawPointColor(string)drawTypeat a time anyways, sodrawColoris sufficientdrawFillColor(string)drawPointer(enum)markerColor(string)markerImage(enum)geojsonColor(string)geojsonFill(boolean) - 20% if truefeatureColor(string)featureFill(boolean) - 20% if truefeatureBorderNone(string)Any other votes for deprecation or refactoring?