API Reference
Sign in

Configuration options

The following data properties are available for configuring the UserKit Widget.

  • data-app-id (Required)
    This property is required and must be set to the app-id for your app found in the UserKit Dashboard

  • data-show-on-load (Optional, Default = undefined)
    May be set to login, register, settings, or auto. This property will display the dialog for the selected value on page load. The auto setting will display the login page for users who are not logged in and the settings page for users who are logged in.

  • data-login-dismiss (Optional, Default = true)
    Setting this property to false will prevent the login dialog from being dismissed.

  • data-register-dismiss (Optional, Default = true)
    Setting this property to false will prevent the register dialog from being dismissed.

  • data-settings-dismiss (Optional, Default = true)
    Setting this property to false will prevent the settings dialog from being dismissed.

  • data-proxy (Optional, Default = undefined)
    Can be used to enable http-only session cookies. More info here

  • data-invite-only-descr (Optional, Default = "An invite is required to register.")
    If your app is configured to be invite-only, this message will be displayed on the registration screen.