fix(annotation/Label): fix doc types and padding #989
Merged
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.
📝 Documentation
🐛 Bug Fix
This fixes a couple of small issues with
Label
from@visx/annotation
:Label
were not correctly generated indocs/annotation
because the exported component name did not match the file name (this is a limitation of the TS doc type generation, should turn on the lint rule for this)Label
'sprops.backgroundPadding
can be of shapenumber | { top?: number, right: ..., bottom: ..., left: ... }
. the logic for theobject
shape was currently broken / this fixes it.anchorLineStroke
, so if you setshowAnchorLine={true}
it wasn't visible by default. should have a default so users aren't confused!/annotation
demo didn't update the annotation position on screen size changes. This results in a broken example in codesandbox when it initially renders with 0 width/height or if the dimensions changed. Added a fix.Here's the verified doc fix:
Before/after in code sandbox:
@hshoff