Sp-dev-docs: PropertyPaneTextField - onGetErrorMessage with Promise is clearing TextField value

[jimmywim]

If you add onGetErrorMessage which returns a Promise of an empty string (i.e. it passes validation), the value of the TextField is cleared when you click or Tab away (blur) from the TextField.

Sample Code:

protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration {
  return {
    pages: [
      {
        header: {
          description: strings.PropertyPaneDescription
        },
        groups: [
          {
            groupName: strings.BasicGroupName,
            groupFields: [
              PropertyPaneTextField('description', {
                label: strings.DescriptionFieldLabel,
                onGetErrorMessage: (): Promise<string> => {
                  return Promise.resolve('')
                }
              })
            ]
          }
        ]
      }
    ]
  };
}

Results:

---

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 08aa20fb-4cde-4ea6-8946-d67451e78e55
• Version Independent ID: 3c47f3e6-427a-681d-42c7-db0a821da0e9
• Content: Validate web part property values
• Content Source: docs/spfx/web-parts/guidance/validate-web-part-property-values.md
• Product: sharepoint
• Technology: sharepoint-framework
• GitHub Login: @spdevdocs
• Microsoft Alias: spdevdocs

[msftbot[bot]]

Thank you for reporting this issue. We will be triaging your incoming issue as soon as possible.

[juliemturner]

I can also confirm that I am seeing this issue in LinksAndHandlebarsTemplate web parts which is currently in production in multiple tenants.

[garrytrinder]

I also seeing a similar behaviour with the out of the box Document Library web part, specifically the Folder property.

Validation works for a entering an incorrect value, but when entering a valid value, it disappears.

[KevinTCoughlin]

Thanks all for the repro. We've identified the break and have a fix.

[Christian-Stahl]

Ok, great me and my customer are waiting for this very welcome fix as well, keep us in the loop, thx!

[ruchira-sapkal]

Yes true. Pls keep us posted with the solution.