-
Notifications
You must be signed in to change notification settings - Fork 449
Add interactive Solidity tutorial workbench #3241
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
Draft
douglance
wants to merge
3
commits into
master
Choose a base branch
from
dl/interactive-solidity-tutorial
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
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.
Draft
Changes from all 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
805 changes: 8 additions & 797 deletions
805
docs/build-decentralized-apps/01-quickstart-solidity-remix.mdx
Large diffs are not rendered by default.
Oops, something went wrong.
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
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
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
151 changes: 151 additions & 0 deletions
151
src/components/InteractiveTutorials/CodeWalkthrough.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,151 @@ | ||
| import React, { useMemo, useState } from 'react'; | ||
| import clsx from 'clsx'; | ||
| import { usePrismTheme } from '@docusaurus/theme-common'; | ||
| import Highlight, { defaultProps, Language } from 'prism-react-renderer'; | ||
| import { parseCodeTitle, parseCodeWalkthrough } from './codeWalkthroughParser'; | ||
| import styles from './styles.module.css'; | ||
|
|
||
| type Props = { | ||
| children: string; | ||
| className?: string; | ||
| language?: string; | ||
| metastring?: string; | ||
| title?: string; | ||
| }; | ||
|
|
||
| function normalizeLanguage(language?: string, className?: string): string { | ||
| const fromClassName = className?.match(/language-([^\s]+)/)?.[1]; | ||
| return (language || fromClassName || 'text').toLowerCase(); | ||
| } | ||
|
|
||
| function resolveHighlightLanguage(language: string): string { | ||
| if (defaultProps.Prism.languages[language]) return language; | ||
| if (language === 'solidity' || language === 'rust') return 'clike'; | ||
| if (language === 'shell' || language === 'sh') return 'bash'; | ||
| return 'text'; | ||
| } | ||
|
|
||
| function isActiveLine(lineNumber: number, startLine: number, endLine: number): boolean { | ||
| return lineNumber >= startLine && lineNumber <= endLine; | ||
| } | ||
|
|
||
| export function CodeWalkthrough({ | ||
| children, | ||
| className, | ||
| language: languageProp, | ||
| metastring, | ||
| title, | ||
| }: Props) { | ||
| const parsed = useMemo(() => parseCodeWalkthrough(children), [children]); | ||
| const language = normalizeLanguage(languageProp, className); | ||
| const highlightLanguage = resolveHighlightLanguage(language); | ||
| const prismTheme = usePrismTheme(); | ||
| const [activeIndex, setActiveIndex] = useState(0); | ||
| const activeStep = parsed.steps[activeIndex]; | ||
| const resolvedTitle = parseCodeTitle(metastring, title); | ||
|
|
||
| const copyCode = async () => { | ||
| if (typeof navigator === 'undefined' || !navigator.clipboard) return; | ||
| await navigator.clipboard.writeText(parsed.code); | ||
| }; | ||
|
|
||
| if (parsed.steps.length === 0) { | ||
| return ( | ||
| <pre className={className}> | ||
| <code>{children}</code> | ||
| </pre> | ||
| ); | ||
| } | ||
|
|
||
| return ( | ||
| <div className={styles.codeWalkthrough}> | ||
| <div className={styles.walkthroughCodePane}> | ||
| <div className={styles.walkthroughCodeHeader}> | ||
| <span>{resolvedTitle || language}</span> | ||
| <button type="button" onClick={copyCode} className={styles.secondaryButton}> | ||
| Copy | ||
| </button> | ||
| </div> | ||
| <Highlight | ||
| Prism={defaultProps.Prism} | ||
| theme={prismTheme} | ||
| code={parsed.code} | ||
| language={highlightLanguage as Language} | ||
| > | ||
| {({ className: highlightClassName, style, tokens, getLineProps, getTokenProps }) => ( | ||
| <pre | ||
| className={clsx(highlightClassName, styles.walkthroughPre, 'thin-scrollbar')} | ||
| style={style} | ||
| tabIndex={0} | ||
| > | ||
| <code> | ||
| {tokens.map((line, index) => { | ||
| const lineNumber = index + 1; | ||
| const lineProps = getLineProps({ line }); | ||
| const { key: lineKey, ...linePropsWithoutKey } = lineProps; | ||
| return ( | ||
| <span | ||
| key={lineKey || index} | ||
| {...linePropsWithoutKey} | ||
| className={clsx( | ||
| lineProps.className, | ||
| styles.walkthroughLine, | ||
| activeStep && | ||
| isActiveLine(lineNumber, activeStep.startLine, activeStep.endLine) && | ||
| styles.walkthroughLineActive, | ||
| )} | ||
| > | ||
| <span className={styles.walkthroughLineNumber}>{lineNumber}</span> | ||
| <span className={styles.walkthroughLineContent}> | ||
| {line.map((token, key) => { | ||
| const tokenProps = getTokenProps({ token }); | ||
| const { key: tokenKey, ...tokenPropsWithoutKey } = tokenProps; | ||
|
|
||
| return <span key={tokenKey || key} {...tokenPropsWithoutKey} />; | ||
| })} | ||
| </span> | ||
| </span> | ||
| ); | ||
| })} | ||
| </code> | ||
| </pre> | ||
| )} | ||
| </Highlight> | ||
| </div> | ||
| <div className={styles.walkthroughSteps}> | ||
| {parsed.steps.map((step, index) => ( | ||
| <button | ||
| key={step.id} | ||
| type="button" | ||
| className={clsx(styles.walkthroughStep, index === activeIndex && styles.activeStep)} | ||
| onClick={() => setActiveIndex(index)} | ||
| > | ||
| <span className={styles.stepKicker}> | ||
| {index + 1} / {parsed.steps.length} | ||
| </span> | ||
| <span className={styles.stepTitle}>{step.title}</span> | ||
| {step.body && <span className={styles.stepBody}>{step.body}</span>} | ||
| </button> | ||
| ))} | ||
| <div className={styles.walkthroughControls}> | ||
| <button | ||
| type="button" | ||
| className={styles.secondaryButton} | ||
| disabled={activeIndex === 0} | ||
| onClick={() => setActiveIndex((value) => Math.max(0, value - 1))} | ||
| > | ||
| Previous | ||
| </button> | ||
| <button | ||
| type="button" | ||
| className={styles.primaryButton} | ||
| disabled={activeIndex === parsed.steps.length - 1} | ||
| onClick={() => setActiveIndex((value) => Math.min(parsed.steps.length - 1, value + 1))} | ||
| > | ||
| Next | ||
| </button> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ); | ||
| } |
23 changes: 23 additions & 0 deletions
23
src/components/InteractiveTutorials/InteractiveTutorialShell.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,23 @@ | ||
| import React, { ReactNode, useEffect } from 'react'; | ||
| import styles from './styles.module.css'; | ||
|
|
||
| type Props = { | ||
| children: ReactNode; | ||
| estimatedTime?: string; | ||
| tutorialKind?: string; | ||
| }; | ||
|
|
||
| export function InteractiveTutorialShell({ children }: Props) { | ||
| useEffect(() => { | ||
| document.body.classList.add('interactive-tutorial-page'); | ||
| return () => document.body.classList.remove('interactive-tutorial-page'); | ||
| }, []); | ||
|
|
||
| return ( | ||
| <div className={styles.tutorialShell}> | ||
| <div data-interactive-tutorial-content className={styles.tutorialContent}> | ||
| {children} | ||
| </div> | ||
| </div> | ||
| ); | ||
| } |
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.
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.