sp component base.icomponentpropertymetadata

Home > @microsoft/sp-component-base > IComponentPropertyMetadata

IComponentPropertyMetadata interface

This is the structure used for map values for component properties metadata.

Signature:

export interface IComponentPropertyMetadata

Properties

Property	Type	Description
isHtmlString?	boolean	(Optional) Indicates whether the property should be serialized as HTML.
isImageSource?	boolean	(Optional) Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform services like link fix-up, search indexing, loading from CDN, etc.
isLink?	boolean	(Optional) Indicates if the property contains a link. This allows SharePoint server to treat the value as such and perform services like search indexing, link fix-up, loading from CDN, etc.
isSearchablePlainText?	boolean	(Optional) Indicates if the property contains plain text that should be search-indexed by SharePoint.
shouldNotPersist?	boolean	(Optional) Indicates if the framework should persist the property on the server.