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.AuthConfigto allow the addition of: - ClerkAuthentication
- The ClerkAuthentication renders a UI for signing users or up.
- ClerkAuthState
-
An extension of
clerk.Authwith 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.Sessions currently signed in, plus controls to sign out of all sessions - ClerkSdkFlags
- A class to hold flags to guide the action of the SDK and UI
- 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
- ClerkThemeColors
- Colors to be used by the theme
- ClerkThemeExtension
- An extension for the Clerk theme
- ClerkThemeStyles
- Text styles used by Clerk furniture
- ClerkUserAction
- Class to hold details of user actions available from the UI.
- ClerkUserButton
-
The ClerkUserButton renders a list of all users from
clerk.Sessions currently signed in, plus controls to sign out of all sessions
Extensions
- ThemeDataExtension on ThemeData
- Extension on ThemeData to get the ClerkThemeExtension
Functions
Typedefs
- AuthWidgetBuilder = Widget Function(BuildContext context, ClerkAuthState authState)
- Typedef for builder invoked by ClerkAuthBuilder
- ClerkErrorCallback = void Function(ClerkError)
-
Function type used to report
clerk.ClerkErrors -
ClerkErrorHandler
= FutureOr<
void> Function(BuildContext context, ClerkError error) - Clerk Error Handler
- ClerkRedirectUriGenerator = Uri? Function(BuildContext, Strategy)
- A function that generates a redirect url for a given strategy
-
ClerkSdkGrammarCollection
= Map<
String, ClerkSdkGrammar> -
A map of Locale strings to
ClerkSdkGrammarinstances -
ClerkSdkLocalizationsCollection
= Map<
String, ClerkSdkLocalizations> - A map of Locale strings to ClerkSdkLocalizations instances
- ClerkThemeStylesBuilder = ClerkThemeStyles Function(ClerkThemeColors colors)
- Builder for styles object