Add component to show CC license in the item page

This commit is contained in:
Alfeu Uzai Tavares
2024-05-03 16:48:31 -03:00
parent a65f248eb2
commit 6858b4b8e8
10 changed files with 105 additions and 0 deletions

View File

@@ -0,0 +1,28 @@
<div *ngIf="uri && name" class="item-page-field">
<ds-metadata-field-wrapper [label]="'item.page.cc.license.title' | translate">
<div [ngClass]="{'row': variant === 'full', 'col': variant === 'small'}">
<!-- 'img' tag is not rendered if any errors occurs when loading it -->
<div *ngIf="showImage" [ngClass]="{'col-auto': variant === 'full', 'row': variant === 'small'}"
style="align-content: center;"
>
<a [href]="uri" target="_blank" class="link-anchor dont-break-out ds-simple-metadata-link">
<img (error)="showImage = false" [src]="imgSrc" [alt]="name" class="cc-image"
[ngStyle]="{
'width': 'var(--ds-thumbnail-max-width)',
'margin-bottom': variant === 'small'? '1ch' : '0',
}"
/>
</a>
</div>
<!-- CC name is always displayed if the image fails to load -->
<div [ngClass]="{ 'row': variant === 'small', 'col': variant === 'full' }">
<span>
{{ variant === 'full' && showDisclaimer ? ('item.page.cc.license.disclaimer' | translate) : '' }}
<a *ngIf="showName || !showImage" [href]="uri" target="_blank" id="cc-name">{{ name }}</a>
</span>
</div>
</div>
</ds-metadata-field-wrapper>
</div>

View File

@@ -0,0 +1,73 @@
import {
NgClass,
NgIf,
NgStyle,
} from '@angular/common';
import {
Component,
Input,
OnInit,
} from '@angular/core';
import { TranslateModule } from '@ngx-translate/core';
import { Item } from 'src/app/core/shared/item.model';
import { MetadataFieldWrapperComponent } from 'src/app/shared/metadata-field-wrapper/metadata-field-wrapper.component';
@Component({
selector: 'ds-item-page-cc-license-field',
templateUrl: './item-page-cc-license-field.component.html',
standalone: true,
imports: [NgIf, NgClass, NgStyle, TranslateModule, MetadataFieldWrapperComponent],
})
/**
* Displays the item's Creative Commons license image in it's simple item page
*/
export class ItemPageCcLicenseFieldComponent implements OnInit {
/**
* The item to display the CC license image for
*/
@Input() item: Item;
/**
* 'full' variant shows image, a disclaimer (optional) and name (always), better for the item page content.
* 'small' variant shows image and name (optional), better for the item page sidebar
*/
@Input() variant?: 'small' | 'full' = 'small';
/**
* Filed name containing the CC license URI, as configured in the back-end, in the 'dspace.cfg' file, propertie
* 'cc.license.uri'
*/
@Input() ccLicenseUriField? = 'dc.rights.uri';
/**
* Filed name containing the CC license name, as configured in the back-end, in the 'dspace.cfg' file, propertie
* 'cc.license.name'
*/
@Input() ccLicenseNameField? = 'dc.rights';
/**
* Shows the CC license name with the image. Always show if image fails to load
*/
@Input() showName? = true;
/**
* Shows the disclaimer in the 'full' variant of the component
*/
@Input() showDisclaimer? = true;
uri: string;
name: string;
showImage = true;
imgSrc: string;
ngOnInit() {
this.uri = this.item.firstMetadataValue(this.ccLicenseUriField);
this.name = this.item.firstMetadataValue(this.ccLicenseNameField);
// Extracts the CC license code from the URI
const regex = /.*creativecommons.org\/(licenses|publicdomain)\/([^/]+)/gm;
const matches = regex.exec(this.uri ?? '') ?? [];
const ccCode = matches.length > 2 ? matches[2] : null;
this.imgSrc = ccCode ? `assets/images/cc-licenses/${ccCode}.png` : null;
}
}

View File

@@ -6657,4 +6657,8 @@
"search.filters.filter.notifyEndorsement.placeholder": "Notify Endorsement",
"search.filters.filter.notifyEndorsement.label": "Search Notify Endorsement",
"item.page.cc.license.title": "Creative Commons license",
"item.page.cc.license.disclaimer": "Except where otherwised noted, this item's license is described as",
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.3 KiB