zegantt 0.3.0 → 1.1.0

package/README.md

@@ -1,73 +1,260 @@
-# React + TypeScript + Vite
+# ZeGantt
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+ZeGantt is a React Gantt chart library focused on construction and project planning workflows.
 
-Currently, two official plugins are available:
+## Highlights
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+- Virtualized rows and day-columns for large datasets (thousands of tasks)
+- Drag, resize and dependency creation with mouse and touch support
+- Keyboard navigation and accessibility attributes for enterprise use
+- Theme tokens via CSS variables
+- i18n with robust English fallback
+- ESM + CJS builds with TypeScript declarations
 
-## React Compiler
+## Install
 
-The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
+```bash
+npm install zegantt
+```
+
+### Required peer dependencies
+
+```bash
+npm install react react-dom lucide-react
+```
 
-## Expanding the ESLint configuration
+## Minimal usage
 
-If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
+```tsx
+import { ProjectGantt, ptBR, type GanttStep } from 'zegantt';
+import 'zegantt/style.css';
 
-```js
-export default defineConfig([
-  globalIgnores(['dist']),
+const steps: GanttStep[] = [
   {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
-
-      // Remove tseslint.configs.recommended and replace with this
-      tseslint.configs.recommendedTypeChecked,
-      // Alternatively, use this for stricter rules
-      tseslint.configs.strictTypeChecked,
-      // Optionally, add this for stylistic rules
-      tseslint.configs.stylisticTypeChecked,
-
-      // Other configs...
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
+    id: 's1',
+    name: 'Foundation',
+    startDate: '2026-01-10',
+    finishDate: '2026-01-20',
+    conclusionPercent: 45,
+    projectId: 'p1',
+    projectTitle: 'Residential Tower',
   },
-])
+];
+
+export function Example() {
+  return (
+    <ProjectGantt
+      steps={steps}
+      locale="pt-BR"
+      translations={ptBR}
+      groupByProject
+      onTaskChange={(task) => console.log('Task updated', task)}
+    />
+  );
+}
 ```
 
-You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
+## Data contracts
 
-```js
-// eslint.config.js
-import reactX from 'eslint-plugin-react-x'
-import reactDom from 'eslint-plugin-react-dom'
+### Steps
 
-export default defineConfig([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
-      // Enable lint rules for React
-      reactX.configs['recommended-typescript'],
-      // Enable lint rules for React DOM
-      reactDom.configs.recommended,
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
+```ts
+interface GanttStep {
+  id: string;
+  name: string;
+  startDate?: Date | string;
+  finishDate?: Date | string;
+  previsionStartDate?: Date | string;
+  previsionFinishDate?: Date | string;
+  conclusionPercent?: number | string;
+  projectId?: string;
+  projectTitle?: string;
+}
+```
+
+### Milestones
+
+```ts
+interface GanttMilestone {
+  id: string;
+  name: string;
+  date?: Date | string;
+  finished?: boolean;
+  projectId?: string;
+  projectTitle?: string;
+}
+```
+
+### Events
+
+```ts
+interface GanttEvent {
+  id: string;
+  title: string;
+  date?: Date | string;
+  finished?: boolean;
+  projectId?: string;
+  projectTitle?: string;
+}
+```
+
+### Notes
+
+```ts
+interface GanttNote {
+  id: string;
+  title: string;
+  targetId?: string;
+  predecessorId?: string;
+  description?: string;
+  author?: string;
+  date?: Date | string;
+  color?: string;
+  filesCount?: number;
+  projectId?: string;
+  projectTitle?: string;
+}
+```
+
+### Dependencies
+
+```ts
+type PredecessorType = 'STEP' | 'MILESTONE';
+type DependencyType = 'FS' | 'SS' | 'FF' | 'SF';
+
+interface GanttDependency {
+  id: string;
+  predecessorId: string;
+  predecessorType: PredecessorType;
+  successorId: string;
+  successorType: PredecessorType;
+  type: DependencyType;
+  lag: number;
+}
+```
+
+## Main props
+
+```ts
+interface ProjectGanttProps {
+  steps: GanttStep[];
+  milestones?: GanttMilestone[];
+  events?: GanttEvent[];
+  notes?: GanttNote[];
+  dependencies?: GanttDependency[];
+
+  loading?: boolean;
+  locale?: string;
+  groupByProject?: boolean;
+  translations?: Record<string, string> | ((key: string, fallback?: string) => string);
+
+  onTaskChange?: (task: GanttTask) => void;
+  onTaskClick?: (task: GanttTask) => void;
+  onCreateDependency?: (params: CreateDependencyParams) => Promise<void>;
+  onDeleteDependency?: (dependencyId: string) => Promise<void>;
+  onDependencyError?: (error: DependencyValidationError) => void;
+
+  onAddNewStage?: (date?: Date, projectId?: string) => void;
+  onAddMilestone?: (date?: Date, projectId?: string) => void;
+  onAddEvent?: (date?: Date, projectId?: string) => void;
+  onAddNote?: (date?: Date, projectId?: string) => void;
+}
+```
+
+## Dependency cycle protection
+
+ZeGantt blocks creation of circular dependencies (for example A -> B -> C -> A).
+
+- If `onDependencyError` is provided, it receives a `CYCLIC_DEPENDENCY` error payload.
+- If not provided, ZeGantt shows a default alert message.
+
+## Accessibility and keyboard
+
+- Interactive rows include semantic roles and keyboard handling
+- Row navigation with arrow keys
+- `Enter` opens task details (when callback exists)
+- Focus-visible ring is provided by default CSS
+
+## Mobile and touch
+
+The library supports touch interactions for:
+
+- Bar dragging
+- Bar resizing
+- Dependency connection handles
+- Timeline panning
+
+## Theming
+
+ZeGantt exposes CSS variables that can be overridden globally or in a wrapper:
+
+```css
+.my-gantt-theme {
+  --zg-surface: #ffffff;
+  --zg-surface-alt: #f4f7f6;
+  --zg-header-bg: #e9efec;
+  --zg-border: #c9d2ce;
+  --zg-border-light: #dbe3df;
+  --zg-primary-color: #0f3d2f;
+  --zg-note-color: #ffd44d;
+  --zg-shadow-panel: 0 10px 30px rgba(0, 0, 0, 0.08);
+}
+```
+
+Apply theme:
+
+```tsx
+<div className="my-gantt-theme">
+  <ProjectGantt steps={steps} />
+</div>
+```
+
+## i18n
+
+- Use `locale` (BCP 47, ex: `en-US`, `pt-BR`) to format dates and month labels.
+- Provide `translations` as object or function.
+- Missing keys fall back to English automatically.
+
+Built-in helper export:
+
+```ts
+import { ptBR } from 'zegantt';
+```
+
+## Testing
+
+Included scripts:
+
+```bash
+npm run test
+npm run test:watch
 ```
+
+Current suite includes:
+
+- Unit tests for `utils/date.ts`, `utils/timeline.ts`, `utils/criticalPath.ts`, `utils/dependencies.ts`
+- Component tests for context menu and task bar rendering behavior
+
+## Build and publish
+
+Build outputs:
+
+- ESM: `dist/zegantt.js`
+- CJS: `dist/zegantt.cjs`
+- Types: `dist/index.d.ts`
+- Styles: `dist/zegantt.css`
+
+Before publishing:
+
+1. Run `npm run test`
+2. Run `npm run build`
+3. Verify `peerDependencies` resolution in consuming projects
+
+## Storybook recommendation
+
+For consumer-facing documentation, Storybook is strongly recommended to demonstrate:
+
+- Large dataset performance scenarios
+- Interaction flows (drag, resize, dependency creation)
+- Theme variants
+- Locale variants

package/dist/index.d.ts

@@ -11,6 +11,16 @@ export declare interface CreateDependencyParams {
 
 export declare type DependencyType = "FS" | "SS" | "FF" | "SF";
 
+export declare interface DependencyValidationError {
+    code: 'CYCLIC_DEPENDENCY';
+    message: string;
+    predecessorId: string;
+    successorId: string;
+}
+
+/** English translation strings for ZeGantt */
+export declare const enUS: Record<string, string>;
+
 export declare interface GanttDependency {
     id: string;
     predecessorId: string;
@@ -118,6 +128,12 @@ export declare interface ProjectGanttProps {
     translations?: Record<string, string> | ((key: string, fallback?: string) => string);
     /** When true renders one project-header row per project and groups tasks by project */
     groupByProject?: boolean;
+    /** Enables infinite-canvas interaction model (zoom + pan viewport). */
+    infiniteCanvas?: boolean;
+    /** Hides left task list/sidebar and keeps only timeline viewport. */
+    hideSidebar?: boolean;
+    /** Applies automatic fit-to-screen on first paint in infinite-canvas mode. */
+    initialFitToScreen?: boolean;
     onTaskChange?: (task: GanttTask) => void;
     onTaskClick?: (task: GanttTask) => void;
     onAddNewStage?: (date?: Date, projectId?: string) => void;
@@ -126,6 +142,7 @@ export declare interface ProjectGanttProps {
     onDeleteStage?: (taskId: string) => void;
     onCreateDependency?: (params: CreateDependencyParams) => Promise<void>;
     onDeleteDependency?: (dependencyId: string) => Promise<void>;
+    onDependencyError?: (error: DependencyValidationError) => void;
     onAddMilestone?: (date?: Date, projectId?: string) => void;
     onAddEvent?: (date?: Date, projectId?: string) => void;
     onAddNote?: (date?: Date, projectId?: string) => void;