J5.x:Adding custom fields/Checkboxes Field - Revision history

Konczal: /* Frontend Output of the Checkboxes Custom Field */

2024-02-24T17:37:44Z

Frontend Output of the Checkboxes Custom Field

← Older revision		Revision as of 17:37, 24 February 2024
Line 74:		Line 74:

	Fields are only displayed in the Frontend if you have filled them with data in the article. If it is not a required field, can you forget it?		Fields are only displayed in the Frontend if you have filled them with data in the article. If it is not a required field, can you forget it?

			[[File:j5.x_frontend_checkboxes_field_output-en.png\|Checkboxes Custom Field Frontend Output\|800px]]

	'''Note''' that the output is displayed with a bullet point - this is the default layout and may look different dependent on your template.		'''Note''' that the output is displayed with a bullet point - this is the default layout and may look different dependent on your template.

Konczal: /* Using the field in the Backend */

2024-02-24T17:33:03Z

Using the field in the Backend

← Older revision		Revision as of 17:33, 24 February 2024
Line 58:		Line 58:

	== Using the field in the Backend ==		== Using the field in the Backend ==

			In the Article Editor select the Custom Fields tab to access the Custom Field. In the this example we have a Field Group named '''Aircraft''' that was assigned to the Category ''Aircraft''. As the Article is assigned to the Aircraft category, the Aircraft tab is available that will contain one or more Custom Fields assigned to that Field Group. If you are not using Field Groups look for a tab named '''Fields'''.

			[[File:j5.x_field_group_editor_tab-en.png\|Custom Fields Editor Tab in the Backend\|800px]]

			Once you have selected the tab it will display all the fields you have created. In this example we have Date Visited, as well as the Seating options field we just created. Note the asterisks symbol - it denotes that it is a required field (this is turned off or on in the field options when you create it).

			Click the checkboxes for any options you would like to select. When you have done, save and close the article.

			[[File:j5.x_backend_use_article_custom_field-en.png\|Use Calendar Custom Field in the Backend\|800px]]

	== Frontend Output of the Checkboxes Custom Field ==		== Frontend Output of the Checkboxes Custom Field ==

Konczal: /* Creating the field */

2024-02-24T17:20:14Z

Creating the field

← Older revision		Revision as of 17:20, 24 February 2024
Line 16:		Line 16:

	Before clicking the '''New''' button, check the dropdown list below the New button is set to '''Article''' - this is the default setting for use in the Article view.		Before clicking the '''New''' button, check the dropdown list below the New button is set to '''Article''' - this is the default setting for use in the Article view.

			[[File:j5.x_new_article_custom_field.png\|Access article fields via the sidebar menu\|300px]]

	'''NOTE:''' Although this tutorial covers creating a checkboxes field for use in an article, the following steps are the same if you were creating one for use in the Contacts Component (remember to set the view before clicking new), the Users Component, or any other component which supports custom fields..		'''NOTE:''' Although this tutorial covers creating a checkboxes field for use in an article, the following steps are the same if you were creating one for use in the Contacts Component (remember to set the view before clicking new), the Users Component, or any other component which supports custom fields..
Line 22:		Line 24:

	The Field Editor will open on the '''General''' tab.		The Field Editor will open on the '''General''' tab.

			[[File:j5.x_new_checkboxes_field_general.png\|Editor General Tab\|800px]]

	Enter a '''Title''' This should be specific to the purpose of the new field. Avoid generic titles in case you want to use other calendar fields in other places.		Enter a '''Title''' This should be specific to the purpose of the new field. Avoid generic titles in case you want to use other calendar fields in other places.

Max123kl: incomplete marker set

2023-11-02T11:32:06Z

incomplete marker set

← Older revision		Revision as of 11:32, 2 November 2023
Line 1:		Line 1:
	<noinclude><languages /></noinclude>		<noinclude><languages /></noinclude>
	<noinclude>{{Joomla version\|version=5.x}}</noinclude>		<noinclude>{{Joomla version\|version=5.x}}</noinclude>
	{{Top portal heading\|color=white-bkgd\|icon=magic\|icon-color=#5091cd\|size=3x\|text-color=#333\|title=		{{Top portal heading\|color=white-bkgd\|icon=magic\|icon-color=#5091cd\|size=3x\|text-color=#333\|title=<translate>
	Tutorial<br>Custom Fields - Creating a Checkboxes Field}}		Tutorial<br>Custom Fields - Creating a Checkboxes Field</translate>}}
			{{incomplete}}
			<translate>
	== Introduction ==		== Introduction ==

Line 53:		Line 54:

	== Using the field in the Backend ==		== Using the field in the Backend ==



	== Frontend Output of the Checkboxes Custom Field ==		== Frontend Output of the Checkboxes Custom Field ==
Line 61:		Line 60:

	Fields are only displayed in the Frontend if you have filled them with data in the article. If it is not a required field, can you forget it?		Fields are only displayed in the Frontend if you have filled them with data in the article. If it is not a required field, can you forget it?


	'''Note''' that the output is displayed with a bullet point - this is the default layout and may look different dependent on your template.		'''Note''' that the output is displayed with a bullet point - this is the default layout and may look different dependent on your template.

	It is possible to change the layout and date format by creating a template custom override.		It is possible to change the layout and date format by creating a template custom override.</translate>



	<div class="row">		<div class="row">

Crystalenka at 13:22, 26 August 2023

2023-08-26T13:22:41Z

← Older revision		Revision as of 13:22, 26 August 2023
Line 73:		Line 73:
	Next: Calendar Field\|class=expand}}</div>		Next: Calendar Field\|class=expand}}</div>
	<div class="large-6 columns">{{Basic button\|S:MyLanguage/J5.x:Adding_custom_fields/Color_Field\|		<div class="large-6 columns">{{Basic button\|S:MyLanguage/J5.x:Adding_custom_fields/Color_Field\|
	Next: ~~Colour~~ Field\|class=expand}}</div>		Next: Color Field\|class=expand}}</div>
	</div>		</div>

Crystalenka: Created page with " {{Joomla version|version=5.x}} {{Top portal heading|color=white-bkgd|icon=magic|icon-color=#5091cd|size=3x|text-col..."

2023-08-26T13:17:30Z

Created page with "<noinclude><languages /></noinclude> <noinclude>{{Joomla version|version=5.x}}</noinclude> {{Top portal heading|color=white-bkgd|icon=magic|icon-color=#5091cd|size=3x|text-col..."

New page

<noinclude><languages /></noinclude>
<noinclude>{{Joomla version|version=5.x}}</noinclude>
{{Top portal heading|color=white-bkgd|icon=magic|icon-color=#5091cd|size=3x|text-color=#333|title=
Tutorial<br>Custom Fields - Creating a Checkboxes Field}}

== Introduction ==

The Checkboxes Field provides one or more checkbox items which can be selected or deselected. It's useful for creating a consistent list of optional attributes for an item.

== Creating the field ==

We will create a Checkboxes Field for use in our articles.

From the Sidebar Menu in the Backend choose '''Content''' then '''Fields'''.

Before clicking the '''New''' button, check the dropdown list below the New button is set to '''Article''' - this is the default setting for use in the Article view.

'''NOTE:''' Although this tutorial covers creating a checkboxes field for use in an article, the following steps are the same if you were creating one for use in the Contacts Component (remember to set the view before clicking new), the Users Component, or any other component which supports custom fields..

Click '''New'''.

The Field Editor will open on the '''General''' tab.

Enter a '''Title''' This should be specific to the purpose of the new field. Avoid generic titles in case you want to use other calendar fields in other places.

On the '''Type''' field choose '''Checkboxes'''.

The '''Name''' field will be filled in automatically on saving the field, but you can enter a different one. It should be lowercase and separated by hyphens.

The '''Label''' field is automatically set to be the same as the Custom Field Title but you can enter whatever you want. The value you enter is output on the Frontend if you choose to show the Label.

Add a '''Description''' if it will be useful. It is not required.

Set the '''Required''' Field to Yes or No with the toggle button. Setting to Yes will make the field a required one that cannot be skipped.

The '''Only Use In Subform''' field can be set to Yes if you only want the field available as a Subform child field.

The '''Default Value''' field can be set to have certain checkboxes checked when the field is first loaded. To check an item by default, enter the value in this field exactly as it appears in the subform below. To check multiple items, add multiple values separated by commas.

Special options within this field are:

* '''Checkbox Values''': This subform determines what checkboxes are available in an item.
** '''Text''': This is the text which will be displayed both with the checkbox in the edit form, as well as in the front end if it is selected.
** '''Value''': This optional field lets you specify the value of the checkbox, which can be used in the ''Default Value'' option, the ''Showon'' option in other fields, or in layout overrides. This is not displayed to the user or front end.

'''Please note: if you change the value of any checkbox items after the field is used in items, it could result in data loss. Proceed with caution.'''

At this point you have entered sufficient information to create the Custom Field and make it available for use.

== Save the Custom Field ==

Click '''Save & Close''' and the Custom Field is available to use.

== Using the field in the Backend ==

== Frontend Output of the Checkboxes Custom Field ==

In the Frontend, you can see the field as you see in the following image. The option in ''Automatic display'' is responsible for the position of the field and your template is responsible for the layout of the field.

Fields are only displayed in the Frontend if you have filled them with data in the article. If it is not a required field, can you forget it?

'''Note''' that the output is displayed with a bullet point - this is the default layout and may look different dependent on your template.

It is possible to change the layout and date format by creating a template custom override.

<div class="row">
<div class="large-6 columns">{{Basic button|S:MyLanguage/J5.x:Adding_custom_fields/Calendar_Field|
Next: Calendar Field|class=expand}}</div>
<div class="large-6 columns">{{Basic button|S:MyLanguage/J5.x:Adding_custom_fields/Color_Field|
Next: Colour Field|class=expand}}</div>
</div>

<noinclude>
[[Category:Tutorials{{#translation:}}]]
[[Category:Custom Fields{{#translation:}}]]
[[Category:Beginners{{#translation:}}]]
[[Category:Joomla! 5.x{{#translation:}}]]
</noinclude>
<noinclude>[[Category:Needs to be marked for translation]]</noinclude>