-
Notifications
You must be signed in to change notification settings - Fork 27
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
docs(styleguide): auto-collapse Figma embed for known non-Codecademy-admin user #2795
Draft
JoshuaKGoldberg
wants to merge
3
commits into
Codecademy:main
Choose a base branch
from
JoshuaKGoldberg:jg-collapse-figma-embed
base: main
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+91
−7
Draft
Changes from 1 commit
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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
29 changes: 29 additions & 0 deletions
29
packages/styleguide/.storybook/components/Docs/FigmaEmbed.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,29 @@ | ||
import { GridBox } from '@codecademy/gamut/src'; | ||
import { Figma } from 'storybook-addon-designs/blocks'; | ||
import { useCollapseFigmaEmbed } from './useCollapseFigmaEmbed'; | ||
|
||
export interface FigmaEmbedProps { | ||
url: string; | ||
} | ||
|
||
export const FigmaEmbed: React.FC<FigmaEmbedProps> = ({ url }) => { | ||
const { defaultCollapsed /* , savePreference */ } = useCollapseFigmaEmbed(); | ||
|
||
return ( | ||
<GridBox | ||
onClick={(event) => { | ||
console.log("Without an onClick, is this where we'd save preference?"); | ||
console.log('DOM event:', event); | ||
}} | ||
mb={32} | ||
> | ||
<Figma | ||
collapsable | ||
defaultCollapsed={defaultCollapsed} | ||
key={defaultCollapsed} | ||
height="56.25%" | ||
url={url} | ||
/> | ||
</GridBox> | ||
); | ||
}; |
58 changes: 58 additions & 0 deletions
58
packages/styleguide/.storybook/components/Docs/useCollapseFigmaEmbed.ts
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,58 @@ | ||
import { useEffect, useState } from 'react'; | ||
|
||
export interface WebUserRoles { | ||
author?: boolean; | ||
admin?: boolean; | ||
pro?: boolean; | ||
} | ||
|
||
export interface WebUser { | ||
roles: WebUserRoles; | ||
} | ||
|
||
const storageKey = 'figma-embed-key'; | ||
|
||
export const useCollapseFigmaEmbed = () => { | ||
const [preference, setPreference] = useState( | ||
globalThis.localStorage?.getItem(storageKey) | ||
); | ||
const [user, setUser] = useState<WebUser>(); | ||
|
||
// 1. If we stored a preference, use that | ||
// 2. If a user was loaded, collapse unless they're an admin | ||
// 3. Otherwise, don't collapse (we're in loading state, so assume a Codecademite) | ||
const defaultCollapsed = preference | ||
? JSON.parse(preference) | ||
: user | ||
? !user.roles.admin | ||
: false; | ||
|
||
const savePreference = (newPreference: boolean) => { | ||
const preferenceValue = JSON.stringify(newPreference); | ||
localStorage.setItem(storageKey, preferenceValue); | ||
setPreference(preferenceValue); | ||
}; | ||
|
||
useEffect(() => { | ||
if (preference) { | ||
return; | ||
} | ||
|
||
if (user) { | ||
savePreference(defaultCollapsed); | ||
return; | ||
} | ||
|
||
const abortController = new AbortController(); | ||
|
||
fetch('https://codecademy.com/users/web', { | ||
signal: abortController.signal, | ||
}) | ||
.then(async (response) => setUser(await response.json())) | ||
.catch(console.warn.bind(console, 'Error loading /users/web:')); | ||
|
||
return () => abortController.abort(); | ||
}, [user]); | ||
|
||
return { defaultCollapsed, savePreference }; | ||
}; |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pending storybookjs/addon-designs#216 and/or my ability to run this all locally.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Now that storybookjs/addon-designs#217 is in, once Gamut is updated to the latest Storybook then we can get this working!