deprecate message in favour of content

[nicmosc]

No description provided.

[nicmosc]

@larsbs not sure if to make this required or not. Technically it should be, but then you get the deprecation warning message and the prop type not matching since you might still be using message. Thoughts?

[larsbs]

@nicmosc what's the motivation behind this change in the first place?

[nicmosc]

@larsbs at first it made sense to have message as we thought of using tooltip for "just" simple messages. But in the end we ended up using them to show more complex info (as it has been the case in the estate admin feature) and "message" ends up being misleading.

But that's not all. After adding the Popover component, which is by nature going to have more than just text in it, and wanting to unify the api, it made more sense to have that prop called content (or at least that represents something more than a single "message")

[larsbs]

@nicmosc Ok, have you investigated about what's the standard procedure to deprecate a prop-type that was required?

[nicmosc]

@larsbs For now i've only been able to find things about "why are proptypes deprecated" when referring to the facebook package, which is just 👌😑

At Airbnb they have a mutuallyExclusive type ljharb/prop-types-tools#14 (comment) which could be a solution. Let me know what you think. Otherwise for now the only solution is to not make either required, and throw an error if neither is passed, though we could do this through a custom validator.

This is interesting, though it's not part of the issue: facebook/prop-types#156 (comment)

[larsbs]

@nicmosc then, let's just re-create a mutuallyExclusive type like Airbnb and then, trigger the deprecation error if message is used.

[larsbs]

@nicmosc idea for syntax:

message: CustomPropType.mutuallyExclusive('content', { deprecated: true }),
content: CustomPropType.mutuallyExclusive('message'),

[nicmosc]

@larsbs good one, then shall we also have a custom prop for deprecated only?

deprecatedProp: CustomPropTypes.deprecated(PropTypes.string),

[larsbs]

@nicmosc sure, we're gonna need it eventually.