ActionSheet for React NativeActionSheet for React Native
/
GitHubGitHub
/
  • Introduction
  • Installation
  • Basic usage
  • Guides
    • Usage with SheetManager
    • Passing data to ActionSheet
    • Using ActionSheet Router
    • Awaiting result from ActionSheet
    • Ref access from anywhere
    • Scrolling
    • FlashList
    • Background Interaction
    • Position tracking
    • Handling SafeArea
    • Navigation bar colors
    • Migrating Guide
  • Reference
    • ActionSheet props
    • ActionSheetRef
    • SheetManager
    • SheetProps
    • SheetProvider
    • registerSheet
    • ShowOptions
    • HideOptions
    • useRouter
    • useScrollHandlers
    • useSheetRouteParams
    • useSheetIDContext
    • useProviderContext
    • useSheetRef
    • useSheetPayload
    • Route
    • DraggableNodeOptions
    • Sheetdefinition
  • Introduction
  • Installation
  • Basic usage
  • Guides
    • Usage with SheetManager
    • Passing data to ActionSheet
    • Using ActionSheet Router
    • Awaiting result from ActionSheet
    • Ref access from anywhere
    • Scrolling
    • FlashList
    • Background Interaction
    • Position tracking
    • Handling SafeArea
    • Navigation bar colors
    • Migrating Guide
  • Reference
    • ActionSheet props
    • ActionSheetRef
    • SheetManager
    • SheetProps
    • SheetProvider
    • registerSheet
    • ShowOptions
    • HideOptions
    • useRouter
    • useScrollHandlers
    • useSheetRouteParams
    • useSheetIDContext
    • useProviderContext
    • useSheetRef
    • useSheetPayload
    • Route
    • DraggableNodeOptions
    • Sheetdefinition
Edit this page on GitHub
Reference
useSheetPayload

useSheetPayload

Returns the current sheet's payload data with which the sheet was opened.

SheetManager.open("user-properties", {
    payload: {
        userId: 'user-id'
    }
});
// Some where in your sheet's component tree.
const payload = useSheetPayload("user-properties");
 
// Access the values on the payload.
payload.userId
useSheetRef
Route
MIT 2024 © Ammar Ahmed.