Road to 1.0 -- 1.0 Must-Haves

[skurfuerst]

In this post, I am trying to sketch out the Road to Neos React UI 1.0.0, give estimates, and try to collect everything together.

Definition: Must Have for 1.0.0

How do we decide whether a feature is must-have or not for 1.0.0? Especially for 1.0.0 releases, we often try to cram as much as possible in. That's why for the React UI, we apply the following guidelines.

Issues are a must-have for 1.0.0, iff:

• they are a core feature of the old UI and haven't been ported yet, especially in the area of inspectors & content editing.
• they are an issue appearing on many websites (e.g. if editing broke when applied on inline elements)
• they are a performance problem for larger websites

Issues are NO must-have for 1.0.0, if:

• they just appear anecdotically
• there exist workarounds which are understandable to the normal editor
• minor styling polishing

Main Areas of Work

The following areas are the main areas where work is still needed.

Each point links to the respective issue; where a concept for the
corresponding component is explained:

• P1??Unsure? Do not send full serialized node info for UI updates #647: Do not send full serialized node info for UI updates
• Inspector Editors
  • File Upload Editor #874 file upload editor
  • Asset Links in Link Editor #875 links to assets in Link Editor
  • Asset Editor #876 assets editor
  • P1 After changing inspector property, you are not forced to apply changes #833 After changing inspector property, you are not forced to apply changes
  • "Selected Element" is missing in Inspector #1014 "Selected Element" is missing in Inspector
  • "Change Type" in inspector doesn't handle auto-created child nodes correctly #1037 "Change Type" in inspector doesn't handle auto-created child nodes correctly
• Node Tree
  • Content and Document tree should scroll when moving nodes through drag/drop #866: Content and Document tree should scroll when moving nodes through drag/drop
  • Add extension point for overriding element Rendering in Node Trees #867: Add extension point for overriding element Rendering in Node Trees
• API Requests
  • P1 Show Re-Login Dialog if Session Timed Out #901 show re-login dialog if session timed out to ensure people do not loose content
  • P1 Properly handle exceptions in API requests #841: Properly handle exceptions in API requests
• switch to context identifier from context path - see TASK: Introduce contextIdentifier for nodes neos-development-collection#1614

to validate / retest

If you want to help, you can pick one of these bugs, try to reproduce it, and add some comments/screenshots.

• breaks in the text of a headline NodeType do not show up after publishing #596: breaks in the text of a headline NodeType do not show up after publishing

Confirmed Bugs

These bugs don't carry big conceptual TODOs; they can just be solved.

If you want to help, pick one of these bugs, and try to fix it.

• Dimension Handling

  • If more than one dimension - urls for preview and backend are wrong #697: If more than one dimension - urls for preview and backend are wrong
  • Fatal Error in DimensionSwitcher on dimension with multiple values #755: Fatal Error in DimensionSwitcher on dimension with multiple values

• Rich Text Editor

  • Text aligning options #829: Text aligning options
  • P2 Editables with span tagName behaves strangely when pasting content #834: Editables with span tagName behaves strangely when pasting content
  • Allow to set extra styles on Span and Div elements #865: Allow to set extra styles on Span and Div elements

• General UI

  • Tooltips for buttons #802: Tooltips for buttons
  • UI should scroll to newly inserted content element #1038: UI should scroll to newly inserted content element
  • Not-Inline-Editable overlay is missing #1015: Not-Inline-Editable overlay is missing
  • Dimension switcher should close after selection #1040: Dimension switcher should close after selection
  • PageTree is empty after switching to another dimension #1042: PageTree is empty after switching to another dimension

Done, Reviewed, Merged

• Make Background Color in ContentCanvas configurable #863: Make Background Color in ContentCanvas configurable
• Wrong escaping for title in document tree #719: Wrong escaping for title in document tree
• Nodes in the page tree only show as hidden when they are selected #749: Nodes in the page tree only show as hidden when they are selected
• "Edit / Preview" buttons slides as buttons are clicked #688: "Edit / Preview" buttons slides as buttons are clicked
• Date/Time Picker not saving #577: Inspector Date Time Picker not saving
• Remove <p> <p/> in placeholder #652: Remove <p></p> in placeholders
• Editables with tagName other than div (e.g. span) cause an infinite loop in CKeditor #668: Editables with tagName other than div (e.g. span) cause an infinite loop in CKeditor (Difficult!)
• (ImageEditor) Persisted Aspect ratio is not accurately re-calculated in the Cropper #369: (ImageEditor) Persisted Aspect ratio is not accurately re-calculated in the Cropper
• (ImageEditor) Support locked aspect ratio #370: (ImageEditor) Support locked aspect ratio
• References / Select Editor Redone #691 references editor
  • Link editor doesn't work with external links #683 links to external URLs
  • unstable: reference editor
  • editor data sources
• node tree search
• TASK: Refactor Content initialization and move to separate package #632 (PR): Refactor Content initialization and move to separate package
• P1 FEATURE: Full select editor (with data providers and multiselect support) #764 (PR) Improve SelectEditor / MultiSelectEditor
  • Implement Data Sources in Select Editor #725 implement Data Sources in Select Editor
  • Make MultiSelectBox component searchable #649 Make MultiSelectBox component searchable
• Can't select time in datetime editor #836: Can't select time in Datetime editor
• Mark a new change in the page/content tree #806: Mark a new change in the page/content tree
• P1 Editing URL path segment is not supported #645: Editing URL path segment is not supported
• Copy Pasting Content Collection should be disallowed is it's an auto created child #609: Copy Pasting Content Collection should be disallowed is it's an auto created child
• P1 Inspector tabs that only have views and no editors are hidden. #837: Inspector tabs that only have views and no editors are hidden.
• P1 When switching focused node, inspector becomes blank if the focused nodetype doesn't have that group #826 When switching focused node, inspector becomes blank if the focused nodetype doesn't have that group
• P1 Editing a property from another page causes browser tab to freeze and crash #842: Editing a property from another page causes browser tab to freeze and crash
• P1 Scrolling contentCanvas is a bit weird #835: Scrolling contentCanvas is a bit weird
• Implement Node Type Filtering in Document Tree #862 node tree filter
• Cannot add element to a container child node element #824: Cannot add element to a container child node element
• Pages can be added after main content collection #766: Pages can be added after main content collection
• Inline UI overrides styling of scrollbars inside contentcanvas #831: Inline UI overrides styling of scrollbars inside contentcanvas
• When the canvas is reloaded after applying inspector, it doesn't scroll back to reveal the focused node #815: When the canvas is reloaded after applying inspector, it doesn't scroll back to reveal the focused node
• Cropping an image: Swtich aspect ratio does not work #852: Cropping an image: Swtich aspect ratio does not work
• Make Dropdown menus (like workspace menu) scrollable if they contain lots of content #864: Make Dropdown menus (like workspace menu) scrollable if they contain lots of content
• P1 Discard a newly created document node leads to errors #791: Discard a newly created document node leads to errors
• P1 Node still rendered in guest frame after deletion #794: Node still rendered in guest frame after deletion

Meta: Issue Management Methodology

• The issue Road to 1.0 -- 1.0 Must-Haves #687 is the main meta-issue tracking everything
  to the React Rewrite 1.0.0 release.
• Every issue which is on the must-have list for 1.0.0 must
  have a link back on top like <- must-have for 1.0.0
• All must-haves must be in the milestone must-have for 1.0.0
• We're using Draw.io for diagrams, using "File -> Export as -> URL" and linking the resulting URL.
  This embeds the full diagram source code into the URL, making it self-contained in the issue.

[dimaip]

Basically almost every part of UI needs more detailed work and testing. From styling, to behavior, keyboard navigation etc etc.
Content tree needs to be more synced to the canvas, e.g. scroll to focused node and scroll canvas the other way. Anyways, no need to get too detailed here, we have issues for it.

Also, you keep on adding target workspace selector. :) What's wrong with the current implementation?

[skurfuerst]

I'm closing this meta-issue, as 1.0.0 is released!