npm - @superleapai/flow-ui - Versions diffs - 1.0.0 - Mend

@superleapai/flow-ui 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (40) hide show

package/CHANGELOG.md +65 -0
package/LICENSE +21 -0
package/README.md +451 -0
package/components/alert.js +282 -0
package/components/avatar.js +195 -0
package/components/badge.js +135 -0
package/components/button.js +201 -0
package/components/checkbox.js +254 -0
package/components/currency.js +227 -0
package/components/date-time-picker/date-time-picker-utils.js +253 -0
package/components/date-time-picker/date-time-picker.js +532 -0
package/components/duration/duration-constants.js +46 -0
package/components/duration/duration-utils.js +164 -0
package/components/duration/duration.js +448 -0
package/components/enum-multiselect.js +869 -0
package/components/enum-select.js +831 -0
package/components/enumeration.js +213 -0
package/components/file-input.js +533 -0
package/components/icon.js +200 -0
package/components/input.js +259 -0
package/components/label.js +111 -0
package/components/multiselect.js +351 -0
package/components/phone-input/phone-input.js +392 -0
package/components/phone-input/phone-utils.js +157 -0
package/components/popover.js +240 -0
package/components/radio-group.js +435 -0
package/components/record-multiselect.js +956 -0
package/components/record-select.js +930 -0
package/components/select.js +544 -0
package/components/spinner.js +136 -0
package/components/table.js +335 -0
package/components/textarea.js +114 -0
package/components/time-picker.js +357 -0
package/components/toast.js +343 -0
package/core/flow.js +1729 -0
package/core/superleapClient.js +146 -0
package/dist/output.css +2 -0
package/index.d.ts +458 -0
package/index.js +253 -0
package/package.json +70 -0

package/CHANGELOG.md ADDED Viewed

@@ -0,0 +1,65 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+## [1.0.0] - 2026-02-06
+### Added
+- Initial release of @superleap/superleap-flow
+- Core state management system with `initState`, `getState`, `setState`, `get`, `set`
+- Screen utilities: `createScreen`, `createGrid`, `createFieldWrapper`
+- Form components:
+  - Input (text, email, number, password, tel, url)
+  - Textarea
+  - Select dropdown
+  - Multi-select (count and tags display)
+  - Radio group
+  - Checkbox (with indeterminate state)
+  - Button (multiple variants)
+  - Time picker (12/24 hour)
+  - Date-time picker
+  - Phone input (international)
+  - Currency input
+  - File upload
+  - Record select (SuperLeap integration)
+  - Record multi-select
+  - Enumeration select/multi-select
+- Advanced components:
+  - Data table with selection
+  - Search input
+  - Stepper for multi-step forms
+  - Toast notifications (success, error, warning, info, loading)
+  - Alert messages
+  - Summary/review rows
+  - Badge
+  - Popover
+  - Spinner
+  - Duration picker
+- Comprehensive TypeScript type definitions
+- Tailwind CSS styling with custom configuration
+- Complete documentation and examples
+- MIT License
+### Features
+- Vanilla JavaScript implementation (no framework dependencies)
+- State management with change listeners
+- Component variants (default, error, warning, success, borderless, inline)
+- Size options (small, default, large)
+- Disabled and read-only states
+- Form validation support
+- Accessibility features
+- Responsive design
+- Dark mode compatible
+- SuperLeap client integration
+### Documentation
+- README.md with complete API reference
+- EXAMPLES.md with component examples
+- QUICKSTART.md for getting started
+- TypeScript definitions (index.d.ts)
+- Example HTML files for testing
+[1.0.0]: https://github.com/superleap/superleap-flow/releases/tag/v1.0.0

package/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2026 SuperLeap
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md ADDED Viewed

@@ -0,0 +1,451 @@
+# @superleap/superleap-flow
+A comprehensive, reusable design system for building multi-step forms and UI components with vanilla JavaScript and Tailwind CSS.
+**✨ Clean Architecture:** Only `FlowUI` and `SuperLeap` are exposed to global scope. All components are internal.
+## 📦 Installation
+```bash
+npm install @superleap/superleap-flow
+```
+## 🚀 Quick Start
+### Browser Usage (Single Script Tag)
+```html
+<!DOCTYPE html>
+<html>
+<head>
+  <link rel="stylesheet" href="node_modules/@superleap/superleap-flow/dist/output.css">
+</head>
+<body>
+  <div id="app"></div>
+  <!-- Single script tag - includes SuperLeap SDK and all components -->
+  <script src="node_modules/@superleap/superleap-flow/index.js"></script>
+  <script>
+    // Wait for library to be ready
+    document.addEventListener('superleap-flow:ready', function() {
+      // Initialize SuperLeap SDK (optional, for Record Select)
+      SuperLeap.init({
+        // apiKey: 'YOUR_API_KEY'
+      });
+      // Initialize state
+      FlowUI.initState({ name: '', email: '' });
+      // Create UI
+      const app = document.getElementById('app');
+      const screen = FlowUI.createScreen('Welcome', 'Please enter your details');
+      const grid = FlowUI.createGrid();
+      grid.appendChild(FlowUI.createInput({
+        label: 'Name',
+        fieldId: 'name',
+        placeholder: 'Enter your name',
+        required: true
+      }));
+      grid.appendChild(FlowUI.createInput({
+        label: 'Email',
+        fieldId: 'email',
+        type: 'email',
+        required: true
+      }));
+      const submitBtn = FlowUI.createButton({
+        variant: 'primary',
+        text: 'Submit',
+        onClick: () => {
+          const data = FlowUI.getState();
+          console.log(data);
+          FlowUI.showToast('Form submitted!', 'success');
+        }
+      });
+      screen.appendChild(grid);
+      screen.appendChild(submitBtn);
+      app.appendChild(screen);
+    });
+  </script>
+</body>
+</html>
+```
+### ES Module Usage
+```javascript
+import { FlowUI, SuperLeap } from '@superleap/superleap-flow';
+// Initialize SuperLeap SDK
+SuperLeap.init({ apiKey: 'YOUR_KEY' });
+// Initialize state
+FlowUI.initState({ name: '', email: '' });
+// Create components
+const nameInput = FlowUI.createInput({
+  label: 'Name',
+  fieldId: 'name',
+  required: true
+});
+```
+### CommonJS Usage
+```javascript
+const { FlowUI, SuperLeap } = require('@superleap/superleap-flow');
+SuperLeap.init({ apiKey: 'YOUR_KEY' });
+FlowUI.initState({ name: '' });
+```
+## 🎯 What's Exposed
+```javascript
+// Only 2 objects in global scope
+window.FlowUI    // ✅ UI Framework with all components
+window.SuperLeap // ✅ SDK Client for API integration
+// All components are internal (not global)
+window.Toast     // ❌ Not available
+window.Button    // ❌ Not available
+window.Alert     // ❌ Not available
+// ... 20+ components kept internal
+```
+## ✨ Features
+- 🎨 **Complete Design System** - Pre-built components matching modern UI standards
+- 📝 **Form Components** - Input, Select, Textarea, Checkbox, Radio, and more
+- 📅 **Date & Time** - Date picker, time picker, and date-time picker
+- 💰 **Specialized Inputs** - Currency, phone number, file upload
+- 🔄 **State Management** - Built-in reactive state management
+- 🎯 **Multi-step Forms** - Stepper component for wizard-style forms
+- 📊 **Data Tables** - Sortable, searchable tables
+- 🎨 **Customizable** - Tailwind CSS for easy styling
+- 📱 **Responsive** - Mobile-first design
+- ✨ **Clean Architecture** - Only FlowUI and SuperLeap exposed globally
+- 📦 **Single Script** - One file includes everything (SDK + components)
+- 🚀 **Zero Dependencies** - Pure vanilla JavaScript
+## 📚 API Reference
+### FlowUI API
+#### State Management
+```javascript
+// Initialize state
+FlowUI.initState(initialState, onChangeCallback)
+// Get entire state
+const state = FlowUI.getState()
+// Update state
+FlowUI.setState({ name: 'John' })
+// Get single value
+const name = FlowUI.get('name')
+// Set single value
+FlowUI.set('name', 'John')
+```
+#### Layout Components
+```javascript
+// Create screen wrapper
+FlowUI.createScreen(title, description)
+// Create form grid
+FlowUI.createGrid()
+// Create field wrapper
+FlowUI.createFieldWrapper(label, required, helpText)
+```
+#### Form Components
+```javascript
+// Text input
+FlowUI.createInput({
+  label: 'Name',
+  fieldId: 'name',
+  placeholder: 'Enter name',
+  required: true,
+  type: 'text', // text, email, password, number, tel, url
+  variant: 'default', // default, error, warning, success, borderless, inline
+  inputSize: 'default', // default, large, small
+  disabled: false,
+  helpText: 'Your full name'
+})
+// Textarea
+FlowUI.createTextarea({
+  label: 'Comments',
+  fieldId: 'comments',
+  placeholder: 'Enter comments',
+  required: false
+})
+// Select dropdown
+FlowUI.createSelect({
+  label: 'Role',
+  fieldId: 'role',
+  options: [
+    { value: 'admin', label: 'Administrator' },
+    { value: 'user', label: 'User' }
+  ],
+  required: true,
+  onChange: (value) => console.log(value)
+})
+// Multi-select
+FlowUI.createMultiSelect({
+  label: 'Tags',
+  fieldId: 'tags',
+  options: [...],
+  placeholder: 'Select tags',
+  type: 'default', // default (count) or tags (show tags)
+  onChange: (values) => console.log(values)
+})
+// Radio group
+FlowUI.createRadioGroup({
+  label: 'Plan',
+  fieldId: 'plan',
+  options: [...],
+  onChange: (value) => console.log(value)
+})
+// Checkbox
+FlowUI.createCheckbox({
+  label: 'I accept terms',
+  fieldId: 'acceptTerms',
+  size: 'default', // default, small, large
+  align: 'left', // left, right
+  onChange: (checked) => console.log(checked)
+})
+// Time picker
+FlowUI.createTimePicker({
+  label: 'Time',
+  fieldId: 'time',
+  use24Hour: false, // false = 12-hour AM/PM, true = 24-hour
+  onChange: (value) => console.log(value)
+})
+// Date-time picker
+FlowUI.createDateTimePicker({
+  label: 'Date & Time',
+  fieldId: 'datetime',
+  granularity: 'minute', // day, hour, minute, second
+  hourCycle: 12, // 12 or 24
+  onChange: (date) => console.log(date)
+})
+// Currency input
+FlowUI.createCurrency({
+  label: 'Amount',
+  fieldId: 'amount',
+  column: {
+    properties: {
+      currency: { currency: 'USD' }
+    }
+  },
+  onChange: (value) => console.log(value)
+})
+// Phone input
+FlowUI.createPhoneInput({
+  label: 'Phone',
+  fieldId: 'phone',
+  defaultCountryCode: 'IN',
+  onChange: (fullValue, country) => console.log(fullValue, country)
+})
+// File upload
+FlowUI.createFileUpload({
+  label: 'Attachments',
+  fieldId: 'files',
+  multiple: true,
+  accept: '.pdf,.jpg,.png'
+})
+// Record select (requires SuperLeap SDK)
+FlowUI.createRecordSelect({
+  label: 'Account',
+  fieldId: 'account',
+  objectSlug: 'account',
+  placeholder: 'Select account',
+  onChange: (value, record) => console.log(value, record)
+})
+```
+#### UI Components
+```javascript
+// Button
+FlowUI.createButton({
+  variant: 'primary', // primary, outline, ghost, link, etc.
+  size: 'default', // small, default, large
+  text: 'Submit',
+  icon: '<svg>...</svg>',
+  iconPosition: 'left', // left, right
+  loading: false,
+  disabled: false,
+  onClick: (event) => console.log('Clicked')
+})
+// Toast notification
+FlowUI.showToast(message, type, duration)
+// type: success, error, warning, info, loading
+// duration: milliseconds (0 for persistent)
+// Example:
+FlowUI.showToast('Success!', 'success', 3000)
+const loadingToast = FlowUI.showToast('Loading...', 'loading', 0)
+loadingToast.close() // Close manually
+```
+#### Table Components
+```javascript
+// Data table
+FlowUI.createDataTable({
+  columns: [
+    { key: 'name', label: 'Name' },
+    { key: 'email', label: 'Email' }
+  ],
+  data: [...],
+  fieldId: 'selectedRow',
+  idKey: 'id',
+  onSelect: (row) => console.log(row)
+})
+// Search input
+FlowUI.createSearchInput({
+  placeholder: 'Search...',
+  fieldId: 'search',
+  onSearch: (query) => console.log(query)
+})
+```
+#### Stepper
+```javascript
+FlowUI.renderStepper(
+  container,
+  [
+    { id: 'step1', label: 'Step 1' },
+    { id: 'step2', label: 'Step 2' },
+    { id: 'step3', label: 'Step 3' }
+  ],
+  'step1' // current step
+)
+```
+#### Summary
+```javascript
+FlowUI.createSummaryRow(label, value)
+```
+#### Alerts
+```javascript
+FlowUI.renderAlerts(container, messages, type)
+// type: error, info, success
+```
+#### Advanced: Direct Component Access
+```javascript
+// Get internal component reference (advanced use)
+const Toast = FlowUI._getComponent('Toast')
+const Button = FlowUI._getComponent('Button')
+// Use directly
+Toast.success('Hello!')
+Button.create({ text: 'Click me' })
+```
+### SuperLeap API
+```javascript
+// Initialize SDK
+SuperLeap.init({
+  apiKey: 'YOUR_API_KEY',
+  baseUrl: 'https://app.superleap.com/api/v1'
+})
+// Get SDK instance
+const sdk = SuperLeap.getSdk()
+// Check availability
+if (SuperLeap.isAvailable()) {
+  // SDK is ready
+}
+// Get default config
+const config = SuperLeap.getDefaultConfig()
+```
+## 🎨 Component Variants
+### Input/Select Variants
+- `default` - Standard appearance
+- `error` - Red border for errors
+- `warning` - Orange border for warnings
+- `success` - Green border for success
+- `borderless` - No border
+- `inline` - Inline style
+### Button Variants
+- `primary` - Primary action button
+- `outline` - Outlined button
+- `ghost` - Ghost/transparent button
+- `link` - Link-styled button
+- `primaryDestructive` - Destructive primary
+- `outlineDestructive` - Destructive outline
+- `ghostDestructive` - Destructive ghost
+### Sizes
+- `small` - Small size
+- `default` - Default size
+- `large` - Large size
+## 📖 Examples
+See `example.html` for a comprehensive demonstration of all components.
+## 🔧 TypeScript Support
+Full TypeScript definitions included:
+```typescript
+import { FlowUI, SuperLeap, SuperLeapConfig } from '@superleap/superleap-flow';
+const config: SuperLeapConfig = {
+  apiKey: 'YOUR_KEY'
+};
+SuperLeap.init(config);
+FlowUI.initState({ name: '' });
+```
+## 📄 License
+MIT
+## 🤝 Contributing
+See CONTRIBUTING.md for contribution guidelines.
+## 📝 Changelog
+See CHANGELOG.md for version history.