Repository: roundtableAI/roundtable-js
Branch: main
Commit: c752b33a7c89
Files: 33
Total size: 154.7 KB
Directory structure:
gitextract_qhmt1r8t/
├── .gitignore
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── examples/
│ ├── index.html
│ └── studies/
│ ├── book-a-demo.js
│ ├── data-annotation.js
│ ├── element-showcase.js
│ ├── enterprise-market-research.js
│ ├── llm-rlhf.js
│ ├── nps-with-branding.js
│ ├── product-market-fit.js
│ └── typeform.js
├── index.js
├── library/
│ ├── core/
│ │ ├── element.js
│ │ ├── plugin.js
│ │ └── survey.js
│ ├── elements/
│ │ ├── HTML.js
│ │ ├── boundingBox.js
│ │ ├── checkBox.js
│ │ ├── dropdownSelect.js
│ │ ├── grid.js
│ │ ├── multiSelect.js
│ │ ├── numberEntry.js
│ │ ├── numberScale.js
│ │ ├── openEnd.js
│ │ ├── singleSelect.js
│ │ └── textInput.js
│ └── plugins/
│ ├── pageHTML.js
│ └── progressBar.js
├── package.json
└── webpack.config.cjs
================================================
FILE CONTENTS
================================================
================================================
FILE: .gitignore
================================================
/node_modules
/dist
================================================
FILE: CODE_OF_CONDUCT.md
================================================
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
support@roundtable.ai.
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series of
actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within the
community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].
[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
================================================
FILE: CONTRIBUTING.md
================================================
# Contributing to RoundtableJS
Thank you for considering contributing to **RoundtableJS**. Here are a few guidelines to help you get started.
### Code of Conduct
Please read our [Code of Conduct](https://github.com/roundtableAI/roundtable-js/blob/main/CODE_OF_CONDUCT.md) before participating. We expect all contributors to adhere to it.
### How Can I Contribute?
**Reporting Bugs**
- Check the [issues](https://github.com/roundtableAI/roundtable-js/issues) for similar reportings.
- Draft a bug report for submission.
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the steps to reproduce the problem in as much detail as possible. Include any relevant information like operating system, browser version, and any logs or error messages. Provide screenshots or animated GIFs if possible.
**Suggesting Enhancements**
- Check the [issues](https://github.com/roundtableAI/roundtable-js/issues) for similar suggestions.
- Draft an enhancement submission report.
- Use a clear and descriptive title for the suggestion.
- Provide a detailed explanation of the suggested enhancement. Explain why this enhancement would be useful to most **RoundtableJS** users.
**Submitting Pull Requests**
1. Check the [issues](https://github.com/roundtableAI/roundtable-js/issues) for relevant discussions.
2. Fork the repository and create your branch from `main`.
3. If you've added code that should be tested, add tests.
4. Ensure the test suite passes and that your code lints.
5. Create a pull request using the pull request template (in progress)
Thank you for your contribution! 📊 ✨
================================================
FILE: LICENSE
================================================
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2024 Roundtable Technologies Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
================================================
FILE: README.md
================================================
RoundtableJS is an open-source JavaScript library for building complex surveys, forms, and data annotation tasks. It's designed to be simple but completely customizable. We make it easy to add complex logic (e.g. branching, skipping, looping), modify question types, and fully customize the design.
## 🌟 Features
- **Designed for the Modern Web:** We're designed in JavaScript and leverage its asynchronous functionality for managing survey logic. For example, rather than determining this logic based on callbacks that trigger when a page is submitted, our library builds the timeline in an async function which means the logic flows intuitively from top to bottom.
- **Developer-Friendly:** We are open-source and API-first. The idea for RoundtableJS arose by seeing how difficult it was to integrate Roundtable's API into other survey software. We want the open-source offering to include a robust plugin ecosystem where people can introduce new question types, integrate with tools like CRMs, and control how data is stored and processed.
- **AI-Native Functionality:** Our [cloud offering](https://surveys.roundtable.ai) has AI-native features such as natural language programming and automated fraud detection. We're continuously expanding our AI features. Let us know what tools you'd like to see!
## 🖼️ Examples
Here are some example surveys built with RoundtableJS. All code is in the [examples/studies](examples/studies) directory.
- [Element showcase](https://roundtable.ai/survey/3e76ab92512f398e366baffd772b06cf972c0c0e)
- [Enterprise market research survey](https://roundtable.ai/survey/3020c264e57a0415889a7d82330af66daf30db15)
- [Simple NPS with branding](https://roundtable.ai/survey/bed16082755fc02b70f582c1fe143b8e7d292a43)
- [Typeform survey](https://roundtable.ai/survey/134a2317bb595d7768194de65772f97dc760b60b)
- [Product market fit survey](https://roundtable.ai/survey/765c87578ccf7e24522e91c44cf41f845c4bcd0e)
- [Book a demo form](https://roundtable.ai/survey/374fd1f3f1719d69b21438cbacd7013d28b7daeb)
- [Data annotation task](https://roundtable.ai/survey/1518e8ae74e9075349b07ffeee8ee21166477e4d)
- [RLHF data collection](https://roundtable.ai/survey/89eeb07064400b58f2d3a3d979b0cff729f1ee2b)
## 🚀 Quick Start
## Installation
### Option 1: npm
1. Install roundtable-js using npm:
```bash
npm install roundtable-js
```
### Option 2: Git
1. Clone the repository:
```
git clone https://github.com/roundtableAI/roundtable-js.git
```
2. Navigate to the project directory:
```
cd roundtable-js
```
3. Include the necessary files in your project.
### Option 3: CDN
1. Include the following script tag in your HTML:
```html
```
## Usage
1. Import the necessary modules in your JavaScript file for npm or Git installations:
```javascript
import Survey from 'roundtable-js/core/survey.js';
import SingleSelect from 'roundtable-js/elements/singleSelect.js';
```
For CDN installation, ensure the script is loaded and use the global `RoundtableJS` object:
```javascript
const { Survey, SingleSelect } = RoundtableJS;
```
2. Create a survey instance and add pages with questions:
```javascript
// Define an asynchronous function to run the survey
async function runSurvey() {
// Create a new Survey instance with a specific participant ID
const survey = new Survey({ participantId: 'participant_123' });
// Define the first question as a single-select question with two options
const question1 = new SingleSelect({
id: 'question1',
text: 'A question',
options: ['Option 1', 'Option 2'],
});
// Define the second question as a single-select question with two options
const question2 = new SingleSelect({
id: 'question2',
text: 'A second question',
options: ['Option 1', 'Option 2'],
});
// Show the first page with the first question and wait for it to be answered
await survey.showPage({ id: 'page1', elements: [question1] });
// This code runs only after the first page is completed
console.log('Page 1 completed');
// Show the next page with the second question and wait for it to be answered
await survey.showPage({ id: 'page2', elements: [question2] });
// Finish the survey once all pages are completed and display an end message
survey.finishSurvey('Thank you for completing the survey!');
}
// Start the survey by calling the runSurvey function
runSurvey();
```
3. Set up your HTML:
```html
Survey
```
## 📚 Documentation
Read our [full documentation](https://docs.roundtable.ai/rjs/introduction).
## 🎉 Community
Join our community:
- [Slack](https://join.slack.com/t/roundtablejs/shared_invite/zt-2m09n74yv-B~UeGbxSzGMTO3f0qXhRxQ)
- [Twitter](https://twitter.com/roundtabledotai)
- [Blog](https://roundtable.ai/blog)
- [LinkedIn](https://www.linkedin.com/company/roundtable-ai)
## 🛠️ Development / Open-Source Community
Please see our [Contributing Guide](CONTRIBUTING.md).
## 📜 License
RoundtableJS is open source software [licensed](LICENSE).
---
================================================
FILE: examples/index.html
================================================
Survey
================================================
FILE: examples/studies/book-a-demo.js
================================================
import Survey from '../../library/core/survey.js';
import TextInput from '../../library/elements/textInput.js';
import HTML from '../../library/elements/HTML.js';
import OpenEnd from '../../library/elements/openEnd.js';
import PageHTML from '../../library/plugins/pageHTML.js';
async function runSurvey() {
const survey = new Survey({
condition: 'test',
participant_id: 'p123',
styles: {
container: {
maxWidth: '650px',
padding: '30px',
paddingTop: '40px',
paddingBottom: '50px',
position: 'relative',
},
button: {
backgroundColor: 'black',
'&:hover': {
backgroundColor: '#333333',
}
}
}
});
const logo = new PageHTML({
id: 'logo',
content: '',
position: 'top',
styles: {
root: {
display: 'block',
margin: '0 auto',
maxWidth: '190px',
marginBottom: '20px'
}
}
});
survey.addPlugin(logo);
const subtitle = new HTML({
id: 'subtitle',
content: '
Please fill out this form and a member of our sales team will contact you.
'
});
const email = new TextInput({
id: 'email',
text: 'Email',
required: true,
placeholder: 'Your email',
});
const name = new TextInput({
id: 'name',
text: 'Name',
required: true,
placeholder: 'Your name',
});
const company = new TextInput({
id: 'company',
text: 'Company',
required: true,
placeholder: 'Your company name',
});
const role = new TextInput({
id: 'role',
text: 'Role',
required: true,
placeholder: 'Your role',
});
const participantVolume = new TextInput({
id: 'participantVolume',
text: 'What is your average participant volume per month?',
required: true,
placeholder: 'Average participant volume',
});
const businessType = new TextInput({
id: 'businessType',
text: 'What % B2B vs B2C?',
required: true,
placeholder: 'Your answer',
});
const hearAboutUs = new TextInput({
id: 'hearAboutUs',
text: 'How did you hear about us?',
required: false,
placeholder: 'Optional',
});
const additionalComments = new OpenEnd({
id: 'additionalComments',
text: 'Additional comments',
required: false,
placeholder: 'Optional',
});
const builtWith = new PageHTML({
id: 'builtWith',
content: '
`);
}
runSurvey();
================================================
FILE: examples/studies/data-annotation.js
================================================
import Survey from '../../library/core/survey.js';
import BoundingBox from '../../library/elements/boundingBox.js';
import ProgressBar from '../../library/plugins/progressBar.js';
// Add images and questions for each page
const imageUrls = ['https://www.usnews.com/object/image/00000168-b98c-d246-a9f9-fddd8bb50000/190204-seattletunnel-editorial.jpg?update-time=1549301335348&size=responsive640',
'https://www.giviexplorer.com/imagesC/11886/576x576xGIVI-Explorer_friends4adventure_Ecuador-cover.jpg'];
async function addBoundingBoxPage(survey, imageUrl, index) {
const boundingBoxQ = new BoundingBox({
id: `bb-q${index}`,
text: `Draw a bounding box around the vehicles in the image below`,
subText: `If there are no vehicles, skip to the next page`,
imageUrl: imageUrl,
});
const id = `q${index}-bb`;
await survey.showPage({ id, elements: [ boundingBoxQ ] });
}
async function runSurvey() {
const survey = new Survey({
participantId: 'test-participant',
condition: 'car-labeling',
});
const progressBar = new ProgressBar({
maxPages: imageUrls.length,
styles: {
bar: {
backgroundColor: 'black'
}
}
});
survey.addPlugin(progressBar);
// Bounding box pages
for (let i = 0; i < imageUrls.length; i++) {
await addBoundingBoxPage(survey, imageUrls[i], i);
}
survey.finishSurvey('Thank you for completing the task!');
}
runSurvey();
================================================
FILE: examples/studies/element-showcase.js
================================================
import Survey from '../../library/core/survey.js';
import BoundingBox from '../../library/elements/boundingBox.js';
import CheckBox from '../../library/elements/checkBox.js';
import TextInput from '../../library/elements/textInput.js';
import DropdownSelect from '../../library/elements/dropdownSelect.js';
import Grid from '../../library/elements/grid.js';
import HTML from '../../library/elements/HTML.js';
import MultiSelect from '../../library/elements/multiSelect.js';
import NumberEntry from '../../library/elements/numberEntry.js';
import NumberScale from '../../library/elements/numberScale.js';
import OpenEnd from '../../library/elements/openEnd.js';
import SingleSelect from '../../library/elements/singleSelect.js';
import ProgressBar from '../../library/plugins/progressBar.js';
import PageHTML from '../../library/plugins/pageHTML.js';
async function runSurvey() {
const survey = new Survey({
title: "Comprehensive Survey Example",
description: "This survey demonstrates all question types and plugins.",
styles: {
body: {
background: '#f9f9f7',
}
}
});
const htmlIntro = new HTML({
id: 'intro',
content: '
Welcome to our element showcase
This survey include examples of every question type and plugin. The code for the survey is available on our GitHub.
',
styles: {
root: {
textAlign: 'center',
}
}
});
const textInput = new TextInput({
id: 'name',
text: 'Name',
required: true,
placeholder: 'Your name',
})
const singleSelect = new SingleSelect({
id: 'favorite-color',
text: 'What is your favorite color?',
subText: 'Select one option',
options: ['Red', 'Blue', 'Green', 'Yellow'],
required: true,
allowOther: true,
});
const multiSelect = new MultiSelect({
id: 'hobbies',
text: 'Which of the following are your hobbies? (Select all that apply)',
options: ['Reading', 'Sports', 'Cooking', 'Gaming', 'Traveling'],
required: true,
minSelect: 1,
maxSelect: 3
});
const dropdownSelect = new DropdownSelect({
id: 'country',
text: 'Select your country of residence',
options: ['United States', 'Canada', 'United Kingdom', 'Australia', 'Germany', 'France', 'Japan', 'Other'],
required: true
});
const checkBox = new CheckBox({
id: 'terms',
text: 'I agree to the terms and conditions',
required: true
});
const numberEntry = new NumberEntry({
id: 'age',
text: 'Please enter your age',
min: 18,
max: 100,
required: true
});
const numberScale = new NumberScale({
id: 'satisfaction',
text: 'How satisfied are you with our service?',
min: 1,
max: 10,
minLabel: 'Not at all satisfied',
maxLabel: 'Extremely satisfied',
required: true
});
const openEnd = new OpenEnd({
id: 'feedback',
text: 'Please provide any additional feedback you may have',
required: false,
maxLength: 500
});
const grid = new Grid({
id: 'feature-rating',
text: 'Please rate the following features of our product',
rows: ['Ease of use', 'Performance', 'Design', 'Customer support'],
columns: ['Poor', 'Fair', 'Good', 'Excellent'],
required: true
});
const boundingBox = new BoundingBox({
id: 'image-selection',
text: 'Please draw a box around the house',
imageUrl: 'https://images.pexels.com/photos/106399/pexels-photo-106399.jpeg',
required: true
});
// Group questions into pages
const page1 = { id: 'page1', elements: [htmlIntro, textInput, singleSelect, multiSelect, dropdownSelect] };
const page2 = { id: 'page2', elements: [checkBox, numberEntry, numberScale, openEnd] };
const page3 = { id: 'page3', elements: [grid, boundingBox] };
const progress = new ProgressBar({ maxPages: 3 });
const logo = new PageHTML({
id: 'logo',
content: '',
position: 'top',
styles:{
root: {
margin: '0 auto',
width: '100%',
maxWidth: '180px',
marginTop: '5px',
marginBottom: '10px'
}
}
});
survey.addPlugin(logo);
survey.addPlugin(progress);
// Show pages sequentially
await survey.showPage(page1);
await survey.showPage(page2);
await survey.showPage(page3);
// Finish the survey
survey.finishSurvey(`
Thank you for completing our comprehensive survey!
Your responses have been recorded and will help us improve our services.
`);
// Log the survey data (in a real scenario, you'd probably send this to a server)
console.log('Survey data:', survey.getAllSurveyData());
}
// Run the survey
runSurvey();
================================================
FILE: examples/studies/enterprise-market-research.js
================================================
import Survey from '../../library/core/survey.js';
import Grid from '../../library/elements/grid.js';
import HTML from '../../library/elements/HTML.js';
import MultiSelect from '../../library/elements/multiSelect.js';
import NumberEntry from '../../library/elements/numberEntry.js';
import OpenEnd from '../../library/elements/openEnd.js';
import SingleSelect from '../../library/elements/singleSelect.js';
import ProgressBar from '../../library/plugins/progressBar.js';
async function runSurvey() {
const survey = new Survey({
condition: 'test',
participant_id: 'p123',
styles: {
body: {
background: '#f0f8ff',
'@media (max-width: 650px)': {
background: 'white',
},
},
container: {
boxShadow: '0 0 10px rgba(0,0,255,0.1)',
'@media (max-width: 650px)': {
boxShadow: 'none',
},
},
button: {
backgroundColor: '#4682b4',
'&:hover': {
backgroundColor: '#5f9ea0',
}
},
question: {
borderBottom: '1px solid #b0d4ff',
paddingBottom: '20px',
'@media (max-width: 650px)': {
borderBottom: 'none',
paddingBottom: '0px',
},
}
}
});
const progressBar = new ProgressBar({
maxPages: 8,
progressAsPercentage: true,
styles: {
bar: {
background: '#4682b4',
}
}
});
survey.addPlugin(progressBar);
const welcome = new HTML({
id: 'welcome',
content: `
Welcome to the Annual Travel Habits Survey
We appreciate your participation in this study.
`
});
await survey.showPage({ id: 'welcome_page', elements: [welcome] });
const q1 = new SingleSelect({
id: 'travel_frequency',
text: 'How often do you travel for business?',
options: ['Never', 'Once a year', '2-3 times a year', '4-6 times a year', 'Monthly', 'Weekly'],
required: true
});
await survey.showPage({ id: 'page1', elements: [q1] });
if (survey.getResponse('travel_frequency') !== 'Never') {
const q2 = new MultiSelect({
id: 'travel_destinations',
text: 'Which regions do you typically travel to for business? (Select all that apply)',
options: ['North America', 'South America', 'Europe', 'Asia', 'Africa', 'Australia'],
required: true
});
await survey.showPage({ id: 'page2', elements: [q2] });
const destinations = survey.getResponse('travel_destinations');
for (const destination of destinations) {
const q_destination = new OpenEnd({
id: `travel_experience_${destination}`,
text: `Please describe your typical business travel experience in ${destination}:`,
minLength: 10,
maxLength: 200,
required: true
});
await survey.showPage({ id: `page_${destination}`, elements: [q_destination] });
}
const q3 = new Grid({
id: 'travel_satisfaction',
text: 'Please rate your satisfaction with the following aspects of your most recent business trip:',
rows: ['Flight', 'Hotel', 'Transportation', 'Food', 'Meeting facilities'],
columns: ['Very Dissatisfied', 'Dissatisfied', 'Neutral', 'Satisfied', 'Very Satisfied'],
required: true
});
await survey.showPage({ id: 'page4', elements: [q3] });
const q4 = new NumberEntry({
id: 'travel_budget',
text: 'What is your average budget per business trip (in USD)?',
min: 0,
max: 1000000,
required: true
});
await survey.showPage({ id: 'page5', elements: [q4] });
const q5 = new OpenEnd({
id: 'travel_improvement',
text: 'What one thing would most improve your business travel experience?',
required: true
});
await survey.showPage({ id: 'page6', elements: [q5] });
}
survey.finishSurvey(`
Thank you for completing our business travel survey!
Your insights will help us improve business travel experiences.
`);
}
runSurvey();
================================================
FILE: examples/studies/llm-rlhf.js
================================================
import Survey from '../../library/core/survey.js';
import OpenEnd from '../../library/elements/openEnd.js';
import HTML from '../../library/elements/HTML.js';
import MultiSelect from '../../library/elements/multiSelect.js';
import SingleSelect from '../../library/elements/singleSelect.js';
import NumberScale from '../../library/elements/numberScale.js';
import ProgressBar from '../../library/plugins/progressBar.js';
function generatePromptResponseHTML(prompt, response) {
return `
Prompt:
${prompt}
Response:
${response}
`;
}
function generatePage(pageNumber, prompt, response) {
const promptResponseHTML = new HTML({
id: `prompt-response-${pageNumber}`,
content: generatePromptResponseHTML(prompt, response)
});
const relevanceQuestion = new SingleSelect({
id: `relevance-${pageNumber}`,
text: 'Is the response relevant for the prompt?',
options: ['Yes', 'No', 'Partially'],
required: true
});
const avoidanceQuestion = new MultiSelect({
id: `avoidance-${pageNumber}`,
text: 'Does the response include anything that should be avoided?',
options: ['Racial slurs', 'Explicit content', 'Misinformation', 'Biased language'],
required: true
});
const qualityQuestion = new NumberScale({
id: `quality-${pageNumber}`,
text: 'Rate the overall quality of the response',
min: 1,
max: 10,
minLabel: 'Poor',
maxLabel: 'Excellent',
required: true
});
const feedbackQuestion = new OpenEnd({
id: `feedback-${pageNumber}`,
text: 'Any additional comments or feedback on the response?',
required: false
});
return {
id: `evaluation-${pageNumber}`,
elements: [promptResponseHTML, relevanceQuestion, avoidanceQuestion, qualityQuestion, feedbackQuestion]
};
}
async function runSurvey() {
const survey = new Survey({
participantId: 'test-participant',
condition: 'llm-evaluation',
styles: {
body: {
background: 'white'
},
container: {
boxShadow: 'none',
},
}
});
const progressBar = new ProgressBar({
maxPages: 2,
styles: {
bar: {
backgroundColor: 'black',
}
}
});
survey.addPlugin(progressBar);
const samplePrompt1 = "What is the population of the United States?";
const sampleResponse1 = "As of 2024, the population of the United States is estimated to be around 335 million people. This figure can fluctuate slightly due to births, deaths, and migration patterns. For the most up-to-date and precise figure, I'd recommend checking the U.S. Census Bureau website, as they provide regular population estimates and projections.";
const samplePrompt2 = "Write a Python function that calculates the factorial of a number.";
const sampleResponse2 = `Here is a Python function that calculates the total factorial of a number:
def factorial(n):
if n == 0 or n == 1:
return 1
else:
return n * factorial(n - 1)
# Example usage
number = 5
result = factorial(number)
print(f"The factorial of {number} is {result}")
`;
await survey.showPage(generatePage(1, samplePrompt1, sampleResponse1));
await survey.showPage(generatePage(2, samplePrompt2, sampleResponse2));
survey.finishSurvey('Thank you for completing the evaluation!');
}
runSurvey();
================================================
FILE: examples/studies/nps-with-branding.js
================================================
import Survey from '../../library/core/survey.js';
import HTML from '../../library/elements/HTML.js';
import NumberScale from '../../library/elements/numberScale.js';
import SingleSelect from '../../library/elements/singleSelect.js';
import PageHTML from '../../library/plugins/pageHTML.js';
async function runSurvey() {
const survey = new Survey({
condition: 'starbucks_nps',
participant_id: 'p123',
styles: {
body: {
color: '#1e3932',
},
container: {
color: '#1e3932',
maxWidth: '600px',
},
button: {
backgroundColor: '#00704A',
color: '#FFFFFF',
transition: 'background-color 0.3s ease',
'&:hover': {
backgroundColor: '#004E33'
}
}
}
});
const logo = new PageHTML({
id: 'starbucks_logo',
content: '',
position: 'top',
styles: {
root: {
marginTop: '10px',
marginBottom: '30px',
}
}
});
survey.addPlugin(logo);
const welcome = new HTML({
id: 'welcome_message',
content: '
Starbucks Customer Feedback
We value your opinion. This short survey will take about 1-2 minutes to complete.
',
styles: {
root: {
textAlign: 'center',
marginBottom: '30px',
}
}
});
const npsQuestion = new NumberScale({
id: 'nps_score',
text: 'How likely are you to recommend Starbucks to a friend or colleague?',
subText: 'Please rate on a scale from 0 (Not at all likely) to 10 (Extremely likely)',
min: 1,
max: 7,
minLabel: 'Not at all likely',
maxLabel: 'Extremely likely',
required: true,
styles: {
subText: {
fontSize: '14px',
fontStyle: 'italic',
marginBottom: '15px',
},
}
});
const experienceQuestion = new SingleSelect({
id: 'experience_rating',
text: 'How would you rate your overall experience with Starbucks?',
options: [
'Excellent',
'Very Good',
'Good',
'Fair',
'Poor'
],
required: true,
styles: {
text:{
marginBottom: '15px',
},
label: {
fontWeight: 'bold',
color: '#00704A'
},
}
});
const thankYou = new PageHTML({
id: 'thank_you_message',
content: '
Thank you for your feedback!
We appreciate your time and input. Your responses will help us improve our services.
',
styles: {
root: {
textAlign: 'center',
marginTop: '30px'
}
}
});
await survey.showPage({ id: 'page1', elements: [welcome, npsQuestion] });
await survey.showPage({ id: 'page2', elements: [experienceQuestion] });
survey.finishSurvey(thankYou.content);
}
runSurvey();
================================================
FILE: examples/studies/product-market-fit.js
================================================
import Survey from '../../library/core/survey.js';
import MultiSelect from '../../library/elements/multiSelect.js';
import NumberScale from '../../library/elements/numberScale.js';
import OpenEnd from '../../library/elements/openEnd.js';
import SingleSelect from '../../library/elements/singleSelect.js';
import PageHTML from '../../library/plugins/pageHTML.js';
async function runSurvey() {
const survey = new Survey();
const logo = new PageHTML({
id: 'logo',
content: '',
position: 'top',
styles: {
root: {
maxWidth: '190px',
margin: '10px auto 30px',
}
}
});
survey.addPlugin(logo);
const q1 = new SingleSelect({
id: 'role',
text: 'What best describes your role?',
options: ['Developer', 'Designer', 'Product Manager', 'Researcher'],
required: true,
allowOther: true,
});
await survey.showPage({ id: 'page1', elements: [q1] });
const q2 = new NumberScale({
id: 'satisfaction',
text: 'How satisfied are you with RoundtableJS?',
min: 1,
max: 10,
minLabel: 'Very Dissatisfied',
maxLabel: 'Very Satisfied',
required: true,
});
await survey.showPage({ id: 'page2', elements: [q2] });
const q3 = new MultiSelect({
id: 'features',
text: 'Which features of RoundtableJS do you find most valuable?',
options: ['Easy to use', 'Customizable', 'Fast performance', 'Good documentation', 'Responsive design'],
minSelected: 1,
maxSelected: 3,
required: true,
});
await survey.showPage({ id: 'page3', elements: [q3] });
const q4 = new OpenEnd({
id: 'improvement',
text: 'What one thing would you improve about RoundtableJS?',
required: true,
});
await survey.showPage({ id: 'page4', elements: [q4] });
const q5 = new SingleSelect({
id: 'recommend',
text: 'How likely are you to recommend RoundtableJS to a colleague?',
options: ['Very likely', 'Likely', 'Neutral', 'Unikely', 'Very unlikely'],
required: true,
});
await survey.showPage({ id: 'page5', elements: [q5] });
survey.finishSurvey("
',
position: 'top',
styles: {
root: {
display: 'block',
margin: '0 auto',
maxWidth: '190px',
marginBottom: '20px'
}
}
});
survey.addPlugin(logo);
const subtitle = new HTML({
id: 'subtitle',
content: '
',
position: 'top',
styles: {
root: {
marginTop: '10px',
marginBottom: '30px',
}
}
});
survey.addPlugin(logo);
const welcome = new HTML({
id: 'welcome_message',
content: '