Skip to content

useConnect

Connects to a wallet using the specified connector.

Import

ts
import { useConnect } from "@midl/react";

Example

tsx
function Page() {
  const { connect, connectors } = useConnect();

  return (
    <div>
      {connectors.map(connector => (
        <button
          key={connector.name}
          onClick={() =>
            connect({
              id: connector.id,
            })
          }
        >
          {connector.name}
        </button>
      ))}
    </div>
  );
}

Parameters

NameTypeDescription
mutationUseMutationOptions(optional) Mutation options for react-query.
configConfig(optional) Custom config to override the default from context.
...restConnectParamsAdditional connect parameters.

Returns

NameTypeDescription
connect(variables: ConnectVariables) => voidFunction to initiate connection.
connectAsync(variables: ConnectVariables) => Promise<ConnectData>Function to asynchronously connect.
connectorsArray<ConnectorWithMetadata>The list of available connectors.
...restobjectOther properties from the mutation object, such as isLoading, error, etc.

ConnectVariables

NameTypeDescription
idstringThe id of the connector to use.