Commit Graph

1351 Commits

Author SHA1 Message Date
Pritesh Nandgaonkar
a89b732765 Fix typo
Summary: Fixes a typo

Reviewed By: jknoxville

Differential Revision: D15200593

fbshipit-source-id: baf5679e095e7bc430f56de03793033c16d59f5f
2019-05-07 04:08:50 -07:00
Pritesh Nandgaonkar
0c54699371 iOS tutorial setup
Summary:
I copied the wordings from Pascal's android setup and changed the API's to match the iOS one. 🙈
This doc explains how to build custom plugin in iOS

Reviewed By: passy

Differential Revision: D15200426

fbshipit-source-id: 0a3c966f7c74aae410c6b3ee643e5a38d33880de
2019-05-07 04:08:50 -07:00
Pascal Hartig
2885f87189 Update copyright headers (#433)
Summary:
Style is modified, so I think it's okay to add
our header there too.
Pull Request resolved: https://github.com/facebook/flipper/pull/433

Differential Revision: D15213091

Pulled By: passy

fbshipit-source-id: c02b67b022f12fdb3e0da39a308d33b073dcb9d3
2019-05-04 11:16:23 -07:00
Daniel Büchele
f3876fbaad update custom JS tutorial
Summary: Update according to changes in D15200794

Reviewed By: jknoxville

Differential Revision: D15200901

fbshipit-source-id: ef0e0895f30d6eb98536c9a7df7a0d46bb4af8d2
2019-05-03 16:24:51 -07:00
Pascal Hartig
6dda7d2b63 More headers
Reviewed By: jknoxville

Differential Revision: D15199272

fbshipit-source-id: d46355a284a6e2acdaccd622dfd4419b06e61a61
2019-05-03 12:08:04 -07:00
John Knox
98d3dd4ebd Add initialSortOrder prop
Summary: Allows for sort order to be preserved and applied from the start.

Reviewed By: danielbuechele

Differential Revision: D15182696

fbshipit-source-id: ad546ce35bf4637ca637589c6c3d6291a4313db7
2019-05-03 11:13:11 -07:00
John Knox
70edb08999 Remember resized column sizes
Summary:
Adds a global inside managed table where, whenever a table key is provided, the column sizes are stored.
Then if a new table is constructed with the same key, it will get the sizes from before.

Reviewed By: danielbuechele

Differential Revision: D15181762

fbshipit-source-id: 98b5a14f8805075928cbe51511609b8b58c512fd
2019-05-03 11:07:31 -07:00
Daniel Büchele
16ed255e2d merge persistedState by keys
Summary: Pushing all new rows into an array could result in duplicate entries. Now the data is stored in an object, using the row's id as a key. This deduplicates the data.

Reviewed By: jknoxville

Differential Revision: D15200794

fbshipit-source-id: 6afa2b7d02c1bdb796c250400938c38c51fdd207
2019-05-03 10:53:20 -07:00
John Knox
37101cd1a7 Tidy up error handling page
Summary: Some wording corrections, and added FlipperResponder section.

Reviewed By: passy

Differential Revision: D15200397

fbshipit-source-id: 2d52b1d7cb55b4cb8b0e15f00242201edf520f16
2019-05-03 10:29:43 -07:00
Pascal Hartig
b3b75939a8 Reorganise extend sidebar
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
2019-05-03 10:21:22 -07:00
Pascal Hartig
531b5e850c JS custom UI tutorial
Summary:
- Adding tutorial for custom JS UI
- optimizing screenshots
- fixing overlapping screenshots on landing page

Reviewed By: jknoxville

Differential Revision: D15198105

fbshipit-source-id: db53403b84a2c422650a4f80e959dad6e984d274
2019-05-03 10:21:22 -07:00
Pascal Hartig
1afece19e7 JS table tutorial
Summary: Image is a placeholder, again.

Reviewed By: jknoxville

Differential Revision: D15185033

fbshipit-source-id: 6c60709d35da97c41a7c4328ef597747d6cea389
2019-05-03 10:21:21 -07:00
Pascal Hartig
2b0e91aa69 Add tutorial section and Android part
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
2019-05-03 10:21:21 -07:00
Pascal Hartig
f584eb05dd Another round of header updates
Summary: I hope that this takes care of all the android violations.

Reviewed By: danielbuechele

Differential Revision: D15199150

fbshipit-source-id: 0f5b4edc1bc9d38de0885f88bb2c3e43acfa09cd
2019-05-03 09:59:33 -07:00
Pritesh Nandgaonkar
b1be6400b8 Added custom swift plugin
Summary: Our very own SeaMammal plugin for iOS written in swift

Reviewed By: passy

Differential Revision: D15199381

fbshipit-source-id: 10b085c314328ff52ae3f5feef51f70d0ce12f1b
2019-05-03 09:53:53 -07:00
Pritesh Nandgaonkar
a8e7f0e028 Updated the installation instruction for swift projects with use_framework
Summary: As per the title. This diff tackles the installation issue for swift projects with `use_framework!`. For more information on this bug follow the discussion [here](https://github.com/facebook/flipper/issues/254)

Reviewed By: danielbuechele

Differential Revision: D15198527

fbshipit-source-id: 573d328369d4bf566ed89f707ed2d6902da0443a
2019-05-03 09:53:52 -07:00
John Knox
c866ba9428 Fix website yarn start
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
2019-05-03 09:47:59 -07:00
John Knox
23b35e8006 Add debugging page
Summary: Information about debugging.

Reviewed By: passy

Differential Revision: D15198711

fbshipit-source-id: 587bca43d99908b666c58bb5279fadb61219e9a1
2019-05-03 09:47:59 -07:00
Pascal Hartig
259adf1f36 Add missing yarn.lock
Summary: Per title.

Reviewed By: jknoxville

Differential Revision: D15198096

fbshipit-source-id: fcdc190a389351f08374de8e6dc984d39f04e8c9
2019-05-03 09:20:14 -07:00
Pascal Hartig
65c0dd1a86 Add missing swift/objc headers
Summary: Per title

Reviewed By: danielbuechele

Differential Revision: D15199200

fbshipit-source-id: a4251311d7fd2d22d39ba89ba0052514abbc3e2c
2019-05-03 09:13:17 -07:00
Pascal Hartig
74c8dbe631 Fix gradle directory error
Summary:
Without this, running clean as part of a longer build
chain will fail because it tries to write to a directory
which got removed in a previous step.

Reviewed By: jknoxville

Differential Revision: D15197982

fbshipit-source-id: 296f5a30661a6e2138c0e37f0103f1b6a82bcfc9
2019-05-03 08:51:13 -07:00
John Knox
0149296fc1 Reorder extending sidebar
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
2019-05-03 07:10:58 -07:00
John Knox
2588338c41 Tidy up and rename "Mobile Setup" page
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
2019-05-03 07:10:58 -07:00
John Knox
733d61132e Restore UI components page in sidebar
Summary: This was missing because it was still being generated in /docs.

Reviewed By: danielbuechele

Differential Revision: D15198144

fbshipit-source-id: aa9e77a1603fb63c1a7576091b70d8fa7124ab16
2019-05-03 07:10:57 -07:00
John Knox
d5573644ac Delete communicating and move the missing info into js-plugin-api
Summary: Documents init in the API reference and deletes the now redundant communicating page.

Reviewed By: danielbuechele

Differential Revision: D15198128

fbshipit-source-id: a9b88632b74edd7d9656ed888192db1fbe7f3642
2019-05-03 07:10:57 -07:00
John Knox
f72e4b5122 Tidy up "Sending data to Plugins" page
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
2019-05-03 07:10:57 -07:00
Pritesh Nandgaonkar
c55bebd1be Tutorial app with sea mammals
Summary: Tutorial app for iOS. It follows the same theme as its android counterpart.

Reviewed By: passy

Differential Revision: D15184515

fbshipit-source-id: bb473c0fa863bb325bb33f8e42c8d6b3d9c640ff
2019-05-03 05:18:47 -07:00
John Knox
57af6fa2bf Add JS Plugin API reference page
Summary: This documents all pretty much the entire API.

Reviewed By: passy

Differential Revision: D15187834

fbshipit-source-id: 073c6a0dc40e3373967e9e5c5b7d44ab9c0aa07f
2019-05-03 04:30:09 -07:00
John Knox
49be7fd35f Redefine Js-Setup as JS Plugin Definition
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
2019-05-03 04:30:09 -07:00
Daniel Büchele
5afb148ffa Migrate to custom plugin
Summary: In this step, we want to visualize our mammals in a custom card view. For this reason, we need to replace `createTablePlugin` with a React component that extends `FlipperPlugin`.

Reviewed By: jknoxville

Differential Revision: D15183324

fbshipit-source-id: 329cdc5c6cbd7e1435538e8cdddf049d914ff221
2019-05-03 02:50:04 -07:00
John Knox
a276af9c1f Show communcating with devices page
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
2019-05-02 12:38:31 -07:00
Pritesh Nandgaonkar
d022cd0e42 Add iOS docs draft for Layout Inspector
Summary:
Updated syntax and code references, but someone else please
check the details here.

Reviewed By: jknoxville

Differential Revision: D15181483

fbshipit-source-id: 93ed636c2d72f33151759e822d77e80e3abd6f03
2019-05-02 12:38:31 -07:00
Pritesh Nandgaonkar
29391db65d Fixed the copy button being overlapped with the text
Summary:
BUG:

{F157319747}

Reviewed By: passy

Differential Revision: D15181532

fbshipit-source-id: cb0f91e7b90b479200cb57c496ae34c87ad35001
2019-05-02 11:31:12 -07:00
Pascal Hartig
adba73ba3c Increase top padding for code buttons
Summary: priteshrnandgaonkar pointed out that they sometimes overlap with the text.

Reviewed By: jknoxville

Differential Revision: D15182356

fbshipit-source-id: def39676d5dcce85aa0b41760cec0ec5cfb9398c
2019-05-02 10:59:13 -07:00
Pascal Hartig
7dae5771d9 Add createTablePlugin-based counterpart to tutorial app
Summary: Per title. It's very basic, which is exactly the point.

Reviewed By: jknoxville

Differential Revision: D15182335

fbshipit-source-id: f70f8cd0510a605879dccb9f909f84971a4eedc3
2019-05-02 09:10:26 -07:00
Pascal Hartig
18af62ebfd Add a basic android plugin
Summary:
Moves some things around for package access reasons.
Otherwise sets up the simplest possible plugin that
just sends over all the data it shows in the UI
on connection time. Is that a good idea? You tell me.

JS part coming with the next diff.

Reviewed By: jknoxville

Differential Revision: D15182282

fbshipit-source-id: da5c1de43dfaee273b4eecc0f4512bef872a0ac6
2019-05-02 09:10:26 -07:00
John Knox
c3efb7b45e Fix broken link
Summary: n/a

Reviewed By: danielbuechele

Differential Revision: D15182855

fbshipit-source-id: 251d25a5542d66cb238b74cfe9b99936597d85e5
2019-05-02 08:54:49 -07:00
John Knox
cf9807d432 Fix broken footer links
Summary: n/a

Reviewed By: danielbuechele

Differential Revision: D15182819

fbshipit-source-id: b2a76dfe94af1ecd9c6fc0c5831ae02fc1fde73f
2019-05-02 08:54:49 -07:00
Pascal Hartig
df46c0c63e Add extending Layout Inspector docs
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
2019-05-02 08:44:44 -07:00
Pritesh Nandgaonkar
367bb9a502 Updated the documentation of the crash reporter plugin
Summary: As per title

Reviewed By: passy

Differential Revision: D15181759

fbshipit-source-id: b184c730bbd349cd432956790e8dc192d3fd5ca0
2019-05-02 07:40:58 -07:00
Pascal Hartig
f4f0998f68 Build Android app on Travis (#430)
Summary:
Pull Request resolved: https://github.com/facebook/flipper/pull/430

Per title

Reviewed By: jknoxville

Differential Revision: D15166788

fbshipit-source-id: 2c2fbf67bf6f86a1811f3b1e7ee114dea4b9878c
2019-05-02 05:08:54 -07:00
Pascal Hartig
65d50fe120 Update license headers in xplat
Summary: Per title.

Reviewed By: danielbuechele

Differential Revision: D15166958

fbshipit-source-id: 26f0a6d7523be3192833fd3995bc9f5e948816a6
2019-05-02 05:08:54 -07:00
Pritesh Nandgaonkar
384568a4a0 Updated the documentation of the shared preferences plugin
Summary: As per the title

Reviewed By: passy

Differential Revision: D15181533

fbshipit-source-id: ca2b13dc81cd28fd2d6ab84fbdc000006d2d43e9
2019-05-02 04:58:39 -07:00
Pritesh Nandgaonkar
31542ca790 Update the open source release script
Summary: We no longer require to host the pods on our repository, thus I updated the release script to get rid off the copying part.

Reviewed By: passy

Differential Revision: D15166526

fbshipit-source-id: 1989eff335f83c191b16a78d9562470d7819bc17
2019-05-02 04:58:38 -07:00
John Knox
1d7b526add Don't recommend untemplated use of FlipperClient::getPlugin
Summary: We have a templated function not requiring a downcast, so there's no need to use the non-templated one.

Reviewed By: passy

Differential Revision: D15167856

fbshipit-source-id: 2f125ac9ca62d7ac4c633127104d1cd2954a13fb
2019-05-02 04:10:46 -07:00
John Knox
deff5e96db Display nicer titles for Mac and Windows Device
Summary: MacDevice and Windows device show uncapitalized 'desktop'. Changing them to Mac and Windows.

Reviewed By: passy

Differential Revision: D15168726

fbshipit-source-id: a69ef572d92f82215e548f71e72ef5d7d48beefa
2019-05-02 04:06:43 -07:00
Pascal Hartig
bbee7a3357 Update iOS license headers (and more)
Summary: Add the affiliates bit that the linter is checking for.

Reviewed By: jknoxville

Differential Revision: D15164826

fbshipit-source-id: 500ffe89ec0c2fd3acfbc374408d16a337cecfa4
2019-05-02 03:28:07 -07:00
Daniel Büchele
b0d2983bd4 docs: add code tabs
Summary: adding code tabs for Android, iOS and C++ to improve readability of pages.

Reviewed By: jknoxville

Differential Revision: D15167691

fbshipit-source-id: e7f602a3a1cbe39ef5da0a15bb0bbfc8f79e8ccc
2019-05-01 11:21:54 -07:00
Daniel Büchele
8734b99f8d fixing links, adding nice buttons
Summary: as per title

Reviewed By: jknoxville

Differential Revision: D15167533

fbshipit-source-id: 67d059c478bf0608b598ba7cd6be19157ff41900
2019-05-01 11:21:54 -07:00
John Knox
be7aefc044 Add missing full stop (#429)
Summary:
Trivial change. I missed this earlier.
Pull Request resolved: https://github.com/facebook/flipper/pull/429

Reviewed By: passy

Differential Revision: D15166391

Pulled By: jknoxville

fbshipit-source-id: 3d52eb1da6d21afa9217cc17cfe887a686cde280
2019-05-01 10:27:27 -07:00