Skip to content
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

feat(editor-ui): onboarding welcome modal and hook #4363

Open
wants to merge 6 commits into
base: staging
Choose a base branch
from

Conversation

hejtful
Copy link
Contributor

@hejtful hejtful commented Dec 18, 2024

Linear issue: EDTR-200

Demo

Copy link

vercel bot commented Dec 18, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
frontend ✅ Ready (Inspect) Visit Preview Dec 19, 2024 11:35am

Copy link
Contributor

github-actions bot commented Dec 18, 2024

📦 Next.js Bundle Analysis for @serlo/frontend

This analysis was generated by the Next.js Bundle Analysis action. 🤖

⚠️ Global Bundle Size Increased

Page Size (compressed)
global 104.91 KB (🟡 +43 B)
Details

The global bundle is the javascript bundle that loads alongside every page. It is in its own category because its impact is much higher - an increase to its size means that every page on your website loads slower, and a decrease means every page loads faster.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

If you want further insight into what is behind the changes, give @next/bundle-analyzer a try!

Eight Pages Changed Size

The following pages changed size from the code in this PR compared to its base branch:

Page Size (compressed) First Load
/___editor_preview 643.42 KB (🟡 +6.2 KB) 748.33 KB
/editor 79.49 KB (🟡 +1 B) 184.4 KB
/entity/create/[type]/[taxonomyId] 663.71 KB (🟡 +6.2 KB) 768.61 KB
/entity/repository/add-revision/[...id] 663.44 KB (🟡 +6.2 KB) 768.34 KB
/page/create 663.42 KB (🟡 +6.2 KB) 768.33 KB
/taxonomy/term/create/[parent_id]/[id] 663.17 KB (🟡 +6.2 KB) 768.08 KB
/taxonomy/term/update/[id] 663.12 KB (🟡 +6.2 KB) 768.03 KB
/user/settings 665.09 KB (🟡 +6.2 KB) 770 KB
Details

Only the gzipped size is provided here based on an expert tip.

First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If next/link is used, subsequent page loads would only need to download that page's bundle (the number in the "Size" column), since the global bundle has already been downloaded.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

Next to the size is how much the size has increased or decreased compared with the base branch of this PR. If this percentage has increased by 20% or more, there will be a red status indicator applied, indicating that special attention should be given to this.

@hejtful hejtful requested a review from elbotho December 19, 2024 09:32
@hejtful hejtful marked this pull request as ready for review December 19, 2024 09:32
Copy link
Member

@elbotho elbotho left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very clean, thank you.
Also really nice that you animated the transistion already 👍

Some suggestions.

Comment on lines +12 to +14
const localStorageValue = localStorage.getItem(localStorageKey)
if (localStorageValue === null) return setIsOpen(true)
const hasSeenModal = decodeWelcomeModalData(localStorageValue)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you don't reuse the preferences:
Could we simplify this by just checking if the key exists?
That way we wouldn't need any type checks and parsing.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could, but I like the idea of decoding any value coming from localStorage, think it's a good practice.

Also, if we later want to expand on this in any way, for example using logged-in user ID to check if a specific user has seen the modal, in case of shared school devices, we can easily expand the codec.

Don't get me wrong, if you implemented it by just checking if the key exists, I wouldn't mind it. But since we already have this code, I wouldn't remove it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants