Skip to content

Commit

Permalink
Update NativeComponentsWindows.md (#463)
Browse files Browse the repository at this point in the history
Add an optional extended description…
  • Loading branch information
rozele committed Jun 7, 2016
1 parent 82b390f commit 528a7fb
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/NativeComponentsWindows.md
Expand Up @@ -7,15 +7,15 @@ permalink: docs/native-components-windows.html
next: running-on-device-windows
---

There are tons of native UI widgets out there ready to be used in the latest apps - some of them are part of the platform, others are available as third-party libraries, and still more might be in use in your very own portfolio. React Native has several of the most critical platform components already wrapped, like `ScrollView` and `TextInput`, but not all of them, and certainly not ones you might have written yourself for a previous app. Fortunately, it's quite easy to wrap up these existing components for seamless integration with your React Native application.
React Native has several of the most critical platform components already wrapped, like `ScrollView` and `TextInput`, but not all of them, and certainly not ones you might have written yourself for a previous app. Fortunately, it's quite easy to wrap up these existing components for seamless integration with your React Native application.

Like the native module guide, this too is a more advanced guide that assumes you are somewhat familiar with the Universal Windows SDK programming. This guide will show you how to build a native UI component, walking you through the implementation of a subset of the existing `ImageView `component available in the core React Native library.
Like the [native module guide](NativeModulesWindows.md), this too is a more advanced guide that assumes you are somewhat familiar with the Universal Windows SDK programming. This guide will show you how to build a native UI component, walking you through the implementation of a subset of the existing `ImageView `component available in the core React Native library.

## ImageView example

For this example we are going to walk through the implementation requirements to allow the use of ImageViews in JavaScript.

Native views are created and manipulated by extending `ViewManager` or more commonly `SimpleViewManager` . A `SimpleViewManager` is convenient in this case because it applies common properties such as background color, opacity, and Flexbox layout.
Native views are created and manipulated by extending `ViewManager` or more commonly `SimpleViewManager` . A `SimpleViewManager` is convenient in this case because it applies common properties such opacity and Flexbox layout.

These subclasses are essentially singletons - only one instance of each is created by the bridge. They vend native views to the `NativeViewHierarchyManager`, which delegates back to them to set and update the properties of the views as necessary. The `ViewManagers` are also typically the delegates for the views, sending events back to JavaScript via the bridge.

Expand All @@ -29,7 +29,7 @@ Vending a view is simple:

## 1. Create the `ViewManager` subclass

In this example we create view manager class `ReactImageManager` that extends `SimpleViewManager` of type `ReactImageView`. `ReactImageView` is the type of object managed by the manager, this will be the custom native view. Name returned by `getName` is used to reference the native view type from JavaScript.
In this example we create view manager class `ReactImageManager` that extends `SimpleViewManager` with generic argument `Border`. `Border` is the type of framework element managed by the manager, this will be the custom native view. The name returned by the `Name` property is used to reference the native view type from JavaScript. The `Border` type is used to support border radii on images, the background of the `Border` is set to the appropriate `ImageSource`.

```csharp
...
Expand Down Expand Up @@ -63,13 +63,13 @@ protected override Border CreateViewInstance(ThemedReactContext reactContext)

## 3. Expose view property setters using the `[ReactProp]` (or `[ReactPropGroup]`) attribute

Properties that are to be reflected in JavaScript needs to be exposed as setter method annotated with `[ReactProp]` (or `[ReactPropGroup]`). Setter method should take view to be updated (of the current view type) as a first argument and property value as a second argument. Setter should be declared as a `void` method and should be `public`. Property type sent to JS is determined automatically based on the type of value argument of the setter. This project uses [Newtonsoft Json.NET](http://www.newtonsoft.com/json) to provide interoperability with JavaScript types. The parameter types of these attributes may be of any type that can be deserialized using Json.NET. Be aware that the use of composite types such as arrays, generics, and user-defined classes may not be supported out-of-the-box with [.NET Native](https://msdn.microsoft.com/en-us/library/dn584397.aspx) pre-compilation, and you may need add information to the [runtime directives (rd.xml)](https://msdn.microsoft.com/en-us/library/dn600639.aspx) file, or just manually deconstruct the JSON by using [`JArray`].
Properties that are to be reflected in JavaScript needs to be exposed as setter method annotated with `[ReactProp]` (or `[ReactPropGroup]`). Setter method should take view to be updated (of the current view type) as a first argument and property value as a second argument. Setter should be declared as a `void` method and should be `public`. The prop type sent to JS is determined automatically based on the type of parameter for the setter. This project uses [Newtonsoft Json.NET](http://www.newtonsoft.com/json) to provide interoperability with JavaScript types. The prop parameter type may be of any type that can be deserialized using Json.NET. Be aware that the use of composite types such as arrays, generics, and user-defined classes may not be supported out-of-the-box with [.NET Native](https://msdn.microsoft.com/en-us/library/dn584397.aspx) pre-compilation, and you may need to add information to the [runtime directives (rd.xml)](https://msdn.microsoft.com/en-us/library/dn600639.aspx) file, or just manually deconstruct the JSON by using [`JArray`](http://www.newtonsoft.com/json/help/html/T_Newtonsoft_Json_Linq_JArray.htm) or [`JObject`](http://www.newtonsoft.com/json/help/html/T_Newtonsoft_Json_Linq_JObject.htm) as the parameter type.

Attribute `[ReactProp]` has one obligatory argument `Name` of type `String`. Name assigned to the `[ReactProp]` attribute linked to the setter method is used to reference the property on JS side.

Except from `Name`, `[ReactProp]` attribute may take following optional arguments: `DefaultBoolean`, `DefaultInt32`, `DefaultDouble`. Those arguments should be of the corresponding primitive type (accordingly `boolean`, `int`, `double`) and the value provided will be passed to the setter method in case when the property that the setter is referencing has been removed from the component. Note that "default" values are only provided for primitive types, in case when setter is of some complex type, `null` will be provided as a default value in case when corresponding property gets removed.
Except from `Name`, `[ReactProp]` attribute may take various optional arguments, e.g.: `DefaultBoolean`, `DefaultInt32`, `DefaultDouble`. Those arguments should be of the corresponding primitive type (accordingly `boolean`, `int`, `double`) and the value provided will be passed to the setter method in case when the property that the setter is referencing has been removed from the component. Note that "default" values are only provided for primitive types, in case when setter is of some complex type, `null` will be provided as a default value in case when corresponding property gets removed.

Setter declaration requirements for methods annotated with `[ReactPropGroup]` are different than for `[ReactProp]`, please refer to the `[ReactPropGroup]` attribute class docs for more information about it.
Setter declaration requirements for methods annotated with `[ReactPropGroup]` are different than for `[ReactProp]`, instead of taking a single name for the prop, it takes an array of names, corresponding to the set of parameters used in the group setter, and does not support any optional default value arguments.

**IMPORTANT!** in ReactJS updating the property value will result in setter method call. Note that one of the ways we can update component is by removing properties that has been set before. In that case setter method will be called as well to notify view manager that property has changed. In that case "default" value will be provided (for primitive types "default" can value can be specified using `DefaultBoolean`, `DefaultDouble`, etc. arguments of `[ReactProp]` attribute, for complex types setter will be called with value set to `null`).

Expand Down Expand Up @@ -106,7 +106,7 @@ public void SetSource(Border view, string source)

## 4. Register the `ViewManager`

The final Java step is to register the ViewManager to the application, this happens in a similar way to [Native Modules](docs/native-modules-windows.html), via the applications package member function `CreateViewManagers.`
The final step is to register the ViewManager to the application, this happens in a similar way to [Native Modules](docs/native-modules-windows.html), via the applications package member function `CreateViewManagers.`

```csharp
public IReadOnlyList<IViewManager> CreateViewManagers(
Expand Down Expand Up @@ -245,4 +245,4 @@ var RCTMyCustomView = requireNativeComponent(`RCTMyCustomView`, MyCustomView, {
});
```

Note the use of `nativeOnly` above. Sometimes you'll have some special properties that you need to expose for the native component, but don't actually want them as part of the API for the associated React component. For example, `Switch` has a custom `onChange` handler for the raw native event, and exposes an `onValueChange` handler property that is invoked with just the boolean value rather than the raw event (similar to `onChangeMessage` in the example above). Since you don't want these native only properties to be part of the API, you don't want to put them in `propTypes`, but if you don't you'll get an error. The solution is simply to call them out via the `nativeOnly` option.
Note the use of `nativeOnly` above. Sometimes you'll have some special properties that you need to expose for the native component, but don't actually want them as part of the API for the associated React component. For example, `Switch` has a custom `onChange` handler for the raw native event, and exposes an `onValueChange` handler property that is invoked with just the boolean value rather than the raw event (similar to `onChangeMessage` in the example above). Since you don't want these native only properties to be part of the API, you don't want to put them in `propTypes`, but if you don't you'll get an error. The solution is simply to call them out via the `nativeOnly` option.

0 comments on commit 528a7fb

Please sign in to comment.