live · mainnetoc · docs
specs · api · guides
docs / documentation

@orangecheck/auth-client


@orangecheck/auth-client / OcSignInButton

Function: OcSignInButton()

function OcSignInButton(__namedParameters: OcSignInButtonProps): 
  | ReactElement<any, string | JSXElementConstructor<any>>
  | null;

Defined in: src/components.tsx:330

Drop-in sign-in button. Renders an anchor that deep-links to the auth host's sign-in page with the current URL as ?return_to=….

When the user is already authenticated it renders nothing — wrap it in a conditional or use <OcAccountPill> as the signed-in affordance.

Parameters

ParameterType
__namedParametersOcSignInButtonProps

Returns

| ReactElement&lt;any, string | JSXElementConstructor&lt;any>> | null