Other Configurations

Overview

PropertyTypeDefault ValueInline Mode SupportOverlay Mode Support
launch_immediatebooleanfalseNoYes
logo_urlurl#efefefYesYes
display_namestring"This App"YesYes
close_buttonbooleantrueNoYes
connect_layoutenum: v1,v2"v2"YesYes
on_success_redirectbooleantrueYesYes
widthnumber768YesYes
heightnumber650YesYes

launch_immediate

It can be used to open/ launch the login tool as soon as SDK is loaded in website without calling the launch method while using the overlay mode.

<html lang="en">
<head>
<script src="https://cdn.getfize.com/sdk/v1.0/getfize.js"></script>
</head>
<body>
<script>
       let handler = FIZE.configure({
         client_id: "FIZE_PROVIDED_CLIENT_ID",
         launch_immediate:  true,
         display_mode: "overlay"
       });   
   </script>
</body>
</html>

logo_url

The client has the option to use their own logo on the SDK UI using the key, "logo_url".

1524
<html lang="en">
<head>
<script src="https://cdn.getfize.com/sdk/v1.0/getfize.js"></script>
</head>
<body>
<script>
       let handler = FIZE.configure({
         client_id: "FIZE_PROVIDED_CLIENT_ID",
         launch_immediate:  true,
         logo_url: 'https://cdn.getfize.com/clients/logos/fize.png', // Custom URL for Logo can be provided here.
       });   
   </script>
</body>
</html>

display_name

The client has the option to configure the display name on the Fize Modal using the key, "display_name".

1518
<html lang="en">
<head>
<script src="https://cdn.getfize.com/sdk/v1.0/getfize.js"></script>
</head>
<body>
<script>
       let handler = FIZE.configure({
         client_id: "FIZE_PROVIDED_CLIENT_ID",
         launch_immediate:  true,
         display_name: "Display Name"
       });   
   </script>
</body>
</html>

close_button

It can be used enabled/disable close button on modal.

1528
<html lang="en">
<head>
<script src="https://cdn.getfize.com/sdk/v1.0/getfize.js"></script>
</head>
<body>
<script>
       let handler = FIZE.configure({
         client_id: "FIZE_PROVIDED_CLIENT_ID",
         close_button:  true
       });   
</script>
</body>
</html>

connect_layout

It is version to be used to view login tool in different templates.

Enums: v1,v2

<html lang="en">
<head>
<script src="https://cdn.getfize.com/sdk/v1.0/getfize.js"></script>
</head>
<body>
<script>
       let handler = FIZE.configure({
         client_id: "FIZE_PROVIDED_CLIENT_ID",
         connect_layout:  "v2",
         launch_immediate: true,
       });   
</script>
</body>
</html>

on_success_redirect

It defines the next after success page. If provided true then it will redirect to home page instead of closing the modal.

πŸ“˜

Note: While using inline mode it will be ignored.

<html lang="en">
<head>
<script src="https://cdn.getfize.com/sdk/v1.0/getfize.js"></script>
</head>
<body>
<script>
       let handler = FIZE.configure({
         client_id: "FIZE_PROVIDED_CLIENT_ID",
         launch_immediate: true,
         on_success_redirect:  true
       });   
</script>
</body>
</html>

width & height

It is used to set the width and height of Fize Login Modal.

Recommended Height/Width :

  • number (width/height > 350)

πŸ“˜

Note: While using inline mode it will be ignored. Inline mode height and width will be 100% of parent tag.

<html lang="en">
<head>
<script src="https://cdn.getfize.com/sdk/v1.0/getfize.js"></script>
</head>
<body>
<script>
       let handler = FIZE.configure({
         client_id: "FIZE_PROVIDED_CLIENT_ID",
         launch_immediate: true,
         width: 800,
         height: 700
       });   
</script>
</body>
</html>

What’s Next