kserjey / react-aqueduct

The bridge to convey data

react-aqueduct

The bridge to convey water data

Installation

npm install --save react-aqueduct

Example

import React from 'react';
import { createRequest } from 'react-aqueduct';

const PeopleSearch = createRequest([], ({ name }) =>
  fetch(`https://swapi.co/api/people/?search=${name}`)
    .then(response => response.json())
    .then(json => json.results),
);

const renderItem = item => <li>{item.name}</li>;

class App extends React.Component {
  state = { name: '' };

  handleChange = ({ currentTarget }) => {
    this.setState({ name: currentTarget.value });
  };

  render() {
    return (
      <section>
        <h1>Star Wars Search</h1>
        <input
          placeholder="Yoda"
          value={this.state.name}
          onChange={this.handleChange}
        />
        <PeopleSearch
          name={this.state.name}
          render={({ data, isLoading }) =>
            isLoading ? <div>Loading...</div> : <ul>{data.map(renderItem)}</ul>
          }
        />
      </section>
    );
  }
}

export default App;

See more examples on codesanbox:

1. Star Wars Search
2. Star Wars Search (with updateData)

API

createRequest()

createRequest(
  (initialValue: any),
  (mapPropsToRequest: (props: Object) => Promise),
  (options: Object),
);

Function that creates request component - a component which fetches data and pass it via render props.

initialValue

Sets initial value of data before fetching is completed.

mapPropsToRequest

A function that takes component props and return request Promise. For example you can use axios:

({ id }) => axios.get(`/api/users/${id}`);

options

withRequest()

Higher-order component