react-regional

react-regional

  • Docs
  • GitHub

›API Reference

Introduction

  • Introduction to react-reginal
  • Quick Start

API Reference

  • <RegionalProvider />
  • gql
  • <Query />
  • <Mutation />

<Query />

Query

Query is a component for getting data from GraphQL server.

Examples

Get list

import React from "react";
import { gql, Query } from "react-regional";

const query = gql`
    {
        users {
            id
            name
        }
    }
`;

export default props => (
    <Query query={query}>
        {result => {
            if (result.loading) {
                return null;
            }

            return (
                <div>
                    {result.data.users.map((user, index) => (
                        <div key={index}>{user.name}</div>
                    ))}
                </div>
            )
        }}
    </Query>
)

Get single recode

import React from "react";
import { gql, Query } from "react-regional";

const query = gql`
    query User($id: ID) {
        user(where: { id: $id }) {
            id
            name
        }
    }
`;

export default props => (
    <Query query={query} variables={{ id: 1 }}>
            {result => {
                if (result.loading) {
                    return null;
                }

                return (
                    <div>
                        {result.data.user.name}
                    </div>
                )
            }}
    </Query>
)

Cache and Refetch

  render() {
    return (
        <Query query={query} cache>
            {result => {
                return (
                    <div>
                        <div>
                            {result.data.user.name}
                        </div>
                        <div>
                            <button onClick={result.onRefetch}>Refetch</button>
                        </div>
                    </div>
                );
            }}
        </Query>

Props

NameTypeDefaultDescription
queryGql-Set the GraphQL query.
variablesobject{}Set the GraphQL variables.
cachebooleanfalseIf true, same query return same response.

Render prop function

The Query return results.

    <Query query={query} variables={{ id: 1 }}>
            {result => {
                console.log(result); // ← this !
NameTypeDefaultDescription
dataanynullReturn on GraphQL response data.
loadingbooleanfalseIf true, The http response is fetching.
erroranyundefinedReturn on request error and GraphQL error.
onRefetch() => void-The refetch is a function to refetch the same request.
← gql<Mutation /> →
  • Query
  • Examples
    • Get list
    • Get single recode
    • Cache and Refetch
  • Props
  • Render prop function
react-regional
Docs
Getting Started
More
GitHub
Copyright © 2018 wheatandcat