Skip to content

Add support for object-valued class attributes in Vue templates #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 27, 2025
Merged

Add support for object-valued class attributes in Vue templates #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions src/Component.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
use DOMNode;
use DOMNodeList;
use DOMText;
use RuntimeException;

class Component {

Expand Down Expand Up @@ -136,6 +137,26 @@ private function handleComponent( DOMElement $node, array $data ): bool {
return true;
}

private function handleArrayAttributeBinding( DOMElement $node, string $name, array $value ) {
if ( $name !== 'class' ) {
throw new RuntimeException( 'Array-valued data invalid for "' . $name . '" attribute' );
}
$existingParts = [];
if ( $node->getAttribute( $name ) ) {
$existingParts = explode( " ", $node->getAttribute( $name ) );
}
if ( array_is_list( $value ) ) {
$existingParts = array_merge( $existingParts, $value );
} else {
foreach ( $value as $key => $addKey ) {
if ( $addKey ) {
array_unshift( $existingParts, $key );
}
}
}
$node->setAttribute( $name, implode( " ", $existingParts ) );
}

private function handleAttributeBinding( DOMElement $node, array $data ) {
/** @var DOMAttr $attribute */
foreach ( iterator_to_array( $node->attributes ) as $attribute ) {
Expand All @@ -150,6 +171,8 @@ private function handleAttributeBinding( DOMElement $node, array $data ) {
if ( $value ) {
$node->setAttribute( $name, $name );
}
} elseif ( is_array( $value ) ) {
$this->handleArrayAttributeBinding( $node, $name, $value );
} else {
$node->setAttribute( $name, $value );
}
Expand Down
99 changes: 99 additions & 0 deletions tests/integration/fixture/statement_view.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
<template id="template">
<div class="wikibase-mex-statement-list">
<div id="P123" class="wikibase-mex-statement">
<div class="wikibase-mex-statement-heading">
<div class="wikibase-mex-statement-heading-row">
<div class="wikibase-mex-property-name">
<p><a href="#" class="mex-link">country of citizenship</a></p>
</div>
<div class="wikibase-mex-edit-link">
<span class="wikibase-mex-icon-edit-small"></span>
<a href="#" class="mex-link-heavy">edit</a>
</div>
</div>
</div>
<div class="wikibase-mex-snak-value">
<p><a href="#" class="mex-link">Barbados</a></p>
</div>
<div class="wikibase-mex-references">
<p class="wikibase-mex-clickable" v-on:click="showReferences.P123 = !showReferences.P123">
<span :class="{ 'wikibase-mex-icon-expand-x-small': !showReferences.P123, 'wikibase-mex-icon-collapse-x-small': showReferences.P123 }"></span>
<a href="javascript: void(0)" class="mex-link">1 reference</a>
</p>
<div class="wikibase-mex-reference-list" :class="{ 'wikibase-mex-references-visible': showReferences.P123 }">
<p>References</p>
</div>
</div>
</div>
<div id="P321" class="wikibase-mex-statement">
<div class="wikibase-mex-statement-heading">
<div class="wikibase-mex-statement-heading-row">
<div class="wikibase-mex-property-name">
<p><a href="#" class="mex-link">signature</a></p>
</div>
<div class="wikibase-mex-edit-link">
<span class="wikibase-mex-icon-edit-small"></span>
<a href="#" class="mex-link-heavy">edit</a>
</div>
</div>
</div>
<div class="wikibase-mex-snak-value">
<div class="wikibase-mex-media-value">
<div class="wikibase-mex-media-value-row">
<div class="wikibase-mex-media-preview">
<div class="wikibase-rankselector ui-state-default">
<span class="ui-icon ui-icon-rankselector wikibase-rankselector-normal" title="Normal rank"></span>
</div>
<img :src="mediaInfo.src" :alt="mediaInfo.altText">
</div>
<div class="wikibase-mex-media-info">
<p><a href="#" class="mex-link-heavy">{{ mediaInfo.filename }}</a></p>
<p>{{ mediaInfo.widthPx }} <span>×</span> {{ mediaInfo.heightPx }}; {{ mediaInfo.fileSizeKb }} KB</p>
</div>
</div>
</div>
</div>
<div class="wikibase-mex-references">
<p :class="{ 'wikibase-mex-clickable': hasReferences }" v-on:click="showReferences.P321 = !showReferences.P321">
<span v-if="hasReferences" :class="{ 'wikibase-mex-icon-expand-x-small': !showReferences.P321, 'wikibase-mex-icon-collapse-x-small': showReferences.P321 }"></span>
<a v-if="hasReferences" href="javascript: void(0)" class="mex-link">{{ referencesMessage }}</a>
<span v-else>{{ referencesMessage }}</span>
</p>
<div v-if="hasReferences" class="wikibase-mex-reference-list" :class="{ 'wikibase-mex-references-visible': showReferences.P321 }">
<div v-for="reference in mediaInfo.references" :key="reference">
<p><a href="#" class="mex-link">Reference URL</a></p>
<p class="wikibase-mex-reference-link">
<a class="mex-link" :href="reference">{{ reference }}</a>
</p>
</div>
</div>
</div>
</div>
</div>
</template>

<script id="data" type="application/json">
{
"mediaInfo": {
"src": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/d5/Rihanna-signature.svg/250px-Rihanna-signature.svg.png",
"altText": "Some alt text",
"filename": "Rihanna-signature.svg",
"widthPx": 348,
"heightPx": 178,
"fileSizeKb": 9,
"references": [
"https://www.elle.com/culture/celebrities/a42622947/asap-rocky-rihanna-relationship-timeline/"
]
},
"showReferences": {
"P123": true,
"P321": false
},
"referencesMessage": "1 reference",
"hasReferences": true
}
</script>
<div id="result">
<!-- generated by `npm run-script populate-fixtures` -->
<div class="wikibase-mex-statement-list"><div id="P123" class="wikibase-mex-statement"><div class="wikibase-mex-statement-heading"><div class="wikibase-mex-statement-heading-row"><div class="wikibase-mex-property-name"><p><a href="#" class="mex-link">country of citizenship</a></p></div><div class="wikibase-mex-edit-link"><span class="wikibase-mex-icon-edit-small"></span><a href="#" class="mex-link-heavy">edit</a></div></div></div><div class="wikibase-mex-snak-value"><p><a href="#" class="mex-link">Barbados</a></p></div><div class="wikibase-mex-references"><p class="wikibase-mex-clickable"><span class="wikibase-mex-icon-collapse-x-small"></span><a href="javascript: void(0)" class="mex-link">1 reference</a></p><div class="wikibase-mex-references-visible wikibase-mex-reference-list"><p>References</p></div></div></div><div id="P321" class="wikibase-mex-statement"><div class="wikibase-mex-statement-heading"><div class="wikibase-mex-statement-heading-row"><div class="wikibase-mex-property-name"><p><a href="#" class="mex-link">signature</a></p></div><div class="wikibase-mex-edit-link"><span class="wikibase-mex-icon-edit-small"></span><a href="#" class="mex-link-heavy">edit</a></div></div></div><div class="wikibase-mex-snak-value"><div class="wikibase-mex-media-value"><div class="wikibase-mex-media-value-row"><div class="wikibase-mex-media-preview"><div class="wikibase-rankselector ui-state-default"><span class="ui-icon ui-icon-rankselector wikibase-rankselector-normal" title="Normal rank"></span></div><img src="https://upload.wikimedia.org/wikipedia/commons/thumb/d/d5/Rihanna-signature.svg/250px-Rihanna-signature.svg.png" alt="Some alt text"></div><div class="wikibase-mex-media-info"><p><a href="#" class="mex-link-heavy">Rihanna-signature.svg</a></p><p>348 <span>×</span> 178; 9 KB</p></div></div></div></div><div class="wikibase-mex-references"><p class="wikibase-mex-clickable"><span class="wikibase-mex-icon-expand-x-small"></span><a href="javascript: void(0)" class="mex-link">1 reference</a></p><div class="wikibase-mex-reference-list"><!--[--><div><p><a href="#" class="mex-link">Reference URL</a></p><p class="wikibase-mex-reference-link"><a class="mex-link" href="https://www.elle.com/culture/celebrities/a42622947/asap-rocky-rihanna-relationship-timeline/">https://www.elle.com/culture/celebrities/a42622947/asap-rocky-rihanna-relationship-timeline/</a></p></div><!--]--></div></div></div></div>
</div>
35 changes: 35 additions & 0 deletions tests/php/TemplatingTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,6 +311,41 @@ public function testMustacheAfterVIf(): void {
$this->assertSame( '<p>a: A c: C</p>', $result );
}

public function testTemplateWithArrayValuedClassAttribute() {
$result = $this->createAndRender(
'<p><a :class="list">Link</a></p>',
[ 'list' => [ 'one_class', 'another_class' ] ]
);

$this->assertSame( '<p><a class="one_class another_class">Link</a></p>', $result );
}

public function testTemplateWithObjectValuedClassAttribute() {
$result = $this->createAndRender(
'<p><a :class="list">Link</a></p>',
[ 'list' => [ 'one_class' => true, 'another_class' => false ] ]
);

$this->assertSame( '<p><a class="one_class">Link</a></p>', $result );
}

public function testTemplateWithObjectValuedClassAttribute_UnionWithExistingAttributes() {
$result = $this->createAndRender(
'<p><a class="another_class" :class="list">Link</a></p>',
[ 'list' => [ 'one_class' => true, 'another_class' => false ] ]
);

$this->assertSame( '<p><a class="one_class another_class">Link</a></p>', $result );
}

public function testTemplateWithObjectValuedNonClassAttribute_ThrowsError() {
$this->expectException( Exception::class );
$this->createAndRender(
'<p><a :my-attr="list">Link</a></p>',
[ 'list' => [ 'one_class' => true, 'another_class' => false ] ]
);
}

/**
* @param string $template HTML
* @param array $data
Expand Down