-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #307 from RBND-studio/dev
Merge dev
- Loading branch information
Showing
44 changed files
with
295 additions
and
52 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"flow-insights": "Flow insights" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
title: Flow insights | ||
description: Realtime analytics of your flows. View insights on how your users are interacting with your flows. | ||
--- | ||
|
||
# Flow insights | ||
|
||
Realtime analytics of your flows. View insights on how your users are interacting with your flows. | ||
|
||
![Flow insights](/analytics/insights.png) | ||
|
||
## Overview | ||
|
||
Flows automatically track how users interact with your flows to help you better understand how your users are engaging with your product. Use these insights to answer questions like: | ||
|
||
- Are the flows useful to users? | ||
- Are users getting stuck in the flows? | ||
- Is something broken? | ||
|
||
In the current state, you can see the last 30 days of data. Stay tuned for unlimited date ranges and more advanced analytics. | ||
|
||
## Metrics | ||
|
||
Flow analytics are in the early stages of development. The following metrics are currently available: | ||
|
||
- **Starts**: How many times the flow was started. | ||
- **Finishes**: How many times the flow was completed. | ||
- **Exits**: How many times the flow was exited without completion. | ||
- **Unique users**: How many unique users have started the flow. | ||
- **Finish rate**: The ratio between finishes and starts. | ||
|
||
In the future, you can expect: | ||
|
||
- **Time spent**: How long users spend in the flow. | ||
- **Error tracking**: See where and why users are getting stuck. We are currently testing this feature. | ||
- **Funnel view**: See the performance of each step in the flow. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
title: Start a flow | ||
description: Select when and where to show a flow. | ||
--- | ||
|
||
# Start a flow | ||
|
||
Select when and where to show a flow. | ||
|
||
![Start form](/creating-flows/start-flow.png) | ||
|
||
You can set the following options for when a flow should start: | ||
|
||
- **When visiting a page**: The flow will be shown when the user visits a specific page. | ||
- **On click**: The flow will be shown when the user clicks on a specific element. | ||
- **On input change**: The flow will be shown when the user changes the value of a specific input. | ||
- **On form submit**: The flow will be shown when the user submits a specific form. | ||
|
||
<SectionLink href="/step-types/shared-properties/wait-properties"> | ||
Learn more about the setting up start options → | ||
</SectionLink> | ||
|
||
## Multiple start options | ||
|
||
You can set multiple start options for a flow. The flow will be shown when the user meets any of the conditions. To add another start options, click the **Add start option** button at the bottom of the form. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"custom-styles": "Custom styles" | ||
} |
50 changes: 50 additions & 0 deletions
50
apps/docs/src/pages/customization-and-styling/custom-styles.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
--- | ||
title: Custom styles | ||
description: Create a custom theme to change the look and feel of your onboarding flows. | ||
--- | ||
|
||
# Custom styles | ||
|
||
Create a custom theme to change the look and feel of your onboarding flows. We strive to provide good defaults, but we expect that you will want to customize how the elements look to match your brand and application. | ||
|
||
![Custom styles](/customization-and-styling/custom-styles.png) | ||
|
||
## CSS variables (recommended) | ||
|
||
CSS variables are the easier way to customize your theme. With variables, you can change the basics like colors, fonts, and spacing across all the elements in the onboarding flows. Using variables is less likely to break when we introduce new features or changes (but we strive to avoid breaking changes whenever possible). | ||
|
||
If you ever need to go back to the start and get the default CSS template, click the **Apply defaults** button. | ||
|
||
### Dark mode | ||
|
||
Out of the box, Flows supports dark mode when you apply class `.dark` on either `html` or `body`. You can change the selector to match your theming implementation. | ||
|
||
```css | ||
:root { | ||
/* This is your default (light) theme */ | ||
--flows-bg-default: #ffffff; | ||
--flows-bg-primary: #ec6441; | ||
} | ||
|
||
.dark { | ||
/* This is your dark theme */ | ||
--flows-bg-default: #181818; | ||
--flows-bg-primary: #e46a49; | ||
} | ||
``` | ||
|
||
## Full CSS template | ||
|
||
For more advanced styling, you can use the full CSS template. This template allows you to customize every element used in the onboarding flows. Please note that this template is more likely to receive breaking changes as we introduce more step types and features. | ||
|
||
Customizing the full CSS template requires a good understanding of CSS and the structure of the onboarding flows. We recommend using the CSS variables template whenever possible. Make sure to preview and test your changes in the onboarding flows to ensure they look good on all devices and screen sizes. We transpile the CSS with [lightningcss.dev](https://lightningcss.dev) so you don't have to worry about browser compatibility. | ||
|
||
### Customizing the full CSS template | ||
|
||
To customize the full CSS template, you need to switch on the **Customize full CSS template** toggle on the **Style template** page. This will display the full CSS template that you can customize. | ||
|
||
If you ever need to go back to the start and get the default CSS template, click the **Apply defaults** button. | ||
|
||
### Restoring to default | ||
|
||
When you customize the full CSS template, the SDK will always load your custom CSS even if there are breaking changes. If you want to go back to the default CSS, just switch off the **Customize full CSS template** toggle on the **Style template** page. This will make sure that your SDK will always load the correct CSS for the version you are using. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"organizations": "Organizations", | ||
"manage-members": "Manage Members" | ||
} |
Oops, something went wrong.