Documentation for ActivityIndicator (#266)

I am working on migrating documentation of ActivityIndicator from Rebolt to demonstrate the way we should handle this with `odoc`.

Author: grabbou

docs/highlight.pack.js

@@ -1,3 +1,48 @@
+/**
+ Displays a circular loading indicator. Check {{:https://facebook.github.io/react-native/docs/activityindicator.html} React Native docs}
+ for details.
+ 
+ {2 Example}
+
+ {[
+ let component = ReasonReact.statelessComponent("MyComponent");
+
+ let make = _children => {
+ ...component,
+ render: _self => <ActivityIndicator />,
+ };
+ ]}
+
+ To render a default ActivityIndicator (spinner) you don't need to pass any props:
+
+ {2 Props}
+
+ All {{:../View-BsReactNative/#props} [View]} props are accepted.
+
+ {3 animating}
+
+ {[
+ ~animating: bool=?
+ ]}
+
+ {3 color}
+
+ Changes the color of the indicator. Can be either a named color ["tomato"], hex ["#ff0ff"] or an rgb ["rgb(255, 34, 11)"].
+
+ {[
+ ~color: Style.color=?
+ ]}
+
+ {3 size}
+
+ In order to change the size of the indicator pass one of the {{:http://2ality.com/2018/01/polymorphic-variants-reasonml.html} polymorphic variants}:
+
+ {[
+ ~size: [ | `large | `small | `exact(int)]=?
+ ]}
+
+ Note: [exact] is only supported on Android. On iOS, it defaults to [`small].
+ */
 let make:
  (
  ~animating: bool=?,
@@ -57,4 +102,4 @@ let make:
  ReasonReact.stateless,
  ReasonReact.noRetainedProps,
  unit,
- );
+ );

src/components/activityIndicator.rei

@@ -1,4 +1,160 @@
 module type ViewComponent = {
+ /**
+ {2 Props}
+
+ {3 hidesWhenStopped}
+
+ {[
+ ~hidesWhenStopped: bool=?,
+ ]}
+
+ {3 accessibilityLabel}
+
+ {[
+ ~accessibilityLabel: ReasonReact.reactElement=?,
+ ]}
+
+ {3 accessible}
+
+ {[
+ ~accessible: bool=?,
+ ]}
+
+ {3 hitSlop}
+
+ {[
+ ~hitSlop: Types.insets=?,
+ ]}
+
+ {3 onAccessibilityTap}
+
+ {[
+ ~onAccessibilityTap: unit => unit=?,
+ ]}
+
+ {3 onLayout}
+
+ {[
+ ~onLayout: RNEvent.NativeLayoutEvent.t => unit=?,
+ ]}
+
+ {3 onMagicTap}
+
+ {[
+ ~onMagicTap: unit => unit=?,
+ ]}
+
+ {3 responderHandlers}
+
+ {[
+ ~responderHandlers: Types.touchResponderHandlers=?,
+ ]}
+
+ {3 pointerEvents}
+
+ {[
+ ~pointerEvents: [ | `auto | `none | `boxNone | `boxOnly]=?,
+ ]}
+
+ {3 removeClippedSubviews}
+
+ {[
+ ~removeClippedSubviews: bool=?,
+ ]}
+
+ {3 style}
+
+ {[
+ ~style: Style.t=?,
+ ]}
+
+ {3 testID}
+
+ {[
+ ~testID: string=?,
+ ]}
+
+ {3 accessibilityComponentType}
+
+ {[
+ ~accessibilityComponentType: [
+ | `none
+ | `button
+ | `radiobutton_checked
+ | `radiobutton_unchecked
+ ]
+ =?
+ ]}
+
+ {3 accessibilityLiveRegion}
+
+ {[
+ ~accessibilityLiveRegion: [ | `none | `polite | `assertive]=?,
+ ]}
+
+ {3 collapsable}
+
+ {[
+ ~collapsable: bool=?
+ ]}
+
+ {3 importantForAccessibility}
+
+ {[
+ ~importantForAccessibility: [ | `auto | `yes | `no | `noHideDescendants]=?
+ ]}
+
+ {3 needsOffscreenAlphaCompositing}
+
+ {[
+ ~needsOffscreenAlphaCompositing: bool=?
+ ]}
+
+ {3 renderToHardwareTextureAndroid}
+
+ {[
+ ~renderToHardwareTextureAndroid: bool=?
+ ]}
+
+ {3 accessibilityTraits}
+
+ {[
+ ~accessibilityTraits: list(
+ [
+ | `none
+ | `button
+ | `link
+ | `header
+ | `search
+ | `image
+ | `selected
+ | `plays
+ | `key
+ | `text
+ | `summary
+ | `disabled
+ | `frequentUpdates
+ | `startsMedia
+ | `adjustable
+ | `allowsDirectInteraction
+ | `pageTurn
+ ],
+ )
+ =?,
+ ]}
+
+ {3 accessibilityViewIsModal}
+
+ {[
+ ~accessibilityViewIsModal: bool=?,
+ ]}
+
+ {3 shouldRasterizeIOS}
+
+ {[
+ ~shouldRasterizeIOS: bool=?,
+ ]}
+ */
  let make:
  (
  ~accessibilityLabel: string=?,
@@ -62,4 +218,4 @@ module type Impl = {let view: ReasonReact.reactClass;};
 
 module CreateComponent: (Impl: Impl) => ViewComponent;
 
-include ViewComponent;
+include ViewComponent;