b416760df0 · samitouri/QOS-React-2

@@ -9,15 +9,23 @@ prev: advanced-components.html

9

10 `React` is the entry point to the React framework. If you're using one of the prebuilt packages it's available as a global; if you're using CommonJS modules you can `require()` it.

11

12 -### DOM

12 +#### React.DOM

13

14 `React.DOM` provides all of the standard HTML tags needed to build a React app. You generally don't use it directly; instead, just include it as part of the `/** @jsx React.DOM */` docblock.

15

16 -### initializeTouchEvents(boolean shouldUseTouch)

16 +#### React.initializeTouchEvents

17 +

18 +```javascript

19 +initializeTouchEvents(boolean shouldUseTouch)

20 +```

21

22 Configure React's event system to handle touch events on mobile devices.

23

20 -### function autoBind(function method)

24 +#### React.autoBind

25 +

26 +```javascript

27 +function autoBind(function method)

28 +```

29

30 Marks the provided function to be automatically bound to each React component instance created. This allows React components to define automatically bound methods and ensure that when called they will always reference their current instance.

31

@@ -35,11 +43,19 @@ React.createClass({

43 });

44 ```

45

38 -### function createClass(object specification)

46 +#### React.createClass

47 +

48 +```javascript

49 +function createClass(object specification)

50 +```

51

52 Creates a component given a specification. A component implements a `render` method which returns a single child. That child may have an arbitrarily deep child structure. One thing that makes components different than a standard prototypal classes is that you don't need to call new on them. They are convenience wrappers that construct backing instances (via new) for you.

53

42 -### ReactComponent renderComponent(ReactComponent container, DOMElement mountPoint)

54 +#### React.renderComponent

55 +

56 +```javascript

57 +ReactComponent renderComponent(ReactComponent container, DOMElement mountPoint)

58 +```

59

60 Renders a React component into the DOM in the supplied `container`.

61

@@ -55,25 +71,45 @@ If you find that you need the underlying browser event for some reason, simply u

71

72 Component classses created by `createClass()` return instances of `ReactComponent` when called. Most of the time when you're using React you're either creating or consuming `ReactComponent`s.

73

58 -### DOMElement getDOMNode()

74 +#### getDOMNode

75 +

76 +```javascript

77 +DOMElement getDOMNode()

78 +```

79

80 If this component has been mounted into the DOM, this returns the corresponding native browser DOM element. This method is useful for reading values out of the DOM, such as form field values and performing DOM measurements.

81

62 -### setProps(object nextProps)

82 +#### setProps

83 +

84 +```javascript

85 +setProps(object nextProps)

86 +```

87

88 When you're integrating with an external JavaScript application you may want to signal a change to a React component rendered with `renderComponent()`. Simply call `setProps()` to change its properties and trigger a re-render.

89

90 **Note:** This method can only be called on a root-level component. That is, it's only available on the component passed directly to `renderComponent()` and none of its children. If you're inclined to use `setProps()` on a child component, instead take advantage of reactive updates and pass the new prop to the child component when it's created in `render()`.

91

68 -### replaceProps(object nextProps)

92 +#### replaceProps

93 +

94 +```javascript

95 +replaceProps(object nextProps)

96 +```

97

98 Like `setProps()` but deletes any pre-existing props that are not in nextProps.

99

72 -### ReactComponent transferPropsTo(ReactComponent targetComponent)

100 +#### transferPropsTo

101 +

102 +```javascript

103 +ReactComponent transferPropsTo(ReactComponent targetComponent)

104 +```

105

106 Transfer properties from this component to a target component that have not already been set on the target component. This is usually used to pass down properties to the returned root component. `targetComponent`, now updated with some new props is returned as a convenience.

107

76 -### setState(object nextState)

108 +#### setState

109 +

110 +```javascript

111 +setState(object nextState)

112 +```

113

114 Merges nextState with the current state. This is the primary method you use to trigger UI updates from event handlers and server request callbacks.

115

@@ -81,24 +117,34 @@ Merges nextState with the current state. This is the primary method you use to t

117

118 **Note:** `setState()` does not immediately mutate `this.state` but creates a pending state transition. Accessing `this.state` after calling this method can potentially return the existing value.

119

84 -### replaceState(object nextState)

120 +#### replaceState

121 +

122 +```javascript

123 +replaceState(object nextState)

124 +```

125

126 Like `setState()` but deletes any pre-existing state keys that are not in nextState.

127

88 -### forceUpdate()

128 +#### forceUpdate()

129 +

130 +```javascript

131 +forceUpdate()

132 +```

133

134 If your `render()` method reads from something other than `this.props` or `this.state` you'll need to tell React when it needs to re-run `render()`. Use `forceUpdate()` to cause React to automatically re-render. This will cause `render()` to be called on the component and all of its children but React will only update the DOM if the markup changes.

135

136 Normally you should try to avoid all uses of `forceUpdate()` and only read from `this.props` and `this.state` in `render()`. This makes your application much simpler and more efficient.

137

94 -### object getInitialState()

95 -### componentWillMount()

96 -### componentDidMount(DOMElement domNode)

97 -### componentWillReceiveProps(object nextProps)

98 -### boolean shouldComponentUpdate(object nextProps, object nextState)

99 -### componentWillUpdate(object nextProps, object nextState)

100 -### ReactComponent render()

101 -### componentDidUpdate(object prevProps, object prevState, DOMElement domNode)

102 -### componentWillUnmount()

103 -

104 -These are overridable lifecycle methods; see the [lifecycle methods](lifecycle.html) documentation for more information.

138 +```javascript

139 +object getInitialState()

140 +componentWillMount()

141 +componentDidMount(DOMElement domNode)

142 +componentWillReceiveProps(object nextProps)

143 +boolean shouldComponentUpdate(object nextProps, object nextState)

144 +componentWillUpdate(object nextProps, object nextState)

145 +ReactComponent render()

146 +componentDidUpdate(object prevProps, object prevState, DOMElement domNode)

147 +componentWillUnmount()

148 +```

149 +

150 +See the [advanced components](advanced-components.html) documentation for more details on these lifecycle methods.

[docs] Clean up formatting on /api.html