Feat/54 add an introduction textarea

[grnd-alt]

• Resolves: Add an introduction textarea #54
• Target version: main

Summary

introduce a description editor at the top similar to Files

Screenshots:

Viewing a Table:

Creating a Table:

Editing a Table:

Checklist

• Code is properly formatted
• Sign-off message is added to all commits
• Tests (unit, integration, api and/or acceptance) are included
• Documentation (manuals or wiki) has been updated or is not required

[juliushaertl]

Very nice, two thoughts that might be worth to discuss with @nextcloud/designers :

• The editor is not collaborative, so maybe we want to make it read only by default with a button to toggle to edit
• From my perspective it would be nicer to left-align as we do it in the files app with the folder description

[enjeck]

@grnd-alt I think we're supposed to have this introduction textarea in both the "Create table" and "Edit table" modals. Similarly to the way we have the "Title".

@juliushaertl said:

The editor is not collaborative, so maybe we want to make it read only by default with a button to toggle to edit

Yes, the editor should be read-only when viewing a table. But we don't need a button to toggle edit, imo. We should handle this in the "Edit table" modal instead.

[jancborchardt]

• The editor is not collaborative, so maybe we want to make it read only by default with a button to toggle to edit
• From my perspective it would be nicer to left-align as we do it in the files app with the folder description

Agree with both of @juliushaertl’s points. Actually a great example of how this could look is the Forms app:

View mode

Edit mode

[grnd-alt]

@jancborchardt
Thanks for you're input about the way it's done in forms.
I've update the screenshots with the new layout. I feel like it could still be improved. It's all quite clustered to the left and the right feels empty. But I don't think we can move the Edit/View/Hide buttons on the same line as the title as they only effect the description editor and not the entire table. I'd propose moving it back to aligning it in the middle (Screenshot Option 2). But if it's better to have it at the left, or you have a different idea I'll happily adapt it.

[jancborchardt]

@grnd-alt nice, thanks for both the suggestions! :)

• A little bit of moving the description can already achieve a lot, like below when the text is left-aligned with the text of the table below (see modified screenshot below)
• The radio button is a bit huge there and not super needed. I would say an "Edit"/"Done" button in the top right like we have in Collectives is better in this case.
• Is "Hide" a requirement? If so, we can do that via a simple collapsing arrow like we do in Collectives too for the "Recent pages" section
• Can we somehow hide the "Show outline" button in view mode, it is not needed here. cc @juliushaertl

[jancborchardt]

Seems good to me! Not 100% sure about the placement of the "Edit" button but there’s so many options that I think just getting it in now is better. :) @juliushaertl?

[juliushaertl]

Small comments, otherwise this looks good 👍

[enjeck]

@jancborchardt I find it very confusing to have an edit button just for the single "description" field. Then a separate button that edits the title in a separate place. Then no way to add a description when creating a table. As a user, I would expect to be able to add a description when creating a table. And to either have a single button to edit everything at once or to be able to inline edit everything. Having a mix feels weird. Maybe it's just me

[jancborchardt]

I find it very confusing to have an edit button just for the single "description" field. Then a separate button that edits the title in a separate place. Then no way to add a description when creating a table. As a user, I would expect to be able to add a description when creating a table. And to either have a single button to edit everything at once or to be able to inline edit everything. Having a mix feels weird. Maybe it's just me

@enjeck yeah you are right – so then should we move the description box editing (and adding) into the modal? And on the tables page we show it read-only, just like we do for the title?

[blizzz]

for the PHP bits :)

[enjeck]

This looks good to me too. Thanks, @grnd-alt

[blizzz]

@juliushaertl your change request is still active