Heading
- Type
- Class
- Namespace
- craft\fieldlayoutelements
- Inherits
- craft\fieldlayoutelements\Heading » craft\fieldlayoutelements\BaseUiElement » craft\base\FieldLayoutElement » yii\base\BaseObject (opens new window)
- Implements
- craft\base\FieldLayoutElementInterface, yii\base\Configurable (opens new window)
- Uses traits
- yii\base\ArrayableTrait (opens new window)
- Since
- 3.5.0
Heading represents an <h2>
UI element that can be included in field layouts.
View source (opens new window)
# Public Properties
Property | Description |
---|---|
heading | string (opens new window) – The heading text |
width | integer (opens new window) – The width (%) of the field |
# heading
- Type
- string (opens new window)
- Default value
null
The heading text
View source (opens new window)
# Public Methods
Method | Description |
---|---|
__call() (opens new window) | Calls the named method which is not a class method. |
__construct() (opens new window) | Constructor. |
__get() (opens new window) | Returns the value of an object property. |
__isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
__set() (opens new window) | Sets value of an object property. |
__unset() (opens new window) | Sets an object property to null. |
canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
canSetProperty() (opens new window) | Returns a value indicating whether a property can be set. |
className() (opens new window) | Returns the fully qualified name of this class. |
extraFields() (opens new window) | Returns the list of fields that can be expanded further and returned by toArray() (opens new window). |
fields() (opens new window) | Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified. |
formHtml() | Returns the element’s form HTMl. |
hasCustomWidth() | Returns whether the element can have a custom width. |
hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
hasProperty() (opens new window) | Returns a value indicating whether a property is defined. |
init() (opens new window) | Initializes the object. |
selectorHtml() | Returns the selector HTML that should be displayed within field layout designers. |
settingsHtml() | Returns the settings HTML for the layout element. |
toArray() (opens new window) | Converts the model into an array. |
# formHtml()
Returns the element’s form HTMl.
Return null
if the element should not be present within the form.
View source (opens new window)
Arguments
$element
(craft\base\ElementInterface, null (opens new window)) – The element the form is being rendered for$static
(boolean (opens new window)) – Whether the form should be static (non-interactive)
Returns
string (opens new window), null (opens new window)
# settingsHtml()
Returns the settings HTML for the layout element.
View source (opens new window)
Returns
string (opens new window), null (opens new window)
# Protected Methods
Method | Description |
---|---|
containerAttributes() | Returns the element container HTML attributes. |
extractFieldsFor() (opens new window) | Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id". |
extractRootFields() (opens new window) | Extracts the root field names from nested fields. |
resolveFields() (opens new window) | Determines which fields can be returned by toArray() (opens new window). |
selectorIcon() | Returns the path to the widget’s SVG icon, or the actual SVG contents. |
selectorLabel() | Returns the selector label. |
selectorLabelAttributes() | Returns the selector label HTML attributes. |
# selectorIcon()
Returns the path to the widget’s SVG icon, or the actual SVG contents.
View source (opens new window)
Returns
string (opens new window), null (opens new window)
# selectorLabel()
Returns the selector label.
View source (opens new window)