This repository has been archived by the owner on Oct 23, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
sp component base.icomponentpropertymetadata
John Nguyen edited this page Aug 19, 2021
·
1 revision
Home > @microsoft/sp-component-base > IComponentPropertyMetadata
This is the structure used for map values for component properties metadata.
Signature:
export interface IComponentPropertyMetadata| 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. |