@shiodome47/planner 0.1.0 → 0.2.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.
- package/README.md +55 -3
- package/dist/chunks/JumpBar-DMnykrl0.js +904 -0
- package/dist/projects/Projects.d.ts +12 -0
- package/dist/projects/ProjectsPage.d.ts +13 -0
- package/dist/projects/colors.d.ts +3 -0
- package/dist/projects/index.d.ts +8 -0
- package/dist/projects/projectCards.d.ts +18 -0
- package/dist/projects.js +643 -0
- package/dist/style.css +2 -0
- package/dist/timeline/Board.d.ts +11 -0
- package/dist/timeline/Timeline.d.ts +12 -0
- package/dist/timeline/index.d.ts +6 -0
- package/dist/timeline.js +279 -0
- package/dist/ui/DaySelect.d.ts +15 -0
- package/dist/ui/Dialog.d.ts +12 -0
- package/dist/ui/DueChip.d.ts +16 -0
- package/dist/ui/JumpBar.d.ts +18 -0
- package/dist/ui/Menu.d.ts +17 -0
- package/dist/ui/NoteDialog.d.ts +38 -0
- package/dist/ui/Root.d.ts +12 -0
- package/dist/ui/Rows.d.ts +39 -0
- package/dist/ui/WhenSelect.d.ts +12 -0
- package/dist/ui/display.d.ts +9 -0
- package/dist/ui/dnd.d.ts +37 -0
- package/dist/ui/storage.d.ts +6 -0
- package/dist/ui/types.d.ts +5 -0
- package/package.json +26 -4
package/README.md
CHANGED
|
@@ -5,8 +5,9 @@
|
|
|
5
5
|
| 入り口 | 中身 | 状態 |
|
|
6
6
|
|---|---|---|
|
|
7
7
|
| `@shiodome47/planner/core` | **土台**。データの形と決まりごと(画面なし。計算だけ) | ✅ 使えます |
|
|
8
|
-
| `@shiodome47/planner/timeline` |
|
|
9
|
-
| `@shiodome47/planner/projects` |
|
|
8
|
+
| `@shiodome47/planner/timeline` | **時間軸の画面** `<Timeline>`(React) | ✅ 使えます |
|
|
9
|
+
| `@shiodome47/planner/projects` | **プロジェクトの画面** `<Projects>`(React。並べ替えは [linkshelf](https://www.npmjs.com/package/linkshelf) の `<CardBoard>`) | ✅ 使えます |
|
|
10
|
+
| `@shiodome47/planner/style.css` | 画面の見た目(`.planner` の中だけに効く) | ✅ |
|
|
10
11
|
|
|
11
12
|
時間軸とプロジェクトは、同じ「やること」の一覧を見ています。期日を入れたやることは、プロジェクトのカードにも、時間軸の列にも出ます。つなぐのは画面ではなく、この土台(`core`)です。
|
|
12
13
|
|
|
@@ -14,6 +15,57 @@
|
|
|
14
15
|
npm install @shiodome47/planner
|
|
15
16
|
```
|
|
16
17
|
|
|
18
|
+
## 画面(timeline・projects)
|
|
19
|
+
|
|
20
|
+
データ(`PlannerData`)と「今」を渡し、変更を `onChange` で受け取って保存するだけで、時間軸とプロジェクトの画面になります。2 つの画面は同じデータを見るので、プロジェクトに期日つきの目標を足すと、時間軸の列にも出ます。
|
|
21
|
+
|
|
22
|
+
```tsx
|
|
23
|
+
import { Timeline } from '@shiodome47/planner/timeline'
|
|
24
|
+
import { Projects } from '@shiodome47/planner/projects'
|
|
25
|
+
import { applyChanges, type Changes, type PlannerData } from '@shiodome47/planner/core'
|
|
26
|
+
import '@shiodome47/planner/style.css'
|
|
27
|
+
|
|
28
|
+
function App() {
|
|
29
|
+
const [data, setData] = useState<PlannerData>(load())
|
|
30
|
+
const onChange = useCallback((c: Changes) => {
|
|
31
|
+
setData((d) => applyChanges(d, c))
|
|
32
|
+
save(c) // 保存先は自由(IndexedDB・サーバー・同期)
|
|
33
|
+
}, [])
|
|
34
|
+
const now = useNow() // 1 分ごとなどに新しくする
|
|
35
|
+
|
|
36
|
+
return tab === 'timeline' ? <Timeline data={data} now={now} onChange={onChange} /> : <Projects data={data} now={now} onChange={onChange} />
|
|
37
|
+
}
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
| 設定 | 中身 |
|
|
41
|
+
|---|---|
|
|
42
|
+
| `data` / `now` / `onChange` | データ・今・変更を受け取る関数(必須) |
|
|
43
|
+
| `simple` | すっきり表示(慣れたら要らない説明の文字を消す) |
|
|
44
|
+
| `theme` | `light` / `dark` / `system`(既定。端末の設定に合わせる) |
|
|
45
|
+
| `className` | 外枠に足すクラス |
|
|
46
|
+
|
|
47
|
+
- 画面の中で使う React の部品・ドラッグ(@dnd-kit)・アイコン(lucide-react)・linkshelf は、`npm install` で一緒に入ります。React(18・19)は使う側のもの
|
|
48
|
+
- 列を広げた状態や、書きかけの文字は、見る人のブラウザに覚えます(名前は `planner:…`)
|
|
49
|
+
- 時間軸は、スマホの幅では列を横にすべらせ、上の帯から列を選べます。プロジェクトは、画面の幅に合わせて段組みになり、カードをドラッグで並べ替えられます(キーボードでも)
|
|
50
|
+
|
|
51
|
+
### 色を合わせる
|
|
52
|
+
|
|
53
|
+
見た目は `.planner` の中だけに効き、色は変数で決まります。使う側の CSS で上書きすると、アプリの色に合わせられます。
|
|
54
|
+
|
|
55
|
+
```css
|
|
56
|
+
.planner {
|
|
57
|
+
--pl-accent: #2563eb; /* 決定のボタン・今日の列・ドラッグの線 */
|
|
58
|
+
--pl-panel: #fff; /* 列・カード */
|
|
59
|
+
--pl-panel-2: #f3f4f6; /* 入力欄・行にマウスを乗せたとき */
|
|
60
|
+
--pl-border: #e5e7eb;
|
|
61
|
+
--pl-text: #111827;
|
|
62
|
+
--pl-muted: #6b7280;
|
|
63
|
+
--pl-sticky-top: 56px; /* 上に固定の見出しがあるページでは、その高さ */
|
|
64
|
+
}
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
ほかに `--pl-page-bg`・`--pl-accent-text`・`--pl-danger`・`--pl-warning`・`--pl-ok` があります。プロジェクトの色は `PROJECT_COLORS`(`teal`・`blue` など 8 色)。
|
|
68
|
+
|
|
17
69
|
## 土台(core)
|
|
18
70
|
|
|
19
71
|
### データの形
|
|
@@ -75,7 +127,7 @@ data = applyChanges(data, toggleDone(data, data.tasks[0], now))
|
|
|
75
127
|
|
|
76
128
|
## English
|
|
77
129
|
|
|
78
|
-
Building blocks for a timeline (today / this week / months / this year / life) and projects, taken from the Magic Lamp app. `@shiodome47/planner/
|
|
130
|
+
Building blocks for a timeline (today / this week / months / this year / life) and projects, taken from the Magic Lamp app. Screens: `<Timeline data now onChange />` (`@shiodome47/planner/timeline`) and `<Projects data now onChange />` (`@shiodome47/planner/projects`); import `@shiodome47/planner/style.css`. Styles apply only inside `.planner`; override `--pl-*` variables to match your app. `@shiodome47/planner/core` holds the data model (`Task`, `Habit`, `Project`, `PlannerData`) and the rules — which column a dated task belongs to, the next date of a recurring habit ("2nd Sunday of each month", "every December 6"), placing, finishing and reordering, and review helpers. Functions never mutate data; they return `Changes`, which you save wherever you like and apply locally with `applyChanges`. Pass the current time (`now`) explicitly. UI labels are Japanese.
|
|
79
131
|
|
|
80
132
|
## License
|
|
81
133
|
|