docs: add getDataByPath to useForm table#12098
Merged
paulpopus merged 1 commit intopayloadcms:mainfrom Apr 2, 2026
Merged
Conversation
paulpopus
approved these changes
Apr 2, 2026
Contributor
|
🚀 This is included in version v3.82.0 |
milamer
pushed a commit
to milamer/payload
that referenced
this pull request
Apr 20, 2026
<!-- Thank you for the PR! Please go through the checklist below and make sure you've completed all the steps. Please review the [CONTRIBUTING.md](https://github.com/payloadcms/payload/blob/main/CONTRIBUTING.md) document in this repository if you haven't already. The following items will ensure that your PR is handled as smoothly as possible: - PR Title must follow conventional commits format. For example, `feat: my new feature`, `fix(plugin-seo): my fix`. - Minimal description explained as if explained to someone not immediately familiar with the code. - Provide before/after screenshots or code diffs if applicable. - Link any related issues/discussions from GitHub or Discord. - Add review comments if necessary to explain to the reviewer the logic behind a change ### What? ### Why? ### How? Fixes # --> ### What? This PR adds the `getDataByPath` utility function to the `useForm` table in the docs. ### Why? This utility is useful for dealing with arrays and other form state. Users commonly ask for examples on how to deal with arrays when using `useField` as this function will return a length instead of the expected value object. ### How? Addition of `getDataByPath` to the `useForm` object table in `docs/admin/react-hooks.mdx`.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What?
This PR adds the
getDataByPathutility function to theuseFormtable in the docs.Why?
This utility is useful for dealing with arrays and other form state. Users commonly ask for examples on how to deal with arrays when using
useFieldas this function will return a length instead of the expected value object.How?
Addition of
getDataByPathto theuseFormobject table indocs/admin/react-hooks.mdx.