Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.Sign up
GitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
Adding an alternate layout parameter to custom fields #18571
Pull Request for Issue #18162 .
Summary of Changes
Adds a new parameter "Layout" to custom fields which allows to select a different field layout for the automatic display.
Layout is used as specified
Not possible to choose a different layout
Documentation Changes Required
Since it is a new feature, it has to be documented.
I'm testing it and it does work correctly :) There are a couple of issues to address though:
Also, a question, why is it that a filename cannot have an underscore? So far I've been using underscores for the filenames of my layouts manually used with the Content Plugin and they've been working normally. Not a big deal, just wondering.
Great job again!
Ah true, didn't think of that. My though was to prevent misunderstanding when someones wants to insert a single field manually. I think then the layout doesn't apply (but haven't tested) and that could be confusing.
That is then a lookup folder from JLayouts overriding mechanism itself. Looks indeed like I have to add that one as well. The com_fields one is because that is where the default layout actually is stored.
Yes, it should not. The "Use Default" should cover that. That was my plan. Do you have an override for that in your template (I think I didn't test that case)? Or why did it show up?
Not really a technical reason. I based the formfield on the component layout one. In view layouts, we use underscore in layout files which should not appear in the select list. That allows to have "children" layouts. If you for example look at the article view, you see the
You have a point. Yeah, the layout indeed does not apply when you insert a single field manually. Maybe for clarity we could rename the option to "Automatic Layout", and in the option description, change it to "Choose an alternate layout to be used with Automatic Display or as part of a Field Group."
Unless... we want to actually make it work also for when inserting a single field manually? (if that is even possible). This way, the option could act as "Default/Base Layout", which is always used for that field unless otherwise overridden in the single field via content plugin.
Yeah, figured so... One more folder to add, damn! Haha.
Yeah, I have an override for render.php now in
Gotcha, that makes sense to me too. Good idea/decision
I took another approach. The layout now applies also when you insert a single field
Took care of them as well now.
Sorry for being late to the party, but com_contact needs to be adjusted too https://github.com/joomla/joomla-cms/blob/staging/components/com_contact/layouts/fields/render.php#L70.
1 similar comment
This PR actually wasn't specifically about what you mentioned over there. This PR here added the ability to add and choose a Custom Layout at a FIELD level (so before even knowing what field type it's going to render). (override for: "components/com_fields/layouts/fields/render.php")
What you were proposing is to add and choose an even deeper Custom Layout at a VALUE level for specific field types, where you would be able to specify a layout for individual values for fields that have multiple values (such as list, checkboxes, repeatable) (override for "plugins/fields/list/tmpl/list.php"). Which is not possible right now and was not included in this PR, just so you know.