[FEATURE] A Repeatable Custom Field by roland-d · Pull Request #20243 · joomla/joomla-cms

roland-d · 2018-04-26T17:04:34Z

Summary of Changes

This pull request adds a new custom field to the core of Joomla. This custom field is called Repeatable because it allows users to enter a repeatable list of items which in turn are by default shown as a list. With a template override you can do a whole lot of other things with this.

Testing Instructions

Installation

Copy all the files to their respective location in your site
Go to Extensions -> Manage -> Discover
In the list find Fields - Repeatable
Select this plugin
Click on Install
Go to Extensions -> Plugins
Filter the list on repeat
Select this plugin
Click Enable

Usage

Go to Content -> Fields
Click New
Give the Custom Field a Title of Marbles
As Type select Repeatable (repeatable)
At the bottom click on the green + to add a new field
Enter the name of the field Size
Select a type of field Text
Click again on the green +
Enter the name of the field Description
Select a type of field Text Area
Save the custom field and it looks like this:
Close the custom field
Click on Articles
Click on New
Give the Article a Title of All about marbles
Click on the Fields tab
Click on the green + sign to add a new line
Enter the text Small
Enter the description I want to make this marble grow
Click on the green + sign to add a new line
Enter the text Medium
Enter the description I have been growing this for a while
Click on the green + sign to add a new line
Enter the text Large
Enter the description It is as big as it gets
Your table now looks like this:
Save and close the article
Now view the article on the site
Your article should look like this:

There you have a it. Users can now create their own lists. If you are creative, you can use it to make tables or other kinds of lists.

Feedback

Let me know if this is something to be considered for core. If not, I will just close this request.

brianteeman · 2018-04-26T17:50:41Z

What are the advantages/differences over this field and the existing list field?

brianteeman · 2018-04-26T17:54:49Z

As its a new core plugin it needs to be added to the list in libraries/src/Extension/ExtensionHelper.php

Septdir · 2018-04-26T18:00:01Z

@roland-d Why do not you want to make a separate plugin and add it to JED ?

The field looks quite useful and will probably be in demand

Why do you need to add it to the core ?

roland-d · 2018-04-26T18:16:05Z

@brianteeman The distinct difference between these two is that with list you need to create the list when you create the custom field and is shown as select list to the end user. Displaylist allows the end user to create a list rather than make a selection. I hope that explains it.

@Septdir I don't want to maintain an extension on the JED. The field seems useful enough for the community, so I figured I share it.

laoneo · 2018-04-26T18:22:46Z

As we do have a list already, I would rather see a new function in core to define a default layout for the field and provide different layouts for the same field type. For the list it would mean to add a new file here like /plugins/fields/list/tmpl/list_ul.php and then provide these layouts as option in the field. What do you guys think?

brianteeman · 2018-04-26T18:24:31Z

thanks @roland-d makes sense now - which it should have done because the name is perfect - sorry

brianteeman · 2018-04-26T18:26:21Z

@laoneo something like
display as select/ul/ol/ etc?

laoneo · 2018-04-26T18:27:49Z

Or like what we have as layouts in modules and views.

roland-d · 2018-04-26T18:41:31Z

@laoneo I thought of adding options to select which layout it would have but for new decided against it because the output is generally styled via a template anyway. So I figured, why add even more options.

Quy · 2018-04-26T19:20:13Z

plugins/fields/displaylist/params/displaylist.xml

+					type="text"
+					icon="list"
+					label="PLG_FIELDS_DISPLAYLIST_PARAMS_LIST_NAME_LABEL"
+					description="PLG_FIELDS_DISPLAYLIST_PARAMS_LIST_NAME_DESC"


Reduce by 1 indent.
Sort in this order: name, type, label and description

brianteeman · 2018-04-26T19:23:03Z

@laoneo I thought of adding options to select which layout it would have but for new decided against it because the output is generally styled via a template anyway. So I figured, why add even more options.

@roland-d I think he meant not to add this new field but to add this as a layout to the current select list field

Quy · 2018-04-26T19:25:11Z

administrator/language/en-GB/en-GB.plg_fields_displaylist.ini

+; Note : All ini files need to be saved as UTF-8
+
+PLG_FIELDS_DISPLAYLIST="Fields - Display List"
+PLG_FIELDS_DISPLAYLIST_LABEL="Display List (%s)"


Not utilized.

@Quy Yes this is utilized. This string is used in the list where you select the field when creating a new custom field.

roland-d · 2018-04-26T19:28:24Z

@brianteeman Ok, if that is what he meant than that would be a feature based on the existing list field and serves a different purpose.

Quy · 2018-04-26T19:32:53Z

plugins/fields/displaylist/params/displaylist.xml

+				description="PLG_FIELDS_DISPLAYLIST_PARAMS_LIST_NAME_DESC"
+				icon="list"
+				multiple="true"
+			>


Change this to /> and delete </field>.

laoneo · 2018-04-26T19:33:54Z

Whats the difference of this plugin to the list field? Only the layout or not? The rest is more or less the same.

roland-d · 2018-04-26T19:42:08Z

@laoneo Apparently my two tries so far have failed to make clear what this plugin does different so going to give it another try. It is not the layout, otherwise I would have added that as an option to the list.

Here is an image to show you the difference:

The existing List is a dropdown, the new Display List allows the one consuming the article to enter a list by themselves rather than having to choose from a fixed list. This can be a usergroup that has no access to maintain the custom fields but has access to create articles. To me this is a distinct difference between these two fields.

AndyGaskell · 2018-04-26T19:43:47Z

I think this would be nice, and a feature that a lot of folk would find useful.
I do agree with @laoneo though, there is quite a big overlap with the current list item.

Perhaps an addition to the existing list plugin, with an option of choosing tmpl output. So, perhaps to go with the list.php we could add a ul.php and a li.php, and a way of choosing the display when editing the list, as per template overrides.

brianteeman · 2018-04-26T19:45:41Z

@roland-d i get it

ot2sen · 2018-05-19T09:05:34Z

@roland-d yes, the read-only extra removed confusion. Works well.
And even if you can hide the read-only fields in options settings it is good that it now also appear as read-only when it is.

yvesh · 2018-05-19T13:59:14Z

I have tested this item ✅ successfully on 675d0a7

Works as expected!

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/20243.}

Quy · 2018-05-19T14:11:01Z

plugins/fields/repeatable/repeatable.php

-				// Setting the value for the field and the item
-				$model->setFieldValue($field->id, $item->get('id'), $value);
-			}
+			// Setting the value for the field and the item


The comment is the same as below. Intentional?

@Quy Wasn't intentional, cleaned up the code a bit and pushed it

Quy · 2018-05-19T14:47:48Z

administrator/language/en-GB/en-GB.plg_fields_repeatable.ini

+PLG_FIELDS_REPEATABLE_PARAMS_FIELDNAME_TYPE_TEXT="Text"
+PLG_FIELDS_REPEATABLE_PARAMS_FIELDNAME_TYPE_TEXTAREA="Text Area"
+PLG_FIELDS_REPEATABLE_PARAMS_FIELDS_DESC="Add one or more form fields"
+PLG_FIELDS_REPEATABLE_PARAMS_FIELDS_LABEL="Form fields"


Capitalize F in fields.

Quy · 2018-05-19T14:48:46Z

administrator/language/en-GB/en-GB.plg_fields_repeatable.ini

+PLG_FIELDS_REPEATABLE="Fields - Repeatable"
+PLG_FIELDS_REPEATABLE_LABEL="Repeatable (%s)"
+PLG_FIELDS_REPEATABLE_PARAMS_FIELDNAME_NAME_DESC="The name of the field to display in the form"
+PLG_FIELDS_REPEATABLE_PARAMS_FIELDNAME_NAME_LABEL="Fieldname"


How about Field Name or just Name?

Renamed it to Name

Quy · 2018-05-19T15:19:01Z

plugins/fields/repeatable/params/repeatable.xml

+								name="fieldtype"
+								type="list"
+								label="PLG_FIELDS_REPEATABLE_PARAMS_FIELDNAME_TYPE_LABEL"
+								description="PLG_FIELDS__REPEATABLE_PARAMS_FIELDNAME_TYPE_DESC"


Remove the extra underscore in PLG_FIELDS__REPEATABLE.

Are icon and multiple attributes necessary here?

Not needed, removed them.

Quy · 2018-05-19T15:20:33Z

plugins/fields/repeatable/params/repeatable.xml

+								type="text"
+								label="PLG_FIELDS_REPEATABLE_PARAMS_FIELDNAME_NAME_LABEL"
+								description="PLG_FIELDS_REPEATABLE_PARAMS_FIELDNAME_NAME_DESC"
+								icon="list"


Are icon and multiple attributes necessary here?

Not needed, removed them.

Removed obsolete form field settings

ghost · 2018-05-19T15:39:41Z

I have tested this item ✅ successfully on f6542e0

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/20243.}

ghost · 2018-05-19T15:39:53Z

Works as expected. Nice feature!
And unlike Yves, I really liked your clear testing instructions Roland....

ot2sen · 2018-05-19T17:45:33Z

I have tested this item ✅ successfully on e13a749

Still works

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/20243.}

ghost · 2018-05-19T17:54:17Z

Why is only one Test count as successful?

Quy · 2018-05-19T18:03:40Z

Because joomlara tested the commit (f6542e0) before the last commit (e13a749).

roland-d · 2018-05-19T18:12:39Z

With the number of tests this PR has gotten and the last commit being trivial one could say it has had enough tests ;)

Quy · 2018-05-19T18:13:16Z

RTC

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/20243.}

mbabker · 2018-05-19T22:30:56Z

Merged to 3.9 via 327fa65

laoneo · 2018-06-02T16:16:39Z

For the people who are requesting a layout chooser per field, It got merged today by #18571.

coolcat-creations · 2018-06-26T07:32:47Z

Hi there! Is there a way to fix the appereance of the Media field? Is it related to the repeatable field or a separate issue?

roland-d · 2018-06-26T07:37:50Z

Hello, this is a separate issue. The styling just doesn't fit.

coolcat-creations · 2018-06-26T07:46:27Z

Sorry for the late testing... But if you use 2 editor fields with JCE you can't type in into the second editor field. I know it's not core related (With TinyMCE everything works fine) but maybe something that can be still fixed?

coolcat-creations · 2018-06-26T07:50:06Z

Created the issue and will post the JCE one also towards JCE ;)

laoneo · 2018-06-26T09:35:06Z

I'm going to lock this one. If there are followup issues, please open a new issue or pull request. Thanks for understanding.

roland-d added 3 commits April 26, 2018 18:39

Display List Custom Field

708052f

Updated language files

9272a5a

Add missing language string

a13022b

roland-d added the Feature label Apr 26, 2018

roland-d added this to the Joomla 3.9.0 milestone Apr 26, 2018

joomla-cms-bot added Language Change This is for Translators PR-3.9-dev labels Apr 26, 2018

Fixed spaces CS

706c045

Add plugin to list of extensions

2670b07

Quy reviewed Apr 26, 2018

View reviewed changes

roland-d added 2 commits April 26, 2018 21:26

Reduce indent by 1

f9a5cf8

Fixed field order

05740a2

Quy reviewed Apr 26, 2018

View reviewed changes

Change closing tag

9cd627d

Add early return

675d0a7

Quy reviewed May 19, 2018

View reviewed changes

Code cleanup

f6542e0

Quy reviewed May 19, 2018

View reviewed changes

Language update

e13a749

Removed obsolete form field settings

joomla-cms-bot removed this from the Joomla 3.10.0 milestone May 19, 2018

joomla-cms-bot added the RTC This Pull Request is Ready To Commit label May 19, 2018

joomla-cms-bot removed the RTC This Pull Request is Ready To Commit label May 19, 2018

zero-24 mentioned this pull request Jun 3, 2018

[3.9] [FEATURE] A Repeatable Custom Field joomlagerman/joomla#424

Closed

roland-d deleted the feature/custom-list-input-field branch June 3, 2018 19:16

joomla locked as resolved and limited conversation to collaborators Jun 26, 2018

Uh oh!

Conversation

roland-d commented Apr 26, 2018 • edited by joomla-cms-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of Changes

Testing Instructions

Installation

Usage

Feedback

Uh oh!

brianteeman commented Apr 26, 2018

Uh oh!

brianteeman commented Apr 26, 2018

Uh oh!

Septdir commented Apr 26, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

roland-d commented Apr 26, 2018

Uh oh!

laoneo commented Apr 26, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

brianteeman commented Apr 26, 2018

Uh oh!

brianteeman commented Apr 26, 2018

Uh oh!

laoneo commented Apr 26, 2018

Uh oh!

roland-d commented Apr 26, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

brianteeman commented Apr 26, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

roland-d commented Apr 26, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

laoneo commented Apr 26, 2018

Uh oh!

roland-d commented Apr 26, 2018

Uh oh!

AndyGaskell commented Apr 26, 2018

Uh oh!

brianteeman commented Apr 26, 2018

Uh oh!

ot2sen commented May 19, 2018

Uh oh!

yvesh commented May 19, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Quy May 19, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ghost commented May 19, 2018

roland-d commented Apr 26, 2018 •

edited by joomla-cms-bot

Loading

Septdir commented Apr 26, 2018 •

edited

Loading

laoneo commented Apr 26, 2018 •

edited

Loading

yvesh commented May 19, 2018 •

edited

Loading

Quy May 19, 2018 •

edited

Loading