Skip to content
PHP Ecosystem
Explore

Text

API reference › HTML SVG › Text

Represents the SVG <text> (text) element for rendering text content in SVG graphics.

Provides a concrete <text> element implementation that returns SvgBlock::TEXT and provides text layout, typography, paint, and transform attribute methods.

The <text> element defines text content with positioning, layout, and typography attributes.

Usage example:

use UIAwesome\Html\Svg\Text;
echo Text::tag()
->x(12)
->y(24)
->fontSize(16)
->fill('currentColor')
->content('Hello SVG')
->render();

See also: https://developer.mozilla.org/en-US/docs/Web/SVG/Element/text (BaseBlock for the base block-level implementation.).

PropertyTypeDescriptionDefined by
$attributes protectedmixed[]HTML attributes array used by the implementing class. Default: [].UIAwesome\Html\Mixin\HasAttributes
$content protectedstringContent string assigned to the element. Default: ''.UIAwesome\Html\Mixin\HasContent
MethodDescriptionDefined by
__construct() finalInitializes a new tag instance.UIAwesome\Html\Core\Base\BaseTag
__toString()Returns the rendered tag string.UIAwesome\Html\Core\Base\BaseTag
accesskey()Sets the accesskey attribute.UIAwesome\Html\Attribute\Global\HasAccesskey
addAriaAttribute()Sets an aria-* attribute.UIAwesome\Html\Attribute\Global\HasAria
addAttribute()Adds or updates a single HTML attribute for the element.UIAwesome\Html\Mixin\HasAttributes
addDataAttribute()Sets a data-* attribute.UIAwesome\Html\Attribute\Global\HasData
addEvent()Sets an on* event attribute.UIAwesome\Html\Attribute\Global\HasEvents
ariaAttributes()Sets multiple aria-* attributes.UIAwesome\Html\Attribute\Global\HasAria
attributes()Adds or updates multiple HTML attributes for the element.UIAwesome\Html\Mixin\HasAttributes
autofocus()Sets the autofocus attribute.UIAwesome\Html\Attribute\Global\CanBeAutofocus
begin() finalStarts begin/end rendering for this instance.UIAwesome\Html\Core\Element\BaseBlock
class()Sets the class attribute.UIAwesome\Html\Attribute\Global\HasClass
clearContent()Clears encoded and raw content without changing other component state.UIAwesome\Html\Mixin\HasContent
config()Applies application-scoped config recipes to this tag.UIAwesome\Html\Core\Base\BaseTag
content()Appends encoded content.UIAwesome\Html\Mixin\HasContent
contentEditable()Sets the contenteditable attribute.UIAwesome\Html\Attribute\Global\HasContentEditable
dataAttributes()Sets multiple data-* attributes.UIAwesome\Html\Attribute\Global\HasData
dir()Sets the dir attribute.UIAwesome\Html\Attribute\Global\HasDir
dominantBaseline()Sets SVG dominant-baseline attribute for the element.Text
draggable()Sets the draggable attribute.UIAwesome\Html\Attribute\Global\HasDraggable
dx()Sets the SVG dx attribute for the element.Text
dy()Sets the SVG dy attribute for the element.Text
end() static finalEnds the most recent begin/end rendering block for the current class.UIAwesome\Html\Core\Element\BaseBlock
events()Sets multiple on* event attributes.UIAwesome\Html\Attribute\Global\HasEvents
fill()Sets the SVG fill attribute for the element.Text
fillOpacity()Sets SVG fill-opacity attribute for the element.Text
fillRule()Sets SVG fill-rule attribute for the element.Text
fontFamily()Sets the SVG font-family attribute for the element.Text
fontSize()Sets the SVG font-size attribute for the element.Text
fontStyle()Sets SVG font-style attribute for the element.Text
fontWeight()Sets the SVG font-weight attribute for the element.Text
getAttribute()Returns the value of a single HTML attribute.UIAwesome\Html\Mixin\HasAttributes
getAttributes()Returns the array of HTML attributes for the element.UIAwesome\Html\Mixin\HasAttributes
getContent()Returns the content assigned to the element.UIAwesome\Html\Mixin\HasContent
hidden()Sets the hidden attribute.UIAwesome\Html\Attribute\Global\CanBeHidden
html()Appends trusted raw HTML content without encoding or sanitizing it.UIAwesome\Html\Mixin\HasContent
id()Sets the id attribute.UIAwesome\Html\Attribute\Global\HasId
itemId()Sets the itemid attribute.UIAwesome\Html\Attribute\Global\HasMicroData
itemProp()Sets the itemprop attribute.UIAwesome\Html\Attribute\Global\HasMicroData
itemRef()Sets the itemref attribute.UIAwesome\Html\Attribute\Global\HasMicroData
itemScope()Sets the itemscope attribute.UIAwesome\Html\Attribute\Global\HasMicroData
itemType()Sets the itemtype attribute.UIAwesome\Html\Attribute\Global\HasMicroData
lang()Sets the lang attribute.UIAwesome\Html\Attribute\Global\HasLang
lengthAdjust()Sets SVG lengthAdjust attribute for the element.Text
letterSpacing()Sets the SVG letter-spacing attribute for the element.Text
opacity()Sets the SVG opacity attribute for the element.Text
removeAriaAttribute()Removes an aria-* attribute.UIAwesome\Html\Attribute\Global\HasAria
removeAttribute()Removes a specific HTML attribute from the element.UIAwesome\Html\Mixin\HasAttributes
removeDataAttribute()Removes a data-* attribute.UIAwesome\Html\Attribute\Global\HasData
removeEvent()Removes an on* event attribute.UIAwesome\Html\Attribute\Global\HasEvents
render() finalRenders the tag with lifecycle hooks.UIAwesome\Html\Core\Base\BaseTag
replaceAttributes()Replaces all HTML attributes for the element.UIAwesome\Html\Mixin\HasAttributes
role()Sets the role attribute.UIAwesome\Html\Attribute\Global\HasRole
rotate()Sets the SVG rotate attribute for the element.Text
spellcheck()Sets the spellcheck attribute.UIAwesome\Html\Attribute\Global\HasSpellcheck
stroke()Sets the SVG stroke attribute for the element.Text
strokeDashArray()Sets the SVG stroke-dasharray attribute for the element.Text
strokeLineCap()Sets the SVG stroke-linecap attribute for the element.Text
strokeLineJoin()Sets the SVG stroke-linejoin attribute for the element.Text
strokeMiterlimit()Sets SVG stroke-miterlimit attribute for the element.Text
strokeOpacity()Sets SVG stroke-opacity attribute for the element.Text
strokeWidth()Sets the SVG stroke-width attribute for the element.Text
style()Sets the style attribute.UIAwesome\Html\Attribute\Global\HasStyle
tabIndex()Sets the tabindex attribute.UIAwesome\Html\Attribute\Global\HasTabindex
tag() staticCreates and configures a new tag instance.UIAwesome\Html\Core\Base\BaseTag
textAnchor()Sets SVG text-anchor attribute for the element.Text
textDecoration()Sets the SVG text-decoration shorthand attribute for the text element.Text
textLength()Sets the SVG textLength attribute for the element.Text
title()Sets the title attribute.Text
transform()Sets the SVG transform attribute for the element.Text
translate()Sets the translate attribute.UIAwesome\Html\Attribute\Global\HasTranslate
wordSpacing()Sets the SVG word-spacing attribute for the element.Text
writingMode()Sets SVG writing-mode attribute for the element.Text
x()Sets the SVG x attribute for the element.Text
y()Sets the SVG y attribute for the element.Text
afterRun() protectedPost-processes rendered output.UIAwesome\Html\Core\Event\HasAfterRun
beforeRun() protectedValidates state before rendering.UIAwesome\Html\Core\Event\HasBeforeRun
getTag() protectedReturns the tag enumeration for the <text> element.Text
isBeginExecuted() protectedIndicates whether this instance has an open or closing operation in the current context.UIAwesome\Html\Core\Element\BaseBlock
loadDefault() protectedReturns class-level default definitions.UIAwesome\Html\Core\Base\BaseTag
run() protectedRenders the block element.UIAwesome\Html\Core\Element\BaseBlock
runBegin() protectedReturns the opening tag for begin/end rendering.UIAwesome\Html\Core\Element\BaseBlock
public function dominantBaseline(UIAwesome\Html\Svg\Values\DominantBaseline|string|null $value): static

Sets SVG dominant-baseline attribute for the element.

Creates a new instance with the specified dominant baseline value for the rendered element.

Parameters

ParameterTypeDescription
$valueUIAwesome\Html\Svg\Values\DominantBaseline|string|nullDominant baseline value to set for the element. Accepts ‘auto’, ‘alphabetic’, ‘middle’, ‘central’, ‘hanging’, ‘mathematical’, ‘ideographic’, ‘text-top’, ‘text-bottom’, DominantBaseline enum, or null to unset.

Returns

static: New instance with the updated dominant-baseline attribute.

Throws

public function dx(float|int|string|null $value): static

Sets the SVG dx attribute for the element.

Creates a new instance with the specified dx-offset value for the rendered element.

Parameters

ParameterTypeDescription
$valuefloat|int|string|nullDX offset value (for example, ‘10’, ‘5 10 15’, or null to unset).

Returns

static: New instance with the updated dx attribute.

public function dy(float|int|string|null $value): static

Sets the SVG dy attribute for the element.

Creates a new instance with the specified dy-offset value for the rendered element.

Parameters

ParameterTypeDescription
$valuefloat|int|string|nullDY offset value (for example, ‘10’, ‘5 10 15’, or null to unset).

Returns

static: New instance with the updated dy attribute.

public function fill(string|null $value): static

Sets the SVG fill attribute for the element.

Creates a new instance with the specified fill value for the rendered element.

Parameters

ParameterTypeDescription
$valuestring|nullFill value (for example, ‘red’, ‘url(#gradient1)’, or null to unset).

Returns

static: New instance with the updated fill attribute.

public function fillOpacity(float|int|string|null $value): static

Sets SVG fill-opacity attribute for the element.

Creates a new instance with the specified fill opacity value for the rendered element.

Parameters

ParameterTypeDescription
$valuefloat|int|string|nullFill opacity value (for example, ‘0.5’ or null to unset).

Returns

static: New instance with the updated fill-opacity attribute.

Throws

public function fillRule(UIAwesome\Html\Svg\Values\FillRule|string|null $value): static

Sets SVG fill-rule attribute for the element.

Creates a new instance with the specified fill rule value for the rendered element.

Parameters

ParameterTypeDescription
$valueUIAwesome\Html\Svg\Values\FillRule|string|nullFill rule value to set for the element. Accepts ‘nonzero’, ‘evenodd’, FillRule enum, or null to unset.

Returns

static: New instance with the updated fill-rule attribute.

Throws

public function fontFamily(string|null $value): static

Sets the SVG font-family attribute for the element.

Creates a new instance with the specified font family value for the rendered element.

Parameters

ParameterTypeDescription
$valuestring|nullFont family value (for example, ‘Arial’, ‘Arial, sans-serif’, or null to unset).

Returns

static: New instance with the updated font-family attribute.

public function fontSize(float|int|string|null $value): static

Sets the SVG font-size attribute for the element.

Creates a new instance with the specified font size value for the rendered element.

Parameters

ParameterTypeDescription
$valuefloat|int|string|nullFont size value (for example, ‘16’, ‘1.2em’, ‘120%’, or null to unset).

Returns

static: New instance with the updated font-size attribute.

public function fontStyle(UIAwesome\Html\Svg\Values\FontStyle|string|null $value): static

Sets SVG font-style attribute for the element.

Creates a new instance with the specified font style value for the rendered element.

Parameters

ParameterTypeDescription
$valueUIAwesome\Html\Svg\Values\FontStyle|string|nullFont style value to set for the element. Accepts ‘normal’, ‘italic’, ‘oblique’, FontStyle enum, or null to unset.

Returns

static: New instance with the updated font-style attribute.

Throws

public function fontWeight(int|string|null $value): static

Sets the SVG font-weight attribute for the element.

Creates a new instance with the specified font weight value for the rendered element.

Parameters

ParameterTypeDescription
$valueint|string|nullFont weight value (for example, ‘700’, ‘bold’, or null to unset).

Returns

static: New instance with the updated font-weight attribute.

public function lengthAdjust(UIAwesome\Html\Svg\Values\LengthAdjust|string|null $value): static

Sets SVG lengthAdjust attribute for the element.

Creates a new instance with the specified length adjust value for the rendered element.

Parameters

ParameterTypeDescription
$valueUIAwesome\Html\Svg\Values\LengthAdjust|string|nullLength adjust value (for example, ‘spacing’, LengthAdjust enum, or null to unset).

Returns

static: New instance with the updated lengthAdjust attribute.

Throws

public function letterSpacing(float|int|string|null $value): static

Sets the SVG letter-spacing attribute for the element.

Creates a new instance with the specified letter spacing value for the rendered element.

Parameters

ParameterTypeDescription
$valuefloat|int|string|nullLetter spacing value (for example, ‘2’, ‘0.1em’, ‘normal’, or null to unset).

Returns

static: New instance with the updated letter-spacing attribute.

public function opacity(float|int|string|null $value): static

Sets the SVG opacity attribute for the element.

Creates a new instance with the specified opacity value for the rendered element.

Parameters

ParameterTypeDescription
$valuefloat|int|string|nullOpacity value (for example, ‘0.5’ or null to unset).

Returns

static: New instance with the updated opacity attribute.

Throws

public function rotate(float|int|string|null $value): static

Sets the SVG rotate attribute for the element.

Creates a new instance with the specified rotation value for the rendered element.

Parameters

ParameterTypeDescription
$valuefloat|int|string|nullRotate value (for example, ‘45’, ‘10 20 30 40’, or null to unset).

Returns

static: New instance with the updated rotate attribute.

public function stroke(string|null $value): static

Sets the SVG stroke attribute for the element.

Creates a new instance with the specified stroke value for the rendered element.

Parameters

ParameterTypeDescription
$valuestring|nullStroke paint value (for example, ‘black’, ‘url(#gradient1)’, or null to unset).

Returns

static: New instance with the updated stroke attribute.

public function strokeDashArray(float|int|string|null $value): static

Sets the SVG stroke-dasharray attribute for the element.

Creates a new instance with the specified dash array value for the rendered element.

Parameters

ParameterTypeDescription
$valuefloat|int|string|nullDash array value (for example, ‘5.3’ or null to unset).

Returns

static: New instance with the updated stroke-dasharray attribute.

See also

public function strokeLineCap(string|UIAwesome\Html\Svg\Values\StrokeLineCap|null $value): static

Sets the SVG stroke-linecap attribute for the element.

Creates a new instance with the specified stroke line cap value for the rendered element.

Parameters

ParameterTypeDescription
$valuestring|UIAwesome\Html\Svg\Values\StrokeLineCap|nullStroke line cap style (for example, ‘round’, StrokeLineCap enum, or null to unset).

Returns

static: New instance with the updated stroke-linecap attribute.

Throws

public function strokeLineJoin(string|UIAwesome\Html\Svg\Values\StrokeLineJoin|null $value): static

Sets the SVG stroke-linejoin attribute for the element.

Parameters

ParameterTypeDescription
$valuestring|UIAwesome\Html\Svg\Values\StrokeLineJoin|nullStroke line join style (for example, ‘miter’, StrokeLineJoin enum, or null to unset).

Returns

static: New instance with the updated stroke-linejoin attribute.

Throws

public function strokeMiterlimit(float|int|string|null $value): static

Sets SVG stroke-miterlimit attribute for the element.

Creates a new instance with the specified stroke miter limit value for the rendered element.

The stroke-miterlimit attribute controls the limit on the ratio of the miter length to the stroke width. When the limit is exceeded, the join is converted from a miter to a bevel. The value must be a number ’>= 1’.

Parameters

ParameterTypeDescription
$valuefloat|int|string|nullStroke miter limit value (for example, ‘4’ or null to unset).

Returns

static: New instance with the updated stroke-miterlimit attribute.

Throws

See also

public function strokeOpacity(float|int|string|null $value): static

Sets SVG stroke-opacity attribute for the element.

Creates a new instance with the specified stroke opacity value for the rendered element.

Parameters

ParameterTypeDescription
$valuefloat|int|string|nullStroke opacity value (for example, ‘0.8’ or null to unset).

Returns

static: New instance with the updated stroke-opacity attribute.

Throws

public function strokeWidth(int|string|null $value): static

Sets the SVG stroke-width attribute for the element.

Creates a new instance with the specified stroke width value for the rendered element.

Parameters

ParameterTypeDescription
$valueint|string|nullStroke width value (for example, ‘2’, ‘1.5em’, or null to unset).

Returns

static: New instance with the updated stroke-width attribute.

public function textAnchor(string|UIAwesome\Html\Svg\Values\TextAnchor|null $value): static

Sets SVG text-anchor attribute for the element.

Creates a new instance with the specified text anchor value for the rendered element.

Parameters

ParameterTypeDescription
$valuestring|UIAwesome\Html\Svg\Values\TextAnchor|nullText anchor value to set for the element. Accepts ‘start’, ‘middle’, ‘end’, TextAnchor enum, or null to unset.

Returns

static: New instance with the updated text-anchor attribute.

Throws

public function textDecoration(string|UIAwesome\Html\Svg\Values\TextDecorationLine|UIAwesome\Html\Svg\Values\TextDecorationStyle|null $value): static

Sets the SVG text-decoration shorthand attribute for the text element.

Creates a new instance with the specified text decoration value for the rendered element.

Parameters

ParameterTypeDescription
$valuestring|UIAwesome\Html\Svg\Values\TextDecorationLine|UIAwesome\Html\Svg\Values\TextDecorationStyle|nullText decoration shorthand value (for example, ‘underline wavy red’, TextDecorationLine enum, or null to unset).

Returns

static: New instance with the updated text-decoration attribute.

public function textLength(float|int|string|null $value): static

Sets the SVG textLength attribute for the element.

Creates a new instance with the specified text length value for the rendered element.

Parameters

ParameterTypeDescription
$valuefloat|int|string|nullText length value (for example, ‘100’, ‘50%’, or null to unset).

Returns

static: New instance with the updated textLength attribute.

public function title(string|Stringable|UnitEnum|null $value): static

Sets the title attribute.

Usage example:

$element->title('SVG text');
$element->title(null);

Parameters

ParameterTypeDescription
$valuestring|Stringable|UnitEnum|nullAdvisory title text, or null to remove the attribute.

Returns

static: New instance with the updated title attribute.

public function transform(string|null $value): static

Sets the SVG transform attribute for the element.

Creates a new instance with the specified transform value for the rendered element.

Parameters

ParameterTypeDescription
$valuestring|nullTransform value (for example, ‘rotate(45)’, ‘scale(2)’, or null to unset).

Returns

static: New instance with the updated transform attribute.

public function wordSpacing(float|int|string|null $value): static

Sets the SVG word-spacing attribute for the element.

Creates a new instance with the specified word spacing value for the rendered element.

Parameters

ParameterTypeDescription
$valuefloat|int|string|nullWord spacing value (for example, ‘5’, ‘0.5em’, ‘normal’, or null to unset).

Returns

static: New instance with the updated word-spacing attribute.

public function writingMode(string|UIAwesome\Html\Svg\Values\WritingMode|null $value): static

Sets SVG writing-mode attribute for the element.

Creates a new instance with the specified writing mode value for the rendered element.

Parameters

ParameterTypeDescription
$valuestring|UIAwesome\Html\Svg\Values\WritingMode|nullWriting mode value to set for the element. Accepts ‘horizontal-tb’, ‘vertical-rl’, ‘vertical-lr’, ‘sideways-rl’, ‘sideways-lr’, WritingMode enum, or null to unset.

Returns

static: New instance with the updated writing-mode attribute.

Throws

public function x(float|int|string|null $value): static

Sets the SVG x attribute for the element.

Creates a new instance with the specified x-coordinate value for the rendered element.

Parameters

ParameterTypeDescription
$valuefloat|int|string|nullX coordinate value (for example, ‘10’, ‘10.3’, ‘50%’, or null to unset).

Returns

static: New instance with the updated x attribute.

public function y(float|int|string|null $value): static

Sets the SVG y attribute for the element.

Creates a new instance with the specified y-coordinate value for the rendered element.

Parameters

ParameterTypeDescription
$valuefloat|int|string|nullY coordinate value (for example, ‘20’, ‘10.3’, ‘50%’, or null to unset).

Returns

static: New instance with the updated y attribute.

protected function getTag(): BackedEnum

Returns the tag enumeration for the <text> element.

Returns

BackedEnum: Tag enumeration instance for <text>. SvgBlock for valid SVG block-level tags.