Add support to use `[@bs.unwrap]` with labeled arguments

[liubko]

[email protected]

Can't use [bs.unwrap] with labeled arguments.

Code

[@bs.obj]
external func :
  (
    ~param: string,
    ~polyParam: [@bs.unwrap] [ | `Str(string) | `Int(int)],
    unit
  ) =>
  _ =
  "";

Error

bs.obj label polyParam does not support [@bs.unwrap] arguments

Try it online

[cknitt]

@bobzhang This would come in very handy for writing zero-cost bindings for the new ReasonReact.

[bobzhang]

This would only work when we know the _ is abstract type, otherwise when you create an object t, the type of t##polyParam is not known. How useful when you only support abstract type? thanks

[cknitt]

For binding React components, the type of the result is the abstract type React.element. So this would definitely be very useful! 👍

Another use case would be "options" objects that are passed to React components in some apis and that you model as an abstract type.

[bobzhang]

Where is React.element defined, what kind of ops are allowed on element if it is abstract?

[cknitt]

React.element is defined here: https://github.com/reasonml/reason-react/blob/master/src/React.re

[cknitt]

@rickyvetter This is the issue I mentioned yesterday. @jsiebern needs this for his material-ui bindings, too.

[shurygindv]

what is the status of this? Is it still in progress?

[DCKT]

Hello,

Is this issue resolvable ? This would help a lot to make 0 cost bindings for React components libraries ! I don't know if I can help for this kind of issues :)

Thanks for your works

[sgny]

style prop in React Native components take a single Style.t object or an array (or list) of them. Until now, we used to cast array(Style.t) as Style.t, but we have some interest in differentiating between them. There are a few possible approaches, so you may follow them in the WIP PR.

The closest to @bs.unwrap is to use @bs.ignore, but that introduces a bit more noise. IMO, defining multiple props (polyParam__string and polyParam__int for the above example) is more straightforward, if not quite as rigorous.

[nirvdrum]

With BuckleScript 7 out the door, I've cleaned up a lot of my bindings by removing usages of [@bs.deriving abstract]. Now I can usually use simple record mapping, except in cases where fields must be optional (as in, they should not appear in the generated JS object). In every such case I've come across it's been for generating an argument for a JS method binding. I.e., these are not objects I ever need to read from directly and the type could be abstract. Here, I've found [@bs.obj] to be nicer than [@bs.deriving abstract]; there's less generated code and I think the intent in the binding is clearer.

Unfortunately, since [@bs.unwrap] can't be used with [@bs.obj], I either can't convert such cases away from [@bs.deriving abstract], or worse, have to change my binding away from [@bs.obj] when the binding needs to be updated for something like supporting untagged union types. Since these types would be abstract anyway, I could accept the limitation indicated in https://github.com/BuckleScript/bucklescript/issues/2827#issuecomment-478825051 and it seems to be that this would be a somewhat frequent use case.

[pheuter]

Would be still super useful as of rescript v9.1.4 so that "variant" React props can be passed nicely to external modules, for example with Headless React:

@react.component @module("@headlessui/react")
external make: (
  ~\"as": @unwrap [#Str(string) | #El(React.element)],
  ~className: string
) => React.element = "Menu"

<Menu \"as"={#Str("div")} className="px-3 ..." />
<Menu \"as"={#El(<> </>)} className="px-3 ..." />

As far as I'm aware there's no simple alternative to this other than to define 2 separate MenuString and MenuEl components that both reference Menu but with overloaded as labeled arguments, which is getting to be very messy.

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[zth]

This is at least partly solved by unboxed variants in v11.