Summary:
I trimmed the previous versions of this down a lot to only
focus on what RN developers need to know without duplicating
what we have in the non-RN docs.
Reviewed By: mweststrate
Differential Revision: D20816115
fbshipit-source-id: 9d88a6fb0d49e823194cce647e64b86d61d6229a
Summary:
This is a first step in breaking up the getting started docs.
Ultimately, the React Native Android and iOS bits will become
separate sections, too, but I won't to keep the diffs a bit smaller.
This one doesn't really do much apart from reorganising the current
content.
Reviewed By: mweststrate
Differential Revision: D20815235
fbshipit-source-id: 5c85b788211699a2a9f5808b9e2590c7db68a1c1
Summary:
I think this'll clarify how to use the lifecycle methods.
Diagram edit link: https://excalidraw.com/#json=5696112581148672,nDwD6t1BNXVreQ8YE8917g
Reviewed By: mweststrate
Differential Revision: D20645302
fbshipit-source-id: 0814dbe8421cfe8e85c297bd5bfb4a8f1a83c353
Summary: Added docs on how to write React-Native JavaScript based plugins
Reviewed By: passy
Differential Revision: D19344803
fbshipit-source-id: ad1ea66f1031760729fdaea8a7e6c1ef5dcd5439
Summary:
Random observations
1. RN already generates the Flipper initialization code out of the box
2. This code assumes a prefixed namespace: `facebook.flipper`. Maybe it would be better if that were `appname`, but that seems an unnecessary burden at this point, preventing direct copy / paste possibilities
3. Out of the box, the generated code by RN doesn't align with the code provided here, because no `ReactInstanceManager` argument is passed in (nor does it seem to be available in a straight-forward way)
4. patch MainApplication.java with `getReactNativeHost().getReactInstanceManager()`
5. turn this into an explicit section: https://fbflipper.com/docs/tutorial/js-table.html#dynamic-plugin-loading. Also explain that when using `node_modules`, config doesn't need to be changed?
6. xcode 10! sudo xcode-select -s /Applications/Xcode_10.XXX/Contents/Developer/
7. Also tried to install Reactotron plugins by Infinite Red, got that compilable in the end, but the andoid / ios implementations still seems to be stub, so I'll try to follow up with them later, to be notified when they actually have something
Reviewed By: passy
Differential Revision: D18349098
fbshipit-source-id: 233bbe20a37c57c7dfe08c8fccdd4508bdefe96f
Summary:
Added docs for the Navigation Plugin.
I've added instructions on how to use the plugin with vanilla Android, or how to integrate it with a third party solution.
Reviewed By: danielbuechele
Differential Revision: D16856614
fbshipit-source-id: e99cb94318820bd926f50bd4ba205fb11396a9d8
Summary:
Now that we finally have something we can screenshot ...
Just for the features page right now, will add some
"installation" instructions next.
Reviewed By: oprisnik
Differential Revision: D15898050
fbshipit-source-id: 9dfd3b1121799e7069336aac845ba2abdb3e42df
Summary:
- Layout was in an odd spot. "Other platforms" is still weird, but it's at least next to the JS part now.
- Tutorial is the first thing after the intro.
Reviewed By: danielbuechele
Differential Revision: D15198470
fbshipit-source-id: 263582ee51f228a295be5952f5dc219e53c5e3e6
Summary:
JS is next. Screenshot on the intro page is really bad.
I hope danielbuechele can replace this. :)
Reviewed By: jknoxville
Differential Revision: D15184371
fbshipit-source-id: 2faaf46450d192ae400675c13b8d71fa1b7dab14
Summary: Inlining the component docs header instead of reading it from the same file we write to.
Reviewed By: passy
Differential Revision: D15199683
fbshipit-source-id: dc34e25b5f8073aa582f90a14bc875c8e8c431db
Summary:
JS pages first, then client pages.
Would be nice if we had some sort of separator, but I think you can only have two levels.
Reviewed By: danielbuechele
Differential Revision: D15198312
fbshipit-source-id: 6c9f8d8775f513a55c256366448faed13b671767
Summary:
* Renamed to "Client Plugin API" to align with the "JavaScript Plugin API" page.
* Added some more info and reworded some parts.
Reviewed By: danielbuechele
Differential Revision: D15198192
fbshipit-source-id: 2c86b6a852e9ed52b0885eb5b7db8436028489d5
Summary: This was missing because it was still being generated in /docs.
Reviewed By: danielbuechele
Differential Revision: D15198144
fbshipit-source-id: aa9e77a1603fb63c1a7576091b70d8fa7124ab16
Summary: Documents init in the API reference and deletes the now redundant communicating page.
Reviewed By: danielbuechele
Differential Revision: D15198128
fbshipit-source-id: a9b88632b74edd7d9656ed888192db1fbe7f3642
Summary:
* Made the code snippets uniform across languages.
* Renamed to "Providing data to plugins" because sending hints at sending across the desktop-client connection which is misleading.
Reviewed By: danielbuechele
Differential Revision: D15198081
fbshipit-source-id: e2c318cdc6055c191f47e846b518c26dd21e4a68
Summary: This documents all pretty much the entire API.
Reviewed By: passy
Differential Revision: D15187834
fbshipit-source-id: 073c6a0dc40e3373967e9e5c5b7d44ab9c0aa07f
Summary:
The purpose of this page wasn't that clear to me, though the content is pretty focused. I've changed it from JS setup to JS Plugin Definition, and reworded it a bit.
I think it makes sense if this specifies everything to do with plugins on the file system, and the next page talks about what you do in javascript.
Reviewed By: passy
Differential Revision: D15184829
fbshipit-source-id: 6335ebc8d4297ffcbf1ab9860b4f055fe5bbcf87
Summary:
This page got lost in the reorganisation. Adding it back.
There's still work to be done on the content and organisation of these docs.
Reviewed By: passy
Differential Revision: D15184349
fbshipit-source-id: 76256ba53189579bec363903dc4068a421cafc98
Summary:
Please give feedback on the sidebar placement.
This is only the Android part. I'll put up a second diff copying the iOS thing over
but hope someone can commandeer that and check for accuracy.
Reviewed By: priteshrnandgaonkar
Differential Revision: D15181454
fbshipit-source-id: d32081feefbfb0ffc38890e835a7d5f6b78667ab
Summary: Describes the interface that clients should conform to to implement the layout plugin.
Reviewed By: danielbuechele
Differential Revision: D15166234
fbshipit-source-id: b86303f18f33762f09cfc503ece856cfcc887493
Summary: I can't take credit for this, I found it in the internal wiki. Have just modernised it and made it public.
Reviewed By: danielbuechele
Differential Revision: D15165547
fbshipit-source-id: d59344aa6ad47be6ab32b88abcdfc14a7d20c775
Summary:
Specifies the API for implementing your own Flipper Client.
I believe this provides everything you need to know to build a flipper-compliant client.
The only snag is that the current certificate exchange procedure would require a change to allow for new OS's, device types etc. It would be much better if we had a TLS-opt out so you don't need to go through all that rigmarole.
Reviewed By: passy
Differential Revision: D15150550
fbshipit-source-id: 2878dcc174807c3f86c0562660e8a3e43e5777b1
Summary: Adding a "features" page to the to bar and splitting plugin descriptions from their setup instructions.
Reviewed By: jknoxville
Differential Revision: D15147464
fbshipit-source-id: b2106d825454c3b2989eb1e536b128ef9b6d0247
Summary: Adds a bunch of steps to take if you're having trouble.
Reviewed By: danielbuechele
Differential Revision: D9811295
fbshipit-source-id: 6802108e98850ab11764081491a528eb939d2224
Summary:
Mention the snapshot releases we now publish and how
to use them.
Reviewed By: jknoxville
Differential Revision: D9654559
fbshipit-source-id: 0b4721a29f93d92a27cc1833bfc98b5642461d94
Summary: Updated the website with the new name flipper
Reviewed By: passy
Differential Revision: D9046642
fbshipit-source-id: e4c6e77ddba62b8ebedf5639dc7cc6375b857cd9
