Function enterRoot

enterRoot<
    Id extends
        | "LoginHomepage"
        | "LoginHomeCds"
        | "LandingScreen"
        | "LoginTwoFactorEntrypoint"
        | "LoginTwoFactorMethodPicker"
        | "LoginTwoFactorEnterTotpCode"
        | "AccountRecoverySearchCds"
        | "AccountRecoverySearch"
        | "AccountRecoveryAuthenticationConfirmation"
        | "AccountRecoveryEmailCode"
        | "RegistrationPhoneNumber"
        | "RegistrationConfirmationCode"
        | "RegistrationPassword"
        | "RegistrationBirthday"
        | "RegistrationName"
        | "RegistrationUsername"
        | "RegistrationTermsOfService"
        | "SaveCredentials"
        | "AccountRecoverySuccessLocationPermission"
        | "FeedTimeline"
        | "PostOpenedFromLink"
        | "ReelsViewer"
        | "MediaComments"
        | "RepostNoteEditor"
        | "Explore"
        | "SearchInput"
        | "SearchResultsTopTab"
        | "SearchResultsAccountsTab"
        | "UserProfile"
        | "ProfileMediaTab"
        | "MyProfile"
        | "MyProfileMediaTab"
        | "EditProfile"
        | "EditProfileBio"
        | "EditProfileUsername"
        | "EditProfileLinks"
        | "EditProfileAddLink"
        | "ProfilePostsFeed"
        | "FeedTimelineFollowing"
        | "UserProfileReelsTab"
        | "DirectInbox"
        | "DirectRecipientPicker"
        | "DirectThread"
        | "DirectCustomizeChat"
        | "DirectThreadThemePicker"
        | "DirectThreadDetails"
        | "DirectThreadSharedMedia"
        | "DirectThreadNicknames"
        | "DirectThreadNicknameChange"
        | "DirectGroupNameAndPhotoEditor"
        | "PostingGalleryPicker"
        | "PostingPostEdit"
        | "PostingNewPost"
        | "PostingCamera"
        | "PostingCameraGallery"
        | "PostingReelEditor"
        | "PostingNewReel"
        | "PostingPostVideoCameraGallery"
        | "PostingPostVideoCamera"
        | "PostingReelCamera"
        | "PostingStoryCameraHost"
        | "PostingStoryCameraGallery"
        | "PostingPostVideoNewReel"
        | "PostingStoryPhotoEditor"
        | "PostingStoryVideoEditor"
        | "PostingStoryStickerTray"
        | "PostingStoryMusicStickerEditor"
        | "PostingStoryShareSheet"
        | "PostingStoryAlsoShareTo"
        | "PostingStoryDoneCamera"
        | "PostingStoryMusicSearchHost"
        | "PostingMusicBrowser"
        | "PostingMusicSearchResults"
        | "PostingReelMusicOverlayDetail"
        | "PostingReelMusicEditor"
        | "ChallengeSelectVerifyMethod"
        | "ChallengeVerifyCode"
        | "ChallengeSubmitPhone"
        | "ChallengeSetNewPassword"
        | "ChallengeAddBirthday"
        | "ChallengeLoginReview"
        | "ChallengeAccountTemporarilyLocked"
        | "ChallengeEscalationInformation"
        | "ChallengeReviewContactPointChange"
        | "ChallengeScrapingWarning"
        | "ChallengeWebRecaptcha"
        | "ChallengeWebSetNewPassword"
        | "ChallengeTextCaptcha"
        | "ChallengeRecaptcha"
        | "ChallengeSetContactPoint"
        | "ChallengeContactPointCode"
        | "ChallengeAuthenticityWizard"
        | "ChallengeAwaitingReview"
        | "ChallengeThanksForProvidingInfo"
        | "ChallengeAccountSuspended",
    Kind extends EnterableScreenKind,
    Input,
    Data extends object,
    State,
    E,
    R,
    Actions extends object,
    Items extends object,
    Top extends PropertyKey,
>(
    definition: ScreenDefinition<
        Id,
        Kind,
        Input,
        Data,
        State,
        E,
        R,
        Actions,
        Items,
        never,
        Top,
    >,
    via: ScreenVia,
    input: Input,
): Effect<
    ScreenRootHandle<Id, Kind, Data, Actions, Items, Top>,

        | ScreenEnterConcurrentError
        | ScreenDataError
        | E
        | ScreenItemListFailure<Items>,
    ScreenEnterServices<R, Items>,
>
Opens the first screen of a path through the launch edge: what a platform's OpenApp calls with the launch's source and ordinal skip — facts of the launch, never a userland argument.

A tab passed here is the tab's root: a tab with no kept stack enters, a kept one restarts its stack at the tab root (closing the frames above it). A switch that keeps the tab's top frame is switchToTab.
Type Parameters
- Id extends
      | "LoginHomepage"
      | "LoginHomeCds"
      | "LandingScreen"
      | "LoginTwoFactorEntrypoint"
      | "LoginTwoFactorMethodPicker"
      | "LoginTwoFactorEnterTotpCode"
      | "AccountRecoverySearchCds"
      | "AccountRecoverySearch"
      | "AccountRecoveryAuthenticationConfirmation"
      | "AccountRecoveryEmailCode"
      | "RegistrationPhoneNumber"
      | "RegistrationConfirmationCode"
      | "RegistrationPassword"
      | "RegistrationBirthday"
      | "RegistrationName"
      | "RegistrationUsername"
      | "RegistrationTermsOfService"
      | "SaveCredentials"
      | "AccountRecoverySuccessLocationPermission"
      | "FeedTimeline"
      | "PostOpenedFromLink"
      | "ReelsViewer"
      | "MediaComments"
      | "RepostNoteEditor"
      | "Explore"
      | "SearchInput"
      | "SearchResultsTopTab"
      | "SearchResultsAccountsTab"
      | "UserProfile"
      | "ProfileMediaTab"
      | "MyProfile"
      | "MyProfileMediaTab"
      | "EditProfile"
      | "EditProfileBio"
      | "EditProfileUsername"
      | "EditProfileLinks"
      | "EditProfileAddLink"
      | "ProfilePostsFeed"
      | "FeedTimelineFollowing"
      | "UserProfileReelsTab"
      | "DirectInbox"
      | "DirectRecipientPicker"
      | "DirectThread"
      | "DirectCustomizeChat"
      | "DirectThreadThemePicker"
      | "DirectThreadDetails"
      | "DirectThreadSharedMedia"
      | "DirectThreadNicknames"
      | "DirectThreadNicknameChange"
      | "DirectGroupNameAndPhotoEditor"
      | "PostingGalleryPicker"
      | "PostingPostEdit"
      | "PostingNewPost"
      | "PostingCamera"
      | "PostingCameraGallery"
      | "PostingReelEditor"
      | "PostingNewReel"
      | "PostingPostVideoCameraGallery"
      | "PostingPostVideoCamera"
      | "PostingReelCamera"
      | "PostingStoryCameraHost"
      | "PostingStoryCameraGallery"
      | "PostingPostVideoNewReel"
      | "PostingStoryPhotoEditor"
      | "PostingStoryVideoEditor"
      | "PostingStoryStickerTray"
      | "PostingStoryMusicStickerEditor"
      | "PostingStoryShareSheet"
      | "PostingStoryAlsoShareTo"
      | "PostingStoryDoneCamera"
      | "PostingStoryMusicSearchHost"
      | "PostingMusicBrowser"
      | "PostingMusicSearchResults"
      | "PostingReelMusicOverlayDetail"
      | "PostingReelMusicEditor"
      | "ChallengeSelectVerifyMethod"
      | "ChallengeVerifyCode"
      | "ChallengeSubmitPhone"
      | "ChallengeSetNewPassword"
      | "ChallengeAddBirthday"
      | "ChallengeLoginReview"
      | "ChallengeAccountTemporarilyLocked"
      | "ChallengeEscalationInformation"
      | "ChallengeReviewContactPointChange"
      | "ChallengeScrapingWarning"
      | "ChallengeWebRecaptcha"
      | "ChallengeWebSetNewPassword"
      | "ChallengeTextCaptcha"
      | "ChallengeRecaptcha"
      | "ChallengeSetContactPoint"
      | "ChallengeContactPointCode"
      | "ChallengeAuthenticityWizard"
      | "ChallengeAwaitingReview"
      | "ChallengeThanksForProvidingInfo"
      | "ChallengeAccountSuspended"
- Kind extends EnterableScreenKind
- Input
- Data extends object
- State
- E
- R
- Actions extends object
- Items extends object
- Top extends PropertyKey
Parameters
- definition: ScreenDefinition<Id, Kind, Input, Data, State, E, R, Actions, Items, never, Top>
- via: ScreenVia
- input: Input
Returns Effect<
    ScreenRootHandle<Id, Kind, Data, Actions, Items, Top>,

        | ScreenEnterConcurrentError
        | ScreenDataError
        | E
        | ScreenItemListFailure<Items>,
    ScreenEnterServices<R, Items>,
>

Function enterRoot

Type Parameters

Parameters

Returns Effect< ScreenRootHandle<Id, Kind, Data, Actions, Items, Top>, | ScreenEnterConcurrentError | ScreenDataError | E | ScreenItemListFailure<Items>, ScreenEnterServices<R, Items>,>

Settings

Returns Effect<
ScreenRootHandle<Id, Kind, Data, Actions, Items, Top>,

| ScreenEnterConcurrentError
| ScreenDataError
| E
| ScreenItemListFailure<Items>,
ScreenEnterServices<R, Items>,
>