This repository has been archived by the owner on Sep 11, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 832
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
The Welcome Home Screen: Return Button (#9089)
* Implement button to return to user onboarding screen * Add analytics events * Increase stability of lazy loading test
- Loading branch information
Showing
13 changed files
with
243 additions
and
30 deletions.
There are no files selected for viewing
This file contains 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 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 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 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,84 @@ | ||
| /* | ||
| Copyright 2022 The Matrix.org Foundation C.I.C. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| .mx_UserOnboardingButton { | ||
| display: flex; | ||
| flex-direction: column; | ||
| align-content: stretch; | ||
| align-items: stretch; | ||
| border-radius: 8px; | ||
| margin: $spacing-8 $spacing-8 0; | ||
| padding: $spacing-12; | ||
|
|
||
| &.mx_UserOnboardingButton_selected, | ||
| &:hover, | ||
| &:focus-within { | ||
| background-color: $panel-actions; | ||
| } | ||
|
|
||
| .mx_UserOnboardingButton_content { | ||
| display: flex; | ||
| flex-direction: row; | ||
| gap: 5px; | ||
| align-items: center; | ||
|
|
||
| .mx_Heading_h4 { | ||
| margin-right: auto; | ||
| font-size: $font-14px; | ||
| color: $primary-content; | ||
| } | ||
|
|
||
| .mx_UserOnboardingButton_percentage { | ||
| font-size: $font-12px; | ||
| color: $secondary-content; | ||
| } | ||
|
|
||
| .mx_UserOnboardingButton_close { | ||
| position: relative; | ||
| box-sizing: border-box; | ||
| width: 14px; | ||
| height: 14px; | ||
| border-radius: 7px; | ||
| border: 1px solid $secondary-content; | ||
| flex-shrink: 0; | ||
|
|
||
| &::before { | ||
| background-color: $secondary-content; | ||
| content: ""; | ||
| mask-repeat: no-repeat; | ||
| mask-position: center; | ||
| mask-size: contain; | ||
| width: 7px; | ||
| height: 7px; | ||
| position: absolute; | ||
| left: 50%; | ||
| top: 50%; | ||
| transform: translate(-50%, -50%); | ||
| mask-image: url("$(res)/img/element-icons/cancel-rounded.svg"); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| .mx_ProgressBar { | ||
| width: auto; | ||
| margin-top: $spacing-8; | ||
| background: $background; | ||
| } | ||
|
|
||
| &.mx_UserOnboardingButton_completed .mx_ProgressBar { | ||
| display: none; | ||
| } | ||
| } |
This file contains 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 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 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
102 changes: 102 additions & 0 deletions
102
src/components/views/user-onboarding/UserOnboardingButton.tsx
This file contains 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,102 @@ | ||
| /* | ||
| Copyright 2022 The Matrix.org Foundation C.I.C. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| import classNames from "classnames"; | ||
| import React, { useCallback } from "react"; | ||
|
|
||
| import { Action } from "../../../dispatcher/actions"; | ||
| import defaultDispatcher from "../../../dispatcher/dispatcher"; | ||
| import { useSettingValue } from "../../../hooks/useSettings"; | ||
| import { useUserOnboardingContext } from "../../../hooks/useUserOnboardingContext"; | ||
| import { useUserOnboardingTasks } from "../../../hooks/useUserOnboardingTasks"; | ||
| import { _t } from "../../../languageHandler"; | ||
| import PosthogTrackers from "../../../PosthogTrackers"; | ||
| import { UseCase } from "../../../settings/enums/UseCase"; | ||
| import { SettingLevel } from "../../../settings/SettingLevel"; | ||
| import SettingsStore from "../../../settings/SettingsStore"; | ||
| import AccessibleButton, { ButtonEvent } from "../../views/elements/AccessibleButton"; | ||
| import ProgressBar from "../../views/elements/ProgressBar"; | ||
| import Heading from "../../views/typography/Heading"; | ||
| import { showUserOnboardingPage } from "./UserOnboardingPage"; | ||
|
|
||
| function toPercentage(progress: number): string { | ||
| return (progress * 100).toFixed(0); | ||
| } | ||
|
|
||
| interface Props { | ||
| selected: boolean; | ||
| minimized: boolean; | ||
| } | ||
|
|
||
| export function UserOnboardingButton({ selected, minimized }: Props) { | ||
| const context = useUserOnboardingContext(); | ||
| const [completedTasks, waitingTasks] = useUserOnboardingTasks(context); | ||
|
|
||
| const completed = completedTasks.length; | ||
| const waiting = waitingTasks.length; | ||
| const total = completed + waiting; | ||
|
|
||
| let progress = 1; | ||
| if (context && waiting) { | ||
| progress = completed / total; | ||
| } | ||
|
|
||
| const onDismiss = useCallback((ev: ButtonEvent) => { | ||
| PosthogTrackers.trackInteraction("WebRoomListUserOnboardingIgnoreButton", ev); | ||
| SettingsStore.setValue("FTUE.userOnboardingButton", null, SettingLevel.ACCOUNT, false); | ||
| }, []); | ||
|
|
||
| const onClick = useCallback((ev: ButtonEvent) => { | ||
| PosthogTrackers.trackInteraction("WebRoomListUserOnboardingButton", ev); | ||
| defaultDispatcher.fire(Action.ViewHomePage); | ||
| }, []); | ||
|
|
||
| const useCase = useSettingValue<UseCase | null>("FTUE.useCaseSelection"); | ||
| const visible = useSettingValue<boolean>("FTUE.userOnboardingButton"); | ||
| if (!visible || minimized || !showUserOnboardingPage(useCase)) { | ||
| return null; | ||
| } | ||
|
|
||
| return ( | ||
| <AccessibleButton | ||
| className={classNames("mx_UserOnboardingButton", { | ||
| "mx_UserOnboardingButton_selected": selected, | ||
| "mx_UserOnboardingButton_minimized": minimized, | ||
| "mx_UserOnboardingButton_completed": !waiting || !context, | ||
| })} | ||
| onClick={onClick}> | ||
| { !minimized && ( | ||
| <> | ||
| <div className="mx_UserOnboardingButton_content"> | ||
| <Heading size="h4" className="mx_Heading_h4"> | ||
| { _t("Welcome") } | ||
| </Heading> | ||
| { context && !completed && ( | ||
| <div className="mx_UserOnboardingButton_percentage"> | ||
| { toPercentage(progress) }% | ||
| </div> | ||
| ) } | ||
| <AccessibleButton | ||
| className="mx_UserOnboardingButton_close" | ||
| onClick={onDismiss} | ||
| /> | ||
| </div> | ||
| <ProgressBar value={completed} max={total} animated /> | ||
| </> | ||
| ) } | ||
| </AccessibleButton> | ||
| ); | ||
| } |
This file contains 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 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 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
Oops, something went wrong.