@niledatabase/react v2.4.1

@niledatabase/react

Storybook

Storybook

Usage

In the root of your react application, add a Nile provider. This will add a QueryClientProvider and a CssVarsProvider to your application.

import { NileProvider } from '@niledatabase/react';

function App() {
  return (
    <NileProvider>
      <div>Welcome to my great app</div>
    </NileProvider>
  );
}

Configuration

Dependencies

React query

The components of this library use react-query to request data. The <QueryClientProvider /> used can be customized via the optional QueryProvider prop of the <NileProvider />.

import { QueryClient, QueryClientProvider } from 'react-query';

const queryClient = new QueryClient({
  defaultOptions: {
    queries: {
      retry: false,
      refetchOnWindowFocus: false,
    },
  },
});

function MyQueryProvider({ children }) {
  return (
    <QueryClientProvider client={queryClient}>{children}</QueryClientProvider>
  );
}

function App() {
  return (
    <NileProvider QueryProvider={MyQueryProvider}>
      <div>Welcome to my great app</div>
    </NileProvider>
  );
}

@mui/joy

Out of the box mui joy is available for use. No set up is required, simply add the dependencies to your code, then use components and functions provided by those libraries.

A custom theme can be given to the NileProvider, which will theme all components:

function App() {
  return (
    <NileProvider theme={theme}>
      <div>Welcome to my great app</div>
    </NileProvider>
  );
}

useNile

A method exposing the configuration created in <NileProvider />. The methods on the instance can be found in the client src readme, or found in the auto-complete of visual studio code.

Making requests

react-query should be used used to handle loading, error, and cacheing of data.

import React, { useEffect } from 'react';
import { useNile, Queries } from '@niledatabase/react';
import { useQuery } from '@tanstack/react-query';

export default function UserTable() {
  const nile = useNile();
  const [users, setUsers] = useState();
  const { data: users = [] } = useQuery(Queries.ListUsers, () => nile.users.listUsers());
  // with multiple requests
  // const [{ data: users = [] }, { data: invites = [] }] = useQueries([
  //   { queryKey: Queries.ListUsers, queryFn: () => nile.users.listUsers({}) },
  //   { queryKey: Queries.ListInvites, queryFn: () => nile.organizations.listInvites({}) },
  // ]);

  return (
    users.map((user) => {
      return <div id={user.id}>{`Email: ${user.email}`</div>;
    })
  );
}

UI customization

For theming and display, A combination of mui joy and material ui is used. As joy approaches feature parity with material, it will be removed from this codebase. For now, there are helper functions in the theme to support both, with the theming function preferring mui joy settings and colors over material.

For details on theming, see their theming documentation. You can pass a custom theme object to the NileProvider and it will merge it with the combined material and joy themes in the <NileProvider />.

import { NileProvider } from '@niledatabase/react';
import { extendTheme } from '@mui/joy/styles';
const customTheme = extendTheme({
  colorSchemes: {
    light: {
      palette: {
        primary: {
          solidBg: '#0078D4',
          solidHoverBg: '#106EBE',
          solidActiveBg: '#005A9E',
          solidDisabledBg: '#F3F2F1',
          solidDisabledColor: '#A19F9D',
        },
      },
    },
  },
});

function App() {
  return (
    <NileProvider theme={customTheme}>
      <div>Welcome to my great app</div>
    </NileProvider>
  );
}