OnRamp is Leen’s embeddable onboarding component that allows your users to easily create new connections or update existing connections. As an embeddable component, OnRamp is designed to be integrated directly into your application workflow.
Create Connection Invite Token
options
, like you would when creating a new connection via our API. These options will not be visible to the user, but will directly be applied to the connection when it is created.
Initialize Leen's OnRamp component
Handle Response from OnRamp
useEffect
hook with onRampResponse
to handle the response from the OnRamp component and perform any necessary actions in your application. Whenever onRampResponse
changes, the effect will run, allowing you to process the response data.onRampResponse
will be an object of type LeenOnRampResponse
, which can be imported in your application as seen in the snippet above. For reference, here is what the response object would look like:leenConnectionError
event in your application like so:Custom overrides (optional)
fontFamily
: the name of the font familyfontUrl
: the url to the font stylesheet (what you would normally add to the head of your html document)headerSize
: the size of the heading font (defaults to 1.25rem)bodySize
: the size of the body font (defaults to 1rem)buttonSize
: the size of the button font (defaults to 0.875rem)px
, rem
, em
, etc.darkMode
to true
to switch to a dark theme.
darkModeColors
with the following keys:
primary
: hex code for the primary colorsecondary
: hex code for the secondary colordarkMode
is set to true
.Create Connections