Add missing size values to README #35
Merged
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
rico-et22
reviewed
Jan 14, 2025
README.md
Outdated
| @@ -82,7 +82,7 @@ Turnstile takes the following arguments: | |||
| | tabIndex | number | - | | |||
| | responseField | boolean | controls generation of `<input />` element | | |||
| | responseFieldName | string | changes the name of `<input />` element | | |||
| | size | string | one of "normal", "compact" | | |||
| | size | string | one of "normal", "compact", "flexible", invisible | | |||
There was a problem hiding this comment.
Just a small detail: quotation marks are missing for invisible
Suggested change
| | size | string | one of "normal", "compact", "flexible", invisible | | |
| | size | string | one of "normal", "compact", "flexible", "invisible" | |
README.md
Outdated
| @@ -82,7 +82,7 @@ Turnstile takes the following arguments: | |||
| | tabIndex | number | - | | |||
| | responseField | boolean | controls generation of `<input />` element | | |||
| | responseFieldName | string | changes the name of `<input />` element | | |||
| | size | string | one of "normal", "compact" | | |||
| | size | string | one of "normal", "compact", "flexible", invisible | | |||
There was a problem hiding this comment.
Suggested change
| | size | string | one of "normal", "compact", "flexible", invisible | | |
| | size | string | one of "normal", "compact", "flexible" | |
Invisible is purposefully not documented. It’s in the types, so you can use it if you know what you’re doing, but if it’s documented, people may think it’s like the invisible mode
There was a problem hiding this comment.
This is a valid point. I went ahead and removed it.
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.
The size prop takes 4 values: "flexible" | "normal" | "compact" | "invisible"
Flexible and invisible were missing so I added them to the readme.