@bryntum/schedulerpro-vue-3-thin 7.1.1 → 7.1.2

package/README.md

@@ -1,53 +1,294 @@
-# Vue 3 wrapper for Bryntum Scheduler Pro
+<div style="display: flex; justify-content: space-between; align-items: center; margin: 0 50px;">
+    <a href="https://bryntum.com/" rel="noopener" target="_blank">
+        <img width="350" src="https://bryntum.com/resources/bryntum_logo_blue.svg" alt="Bryntum logo">
+    </a>
+    <img src="https://bryntum.com/products/grid/docs/data/Core/images/logo/vue.svg" alt="Vue" width="100">
+</div>
 
-This package contains a wrapper that encapsulates Bryntum Scheduler Pro and turns it into a Vue 3 component, exposing
-configuration options, properties, features, and events.
+# Vue 3 wrapper for Bryntum Scheduler Pro Thin packages
 
-# Bryntum repository access setup
+This package provides a wrapper that turns Bryntum Scheduler Pro into a Vue 3 component, exposing configuration options,
+properties, features, and events.
 
-This npm package requires access to the private Bryntum npm repository.
-You must be logged in to this repository as a licensed or trial user to access it.
-Please check the [Online npm repository guide](https://bryntum.com/products/schedulerpro/docs/guide/SchedulerPro/npm-repository) for detailed information on the sign-up/login
-process.
+> **Thin Package:** This is a thin wrapper package designed for applications that use multiple Bryntum products.
+> Thin packages exclude bundled dependencies to avoid duplication. For details, see
+> [Vue Multiple Products](https://bryntum.com/products/schedulerpro/docs/guide/SchedulerPro/integration/vue/multiple-products).
 
-# Installation
+## Version Requirement
 
-The installation is performed by running the installation command in the root of your application folder. The specific
-command depends on the package manager used in your application.
+* Vue: `3.2` or higher
+* TypeScript: `4.2` or higher
+* Vite `5` or higher
 
-The following commands are most frequently used:
+## Package Contents
 
-Install using `npm`:
+| Path         | Description                                    |
+|--------------|------------------------------------------------|
+| `lib/`       | Vue 3 wrapper components (BryntumSchedulerPro etc.) |
+| `src/`       | Original Vue source files                      |
+| `src/*.d.ts` | TypeScript type definitions                    |
 
-```shell
-npm install @bryntum/schedulerpro-vue-3@7.1.1
+## Installation
+
+### Vue 3 Wrapper
+
+```bash
+npm install @bryntum/schedulerpro-vue-3-thin@latest
+```
+
+### Component Package (Required)
+
+```bash
+npm install @bryntum/schedulerpro-thin@latest
+```
+
+## Try Bryntum Online Demos
+
+* [View Online Vue Demos](https://bryntum.com/products/schedulerpro/examples/?framework=vue)
+
+## Quick Start
+
+Edit the `src/App.vue` file and replace the content with the following:
+
+```typescript
+<script setup>
+import { createApp, ref } from 'vue';
+
+import { BryntumSchedulerPro, BryntumSchedulerProProjectModel } from '@bryntum/schedulerpro-vue-3-thin';
+import { schedulerProProjectProps, schedulerProProps } from './configs/schedulerrpo';
+
+import './App.scss';
+
+const schedulerProProject = ref(null);
+
+createApp({
+    setup() {
+        return {
+            schedulerProProject
+        };
+    }
+});
+</script>
+
+<template>
+    <bryntum-scheduler-pro-project-model
+        ref="schedulerProProject"
+        v-bind=schedulerProProjectProps
+    />
+    <bryntum-scheduler-pro
+        :project="schedulerProProject"
+        v-bind="schedulerProProps"
+    />
+</template>
+
+<style lang="scss">
+</style>
+```
+
+Create a `SchedulerProConfig.ts` file in the `src/` directory with the following content:
+
+```typescript
+import { type BryntumSchedulerProProps } from '@bryntum/schedulerpro-vue-3';
+
+export const schedulerProConfig : BryntumSchedulerProProps = {
+    startDate        : new Date(2026, 0, 1),
+    endDate          : new Date(2026, 1, 10),
+    viewPreset       : 'hourAndDay',
+    rowHeight        : 50,
+    barMargin        : 5,
+    multiEventSelect : true,
+    // Uncomment this line, if you have a public/users/ path for images
+    // resourceImagePath : 'users/',
+    columns          : [{ text : 'Name', field : 'name', width : 130 }],
+    // Project arranges loading and syncing of data in JSON form from/to a web service
+    project          : {
+        loadUrl  : 'data/data.json',
+        autoLoad : true
+    }
+};
 ```
 
-Install using `yarn`:
+<details>
+<summary>Create sample data (click to expand)</summary>
 
-```shell
-yarn add @bryntum/schedulerpro-vue-3@7.1.1
+Create a `public/data/data.json` file for example data and add the following JSON data to it:
+
+```json
+{
+  "success": true,
+  "resources": {
+    "rows": [
+      { "id": 1, "name": "Dan Stevenson"     },
+      { "id": 2, "name": "Talisha Babin"     },
+      { "id": 3, "name": "Michael Chen"      },
+      { "id": 4, "name": "Sophia Rodriguez"  },
+      { "id": 5, "name": "Arjun Mehta"       }
+    ]
+  },
+  "events": {
+    "rows": [
+      { "id": 1,  "startDate": "2026-01-01", "duration": 3, "durationUnit": "d", "name": "Project Kickoff"        },
+      { "id": 2,  "startDate": "2026-01-04", "duration": 4, "durationUnit": "d", "name": "Requirement Gathering"  },
+      { "id": 3,  "startDate": "2026-01-08", "duration": 5, "durationUnit": "d", "name": "UI/UX Design"           },
+      { "id": 4,  "startDate": "2026-01-13", "duration": 7, "durationUnit": "d", "name": "Backend Development"    },
+      { "id": 5,  "startDate": "2026-01-20", "duration": 6, "durationUnit": "d", "name": "Frontend Development"   },
+      { "id": 6,  "startDate": "2026-01-26", "duration": 4, "durationUnit": "d", "name": "API Integration"        },
+      { "id": 7,  "startDate": "2026-01-30", "duration": 3, "durationUnit": "d", "name": "Testing & QA"           },
+      { "id": 8,  "startDate": "2026-02-02", "duration": 2, "durationUnit": "d", "name": "Client Review"          },
+      { "id": 9,  "startDate": "2026-02-04", "duration": 3, "durationUnit": "d", "name": "Bug Fixing"             },
+      { "id": 10, "startDate": "2026-02-07", "duration": 2, "durationUnit": "d", "name": "Final Deployment"       }
+    ]
+  },
+  "assignments": {
+    "rows": [
+      { "event": 1,  "resource": 1 },
+      { "event": 2,  "resource": 2 },
+      { "event": 3,  "resource": 3 },
+      { "event": 4,  "resource": 4 },
+      { "event": 5,  "resource": 5 },
+      { "event": 6,  "resource": 3 },
+      { "event": 7,  "resource": 2 },
+      { "event": 8,  "resource": 1 },
+      { "event": 9,  "resource": 4 },
+      { "event": 10, "resource": 5 }
+    ]
+  },
+  "dependencies": {
+    "rows": [
+      { "fromEvent": 1, "toEvent": 2  },
+      { "fromEvent": 2, "toEvent": 3  },
+      { "fromEvent": 3, "toEvent": 4  },
+      { "fromEvent": 4, "toEvent": 5  },
+      { "fromEvent": 5, "toEvent": 6  },
+      { "fromEvent": 6, "toEvent": 7  },
+      { "fromEvent": 7, "toEvent": 8  },
+      { "fromEvent": 8, "toEvent": 9  },
+      { "fromEvent": 9, "toEvent": 10 }
+    ]
+  }
+}
 ```
 
-# Integration guide
+This is the data the Bryntum SchedulerPro will use.
+
+</details>
+
+## Project Structure
+
+### Product Dependencies
+
+API packages:
+
+```json
+{
+  "dependencies": {
+    "@bryntum/core-thin": "7.1.2",
+    "@bryntum/engine-thin": "7.1.2",
+    "@bryntum/grid-thin": "7.1.2",
+    "@bryntum/scheduler-thin": "7.1.2",
+    "@bryntum/schedulerpro-thin": "7.1.2"
+  }
+}
+```
+
+Framework wrapper packages:
+
+```json
+{
+  "dependencies": {
+    "@bryntum/core-vue-3-thin": "7.1.2",
+    "@bryntum/schedulerpro-vue-3-thin": "7.1.2"
+  }
+}
+```
+
+### Product Configuration
+
+```typescript
+import { BryntumSchedulerProProps } from '@bryntum/schedulerpro-vue-3-thin';
+
+const schedulerProProps : BryntumSchedulerProProps = {
+    // Scheduler Pro configuration
+};
+```
+
+### Product Styling
+
+**SCSS/CSS:**
+
+```css
+/* FontAwesome is used for icons */
+@import '@bryntum/core-thin/fontawesome/css/fontawesome.css';
+@import "@bryntum/core-thin/fontawesome/css/solid.css";
+/* Structural CSS */
+@import '@bryntum/core-thin/core.css';
+@import '@bryntum/grid-thin/grid.css';
+@import '@bryntum/scheduler-thin/scheduler.css';
+@import '@bryntum/schedulerpro-thin/schedulerpro.css';
+/* Theme */
+@import '@bryntum/core-thin/svalbard-light.css';
+```
+
+### Product Localization
+
+```javascript
+import '@bryntum/schedulerpro-thin/lib/localization/De.js'
+```
+
+## Integration Guide
 
 For details on installing and using this package, see the
 [Vue Integration Guide](https://bryntum.com/products/schedulerpro/docs/guide/SchedulerPro/integration/vue/guide).
 
-# Online references
+## Wrappers
+
+Vue wrappers encapsulate Bryntum components as native Vue components, exposing all configuration options,
+properties, features, and events through Vue-familiar patterns like props, events, and slots.
+
+Visit [Wrappers documentation](https://bryntum.com/products/schedulerpro/docs/guide/SchedulerPro/integration/vue/guide#wrappers) for the complete list of available
+wrapper components.
+
+## Features
+
+Features are optional modules that extend Bryntum Scheduler Pro functionality. Each feature is suffixed with `Feature` and
+can be enabled and configured through standard Vue props.
+
+Visit [Features documentation](https://bryntum.com/products/schedulerpro/docs/guide/SchedulerPro/integration/vue/guide#features) for the complete list of available
+features and their configuration options.
+
+## Explore All Bryntum Products
+
+* [Bryntum Grid](https://bryntum.com/products/grid/) - High-performance data grid
+* [Bryntum Scheduler](https://bryntum.com/products/scheduler/) - Resource scheduling component
+* [Bryntum Scheduler Pro](https://bryntum.com/products/schedulerpro/) - Advanced scheduling with dependencies
+* [Bryntum Gantt](https://bryntum.com/products/gantt/) - Project planning and management
+* [Bryntum Calendar](https://bryntum.com/products/calendar/) - Full-featured calendar component
+* [Bryntum TaskBoard](https://bryntum.com/products/taskboard/) - Kanban-style task management
+
+Explore our comprehensive collection of demos:
+
+| Product           |   <img src="https://bryntum.com/products/grid/docs/data/Core/images/logo/js.svg" alt="JavaScript" width="30"><br>JavaScript    |  <img src="https://bryntum.com/products/grid/docs/data/Core/images/logo/react.svg" alt="React" width="30"><br>React  |   <img src="https://bryntum.com/products/grid/docs/data/Core/images/logo/vue.svg" alt="Vue" width="30"><br>Vue   | <img src="https://bryntum.com/products/grid/docs/data/Core/images/logo/angular.svg" alt="Angular" width="30"><br>Angular |
+|-------------------|:------------------------------------------------------------------------------------:|:--------------------------------------------------------------------------:|:----------------------------------------------------------------------:|:------------------------------------------------------------------------------:|
+| **Grid**          |         [Grid JavaScript demos](https://bryntum.com/products/grid/examples/?framework=javascript)          |         [Grid React demos](https://bryntum.com/products/grid/examples/?framework=react)          |         [Grid Vue demos](https://bryntum.com/products/grid/examples/?framework=vue)          |         [Grid Angular demos](https://bryntum.com/products/grid/examples/?framework=angular)          |
+| **Scheduler**     |    [Scheduler JavaScript demos](https://bryntum.com/products/scheduler/examples/?framework=javascript)     |    [Scheduler React demos](https://bryntum.com/products/scheduler/examples/?framework=react)     |    [Scheduler Vue demos](https://bryntum.com/products/scheduler/examples/?framework=vue)     |    [Scheduler Angular demos](https://bryntum.com/products/scheduler/examples/?framework=angular)     |
+| **Scheduler Pro** | [Scheduler Pro JavaScript demos](https://bryntum.com/products/schedulerpro/examples/?framework=javascript) | [Scheduler Pro React demos](https://bryntum.com/products/schedulerpro/examples/?framework=react) | [Scheduler Pro Vue demos](https://bryntum.com/products/schedulerpro/examples/?framework=vue) | [Scheduler Pro Angular demos](https://bryntum.com/products/schedulerpro/examples/?framework=angular) |
+| **Gantt**         |        [Gantt JavaScript demos](https://bryntum.com/products/gantt/examples/?framework=javascript)         |        [Gantt React demos](https://bryntum.com/products/gantt/examples/?framework=react)         |        [Gantt Vue demos](https://bryntum.com/products/gantt/examples/?framework=vue)         |        [Gantt Angular demos](https://bryntum.com/products/gantt/examples/?framework=angular)         |
+| **Calendar**      |     [Calendar JavaScript demos](https://bryntum.com/products/calendar/examples/?framework=javascript)      |     [Calendar React demos](https://bryntum.com/products/calendar/examples/?framework=react)      |     [Calendar Vue demos](https://bryntum.com/products/calendar/examples/?framework=vue)      |     [Calendar Angular demos](https://bryntum.com/products/calendar/examples/?framework=angular)      |
+| **TaskBoard**     |    [TaskBoard JavaScript demos](https://bryntum.com/products/taskboard/examples/?framework=javascript)     |    [TaskBoard React demos](https://bryntum.com/products/taskboard/examples/?framework=react)     |    [TaskBoard Vue demos](https://bryntum.com/products/taskboard/examples/?framework=vue)     |    [TaskBoard Angular demos](https://bryntum.com/products/taskboard/examples/?framework=angular)     |
+
+## Online references
 
-* [Bryntum Vue Quick Start Guide](https://bryntum.com/products/schedulerpro/docs/guide/SchedulerPro/quick-start/vue-3)
-* [Bryntum Vue Integration Guide](https://bryntum.com/products/schedulerpro/docs/guide/SchedulerPro/integration/vue/guide)
-* [Bryntum npm repository guide](https://bryntum.com/products/schedulerpro/docs/guide/SchedulerPro/npm-repository)
 * [Bryntum Scheduler Pro documentation](https://bryntum.com/products/schedulerpro/docs/)
 * [Bryntum Scheduler Pro examples](https://bryntum.com/products/schedulerpro/examples/)
+
 * [Bryntum Support Forum](https://forum.bryntum.com/)
 * [Contact us](https://bryntum.com/contact/)
 
-# License and copyright
+## License and copyright
 
 This wrapper depends on Bryntum Scheduler Pro, which is commercial software and requires a paid license.
 Please visit the [Bryntum Scheduler Pro End User License](https://bryntum.com/products/schedulerpro/license/) for the full text of the license.
 
 Copyright © 2009-2026, Bryntum
 All rights reserved.
+