mirror of
https://github.com/FranP-code/countries.git
synced 2025-10-13 00:02:15 +00:00
Reorganize examples/readmes
This commit is contained in:
89
README.md
89
README.md
@@ -49,90 +49,7 @@ The above GraphQL query will produce the following JSON response:
|
||||
|
||||
Check out [the playground](https://countries.trevorblades.com) to explore the schema and test out some queries.
|
||||
|
||||
## Example
|
||||
## Examples
|
||||
|
||||
One practical use of this API is to create a country select field that fetches its options dynamically. Normally, you would need to install an npm package or create a file in your project containing the necessary data (normally country codes and names) and bundle that data with your app code. This results in a lot of extra kilobytes hanging around in your bundle for a feature that might not always get rendered or used. Here's a simple data size comparison:
|
||||
|
||||
- **50.1 KB** with the `countries` export from [Countries List](https://annexare.github.io/Countries/)
|
||||
- **14.2 KB** with this API (~70% smaller)
|
||||
|
||||
This example uses [React](https://reactjs.org/) and [Apollo GraphQL](https://apollographql.com) tools. Apollo's GraphQL client and React components make it simple to execute, handle, and cache GraphQL queries. You can also accomplish this by sending a POST request to this API using `fetch` or your favourite request library, but this example won't cover that.
|
||||
|
||||
If you prefer [React native](https://facebook.github.io/react-native/), check out [this example](https://github.com/muhzi4u/country-directory-app).
|
||||
|
||||
### Install dependencies
|
||||
|
||||
```shell
|
||||
$ npm install react react-dom react-apollo apollo-boost graphql graphql-tag
|
||||
```
|
||||
|
||||
### Build the component
|
||||
|
||||
```js
|
||||
import ApolloClient from 'apollo-boost';
|
||||
import React, {Component} from 'react';
|
||||
import ReactDOM from 'react-dom';
|
||||
import gql from 'graphql-tag';
|
||||
import {Query} from 'react-apollo';
|
||||
|
||||
// initialize a GraphQL client
|
||||
const client = new ApolloClient({
|
||||
uri: 'https://countries.trevorblades.com'
|
||||
});
|
||||
|
||||
// write a GraphQL query that asks for names and codes for all countries
|
||||
const GET_COUNTRIES = gql`
|
||||
{
|
||||
countries {
|
||||
name
|
||||
code
|
||||
}
|
||||
}
|
||||
`;
|
||||
|
||||
// create a component that renders an API data-powered select input
|
||||
class CountrySelect extends Component {
|
||||
state = {
|
||||
country: 'US'
|
||||
};
|
||||
|
||||
// set the selected country to the new input value
|
||||
onCountryChange = event => {
|
||||
this.setState({country: event.target.value});
|
||||
};
|
||||
|
||||
render() {
|
||||
return (
|
||||
<Query query={GET_COUNTRIES} client={client}>
|
||||
{({loading, error, data}) => {
|
||||
if (loading) return <p>Loading...</p>;
|
||||
if (error) return <p>{error.message}</p>;
|
||||
return (
|
||||
<select value={this.state.country} onChange={this.onCountryChange}>
|
||||
{data.countries.map(country => (
|
||||
<option key={country.code} value={country.code}>
|
||||
{country.name}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
);
|
||||
}}
|
||||
</Query>
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
ReactDOM.render(<CountrySelect />, document.getElementById('root'));
|
||||
```
|
||||
|
||||
### Now you're worldwide! 🌎
|
||||
|
||||
[](https://codesandbox.io/s/913llyjylo)
|
||||
|
||||
Check out the CodeSandbox link above for a complete, working copy of this example. This `CountrySelect` component only fetches its country data when it mounts. That means that if it exists within an unmatched route or the falsey end of a condition, it doesn't request any data.
|
||||
|
||||

|
||||
|
||||
> Reach for the stars, and if you don't grab 'em, at least you'll fall on top of the world
|
||||
>
|
||||
> — Pitbull
|
||||
- [React](./examples/react)
|
||||
- [React Native](https://github.com/muhzi4u/country-directory-app)
|
||||
|
||||
85
examples/react/README.md
Normal file
85
examples/react/README.md
Normal file
@@ -0,0 +1,85 @@
|
||||
# React example
|
||||
|
||||
One practical use of this API is to create a country select field that fetches its options dynamically. Normally, you would need to install an npm package or create a file in your project containing the necessary data (normally country codes and names) and bundle that data with your app code. This results in a lot of extra kilobytes hanging around in your bundle for a feature that might not always get rendered or used. Here's a simple data size comparison:
|
||||
|
||||
- **50.1 KB** with the `countries` export from [Countries List](https://annexare.github.io/Countries/)
|
||||
- **14.2 KB** with this API (~70% smaller)
|
||||
|
||||
This example uses [React](https://reactjs.org/) and [Apollo GraphQL](https://apollographql.com) tools. Apollo's GraphQL client and React components make it simple to execute, handle, and cache GraphQL queries. You can also accomplish this by sending a POST request to this API using `fetch` or your favourite request library, but this example won't cover that.
|
||||
|
||||
## Install dependencies
|
||||
|
||||
```shell
|
||||
$ npm install react react-dom react-apollo apollo-boost graphql graphql-tag
|
||||
```
|
||||
|
||||
## Build the component
|
||||
|
||||
```js
|
||||
import ApolloClient from 'apollo-boost';
|
||||
import React, {Component} from 'react';
|
||||
import ReactDOM from 'react-dom';
|
||||
import gql from 'graphql-tag';
|
||||
import {Query} from 'react-apollo';
|
||||
|
||||
// initialize a GraphQL client
|
||||
const client = new ApolloClient({
|
||||
uri: 'https://countries.trevorblades.com'
|
||||
});
|
||||
|
||||
// write a GraphQL query that asks for names and codes for all countries
|
||||
const GET_COUNTRIES = gql`
|
||||
{
|
||||
countries {
|
||||
name
|
||||
code
|
||||
}
|
||||
}
|
||||
`;
|
||||
|
||||
// create a component that renders an API data-powered select input
|
||||
class CountrySelect extends Component {
|
||||
state = {
|
||||
country: 'US'
|
||||
};
|
||||
|
||||
// set the selected country to the new input value
|
||||
onCountryChange = event => {
|
||||
this.setState({country: event.target.value});
|
||||
};
|
||||
|
||||
render() {
|
||||
return (
|
||||
<Query query={GET_COUNTRIES} client={client}>
|
||||
{({loading, error, data}) => {
|
||||
if (loading) return <p>Loading...</p>;
|
||||
if (error) return <p>{error.message}</p>;
|
||||
return (
|
||||
<select value={this.state.country} onChange={this.onCountryChange}>
|
||||
{data.countries.map(country => (
|
||||
<option key={country.code} value={country.code}>
|
||||
{country.name}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
);
|
||||
}}
|
||||
</Query>
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
ReactDOM.render(<CountrySelect />, document.getElementById('root'));
|
||||
```
|
||||
|
||||
## Now you're worldwide! 🌎
|
||||
|
||||
[](https://codesandbox.io/s/913llyjylo)
|
||||
|
||||
Check out the CodeSandbox link above for a complete, working copy of this example. This `CountrySelect` component only fetches its country data when it mounts. That means that if it exists within an unmatched route or the falsey end of a condition, it doesn't request any data.
|
||||
|
||||

|
||||
|
||||
> Reach for the stars, and if you don't grab 'em, at least you'll fall on top of the world
|
||||
>
|
||||
> — Pitbull
|
||||
|
Before Width: | Height: | Size: 71 KiB After Width: | Height: | Size: 71 KiB |
Reference in New Issue
Block a user