Skip to content

feat(collections): add css classes to meta elements #4208

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
Sep 29, 2025
Merged

feat(collections): add css classes to meta elements #4208

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
24 changes: 17 additions & 7 deletions src/blocks/collections/class-collections-block.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,7 @@ public static function render_collection_meta( $collection, $attributes ) {
if ( $attributes['showPeriod'] ) {
$period = Collection_Meta::get( $collection->ID, 'period' );
if ( $period ) {
$meta_parts[] = esc_html( $period );
$meta_parts[] = '<span class="wp-block-newspack-collections__period">' . esc_html( $period ) . '</span>';
}
}

Expand All @@ -328,27 +328,37 @@ public static function render_collection_meta( $collection, $attributes ) {
if ( $attributes['showVolume'] ) {
$volume = Collection_Meta::get( $collection->ID, 'volume' );
if ( $volume ) {
/* translators: %s is the volume number of a collection */
$vol_number[] = sprintf( _x( 'Vol. %s', 'collection volume number', 'newspack-plugin' ), esc_html( $volume ) );
$vol_number[] = '<span class="wp-block-newspack-collections__volume">' .
sprintf(
/* translators: %s is the volume number of a collection */
_x( 'Vol. %s', 'collection volume number', 'newspack-plugin' ),
esc_html( $volume )
) .
'</span>';
}
}

if ( $attributes['showNumber'] ) {
$number = Collection_Meta::get( $collection->ID, 'number' );
if ( $number ) {
/* translators: %s is the issue number of a collection */
$vol_number[] = sprintf( _x( 'No. %s', 'collection issue number', 'newspack-plugin' ), esc_html( $number ) );
$vol_number[] = '<span class="wp-block-newspack-collections__number">' .
sprintf(
/* translators: %s is the issue number of a collection */
_x( 'No. %s', 'collection issue number', 'newspack-plugin' ),
esc_html( $number )
) .
'</span>';
}
}

if ( $vol_number ) {
$meta_parts[] = implode( ' / ', $vol_number );
$meta_parts[] = implode( ' <span class="wp-block-newspack-collections__divider">/</span> ', $vol_number );
}

// Render meta text.
if ( ! empty( $meta_parts ) ) {
// Use different separator based on layout.
$separator = 'list' === $attributes['layout'] ? ' / ' : '<br>';
$separator = 'list' === $attributes['layout'] ? ' <span class="wp-block-newspack-collections__divider">/</span> ' : '<br>';
$meta_text = implode( $separator, $meta_parts );
?>
<div class="wp-block-newspack-collections__meta has-medium-gray-color has-text-color has-small-font-size">
Expand Down
62 changes: 43 additions & 19 deletions src/blocks/collections/components/CollectionItem.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,36 +74,60 @@ const CollectionItem = ( { collection, attributes } ) => {
return next.slice( 0, numberOfCTAs || 1 );
}, [ collection.ctas, showSubscriptionUrl, showOrderUrl, specificCTAs, numberOfCTAs ] );

// Build meta text, memoized.
const metaText = useMemo( () => {
const metaParts = [];
// Build meta elements, memoized.
const metaElements = useMemo( () => {
const elements = [];

// Add period first.
if ( showPeriod && period ) {
metaParts.push( period );
elements.push(
<span key="period" className="wp-block-newspack-collections__period">
{ period }
</span>
);
}

const volNumber = [];

if ( showVolume && volume ) {
volNumber.push( `Vol. ${ volume }` );
// Add separator if we have period and will have volume/number.
if ( showPeriod && period && ( ( showVolume && volume ) || ( showNumber && number ) ) ) {
const separator =
layout === 'list' ? (
<span key="period-sep" className="wp-block-newspack-collections__divider">
{ ' / ' }
</span>
) : (
<br key="period-sep" />
);
elements.push( separator );
}

if ( showNumber && number ) {
volNumber.push( `No. ${ number }` );
// Volume.
if ( showVolume && volume ) {
elements.push(
<span key="volume" className="wp-block-newspack-collections__volume">
{ `Vol. ${ volume }` }
</span>
);
}

if ( volNumber.length ) {
metaParts.push( volNumber.join( ' / ' ) );
// Separator between volume and number.
if ( showVolume && volume && showNumber && number ) {
elements.push(
<span key="vol-num-sep" className="wp-block-newspack-collections__divider">
{ ' / ' }
</span>
);
}

if ( metaParts.length ) {
// Use different separator based on layout.
const separator = layout === 'list' ? ' / ' : '<br>';
return metaParts.join( separator );
// Number.
if ( showNumber && number ) {
elements.push(
<span key="number" className="wp-block-newspack-collections__number">
{ `No. ${ number }` }
</span>
);
}

return '';
return elements;
}, [ showPeriod, period, showVolume, volume, showNumber, number, layout ] );

return (
Expand Down Expand Up @@ -143,9 +167,9 @@ const CollectionItem = ( { collection, attributes } ) => {
</h3>
) }

{ metaText && (
{ metaElements.length > 0 && (
<div className="wp-block-newspack-collections__meta has-medium-gray-color has-text-color has-small-font-size">
<RawHTML>{ metaText }</RawHTML>
{ metaElements }
</div>
) }

Expand Down
4 changes: 3 additions & 1 deletion tests/unit-tests/collections/class-test-collections-block.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,9 @@ public function test_render_collection_meta_list_layout() {
Collections_Block::render_collection_meta( $collection, $attributes );
$output = ob_get_clean();

$this->assertStringContainsString( $period . ' / Vol. ' . $volume, $output, 'Should use slash separator for list layout' );
$this->assertStringContainsString( $period, $output, 'Should contain period' );
$this->assertStringContainsString( 'Vol. ' . $volume, $output, 'Should contain volume' );
$this->assertStringContainsString( '>/</', $output, 'Should use slash separator for list layout' );
}

/**
Expand Down