New User Onboarding Task List

cypress/e2e/user-onboarding/user-onboarding-new.ts

@@ -0,0 +1,68 @@
+/*
+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.
+*/
+
+/// <reference types="cypress" />
+
+import { MatrixClient } from "../../global";
+import { SynapseInstance } from "../../plugins/synapsedocker";
+
+describe("User Onboarding (new user)", () => {
+    let synapse: SynapseInstance;
+
+    const bot1Name = "BotBob";
+    let bot1: MatrixClient;
+
+    beforeEach(() => {
+        cy.startSynapse("default").then(data => {
+            synapse = data;
+            cy.initTestUser(synapse, "Jane Doe");
+            cy.window({ log: false }).then(win => {
+                win.localStorage.setItem("mx_registration_time", "1656633601");
+            });
+            cy.reload().then(() => {
+                // wait for the app to load
+                return cy.get(".mx_MatrixChat", { timeout: 15000 });
+            });
+            cy.getBot(synapse, { displayName: bot1Name }).then(_bot1 => {
+                bot1 = _bot1;
+            });
+            cy.get('.mx_UserOnboardingPage').should('exist');
+        });
+    });
+
+    afterEach(() => {
+        cy.stopSynapse(synapse);
+    });
+
+    it("page is shown", () => {
+        cy.get('.mx_UserOnboardingPage').should('exist');
+        cy.percySnapshot("User onboarding page");
+    });
+
+    it("using find friends action should increase progress", () => {
+        cy.get(".mx_ProgressBar").invoke("val").then((oldProgress) => {
+            const findPeopleAction = cy.contains(".mx_UserOnboardingTask_action", "Find friends");
+            expect(findPeopleAction).to.exist;
+            findPeopleAction.click();
+            cy.get(".mx_InviteDialog_editor input").type(bot1.getUserId());
+            cy.get(".mx_InviteDialog_buttonAndSpinner").click();
+            cy.get(".mx_InviteDialog_buttonAndSpinner").should("not.exist");
+            cy.visit("/#/home");
+
+            cy.get(".mx_ProgressBar").invoke("val").should("be.greaterThan", oldProgress);
+        });
+    });
+});

cypress/e2e/user-onboarding/user-onboarding-old.ts

@@ -0,0 +1,46 @@
+/*
+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.
+*/
+
+/// <reference types="cypress" />
+
+import { SynapseInstance } from "../../plugins/synapsedocker";
+
+describe("User Onboarding (old user)", () => {
+    let synapse: SynapseInstance;
+
+    beforeEach(() => {
+        cy.startSynapse("default").then(data => {
+            synapse = data;
+            cy.initTestUser(synapse, "Jane Doe");
+            cy.window({ log: false }).then(win => {
+                win.localStorage.setItem("mx_registration_time", "2");
+            });
+            cy.reload().then(() => {
+                // wait for the app to load
+                return cy.get(".mx_MatrixChat", { timeout: 15000 });
+            });
+        });
+    });
+
+    afterEach(() => {
+        cy.visit("/#/home");
+        cy.stopSynapse(synapse);
+    });
+
+    it("page is hidden", () => {
+        cy.get('.mx_UserOnboardingPage').should('not.exist');
+    });
+});

package.json

@@ -57,7 +57,7 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.12.5",
-    "@matrix-org/analytics-events": "^0.1.2",
+    "@matrix-org/analytics-events": "^0.2.0",
     "@matrix-org/react-sdk-module-api": "^0.0.3",
     "@sentry/browser": "^6.11.0",
     "@sentry/tracing": "^6.11.0",

res/css/_components.pcss

@@ -324,6 +324,10 @@
 @import "./views/toasts/_IncomingCallToast.pcss";
 @import "./views/toasts/_NonUrgentEchoFailureToast.pcss";
 @import "./views/typography/_Heading.pcss";
+@import "./views/user-onboarding/_UserOnboardingHeader.pcss";
+@import "./views/user-onboarding/_UserOnboardingList.pcss";
+@import "./views/user-onboarding/_UserOnboardingPage.pcss";
+@import "./views/user-onboarding/_UserOnboardingTask.pcss";
 @import "./views/verification/_VerificationShowSas.pcss";
 @import "./views/voip/CallView/_CallViewButtons.pcss";
 @import "./views/voip/_CallPreview.pcss";

res/css/_spacing.pcss

@@ -25,3 +25,5 @@ $spacing-24: 24px;
 $spacing-28: 28px;
 $spacing-32: 32px;
 $spacing-40: 40px;
+$spacing-48: 48px;
+$spacing-64: 64px;

res/css/views/user-onboarding/_UserOnboardingHeader.pcss

@@ -0,0 +1,101 @@
+/*
+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_UserOnboardingHeader {
+    display: flex;
+    flex-direction: row;
+    padding: $spacing-32;
+    border-radius: 16px;
+    background: $system;
+    gap: $spacing-64;
+
+    animation-delay: 1500ms;
+    animation-duration: 300ms;
+    animation-timing-function: cubic-bezier(0, 0, 0.58, 1);
+    animation-name: mx_UserOnboardingHeader_slideIn;
+    animation-fill-mode: backwards;
+    will-change: opacity, transform;
+
+    @media (max-width: 1280px) {
+        margin: $spacing-32;
+    }
+
+    .mx_UserOnboardingHeader_dot {
+        color: $accent;
+    }
+
+    .mx_UserOnboardingHeader_content {
+        display: flex;
+        flex-direction: column;
+        flex-basis: 50%;
+        flex-shrink: 1;
+        flex-grow: 1;
+        min-width: 0;
+        gap: $spacing-24;
+        margin-right: auto;
+
+        p {
+            margin: 0;
+        }
+
+        .mx_AccessibleButton {
+            margin-top: auto;
+            align-self: flex-start;
+            padding: $spacing-12 $spacing-24;
+        }
+    }
+
+    .mx_UserOnboardingHeader_image {
+        flex-basis: 30%;
+        flex-shrink: 1;
+        flex-grow: 1;
+        align-self: center;
+        height: calc(100% + $spacing-64 + $spacing-64);
+        aspect-ratio: 4 / 3;
+        object-fit: contain;
+        min-width: 0;
+        min-height: 0;
+        margin-top: -$spacing-64;
+        margin-bottom: -$spacing-64;
+
+        animation-delay: 1500ms;
+        animation-duration: 300ms;
+        animation-timing-function: cubic-bezier(0, 0, 0.58, 1);
+        animation-name: mx_UserOnboardingHeader_slideInLong;
+        animation-fill-mode: backwards;
+        will-change: opacity, transform;
+    }
+}
+
+@keyframes mx_UserOnboardingHeader_slideIn {
+    0% {
+        transform: translate(0, 8px);
+        opacity: 0;
+    }
+    100% {
+        transform: translate(0, 0);
+        opacity: 1;
+    }
+}
+
+@keyframes mx_UserOnboardingHeader_slideInLong {
+    0% {
+        transform: translate(0, 32px);
+    }
+    100% {
+        transform: translate(0, 0);
+    }
+}

res/css/views/user-onboarding/_UserOnboardingList.pcss

@@ -0,0 +1,79 @@
+/*
+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_UserOnboardingList {
+    display: flex;
+    flex-direction: column;
+    margin: 0 $spacing-32;
+
+    animation-duration: 300ms;
+    animation-timing-function: cubic-bezier(0, 0, 0.58, 1);
+    animation-name: mx_UserOnboardingList_slideIn;
+    animation-fill-mode: backwards;
+    will-change: opacity;
+
+    .mx_UserOnboardingList_header {
+        display: flex;
+        flex-direction: row;
+        gap: 12px;
+        align-items: center;
+
+        .mx_UserOnboardingList_hint {
+            color: $secondary-content;
+        }
+    }
+
+    .mx_UserOnboardingList_progress {
+        display: flex;
+        flex-direction: column;
+        counter-reset: user-onboarding;
+
+        .mx_ProgressBar {
+            width: auto;
+            margin-top: $spacing-16;
+            height: 16px;
+
+            @mixin ProgressBarBorderRadius 16px;
+        }
+
+        .mx_UserOnboardingFeedback {
+            margin-top: $spacing-16;
+        }
+    }
+
+    .mx_UserOnboardingList_list {
+        display: grid;
+        grid-template-columns: max-content 1fr max-content;
+
+        appearance: none;
+        list-style: none;
+        margin: $spacing-32 0 0;
+        padding: 0;
+
+        grid-gap: $spacing-24;
+    }
+}
+
+@keyframes mx_UserOnboardingList_slideIn {
+    0% {
+        transform: translate(0, 8px);
+        opacity: 0;
+    }
+    100% {
+        transform: translate(0, 0);
+        opacity: 1;
+    }
+}

res/css/views/user-onboarding/_UserOnboardingPage.pcss

@@ -0,0 +1,35 @@
+/*
+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_UserOnboardingPage {
+    width: 100%;
+    height: 100%;
+
+    align-self: stretch;
+    max-width: 1200px;
+    margin: 0 auto auto;
+
+    display: flex;
+    flex-direction: column;
+    box-sizing: border-box;
+
+    gap: $spacing-64;
+    padding: $spacing-64 100px;
+
+    @media (max-width: 1280px) {
+        padding: $spacing-48 $spacing-32;
+    }
+}