@ninthforge/gantt 0.0.0-stage → 1.0.0-rc.1

package/LICENSE.md

@@ -0,0 +1,9 @@
+Copyright (c) 2026 Inspire Labs Pty Ltd, trading as Ninth Forge. All rights reserved.
+
+This repository and its contents are proprietary and confidential. No licence is
+granted to use, copy, modify or distribute any part of it except under a written
+agreement with Inspire Labs Pty Ltd. Packages published from this repository are
+licensed under the Ninth Forge End User Licence Agreement at https://ninthforge.com/legal/eula.
+
+Free-pack packages and `@ninthforge/tokens` are released under the MIT licence; for
+those packages, the licence file inside the package applies to that package only.

package/README.md

@@ -1,3 +1,82 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# @ninthforge/gantt
+
+A work plan for Microsoft Power Apps code apps and any React app: phases, tasks and milestones on a timeline, with dependencies, progress and a task grid. It's part of **[Ninth Forge Plan](https://ninthforge.com)**, the same component as the Ninth Forge Gantt control for model-driven and canvas apps.
+
+- **Plan:** phases that span their tasks, milestones as diamonds, finish-to-start dependencies, baselines, and working days (Monday to Friday, or every day).
+- **Edit:**
+  - drag to move, drag an edge to resize, drag the progress knob
+  - drag from a bar to link tasks
+  - rename in place, add tasks
+  - Alt+arrows from the keyboard, with undo and redo
+- **Read:** Week, Month and Quarter zoom, a task grid with owner, % done, dates and duration columns, a filter box, and expand or collapse by phase.
+- **Output and access:**
+  - print and PNG export
+  - light and dark themes with your accent
+  - right-to-left layouts and high-contrast mode
+  - full keyboard and screen-reader support
+- **Fast:** 5,000 tasks scroll smoothly; only the rows on screen are drawn.
+- **Lean and private:**
+  - no runtime dependencies beyond React (16.14 or later)
+  - no network calls, and the licence check is offline
+
+## Install
+
+```
+npm install @ninthforge/gantt@next
+```
+
+Release candidates (1.0.0-rc.N) are under npm's `next` tag until 1.0.0 on 27 January 2027.
+
+```
+# from 1.0.0
+npm install @ninthforge/gantt
+```
+
+## Use
+
+You hold the data. The Gantt shows it and tells you what the user changed.
+
+```tsx
+import { useState } from 'react';
+import { Gantt, type GanttChange, type GanttTask } from '@ninthforge/gantt';
+
+const initial: GanttTask[] = [
+  { id: 'p1', name: 'Discovery', kind: 'phase' }, // a phase spans its tasks
+  { id: 't1', name: 'Stakeholder interviews', parentId: 'p1', start: '2026-07-06', end: '2026-07-22', progress: 100, owner: { name: 'Ava Kim' } },
+  { id: 'm1', name: 'Requirements signed off', kind: 'milestone', parentId: 'p1', date: '2026-08-03', dependsOn: ['t1'] },
+  { id: 'p2', name: 'Build', kind: 'phase' },
+  { id: 't2', name: 'Front end', parentId: 'p2', start: '2026-09-14', end: '2026-11-13', progress: 42, owner: { name: 'Ravi Shah' }, dependsOn: ['m1'] },
+  { id: 't3', name: 'Integrations', parentId: 'p2', start: '2026-09-21', end: '2026-11-20', progress: 30, owner: { name: 'Mia Tan' } }
+];
+
+export function WorkPlan({ licenseKey, tenantId }: { licenseKey?: string; tenantId?: string }) {
+  const [tasks, setTasks] = useState(initial);
+
+  // Save to your backend; throw (or reject) to put the task back with a message.
+  const onTaskChange = async (c: GanttChange) => {
+    const { id, previous, source, ...fields } = c;
+    setTasks((list) => list.map((t) => (t.id === id ? { ...t, ...fields } : t)));
+  };
+
+  return (
+    <div style={{ height: 560 }}>
+      <Gantt
+        title="Customer portal relaunch"
+        tasks={tasks}
+        onTaskChange={onTaskChange}
+        licenseKey={licenseKey}
+        tenantId={tenantId}
+      />
+    </div>
+  );
+}
+```
+
+- **Dates** are ISO `YYYY-MM-DD` strings, end inclusive, handled in UTC. Changes come back the same way, with only the changed fields plus `previous` (for undo or diffing).
+- **Kinds:** `task` (the default), `phase` (its dates come from its tasks) and `milestone` (one `date`).
+- **Read-only:** `editable={false}`, or switch single actions off, e.g. `editable={{ link: false }}`.
+- **Optimistic saves:** return a promise from `onTaskChange`. The chart keeps the edit while it's pending, and puts it back with a message if the promise rejects.
+
+## Licence
+
+Ninth Forge Plan is a paid product. Without a key, everything works, with a small "Unlicensed" badge in the corner. Pass your Plan key as `licenseKey` and your Microsoft Entra tenant ID as `tenantId`. The check is offline. Trials and keys: [ninthforge.com](https://ninthforge.com).