# @design.estate/dees-catalog A comprehensive web components library built with TypeScript and LitElement, providing **75+ UI components** for building modern web applications with consistent design and behavior. 🚀 [![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-blue.svg)](https://www.typescriptlang.org/) [![LitElement](https://img.shields.io/badge/LitElement-4.0+-orange.svg)](https://lit.dev/) ## Issue Reporting and Security For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly. ## ✨ Features - 🎨 **Consistent Design System** - Beautiful, cohesive components following modern UI/UX principles - 🌙 **Dark/Light Theme Support** - All components automatically adapt to your theme - ⌨️ **Keyboard Accessible** - Full keyboard navigation and ARIA support - 📱 **Responsive** - Mobile-first design that works across all screen sizes - 🔧 **TypeScript-First** - Fully typed APIs with excellent IDE support - 🧩 **Modular** - Use only what you need, tree-shakeable architecture ## 📦 Installation ```bash npm install @design.estate/dees-catalog # or pnpm add @design.estate/dees-catalog ``` ## 🚀 Quick Start ```typescript import { html, DeesElement, customElement } from '@design.estate/dees-element'; import '@design.estate/dees-catalog'; @customElement('my-app') class MyApp extends DeesElement { render() { return html` alert('Hello!')}> Click me! `; } } ``` ## 📖 Development Guide For developers working on this library, please refer to the [UI Components Playbook](readme.playbook.md) for comprehensive patterns, best practices, and architectural guidelines. ## 📚 Components Overview | Category | Components | |----------|------------| | **Core UI** | [`DeesButton`](#deesbutton), [`DeesButtonExit`](#deesbuttonexit), [`DeesButtonGroup`](#deesbuttongroup), [`DeesBadge`](#deesbadge), [`DeesChips`](#deeschips), [`DeesHeading`](#deesheading), [`DeesHint`](#deeshint), [`DeesIcon`](#deesicon), [`DeesLabel`](#deeslabel), [`DeesPanel`](#deespanel), [`DeesSearchbar`](#deessearchbar), [`DeesSpinner`](#deesspinner), [`DeesToast`](#deestoast), [`DeesWindowcontrols`](#deeswindowcontrols) | | **Forms** | [`DeesForm`](#deesform), [`DeesInputText`](#deesinputtext), [`DeesInputCheckbox`](#deesinputcheckbox), [`DeesInputDropdown`](#deesinputdropdown), [`DeesInputRadiogroup`](#deesinputradiogroup), [`DeesInputFileupload`](#deesinputfileupload), [`DeesInputIban`](#deesinputiban), [`DeesInputPhone`](#deesinputphone), [`DeesInputQuantitySelector`](#deesinputquantityselector), [`DeesInputMultitoggle`](#deesinputmultitoggle), [`DeesInputTags`](#deesinputtags), [`DeesInputTypelist`](#deesinputtypelist), [`DeesInputRichtext`](#deesinputrichtext), [`DeesInputWysiwyg`](#deesinputwysiwyg), [`DeesInputDatepicker`](#deesinputdatepicker), [`DeesInputSearchselect`](#deesinputsearchselect), [`DeesFormSubmit`](#deesformsubmit) | | **Layout** | [`DeesAppui`](#deesappui), [`DeesAppuiMainmenu`](#deesappuimainmenu), [`DeesAppuiSecondarymenu`](#deesappuisecondarymenu), [`DeesAppuiMaincontent`](#deesappuimaincontent), [`DeesAppuiAppbar`](#deesappuiappbar), [`DeesAppuiActivitylog`](#deesappuiactivitylog), [`DeesAppuiProfiledropdown`](#deesappuiprofiledropdown), [`DeesAppuiTabs`](#deesappuitabs), [`DeesMobileNavigation`](#deesmobilenavigation), [`DeesDashboardGrid`](#deesdashboardgrid) | | **Data Display** | [`DeesTable`](#deestable), [`DeesDataviewCodebox`](#deesdataviewcodebox), [`DeesDataviewStatusobject`](#deesdataviewstatusobject), [`DeesPdf`](#deespdf), [`DeesStatsGrid`](#deesstatsgrid), [`DeesPagination`](#deespagination) | | **Visualization** | [`DeesChartArea`](#deeschartarea), [`DeesChartLog`](#deeschartlog) | | **Dialogs & Overlays** | [`DeesModal`](#deesmodal), [`DeesContextmenu`](#deescontextmenu), [`DeesSpeechbubble`](#deesspeechbubble), [`DeesWindowlayer`](#deeswindowlayer) | | **Navigation** | [`DeesStepper`](#deesstepper), [`DeesProgressbar`](#deesprogressbar) | | **Development** | [`DeesEditor`](#deeseditor), [`DeesEditorMarkdown`](#deeseditormarkdown), [`DeesEditorMarkdownoutlet`](#deeseditormarkdownoutlet), [`DeesTerminal`](#deesterminal), [`DeesUpdater`](#deesupdater) | | **Auth & Utilities** | [`DeesSimpleAppdash`](#deessimpleappdash), [`DeesSimpleLogin`](#deessimplelogin) | | **Shopping** | [`DeesShoppingProductcard`](#deesshoppingproductcard) | --- ## 🎯 Detailed Component Documentation ### Core UI Components #### `DeesButton` A versatile button component supporting multiple styles and states. ```typescript // Basic usage const button = document.createElement('dees-button'); button.text = 'Click me'; // With options Click me ``` #### `DeesBadge` Display status indicators or counts with customizable styles. ```typescript ``` #### `DeesChips` Interactive chips/tags with selection capabilities. ```typescript ``` #### `DeesIcon` Display icons from FontAwesome and Lucide icon libraries with library prefixes. ```typescript // FontAwesome icons - use 'fa:' prefix // Lucide icons - use 'lucide:' prefix // Legacy API (deprecated but still supported) ``` #### `DeesLabel` Text label component with optional icon and status indicators. ```typescript ``` #### `DeesSpinner` Loading indicator with customizable appearance. ```typescript ``` #### `DeesToast` Notification toast messages with various styles, positions, and auto-dismiss functionality. ```typescript // Programmatic usage DeesToast.show({ message: 'Operation successful', type: 'success', // Options: info, success, warning, error duration: 3000, // Time in milliseconds before auto-dismiss position: 'top-right' // Options: top-right, top-left, bottom-right, bottom-left, top-center, bottom-center }); // Convenience methods DeesToast.info('Information message'); DeesToast.success('Success message'); DeesToast.warning('Warning message'); DeesToast.error('Error message'); // Advanced control const toast = await DeesToast.show({ message: 'Processing...', type: 'info', duration: 0 // No auto-dismiss }); // Later dismiss programmatically toast.dismiss(); ``` **Key Features:** - Multiple toast types with distinct icons and colors - 6 position options for flexible placement - Auto-dismiss with visual progress indicator - Manual dismiss by clicking - Smooth animations and transitions - Automatic stacking of multiple toasts - Theme-aware styling - Programmatic control #### `DeesButtonExit` Exit/close button component with consistent styling. ```typescript ``` #### `DeesButtonGroup` Container for grouping related buttons together. ```typescript ``` #### `DeesHeading` Consistent heading component with level and styling options. ```typescript ``` #### `DeesHint` Hint/tooltip component for providing contextual help. ```typescript ``` #### `DeesPanel` Container component for grouping related content with optional title and actions. ```typescript ``` #### `DeesSearchbar` Search input component with suggestions and search handling. ```typescript ``` #### `DeesWindowcontrols` Window control buttons (minimize, maximize, close) for desktop-like applications. ```typescript ``` --- ### Form Components #### `DeesForm` Container component for form elements with built-in validation and data handling. ```typescript handleFormData(e.detail)} // Emitted when form is submitted @formValidation=${(e) => handleValidation(e.detail)} // Emitted during validation > Submit ``` #### `DeesInputText` Text input field with validation and formatting options. ```typescript ``` #### `DeesInputCheckbox` Checkbox input component for boolean values. ```typescript ``` #### `DeesInputDropdown` Dropdown selection component with search and filtering capabilities. ```typescript ``` #### `DeesInputFileupload` File upload component with drag-and-drop support. ```typescript ``` #### `DeesInputIban` Specialized input for IBAN (International Bank Account Number) with validation. ```typescript ``` #### `DeesInputPhone` Phone number input with country code selection and formatting. ```typescript ``` #### `DeesInputQuantitySelector` Numeric input with increment/decrement controls. ```typescript ``` #### `DeesInputMultitoggle` Multi-state toggle button group. ```typescript ``` #### `DeesInputRadiogroup` Radio button group for single-choice selections with internal state management. ```typescript // With custom option objects ``` #### `DeesInputTags` Tag input component for managing lists of tags with auto-complete and validation. ```typescript ``` **Key Features:** - Add tags by pressing Enter or typing comma/semicolon - Remove tags with click or backspace - Auto-complete suggestions with keyboard navigation - Maximum tag limit support - Full theme support - Form validation integration #### `DeesInputTypelist` Dynamic list input for managing arrays of typed values. ```typescript ``` #### `DeesInputDatepicker` Date and time picker component with calendar interface and manual typing support. ```typescript ``` **Key Features:** - Interactive calendar popup - Manual date typing with multiple formats - Optional time selection - Configurable date format - Min/max date constraints - Disable specific dates - Keyboard navigation - Today button - Clear functionality - 12/24 hour time formats - Theme-aware styling - Live parsing and validation **Manual Input Formats:** ```typescript // Date formats supported "2023-12-20" // ISO format (YYYY-MM-DD) "20.12.2023" // European format (DD.MM.YYYY) "12/20/2023" // US format (MM/DD/YYYY) // Date with time (add space and time after any date format) "2023-12-20 14:30" "20.12.2023 9:45" "12/20/2023 16:00" ``` #### `DeesInputSearchselect` Search-enabled dropdown selection component. ```typescript ``` #### `DeesInputRichtext` Rich text editor with formatting toolbar powered by TipTap. ```typescript ``` **Key Features:** - Full formatting toolbar (bold, italic, underline, strike, etc.) - Heading levels (H1-H6) - Lists (bullet, ordered) - Links with URL editing - Code blocks and inline code - Blockquotes - Horizontal rules - Undo/redo support - Word and character count - HTML output #### `DeesInputWysiwyg` Advanced block-based editor with slash commands and rich content blocks. ```typescript ``` **Key Features:** - Slash commands for quick formatting - Block-based editing (paragraphs, headings, lists, etc.) - Drag and drop block reordering - Multiple output formats - Keyboard shortcuts - Collaborative editing ready - Extensible block types #### `DeesFormSubmit` Submit button component specifically designed for `DeesForm`. ```typescript Submit Form ``` --- ### Layout Components #### `DeesAppui` A comprehensive application shell component providing a complete UI framework with navigation, menus, activity logging, and view management. > **Full API Documentation**: See [ts_web/elements/00group-appui/dees-appui/readme.md](./ts_web/elements/00group-appui/dees-appui/readme.md) for complete documentation including all programmatic APIs, view lifecycle hooks, and TypeScript interfaces. **Quick Start:** ```typescript import { html, DeesElement, customElement } from '@design.estate/dees-element'; import { DeesAppui } from '@design.estate/dees-catalog'; @customElement('my-app') class MyApp extends DeesElement { private appui: DeesAppui; async firstUpdated() { this.appui = this.shadowRoot.querySelector('dees-appui'); // Configure with views and menu this.appui.configure({ branding: { logoIcon: 'lucide:box', logoText: 'My App' }, views: [ { id: 'dashboard', name: 'Dashboard', iconName: 'lucide:home', content: 'my-dashboard' }, { id: 'settings', name: 'Settings', iconName: 'lucide:settings', content: 'my-settings' }, ], mainMenu: { sections: [{ name: 'Main', views: ['dashboard', 'settings'] }] }, defaultView: 'dashboard' }); } render() { return html``; } } ``` **Key Features:** - **Configure API**: Single `configure()` method for complete app setup - **View Management**: Automatic view caching, lazy loading, and lifecycle hooks - **Programmatic APIs**: Full control over AppBar, Main Menu, Secondary Menu, Content Tabs, and Activity Log - **View Lifecycle Hooks**: `onActivate()`, `onDeactivate()`, and `canDeactivate()` for view components - **Hash-based Routing**: Automatic URL synchronization with view navigation - **RxJS Observables**: `viewChanged$` and `viewLifecycle$` for reactive programming - **TypeScript-first**: Typed `IViewActivationContext` passed to views on activation **Programmatic APIs include:** - `navigateToView(viewId, params?)` - Navigate between views - `setAppBarMenus()`, `setBreadcrumbs()`, `setUser()` - Control the app bar - `setMainMenu()`, `setMainMenuSelection()`, `setMainMenuBadge()` - Control main navigation - `setMainMenuCollapsed()`, `setMainMenuVisible()` - Control main menu visibility - `setSecondaryMenu()`, `setSecondaryMenuCollapsed()`, `setSecondaryMenuVisible()` - Control secondary menu - `setContentTabs()`, `setContentTabsVisible()` - Control view-specific UI - `activityLog.add()`, `activityLog.addMany()`, `activityLog.clear()` - Manage activity entries **View Visibility Control:** ```typescript // In your view's onActivate hook onActivate(context: IViewActivationContext) { // Hide secondary menu for a fullscreen view context.appui.setSecondaryMenuVisible(false); // Hide content tabs context.appui.setContentTabsVisible(false); // Collapse main menu to give more space context.appui.setMainMenuCollapsed(true); } ``` #### `DeesAppuiMainmenu` Main navigation menu component for application-wide navigation. ```typescript navigate('dashboard') }, { key: 'settings', iconName: 'lucide:settings', action: () => navigate('settings') } ] } ]} collapsed // Optional: show collapsed version > ``` #### `DeesAppuiSecondarymenu` Secondary navigation component for sub-section selection with collapsible groups and badges. ```typescript select('frontend'), badge: 3, badgeVariant: 'warning' }, { key: 'API Server', iconName: 'lucide:server', action: () => select('api') } ] } ]} @item-select=${handleSectionChange} > ``` #### `DeesAppuiMaincontent` Main content area with tab management support. ```typescript selectTab('overview') }, { key: 'Details', iconName: 'lucide:info', action: () => selectTab('details') } ]} @tab-select=${handleTabChange} > ``` #### `DeesAppuiAppbar` Professional application bar component with hierarchical menus, breadcrumb navigation, and user account management. ```typescript {}, // No-op for parent menu items submenu: [ { name: 'New File', shortcut: 'Cmd+N', iconName: 'file-plus', action: async () => handleNewFile() }, { name: 'Open...', shortcut: 'Cmd+O', iconName: 'folder-open', action: async () => handleOpen() }, { divider: true }, // Menu separator { name: 'Save', shortcut: 'Cmd+S', iconName: 'save', action: async () => handleSave(), disabled: true // Disabled state } ] } ]} .breadcrumbs=${'Project > src > components'} .showWindowControls=${true} .showSearch=${true} .user=${{ name: 'John Doe', avatar: '/path/to/avatar.jpg', status: 'online' // Options: 'online' | 'offline' | 'busy' | 'away' }} @menu-select=${(e) => handleMenuSelect(e.detail.item)} @breadcrumb-navigate=${(e) => handleBreadcrumbClick(e.detail)} > ``` **Key Features:** - **Hierarchical Menu System** - Top-level menus with dropdown submenus, icons, and keyboard shortcuts - **Keyboard Navigation** - Full keyboard support (Tab, Arrow keys, Enter, Escape) - **Breadcrumb Navigation** - Customizable breadcrumb trail with click events - **User Account Section** - Avatar with status indicator - **Accessibility** - Full ARIA support with menubar roles #### `DeesAppuiTabs` Reusable tab component with horizontal/vertical layout support. ```typescript console.log('Home') }, { key: 'Settings', iconName: 'lucide:settings', action: () => console.log('Settings') } ]} tabStyle="horizontal" // Options: horizontal, vertical showTabIndicator={true} @tab-select=${handleTabSelect} > ``` --- ### Data Display Components #### `DeesTable` Advanced table component with sorting, filtering, and action support. ```typescript ({ name: item.name, date: item.date, amount: item.amount, description: item.description })} .dataActions=${[ { name: 'Edit', icon: 'edit', action: (item) => handleEdit(item) }, { name: 'Delete', icon: 'trash', action: (item) => handleDelete(item) } ]} heading1="Transactions" heading2="Recent Activity" searchable // Enable search functionality dataName="transaction" // Name for single data item @selection-change=${handleSelectionChange} > ``` **Advanced Features:** - Schema-first columns or `displayFunction` rendering - Sorting via header clicks with `aria-sort` + `sortChange` - Global search with Lucene-like syntax; modes: `table`, `data`, `server` - Per-column quick filters row; `showColumnFilters` and `column.filterable=false` - Selection: `none` | `single` | `multi`, with select-all and `selectionChange` - Sticky header + internal scroll (`stickyHeader`, `--table-max-height`) - Rich actions: header/in-row/contextmenu/footer/doubleClick; pinned Actions column - Editable cells via `editableFields` - Drag & drop files onto rows #### `DeesDataviewCodebox` Code display component with syntax highlighting and line numbers. ```typescript { return html\`
Hello World
\`; }; `} >
``` #### `DeesDataviewStatusobject` Status display component for complex objects with nested status indicators. ```typescript ``` #### `DeesPdf` PDF viewer component with navigation and zoom controls. ```typescript ``` #### `DeesStatsGrid` A responsive grid component for displaying statistical data with various visualization types. ```typescript ``` #### `DeesPagination` Pagination component for navigating through large datasets. ```typescript ``` --- ### Visualization Components #### `DeesChartArea` Area chart component built on ApexCharts for visualizing time-series data. ```typescript ``` #### `DeesChartLog` Specialized chart component for visualizing log data and events. ```typescript ``` --- ### Dialogs & Overlays Components #### `DeesModal` Modal dialog component with customizable content and actions. ```typescript // Programmatic usage DeesModal.createAndShow({ heading: 'Confirm Action', content: html` `, menuOptions: [ { name: 'Cancel', action: async (modal) => { modal.destroy(); return null; } }, { name: 'Confirm', action: async (modal) => { /* handle */ modal.destroy(); return null; } } ] }); ``` #### `DeesContextmenu` Context menu component for right-click actions. ```typescript handleEdit() }, { label: 'Delete', icon: 'trash', action: () => handleDelete() } ]} position="right" > ``` #### `DeesSpeechbubble` Tooltip-style speech bubble component for contextual information. ```typescript // Programmatic usage const bubble = await DeesSpeechbubble.createAndShow( referenceElement, 'Helpful information about this feature' ); ``` #### `DeesWindowlayer` Base overlay component used by modal dialogs and other overlay components. ```typescript const layer = await DeesWindowLayer.createAndShow({ blur: true, }); ``` --- ### Navigation Components #### `DeesStepper` Multi-step navigation component for guided user flows. ```typescript Form 1` }, { key: 'address', label: 'Address', content: html`
Form 2
` }, { key: 'confirm', label: 'Confirmation', content: html`
Review
` } ]} currentStep="personal" @step-change=${handleStepChange} @complete=${handleComplete} >
``` #### `DeesProgressbar` Progress indicator component for tracking completion status. ```typescript ``` --- ### Development Components #### `DeesEditor` Code editor component with syntax highlighting and code completion, powered by Monaco Editor. ```typescript ``` #### `DeesEditorMarkdown` Markdown editor component with live preview. ```typescript ``` #### `DeesEditorMarkdownoutlet` Markdown preview component for rendering markdown content. ```typescript ``` #### `DeesTerminal` Terminal emulator component for command-line interface. ```typescript `Echo: ${args.join(' ')}`, 'help': () => 'Available commands: echo, help' }} .prompt=${'$'} .welcomeMessage=${'Welcome! Type "help" for available commands.'} > ``` #### `DeesUpdater` Component for managing application updates and version control. ```typescript ``` --- ### Auth & Utilities Components #### `DeesSimpleAppdash` Simple application dashboard component for quick prototyping. ```typescript ``` #### `DeesSimpleLogin` Simple login form component with validation and customization. ```typescript ``` --- ### Shopping Components #### `DeesShoppingProductcard` Product card component for e-commerce applications. ```typescript ``` --- ## 🔧 TypeScript Interfaces The library exports unified interfaces for consistent API patterns: ```typescript // Base menu item interface (used by tabs, menus, etc.) interface IMenuItem { key: string; iconName?: string; action: () => void; badge?: string | number; badgeVariant?: 'default' | 'success' | 'warning' | 'error'; } // Menu group interface for organized menus interface IMenuGroup { name: string; items: IMenuItem[]; collapsed?: boolean; iconName?: string; } ``` --- ## License and Legal Information This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./LICENSE) file. **Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file. ### Trademarks This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar. ### Company Information Task Venture Capital GmbH Registered at District Court Bremen HRB 35230 HB, Germany For any legal inquiries or further information, please contact us via email at hello@task.vc. By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.