RFC: Move Sitegeist.Archaeopteryx link editor to the core

daniellienert · August 31, 2022, 12:17pm

Hi all!

You might have heard of https://github.com/sitegeist/Sitegeist.Archaeopteryx which is a mighty link editor and a great addition to the current slick but limited Neos link editor.

We are using the editor in more and more projects and the customers are very happy. Especially on larger sites, it enables the editor to find the correct target document. We are also working on lots of improvements and fixes right now, although its already very solid.

I talked to @Nezaniel and @mficzel and they would be happy to have the feature in the core.

Here are the options and I would like to hear your votes:

Add it as an additional editor to Neos.Ui
Add it as a separate package under the Neos Namespace
Add it as a separate package under the Flowpack Namespace

0 voters

daniellienert · August 31, 2022, 1:00pm

Just found the related issue https://github.com/neos/neos-ui/issues/2669 : )

Marc · September 1, 2022, 5:37am

i would very much like it in the core

Things about Code: Hooks and Functional Components vs what we have currently
The Link Editor’s code comes with more modern react functional components and also hooks (via an adaptation layer).

Hooks and FC are not used in the ui currently, we use hoc (the things with the decorators) and class components.

When we keep the adaptation layer of the hooks and move them also in the core we would have two different write forms, but having both options in the ui at the same time could help to migrate eventually all code to functional components with hooks and gives 3rd party authors (you and me ) fancier tools.

Marc · September 23, 2022, 11:03am

I found out that this Editor makes use if rxjs for its own state management see:

github.com

sitegeist/Sitegeist.Archaeopteryx/blob/76ffea7c34b95700beaf13a870085943c514cad9/Neos.Ui/core/src/domain/Editor/Editor.ts

import * as React from 'react';
import {ActionType, getType} from 'typesafe-actions';
import {BehaviorSubject, Subject} from 'rxjs';
import {scan, shareReplay} from 'rxjs/operators';

import {ILink, ILinkOptions} from '../Link';

import * as actions from './EditorAction';

export interface IEditorState {
    enabledLinkOptions: (keyof ILinkOptions)[]
    editorOptions: {
        linkTypes?: Record<string, any | unknown>
    }
    isOpen: boolean
    initialValue:  null | ILink
}

type IEditorResult =
    | {change: true, value: null | ILink}

This file has been truncated. show original

in the ui we would archive this task via redux (and sagas)?.

just mixing this as is into the ui wouldt be clean, i think.

Marc · September 28, 2022, 11:05am

also another point is that the plugin uses a highly modular structure - 7 workspace packages thats a lot in comparison to the whole ui, which for example uses one subpackage for ALL editors.

how can we integrate this highly modular plugin without loosing its structure (i love that its so clean and seperated!)

creative-resort · October 15, 2022, 5:24am

With this editor in the core, it would no more be a missing link editor, but become THE Link Editor, right?
Would it make sense to change the name to just “Linkeditor” within Neos.Ui?

soee · October 27, 2023, 7:31am

I would like to bring back attention to this topic. It would be very, very nice to have it by default in Neos. Maybe after 9.0 release.

mficzel · October 27, 2023, 12:36pm

Yes the editor would be renamed. Question is wether it should replace the current LinkEditor, in that case it should support starting points outside the current site or wether it schould be an alternative with a distinct name. How about LinkDialogEditor

manuelmeister · October 30, 2023, 11:09am

I think it would make sense to have both. As sometimes the use case is just a simple link which should not open a whole dialog.