Control panel for relations #3382

ksuess · 2022-05-22T15:17:49Z

Inspect relations
Edit relations
Add relations to arbitrary targets
Batch edit relations
Second tab with actions to fix broken relations.

TODO

Inspect and modify relations

Fix relations

Nice to have

? Filter by target: content type, review state, …

netlify · 2022-05-22T15:17:54Z

✅ Deploy Preview for volto canceled.

Name	Link
🔨 Latest commit	`7427657`
🔍 Latest deploy log	https://app.netlify.com/sites/volto/deploys/646c7d1fcbaf530008e06fe5

cypress · 2022-05-22T15:34:51Z

Passing run #5258 ↗︎

0	493	20	0	0

Details:

Update info on required plone.api version to edit relations
Project: Volto	Commit: `74276575d1`
Status: Passed	Duration: 15:17 💡
Started: May 23, 2023 8:48 AM	Ended: May 23, 2023 9:03 AM

_{This comment has been generated by cypress-bot as a result of this
project's GitHub integration settings.}

pbauer · 2022-05-24T07:37:19Z

I like the ability to filter by source and target.

But I don't really understand how the output in the screenshot should work. When relations always point from one content item to another content what is then "Chassis" etc?
I would prefer to duplicate the same UI as it is used in classic with links to source and to target. Or change the classic UI as well if there is better proposal. So far in classic inspecting looks like this:

ksuess · 2022-05-24T07:56:38Z

A binary relation is a subset of the cartesian product of source set and target set. This UI provides this cartesian product as a matrix with checkboxes with event handlers to add or delete a relation.
The event handler adds or delete a relation element and gives a confirmation with a toast.
Apart from this, batch editing is possible via the checkbox row on top: check 'Chassis' and all displayed sources (filter by search field or filter by filter on the right side) get a relation to 'Chassis'.

The example above shows that 'Light system' has relation 'comprisescomponentpart' to ['Chassis', 'Electronics','Navigation System']
'Navigation System' has one relation of type 'comprisescomponentpart': the one to 'Electronics'

erral · 2022-06-08T15:04:49Z

does this PR add an action to get the relations of a given object? That would be useful too.

ksuess · 2022-06-08T16:04:01Z

does this PR add an action to get the relations of a given object? That would be useful too.

you mean,
show all relations, no matter which type, of an object?
Sounds interesting! I'll add it to the TODOs above.

erral · 2022-06-08T16:35:10Z

Yes I mean exactly that.

Nowadays when we have a relation field in an object, to be able to get the related objects, we index the UID of the objects and then query the catalog to get that information. If an action is available, we can use that action that under the hood calls this endpoint and this way getting the related items could be easier.

It could have several parameters to get the backreleations and also the name of the relation to query.

ksuess · 2022-06-08T17:45:24Z

Oh my, now I get it, you mean a Volto action to fetch the relations!
@pbauer started working on endpoints for relations in general and the relations controlpanel.
In this PR I provide (will provide) Volto actions for relations in general and the relations control panel, which will attack these endpoints. So these actions can be taken for whatever you want to do with relations in Volto. How the actions will look like (and are already drafted here) with parameters relation name/type, backrelation, etc can be seen in Philips elaborated documentation for the future endpoints on the backend side: [will paste the link later. Netlify preview of PRs needs to be fixed]

erral · 2022-06-08T18:06:08Z

Nice. I saw both the actions to get all relations and the plone.restapi endpoint documentation for it and that's why I asked about the context-relation action, I thought that everything was going to be here 😄

avoinea · 2022-09-22T16:02:11Z

@ksuess @pbauer This PR needs some love :)

ksuess · 2022-11-08T05:41:41Z

I am prepared. Now I need the plone.restapi endpoint please, @pbauer.
plone/plone.restapi#1432 (comment)
No endpoint on context, but one single endpoint /@relations on portal root.
@relations deals with the source/target/relation parameters.

Co-authored-by: Katja Süss <k.suess@rohberg.ch>

…bels and toggle sticky.

… '-'. Labels and toggle sticky.

… relations-control-panel

ksuess · 2023-05-23T09:06:02Z

UI recomendations are turned into code. Tests are green. Let's review!

* master: Release changelog for 16.20.7 (#4816) Release 17.0.0-alpha.8 Add supported languages (#4811) Fix html tag lang attribute in SSR (#4803) Finnish translation forwardport (#4084) (#4810) Control panel for relations (#3382) Add guard in case of malformed blocks are present (at least id and title should be present) (#4802) fixed the issue #4660 - shouldn't use a hook like function name for a variable (#4693) Fix HMR of @plone/volto (#4799)

* master: (26 commits) Update Brazilian Portuguese translations (Fixes #4853) Convert header class to function (#4767) Use a Container from the registry in the Form component and fallback to the Semantic UI one (#4849) Display password validation error if available; update minimum password length (#4801) Do not break requires validation on number fields with value 0 (#4841) Search Block: Add support for advanced facets that are displayed on demand (#4784) Release 17.0.0-alpha.9 Fix navigation sections in 404 pages (#4836) fix special characters in request urls (#4825) Fix block is undefined in StyleWrapper helper when building classnames (#4827) Fix glossary warning due to lack of empty line before a term (#4820) Release changelog for 16.20.7 (#4816) Release 17.0.0-alpha.8 Add supported languages (#4811) Fix html tag lang attribute in SSR (#4803) Finnish translation forwardport (#4084) (#4810) Control panel for relations (#3382) Add guard in case of malformed blocks are present (at least id and title should be present) (#4802) fixed the issue #4660 - shouldn't use a hook like function name for a variable (#4693) Fix HMR of @plone/volto (#4799) ...

tisto · 2024-02-12T18:49:32Z

@ksuess I am currently writing the official roadmap for Plone 6.x. I am adding a link to the documentation for every PLIP. Do we have any kind of documentation for the relations control panel?

I'd also like to give people proper credit. Did anyone help you with this or did you work on this on your own?

stevepiercy · 2024-02-13T00:45:10Z

@ksuess @tisto I think this is the User Manual for it. Finding links and references to the current page.

There's also developer docs:

I hope that captured all of them. This was a huge effort!

ksuess · 2024-02-15T10:45:32Z

@ksuess I am currently writing the official roadmap for Plone 6.x. I am adding a link to the documentation for every PLIP. Do we have any kind of documentation for the relations control panel?

No, control panels are not documented.
The relations control panel has a superb user experience ;-) and is therefore self-explaining.

I'd also like to give people proper credit. Did anyone help you with this or did you work on this on your own?

The relations control panel is my work.

arky requested a review from sneridagh May 23, 2022 03:45

nileshgulia1 mentioned this pull request May 23, 2022

RelationList Widget #3355

Closed

ksuess modified the milestones: 16.x.x, Plone 6.0 Jun 5, 2022

sneridagh removed this from the Plone 6.0 milestone Oct 1, 2022

ksuess force-pushed the relations-control-panel branch from be26dc2 to 62b38b3 Compare October 16, 2022 14:01

ksuess force-pushed the relations-control-panel branch from 08a8403 to 0a49c30 Compare October 30, 2022 10:00

ksuess self-assigned this Feb 2, 2023

ksuess added 7 commits March 19, 2023 13:08

Control panel for relations. First draft.

30cdf88

Small fixes for demo 'relations matrix'

ac7a5bb

Control panel for relations. First draft.

fc34726

Small fixes for demo 'relations matrix'

0bbfa93

Relations cp: show number of relations.

e5b79c7

Fix toast warning

854d00a

Relations cp: two tabs: inspect and fix

c96d0cf

danalvrz mentioned this pull request May 20, 2023

UI recommendation for the relation control panel #4789

Closed

6 tasks

danalvrz force-pushed the relations-control-panel branch from 211209f to 3ddd59c Compare May 20, 2023 16:12

ksuess and others added 4 commits May 21, 2023 08:25

Merge branch 'master' into relations-control-panel

c8fc8a4

Get path with ObjectBrowser widget

615aa3d

Remove unused imports

d02c321

Update control panel layout (#4794)

7f41f30

Co-authored-by: Katja Süss <k.suess@rohberg.ch>

ksuess mentioned this pull request May 22, 2023

Create relation only if there is no existing one with same … plone/plone.api#507

Merged

ksuess added 9 commits May 23, 2023 09:53

Delete multiple relations: Checkbox toggle instead of '+' and '-'. La…

0bb843b

…bels and toggle sticky.

Delete multiple group memberships: Checkbox toggle instead of '+' and…

4c6c94f

… '-'. Labels and toggle sticky.

prettier

5c30066

Merge branch 'master' into relations-control-panel

13b4803

Fix 'Duplicate key 'pane' '

8ce0c2a

Remove unused import

1563dc5

Merge branch 'relations-control-panel' of github.com:plone/volto into…

dbcb5f1

… relations-control-panel

Fix acceptance tests

0f4f91b

Update info on required plone.api version to edit relations

7427657

sneridagh added the 24 status: ready label May 23, 2023

ksuess merged commit 4453774 into master May 23, 2023

ksuess deleted the relations-control-panel branch May 23, 2023 21:59

ksuess removed the 24 status: ready label Oct 6, 2023

davisagli mentioned this pull request Oct 6, 2023

Add note in release notes for Volto 17 final #5281

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Control panel for relations #3382

Control panel for relations #3382

ksuess commented May 22, 2022 •

edited

Loading

netlify bot commented May 22, 2022 •

edited

Loading

cypress bot commented May 22, 2022 •

edited

Loading

pbauer commented May 24, 2022

ksuess commented May 24, 2022

erral commented Jun 8, 2022

ksuess commented Jun 8, 2022

erral commented Jun 8, 2022 •

edited

Loading

ksuess commented Jun 8, 2022 •

edited

Loading

erral commented Jun 8, 2022

avoinea commented Sep 22, 2022

ksuess commented Nov 8, 2022

ksuess commented May 23, 2023

tisto commented Feb 12, 2024

stevepiercy commented Feb 13, 2024

ksuess commented Feb 15, 2024

Control panel for relations #3382

Control panel for relations #3382

Conversation

ksuess commented May 22, 2022 • edited Loading

netlify bot commented May 22, 2022 • edited Loading

✅ Deploy Preview for volto canceled.

cypress bot commented May 22, 2022 • edited Loading

Passing run #5258 ↗︎

pbauer commented May 24, 2022

ksuess commented May 24, 2022

erral commented Jun 8, 2022

ksuess commented Jun 8, 2022

erral commented Jun 8, 2022 • edited Loading

ksuess commented Jun 8, 2022 • edited Loading

erral commented Jun 8, 2022

avoinea commented Sep 22, 2022

ksuess commented Nov 8, 2022

ksuess commented May 23, 2023

tisto commented Feb 12, 2024

stevepiercy commented Feb 13, 2024

ksuess commented Feb 15, 2024

ksuess commented May 22, 2022 •

edited

Loading

netlify bot commented May 22, 2022 •

edited

Loading

cypress bot commented May 22, 2022 •

edited

Loading

erral commented Jun 8, 2022 •

edited

Loading

ksuess commented Jun 8, 2022 •

edited

Loading