Skip to content

tutim-io/tutim

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

76 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

πŸ“ README

Tutim.io logo

Wizard Form infrastructure for product teams

Headless forms module to create web-app powerful forms in minutes.

MIT License Number of GitHub stars Discord is Live Docs are updated Product Hunt


πŸ“ Why Tutim?

Building forms in apps is complicated.

At first, it seems like just throwing a few input fields, but in reality, it's just the beginning.

Tutim gives you your own in-house form builder that's fully integrated with your component library and design system. Everybody on your team can create, edit, and publish forms and surveys in your app regardless of their technical background.

This repo is 100% free, and will always remain.

✨ Features

  • 🌈 Headless: Default design system that can be replaced with yours
  • πŸ’… Rich form: Save draft, wizard, conditional branching, and more are available out-of-the-box
  • πŸš€ Performant: Best practices are implemented. Never worry about delays
  • πŸ› οΈ No-Code Builder: Let PMs and designers create and change forms. Stick with React for styling and embedding
  • πŸ‘¨β€πŸ’» Built-in Analytics: Opening rate, drop-offs, conversions. privacy-first (coming soon)
  • πŸ“¦ Templates: Onboarding, personal details, feedback from our gallery(coming soon)

πŸš€ Getting Started

Explore the docs Β»

Sandbox Example Β»

Admin Portal & Builder Β»

Create your first form in 2 minutes, by following these steps:

1. Install tutim React package:

yarn add @tutim/headless @tutim/fields @tutim/types
npm install @tutim/headless @tutim/fields @tutim/types

2. Create your first form schema with Tutim Form Builder, or by creating the form JSON schema yourself

3. Render the form:

import { TutimWizard, defaultFields } from '@tutim/fields'; import { FormProvider } from '@tutim/headless'; const config = { // Use https://tutim.io to create and manage rich schemas with no-code fields: [ { key: 'firstName', label: 'First Name', type: 'text' }, { key: 'lastName', label: 'Last Name', type: 'text' }, ], }; const App = () => { return ( <div className="App"> <FormProvider fieldComponents={defaultFields}> <TutimWizard onSubmit={console.log} config={config} /> </FormProvider> </div> ); }; export default App;

4. Output Example:

Form output example

BYOF - Bring Your Own Field. Use Field type to register any type of field. Can be used on FormProvider level for global inputs or withing FieldConfig for local use cases

CustomField is a component that allows you to define custom form fields that can be used in your react application. You can use it to render any type of form field that you want, based on the type specified in the field configuration.

CustomField can be used either globally, by specifying it in the fieldComponents object passed to the FormProvider component, or locally, by specifying the Field prop in the field configuration when creating a form.

import { Field, FieldConfig } from '@tutim/types'; export const CustomField: Field = ({ inputProps, fieldConfig }) => { const { value, onChange } = inputProps; const onClick = () => onChange(value + 2); return ( <button type="button" onClick={onClick}> {fieldConfig.label}: {value} </button> ); }; export const customFieldConfig: FieldConfig = { key: 'clicker', label: 'Click Me', type: 'custom', defaultValue: 0, Field: CustomField, };

FormProvider is a component that allows you to define the form fields that you want to use in your react application. It provides a way to specify the field components that will be used to render the form fields, and allows you to use either the default field components provided by the @tutim/fields library, or your own custom field components.

import { FormProvider } from '@tutim/headless'; import { defaultFields, TutimWizard } from '@tutim/fields'; import { Field, FieldComponents, InputType } from '@tutim/types'; export const CustomField: Field = ({ inputProps, fieldConfig }) => { const { value, onChange } = inputProps; const onClick = () => onChange(value + 2); return ( <button type="button" onClick={onClick}> {fieldConfig.label}: {value} </button> ); }; const fieldComponents: FieldComponents = { ...defaultFields, // optional built in input fields based on MUI [InputType.Text]: ({ inputProps }) => <input {...inputProps} />, 'custom-field': (fieldProps) => <CustomField {...fieldProps} />, // add any type of input and reference it by 'type' }; const App = (): JSX.Element => { return ( <div className="App"> <FormProvider fieldComponents={fieldComponents}> <TutimWizard onSubmit={console.log} config={{ fields: [{ key: 'field1' }] }} /> </FormProvider> </div> ); }; export default App;

πŸ“œ Forms

Tutim provides all forms solutions. Through code or drag & drop interface.

πŸ’Œ Inputs

  • All basic (Text, Select, Checkbox, Date...)
  • Array & Multi fields
  • Object and deep object support
  • Rich input library (coming soon)

πŸ“ž Design & Layout

  • Simple form layout (one pager)
  • Layout and grouping control
  • Wizard multi steps (coming soon)
  • DnD rich builder

😊 Portal

  • Generative builder (build wizard from text with AI)
  • Simple form builder
  • Conditional branching
  • Drag & Drop form builder
  • Templates library

☁️ Cloud (closed beta, request early access)

  • Manage and serve schemas
  • Hosted forms
  • Backend support
  • 3rd Party integrations

🀡 Need Help?

We are more than happy to help you.

If you are getting any errors, facing problems, or need a new feature while working on this project -

Open an issue or join our Discord server and ask for help.

πŸ”— Links

πŸ’ͺ By the community, for the community

Powered by Tutim.io