@jaeungkim/gantt-chart 1.4.0 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +22 -14
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -6,7 +6,12 @@
6
6
  [![CI](https://github.com/jaeungkim/gantt-chart/actions/workflows/ci.yml/badge.svg)](https://github.com/jaeungkim/gantt-chart/actions/workflows/ci.yml)
7
7
  [![license](https://img.shields.io/npm/l/@jaeungkim/gantt-chart)](LICENSE)
8
8
 
9
- A Gantt chart for React that behaves like a controlled input.
9
+ Bring interactive project planning to your React app.
10
+
11
+ Drag tasks, connect dependencies, and organize projects into nested timelines. Working calendars,
12
+ keyboard editing, and light and dark themes come built in.
13
+
14
+ Open source · MIT licensed · React 18 & 19 · TypeScript
10
15
 
11
16
  [Quick start](https://gantt.jaeungkim.com/docs/quick-start) |
12
17
  [Playground](https://gantt.jaeungkim.com/playground) |
@@ -15,18 +20,21 @@ A Gantt chart for React that behaves like a controlled input.
15
20
 
16
21
  ## Features
17
22
 
18
- - One controlled `tasks` prop. Every committed gesture returns the complete next array through
19
- `onTasksChange`, and the chart persists nothing.
20
- - One ARIA treegrid. Move, resize and reorder from the keyboard, announced in a live region.
21
- Drawing a dependency arrow has no keyboard path.
22
- - Rows and time cells both virtualized against one scroll window, so a 4,000-row plan mounts what
23
- fits on screen.
24
- - A headless core with no React and no DOM, enforced by an eslint `no-restricted-imports` block
25
- scoped to `src/core`.
26
- - Dependency arrows for `FS`, `SS`, `FF` and `SF`, drawn between bars.
27
- - A working calendar from `workingWeekdays` and `holidays` that both shades the timeline and snaps
28
- a drop forward.
29
- - Five scales from `day` to `year`, a task list pane with the `parentId` tree, and lanes.
23
+ - **Edit the plan directly.** Move and resize tasks, adjust progress, and draw dependency arrows.
24
+ - **Move a whole project phase.** Organize tasks into a collapsible hierarchy and move a summary
25
+ row together with its children.
26
+ - **Connect the work.** Draw finish-to-start, start-to-start, finish-to-finish and start-to-finish
27
+ dependencies.
28
+ - **Plan around working days.** Define workweeks and holidays, with optional snapping to the next
29
+ working day.
30
+ - **Explore larger plans.** Rows and time cells are virtualized, with five scales from day to year.
31
+ - **Use the keyboard.** Navigate, move, resize and reorder tasks with edit announcements.
32
+ See the [accessibility guide](https://gantt.jaeungkim.com/docs/accessibility) for supported
33
+ actions and remaining gaps.
34
+ - **Match your app.** Light and dark themes, CSS custom properties, localized dates and custom
35
+ detail panels.
36
+ - **Connect your data.** Receive updated tasks through `onTasksChange` and handle storage in
37
+ your app.
30
38
 
31
39
  ## Install
32
40
 
@@ -40,7 +48,7 @@ pnpm add @jaeungkim/gantt-chart
40
48
  built bundle imports. The ESM build is under 40 kB gzipped and the stylesheet is 4.1 kB. `dayjs` is a
41
49
  declared dependency because `Dayjs` is in the public types.
42
50
 
43
- ## Quick example
51
+ ## Connect it to your app
44
52
 
45
53
  ```tsx
46
54
  import { useState } from 'react';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jaeungkim/gantt-chart",
3
- "version": "1.4.0",
3
+ "version": "1.5.0",
4
4
  "private": false,
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",
@@ -23,7 +23,7 @@
23
23
  "files": [
24
24
  "dist"
25
25
  ],
26
- "description": "A Gantt chart for React that behaves like a controlled input. Every drag returns the complete next tasks array. An ARIA treegrid with keyboard editing, rows and time cells both virtualized, a headless core with no React or DOM, dependency arrows and a working calendar.",
26
+ "description": "An open-source React Gantt chart for interactive project planning. Drag tasks, connect dependencies, and organize nested timelines with working calendars, keyboard editing, virtualization, and light and dark themes.",
27
27
  "keywords": [
28
28
  "gantt",
29
29
  "gantt-chart",