kevinrodriguez-io / flutter_graphql_hooks Goto Github PK

Apollo-like set of hooks to be used with flutter

License: MIT License

Dart 100.00%

hooks flutter-graphql-hooks apollo flutter-graphql

flutter_graphql_hooks's Introduction

Flutter GraphQL Hooks 🪝

LOOKING FOR MAINTAINERS

Introduction

This package exposes an apollo-like set of hooks to be used with flutter, it's meant to be used together with the graphql_flutter package and it's based on it's latest implementation.

It can be used along with artemis to provide strongly typed hooks, example:

final query = GetRoomsQuery(variables: GetRoomsArguments(limit: 10, offset: 0));

final rooms = useQuery(QueryOptions(
  document: query.document,
  variables: query.getVariablesMap(),
));

final loading = rooms.result.loading;
final error = rooms.result.error;
final data = query.parse(rooms.result.data);
// Data will no longer be a [Map<String, dynamic>] and will have proper typings!

Installing

dependencies:
  flutter_graphql_hooks:

Notes

In order to use the hooks, a GraphqlProvider must exist on the build context. Otherwise you'll need to manually pass the client in the hook as a parameter like:

final rooms = useQuery(QueryOptions(
  document: query.document,
  variables: query.getVariablesMap(),
), client: myGraphqlClient);

flutter_graphql_hooks's People

Contributors

Stargazers

Watchers

flutter_graphql_hooks's Issues

Unnecessary `Use` in class names

In the same way that a useStatedoes not return an useStateResult, the useQuery shouldn't return a Use...Result.

Abuse of useState hook

Inside useQuery, useMutation and others, there are many useState for loading and error. These generates a double rebuild for each updating depleting performance.

The right way is to create a custom hook.

TypeError when setting data-attribute in useQuery

Hi there!

Thanks for creating this package, I'm hoping to get it working in our project :)

We're getting an error from use_query complaining about the type of the data-attribute.

As you can see in this screenshot, the incoming result.data is of type _InternalLinkedHashMap<String, dynamic>.

But when setting data.value to result.value the following exception is thrown:

It complains that the type of the data-attribute, which is Null coming from the type-assertion of useState(null), does not match the incoming data.

Is this possible to fix? One idea is trying data = useState<Map<String, dynamic>>(null)

Here is the code that is running the query:

class ShoppingCartScreen extends HookWidget {
  final int storeId;

  ShoppingCartScreen(this.storeId);

  @override
  Widget build(BuildContext context) {
    final trustMealArticlesQuery = TrustMealArticlesQuery(
        variables: TrustMealArticlesArguments(
            input: GetGroceryArticlesInput(storeId: storeId)));
    var queryResult = useQuery(QueryOptions(
            document: trustMealArticlesQuery.document,
            variables: trustMealArticlesQuery.getVariablesMap()))
        .result;

    var trustMealArticles = queryResult.data != null
        ? trustMealArticlesQuery.parse(queryResult.data).groceryArticles
        : <TrustMealArticles$Query$GroceryArticle>[];

    return ShoppingCartScreenContent(
      storeId: storeId,
      trustMealArticles: trustMealArticles,
      loading: queryResult.loading,
      exception: queryResult.error,
    );
  }
}

Adding the fetchMore function

Hello again

I see that useQuery returns a refetch-function, here called fetch, but I can't find any support for the fetchMore-function used for pagination.

Is it possible to add this?

In the query-hooks when result has an exception, why does it throw the exception? I thought the graphql-way is that the error silently arrives in the error-attribute and then it is handled from there. Now I have to wrap the query in an empty try-catch just to ignore the exception that is thrown.

Upgrade graphql_flutter

Hey

I would like to upgrade my graphql_flutter to 5.0.0, but this library currently keeps me from doing that.

Do you think you'd be able to upgrade easily?