oc · docs
docs / documentation

@orangecheck/auth-client


@orangecheck/auth-client / OcSignInButton

Function: OcSignInButton()

function OcSignInButton(__namedParameters: OcSignInButtonProps): any;

Defined in: components.tsx:349

Drop-in sign-in button. Renders an anchor that points at either:

  • the consumer's local /signin page (when signInUrl prop is set — recommended; works with <OcSignIn />), or
  • the auth host's /signin?return_to=… (default fallback)

When the user is already authenticated it renders nothing.

Parameters

ParameterType
__namedParametersOcSignInButtonProps

Returns

any