-
Notifications
You must be signed in to change notification settings - Fork 538
refactor: move onboarding into main app flow #3912
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+989
−800
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
195 changes: 195 additions & 0 deletions
195
apps/desktop/src/components/main/body/onboarding/index.tsx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,195 @@ | ||
| import { useQueryClient } from "@tanstack/react-query"; | ||
| import { platform } from "@tauri-apps/plugin-os"; | ||
| import { Volume2Icon, VolumeXIcon } from "lucide-react"; | ||
| import { useCallback, useEffect, useState } from "react"; | ||
|
|
||
| import { commands as analyticsCommands } from "@hypr/plugin-analytics"; | ||
| import { commands as sfxCommands } from "@hypr/plugin-sfx"; | ||
|
|
||
| import { usePermissions } from "../../../../hooks/usePermissions"; | ||
| import { type Tab, useTabs } from "../../../../store/zustand/tabs"; | ||
| import { CalendarSection } from "../../../onboarding/calendar"; | ||
| import { | ||
| getInitialStep, | ||
| getNextStep, | ||
| getPrevStep, | ||
| getStepStatus, | ||
| } from "../../../onboarding/config"; | ||
| import { FinalSection, finishOnboarding } from "../../../onboarding/final"; | ||
| import { FolderLocationSection } from "../../../onboarding/folder-location"; | ||
| import { LoginSection } from "../../../onboarding/login"; | ||
| import { PermissionsSection } from "../../../onboarding/permissions"; | ||
| import { OnboardingSection } from "../../../onboarding/shared"; | ||
| import { StandardTabWrapper } from "../index"; | ||
| import { type TabItem, TabItemBase } from "../shared"; | ||
|
|
||
| export const TabItemOnboarding: TabItem< | ||
| Extract<Tab, { type: "onboarding" }> | ||
| > = ({ | ||
| tab, | ||
| tabIndex, | ||
| handleCloseThis, | ||
| handleSelectThis, | ||
| handleCloseOthers, | ||
| handleCloseAll, | ||
| handlePinThis, | ||
| handleUnpinThis, | ||
| }) => { | ||
| return ( | ||
| <TabItemBase | ||
| icon={<span className="text-sm">👋</span>} | ||
| title="Welcome" | ||
| selected={tab.active} | ||
| allowPin={false} | ||
| allowClose={false} | ||
| tabIndex={tabIndex} | ||
| handleCloseThis={() => handleCloseThis(tab)} | ||
| handleSelectThis={() => handleSelectThis(tab)} | ||
| handleCloseOthers={handleCloseOthers} | ||
| handleCloseAll={handleCloseAll} | ||
| handlePinThis={() => handlePinThis(tab)} | ||
| handleUnpinThis={() => handleUnpinThis(tab)} | ||
| /> | ||
| ); | ||
| }; | ||
|
|
||
| export function TabContentOnboarding({ | ||
| tab: _tab, | ||
| }: { | ||
| tab: Extract<Tab, { type: "onboarding" }>; | ||
| }) { | ||
| const queryClient = useQueryClient(); | ||
| const close = useTabs((state) => state.close); | ||
| const currentTab = useTabs((state) => state.currentTab); | ||
| const [isMuted, setIsMuted] = useState(false); | ||
| const [currentStep, setCurrentStep] = useState(getInitialStep); | ||
|
|
||
| const { | ||
| micPermissionStatus, | ||
| systemAudioPermissionStatus, | ||
| accessibilityPermissionStatus, | ||
| } = usePermissions(); | ||
|
|
||
| const allPermissionsGranted = | ||
| micPermissionStatus.data === "authorized" && | ||
| systemAudioPermissionStatus.data === "authorized" && | ||
| accessibilityPermissionStatus.data === "authorized"; | ||
|
|
||
| useEffect(() => { | ||
| if (currentStep === "permissions" && allPermissionsGranted) { | ||
| setCurrentStep("login"); | ||
| } | ||
| }, [currentStep, allPermissionsGranted]); | ||
|
|
||
| const goNext = useCallback(() => { | ||
| const next = getNextStep(currentStep); | ||
| if (next) setCurrentStep(next); | ||
| }, [currentStep]); | ||
|
|
||
| const goBack = useCallback(() => { | ||
| const prev = getPrevStep(currentStep); | ||
| if (prev) setCurrentStep(prev); | ||
| }, [currentStep]); | ||
|
|
||
| useEffect(() => { | ||
| void analyticsCommands.event({ | ||
| event: "onboarding_step_viewed", | ||
| step: currentStep, | ||
| platform: platform(), | ||
| }); | ||
| }, [currentStep]); | ||
|
|
||
| useEffect(() => { | ||
| sfxCommands | ||
| .play("BGM") | ||
| .then(() => sfxCommands.setVolume("BGM", 0.2)) | ||
| .catch(console.error); | ||
| return () => { | ||
| sfxCommands.stop("BGM").catch(console.error); | ||
| }; | ||
| }, []); | ||
|
|
||
| useEffect(() => { | ||
| sfxCommands.setVolume("BGM", isMuted ? 0 : 0.2).catch(console.error); | ||
| }, [isMuted]); | ||
|
|
||
| const handleFinish = useCallback(() => { | ||
| void queryClient.invalidateQueries({ queryKey: ["onboarding-needed"] }); | ||
| if (currentTab) { | ||
| close(currentTab); | ||
| } | ||
| }, [close, currentTab, queryClient]); | ||
|
|
||
| return ( | ||
| <StandardTabWrapper> | ||
| <div className="relative h-full overflow-y-auto"> | ||
| <button | ||
| onClick={() => setIsMuted((prev) => !prev)} | ||
| className="sticky top-2 float-right mr-2 p-1.5 rounded-full hover:bg-neutral-100 transition-colors z-10" | ||
| aria-label={isMuted ? "Unmute" : "Mute"} | ||
| > | ||
| {isMuted ? ( | ||
| <VolumeXIcon size={16} className="text-neutral-600" /> | ||
| ) : ( | ||
| <Volume2Icon size={16} className="text-neutral-600" /> | ||
| )} | ||
| </button> | ||
|
|
||
| <div className="flex flex-col px-6 pt-4 pb-16 gap-8"> | ||
| <h1 className="text-2xl font-semibold font-serif text-neutral-900"> | ||
| Welcome to Hyprnote | ||
| </h1> | ||
|
|
||
| <OnboardingSection | ||
| title="Permissions" | ||
| description="Required for best experience" | ||
| status={getStepStatus("permissions", currentStep)} | ||
| onBack={goBack} | ||
| onNext={goNext} | ||
| > | ||
| <PermissionsSection /> | ||
| </OnboardingSection> | ||
|
|
||
| <OnboardingSection | ||
| title="Account" | ||
| description="Sign in to sync and unlock Pro features" | ||
| status={getStepStatus("login", currentStep)} | ||
| onBack={goBack} | ||
| onNext={goNext} | ||
| > | ||
| <LoginSection onContinue={goNext} /> | ||
| </OnboardingSection> | ||
|
|
||
| <OnboardingSection | ||
| title="Calendar" | ||
| description="Select calendars to sync" | ||
| status={getStepStatus("calendar", currentStep)} | ||
| onBack={goBack} | ||
| onNext={goNext} | ||
| > | ||
| <CalendarSection onContinue={goNext} /> | ||
| </OnboardingSection> | ||
|
|
||
| <OnboardingSection | ||
| title="Storage" | ||
| description="Where your notes and recordings are stored" | ||
| status={getStepStatus("folder-location", currentStep)} | ||
| onBack={goBack} | ||
| onNext={goNext} | ||
| > | ||
| <FolderLocationSection onContinue={goNext} /> | ||
| </OnboardingSection> | ||
|
|
||
| <OnboardingSection | ||
| title="Ready to go" | ||
| status={getStepStatus("final", currentStep)} | ||
| onBack={goBack} | ||
| onNext={() => void finishOnboarding(handleFinish)} | ||
| > | ||
| <FinalSection onContinue={handleFinish} /> | ||
| </OnboardingSection> | ||
| </div> | ||
| </div> | ||
| </StandardTabWrapper> | ||
| ); | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.