Skip to content

[6.0] Note Custom Field Plugin #45233

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 27 commits into from
Aug 16, 2025
Merged

Conversation

TLWebdesign
Copy link

@TLWebdesign TLWebdesign commented Mar 27, 2025

I've created a Note Custom Field. Based on the Joomla's default Note Form Field Type. This allows users for example to place notes in between custom fields to guide users.

This note only displays in the backend of the website just like the default Note Form Field. It could be made available in front-end if people would desire this.

Summary of Changes

Notes Custom Field added

Testing Instructions

You can discover the extension and then use it in custom fields. It's called note.
Discover it, publish the extension.
Then go to Article -> Custom Fields. Create a new Field of type "Note"

Check that the note is visible in the backend article edit page.

Set option Display Front-end to yes. Then check that the option is also displayed in the front-end article view.

Actual result BEFORE applying this Pull Request

No Note Custom Field available.

Expected result AFTER applying this Pull Request

Note Custom Field available.

Link to documentations

Please select:

  • Documentation link for docs.joomla.org:

  • No documentation changes for docs.joomla.org needed

  • Pull Request link for manual.joomla.org:

  • No documentation changes for manual.joomla.org needed

@joomla-cms-bot joomla-cms-bot added Language Change This is for Translators PR-6.0-dev labels Mar 27, 2025
@QuyTon
Copy link
Contributor

QuyTon commented Apr 4, 2025

Required and Default Value are not applicable so this will cause confusion.
For Show Close Button, I expect the button to not display if set to false.

@QuyTon QuyTon added the Feature label Apr 5, 2025
@TLWebdesign
Copy link
Author

Required and Default Value are not applicable so this will cause confusion. For Show Close Button, I expect the button to not display if set to false.

Hi,

i'm not exactly sure what you mean with "required". I've removed the empty default value on the close form field xml.

The documentation says this about the close button:
close (optional) a value of 'true' (for alerts) or the value for the data-dismiss of the Bootstrap close icon

Wondering if the default should be "true" instead of empty to show the possibility.

@QuyTon
Copy link
Contributor

QuyTon commented Apr 11, 2025

i'm not exactly sure what you mean with "required". I've removed the empty default value on the close form field xml.

45233

The documentation says this about the close button: close (optional) a value of 'true' (for alerts) or the value for the data-dismiss of the Bootstrap close icon

I was expecting it to look like this without the close button.

45233-alert

@TLWebdesign
Copy link
Author

i'm not exactly sure what you mean with "required". I've removed the empty default value on the close form field xml.

45233

The documentation says this about the close button: close (optional) a value of 'true' (for alerts) or the value for the data-dismiss of the Bootstrap close icon

I was expecting it to look like this without the close button.

45233-alert

Those settings are not added by the plugin. Do you know of a custom field that has these settings removed so i could check that?

@exlemor
Copy link

exlemor commented Jun 1, 2025

I have tested this item ✅ successfully on 84c1b7c

Hi Tom, I have successfully tested this.

(1 question, why can't we have this for the User Accounts area as well? :) )


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45233.

@TLWebdesign
Copy link
Author

(1 question, why can't we have this for the User Accounts area as well? :) )

Hi Emmanuel,

With User Accounts area do you mean the website front-end?
Technically there is no reason why we could not allow this. I've created and tested this already but it's not in the PR because it is not a "plain" implementation of the note form field. If maintainers would want this to also be available in front-end of the website then i could add that.

@exlemor
Copy link

exlemor commented Jun 2, 2025

(1 question, why can't we have this for the User Accounts area as well? :) )

Hi Emmanuel,

With User Accounts area do you mean the website front-end? Technically there is no reason why we could not allow this. I've created and tested this already but it's not in the PR because it is not a "plain" implementation of the note form field. If maintainers would want this to also be available in front-end of the website then i could add that.

Hi Tom, no I meant backend actually... I know the backend has Users --> User Notes area but that is not referenced in the user's profile itself which is not so convenient, that's why I liked the idea of this being available in the custom fields for Users that would one could have a notes field inside the user's profile... (vs having to go back and forth between a user's profile and the User Notes area).

@brianteeman
Copy link
Contributor

@exlemor you are comparing apples and pears

@TLWebdesign
Copy link
Author

@exlemor like brian said that is totally different from what this is and does. So then the answer is no not with this PR.

added plg_fields_note in right alphabetical order and updated the ordering of the plg_fields to match
@muhme
Copy link
Contributor

muhme commented Jun 6, 2025

I started testing (and I'm not familar with custom fields). I created a Note custom field with 'notes field description' and 'notes field heading', you see the representation in the screenshots. As mentioned before, some settings like 'Default Value' is unused. 'Automatic Display' is also not used, as there is no content? 'Editable In' works as 'Shown In'. But what hurts me, if I set 'Required' in the custom field, the article is no longer saveable in administrator backend or site frontend, see error message:

screen
Backend-View with error

frontend-edit
Frontend edit view

Shouldn't we disable the options that can't be used and rename ‘Editable In’ to ‘Display In’? And maybe a use case would be helpful. If this is just a header for the following custom field, couldn't this be ¿easier? implemented with CSS in the following custom field? I would like to continue to support testing, thx.

@muhme
Copy link
Contributor

muhme commented Aug 16, 2025

I have tested this item ✅ successfully on 4133982

I was testing the Note field again, same procedure and it is working with not set Heading on frontend (view/edit) and backend the same way.


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45233.

@richard67
Copy link
Member

RTC


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45233.

@joomla-cms-bot joomla-cms-bot added the RTC This Pull Request is Ready To Commit label Aug 16, 2025
@richard67 richard67 removed the RTC This Pull Request is Ready To Commit label Aug 16, 2025
@richard67
Copy link
Member

Back to pending. The update SQL scripts need to be renamed to something newer than 6.0.0-2025-08-02.sql.


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45233.

@richard67
Copy link
Member

@TLWebdesign Could you rename the update SQL scripts to something newer than "6.0.0-2025-08-02.sql", e.g. "6.0.0-2025-08-16.sql? Thanks in advance.

@richard67
Copy link
Member

P.S. If the name of the new update SQL script is not newer than the latest present one when compared with PHP version compare, it will not run when updating e.g. from 6.0.0-alpha3.

@richard67 richard67 added the Updates Requested Indicates that this pull request needs an update from the author and should not be tested. label Aug 16, 2025
Co-authored-by: Richard Fath <[email protected]>
@richard67 richard67 removed the Updates Requested Indicates that this pull request needs an update from the author and should not be tested. label Aug 16, 2025
@richard67
Copy link
Member

RTC


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45233.

@richard67 richard67 added the Updates Requested Indicates that this pull request needs an update from the author and should not be tested. label Aug 16, 2025
@joomla-cms-bot joomla-cms-bot added the RTC This Pull Request is Ready To Commit label Aug 16, 2025
@richard67 richard67 removed the Updates Requested Indicates that this pull request needs an update from the author and should not be tested. label Aug 16, 2025
@Bodge-IT Bodge-IT merged commit 38f3927 into joomla:6.0-dev Aug 16, 2025
30 checks passed
@joomla-cms-bot joomla-cms-bot removed the RTC This Pull Request is Ready To Commit label Aug 16, 2025
@Bodge-IT
Copy link
Contributor

Thanks @TLWebdesign and thanks @muhme & @exlemor for testing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants