clerk_flutter library
Package that will allow you to authenticate and use Clerk from Flutter code.
Classes
- ClerkAuth
- Control widget initialising Clerk Auth system
- ClerkAuthBuilder
- A Widget which builds its subtree in the context of a ClerkAuthState
- ClerkAuthConfig
-
An extended
clerk.AuthConfig
to allow the addition of: - ClerkAuthentication
- The ClerkAuthentication renders a UI for signing users or up.
- ClerkAuthState
-
An extension of
clerk.Auth
with ChangeNotifier so that updates to the auth state can be propagated out into the UI - ClerkErrorListener
- Widget to display error messages as errors are received from the ClerkAuthState.
- ClerkOrganizationList
-
The ClerkOrganizationList renders a list of all users from
clerk.Session
s currently signed in, plus controls to sign out of all sessions - ClerkOrganizationProfile
- ClerkOrganizationProfile displays user details and allows their editing
- ClerkSdkLocalizations
-
Callers can lookup localized strings with an instance of ClerkSdkLocalizations
returned by
ClerkSdkLocalizations.of(context)
. - ClerkSignedIn
- A widget that builds its child only if we are signed in i.e. a user is present on the client
- ClerkSignedOut
- A widget that builds its child only if we are signed out i.e. a user is not present on the client
- ClerkSignInPanel
- The ClerkSignInPanel renders a UI for signing in users.
- ClerkSignOutPanel
- The ClerkSignOutPanel renders a UI for signing out users.
- ClerkSignUpPanel
- The ClerkSignUpPanel renders a UI for signing up users.
- ClerkSSOPanel
- The ClerkSSOPanel renders a UI for signing up via configured oAuth providers.
- ClerkUserAction
- Class to hold details of user actions available from the UI.
- ClerkUserButton
-
The ClerkUserButton renders a list of all users from
clerk.Session
s currently signed in, plus controls to sign out of all sessions - ClerkUserProfile
- ClerkUserProfile displays user details and allows their editing
- CreateOrganizationPanel
- The CreateOrganizationPanel component is used to render an organization creation UI that allows users to create brand new organizations within your application.
Functions
Typedefs
- AuthWidgetBuilder = Widget Function(BuildContext context, ClerkAuthState authState)
- Typedef for builder invoked by ClerkAuthBuilder
- ClerkErrorCallback = void Function(AuthError)
-
Function type used to report
clerk.AuthError
s -
ClerkErrorHandler
= FutureOr<
void> Function(BuildContext context, AuthError error) - Clerk Error Handler
-
ClerkSdkLocalizationsCollection
= Map<
String, ClerkSdkLocalizations> - A map of Locale strings to ClerkSdkLocalizations instances