react-meteor-accounts

Simple hooks and higher-order components (HOCs) for getting reactive, stateful values of Meteor's Accounts data sources.

Table of Contents

• Installation
  • Peer npm dependencies
  • Changelog
• Usage
  • useUser
  • useUserId
  • useLoggingIn
  • useLoggingOut
  • withUser
  • withUserId
  • withLoggingIn
  • withLoggingOut

Installation

Install the package from Atmosphere:

meteor add react-meteor-accounts

Peer npm dependencies

Install React if you have not already:

meteor npm install react

Note: The minimum supported version of React is v16.8 ("the one with hooks").

Changelog

For recent changes, check the changelog.

Usage

Utilities for each data source are available for the two ways of writing React components: hooks and higher-order components (HOCs). Hooks can only be used in functional components. HOCs can be used for both functional and class components, but are primarily for the latter.

Note: All HOCs forward refs.

useUser()

Get a stateful value of the current user record. A hook. Uses Meteor.user, a reactive data source.

• Arguments: none.
• Returns: object | null.

Example:

import React from 'react';
import { useUser } from 'meteor/react-meteor-accounts';

function Foo() {
  const user = useUser();

  if (user === null) {
    return <h1>Log in</h1>;
  }

  return <h1>Hello {user.username}</h1>;
}

TypeScript signature:

1function useUser(): Meteor.User | null;

useUserId()

Get a stateful value of the current user id. A hook. Uses Meteor.userId, a reactive data source.

• Arguments: none.
• Returns: string | null.

Example:

import React from 'react';
import { useUserId } from 'meteor/react-meteor-accounts';

function Foo() {
  const userId = useUserId();

  return (
    <div>
      <h1>Account Details</h1>
      {userId ? (
          <p>Your unique account id is {userId}.</p>
        ) : (
          <p>Log-in to view your account details.</p>
        )}
    </div>
  );
}

TypeScript signature:

1function useUserId(): string | null;

useLoggingIn()

Get a stateful value of whether a login method (e.g. loginWith<Service>) is currently in progress. A hook. Uses Meteor.loggingIn, a reactive data source.

• Arguments: none.
• Returns: boolean.

Example:

import React from 'react';
import { useLoggingIn } from 'meteor/react-meteor-accounts';

function Foo() {
  const loggingIn = useLoggingIn();

  if (!loggingIn) {
    return null;
  }

  return (
    <div>Logging in, please wait a moment.</div>
  );
}

TypeScript signature:

1function useLoggingIn(): boolean;

useLoggingOut()

Get a stateful value of whether the logout method is currently in progress. A hook. Uses Meteor.loggingOut (no online documentation), a reactive data source.

• Arguments: none.
• Returns: boolean.

Example:

import React from 'react';
import { useLoggingOut } from 'meteor/react-meteor-accounts';

function Foo() {
  const loggingOut = useLoggingOut();

  if (!loggingOut) {
    return null;
  }

  return (
    <div>Logging out, please wait a moment.</div>
  );
}

TypeScript signature:

1function useLoggingOut(): boolean;

withUser(...)

Return a wrapped version of the given component, where the component receives a stateful prop of the current user record, user. A higher-order component. Uses Meteor.user, a reactive data source.

• Arguments:

Argument	Type	Required	Description
Component	React.ComponentType	yes	A React component.

• Returns: React.ForwardRefExoticComponent.

Examples:

import React from 'react';
import { withUser } from 'meteor/react-meteor-accounts';

class Foo extends React.Component {
  render() {
    if (this.props.user === null) {
      return <h1>Log in</h1>;
    }

    return <h1>Hello {this.props.user.username}</h1>;
  }
}

const FooWithUser = withUser(Foo);

TypeScript signature:

1function withUser<P>(Component: React.ComponentType<P>): React.ForwardRefExoticComponent<React.PropsWithoutRef<Omit<P, "user"> & Partial<WithUserProps>> & React.RefAttributes<unknown>>;

withUserId(...)

Return a wrapped version of the given component, where the component receives a stateful prop of the current user id. A higher-order component. Uses Meteor.userId, a reactive data source.

• Arguments:

Argument	Type	Required	Description
Component	React.ComponentType	yes	A React component.

• Returns: React.ForwardRefExoticComponent.

Example:

import React from 'react';
import { withUserId } from 'meteor/react-meteor-accounts';

class Foo extends React.Component {
  render() {
    return (
      <div>
        <h1>Account Details</h1>
        {this.props.userId ? (
            <p>Your unique account id is {this.props.userId}.</p>
          ) : (
            <p>Log-in to view your account details.</p>
          )}
      </div>
    );
  }
}

const FooWithUserId = withUserId(Foo);

TypeScript signature:

1function withUserId<P>(Component: React.ComponentType<P>): React.ForwardRefExoticComponent<React.PropsWithoutRef<Omit<P, "userId"> & Partial<WithUserIdProps>> & React.RefAttributes<unknown>>;

withLoggingIn(...)

Return a wrapped version of the given component, where the component receives a stateful prop of whether a login method (e.g. loginWith<Service>) is currently in progress. A higher-order component. Uses Meteor.loggingIn, a reactive data source.

• Arguments:

Argument	Type	Required	Description
Component	React.ComponentType	yes	A React component.

• Returns: React.ForwardRefExoticComponent.

Example:

import React from 'react';
import { withLoggingIn } from 'meteor/react-meteor-accounts';

class Foo extends React.Component {
  render() {
    if (!this.props.loggingIn) {
      return null;
    }

    return (
      <div>Logging in, please wait a moment.</div>
    );
  }
}

const FooWithLoggingIn = withLoggingIn(Foo);

TypeScript signatures:

1function withLoggingIn<P>(Component: React.ComponentType<P>): React.ForwardRefExoticComponent<React.PropsWithoutRef<Omit<P, "loggingIn"> & Partial<WithLoggingInProps>> & React.RefAttributes<unknown>>;

withLoggingOut(...)

Return a wrapped version of the given component, where the component receives a stateful prop of whether the logout method is currently in progress. A higher-order component. Uses Meteor.loggingOut, a reactive data source.

• Arguments:

Argument	Type	Required	Description
Component	React.ComponentType	yes	A React component.

• Returns: React.ForwardRefExoticComponent.

Example:

import React from 'react';
import { withLoggingOut } from 'meteor/react-meteor-accounts';

class Foo extends React.Component {
  render() {
    if (!this.props.loggingOut) {
      return null;
    }

    return (
      <div>Logging out, please wait a moment.</div>
    );
  }
}

const FooWithLoggingOut = withLoggingOut(Foo);

TypeScript signature:

1function withLoggingOut<P>(Component: React.ComponentType<P>): React.ForwardRefExoticComponent<React.PropsWithoutRef<Omit<P, "loggingOut"> & Partial<WithLoggingOutProps>> & React.RefAttributes<unknown>>;