@object-ui/plugin-list 0.5.0

package/.turbo/turbo-build.log

@@ -0,0 +1,18 @@
+
+> @object-ui/plugin-list@0.5.0 build /home/runner/work/objectui/objectui/packages/plugin-list
+> vite build
+
+vite v7.3.1 building client environment for production...
+transforming...
+✓ 3553 modules transformed.
+rendering chunks...
+
+[vite:dts] Start generate declaration files...
+computing gzip size...
+[vite:dts] Declaration files built in 21552ms.
+
+dist/plugin-list.css    108.36 kB │ gzip:  17.59 kB
+dist/index.js         1,717.24 kB │ gzip: 403.86 kB
+dist/plugin-list.css    108.36 kB │ gzip:  17.59 kB
+dist/index.umd.cjs    1,239.32 kB │ gzip: 342.97 kB
+✓ built in 1m 6s

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 ObjectQL
+
+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

@@ -0,0 +1,127 @@
+# @object-ui/plugin-list
+
+ListView plugin for ObjectUI - A unified view component with view type switching, filtering, sorting, and view configuration persistence.
+
+## Features
+
+- **View Type Switching**: Switch between Grid, List, Kanban, Calendar, and Chart views
+- **View Persistence**: Automatically saves user's view preference
+- **Integrated Search**: Full-text search across records
+- **Filtering**: Advanced filter UI (expandable filter panel)
+- **Sorting**: Sort by any field, toggle ascending/descending
+- **Flexible Configuration**: Configure available view types per object
+- **Custom Templates**: Support for custom view options per view type
+
+## Installation
+
+```bash
+pnpm add @object-ui/plugin-list
+```
+
+## Usage
+
+### Basic Example
+
+```tsx
+import { ListView } from '@object-ui/plugin-list';
+
+function ContactsView() {
+  return (
+    <ListView
+      schema={{
+        type: 'list-view',
+        objectName: 'contacts',
+        viewType: 'grid',
+        fields: ['name', 'email', 'phone', 'company'],
+        sort: [{ field: 'name', order: 'asc' }],
+      }}
+    />
+  );
+}
+```
+
+### With Multiple View Types
+
+```tsx
+<ListView
+  schema={{
+    type: 'list-view',
+    objectName: 'deals',
+    viewType: 'kanban',
+    fields: ['name', 'amount', 'stage', 'close_date'],
+    options: {
+      kanban: {
+        groupField: 'stage',
+        titleField: 'name',
+      },
+      calendar: {
+        startDateField: 'close_date',
+        titleField: 'name',
+      },
+      chart: {
+        chartType: 'bar',
+        xAxisField: 'stage',
+        yAxisFields: ['amount'],
+      }
+    }
+  }}
+/>
+```
+
+### With Callbacks
+
+```tsx
+<ListView
+  schema={{
+    type: 'list-view',
+    objectName: 'tasks',
+    fields: ['title', 'status', 'priority'],
+  }}
+  onViewChange={(view) => console.log('View changed to:', view)}
+  onSearchChange={(search) => console.log('Search:', search)}
+  onSortChange={(sort) => console.log('Sort:', sort)}
+  onFilterChange={(filters) => console.log('Filters:', filters)}
+/>
+```
+
+## Schema
+
+The ListView component accepts a `ListViewSchema`:
+
+```typescript
+interface ListViewSchema {
+  type: 'list-view';
+  objectName: string;
+  viewType?: 'grid' | 'kanban' | 'calendar' | 'gantt' | 'map' | 'chart';
+  fields?: string[];
+  filters?: Array<any[] | string>;
+  sort?: Array<{ field: string; order: 'asc' | 'desc' }>;
+  options?: {
+    grid?: Record<string, any>;
+    list?: Record<string, any>;
+    kanban?: {
+      groupField: string;
+      titleField?: string;
+      cardFields?: string[];
+    };
+    calendar?: {
+      startDateField: string;
+      endDateField?: string;
+      titleField: string;
+    };
+    chart?: {
+      chartType: 'bar' | 'line' | 'pie' | 'area';
+      xAxisField: string;
+      yAxisFields: string[];
+    };
+  };
+}
+```
+
+## View Persistence
+
+The ListView automatically persists the user's view type preference in localStorage using the key `listview-{objectName}-view`.
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './src/index'
+export {}