[ SharePoint Framework ] 11. Integrate web part properties with SharePoint

일반적으로, 웹 파트를 구축 할 때는 웹 파트 속성이 SharePoint와 분리되어 최종 사용자가 그 값을 관리했습니다. SharePoint Framework는 웹 파트 속성 값 관리를 단순화하고 이를 SharePoint 검색과 통합 할 수있는 새로운 기능을 제공합니다. 

 

이 문서에서는 SharePoint Framework 클라이언트 쪽 웹 파트를 작성할 때

이러한 기능을 사용하는 방법에 대해 설명합니다.

 

Client-side web part properties

SharePoint Framework 클라이언트 측 웹 파트를 작성할 때 사용자가 구성 할 수있는 속성을 정의 할 수 있습니다. 

고정 된 값 대신 속성을 사용하면 웹 파트가 더 유연하고 다양한 시나리오에 적합합니다.

기존 웹 파트와 비교하여 SharePoint Framework가 웹 파트 속성을 처리하는 방법에는 약간의 차이가 있습니다. 다음 스키마는 웹 파트 속성 값이 서로 다른 SharePoint 계층을 통과하는 방법을 보여줍니다.

최종 사용자의 웹 파트 속성 값을 수락하기 전에 항상 값을 확인해야합니다 . 이렇게하면 웹 파트가 사용자에게 친숙한 지 확인할 수있을뿐만 아니라 웹 파트 구성에 유효하지 않은 데이터가 저장되는 것을 방지 할 수 있습니다.

또한 SharePoint Framework는 개인 설정을 지원하지 않으며 모든 사용자는 특정 웹 파트의 동일한 구성을 볼 수 있습니다.

Specify web part property value type

 

기존 SharePoint 웹 파트에서는 웹 파트 속성 값이 SharePoint와 분리되어 있습니다.

SharePoint에 저장된 파일의 URL을 가진 웹 파트 속성이있는 경우이 URL이 유효하고 이동 또는 이름이 바뀔 경우 올바른 문서를 가리키는 지 수동으로 확인해야합니다. 또한 사용자가 웹 파트에 표시 할 텍스트를 입력하도록 허용 한 경우 해당 텍스트는 SharePoint Search에서 인덱싱되지 않습니다.

웹 파트를 작성할 때 SharePoint Framework를 사용하면 특정 웹 파트 속성에 어떤 종류의 가치가 있는지 지정할 수 있습니다. 이 구성은 SharePoint가 값을 처리하는 방법을 결정합니다. 지정된 구성에 따라 SharePoint는 검색 인덱스에 특정 속성 값을 포함하고 안전하지 않은 HTML을 제거하며 파일이 이동되거나 이름이 변경 될 경우 SharePoint에 저장된 문서에 대한 링크를 최신 상태로 유지할 수 있습니다.

웹 파트 속성에서 구성을 지정하려면 웹 파트 클래스에서 propertiesMetadata 게터를 재정의합니다.

import {
  BaseClientSideWebPart,
  IPropertyPaneConfiguration,
  PropertyPaneTextField,
  IWebPartPropertiesMetadata
} from '@microsoft/sp-webpart-base';

// ...

export default class ArticleLinkWebPart extends BaseClientSideWebPart<IArticleLinkWebPartProps> {
  // ...
  protected get propertiesMetadata(): IWebPartPropertiesMetadata {
    return {
      'title': { isSearchablePlainText: true },
      'intro': { isHtmlString: true },
      'image': { isImageSource: true },
      'url': { isLink: true }
    };
  }
  // ...
}