react-dynamic-var

react-dynamic-var

A React component for content-editable text input with variable autocompletion. It displays variables as {{label}} in the UI and outputs {{id}} in the plain text, with automatic spacing around inserted variables.

Features

• 🚀 Smart autocomplete suggestions when typing {{
• 🎯 Beautiful variable tags with {{label}} display
• 📝 Clean output format with {{id}} for processing
• 🔄 Automatic spacing around variables
• 📦 TypeScript ready with full type definitions
• 🎨 Styled with Tailwind CSS (customizable)
• 🎯 Smart variable replacement and deletion
• ✨ Click variables to edit/replace them

Installation

npm install react-dynamic-var
# or
yarn add react-dynamic-var

Quick Start

import React from 'react';
import { VariableInputBox } from 'react-dynamic-var';

const variables = [
  { id: 1, label: 'name' },
  { id: 2, label: 'email' },
  { id: 3, label: 'phone' },
];

function App() {
  return (
    <VariableInputBox
      variables={variables}
      onChange={(value) => console.log('Editor content:', value)}
      placeholder="Type here with {{variable}}"
      className="custom-class"
    />
  );
}

Props

Prop	Type	Required	Description
variables	Array<{ id: number, label: string }>	Yes	Array of variables for suggestions
onChange	(value: string) => void	No	Callback fired when content changes
defaultValue	string	No	Initial value for the editor. Variables should be in {{id}} format
placeholder	string	No	Placeholder text when editor is empty
className	string	No	Additional CSS classes for the editor

Features

Variable Insertion

• Type {{ to trigger suggestions
• Continue typing to filter variables
• Click or press Enter to insert
• Variables are automatically wrapped with proper spacing

Variable Editing

• Click on any variable tag to edit/replace it
• The suggestion box will show all available variables
• Select a new variable to replace the existing one

Variable Deletion

• Use Backspace to delete variables
• Smart handling of spaces around variables
• Maintains proper formatting

Input/Output Format

• Visual format: Hello {{name}}, your {{email}} is confirmed
• Output format: Hello {{1}}, your {{2}} is confirmed

Styling

With Tailwind CSS

The component is styled with Tailwind CSS classes by default:

• Variable tags use bg-blue-200, text-blue-900, etc.
• Hover effects with hover:bg-blue-300, hover:scale-105
• Smooth transitions with transition-all

Without Tailwind CSS

Add these CSS classes to replicate the default styling:

.variable-input-box [contenteditable] {
  border: 1px solid #d1d5db;
  border-radius: 0.375rem;
  padding: 0.5rem 0.75rem;
  min-height: 40px;
}

.variable-input-box span {
  display: inline-block;
  background-color: #bfdbfe;
  color: #1e3a8a;
  font-weight: 600;
  font-size: 0.875rem;
  padding: 0.25rem 0.625rem;
  border-radius: 0.5rem;
  margin-right: 0.25rem;
  cursor: pointer;
  transition: all 0.2s;
}

.variable-input-box span:hover {
  background-color: #93c5fd;
  transform: scale(1.05);
}

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT © Hossain Azad