This repository has been archived by the owner on Dec 30, 2022. It is now read-only.
feat: add react refs docs #221
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
djejaquino
suggested changes
Aug 25, 2022
There was a problem hiding this comment.
Under BasisTheoryReact section let's add a new Element Ref (or similar) where we have code sample of how to perform tokenization, similar to the getElement section.
It feels weird that we would be deprecating the latter and not adding examples for Refs.
Be aware of the Typescript type generics passed to useRef function
source/includes/elements/react/_card_expiration_date_element.md
Outdated
Show resolved
Hide resolved
source/includes/elements/react/_card_verification_code_element.md
Outdated
Show resolved
Hide resolved
djejaquino
suggested changes
Aug 26, 2022
| ``` | ||
|
|
||
| Gets the underlying Element instance. Given the declarative nature of React, this method enables referencing the Element value for tokenization. | ||
| [Refs](https://reactjs.org/docs/refs-and-the-dom.html) are a way to access DOM nodes or React elements created in the render method. |
There was a problem hiding this comment.
Suggested change
| [Refs](https://reactjs.org/docs/refs-and-the-dom.html) are a way to access DOM nodes or React elements created in the render method. | |
| [Refs](https://reactjs.org/docs/refs-and-the-dom.html) are a way to access DOM nodes or React component instances. |
|
|
||
| The targeted Element must be present in your component tree (virtual DOM) when invoking this method. | ||
| In the case of BasisTheoryReact, `refs` are utilized to store or receive (in the case of a [callback ref](https://reactjs.org/docs/refs-and-the-dom.html#callback-refs)) the created element instance. |
There was a problem hiding this comment.
Suggested change
| In the case of BasisTheoryReact, `refs` are utilized to store or receive (in the case of a [callback ref](https://reactjs.org/docs/refs-and-the-dom.html#callback-refs)) the created element instance. | |
| In BasisTheoryReact, `refs` are utilized to store or receive (in the case of a [callback ref](https://reactjs.org/docs/refs-and-the-dom.html#callback-refs)) the underlying Element instance to tokenize their value or call one of its methods. |
| </aside> | ||
|
|
||
| You can type-cast `getElement` method to safely call specific Elements methods. | ||
| When using typescript, you can type-cast the element `ref` to safely call specific Elements methods. |
There was a problem hiding this comment.
Turn Tokenization > Data Parsing into a level 2 heading and link "specific" methods to it, for better clarity.
Suggested change
| When using typescript, you can type-cast the element `ref` to safely call specific Elements methods. | |
| When using Typescript, you can type-cast the element `ref` to safely call specific Elements methods. |
There was a problem hiding this comment.
When we introduce focus and blur we will have to rethink about methods documentation.
djejaquino
approved these changes
Aug 26, 2022
bt-platform-eng
pushed a commit
that referenced
this pull request
Aug 26, 2022
# [1.62.0](v1.61.0...v1.62.0) (2022-08-26) ### Features * add react refs docs ([#221](#221)) ([e256252](e256252))
|
🎉 This PR is included in version 1.62.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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
refsfeature for react elementsTesting required outside of automated testing?
Screenshots (if appropriate):
Rollback / Rollforward Procedure
Reviewer Checklist