@mieweb/forms-editor 1.0.0 → 1.0.2

package/README.md

@@ -1,46 +1,14 @@
 # @mieweb/forms-editor
 
-Embeddable questionnaire editor with FHIR export and conditional logic.
+Visual questionnaire builder with three editing modes: Build, Code, and Preview.
 
-## 🎨 Version 1.0 - UI/UX Refinement
-
-The editor now features a complete visual overhaul with modern blue theme:
-- All field components use consistent blue color palette
-- Enhanced focus states and hover interactions
-- Improved field selection and editing experience
-- Better visual hierarchy with updated FieldWrapper
-- Mobile-responsive with polished interactions
-
-See the [main CHANGELOG](../../CHANGELOG.md) for complete details.
+## Installation
 
 ```bash
-npm install @mieweb/forms-editor react react-dom
+npm install @mieweb/forms-editor
 ```
 
-## 🆕 New Features
-
-### YAML & JSON Import
-Import questionnaires from YAML or JSON with automatic format detection:
-- Drag and drop `.json`, `.yaml`, or `.yml` files
-- Auto-detects MIE Forms vs SurveyJS schemas
-- Preserves metadata (title, description, etc.)
-
-### Auto-Parsing on Initialization
-Pass YAML strings, JSON strings, or objects directly:
-```jsx
-// YAML string
-const yamlData = `
-schemaType: mieforms-v1.0
-fields:
-  - id: name
-    fieldType: text
-    question: Name?
-`;
-
-<QuestionnaireEditor initialFormData={yamlData} />
-
-// Or JSON string, or parsed object - all work!
-```
+**Requirements:** React 18+ and React DOM 18+
 
 ## Quick Start
 
@@ -50,13 +18,7 @@ import { QuestionnaireEditor } from '@mieweb/forms-editor';
 function App() {
   const [formData, setFormData] = React.useState({
     schemaType: 'mieforms-v1.0',
-    title: 'Patient Intake',
-    fields: [
-      { id: 'section-1', fieldType: 'section', title: 'Section 1', fields: [] },
-      { id: 'name', fieldType: 'text', question: 'Your Name', required: true },
-      { id: 'gender', fieldType: 'radio', question: 'Gender', 
-        options: [{ value: 'Male' }, { value: 'Female' }], selected: null },
-    ]
+    fields: []
   });
 
   return (
@@ -68,91 +30,17 @@ function App() {
 }
 ```
 
-## Props
-
-- `initialFormData` - Form data object or YAML/JSON string (supports auto-parsing)
-- `schemaType` - Optional: `'mieforms'` or `'surveyjs'` (auto-detected if not provided)
-- `onChange` - Callback when form data changes (receives complete form object with metadata)
-- `startInPreview` - Start in preview mode (default: false)
-- `hideUnsupportedFields` - Hide unsupported field types (default: false)
-- `showHeader` - Show editor header (default: true)
-- `className` - Additional CSS classes
-
-## 🔄 Breaking Changes (v0.1.1)
+## Documentation
 
-### Prop Rename
-```jsx
-// ❌ Before
-<QuestionnaireEditor initialFields={fields} />
+**[Full Documentation](<link>/docs/editor/overview)**
 
-// ✅ After
-<QuestionnaireEditor initialFormData={formData} />
-```
+For detailed information, see:
+- [Quick Start Guide](<link>/docs/getting-started/quickstart-editor)
+- [Props Reference](<link>/docs/editor/props)
+- [Editor Modes](<link>/docs/editor/modes)
+- [Field Editing](<link>/docs/editor/field-editing)
+- [Import/Export](<link>/docs/editor/importing)
 
-### onChange Callback
-Now receives complete form data object instead of just fields array:
-```jsx
-// ❌ Before
-onChange={(fields) => console.log(fields)}
+## License
 
-// ✅ After
-onChange={(formData) => {
-  console.log(formData);
-  // { schemaType: 'mieforms-v1.0', title: '...', fields: [...] }
-}}
-```
-
-### Schema Type Required
-Form data must include `schemaType` field:
-```jsx
-const formData = {
-  schemaType: 'mieforms-v1.0', // Required!
-  fields: [...]
-};
-```
-
-## Features
-
-### Field Types
-- `text` - Single-line text input
-- `longtext` - Multi-line text area
-- `multitext` - Multiple labeled text inputs
-- `boolean` - Yes/No button selection
-- `radio` - Radio buttons
-- `check` - Checkboxes
-- `dropdown` - Dropdown selection
-- `section` - Field container
-- `unsupported` - Placeholder (can be hidden with `hideUnsupportedFields` prop)
-
-### Conditional Logic
-Show/hide fields based on answers via the Logic panel.
-
-### Import/Export
-- JSON, YAML formats with auto-detection
-- SurveyJS schema import with conversion report
-- FHIR export (via forms-engine)
-
-### Mobile Support
-Responsive with swipeable modal editing.
-
-## Field Structure
-
-```javascript
-{
-  id: 'unique-id',
-  fieldType: 'text', // 'longtext', 'multitext', 'boolean', 'radio', 'check', 'dropdown', 'section'
-  question: 'What is your name?',
-  answer: '',
-  required: false,
-  enableWhen: {
-    logic: 'AND', // or 'OR'
-    conditions: [
-      {
-        targetId: 'other-field-id',
-        operator: 'equals', // 'contains', 'includes'
-        value: 'expected-value'
-      }
-    ]
-  }
-}
-```
+MIT