chore: adds vercel style guide to docs app (#4561)

This commit is contained in:
Piyush Gupta
2025-01-09 10:23:10 +05:30
committed by GitHub
parent b44d6e60bd
commit 6e1ee6df12
237 changed files with 1346 additions and 1314 deletions

View File

@@ -1,3 +1,20 @@
module.exports = {
extends: ["@formbricks/eslint-config/legacy-next.js"],
root: true,
extends: ["@formbricks/eslint-config/next.js"],
parserOptions: {
project: "tsconfig.json",
tsconfigRootDir: __dirname,
},
rules: {
"@typescript-eslint/restrict-template-expressions": "off",
"import/no-cycle": "off",
},
settings: {
"import/resolver": {
typescript: {
project: "tsconfig.json",
},
caseSensitive: false,
},
},
};

View File

@@ -1,4 +1,4 @@
import { MdxImage } from "@/components/MdxImage";
import { MdxImage } from "@/components/mdx-image";
import AddMember from "./images/add-member.webp";
import BulkInvite from "./images/bulk-invite.webp";
@@ -20,8 +20,7 @@ Learn about the different organization-level and team-level roles and how they a
Permissions in Formbricks are broadly handled using organization-level roles, which apply to all teams and projects in the organization. Users on a self-hosting and Enterprise plan, have access to team-level roles, which enable more granular permissions.
<Note>
Access Roles is a feature of the **Enterprise Edition**. In the **Community Edition** and on the **Free**
and **Startup** plan in the Cloud you can invite unlimited organization members as `Owner`.
Access Roles is a feature of the **Enterprise Edition**. In the **Community Edition** and on the **Free** and **Startup** plan in the Cloud you can invite unlimited organization members as `Owner`.
</Note>
Here are the different access permissions, ranked from highest to lowest access
@@ -133,8 +132,7 @@ There are two ways to invite organization members: One by one or in bulk.
/>
<Note>
Access Roles is a feature of the **Enterprise Edition**. In the **Community Edition** and on the **Free**
and **Startup** plan in the Cloud you can invite unlimited organization members as `Owners`.
Access Roles is a feature of the **Enterprise Edition**. In the **Community Edition** and on the **Free** and **Startup** plan in the Cloud you can invite unlimited organization members as `Owners`.
</Note>
Formbricks sends an email to the organization member with an invitation link. The organization member can accept the invitation or create a new account by clicking on the link.

View File

@@ -1,5 +1,5 @@
import { MdxImage } from "@/components/MdxImage";
import SurveyEmbed from "@/components/SurveyEmbed";
import { MdxImage } from "@/components/mdx-image";
import SurveyEmbed from "@/components/survey-embed";
import AddImageOrVideoToQuestionImage from "./images/add-image-or-video-to-question-image.webp";
import AddImageOrVideoToQuestionVideo from "./images/add-image-or-video-to-question-video.webp";
import AddImageOrVideoToQuestion from "./images/add-image-or-video-to-question.webp";
@@ -29,6 +29,7 @@ Upload an image by clicking the upload icon or dragging the file:
/>
## How to Add Videos
Toggle to add a video via link:
<MdxImage
@@ -42,4 +43,6 @@ Toggle to add a video via link:
We support YouTube, Vimeo, and Loom URLs.
<Note>**YouTube Privacy Mode**: This option reduces tracking by converting YouTube URLs to no-cookie URLs. It only works with YouTube.</Note>
<Note>
**YouTube Privacy Mode**: This option reduces tracking by converting YouTube URLs to no-cookie URLs. It only works with YouTube.
</Note>

View File

@@ -1,4 +1,4 @@
import { MdxImage } from "@/components/MdxImage";
import { MdxImage } from "@/components/mdx-image";
import ActionCalculateOperators from "./images/action-calculate-operators.webp";
import ActionCalculateValue from "./images/action-calculate-value.webp";
import ActionCalculateVariables from "./images/action-calculate-variables.webp";
@@ -38,8 +38,7 @@ Create complex survey logic with the Logic Editor. Use conditions, actions, and
<MdxImage src={AddLogic} alt="Add Logic" quality="100" className="max-w-full rounded-lg sm:max-w-3xl" />
<Note>
You can add multiple logic blocks to a survey. Logic blocks are executed in the order they are added. You
can rearrange the order of logic blocks.
You can add multiple logic blocks to a survey. Logic blocks are executed in the order they are added. You can rearrange the order of logic blocks.
</Note>
2. **Add Conditions**: Add conditions to the logic block. Conditions are rules that determine when an action should be executed.
@@ -87,8 +86,7 @@ Conditons can be based on:
/>
<Note>
- Conditions can be grouped. - Conditions can be combined using AND or OR operators. You can add multiple
conditions to a logic block. Conditions are evaluated in the order they are added.
- Conditions can be grouped. - Conditions can be combined using AND or OR operators. You can add multiple conditions to a logic block. Conditions are evaluated in the order they are added.
</Note>
<MdxImage

View File

@@ -1,4 +1,4 @@
import { MdxImage } from "@/components/MdxImage";
import { MdxImage } from "@/components/mdx-image";
import EmailCustomizationSettings from "./email-customization-card.webp";
import EmailSample from "./email-sample.webp";
@@ -14,8 +14,7 @@ export const metadata = {
Email customization is a white-label feature that allows you to customize the email that is sent to your users. You can upload a logo of your company and use it in the email.
<Note>
This feature is a white-label feature. It is only available for users on paid plans or have an enterprise
license.
This feature is a white-label feature. It is only available for users on paid plans or have an enterprise license.
</Note>
## How to Upload a Logo

View File

@@ -1,4 +1,4 @@
import { MdxImage } from "@/components/MdxImage";
import { MdxImage } from "@/components/mdx-image";
import FilledHiddenFields from "./filled-hidden-fields.webp";
import HiddenFieldResponses from "./hidden-field-responses.webp";
@@ -74,6 +74,7 @@ https://formbricks.com/clin3dxja02k8l80hpwmx4bjy?screen=landing_page&job=Founder
</Col>
### App & Website Surveys
For in-product surveys, you can set hidden fields in the response by adding them to the `formbricks.track` call:
<Col>
@@ -106,4 +107,4 @@ These hidden fields will now be visible in the responses tab just like other fie
- **Tracking Source**: You can add a hidden field to track the source of the survey. For a detailed guide on Source Tracking, check out the [Source Tracking](/link-surveys/source-tracking) guide.
- **User Metadata**: You can add hidden fields to capture user metadata such as user ID, email, or any other user-specific information.
- **Survey Metadata**: You can add hidden fields to capture other metadata, e.g. the screen from which the survey was filled, or any other app specific information.
- **Survey Metadata**: You can add hidden fields to capture other metadata, e.g. the screen from which the survey was filled, or any other app specific information.

View File

@@ -1,13 +1,12 @@
import { MdxImage } from "@/components/MdxImage";
import { MdxImage } from "@/components/mdx-image";
import StepOne from "./images/StepOne.webp";
import StepThree from "./images/StepThree.webp";
import StepTwo from "./images/StepTwo.webp";
import StepOne from "./images/step-one.webp";
import StepThree from "./images/step-three.webp";
import StepTwo from "./images/step-two.webp";
export const metadata = {
title: "Set a Maximum Number of Submissions for Surveys",
description:
"Limit the number of responses your survey can receive.",
description: "Limit the number of responses your survey can receive.",
};
# Limit by Number of Submissions
@@ -20,7 +19,7 @@ Automatically close your survey after a specific number of responses with Formbr
src={StepTwo}
alt="Choose a link survey template"
quality="100"
className="max-w-full rounded-lg sm:max-w-3xl "
className="max-w-full rounded-lg sm:max-w-3xl"
/>
- **Details**: Set a specific number of responses after which the survey automatically closes.
- **Use Case**: Perfect for limited offers, exclusive surveys, or when you need a precise sample size for statistical significance.

View File

@@ -1,5 +1,5 @@
import { MdxImage } from "@/components/MdxImage";
import { TellaVideo } from "@/components/TellaVideo";
import { MdxImage } from "@/components/mdx-image";
import { TellaVideo } from "@/components/tella-video";
import Filters from "./filters.webp";
import MetadataCard from "./metadata-card.webp";

View File

@@ -1,6 +1,6 @@
import { MdxImage } from "@/components/MdxImage";
import { MdxImage } from "@/components/mdx-image";
import { ResponsiveVideo } from "@/components/ResponsiveVideo";
import { ResponsiveVideo } from "@/components/responsive-video";
import AddLanguageInSurvey from "./add-language-in-survey.webp";
import AddLanguages from "./add-languages.webp";
import EditMultiLang from "./edit-multi-lang.webp";
@@ -137,8 +137,7 @@ Formbricks.init({
</Col>
<Note>
If a user has a language assigned, a survey has multi-language activate and it is missing a translation in
the language of the user, the survey will not be displayed.
If a user has a language assigned, a survey has multi-language activate and it is missing a translation in the language of the user, the survey will not be displayed.
</Note>
2. That's it! Now, users with the language attribute set will see the survey in their preferred language. You can start collecting responses in multiple languages and filter them by language on the summary page.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

View File

@@ -1,13 +1,13 @@
import { MdxImage } from "@/components/MdxImage";
import { MdxImage } from "@/components/mdx-image";
import StepEleven from "./images/StepEleven.webp";
import StepNine from "./images/StepNine.webp";
import StepTen from "./images/StepTen.webp";
import StepEleven from "./images/step-eleven.webp";
import StepNine from "./images/step-nine.webp";
import StepTen from "./images/step-ten.webp";
import Doggo from "./images/Doggo.jpg";
import HipsterLiving from "./images/HipsterLiving.jpg";
import Mario from "./images/Mario.webp";
import WindowsXp from "./images/WindowsXp.jpg";
import Doggo from "./images/doggo.webp";
import HipsterLiving from "./images/hipster-living.webp";
import Mario from "./images/mario.webp";
import WindowsXp from "./images/windows-xp.webp";
export const metadata = {
title: "Overwrite Styling Theme on Individual Surveys",
@@ -20,7 +20,7 @@ export const metadata = {
Overwrite the global styling theme for individual surveys to create unique styles for each survey.
<Note>
To set a styling theme for all surveys, please see the [Styling Theme](/core-features/global/styling-theme) manual.{" "}
To set a styling theme for all surveys, please see the [Styling Theme](/core-features/global/styling-theme) manual.
</Note>
### Overwrite Styling Theme

View File

@@ -1,6 +1,6 @@
import { MdxImage } from "@/components/MdxImage";
import { MdxImage } from "@/components/mdx-image";
import StepOne from "./images/StepOne.webp";
import StepOne from "./images/step-one.webp";
export const metadata = {
title: "Collect Partial Submissions with Formbricks",
@@ -39,7 +39,7 @@ Formbricks provides detailed analytics for partial submissions, including a per-
src={StepOne}
alt="Choose a link survey template"
quality="100"
className="max-w-full rounded-lg sm:max-w-3xl "
className="max-w-full rounded-lg sm:max-w-3xl"
/>
### **Survey Summary Analytics**

View File

@@ -1,5 +1,5 @@
import { MdxImage } from "@/components/MdxImage";
import SurveyEmbed from "@/components/SurveyEmbed";
import { MdxImage } from "@/components/mdx-image";
import SurveyEmbed from "@/components/survey-embed";
import Address from "./images/address.webp";
#### Question Type
@@ -20,17 +20,20 @@ The Address question type allows respondents to input their address details, inc
/>
### Question
Provide a question to describe the address information you are requesting.
### Description
Optionally, add a description to guide the user.
### Toggle Fields
You can choose to show and require any or all of the following fields in the form:
- Address Line 1
- Address Line 2
- City
- State
- Zip Code
- Country
You can choose to show and require any or all of the following fields in the form:
- Address Line 1
- Address Line 2
- City
- State
- Zip Code
- Country

View File

@@ -1,5 +1,5 @@
import { MdxImage } from "@/components/MdxImage";
import SurveyEmbed from "@/components/SurveyEmbed";
import { MdxImage } from "@/components/mdx-image";
import SurveyEmbed from "@/components/survey-embed";
import Consent from "./images/consent.webp";
#### Question Type
@@ -11,6 +11,7 @@ The Consent card is used to obtain user agreement regarding a product, service,
<SurveyEmbed surveyUrl="https://app.formbricks.com/s/orxp15pca6x2nfr3v8pttpwm" />
## Elements
<MdxImage
src={Consent}
alt="Overview of Consent question type"
@@ -19,10 +20,13 @@ The Consent card is used to obtain user agreement regarding a product, service,
/>
### Title
A bold statement or question asking for user consent, displayed prominently at the top of the card.
### Description
A short explanation or additional context for the consent request, displayed below the title. The text can be formatted, and hyperlinks are allowed within the description.
### Checkbox
At the bottom of the card, users can confirm their agreement by checking the box, indicating their consent to the question or statement above. The label for the checkbox is also editable.
At the bottom of the card, users can confirm their agreement by checking the box, indicating their consent to the question or statement above. The label for the checkbox is also editable.

View File

@@ -1,5 +1,5 @@
import { MdxImage } from "@/components/MdxImage";
import SurveyEmbed from "@/components/SurveyEmbed";
import { MdxImage } from "@/components/mdx-image";
import SurveyEmbed from "@/components/survey-embed";
import Contact from "./images/contact.webp";
#### Question Type
@@ -11,6 +11,7 @@ The Contact Info question type allows respondents to provide their basic contact
<SurveyEmbed surveyUrl="https://app.formbricks.com/s/z2zjoonfeythx5n6z5qijbsg" />
## Elements
<MdxImage
src={Contact}
alt="Overview of Contact Info question type"
@@ -29,8 +30,9 @@ Optionally, add a description to give additional context.
### Toggle Fields
You can choose to show and require any or all of the following fields:
- First Name
- Last Name
- Email
- Phone Number
- Company
- First Name
- Last Name
- Email
- Phone Number
- Company

View File

@@ -1,5 +1,5 @@
import { MdxImage } from "@/components/MdxImage";
import SurveyEmbed from "@/components/SurveyEmbed";
import { MdxImage } from "@/components/mdx-image";
import SurveyEmbed from "@/components/survey-embed";
import Date from "./images/date.webp";
#### Question Type
@@ -11,6 +11,7 @@ The Date question type allows respondents to provide a date, such as when they a
<SurveyEmbed surveyUrl="https://app.formbricks.com/s/rk844spc8ffls25vzkxzzhse" />
## Elements
<MdxImage
src={Date}
alt="Overview of Date question type"
@@ -19,14 +20,17 @@ The Date question type allows respondents to provide a date, such as when they a
/>
### Title
Add a clear title to inform the respondent what date you are asking for.
### Description
Provide an optional description with further instructions.
### Date Format
Choose from multiple date formats for the input:
- MM-DD-YYYY
- DD-MM-YYYY
- YYYY-MM-DD
Choose from multiple date formats for the input:
- MM-DD-YYYY
- DD-MM-YYYY
- YYYY-MM-DD

View File

@@ -1,5 +1,5 @@
import { MdxImage } from "@/components/MdxImage";
import SurveyEmbed from "@/components/SurveyEmbed";
import { MdxImage } from "@/components/mdx-image";
import SurveyEmbed from "@/components/survey-embed";
import FileUpload from "./images/file-upload.webp";
#### Questions Type
@@ -11,6 +11,7 @@ The File Upload question type allows respondents to upload files related to your
<SurveyEmbed surveyUrl="https://app.formbricks.com/s/oo4e6vva48w0trn01ht8krwo" />
## Elements
<MdxImage
src={FileUpload}
alt="Overview of Fill Upload question type"
@@ -19,16 +20,21 @@ The File Upload question type allows respondents to upload files related to your
/>
### Title
Add a clear title that informs the respondent about the purpose of the file upload.
### Description
Provide an optional description to give respondents more details or instructions about what files they need to upload.
### Allow Multiple Files
Enable this option to allow respondents to upload multiple files at once.
### Max File Size
You can set a maximum file size limit, and an input box will appear to specify the size in MB.
### File Type Restrictions
You can restrict the allowed file types. An input box will appear where you can specify the file formats, such as `.pdf`, `.jpg`, `.docx`, etc.
You can restrict the allowed file types. An input box will appear where you can specify the file formats, such as `.pdf`, `.jpg`, `.docx`, etc.

View File

@@ -1,5 +1,5 @@
import { MdxImage } from "@/components/MdxImage";
import SurveyEmbed from "@/components/SurveyEmbed";
import { MdxImage } from "@/components/mdx-image";
import SurveyEmbed from "@/components/survey-embed";
import FreeText from "./images/free-text.webp";
export const metadata = {
@@ -16,6 +16,7 @@ Free text questions allow respondents to enter a custom answer. Displays a title
<SurveyEmbed surveyUrl="https://app.formbricks.com/s/cm2b2eftv000012b0l3htbu0a" />
## Elements
<MdxImage
src={FreeText}
alt="Overview of Free Text question type"
@@ -24,12 +25,15 @@ Free text questions allow respondents to enter a custom answer. Displays a title
/>
### Title
Add a clear title to inform the respondent what information you are asking for.
### Description
Provide an optional description with further instructions.
### Placeholder
Specify a placeholder text to display in the input field.
### Input Type

View File

@@ -1,5 +1,5 @@
import { MdxImage } from "@/components/MdxImage";
import SurveyEmbed from "@/components/SurveyEmbed";
import { MdxImage } from "@/components/mdx-image";
import SurveyEmbed from "@/components/survey-embed";
import Matrix from "./images/matrix.webp";
#### Question Type

View File

@@ -1,5 +1,5 @@
import { MdxImage } from "@/components/MdxImage";
import SurveyEmbed from "@/components/SurveyEmbed";
import { MdxImage } from "@/components/mdx-image";
import SurveyEmbed from "@/components/survey-embed";
import MultiSelect from "./images/multi-select.webp";
export const metadata = {
@@ -16,6 +16,7 @@ Multi select questions allow respondents to select several answers from a list.
<SurveyEmbed surveyUrl="https://app.formbricks.com/s/jhyo6lwzf6eh3fyplhlp7h5f" />
## Elements
<MdxImage
src={MultiSelect}
alt="Overview of Multi Select question type"
@@ -24,13 +25,15 @@ Multi select questions allow respondents to select several answers from a list.
/>
### Title
Add a clear title to inform the respondent what information you are asking for.
### Description
Provide an optional description with further instructions.
### Options
Define the options shown in the list. These represent the items for which users will select.
Other than the fact that respondents can select multiple options, multi select questions are similar to [single select](/global/question-types/single-select) questions.

View File

@@ -1,5 +1,5 @@
import { MdxImage } from "@/components/MdxImage";
import SurveyEmbed from "@/components/SurveyEmbed";
import { MdxImage } from "@/components/mdx-image";
import SurveyEmbed from "@/components/survey-embed";
import NetPromoterScore from "./images/net-promoter-score.webp";
#### Question Type
@@ -11,6 +11,7 @@ Net Promoter Score questions allow respondents to rate a question on a scale fro
<SurveyEmbed surveyUrl="https://app.formbricks.com/s/vqmpasmnt5qcpsa4enheips0" />
## Elements
<MdxImage
src={NetPromoterScore}
alt="Overview of Net Promoter Score question type"
@@ -19,13 +20,17 @@ Net Promoter Score questions allow respondents to rate a question on a scale fro
/>
### Title
Add a clear title to inform the respondent what information you are asking for.
### Description
Provide an optional description with further instructions.
### Labels
Add labels for the lower and upper bounds of the score. The default is "Not at all likely" and "Extremely likely".
### Add color coding
Add color coding to the score. This will show a color bar above the score.
Add color coding to the score. This will show a color bar above the score.

View File

@@ -1,5 +1,5 @@
import { MdxImage } from "@/components/MdxImage";
import SurveyEmbed from "@/components/SurveyEmbed";
import { MdxImage } from "@/components/mdx-image";
import SurveyEmbed from "@/components/survey-embed";
import PictureSelection from "./images/picture-selection.webp";
export const metadata = {
@@ -16,6 +16,7 @@ Picture selection questions allow respondents to select one or more images from
<SurveyEmbed surveyUrl="https://app.formbricks.com/s/xtgmwxlk7jxxr4oi6ym7odki" />
## Elements
<MdxImage
src={PictureSelection}
alt="Overview of Picture Selection question type"
@@ -24,13 +25,17 @@ Picture selection questions allow respondents to select one or more images from
/>
### Title
Add a clear title to inform the respondent what information you are asking for.
### Description
Provide an optional description with further instructions.
### Images
Images can be uploaded via click or drag and drop. At least two images are required.
### Allow Multi Select
This option allows user to select more than one image.
This option allows user to select more than one image.

View File

@@ -1,5 +1,5 @@
import { MdxImage } from "@/components/MdxImage";
import SurveyEmbed from "@/components/SurveyEmbed";
import { MdxImage } from "@/components/mdx-image";
import SurveyEmbed from "@/components/survey-embed";
import Ranking from "./images/ranking.webp";
#### Question Type
@@ -11,6 +11,7 @@ Ranking questions let respondents select options in order from 1 to the total nu
<SurveyEmbed surveyUrl="https://app.formbricks.com/s/z6s84x9wbyk0yqqtfaz238px" />
## Elements
<MdxImage
src={Ranking}
alt="Overview of Ranking question type"
@@ -19,14 +20,18 @@ Ranking questions let respondents select options in order from 1 to the total nu
/>
### Title
Add a clear title to inform the respondent what information you are asking for.
### Description
Provide an optional description with further instructions.
### Options
You need to add at least two options so that users can rearrange them in numerical order based on their selection.
### Select ordering
- Keep current order: This will keep the order of options the same for all respondents.
- Randomize all: This will randomize the options for each respondent.

View File

@@ -1,5 +1,5 @@
import { MdxImage } from "@/components/MdxImage";
import SurveyEmbed from "@/components/SurveyEmbed";
import { MdxImage } from "@/components/mdx-image";
import SurveyEmbed from "@/components/survey-embed";
import Rating from "./images/rating.webp";
export const metadata = {
@@ -16,6 +16,7 @@ Rating questions allow respondents to rate questions on a scale. Displays a titl
<SurveyEmbed surveyUrl="https://app.formbricks.com/s/cx7u4n6hwvc3nztuk4vdezl9" />
## Elements
<MdxImage
src={Rating}
alt="Overview of Rating question type"
@@ -24,16 +25,21 @@ Rating questions allow respondents to rate questions on a scale. Displays a titl
/>
### Title
Add a clear title to inform the respondent what information you are asking for.
### Description
Provide an optional description with further instructions.
### Scale
Select the icon to be used for the rating scale. The options include: stars, numbers or smileys. The default is stars.
### Range
Select the range of the rating scale. the options include: 3, 4, 5, 7 or 10. The default is 5.
### Labels
Add labels for the lower and upper bounds of the rating scale. The default is "Not good" and "Very good".
Add labels for the lower and upper bounds of the rating scale. The default is "Not good" and "Very good".

View File

@@ -1,5 +1,5 @@
import { MdxImage } from "@/components/MdxImage";
import SurveyEmbed from "@/components/SurveyEmbed";
import { MdxImage } from "@/components/mdx-image";
import SurveyEmbed from "@/components/survey-embed";
import ScheduleCall from "./images/schedule-call.webp";
#### Question Type
@@ -11,6 +11,7 @@ The Schedule A Meeting question type allows respondents to book a meeting by sel
<SurveyEmbed surveyUrl="https://app.formbricks.com/s/hx08x27c2aghywh57rroe6fi" />
## Elements
<MdxImage
src={ScheduleCall}
alt="Overview of Schedule question type"
@@ -19,13 +20,17 @@ The Schedule A Meeting question type allows respondents to book a meeting by sel
/>
### Title
Add a clear title to inform the respondent what information you are asking for.
### Description
Provide an optional description with further instructions.
### Cal.com Username/Event
Add an input box where users can enter their [`cal.com`](https://cal.com/) username and event URL (e.g., `username/event`).
### Custom Hostname (Optional)
Enable an input box for adding a custom hostname, which is necessary if using a self-hosted instance of [`cal.com`](https://cal.com/docs/self-hosting/installation).
Enable an input box for adding a custom hostname, which is necessary if using a self-hosted instance of [`cal.com`](https://cal.com/docs/self-hosting/installation).

View File

@@ -1,5 +1,5 @@
import { MdxImage } from "@/components/MdxImage";
import SurveyEmbed from "@/components/SurveyEmbed";
import { MdxImage } from "@/components/mdx-image";
import SurveyEmbed from "@/components/survey-embed";
import SingleSelect from "./images/single-select.webp";
export const metadata = {
@@ -16,6 +16,7 @@ Single select questions allow respondents to select one answer from a list. Disp
<SurveyEmbed surveyUrl="https://app.formbricks.com/s/wybd3v3cxpdfve4472fu3lhi" />
## Elements
<MdxImage
src={SingleSelect}
alt="Overview of Single Select question type"
@@ -24,12 +25,15 @@ Single select questions allow respondents to select one answer from a list. Disp
/>
### Title
Add a clear title to inform the respondent what information you are asking for.
### Description
Provide an optional description with further instructions.
### Options
The list of answers the respondent can choose from.
### Additional Actions
@@ -41,4 +45,4 @@ The list of answers the respondent can choose from.
- Order dropdown: Allows you to choose the order in which the options are displayed.
- Keep current order: Options will be displayed in the order you added them.
- Randomize all: Options will be displayed in a random order.
- Randomize all except last option: Options will be displayed in a random order, except for the last one.
- Randomize all except last option: Options will be displayed in a random order, except for the last one.

View File

@@ -1,6 +1,6 @@
import { MdxImage } from "@/components/MdxImage";
import SurveyEmbed from "@/components/SurveyEmbed";
import StatementCTA from "./images/statement-CTA.webp";
import { MdxImage } from "@/components/mdx-image";
import SurveyEmbed from "@/components/survey-embed";
import StatementCTA from "./images/statement-cta.webp";
#### Question Type
@@ -11,6 +11,7 @@ The Statement question type allows you to display descriptive information in you
<SurveyEmbed surveyUrl="https://app.formbricks.com/s/k3p7r7riyy504u4zziqat8zj" />
## Elements
<MdxImage
src={StatementCTA}
alt="Overview of Statement question type"
@@ -19,11 +20,14 @@ The Statement question type allows you to display descriptive information in you
/>
### Title
This is the main question or heading that appears at the top of the card.
### Description
A brief note or instruction displayed under the title, typically used to provide context or instructions for the next step.
### Button Options
- Button to continue in survey: This will continue respondent with the survey, form or fillups.
- Button to link to external URL: Selecting this option will open-up URL input box below when us set URL the button will redirect to your setted link.

View File

Before

Width:  |  Height:  |  Size: 8.5 KiB

After

Width:  |  Height:  |  Size: 8.5 KiB

View File

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 13 KiB

View File

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 13 KiB

View File

@@ -1,19 +1,21 @@
import { MdxImage } from "@/components/MdxImage";
import SurveyEmbed from "@/components/SurveyEmbed";
import StepOne from "./images/StepOne.webp";
import StepThree from "./images/StepThree.webp";
import StepTwo from "./images/StepTwo.webp";
import { MdxImage } from "@/components/mdx-image";
import SurveyEmbed from "@/components/survey-embed";
import StepOne from "./images/step-one.webp";
import StepThree from "./images/step-three.webp";
import StepTwo from "./images/step-two.webp";
export const metadata = {
title: "Recall Data in Formbricks Surveys",
description:
"Personalize your surveys by dynamically inserting data from URL parameters or previous answers into questions and descriptions. The Recall Data feature helps create engaging, adaptive survey experiences tailored to each respondent."};
"Personalize your surveys by dynamically inserting data from URL parameters or previous answers into questions and descriptions. The Recall Data feature helps create engaging, adaptive survey experiences tailored to each respondent.",
};
# Recall Data
Personalize your surveys by dynamically inserting data from URL parameters or previous answers into questions and descriptions. The Recall Data feature helps create engaging, adaptive survey experiences tailored to each respondent.
## Recall Sources
You can recall data from the following sources:
- From a previous question
@@ -23,8 +25,7 @@ You can recall data from the following sources:
## Recalling from a previous question
<Note>
The recall functionality is disabled on the first question of the survey since theres no preceding question
to recall data from.
The recall functionality is disabled on the first question of the survey since theres no preceding question to recall data from.
</Note>
### **Pre-requisite**
@@ -35,7 +36,7 @@ Ensure the answer you wish to recall precedes the question in which it will be r
src={StepThree}
alt="Survey setup example with link survey template"
quality="100"
className="max-w-full rounded-lg sm:max-w-3xl "
className="max-w-full rounded-lg sm:max-w-3xl"
/>
### **Step 1: Recall Data**
@@ -46,7 +47,7 @@ Type **`@`** in the question or description field where you want to insert a rec
src={StepTwo}
alt="Dropdown menu for recalling data in survey"
quality="100"
className="max-w-full rounded-lg sm:max-w-3xl "
className="max-w-full rounded-lg sm:max-w-3xl"
/>
### **Step 2: Set a Fallback**
@@ -57,10 +58,11 @@ To ensure the survey remains coherent when a response is missing (or the questio
src={StepOne}
alt="Setting fallback option in survey question"
quality="100"
className="max-w-full rounded-lg sm:max-w-3xl "
className="max-w-full rounded-lg sm:max-w-3xl"
/>
## Recalling from the URL
1. Create a hidden field, [here is how →](/docs/global/hidden-fields)
2. Use the `@` symbol in a question or description to recall the value of the hidden field
3. Set a fallback in case the hidden field is not being filled by a URL parameter

View File

@@ -1,13 +1,12 @@
import { MdxImage } from "@/components/MdxImage";
import { MdxImage } from "@/components/mdx-image";
import StepOne from "./images/StepOne.webp";
import StepThree from "./images/StepThree.webp";
import StepTwo from "./images/StepTwo.webp";
import StepOne from "./images/step-one.webp";
import StepThree from "./images/step-three.webp";
import StepTwo from "./images/step-two.webp";
export const metadata = {
title: "Schedule Start & End Dates for Surveys",
description:
"Automatically release and close surveys based on specific dates.",
description: "Automatically release and close surveys based on specific dates.",
};
# Schedule Start & End Dates
@@ -24,7 +23,7 @@ Configure your surveys to open and close based on specific criteria. Heres ho
src={StepOne}
alt="Choose a link survey template"
quality="100"
className="max-w-full rounded-lg sm:max-w-3xl "
className="max-w-full rounded-lg sm:max-w-3xl"
/>
- **Details**: Choose the date and time when the survey should become available to respondents. All times follow UTC timezone.
@@ -38,11 +37,11 @@ Configure your surveys to open and close based on specific criteria. Heres ho
src={StepThree}
alt="Choose a link survey template"
quality="100"
className="max-w-full rounded-lg sm:max-w-3xl "
className="max-w-full rounded-lg sm:max-w-3xl"
/>
- **Details**: Define a specific date and time for the survey to close. This also follows UTC timezone. - **Use
Case**: Essential for surveys linked to time-bound events or studies where data collection needs to end at a specific
point.
- **Details**: Define a specific date and time for the survey to close. This also follows UTC timezone. -
**Use Case**: Essential for surveys linked to time-bound events or studies where data collection needs to end
at a specific point.
### **Summary**

View File

@@ -1,4 +1,4 @@
import { MdxImage } from "@/components/MdxImage";
import { MdxImage } from "@/components/mdx-image";
import StepOne from "./images/1-publish-to-web.webp";
import StepTwo from "./images/2-warning-publish.webp";
@@ -6,8 +6,7 @@ import StepThree from "./images/3-share-link.webp";
export const metadata = {
title: "Shareable Dashboards",
description:
"Create shareable links to dashboards of specific surveys.",
description: "Create shareable links to dashboards of specific surveys.",
};
# Shareable Dashboards

View File

@@ -1,7 +1,7 @@
import { MdxImage } from "@/components/MdxImage";
import { MdxImage } from "@/components/mdx-image";
import StepOne from "./images/StepOne.webp";
import StepTwo from "./images/StepTwo.webp";
import StepOne from "./images/step-one.webp";
import StepTwo from "./images/step-two.webp";
export const metadata = {
title: "Show Survey to % of Users",
@@ -14,8 +14,7 @@ export const metadata = {
To target specific segments of your audience or manage survey exposure, Formbricks allows you to display surveys to only a percentage of your targeted users.
<Note>
This feature is applicable for website surveys and app surveys, where managing participant engagement and
response volume is crucial.
This feature is applicable for website surveys and app surveys, where managing participant engagement and response volume is crucial.
</Note>
## **Enabling Percentage-Based Visibility**
@@ -34,7 +33,7 @@ Set up this feature to control how many users see your survey, using a simple sl
src={StepOne}
alt="Choose a link survey template"
quality="100"
className="max-w-full rounded-lg sm:max-w-3xl "
className="max-w-full rounded-lg sm:max-w-3xl"
/>
- Select **`Survey Trigger`** from the menu options.
@@ -51,12 +50,11 @@ Set up this feature to control how many users see your survey, using a simple sl
src={StepTwo}
alt="Choose a link survey template"
quality="100"
className="max-w-full rounded-lg sm:max-w-3xl "
className="max-w-full rounded-lg sm:max-w-3xl"
/>
<Note>
Please note that this feature operates based on mathematical probabilistic functions, which may result in
slight variations in the exact percentage of users who see the survey.{" "}
Please note that this feature operates based on mathematical probabilistic functions, which may result in slight variations in the exact percentage of users who see the survey.
</Note>
### **Example Usage**

Binary file not shown.

Before

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.5 KiB

View File

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 19 KiB

View File

Before

Width:  |  Height:  |  Size: 6.9 KiB

After

Width:  |  Height:  |  Size: 6.9 KiB

View File

Before

Width:  |  Height:  |  Size: 5.7 KiB

After

Width:  |  Height:  |  Size: 5.7 KiB

View File

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB

View File

Before

Width:  |  Height:  |  Size: 8.4 KiB

After

Width:  |  Height:  |  Size: 8.4 KiB

View File

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 13 KiB

View File

Before

Width:  |  Height:  |  Size: 25 KiB

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

View File

@@ -1,23 +1,23 @@
import { MdxImage } from "@/components/MdxImage";
import { MdxImage } from "@/components/mdx-image";
import StepEight from "./images/StepEight.webp";
import StepEleven from "./images/StepEleven.webp";
import StepFive from "./images/StepFive.webp";
import StepFour from "./images/StepFour.webp";
import StepNine from "./images/StepNine.webp";
import StepSeven from "./images/StepSeven.webp";
import StepSix from "./images/StepSix.webp";
import StepTen from "./images/StepTen.webp";
import AllowOverwrite from "./images/allow-overwrite.webp";
import BackgroundSettings from "./images/background-settings.webp";
import CardSettings from "./images/card-settings.webp";
import FormSettings from "./images/form-settings.webp";
import LookAndFeelSettings from "./images/look-and-feel.webp";
import StepEight from "./images/step-eight.webp";
import StepEleven from "./images/step-eleven.webp";
import StepFive from "./images/step-five.webp";
import StepFour from "./images/step-four.webp";
import StepNine from "./images/step-nine.webp";
import StepSeven from "./images/step-seven.webp";
import StepSix from "./images/step-six.webp";
import StepTen from "./images/step-ten.webp";
import Doggo from "./images/Doggo.jpg";
import HipsterLiving from "./images/HipsterLiving.jpg";
import Mario from "./images/Mario.webp";
import WindowsXp from "./images/WindowsXp.jpg";
import Doggo from "./images/doggo.webp";
import HipsterLiving from "./images/hipster-living.webp";
import Mario from "./images/mario.webp";
import WindowsXp from "./images/windows-xp.webp";
export const metadata = {
title: "Styling Theme",

View File

@@ -1,4 +1,4 @@
import { MdxImage } from "@/components/MdxImage";
import { MdxImage } from "@/components/mdx-image";
import CreatedVariables from "./images/created-variables.webp";
import InputVariables from "./images/input-variables.webp";
@@ -84,6 +84,5 @@ Variables are different from hidden fields in the following ways:
/>
<Note>
To know more about how to use logic in Formbricks, check out the [Conditional
Logic](/global/conditional-logic).
To know more about how to use logic in Formbricks, check out the [Conditional Logic](/global/conditional-logic).
</Note>

View File

@@ -1,13 +1,13 @@
"use client";
import { Button } from "@/components/Button";
import { LoadingSpinner } from "@/components/icons/LoadingSpinner";
import { useTheme } from "next-themes";
import { useState } from "react";
import { RedocStandalone } from "redoc";
import { LoadingSpinner } from "@/components/icons/loading-spinner";
import { Button } from "@/components/button";
import "./style.css";
export const ApiDocs = () => {
export function ApiDocs() {
const { resolvedTheme } = useTheme();
const redocTheme = {
@@ -61,8 +61,8 @@ export const ApiDocs = () => {
<Button href="/developer-docs/rest-api" arrow="left" className="mb-4 mt-8">
Back to docs
</Button>
<RedocStandalone specUrl="/docs/openapi.yaml" onLoaded={() => setLoading(false)} options={redocTheme} />
{loading && <LoadingSpinner />}
<RedocStandalone specUrl="/docs/openapi.yaml" onLoaded={() => { setLoading(false); }} options={redocTheme} />
{loading ? <LoadingSpinner /> : null}
</div>
);
};
}

View File

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

View File

Before

Width:  |  Height:  |  Size: 53 KiB

After

Width:  |  Height:  |  Size: 53 KiB

View File

@@ -1,7 +1,7 @@
import { MdxImage } from "@/components/MdxImage";
import { MdxImage } from "@/components/mdx-image";
import I1 from "./images/I1.webp";
import I2 from "./images/I2.webp";
import I1 from "./images/i1.webp";
import I2 from "./images/i2.webp";
export const metadata = {
title: "Using Actions in Formbricks",

View File

@@ -1,45 +1,45 @@
import { Button } from "@/components/Button";
import Image from "next/image";
import { Button } from "@/components/button";
import logoHtml from "@/images/frameworks/html5.svg";
import logoNextjs from "@/images/frameworks/nextjs.svg";
import logoReactJs from "@/images/frameworks/reactjs.svg";
import logoVueJs from "@/images/frameworks/vuejs.svg";
import Image from "next/image";
const libraries = [
{
href: "#html",
name: "HTML",
description: "All you need to do is add 3 lines of code to your HTML script and thats it, you're done!",
logo: logoHtml,
logo: logoHtml as string,
},
{
href: "#react-js",
name: "React.js",
description: "Load the our Js library with your environment ID and you're ready to go!",
logo: logoReactJs,
logo: logoReactJs as string,
},
{
href: "#next-js",
name: "Next.js",
description:
"Natively add us to your NextJs project with support for both App as well as Pages project structure!",
logo: logoNextjs,
logo: logoNextjs as string,
},
{
href: "#vue-js",
name: "Vue.js",
description: "Simply add us to your router change and sit back!",
logo: logoVueJs,
logo: logoVueJs as string,
},
{
href: "#react-native",
name: "React Native",
description: "Easily integrate our SDK with your React Native app for seamless survey support!",
logo: logoReactJs,
logo: logoReactJs as string,
},
];
export const Libraries = () => {
export function Libraries() {
return (
<div className="my-16 xl:max-w-none">
<div className="not-prose mt-4 grid grid-cols-1 gap-x-6 gap-y-10 border-slate-900/5 xl:max-w-none xl:grid-cols-2 2xl:grid-cols-3 dark:border-white/5">
@@ -63,4 +63,4 @@ export const Libraries = () => {
</div>
</div>
);
};
}

View File

@@ -1,6 +1,6 @@
import { MdxImage } from "@/components/MdxImage";
import { MdxImage } from "@/components/mdx-image";
import { Libraries } from "./components/Libraries";
import { Libraries } from "./components/libraries";
import ReactApp from "./images/react-in-app-survey-app-popup-form.webp";
import WidgetConnected from "./images/widget-connected.webp";

View File

Before

Width:  |  Height:  |  Size: 70 KiB

After

Width:  |  Height:  |  Size: 70 KiB

View File

Before

Width:  |  Height:  |  Size: 88 KiB

After

Width:  |  Height:  |  Size: 88 KiB

View File

Before

Width:  |  Height:  |  Size: 102 KiB

After

Width:  |  Height:  |  Size: 102 KiB

View File

Before

Width:  |  Height:  |  Size: 110 KiB

After

Width:  |  Height:  |  Size: 110 KiB

View File

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 42 KiB

View File

Before

Width:  |  Height:  |  Size: 149 KiB

After

Width:  |  Height:  |  Size: 149 KiB

View File

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 34 KiB

View File

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 26 KiB

View File

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 23 KiB

View File

@@ -1,14 +1,14 @@
import { MdxImage } from "@/components/MdxImage";
import { MdxImage } from "@/components/mdx-image";
import I1 from "./images/I1.webp";
import I2 from "./images/I2.webp";
import I3 from "./images/I3.webp";
import I3_1 from "./images/I3_1.webp";
import I4 from "./images/I4.webp";
import I5 from "./images/I5.webp";
import I6 from "./images/I6.webp";
import I7 from "./images/I7.webp";
import I8 from "./images/I8.webp";
import I1 from "./images/i1.webp";
import I2 from "./images/i2.webp";
import I3 from "./images/i3.webp";
import I3_1 from "./images/i3_1.webp";
import I4 from "./images/i4.webp";
import I5 from "./images/i5.webp";
import I6 from "./images/i6.webp";
import I7 from "./images/i7.webp";
import I8 from "./images/i8.webp";
export const metadata = {
title: "Formbricks Quickstart Guide: App Surveys Made Easier & Faster",

View File

@@ -1,4 +1,4 @@
import { MdxImage } from "@/components/MdxImage";
import { MdxImage } from "@/components/mdx-image";
import AppSurvey from "./app-survey.webp";
import GlobalWaitTime from "./global-wait-time.webp";

Some files were not shown because too many files have changed in this diff Show More