@emporix/cockpit-component-library 1.0.0 → 1.0.1

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 (2) hide show
  1. package/README.md +249 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -64,6 +64,37 @@ If the above methods don't work, copy the CSS file from `node_modules/@emporix/c
64
64
 
65
65
  ## Components
66
66
 
67
+ Current exported components:
68
+
69
+ - `PrimaryButton`
70
+ - `SecondaryButton`
71
+ - `TertiaryButton`
72
+ - `ContrastButton`
73
+ - `Tabs`
74
+ - `RichTextEditor`
75
+ - `Spinner`
76
+ - `Breadcrumb`
77
+ - `Dropdown`
78
+ - `MultiSelect`
79
+ - `InputText`
80
+ - `SelectButton`
81
+ - `Card`
82
+ - `IconCard`
83
+ - `FileUploadDropzone`
84
+ - `Chip`
85
+ - `AlertBox`
86
+ - `SideMenu`
87
+ - `TopNav`
88
+ - `Toast` (plus `ToastProvider` and `useToast`)
89
+ - `Modal`
90
+ - `ConfirmDialog`
91
+ - `ProductTable`
92
+ - `ProductTableIconAddButton`
93
+ - `OrderTable`
94
+ - `OrderStatusTag`
95
+ - `Wizard`
96
+ - `Timeline`
97
+
67
98
  ### PrimaryButton
68
99
 
69
100
  A simple, focused button component for primary actions.
@@ -325,6 +356,224 @@ const tabs: TabItem[] = [
325
356
  | label | string | Display label for the tab |
326
357
  | content | ReactNode | Content to display when active |
327
358
 
359
+ ### SecondaryButton
360
+
361
+ Secondary action button variant with API similar to `PrimaryButton`.
362
+
363
+ ```tsx
364
+ import { SecondaryButton } from '@emporix/cockpit-component-library'
365
+
366
+ <SecondaryButton label="Cancel" />
367
+ ```
368
+
369
+ ### TertiaryButton
370
+
371
+ Low-emphasis button for tertiary actions.
372
+
373
+ ```tsx
374
+ import { TertiaryButton } from '@emporix/cockpit-component-library'
375
+
376
+ <TertiaryButton label="Learn more" />
377
+ ```
378
+
379
+ ### ContrastButton
380
+
381
+ Button variant designed for high-contrast contexts.
382
+
383
+ ```tsx
384
+ import { ContrastButton } from '@emporix/cockpit-component-library'
385
+
386
+ <ContrastButton label="Open" />
387
+ ```
388
+
389
+ ### Dropdown
390
+
391
+ Single-select dropdown component with optional filtering, editable mode, and templating.
392
+
393
+ ```tsx
394
+ import { Dropdown } from '@emporix/cockpit-component-library'
395
+
396
+ <Dropdown options={options} value={value} onChange={(e) => setValue(e.value)} />
397
+ ```
398
+
399
+ ### MultiSelect
400
+
401
+ Multi-value selection component for choosing multiple options from a list.
402
+
403
+ ```tsx
404
+ import { MultiSelect } from '@emporix/cockpit-component-library'
405
+
406
+ <MultiSelect options={options} value={value} onChange={(e) => setValue(e.value)} />
407
+ ```
408
+
409
+ ### RichTextEditor
410
+
411
+ Rich text input component for formatted content editing.
412
+
413
+ ```tsx
414
+ import { RichTextEditor } from '@emporix/cockpit-component-library'
415
+
416
+ <RichTextEditor value={value} onChange={setValue} />
417
+ ```
418
+
419
+ ### Spinner
420
+
421
+ Loading indicator component with configurable size.
422
+
423
+ ```tsx
424
+ import { Spinner } from '@emporix/cockpit-component-library'
425
+
426
+ <Spinner size="md" />
427
+ ```
428
+
429
+ ### Breadcrumb
430
+
431
+ Navigation breadcrumb for representing hierarchical page location.
432
+
433
+ ```tsx
434
+ import { Breadcrumb } from '@emporix/cockpit-component-library'
435
+
436
+ <Breadcrumb items={items} />
437
+ ```
438
+
439
+ ### IconCard
440
+
441
+ Card-like container with a prominent icon/content layout.
442
+
443
+ ```tsx
444
+ import { IconCard } from '@emporix/cockpit-component-library'
445
+
446
+ <IconCard title="Title" description="Description" icon={<span />} />
447
+ ```
448
+
449
+ ### FileUploadDropzone
450
+
451
+ Dropzone component for drag-and-drop file uploads with type constraints.
452
+
453
+ ```tsx
454
+ import { FileUploadDropzone } from '@emporix/cockpit-component-library'
455
+
456
+ <FileUploadDropzone acceptedTypes={['image']} onFilesSelected={handleFiles} />
457
+ ```
458
+
459
+ ### AlertBox
460
+
461
+ Inline alert component for success, info, warning, and error messages.
462
+
463
+ ```tsx
464
+ import { AlertBox } from '@emporix/cockpit-component-library'
465
+
466
+ <AlertBox variant="info" title="Heads up" />
467
+ ```
468
+
469
+ ### SideMenu
470
+
471
+ Composable side navigation menu with brand, nav items, and footer slots.
472
+
473
+ ```tsx
474
+ import { SideMenu } from '@emporix/cockpit-component-library'
475
+
476
+ <SideMenu>{/* ... */}</SideMenu>
477
+ ```
478
+
479
+ ### TopNav
480
+
481
+ Top navigation/header component for page-level actions and context.
482
+
483
+ ```tsx
484
+ import { TopNav } from '@emporix/cockpit-component-library'
485
+
486
+ <TopNav title="Dashboard" />
487
+ ```
488
+
489
+ ### Toast
490
+
491
+ Toast notification primitives: `Toast`, `ToastProvider`, and `useToast`.
492
+
493
+ ```tsx
494
+ import { ToastProvider, useToast } from '@emporix/cockpit-component-library'
495
+ ```
496
+
497
+ ### Modal
498
+
499
+ Dialog modal component for focused workflows and confirmations.
500
+
501
+ ```tsx
502
+ import { Modal } from '@emporix/cockpit-component-library'
503
+
504
+ <Modal isOpen={open} onClose={onClose} title="Edit item" />
505
+ ```
506
+
507
+ ### ConfirmDialog
508
+
509
+ Preset confirmation dialog for destructive or high-impact actions.
510
+
511
+ ```tsx
512
+ import { ConfirmDialog } from '@emporix/cockpit-component-library'
513
+
514
+ <ConfirmDialog open={open} onConfirm={onConfirm} onCancel={onCancel} />
515
+ ```
516
+
517
+ ### ProductTable
518
+
519
+ Data table component focused on product records and common actions.
520
+
521
+ ```tsx
522
+ import { ProductTable } from '@emporix/cockpit-component-library'
523
+
524
+ <ProductTable items={items} columns={columns} />
525
+ ```
526
+
527
+ ### ProductTableIconAddButton
528
+
529
+ Compact icon button variant used with `ProductTable` add flows.
530
+
531
+ ```tsx
532
+ import { ProductTableIconAddButton } from '@emporix/cockpit-component-library'
533
+
534
+ <ProductTableIconAddButton onClick={onAdd} />
535
+ ```
536
+
537
+ ### OrderTable
538
+
539
+ Data table for order rows and order-oriented workflows.
540
+
541
+ ```tsx
542
+ import { OrderTable } from '@emporix/cockpit-component-library'
543
+
544
+ <OrderTable rows={rows} />
545
+ ```
546
+
547
+ ### OrderStatusTag
548
+
549
+ Status badge component for order state presentation.
550
+
551
+ ```tsx
552
+ import { OrderStatusTag } from '@emporix/cockpit-component-library'
553
+
554
+ <OrderStatusTag status="submitted" />
555
+ ```
556
+
557
+ ### Wizard
558
+
559
+ Step-based workflow component for multi-stage forms and processes.
560
+
561
+ ```tsx
562
+ import { Wizard } from '@emporix/cockpit-component-library'
563
+
564
+ <Wizard steps={steps} />
565
+ ```
566
+
567
+ ### Timeline
568
+
569
+ Chronological event list component for activity/history views.
570
+
571
+ ```tsx
572
+ import { Timeline } from '@emporix/cockpit-component-library'
573
+
574
+ <Timeline events={events} />
575
+ ```
576
+
328
577
  ## Theming with CSS Variables
329
578
 
330
579
  The component library uses CSS variables for easy theming. You can customize the appearance by overriding these variables:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emporix/cockpit-component-library",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "A React component library for cockipt projects",
5
5
  "type": "module",
6
6
  "main": "./dist/index.umd.js",