Add helpers for AnnotationDocumentInfo #18
Merged
Conversation
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
acelaya
commented
Jun 11, 2025
acelaya
commented
Jun 11, 2025
acelaya
commented
Jun 11, 2025
Comment on lines
+1
to
+10
| export type Annotation = { | ||
| uri: string; | ||
| document: { title: string }; | ||
| links: { | ||
| /** A "bouncer" URL that takes the user to see the annotation in context */ | ||
| incontext?: string; | ||
| /** URL to view the annotation by itself. */ | ||
| html?: string; | ||
| }; | ||
| }; |
Collaborator
Author
There was a problem hiding this comment.
I have created this type as small as possible, just with the minimum properties that are needed by the helpers defined here.
In future we plan to extract the type definitions to a shared location.
acelaya
commented
Jun 11, 2025
acelaya
force-pushed
the
annotation-document
branch
from
5897c76 to
ff6fdb6
Compare
Contributor
robertknight
left a comment
robertknight
left a comment
There was a problem hiding this comment.
I think it will make sense to combine AnnotationDocument and AnnotationDocumentInfo into one AnnotationDocumentInfo component, since AnnotationDocumentInfo is quite small and I don't think we plan to use it outside AnnotationDocument?
acelaya
changed the title
acelaya
force-pushed
the
annotation-document
branch
2 times, most recently
from
13e20d5 to
c5122f0
Compare
acelaya
force-pushed
the
annotation-document
branch
from
c5122f0 to
3b0562f
Compare
This was referenced Jun 11, 2025
robertknight
approved these changes
Jun 11, 2025
acelaya
force-pushed
the
annotation-document
branch
from
3b0562f to
1825352
Compare
acelaya
force-pushed
the
annotation-document
branch
from
1825352 to
4fdd8f1
Compare
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.
Part of hypothesis/h#9548
Improve the
AnnotationDocumentInfocomponent so that it can extract the information to display from the annotation, via a number of new helper functions.Most of the logic here is extracted from client, and will be used in hypothesis/h#9618 as well.
Once merged, I will create a client PR removing the helpers that are not needed there anymore.