Sp-dev-docs: FieldCustomizer - InternalFieldName does not work, DisplayName does

[johannes-z]

Category

• [ ] Question
• [ ] Typo
• [x] Bug
• [ ] Additional article idea

Expected or Desired Behavior

The FieldCustomizer scaffolding generates a serve.json that looks like this:

      "fieldCustomizers": {
        "InternalFieldName": {
          "id": "...",
          "properties": {
            "sampleText": "Value"
          }
        }
      }

It specifically says InternalFieldName, although only the DisplayName of the field works.

Observed Behavior

I have a column called MyField (InternalName) with a title of My Custom Field (DisplayName). Using MyField as InternalFieldName, nothing happens when I run gulp.serve. When I change the field name inside serve.json to My Custom Field instead, it works.

[msft-github-bot]

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

[CPritch]

I can confirm this is an issue on our end of things. I doubt that this applies to deployed Field Customizers but is incredibly annoying as it means you cannot test locally any field that has a space in the Title.

[CPritch]

@GrahamMcMynn why was this closed? This is still an issue.

[GrahamMcMynn]

Sorry about that, I misunderstood your comment when you said you can confirm it is an issue on your end of things.

[andrewconnell]

Can you provide additional context? Which SPFx version, which environment, etc?

[msft-github-bot]

The more context details you can provide, the easier it is to help assist on issues. Any code you can provide and/or screenshots of the issue also help. The easier you can make it to reproduce the issue, the easier and quicker it is for someone to help you. Things that always help posting with every issue include (1) SharePoint environment(s) (on-prem / SP 2016 / SP 2019 / SharePoint Online), (2) if SharePoint Online, is the tenant configured for standard / targeted release, (3) if SharePoint Framework, list the versions of installed tools (Node.js, NPM, Yeoman, Gulp, SPFx generator, etc... use npm list -g --depth=0), (4) if applicable, browser(s) tested, (5) if applicable, version of Office UI Fabric React & (6) anything else you can provide.

[johannes-z]

@andrewconnell I used the latest version back then, which was, I believe, 1.9.1, targetting SharePoint Online.

[CPritch]

This was not working correctly for me in both a targeted-release tenant and standard-release tenant in SPO for 1.9.1. The served component only works for the title of a column rather than the internal name as described by all documentation.

[andrewconnell]

Confirmed...

[kemesfun]

@johannes-z I am not able to reproduce this issue. Let me know if you are still having this issue.

[msft-github-bot]

This issue has been automatically marked as stale because it has marked as requiring author feedback but has not had any activity for 7 days. It will be closed if no further activity occurs within the next 7 days of this comment. Please see our wiki for more information: Issue List Labels: Needs Author Feedback & Issue List: No response from the original issue author

[jcoolsen]

I think that the missing piece here, is that this issue only happens in development mode. So there is a difference between how stuff works when developing and how it works when deployed.

[msft-github-bot]

Closing issue due to no response from the original author. Please refer to our wiki for more details, including how to remediate this action if you feel this was done prematurely or in error: No response from the original issue author