oc · docs
docs / documentation

@orangecheck/me-client


@orangecheck/me-client / OcSignInButtonProps

Interface: OcSignInButtonProps

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

Extends

  • Omit<React.ButtonHTMLAttributes<HTMLButtonElement>, "onError">

Indexable

[key: string]: ButtonHTMLAttributes<HTMLButtonElement>
[key: number]: ButtonHTMLAttributes<HTMLButtonElement>
[key: symbol]: ButtonHTMLAttributes<HTMLButtonElement>

Properties

PropertyTypeDescriptionDefined in
<a id="property-label"></a> label?stringCustom button text. Defaults to "sign in with oc".me-client/src/SignInButton.tsx:16
<a id="property-onsignin"></a> onSignin?(session: Session) => void-me-client/src/SignInButton.tsx:11
<a id="property-onsigninerror"></a> onSignInError?(error: Error) => voidCalled when the sign-in flow fails. Renamed from onError to avoid shadowing the native button error handler.me-client/src/SignInButton.tsx:14
<a id="property-returnto"></a> returnTo?string-me-client/src/SignInButton.tsx:10
<a id="property-scope"></a> scopestring[]-me-client/src/SignInButton.tsx:8
<a id="property-sessionpolicy"></a> sessionPolicy?Partial&lt;SessionPolicy>-me-client/src/SignInButton.tsx:9