The fm:Form_ChannelTree component generates a selectbox, populated with channels from channels in a tree indented format from your project.
This can be used for example to specify a channel in an upload form, or a list of channels and their indented children to pick when creating a gallery.
<fm:Form_ChannelTree name="channel"/>
Name | Required | Default | Description |
---|---|---|---|
class | Optional | The css classname that will be assigned to the actual html form field. Note that a few default classes might be added | |
disabled | Optional | N/A | This will set the html disabled attribute |
hideParent | Optional | false | When displaying the Channel Tree, this will no include the Parent channel in the drop down. |
id | Optional | randomized | The id of the form element. Note that this id will also be used for the 'for' attribute in the <label> component |
label | Optional | N/A | This attribute will be used to generate labels for this component, if it's used within an fm:Form component |
language | Optional | N/A | This specifies which language to use for the display of the form_country dropdown. Choices are:
|
multiple | Optional | N/A | Setting multiple will allow the user to select multiple items in this dropdown. |
name | Required | N/A | The name of the form field. This is how the value will be submitted back to the server |
parentId | Optional | 0 | The id of the parent channel that you want to show the child tree of in the drop down, Defaults to 0, and shows all channels. |
readonly | Optional | N/A | This sets the html readonly attribute and controls if the user can change the value |
required | Optional | 0 | Set required to '1' if you'd like the form validator to check if this form element has a value before submitting |
size | Optional | N/A | The size attribute will be directly passed through to this component and dictates how much items are showing by default. |
style | Optional | The style attribute for the actual form component | |
title | Optional | N/A | Sets the title attribute on the select element. |
truncateAt | Optional | 16 | Truncate text at this length, |
value | Optional | The current value of the form element | |
visibility | Optional | ALL | Show only channels with the specified visbility setting. SHOWN/HIDDEN/ALL, |
You can still add custom options, just like with the standard fm:Form_Select component. These options will end up on the top of the list.
<fm:Form_ChannelTree name="channel">
<fm:Form_Option value="" label="All channels" />
</fm:Form_ChannelTree>