dons20/steam-review-editor

Editor Update v1

dons20 opened this issue · 5 comments

This issue will track the main features being planned for the update. This list is by no means exhaustive, but should cover the main features/bugs to be resolved before release, including #2.

The existing site is outdated and being redone in React. The editor tool is also being changed due to difficulties in implementing certain community-desired features, namely tables.

  • Website design redone
  • Updated existing dependencies
  • Implemented toolbar with all official text formatting options
    • Enabled table functionality
    • Implemented [img] tags
    • Added new widgets (preview only since they're just links)
      • YouTube
      • Steam Store
      • Steam Community
  • Sync toolbar options with editor behaviour
  • Added Review preview
  • Added Raw markup preview
  • Enabled markup paste support
  • Responsive editor refactoring

Editor Optimization - Removing this as a goal for v1.

Minimum target will be under 5s load time on average device.

Early preview of editor revamp. Overall appearance has been designed to be a lot more readable and similar to Steam's own color scheme, font styles and graphics.

SREProgress

Table and image functionality being worked on.

Because of the dynamic nature of React and Create-React-App, the site will be hosted on netlify which can automate the builds easily.

Current development domain (live): https://steam-review-editor.netlify.com

As of now, all core editor features are in place, though I need to extend the table functions to have more specific control over add/delete rows/columns. Will potentially use the slate-hovering-menu.

Note: Images don't show up in previews below due to localhost CORS blocking. Should work fine in live editor.

SREProgress-editor-all-blocks

SREProgress-all-blocks

Back on the rework train, it seems that the formatting page was updated at some point with new widgets. Functionally, they are only just links, but it may be worth creating toolbar options for them. For v1 of the rework, I'll just allow the store preview to display them in a special way without adding any new toolbar options.

Reference: https://steamcommunity.com/comment/Recommendation/formattinghelp

With update 0.50+ of the slate editor, much of the functionality has been rewritten and overall improved in terms of performance and code readability. This has led to some of the editor features breaking, such as tables.

I've managed to migrate/refactor most of the code to support this new editor, and make many notable improvements. Table functionality is now again high priority along with both serializers (which should be a bit easier to implement thanks to the update).

Also worth noting that there is another free editor platform worth looking into for a performance comparison. Will try experimenting with it sometime after v1 is released.

Current look at site+editor:
image

Table functionality is notably tricker to get right on the UI side. Will need to build a good grid selector for the dropdown menu for simpler, easy tables. However I'll stick to custom inputs for now
image