Skip to content
PHP Ecosystem
Explore

Uses

API reference › HTML SVG › Uses

Represents the SVG <use> (use) element for referencing and reusing SVG fragments.

Provides a concrete <use> element implementation that returns SvgVoid::USES and provides linking, geometry, presentation, and transform attribute methods.

The <use> element references an existing element and renders it at the specified location.

See also: https://developer.mozilla.org/en-US/docs/Web/SVG/Element/use (BaseVoid for the base implementation.).

PropertyTypeDescriptionDefined by
$attributes protectedmixed[]HTML attributes array used by the implementing class. Default: [].UIAwesome\Html\Mixin\HasAttributes
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
class()Sets the class attribute.UIAwesome\Html\Attribute\Global\HasClass
config()Applies application-scoped config recipes to this tag.UIAwesome\Html\Core\Base\BaseTag
dataAttributes()Sets multiple data-* attributes.UIAwesome\Html\Attribute\Global\HasData
dir()Sets the dir attribute.UIAwesome\Html\Attribute\Global\HasDir
events()Sets multiple on* event attributes.UIAwesome\Html\Attribute\Global\HasEvents
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
height()Sets the height attribute.Uses
hidden()Sets the hidden attribute.UIAwesome\Html\Attribute\Global\CanBeHidden
href()Sets the href attribute.Uses
id()Sets the id attribute.UIAwesome\Html\Attribute\Global\HasId
lang()Sets the lang attribute.UIAwesome\Html\Attribute\Global\HasLang
opacity()Sets the SVG opacity attribute for the element.Uses
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
style()Sets the style attribute.UIAwesome\Html\Attribute\Global\HasStyle
tag() staticCreates and configures a new tag instance.UIAwesome\Html\Core\Base\BaseTag
title()Sets the title attribute.UIAwesome\Html\Attribute\Global\HasTitle
transform()Sets the SVG transform attribute for the element.Uses
translate()Sets the translate attribute.UIAwesome\Html\Attribute\Global\HasTranslate
width()Sets the width attribute.Uses
x()Sets the SVG x attribute for the element.Uses
y()Sets the SVG y attribute for the element.Uses
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 <use> element.Uses
loadDefault() protectedReturns class-level default definitions.UIAwesome\Html\Core\Base\BaseTag
run() protectedRenders the void element.UIAwesome\Html\Core\Element\BaseVoid
public function height(int|string|Stringable|UnitEnum|null $value): static

Sets the height attribute.

Usage example:

$element->height(200);
$element->height('50%');
$element->height('auto');

Parameters

ParameterTypeDescription
$valueint|string|Stringable|UnitEnum|nullHeight value in pixels or CSS units, or null to remove the attribute.

Returns

static: New instance with the updated height attribute.

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

Sets the href attribute.

Usage example:

$element->href('#symbol');
$element->href(null);

Parameters

ParameterTypeDescription
$valuestring|Stringable|UnitEnum|nullURL, path, or fragment, or null to remove the attribute.

Returns

static: New instance with the updated href 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 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 width(int|string|Stringable|UnitEnum|null $value): static

Sets the width attribute.

Usage example:

$element->width(400);
$element->width('50%');
$element->width('auto');
$element->width(null);

Parameters

ParameterTypeDescription
$valueint|string|Stringable|UnitEnum|nullWidth value in pixels or CSS units, or null to remove the attribute.

Returns

static: New instance with the updated width attribute.

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 <use> element.

Returns

BackedEnum: Tag enumeration instance for <use>. SvgVoid for valid SVG void-level tags.