mirror of
https://github.com/zhigang1992/DefinitelyTyped.git
synced 2026-05-16 19:09:18 +08:00
feat: add react-redux 4.4.0
This commit is contained in:
293
react-redux/react-redux-tests.tsx
Normal file
293
react-redux/react-redux-tests.tsx
Normal file
@@ -0,0 +1,293 @@
|
||||
/// <reference path="react-redux.d.ts" />
|
||||
/// <reference path="../react/react.d.ts"/>
|
||||
/// <reference path="../react/react-dom.d.ts"/>
|
||||
/// <reference path="../redux/redux.d.ts" />
|
||||
/// <reference path="../history/history.d.ts" />
|
||||
/// <reference path="../react-router/react-router.d.ts" />
|
||||
/// <reference path="../object-assign/object-assign.d.ts" />
|
||||
|
||||
import { Component, ReactElement } from 'react';
|
||||
import * as React from 'react';
|
||||
import * as ReactDOM from 'react-dom';
|
||||
import { Router, RouterState } from 'react-router';
|
||||
import { Store, Dispatch, bindActionCreators } from 'redux';
|
||||
import { connect, Provider } from 'react-redux';
|
||||
import objectAssign = require('object-assign');
|
||||
|
||||
//
|
||||
// Quick Start
|
||||
// https://github.com/rackt/react-redux/blob/master/docs/quick-start.md#quick-start
|
||||
//
|
||||
|
||||
interface CounterState {
|
||||
counter: number;
|
||||
}
|
||||
declare var increment: Function;
|
||||
|
||||
class Counter extends Component<any, any> {
|
||||
render() {
|
||||
return (
|
||||
<button onClick={this.props.onIncrement}>
|
||||
{this.props.value}
|
||||
</button>
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
function mapStateToProps(state: CounterState) {
|
||||
return {
|
||||
value: state.counter
|
||||
};
|
||||
}
|
||||
|
||||
// Which action creators does it want to receive by props?
|
||||
function mapDispatchToProps(dispatch: Dispatch) {
|
||||
return {
|
||||
onIncrement: () => dispatch(increment())
|
||||
};
|
||||
}
|
||||
|
||||
connect(
|
||||
mapStateToProps,
|
||||
mapDispatchToProps
|
||||
)(Counter);
|
||||
|
||||
|
||||
@connect(mapStateToProps)
|
||||
class CounterContainer extends Component<any, any> {
|
||||
|
||||
}
|
||||
|
||||
class App extends Component<any, any> {
|
||||
render(): JSX.Element {
|
||||
// ...
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
const targetEl = document.getElementById('root');
|
||||
|
||||
ReactDOM.render((
|
||||
<Provider store={store}>
|
||||
{() => <App />}
|
||||
</Provider>
|
||||
), targetEl);
|
||||
|
||||
//
|
||||
// API
|
||||
// https://github.com/rackt/react-redux/blob/master/docs/api.md
|
||||
//
|
||||
declare var store: Store;
|
||||
declare var routerState: RouterState;
|
||||
declare var history: HistoryModule.History;
|
||||
class MyRootComponent extends Component<any, any> {
|
||||
|
||||
}
|
||||
class TodoApp extends Component<any, any> {
|
||||
|
||||
}
|
||||
interface TodoState {
|
||||
todos: string[]|string;
|
||||
}
|
||||
interface TodoProps {
|
||||
userId: number;
|
||||
}
|
||||
interface DispatchProps {
|
||||
addTodo(userId: number, text: string): void;
|
||||
}
|
||||
declare var actionCreators: () => {
|
||||
action: Function;
|
||||
}
|
||||
declare var addTodo: () => { type: string; };
|
||||
declare var todoActionCreators: { [type: string]: (...args: any[]) => any; };
|
||||
declare var counterActionCreators: { [type: string]: (...args: any[]) => any; };
|
||||
|
||||
ReactDOM.render(
|
||||
<Provider store={store}>
|
||||
{() => <MyRootComponent />}
|
||||
</Provider>,
|
||||
document.body
|
||||
);
|
||||
|
||||
//TODO: for React Router 0.13
|
||||
////TODO: error TS2339: Property 'run' does not exist on type 'typeof "react-router"'.
|
||||
////TODO: error TS2339: Property 'HistoryLocation' does not exist on type 'typeof "react-router"'.
|
||||
//declare var routes: any;
|
||||
//Router.run(routes, Router.HistoryLocation, (Handler, routerState) => { // note "routerState" here
|
||||
// ReactDOM.render(
|
||||
// <Provider store={store}>
|
||||
// {/*
|
||||
// //TODO: error TS2339: Property 'routerState' does not exist on type 'RouteProp'.
|
||||
// {() => <Handler routerState={routerState} />} // note "routerState" here: important to pass it down
|
||||
// */}
|
||||
// </Provider>,
|
||||
// document.getElementById('root')
|
||||
// );
|
||||
//});
|
||||
|
||||
|
||||
//TODO: for React Router 1.0
|
||||
ReactDOM.render(
|
||||
<Provider store={store}>
|
||||
{() => <Router history={history}>...</Router>}
|
||||
</Provider>,
|
||||
targetEl
|
||||
);
|
||||
|
||||
// Inject just dispatch and don't listen to store
|
||||
|
||||
connect()(TodoApp);
|
||||
|
||||
// Inject dispatch and every field in the global state
|
||||
|
||||
connect((state: TodoState) => state)(TodoApp);
|
||||
|
||||
// Inject dispatch and todos
|
||||
|
||||
function mapStateToProps2(state: TodoState) {
|
||||
return { todos: state.todos };
|
||||
}
|
||||
|
||||
export default connect(mapStateToProps2)(TodoApp);
|
||||
|
||||
// Inject todos and all action creators (addTodo, completeTodo, ...)
|
||||
|
||||
//function mapStateToProps(state) {
|
||||
// return { todos: state.todos };
|
||||
//}
|
||||
|
||||
connect(mapStateToProps2, actionCreators)(TodoApp);
|
||||
|
||||
// Inject todos and all action creators (addTodo, completeTodo, ...) as actions
|
||||
|
||||
//function mapStateToProps(state) {
|
||||
// return { todos: state.todos };
|
||||
//}
|
||||
|
||||
function mapDispatchToProps2(dispatch: Dispatch) {
|
||||
return { actions: bindActionCreators(actionCreators, dispatch) };
|
||||
}
|
||||
|
||||
connect(mapStateToProps2, mapDispatchToProps2)(TodoApp);
|
||||
|
||||
// Inject todos and a specific action creator (addTodo)
|
||||
|
||||
//function mapStateToProps(state) {
|
||||
// return { todos: state.todos };
|
||||
//}
|
||||
|
||||
function mapDispatchToProps3(dispatch: Dispatch) {
|
||||
return bindActionCreators({ addTodo }, dispatch);
|
||||
}
|
||||
|
||||
connect(mapStateToProps2, mapDispatchToProps3)(TodoApp);
|
||||
|
||||
// Inject todos, todoActionCreators as todoActions, and counterActionCreators as counterActions
|
||||
|
||||
//function mapStateToProps(state) {
|
||||
// return { todos: state.todos };
|
||||
//}
|
||||
|
||||
function mapDispatchToProps4(dispatch: Dispatch) {
|
||||
return {
|
||||
todoActions: bindActionCreators(todoActionCreators, dispatch),
|
||||
counterActions: bindActionCreators(counterActionCreators, dispatch)
|
||||
};
|
||||
}
|
||||
|
||||
connect(mapStateToProps2, mapDispatchToProps4)(TodoApp);
|
||||
|
||||
// Inject todos, and todoActionCreators and counterActionCreators together as actions
|
||||
|
||||
//function mapStateToProps(state) {
|
||||
// return { todos: state.todos };
|
||||
//}
|
||||
|
||||
function mapDispatchToProps5(dispatch: Dispatch) {
|
||||
return {
|
||||
actions: bindActionCreators(objectAssign({}, todoActionCreators, counterActionCreators), dispatch)
|
||||
};
|
||||
}
|
||||
|
||||
connect(mapStateToProps2, mapDispatchToProps5)(TodoApp);
|
||||
|
||||
// Inject todos, and all todoActionCreators and counterActionCreators directly as props
|
||||
|
||||
//function mapStateToProps(state) {
|
||||
// return { todos: state.todos };
|
||||
//}
|
||||
|
||||
function mapDispatchToProps6(dispatch: Dispatch) {
|
||||
return bindActionCreators(objectAssign({}, todoActionCreators, counterActionCreators), dispatch);
|
||||
}
|
||||
|
||||
connect(mapStateToProps2, mapDispatchToProps6)(TodoApp);
|
||||
|
||||
// Inject todos of a specific user depending on props
|
||||
|
||||
function mapStateToProps3(state: TodoState, ownProps: TodoProps): TodoState {
|
||||
return { todos: state.todos[ownProps.userId] };
|
||||
}
|
||||
|
||||
connect(mapStateToProps3)(TodoApp);
|
||||
|
||||
// Inject todos of a specific user depending on props, and inject props.userId into the action
|
||||
|
||||
//function mapStateToProps(state) {
|
||||
// return { todos: state.todos };
|
||||
//}
|
||||
|
||||
function mergeProps(stateProps: TodoState, dispatchProps: DispatchProps, ownProps: TodoProps): DispatchProps & TodoState {
|
||||
return objectAssign({}, ownProps, {
|
||||
todos: stateProps.todos[ownProps.userId],
|
||||
addTodo: (text: string) => dispatchProps.addTodo(ownProps.userId, text)
|
||||
});
|
||||
}
|
||||
|
||||
connect(mapStateToProps2, actionCreators, mergeProps)(TodoApp);
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
interface TestProp {
|
||||
property1: number;
|
||||
someOtherProperty?: string;
|
||||
}
|
||||
interface TestState {
|
||||
isLoaded: boolean;
|
||||
state1: number;
|
||||
}
|
||||
class TestComponent extends Component<TestProp, TestState> { }
|
||||
const WrappedTestComponent = connect()(TestComponent);
|
||||
|
||||
// return value of the connect()(TestComponent) is of the type TestComponent
|
||||
let ATestComponent: typeof TestComponent = null;
|
||||
ATestComponent = TestComponent;
|
||||
ATestComponent = WrappedTestComponent;
|
||||
|
||||
let anElement: ReactElement<TestProp>;
|
||||
<TestComponent property1={42} />;
|
||||
<WrappedTestComponent property1={42} />;
|
||||
<ATestComponent property1={42} />;
|
||||
|
||||
class NonComponent {}
|
||||
// this doesn't compile
|
||||
//connect()(NonComponent);
|
||||
|
||||
// connect()(SomeClass) has the same constructor as SomeClass itself
|
||||
class SomeClass extends Component<any, any> {
|
||||
constructor(public foo: string) { super() }
|
||||
public bar: number;
|
||||
}
|
||||
let bar: number = new (connect()(SomeClass))("foo").bar;
|
||||
|
||||
|
||||
// stateless functions
|
||||
interface HelloMessageProps { name: string; }
|
||||
function HelloMessage(props: HelloMessageProps) {
|
||||
return <div>Hello {props.name}</div>;
|
||||
}
|
||||
let ConnectedHelloMessage = connect()(HelloMessage);
|
||||
ReactDOM.render(<HelloMessage name="Sebastian" />, document.getElementById('content'));
|
||||
ReactDOM.render(<ConnectedHelloMessage name="Sebastian" />, document.getElementById('content'));
|
||||
68
react-redux/react-redux.d.ts
vendored
Normal file
68
react-redux/react-redux.d.ts
vendored
Normal file
@@ -0,0 +1,68 @@
|
||||
// Type definitions for react-redux 4.4.0
|
||||
// Project: https://github.com/rackt/react-redux
|
||||
// Definitions by: Qubo <https://github.com/tkqubo>
|
||||
// Definitions: https://github.com/borisyankov/DefinitelyTyped
|
||||
|
||||
/// <reference path="../react/react.d.ts" />
|
||||
/// <reference path="../redux/redux.d.ts" />
|
||||
|
||||
declare module "react-redux" {
|
||||
import { ComponentClass, Component, StatelessComponent } from 'react';
|
||||
import { Store, Dispatch, ActionCreator } from 'redux';
|
||||
|
||||
export interface ComponentConstructDecorator<P> {
|
||||
<TComponentConstruct extends (ComponentClass<P>|StatelessComponent<P>)>(component: TComponentConstruct): TComponentConstruct
|
||||
}
|
||||
|
||||
/**
|
||||
* Connects a React component to a Redux store.
|
||||
* @param mapStateToProps
|
||||
* @param mapDispatchToProps
|
||||
* @param mergeProps
|
||||
* @param options
|
||||
*/
|
||||
export function connect<P>(mapStateToProps?: MapStateToProps,
|
||||
mapDispatchToProps?: MapDispatchToPropsFunction|MapDispatchToPropsObject,
|
||||
mergeProps?: MergeProps,
|
||||
options?: Options): ComponentConstructDecorator<P>;
|
||||
|
||||
interface MapStateToProps {
|
||||
(state: any, ownProps?: any): any;
|
||||
}
|
||||
|
||||
interface MapDispatchToPropsFunction {
|
||||
(dispatch: Dispatch, ownProps?: any): any;
|
||||
}
|
||||
|
||||
interface MapDispatchToPropsObject {
|
||||
[name: string]: ActionCreator;
|
||||
}
|
||||
|
||||
interface MergeProps {
|
||||
(stateProps: any, dispatchProps: any, ownProps: any): any;
|
||||
}
|
||||
|
||||
interface Options {
|
||||
/**
|
||||
* If true, implements shouldComponentUpdate and shallowly compares the result of mergeProps,
|
||||
* preventing unnecessary updates, assuming that the component is a “pure” component
|
||||
* and does not rely on any input or state other than its props and the selected Redux store’s state.
|
||||
* Defaults to true.
|
||||
* @default true
|
||||
*/
|
||||
pure: boolean;
|
||||
}
|
||||
|
||||
export interface Property {
|
||||
/**
|
||||
* The single Redux store in your application.
|
||||
*/
|
||||
store?: Store;
|
||||
children?: Function;
|
||||
}
|
||||
|
||||
/**
|
||||
* Makes the Redux store available to the connect() calls in the component hierarchy below.
|
||||
*/
|
||||
export class Provider extends Component<Property, {}> { }
|
||||
}
|
||||
Reference in New Issue
Block a user