Skip to main content

Documentation Index

Fetch the complete documentation index at: https://turnkey-0e7c1f5b-amir-tx-status-webhooks.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Package: react-wallet-kit

Defined in: react-wallet-kit/src/providers/client/Types.tsx:488

Handles the update user name flow.
  • This function opens a modal with the UpdateUserName component for updating and verifying the user’s name.
  • If a userName is provided, it will directly update the user name without showing the modal.
  • Uses updateUserName under the hood to perform the update and automatically refreshes the user details state after a successful update.
  • Optionally displays a success page after the update, with customizable duration.
  • Supports passing a custom title and subtitle for the modal UI.
  • Handles all error cases and throws a TurnkeyError with appropriate error codes.
​
params
HandleUpdateUserNameParams
A successful response returns the following fields:
​
returns
string
required
A promise that resolves to the userId of the user that was changed.