Grading comments #162
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,162 @@ | ||
| import { ButtonGroup, Icon, NumericInput, Position } from '@blueprintjs/core' | ||
| import { IconNames } from '@blueprintjs/icons' | ||
| import * as React from 'react' | ||
| import ReactMde, { ReactMdeTypes } from 'react-mde' | ||
| import * as Showdown from 'showdown' | ||
| import { controlButton } from '../../commons' | ||
|
|
||
| type GradingEditorProps = DispatchProps & OwnProps & StateProps | ||
|
|
||
| export type DispatchProps = { | ||
| handleGradingCommentsChange: (s: string) => void | ||
| handleGradingXPChange: (i: number | undefined) => void | ||
| handleGradingInputSave: (s: string, i: number | undefined) => void | ||
| } | ||
|
|
||
| export type OwnProps = { | ||
| maximumXP: number | ||
| } | ||
|
|
||
| export type StateProps = { | ||
| gradingCommentsValue: string | ||
| gradingXP: number | undefined | ||
| } | ||
|
|
||
| /** | ||
| * Keeps track of the current editor state, | ||
| * as well as the XP in the numeric input. | ||
| * | ||
| * XP can be undefined to show the hint text. | ||
| */ | ||
| type State = { | ||
| mdeState: ReactMdeTypes.MdeState | ||
| XPInput: number | undefined | ||
| } | ||
|
|
||
| class GradingEditor extends React.Component<GradingEditorProps, State> { | ||
| private converter: Showdown.Converter | ||
|
|
||
| constructor(props: GradingEditorProps) { | ||
| super(props) | ||
| this.state = { | ||
|
Contributor
Author
There was a problem hiding this comment. Local state is used to keep track of everything here, because the editor already uses it. Upon unmounting, the values are dispatched. |
||
| mdeState: { | ||
| markdown: this.props.gradingCommentsValue | ||
| }, | ||
| XPInput: this.props.gradingXP | ||
| } | ||
| /** | ||
| * The markdown-to-html converter for the editor. | ||
| */ | ||
| this.converter = new Showdown.Converter({ | ||
| tables: true, | ||
| simplifiedAutoLink: true, | ||
| strikethrough: true, | ||
| tasklists: true, | ||
| openLinksInNewWindow: true | ||
| }) | ||
| } | ||
|
|
||
| /** | ||
| * Update the redux state's grading comments value, using the latest | ||
| * value in the local state. | ||
| */ | ||
| public componentWillUnmount() { | ||
| this.props.handleGradingCommentsChange(this.state.mdeState.markdown!) | ||
| this.props.handleGradingXPChange(this.state.XPInput) | ||
| } | ||
|
|
||
| public render() { | ||
| return ( | ||
| <> | ||
| <div className="grading-editor-input-parent"> | ||
| <ButtonGroup fill={true}> | ||
| <NumericInput | ||
| onValueChange={this.onXPInputChange} | ||
| value={this.state.XPInput} | ||
| buttonPosition={Position.LEFT} | ||
| placeholder="XP here" | ||
| min={0} | ||
| max={this.props.maximumXP} | ||
| /> | ||
| {controlButton('Save', IconNames.FLOPPY_DISK, this.onClickSaveButton)} | ||
| </ButtonGroup> | ||
| </div> | ||
| <div className="react-mde-parent"> | ||
| <ReactMde | ||
| buttonContentOptions={{ | ||
| iconProvider: this.blueprintIconProvider | ||
| }} | ||
| layout={'vertical'} | ||
| onChange={this.handleValueChange} | ||
| editorState={this.state.mdeState} | ||
| generateMarkdownPreview={this.generateMarkdownPreview} | ||
| /> | ||
| </div> | ||
| </> | ||
| ) | ||
| } | ||
|
|
||
| /** | ||
| * A custom icons provider. It uses a bulky mapping function | ||
| * defined below. | ||
| * | ||
| * See {@link https://github.com/andrerpena/react-mde} | ||
| */ | ||
| private blueprintIconProvider(name: string) { | ||
| return <Icon icon={faToBlueprintIconMapping(name)} /> | ||
| } | ||
|
|
||
| private onClickSaveButton = () => { | ||
| this.props.handleGradingInputSave(this.state.mdeState.markdown!, this.state.XPInput) | ||
| } | ||
|
|
||
| private onXPInputChange = (newValue: number) => { | ||
| this.setState({ | ||
| ...this.state, | ||
| XPInput: newValue | ||
| }) | ||
| } | ||
|
|
||
| private handleValueChange = (mdeState: ReactMdeTypes.MdeState) => { | ||
| this.setState({ mdeState }) | ||
| } | ||
|
|
||
| private generateMarkdownPreview = (markdown: string) => | ||
| Promise.resolve(this.converter.makeHtml(markdown)) | ||
| } | ||
|
|
||
| /** | ||
| * Maps FontAwesome5 icon names to blueprintjs counterparts. | ||
| * This is to reduce the number of dependencies on icons, and | ||
| * keep a more consistent look. | ||
| */ | ||
| const faToBlueprintIconMapping = (name: string) => { | ||
| switch (name) { | ||
| case 'heading': | ||
| return IconNames.HEADER | ||
| case 'bold': | ||
| return IconNames.BOLD | ||
| case 'italic': | ||
| return IconNames.ITALIC | ||
| case 'strikethrough': | ||
| return IconNames.STRIKETHROUGH | ||
| case 'link': | ||
| return IconNames.LINK | ||
| case 'quote-right': | ||
| return IconNames.CITATION | ||
| case 'code': | ||
| return IconNames.CODE | ||
| case 'image': | ||
| return IconNames.MEDIA | ||
| case 'list-ul': | ||
| return IconNames.PROPERTIES | ||
| case 'list-ol': | ||
| return IconNames.NUMBERED_LIST | ||
| case 'tasks': | ||
| return IconNames.TICK | ||
| default: | ||
| return IconNames.HELP | ||
| } | ||
| } | ||
|
|
||
| export default GradingEditor | ||
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,31 @@ | ||
| import * as React from 'react' | ||
| import { NavLink } from 'react-router-dom' | ||
|
|
||
| import { GradingOverview } from './gradingShape' | ||
|
|
||
| type GradingNavLinkProps = { | ||
| data: GradingOverview | ||
| } | ||
|
|
||
| /** | ||
| * Used to render a link in the table that displays GradingOverviews. | ||
| * This is a fully fledged component (not SFC) by specification in | ||
| * ag-grid. | ||
| * | ||
| * See {@link https://www.ag-grid.com/example-react-dynamic} | ||
| */ | ||
| class GradingNavLink extends React.Component<GradingNavLinkProps, {}> { | ||
| constructor(props: GradingNavLinkProps) { | ||
| super(props) | ||
| } | ||
|
|
||
| public render() { | ||
| return ( | ||
| <NavLink to={`/academy/grading/${this.props.data.submissionId}`} activeClassName="pt-active"> | ||
| {this.props.data.graded ? 'Done' : 'Not Graded'} | ||
| </NavLink> | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| export default GradingNavLink |
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
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.
Should I change this to UPLOAD_GRADING_INPUT instead? It's only use is to call a saga.
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.
I think save is fine