openpencil/packages/docs/programmable/sdk/api/advanced/use-scrub-input.md
2026-03-24 23:24:08 +03:00

17 lines
496 B
Markdown

---
title: useScrubInput
description: Primitive context helper for ScrubInputRoot descendants.
---
# useScrubInput
`useScrubInput()` reads the local scrub-input context provided by `ScrubInputRoot`.
Use it inside `ScrubInputField`, `ScrubInputDisplay`, or custom descendants that need editing and scrubbing state.
## Related APIs
- [ScrubInputRoot](../components/scrub-input-root)
- [ScrubInputField](../components/scrub-input-field)
- [ScrubInputDisplay](../components/scrub-input-display)