Fix the remaining broken links on fbflipper.com
Summary: Used https://www.brokenlinkcheck.com/broken-links.php#status for now to find broken links and fixed them all. Would be better to use some automated tool to check this at diff time, but that's not setup yet. Reviewed By: passy Differential Revision: D21301702 fbshipit-source-id: f13c8769b15d9f99563fc65dc0544320d07a2bfb
This commit is contained in:
committed by
Facebook GitHub Bot
parent
f1abd8a4a4
commit
7e4682b694
@@ -60,4 +60,4 @@ This will ask Flipper desktop to generate a client certificate, using the CSR pr
|
||||
|
||||
Depending on the client, `destination` can have a different meaning. A basic example would be a file path, that both the desktop and the client have access to. With this Flipper desktop could write the certificate to that path. A more involved example is that of the Android Client, where destination specifies a relative path inside an app container. And the Subject Common Name determines which app container. Together these two pieces of information form an absolute file path inside an android device.
|
||||
|
||||
For Flipper desktop to work with a given Client type, it needs to be modified to know how to correctly interpret the `destination` argument, and deploy certificates to it. You can see the current implementations in [CertificateProvider.tsx](https://github.com/facebook/flipper/blob/master/desktop/src/utils/CertificateProvider.tsx).
|
||||
For Flipper desktop to work with a given Client type, it needs to be modified to know how to correctly interpret the `destination` argument, and deploy certificates to it. You can see the current implementations in [CertificateProvider.tsx](https://github.com/facebook/flipper/blob/master/desktop/app/src/utils/CertificateProvider.tsx).
|
||||
|
||||
@@ -65,7 +65,7 @@ Pseudo-classes can be used like this:
|
||||
|
||||
## Colors
|
||||
|
||||
The colors module contains all standard colors used by Flipper. All the available colors are defined in [`desktop/src/ui/components/colors.tsx`](https://github.com/facebook/flipper/blob/master/desktop/src/ui/components/colors.tsx) with comments about suggested usage of them. And we strongly encourage to use them. They can be required like this:
|
||||
The colors module contains all standard colors used by Flipper. All the available colors are defined in [`desktop/src/ui/components/colors.tsx`](https://github.com/facebook/flipper/blob/master/desktop/app/src/ui/components/colors.tsx) with comments about suggested usage of them. And we strongly encourage to use them. They can be required like this:
|
||||
|
||||
```javascript
|
||||
import {colors} from 'flipper'
|
||||
|
||||
@@ -12,4 +12,4 @@ Flipper itself only provides the architectural platform. What makes it useful ar
|
||||
|
||||
The Flipper desktop app and the mobile native SDK establish a connection which is used to send data to and from the device. Flipper does not make any restrictions on what kind of data is being sent. This enables a lot of different use-cases where you want to better understand what is going inside your app. For example you can visualize the state of local caches, events happening or trigger actions on your app from the desktop.
|
||||
|
||||
If there is no plugin that does exactly what you want, you can build your own plugin, tailored to your needs. A plugin always consists of the native implementation sending and receiving data and the desktop plugin visualizing data. Learn more on how to [extend Flipper](extending/index) and build your own plugin. The native implementations are written in Java, Objective-C, or C++, the desktop UI is written in React.
|
||||
If there is no plugin that does exactly what you want, you can build your own plugin, tailored to your needs. A plugin always consists of the native implementation sending and receiving data and the desktop plugin visualizing data. Learn more on how to [extend Flipper](../extending/index) and build your own plugin. The native implementations are written in Java, Objective-C, or C++, the desktop UI is written in React.
|
||||
|
||||
@@ -45,8 +45,8 @@ _Example Flipper plugin: playing a game of Tic Tac Toe using Flipper and some em
|
||||
|
||||
If you would love to build a specific (or generic) extension for Flipper check out the following pointers! Plugins for Flipper can be distributed through NPM so sharing them is trivial.
|
||||
|
||||
→ Creating a React Native Flipper Plugin https://fbflipper.com/docs/tutorial/react-native.html
|
||||
→ Create a Flipper Desktop Plugin https://fbflipper.com/docs/tutorial/js-setup.html
|
||||
→ Creating a React Native Flipper Plugin https://fbflipper.com/docs/tutorial/react-native
|
||||
→ Create a Flipper Desktop Plugin https://fbflipper.com/docs/tutorial/js-setup
|
||||
|
||||
### Community React Native plugins for Flipper
|
||||
|
||||
|
||||
@@ -112,4 +112,4 @@ Finally, you need to add plugins to your Flipper client. Above, we have only add
|
||||
|
||||
## Having trouble?
|
||||
|
||||
See the [troubleshooting page](troubleshooting.html) for help with known problems.
|
||||
See the [troubleshooting page](../troubleshooting) for help with known problems.
|
||||
|
||||
@@ -114,4 +114,4 @@ public class MainApplication extends Application implements ReactApplication {
|
||||
|
||||
## Further Steps
|
||||
|
||||
To create your own plugins and integrate with Flipper using JavaScript, check out our [writing plugins for React Native](tutorial/react-native) tutorial!
|
||||
To create your own plugins and integrate with Flipper using JavaScript, check out our [writing plugins for React Native](../tutorial/react-native) tutorial!
|
||||
|
||||
@@ -4,7 +4,7 @@ title: Crash Reporter Setup
|
||||
sidebar_label: Crash Reporter
|
||||
---
|
||||
|
||||
You do not have to instantiate it in your app in order to use its basic functionality mentioned [here](features/crash-reporter-plugin). You can also use crash reporter plugin to send the notifications for the exception which you suppress in your Android application. You could even use it to send the notifications when the [Litho Error Boundary](https://fblitho.com/docs/error-boundaries) is triggered. In order to send your custom notification you will have to follow the following steps.
|
||||
You do not have to instantiate it in your app in order to use its basic functionality mentioned [here](../features/crash-reporter-plugin). You can also use crash reporter plugin to send the notifications for the exception which you suppress in your Android application. You could even use it to send the notifications when the [Litho Error Boundary](https://fblitho.com/docs/error-boundaries) is triggered. In order to send your custom notification you will have to follow the following steps.
|
||||
|
||||
## Android
|
||||
|
||||
|
||||
@@ -35,13 +35,13 @@ export default class SeaMammals extends FlipperPlugin<State, any, PersistedState
|
||||
}
|
||||
```
|
||||
|
||||
You can see how we are styling our components using [emotion](https://emotion.sh/). To learn more about this, make sure to read our guide on [styling components](extending/styling-components).
|
||||
You can see how we are styling our components using [emotion](https://emotion.sh/). To learn more about this, make sure to read our guide on [styling components](../extending/styling-components).
|
||||
|
||||
## Adding data handling
|
||||
|
||||
The plugin is quite useless when we don't display any actual data. We are adding two static properties to our plugin class for data handling. `defaultPersistedState` defines the default state before we received any data. In `persistedStateReducer` we define how new data is merged with the existing data.
|
||||
|
||||
For the default state we define an empty object because we don't have any data, yet. When receiving data, we simply add it to the existing object, using the ID as a key. Learn more about [persistedState](extending/js-plugin-api.md#persistedstate) in our guide.
|
||||
For the default state we define an empty object because we don't have any data, yet. When receiving data, we simply add it to the existing object, using the ID as a key. Learn more about [persistedState](../extending/js-plugin-api#persistedstate) in our guide.
|
||||
|
||||
```js
|
||||
static defaultPersistedState: PersistedState = {
|
||||
|
||||
@@ -7,7 +7,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
|
||||
Now that we have the native side covered, let's display the data we're sending
|
||||
on the desktop side. You can check out the full workflow of building Flipper desktop
|
||||
plugins here: https://fbflipper.com/docs/extending/js-setup.html.
|
||||
plugins here: https://fbflipper.com/docs/extending/js-setup.
|
||||
|
||||
<img alt="Custom cards UI for our sea mammals plugin" src={useBaseUrl("img/js-custom.png")} />
|
||||
|
||||
|
||||
@@ -130,7 +130,7 @@ export default createTablePlugin<Row>({
|
||||
buildRow,
|
||||
});
|
||||
```
|
||||
*See [index.tsx](https://github.com/facebook/flipper/blob/master/desktop/plugins/seamammals/index.tsx)*
|
||||
*See [index.tsx](https://github.com/facebook/flipper/blob/master/desktop/plugins/seamammals/src/index.tsx)*
|
||||
|
||||
The `method` we define here corresponds to the name
|
||||
of the function we call on the native side to inform
|
||||
|
||||
@@ -17,7 +17,7 @@ To expose Flipper to the JavaScript world, the React Native Native Module `react
|
||||
Registering a new plugin is done by importing `addPlugin` from `"react-native-flipper"` and providing it an object that at least implements the method `getId` (the plugin id that should be used in the desktop plugin as well to make the connection) and two event handlers for the `onConnect` and `onDisconnect` events.
|
||||
|
||||
These `onConnect` and `onDisconnect` events are triggered every time the plugin becomes (in)active in the Flipper desktop application.
|
||||
If the plugin is a [background plugin](../extending/create-plugin.md#background-plugins), these events are triggered typically only once (they might be triggered never, if the Desktop user didn't enable the plugin, or multiple times if they enabled or disabled the plugin a few times).
|
||||
If the plugin is a [background plugin](../extending/create-plugin#background-plugins), these events are triggered typically only once (they might be triggered never, if the Desktop user didn't enable the plugin, or multiple times if they enabled or disabled the plugin a few times).
|
||||
|
||||
The `onConnect` callback receive a `connection` which can be used to communicate with the backend:
|
||||
|
||||
@@ -44,7 +44,7 @@ addPlugin({
|
||||
|
||||
You might want to store the connection somewhere to be able to send more events as long as `onDisconnect` event hasn't been fired.
|
||||
|
||||
The `connection` object can also be used to listen to messages coming from the Desktop plugin. See [Client Plugin API](create-plugin) for details.
|
||||
The `connection` object can also be used to listen to messages coming from the Desktop plugin. See [Client Plugin API](../extending/create-plugin) for details.
|
||||
|
||||
An example plugin to play a little Tic-Tac-Toe between the Flipper Desktop and a React Native app can be found inside this repository as well (run `yarn && yarn android` in `react-native/ReactNativeFlipperExample` to start the test project):
|
||||
|
||||
|
||||
Reference in New Issue
Block a user