Document extensions

Question

Document extensions

brodybits opened this issue 5 years ago · comments

Chris Brody commented 5 years ago

Two kinds of extensions as described in https://youtu.be/hNwQPJy-XZY:

How to make an existing or new primitive component work on more platforms - 17:27 (t=1047 seconds)
Example of adding a new checkbox extension - 19:17 (t=1156 seconds)

The trick is that for each primitive there would be JavaScript files such as:

index.js - for web platform (using react-native-web)
index.android.js - for Android (using react-native)
index.ios.js - for iOS (using react-native)
...

I was not aware of this support for either of the two kinds of extensions until very recently (unfortunately I lost track of which discussion I found https://youtu.be/hNwQPJy-XZY in). I hope we can get this more formally documented in the near future.

P.S. Here are some examples of new "primitive" components (first 2 by myself):

This description was also updated to make it clear that I meant there are two types of extensions: adding new "primitive" components and supporting additional platforms.

Mathieu Dutour · Answer 1 · Thu Apr 11 2019 07:10:20 GMT+0800 (China Standard Time)

Keep in mind that this is not enforced by react-primitives. It's the bundler config that resolves some extensions before others (for the case of react-native, it resolves ios.js before .js).

But yes, a bit of documentation about it would be nice.

Here are the convention we follow:

.android.js -> react-native
.ios.js -> react-native
.js -> react-native-web
.sketch.js -> react-sketchapp
.vr.js -> react-vr (possibly react-360 soon)
.web.js -> react-native.web
.windows.js -> react-native

Chris Brody · Answer 2 · Mon Apr 15 2019 06:51:05 GMT+0800 (China Standard Time)

I hope to contribute some documentation in the near future. For now I would like to focus on Android, iOS, and web. (Examples and documentation for the other platforms would be nice, not sure how much commercial interest there would be.)

P.S. By "hope" I did not mean "promise". That means that there is no commitment, and I think others should feel free to contribute according to their best judgment. I may need a few weeks due to some other priorities. But I did say "near future", not "someday" since I would like to give this much needed task some priority. This may be part of #29 (add docs site).