TextComponent
extends Component
in package
Base class for all components that primarily contain text content.
Tags
Table of Contents
Properties
- $anchor : string|null
- $animation : array<string, mixed>|null
- $behavior : array<string, mixed>|null
- $conditional : array<string, mixed>|null
- $format : string|null
- $hidden : bool
- $identifier : string|null
- $inlineTextStyles : array<string|int, array<string, mixed>>|null
- $layout : string|null
- $style : string|null
- $text : string
- $textStyle : string|null
Methods
- __construct() : mixed
- getRole() : string
- Get the role name for the component (e.g., 'body', 'photo', 'heading1').
- jsonSerialize() : array<string, mixed>
- Implementation of JsonSerializable.
- setAnchor() : static
- Set the anchor configuration.
- setAnimation() : static
- Set component animation.
- setBehavior() : static
- Set component behavior.
- setConditional() : static
- Set conditional properties for the component.
- setFormat() : static
- Set the format of the text content ('html' or 'markdown').
- setHidden() : static
- Set whether the component is hidden.
- setIdentifier() : static
- Set a unique identifier for this component.
- setInlineTextStyles() : static
- Define specific styles for ranges of text within this component.
- setLayout() : static
- Set the layout name or inline layout.
- setStyle() : static
- Set the style name.
- setTextStyle() : static
- Set the text style name.
- getBaseProperties() : array<string, mixed>
- Get the base properties common to all components for JSON serialization.
Properties
$anchor
protected
string|null
$anchor
= null
Anchor configuration for pinning components.
$animation
protected
array<string, mixed>|null
$animation
= null
Animation settings for the component.
$behavior
protected
array<string, mixed>|null
$behavior
= null
Behavior settings (e.g., Parallax).
$conditional
protected
array<string, mixed>|null
$conditional
= null
Conditional properties based on orientation/device.
$format
protected
string|null
$format
= null
The text format (none, html, markdown).
$hidden
protected
bool
$hidden
= false
Whether the component is hidden by default.
$identifier
protected
string|null
$identifier
= null
A unique identifier for this component instance.
$inlineTextStyles
protected
array<string|int, array<string, mixed>>|null
$inlineTextStyles
= null
Inline style overrides.
$layout
protected
string|null
$layout
= null
Reference to a named layout defined in Article.
$style
protected
string|null
$style
= null
Reference to a named style defined in Article.
$text read-only
protected
string
$text
$textStyle
protected
string|null
$textStyle
= null
Reference to a named text style.
Methods
__construct()
public
__construct(string $text) : mixed
Parameters
- $text : string
-
The raw text content.
getRole()
Get the role name for the component (e.g., 'body', 'photo', 'heading1').
public
abstract getRole() : string
Return values
stringjsonSerialize()
Implementation of JsonSerializable.
public
jsonSerialize() : array<string, mixed>
Return values
array<string, mixed>setAnchor()
Set the anchor configuration.
public
setAnchor(string $anchor) : static
Parameters
- $anchor : string
Return values
staticsetAnimation()
Set component animation.
public
setAnimation(array<string, mixed> $animation) : static
Parameters
- $animation : array<string, mixed>
-
Animation properties.
Tags
Return values
staticsetBehavior()
Set component behavior.
public
setBehavior(array<string, mixed> $behavior) : static
Parameters
- $behavior : array<string, mixed>
-
Behavior properties (e.g., parallax).
Tags
Return values
staticsetConditional()
Set conditional properties for the component.
public
setConditional(array<string, mixed> $conditional) : static
Parameters
- $conditional : array<string, mixed>
-
Array of conditions.
Tags
Return values
staticsetFormat()
Set the format of the text content ('html' or 'markdown').
public
setFormat(string $format) : static
Parameters
- $format : string
Return values
staticsetHidden()
Set whether the component is hidden.
public
setHidden(bool $hidden) : static
Parameters
- $hidden : bool
Return values
staticsetIdentifier()
Set a unique identifier for this component.
public
setIdentifier(string $identifier) : static
Parameters
- $identifier : string
Return values
staticsetInlineTextStyles()
Define specific styles for ranges of text within this component.
public
setInlineTextStyles(array<string|int, array<string, mixed>> $styles) : static
Parameters
- $styles : array<string|int, array<string, mixed>>
Return values
staticsetLayout()
Set the layout name or inline layout.
public
setLayout(string $layout) : static
Parameters
- $layout : string
-
Reference to a name in componentLayouts.
Return values
staticsetStyle()
Set the style name.
public
setStyle(string $style) : static
Parameters
- $style : string
-
Reference to a name in componentStyles.
Return values
staticsetTextStyle()
Set the text style name.
public
setTextStyle(string $textStyle) : static
Parameters
- $textStyle : string
Return values
staticgetBaseProperties()
Get the base properties common to all components for JSON serialization.
protected
getBaseProperties() : array<string, mixed>