@cratis/scene.primereact 4.23.0 → 4.24.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cratis/scene.primereact",
-    "version": "4.23.0",
+    "version": "4.24.0",
     "description": "The PrimeReact component package: maps Scene's abstract component names onto real PrimeReact components, and PrimeReact's free themes onto Scene themes.",
     "keywords": [
         "cratis",
@@ -59,15 +59,15 @@
         "build-storybook": "storybook build"
     },
     "dependencies": {
-        "@cratis/scene.engine": "4.23.0",
-        "@cratis/scene.model": "4.23.0",
-        "@cratis/scene.react": "4.23.0",
+        "@cratis/scene.engine": "4.24.0",
+        "@cratis/scene.model": "4.24.0",
+        "@cratis/scene.react": "4.24.0",
         "@primeuix/themes": "^3.0.1"
     },
     "devDependencies": {
-        "@cratis/scene.engine": "4.23.0",
-        "@cratis/scene.model": "4.23.0",
-        "@cratis/scene.react": "4.23.0",
+        "@cratis/scene.engine": "4.24.0",
+        "@cratis/scene.model": "4.24.0",
+        "@cratis/scene.react": "4.24.0",
         "@primereact/core": "11.2.0",
         "@primereact/headless": "11.2.0",
         "@primereact/types": "11.2.0",

package/primeReactComponentMetadata.ts

@@ -0,0 +1,98 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { ComponentCategory } from '@cratis/scene.model';
+import { ComponentMetadata, componentMetadata as m, toolbarDesignMode } from '@cratis/scene.react';
+
+/** The category, icon, keywords and picker badge of every component of the package (CMP1), keyed by bare component name. */
+export const primeReactComponentMetadata: Record<string, ComponentMetadata> = {
+    inputText: m('Text field', ComponentCategory.Input, 'text-cursor-input', ['text', 'input', 'string']),
+    inputTextarea: m('Text area', ComponentCategory.Input, 'text-align-start', ['multiline', 'text', 'notes']),
+    inputNumber: m('Number field', ComponentCategory.Input, 'hash', ['number', 'numeric', 'integer']),
+    password: m('Password', ComponentCategory.Input, 'key-round', ['secret', 'credentials', 'login']),
+    floatLabel: m('Float label', ComponentCategory.Input, 'tag', ['label', 'field', 'floating']),
+    iconField: m('Icon field', ComponentCategory.Input, 'face-slightly-smiling', ['icon', 'input', 'adornment']),
+    dropdown: m('Dropdown', ComponentCategory.Input, 'chevrons-up-down', ['select', 'choice', 'combo']),
+    multiSelect: m('Multi-select', ComponentCategory.Input, 'list-checks', ['multiple', 'select', 'choices']),
+    listBox: m('List box', ComponentCategory.Input, 'list', ['list', 'select', 'options']),
+    selectButton: m('Select button', ComponentCategory.Input, 'toggle-left', ['segmented', 'choice', 'toggle']),
+    checkbox: m('Checkbox', ComponentCategory.Input, 'square-check', ['boolean', 'tick', 'toggle']),
+    multiStateCheckbox: m('Multi-state checkbox', ComponentCategory.Input, 'square-minus', ['tri-state', 'checkbox', 'states']),
+    radioButton: m('Radio button', ComponentCategory.Input, 'circle-dot', ['radio', 'option']),
+    toggleSwitch: m('Toggle switch', ComponentCategory.Input, 'toggle-right', ['switch', 'boolean', 'on off']),
+    slider: m('Slider', ComponentCategory.Input, 'sliders-horizontal', ['range', 'value']),
+    rating: m('Rating', ComponentCategory.Input, 'star', ['stars', 'score', 'review']),
+    knob: m('Knob', ComponentCategory.Input, 'gauge', ['dial', 'value', 'range']),
+    calendar: m('Date picker', ComponentCategory.Input, 'calendar', ['date', 'calendar', 'time']),
+    colorPicker: m('Color picker', ComponentCategory.Input, 'palette', ['colour', 'swatch', 'hex']),
+    chips: m('Tag input', ComponentCategory.Input, 'tags', ['tags', 'chips', 'keywords'], 'Tg'),
+    autoComplete: m('Lookup', ComponentCategory.Input, 'search', ['autocomplete', 'suggest', 'search', 'combo']),
+    treeSelect: m('Tree select', ComponentCategory.Input, 'list-tree', ['hierarchy', 'select', 'tree']),
+    editor: m('Rich text editor', ComponentCategory.Input, 'pencil-line', ['wysiwyg', 'html', 'text']),
+    fileUpload: m('File upload', ComponentCategory.Input, 'upload', ['attachment', 'file', 'import']),
+    button: m('Button', ComponentCategory.Actions, 'mouse-pointer-click', ['click', 'submit', 'action'], 'Bt'),
+    splitButton: m('Split button', ComponentCategory.Actions, 'square-chevron-down', ['menu button', 'dropdown button', 'actions']),
+    speedDial: m('Speed dial', ComponentCategory.Actions, 'zap', ['floating', 'fab', 'actions']),
+    buttonGroup: m('Button group', ComponentCategory.Actions, 'group', ['buttons', 'segmented']),
+    dataTable: m('Data table', ComponentCategory.DataDisplay, 'table', ['grid', 'list', 'rows', 'table'], 'Tb'),
+    table: m('Table', ComponentCategory.DataDisplay, 'table-2', ['grid', 'rows', 'list'], 'Tb'),
+    column: m('Table column', ComponentCategory.DataDisplay, 'columns-3', ['heading', 'field']),
+    dataView: m('Data view', ComponentCategory.DataDisplay, 'layout-list', ['list', 'cards', 'grid', 'items']),
+    dataScroller: m('Data scroller', ComponentCategory.DataDisplay, 'scroll-text', ['infinite', 'lazy', 'list']),
+    tree: m('Tree', ComponentCategory.DataDisplay, 'list-tree', ['hierarchy', 'nodes', 'outline']),
+    treeTable: m('Tree table', ComponentCategory.DataDisplay, 'table-properties', ['hierarchy', 'grid', 'nodes']),
+    timeline: m('Timeline', ComponentCategory.DataDisplay, 'git-commit-vertical', ['history', 'events', 'activity', 'schedule'], 'Tl'),
+    paginator: m('Paginator', ComponentCategory.Navigation, 'chevrons-left-right', ['pages', 'paging', 'pagination']),
+    orderList: m('Order list', ComponentCategory.Input, 'arrow-up-down', ['reorder', 'sort', 'sequence']),
+    pickList: m('Pick list', ComponentCategory.Input, 'arrow-left-right', ['transfer', 'move', 'dual list']),
+    organizationChart: m('Organization chart', ComponentCategory.DataDisplay, 'network', ['org chart', 'hierarchy', 'tree']),
+    chart: m('Chart', ComponentCategory.DataDisplay, 'chart-column', ['graph', 'bar', 'line', 'pie', 'plot'], 'Ch'),
+    card: m('Card', ComponentCategory.Layout, 'square', ['panel', 'box', 'container']),
+    panel: m('Panel', ComponentCategory.Layout, 'panel-top', ['box', 'container', 'group']),
+    accordion: m('Accordion', ComponentCategory.Layout, 'chevrons-up-down', ['collapsible', 'expand', 'sections']),
+    fieldset: m('Fieldset', ComponentCategory.Forms, 'square-dashed', ['legend', 'group', 'field group']),
+    divider: m('Divider', ComponentCategory.Layout, 'separator-horizontal', ['separator', 'rule', 'line']),
+    splitter: m('Split pane', ComponentCategory.Layout, 'columns-2', ['splitter', 'resize', 'panes']),
+    scrollPanel: m('Scroll panel', ComponentCategory.Layout, 'scroll', ['scroll', 'overflow', 'container']),
+    tabView: m('Tabs', ComponentCategory.Navigation, 'folder', ['tab view', 'tabs', 'sections'], 'Tb'),
+    toolbar: m('Toolbar', ComponentCategory.Actions, 'wrench', ['actions', 'buttons', 'command bar'], 'Tl', toolbarDesignMode()),
+    stepper: m('Stepper', ComponentCategory.Navigation, 'footprints', ['wizard', 'steps', 'progress']),
+    dialog: m('Dialog', ComponentCategory.Overlay, 'app-window', ['modal', 'popup', 'window']),
+    confirmDialog: m('Confirm dialog', ComponentCategory.Overlay, 'circle-question-mark', ['confirm', 'yes no', 'modal']),
+    overlayPanel: m('Popover', ComponentCategory.Overlay, 'message-square', ['overlay', 'popup', 'panel']),
+    sidebar: m('Side sheet', ComponentCategory.Overlay, 'panel-right', ['drawer', 'sidebar', 'sheet']),
+    tooltip: m('Tooltip', ComponentCategory.Overlay, 'message-square', ['hint', 'hover', 'help']),
+    menu: m('Menu', ComponentCategory.Actions, 'menu', ['list', 'actions', 'options']),
+    menubar: m('Menu bar', ComponentCategory.Navigation, 'menu', ['top menu', 'navigation', 'bar']),
+    breadcrumb: m('Breadcrumbs', ComponentCategory.Navigation, 'chevron-right', ['trail', 'path', 'navigation']),
+    tabMenu: m('Tab menu', ComponentCategory.Navigation, 'folder', ['tabs', 'navigation', 'menu']),
+    steps: m('Steps', ComponentCategory.Navigation, 'list-ordered', ['wizard', 'stepper', 'progress']),
+    tieredMenu: m('Tiered menu', ComponentCategory.Actions, 'list-tree', ['nested', 'submenu', 'menu']),
+    panelMenu: m('Panel menu', ComponentCategory.Navigation, 'panel-left', ['accordion menu', 'sidebar menu', 'navigation']),
+    contextMenu: m('Context menu', ComponentCategory.Actions, 'mouse-pointer-2', ['right click', 'menu', 'actions']),
+    megaMenu: m('Mega menu', ComponentCategory.Navigation, 'layout-grid', ['large menu', 'navigation', 'columns']),
+    dock: m('Dock', ComponentCategory.Navigation, 'dock', ['launcher', 'taskbar', 'icons']),
+    message: m('Message', ComponentCategory.Feedback, 'message-square-warning', ['alert', 'notice', 'banner']),
+    inlineMessage: m('Inline message', ComponentCategory.Feedback, 'info', ['alert', 'hint', 'notice']),
+    toast: m('Toast', ComponentCategory.Feedback, 'bell', ['notification', 'snackbar', 'alert']),
+    image: m('Image', ComponentCategory.DataDisplay, 'image', ['picture', 'photo', 'media']),
+    galleria: m('Gallery', ComponentCategory.DataDisplay, 'images', ['photos', 'slideshow', 'images']),
+    carousel: m('Carousel', ComponentCategory.DataDisplay, 'gallery-horizontal', ['slides', 'slider', 'rotator']),
+    avatar: m('Avatar', ComponentCategory.DataDisplay, 'circle-user', ['user', 'profile', 'picture']),
+    badge: m('Badge', ComponentCategory.DataDisplay, 'badge', ['count', 'indicator', 'label']),
+    chip: m('Chip', ComponentCategory.DataDisplay, 'tag', ['tag', 'label', 'token']),
+    tag: m('Tag', ComponentCategory.DataDisplay, 'tag', ['label', 'status', 'chip']),
+    progressBar: m('Progress bar', ComponentCategory.Feedback, 'loader', ['progress', 'percent', 'loading']),
+    progressSpinner: m('Progress spinner', ComponentCategory.Feedback, 'loader-circle', ['spinner', 'loading', 'busy']),
+    skeleton: m('Skeleton', ComponentCategory.Feedback, 'rectangle-ellipsis', ['placeholder', 'loading', 'shimmer']),
+    scrollTop: m('Scroll to top', ComponentCategory.Navigation, 'arrow-up-to-line', ['back to top', 'scroll']),
+    blockUI: m('Block UI', ComponentCategory.Feedback, 'lock', ['mask', 'busy', 'overlay']),
+    inplace: m('In-place editor', ComponentCategory.Input, 'pencil', ['inline edit', 'click to edit']),
+    terminal: m('Terminal', ComponentCategory.DataDisplay, 'terminal', ['console', 'command line', 'shell']),
+    text: m('Text', ComponentCategory.DataDisplay, 'type', ['label', 'paragraph', 'copy']),
+    title: m('Title', ComponentCategory.DataDisplay, 'heading', ['heading', 'header', 'caption']),
+    field: m('Summary field', ComponentCategory.DataDisplay, 'tag', ['label', 'value', 'pair']),
+    section: m('Section', ComponentCategory.Layout, 'layout-panel-top', ['group', 'area', 'block']),
+    summary: m('Summary', ComponentCategory.DataDisplay, 'list', ['details', 'overview', 'facts']),
+    action: m('Command action', ComponentCategory.Actions, 'zap', ['command', 'invoke', 'submit']),
+};

package/primeReactDescriptors.ts

@@ -2,13 +2,14 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 import { BindingSourceKind, ComponentDescriptor, PropertyDescriptor, PropertyEditorKind, PropertyValueType } from '@cratis/scene.model';
-import { componentRegistryKey } from '@cratis/scene.react';
+import { componentRegistryKey, describeComponents } from '@cratis/scene.react';
 import { chartTypeChoices } from './chart/chartTypeChoices';
 import { legacyEnumerationChoices } from './legacyEnumerationChoices';
 import { ChartType } from './chart';
 import { TreeTableSelectionMode } from './data';
 import { FileUploadMode } from './file';
 import { primeReactInputDescriptors } from './inputDescriptors';
+import { primeReactComponentMetadata } from './primeReactComponentMetadata';
 
 const key = (name: string) => componentRegistryKey('PrimeReact', name);
 
@@ -89,7 +90,7 @@ function treeNode(depth: number): PropertyDescriptor[] {
 }
 
 /** Design-time descriptors for PrimeReact controls whose authored data has structured configuration. */
-export const primeReactDescriptors: ComponentDescriptor[] = [
+const describedPrimeReact: ComponentDescriptor[] = [
     ...primeReactInputDescriptors,
     {
         component: key('chart'),
@@ -193,3 +194,6 @@ export const primeReactDescriptors: ComponentDescriptor[] = [
         ],
     },
 ];
+
+/** The `PrimeReact` descriptors: the hand-written ones above with every component's category, icon, keywords and design mode (CMP1). */
+export const primeReactDescriptors: ComponentDescriptor[] = describeComponents('PrimeReact', describedPrimeReact, primeReactComponentMetadata);