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

@orangecheck/me-client


@orangecheck/me-client / OcSignInButton

Function: OcSignInButton()

function OcSignInButton(__namedParameters: OcSignInButtonProps): Element;

Defined in: me-client/src/SignInButton.tsx:29

Drop-in Sign-in-with-OC button. Triggers the me.ochk.io consent flow for the requested scope, opens (or refreshes) a session, and calls onSignin(session) on success. Class C billable event for the integrating site; cashback flows to the user.

Mounting requires <OcSessionProvider> from @orangecheck/auth-client somewhere up the React tree so the resulting session can be read by useOcSession() across the rest of the app.

Parameters

ParameterType
__namedParametersOcSignInButtonProps

Returns

Element