Skip to content

Change createLocalizableString API #10249

@RomanTsukanov

Description

@RomanTsukanov

This is what a call of the createLocalizableString looks like:

this.createLocalizableString("caption", this, true, "descriptiveTextCaption");

3 out of 4 parameters cannot be understood at a glance, without being looked up in the docs.

Suggested API:

this.createLocalizableString({
  name: "caption",
  owner: this,
  supportsMarkdown: true,
  dictionaryKey: "descriptiveTextCaption" // <-- clarify why this parameter can be boolean
});

Metadata

Metadata

Labels

API changeIssues that request changes in the API

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions