From e4eee7ce27996c84066486e51d2fc151e1561d89 Mon Sep 17 00:00:00 2001 From: Kristof De Langhe Date: Wed, 24 Oct 2018 11:05:32 +0200 Subject: [PATCH] 56434: Docs for all item-page-metadata-field, related-entities, item-page and metadata-values componens --- .../metadata-field-wrapper.component.ts | 3 +++ .../metadata-uri-values.component.ts | 13 +++++++++++++ .../metadata-values/metadata-values.component.ts | 9 +++++++++ .../specific-field/item-page-field.component.ts | 3 +++ 4 files changed, 28 insertions(+) diff --git a/src/app/+item-page/field-components/metadata-field-wrapper/metadata-field-wrapper.component.ts b/src/app/+item-page/field-components/metadata-field-wrapper/metadata-field-wrapper.component.ts index 8c80384732..f528f06ba5 100644 --- a/src/app/+item-page/field-components/metadata-field-wrapper/metadata-field-wrapper.component.ts +++ b/src/app/+item-page/field-components/metadata-field-wrapper/metadata-field-wrapper.component.ts @@ -11,6 +11,9 @@ import { Component, Input } from '@angular/core'; }) export class MetadataFieldWrapperComponent { + /** + * The label (title) for the content + */ @Input() label: string; } diff --git a/src/app/+item-page/field-components/metadata-uri-values/metadata-uri-values.component.ts b/src/app/+item-page/field-components/metadata-uri-values/metadata-uri-values.component.ts index 212dcddee8..8ff3317e06 100644 --- a/src/app/+item-page/field-components/metadata-uri-values/metadata-uri-values.component.ts +++ b/src/app/+item-page/field-components/metadata-uri-values/metadata-uri-values.component.ts @@ -16,11 +16,24 @@ import { MetadataValuesComponent } from '../metadata-values/metadata-values.comp }) export class MetadataUriValuesComponent extends MetadataValuesComponent { + /** + * Optional text to replace the links with + * If undefined, the metadata value (uri) is displayed + */ @Input() linktext: any; + /** + * The metadata values to display + */ @Input() values: any; + /** + * The seperator used to split the metadata values (can contain HTML) + */ @Input() separator: string; + /** + * The label for this iteration of metadata values + */ @Input() label: string; } diff --git a/src/app/+item-page/field-components/metadata-values/metadata-values.component.ts b/src/app/+item-page/field-components/metadata-values/metadata-values.component.ts index 1c94b56d57..90a265b9f7 100644 --- a/src/app/+item-page/field-components/metadata-values/metadata-values.component.ts +++ b/src/app/+item-page/field-components/metadata-values/metadata-values.component.ts @@ -12,10 +12,19 @@ import { Metadatum } from '../../../core/shared/metadatum.model'; }) export class MetadataValuesComponent { + /** + * The metadata values to display + */ @Input() values: Metadatum[]; + /** + * The seperator used to split the metadata values (can contain HTML) + */ @Input() separator: string; + /** + * The label for this iteration of metadata values + */ @Input() label: string; } diff --git a/src/app/+item-page/simple/field-components/specific-field/item-page-field.component.ts b/src/app/+item-page/simple/field-components/specific-field/item-page-field.component.ts index 525c898c0e..ce2b110efd 100644 --- a/src/app/+item-page/simple/field-components/specific-field/item-page-field.component.ts +++ b/src/app/+item-page/simple/field-components/specific-field/item-page-field.component.ts @@ -13,6 +13,9 @@ import { Item } from '../../../../core/shared/item.model'; }) export class ItemPageFieldComponent { + /** + * The item to display metadata for + */ @Input() item: Item; /**