open-grid 1.3.1 → 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.
- package/CHANGELOG.md +77 -0
- package/README.ja.md +462 -0
- package/README.md +70 -19
- package/README.zh.md +455 -0
- package/dist/{OpenGrid-B7m7ei7f.cjs → OpenGrid-CT9bV6On.cjs} +7 -7
- package/dist/OpenGrid-CT9bV6On.cjs.map +1 -0
- package/dist/{OpenGrid-CeUdO_fM.js → OpenGrid-DACnZdEy.js} +7 -7
- package/dist/OpenGrid-DACnZdEy.js.map +1 -0
- package/dist/Registry-CPJYOqCn.js +74 -0
- package/dist/Registry-CPJYOqCn.js.map +1 -0
- package/dist/Registry-D74ZmdDz.cjs +71 -0
- package/dist/Registry-D74ZmdDz.cjs.map +1 -0
- package/dist/{index-JjfWY3Bt.cjs → index-Brfso4Ry.cjs} +92 -160
- package/dist/index-Brfso4Ry.cjs.map +1 -0
- package/dist/index-CeJ-0-80.cjs.map +1 -0
- package/dist/index-DnarQ4eR.js.map +1 -0
- package/dist/index-al9Mbv3E.js +481 -0
- package/dist/index-al9Mbv3E.js.map +1 -0
- package/dist/open-grid-base.css +98 -35
- package/dist/open-grid-header.cjs +188 -0
- package/dist/open-grid-header.cjs.map +1 -0
- package/dist/open-grid-header.css +386 -0
- package/dist/open-grid-header.js +197 -0
- package/dist/open-grid-header.js.map +1 -0
- package/dist/open-grid-react.cjs +1 -1
- package/dist/open-grid-react.cjs.map +1 -0
- package/dist/open-grid-react.js +1 -1
- package/dist/open-grid-react.js.map +1 -0
- package/dist/open-grid-themes.css +774 -1
- package/dist/open-grid-typography.cjs +97 -0
- package/dist/open-grid-typography.cjs.map +1 -0
- package/dist/open-grid-typography.css +181 -0
- package/dist/open-grid-typography.js +105 -0
- package/dist/open-grid-typography.js.map +1 -0
- package/dist/open-grid-vue.cjs +1 -1
- package/dist/open-grid-vue.cjs.map +1 -0
- package/dist/open-grid-vue.js +1 -1
- package/dist/open-grid-vue.js.map +1 -0
- package/dist/open-grid.cjs +31 -31
- package/dist/open-grid.cjs.map +1 -0
- package/dist/open-grid.js +86 -82
- package/dist/open-grid.js.map +1 -0
- package/dist/types/core/FilterSelect.d.ts +269 -33
- package/dist/types/core/GridShuttle.d.ts +160 -24
- package/dist/types/core/IconRegistry.d.ts +241 -33
- package/dist/types/core/OpenGrid.d.ts +2589 -327
- package/dist/types/core/OrgChart.d.ts +249 -32
- package/dist/types/core/SkinRegistry.d.ts +295 -60
- package/dist/types/core/XmlConverter.d.ts +388 -47
- package/dist/types/core/appearance/AppearanceAxis.d.ts +1 -1
- package/dist/types/core/appearance/HeaderRegistry.d.ts +236 -0
- package/dist/types/core/appearance/ThemeMetaRegistry.d.ts +1 -1
- package/dist/types/core/appearance/TypographyRegistry.d.ts +122 -0
- package/dist/types/core/appearance/index.d.ts +1 -0
- package/dist/types/core/chart/types.d.ts +1008 -126
- package/dist/types/core/extension/Registry.d.ts +389 -51
- package/dist/types/core/extension/reserved.d.ts +34 -5
- package/dist/types/core/i18n/LocaleRegistry.d.ts +271 -54
- package/dist/types/core/i18n/types.d.ts +636 -85
- package/dist/types/core/types.d.ts +3576 -426
- package/dist/types/header/index.d.ts +144 -0
- package/dist/types/index.d.ts +226 -17
- package/dist/types/typography/index.d.ts +128 -0
- package/dist/xlsx.min-BQ1o3sB6.cjs.map +1 -0
- package/dist/xlsx.min-Bbz2ZypC.js.map +1 -0
- package/package.json +126 -112
- package/dist/index-DrCPRuYi.js +0 -548
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,83 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to OPEN_GRID will be documented in this file.
|
|
4
4
|
|
|
5
|
+
## [1.5.0] - 2026-08-08
|
|
6
|
+
|
|
7
|
+
### Added
|
|
8
|
+
- **헤더 축 신설 (제6축)** / **New header axis (6th).** 머리글의 **형태**를 색·형태(스킨)·밀도·
|
|
9
|
+
질감·조판에 이은 여섯 번째 축으로 세운다. 지금까지 머리글 모양은 테마 27종이 색만 갈아끼울 뿐
|
|
10
|
+
**하나뿐**이었다.
|
|
11
|
+
- 프리셋 5종 — `default`(오늘과 동일) · `rule`(색면 없이 아래 선 하나) · `quiet`(색면은 두고
|
|
12
|
+
세로 칸막이만 걷음) · `band`(굵은 밑줄, 멀리서·저시력) · `pill`(정렬된 컬럼만 배지로 떠오름).
|
|
13
|
+
- 별도 엔트리 `open-grid/header` — import 하지 않으면 **1바이트도 배송되지 않는다.**
|
|
14
|
+
조판 축(`open-grid/typography`)과 같은 구조다.
|
|
15
|
+
- `applyHeader()` · `defineHeader()` · `HEADER_PRESETS`. 프리셋 본체 CSS 는 `open-grid/header.css`.
|
|
16
|
+
- **이 축은 색을 소유하지 않는다.** `--og-header-*` 이름이 실제로 세 축에 걸쳐 있어
|
|
17
|
+
(색 = 테마 축 · 조판 = 타이포 축 · 형태 = 헤더 축), 헤더 축이 가진 것은 **형태 토큰 8개뿐**이다.
|
|
18
|
+
색은 CSS 가 테마 토큰에서 `var()` 로 유도하므로 **이 축을 통해 새 색이 들어올 자리가 없다.**
|
|
19
|
+
- / The header axis owns **shape only** — 8 tokens. Colours are derived from theme tokens via
|
|
20
|
+
`var()`, so no new hex can enter through this axis. Ship zero bytes unless you import it.
|
|
21
|
+
|
|
22
|
+
- **신규 테마 12종 확정** / **12 new themes finalised.** 내장 테마는 **27종**이 된다.
|
|
23
|
+
```
|
|
24
|
+
밝은 6 graphite · high-contrast · washi · plain · field · clinical
|
|
25
|
+
어두운 6 high-contrast-dark · blueprint · nocturne · graphite-dark · sentinel · ticker
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### Fixed
|
|
29
|
+
- **hover 막대와 스피너가 테마를 안 따라오던 문제** / **Accent bar and spinner ignored the theme.**
|
|
30
|
+
`:root` 안에서 `--og-row-accent-color: var(--og-primary)` 로 선언하면 **그 자리에서 값이 확정**되어
|
|
31
|
+
확정값이 상속된다. 그래서 테마가 뒤에서 `--og-primary` 를 바꿔도 따라오지 않았고, 결과적으로
|
|
32
|
+
행 hover 좌측 막대와 로딩 스피너가 **테마 27종 전부에서 같은 파랑**이었다.
|
|
33
|
+
`.og-container` 에서 다시 선언해 그 요소의 테마 색으로 재확정한다.
|
|
34
|
+
**13종이 대비 미달에서 통과로 올라간다.** 기본 테마는 값이 같아 렌더가 안 바뀐다.
|
|
35
|
+
/ Custom properties resolve where they are declared. Re-declaring them on `.og-container`
|
|
36
|
+
lets the theme win. 13 themes move from failing to passing contrast; the default theme is unchanged.
|
|
37
|
+
|
|
38
|
+
### Changed
|
|
39
|
+
- **하드코딩된 색·반경을 토큰으로** / **Hardcoded colours and radii are now tokens.**
|
|
40
|
+
행번호 열 글자(`#999`)와 여러 `border-radius` 리터럴을 `var(--토큰, 오늘값)` 으로 연다.
|
|
41
|
+
**폴백이 오늘 값이라 기본 렌더는 그대로다.** 형태 축의 `sharp` 를 골랐을 때 이제 실제로 각진다.
|
|
42
|
+
/ Fallbacks keep today's values, so the default render is byte-identical. The `sharp` skin now
|
|
43
|
+
actually squares off the corners it previously missed.
|
|
44
|
+
|
|
45
|
+
- **테마 3종 제거** / **Three themes removed.** `ledger` · `daylight` · `ocean-dark` 는 1.4.0 이후
|
|
46
|
+
저장소에만 있던 미발행 중간 산출로 **한 번도 배포된 적이 없다.** 최종 명단에서 각각
|
|
47
|
+
`plain` · `field` · `high-contrast-dark` 로 대체됐다. `ocean` 의 다크 짝 표기도 함께 지웠다.
|
|
48
|
+
/ They were never published — no consumer action is required.
|
|
49
|
+
|
|
50
|
+
- **API 문서에 축 플러그인 두 개가 나온다** / **Both axis plugins now appear in the API docs.**
|
|
51
|
+
`open-grid/typography` 와 `open-grid/header` 가 TypeDoc 진입점에 없어 문서에서 빠져 있었다.
|
|
52
|
+
주석은 한국어·영어·일본어로 병행 제공된다.
|
|
53
|
+
|
|
54
|
+
## [1.4.0] - 2026-07-17
|
|
55
|
+
|
|
56
|
+
### Added
|
|
57
|
+
- **확장 레지스트리 공개** / **Extension registry is now public.** 커스텀 등록소를 만들 때 쓰는
|
|
58
|
+
등록 정책 엔진 `TypedRegistry` 와 예약 네임스페이스 가드를 공개 API 로 내보낸다. 구현은
|
|
59
|
+
이전부터 코어 안에 있었고, 이번에 공개 표면에 올렸다.
|
|
60
|
+
- `TypedRegistry` — 매 등록의 처리 결과를 돌려준다: `added`(신규) · `replaced`(덮어씀) ·
|
|
61
|
+
`kept`(기존 유지) · `rejected`(거부). 유지·거부에는 `reason` 이 함께 온다.
|
|
62
|
+
- `RESERVED_PREFIXES` · `isReserved` — `og:` · `og-` 는 그리드가 예약한 대역이라 외부 등록이 거부된다.
|
|
63
|
+
- `duplicatePolicy: 'protect-builtin'` — `origin: 'builtin'` 으로 등록된 항목을 나중 등록이 덮지 못하게 막는다.
|
|
64
|
+
- 타입 10종(`IRegistry`·`RegisterOptions`·`RegisterResult`·`RegisterAction`·`RegisterReason`·
|
|
65
|
+
`RegistryEntry`·`EntryOrigin`·`DuplicatePolicy`·`DeprecationInfo`·`TypedRegistryConfig`).
|
|
66
|
+
- / `TypedRegistry` returns what each registration actually did, guards the reserved `og:`/`og-`
|
|
67
|
+
namespace, and can shield built-in entries. Types are erased at runtime.
|
|
68
|
+
- **번들 영향 +80B**(gzip, ES entry 4,441→4,521B / 예산 8,000B). ES 코어 청크는 불변.
|
|
69
|
+
- **순수 additive — 기존 사용자 조치 불필요.** `OpenGrid.registerRenderer` 의 내부 등록 경로는
|
|
70
|
+
바뀌지 않았다(정책 엔진을 거치지 않는다). 기존 동작 100% 보존.
|
|
71
|
+
|
|
72
|
+
### Docs
|
|
73
|
+
- **공개 API JSDoc 4개 국어(한국어·English·日本語·中文)** — TypeDoc 이 렌더하는 공개 선언 전 파일
|
|
74
|
+
891블록. 기존의 `설명. / English.` 한 줄 병기는 문서에서 두 언어가 한 문단에 뭉쳐 나오던 문제가
|
|
75
|
+
있어 **언어별 문단 분리**로 전환했다. 코드 로직 변화 0(주석 전용).
|
|
76
|
+
/ Public API JSDoc in Korean, English, Japanese and Chinese — 891 blocks, one paragraph per
|
|
77
|
+
language (the previous single-line `ko / en` form collapsed into one rendered paragraph).
|
|
78
|
+
- **README 일본어·중국어판** 신설(`README.ja.md` · `README.zh.md`) + 원본 현행화
|
|
79
|
+
(기능표가 v0.1 시절에 머물러 있던 것을 실제 구현 현황으로 교정, 테마 12→15).
|
|
80
|
+
- 영문 JSDoc 드리프트 2건 교정(`ChartSeries.pattern` 이 "색 대신" 분기를 누락, `sampled` 설명 정리).
|
|
81
|
+
|
|
5
82
|
## [1.3.1] - 2026-07-15
|
|
6
83
|
|
|
7
84
|
### Docs
|
package/README.ja.md
ADDED
|
@@ -0,0 +1,462 @@
|
|
|
1
|
+
# OPEN_GRID
|
|
2
|
+
|
|
3
|
+
**Meet Open Grid** — **依存ゼロのコア**を持つ超軽量データグリッド。どんな技術スタックにも
|
|
4
|
+
すんなり収まります。React、Vue、Angular、jQuery、素の JavaScript — どれでもそのまま動きます。
|
|
5
|
+
MIT ライセンスなので商用利用も自由、カスタマイズに際限はなく、AI フレンドリーな override ガイドで
|
|
6
|
+
グリッドをこれまで以上に押し広げられます。
|
|
7
|
+
|
|
8
|
+
仮想スクロール・インライン編集・グルーピング・ツリービュー・ドラッグ&ドロップ・変更追跡・フッター集計・列の並べ替えを備えた、高速でフレームワーク非依存のデータグリッド。
|
|
9
|
+
|
|
10
|
+
[](LICENSE)
|
|
11
|
+
[](https://www.typescriptlang.org/)
|
|
12
|
+
[](https://www.npmjs.com/package/open-grid)
|
|
13
|
+
|
|
14
|
+
[English](README.md) · **日本語** · [中文](README.zh.md)
|
|
15
|
+
|
|
16
|
+
📖 **[開発ガイド](https://foxnail.kr/open-grid/demo/v2/guide/index.php)** — インストールから高度な API まで、段階を追って解説
|
|
17
|
+
🔗 **[デモ/ホームページ](https://foxnail.kr/open-grid/demo/v2/index.php)**
|
|
18
|
+
📚 **[API ドキュメント](https://foxnail.kr/open-grid/demo/v2/api-docs/)** — 韓国語・英語・日本語・中国語の 4 言語 JSDoc
|
|
19
|
+
|
|
20
|
+
## 機能
|
|
21
|
+
|
|
22
|
+
### コア
|
|
23
|
+
|
|
24
|
+
| 機能 | 状態 |
|
|
25
|
+
|---|---|
|
|
26
|
+
| 仮想スクロール(100 万行以上) | ✅ |
|
|
27
|
+
| インライン編集(クリック/ダブルクリック/F2) | ✅ |
|
|
28
|
+
| セルレンダラー(text、number、date、checkbox、button、badge、link、template、sparkline、…) | ✅ |
|
|
29
|
+
| 5 種のセルエディター(text、number、select、date、checkbox) | ✅ |
|
|
30
|
+
| マルチソート(Shift+クリック) | ✅ |
|
|
31
|
+
| 列フィルター UI(9 種の演算子) | ✅ |
|
|
32
|
+
| 列幅リサイズ(ドラッグ) | ✅ |
|
|
33
|
+
| 列の並べ替え(ヘッダーをドラッグ、`columnReorder: true`) | ✅ |
|
|
34
|
+
| 列の固定 | ✅ |
|
|
35
|
+
| 行/列グループ(ヘッダー結合) | ✅ |
|
|
36
|
+
| グルーピング+集計(SUM/AVG/MIN/MAX/COUNT) | ✅ |
|
|
37
|
+
| ツリーグリッド(フラット → 階層、展開/折りたたみ) | ✅ |
|
|
38
|
+
| OrgChart(テーマ対応の組織図) | ✅ |
|
|
39
|
+
| セル結合(手動+自動 rowSpan/colSpan) | ✅ |
|
|
40
|
+
| 行のドラッグ&ドロップ | ✅ |
|
|
41
|
+
| 変更追跡(`getChanges` / `getChangedColumns` / `getOriginalRow`) | ✅ |
|
|
42
|
+
| フッター集計(`setFooter`、`getFooterValue`、OGDecimal による精度保証) | ✅ |
|
|
43
|
+
| データマスキング(10 種類、セル/列単位の切り替え) | ✅ |
|
|
44
|
+
| ページネーション | ✅ |
|
|
45
|
+
| Excel / CSS テーマのエクスポート | ✅ |
|
|
46
|
+
| CSV / JSON エクスポート | ✅ |
|
|
47
|
+
| クリップボード(Ctrl+C / Ctrl+V) | ✅ |
|
|
48
|
+
| キーボード操作(矢印/Tab/F2/Esc) | ✅ |
|
|
49
|
+
| コアの依存ゼロ | ✅ |
|
|
50
|
+
|
|
51
|
+
### スプレッドシート級(v1.1)
|
|
52
|
+
|
|
53
|
+
| 機能 | 状態 |
|
|
54
|
+
|---|---|
|
|
55
|
+
| 範囲選択+フィル — セル範囲のドラッグ、連続データのフィル、TSV クリップボード、Ctrl+D/R(`rangeSelection`) | ✅ |
|
|
56
|
+
| マスター/ディテール — 行を展開して HTML パネルまたはサブグリッドを表示(`masterDetail`、`expandRow`) | ✅ |
|
|
57
|
+
| 数式セル — `=B1*C1`、`=SUM(C1:C10)`、19 個の関数、`[field]`/A1 参照、`#REF`/`#CYCLE` エラー(`formula`) | ✅ |
|
|
58
|
+
| 統合チャート — グリッドのデータから棒/折れ線を描画、LTTB ダウンサンプリング+サンプリングバッジ、組み込みの canvas レンダラー(`chart`) | ✅ |
|
|
59
|
+
|
|
60
|
+
### 書式とデータ(v1.3)
|
|
61
|
+
|
|
62
|
+
| 機能 | 状態 |
|
|
63
|
+
|---|---|
|
|
64
|
+
| 条件付き書式 — データバー、ヒートマップ、アイコンセット、ルールの優先順位 | ✅ |
|
|
65
|
+
| リアルタイムデータ — バックプレッシャー対応のストリーミング/ポーリングソース | ✅ |
|
|
66
|
+
| 外観の軸 — density と texture のセッター | ✅ |
|
|
67
|
+
|
|
68
|
+
### 見た目
|
|
69
|
+
|
|
70
|
+
| 機能 | 状態 |
|
|
71
|
+
|---|---|
|
|
72
|
+
| 15 種の組み込みテーマ(dark、ocean、forest、crimson、stitch、…) | ✅ |
|
|
73
|
+
| 6 種のスキン(色とは直交する形の軸)— sharp / rounded / stitch / flat / high-contrast / material | ✅ |
|
|
74
|
+
| 64 個のロールアイコン(Bootstrap Icons、MIT)— `renderIcon`、`grid.setIcon`、`OpenGrid.defineIconSet` | ✅ |
|
|
75
|
+
| ローカライズ/i18n(組み込みの `ko`・`en`、`setLocale`、カスタムロケール) | ✅ |
|
|
76
|
+
|
|
77
|
+
### 拡張性
|
|
78
|
+
|
|
79
|
+
| 機能 | 状態 |
|
|
80
|
+
|---|---|
|
|
81
|
+
| `grid.override(...)` — コアに手を入れずに挙動をカスタマイズ(AI フレンドリーなガイド付き) | ✅ |
|
|
82
|
+
| 拡張レジストリ — `added`/`replaced`/`kept`/`rejected` の結果を返す `TypedRegistry`、予約済み `og:` のガード、`protect-builtin` | ✅ |
|
|
83
|
+
| Vue 3 コンポーネント | ✅ |
|
|
84
|
+
| React 18 コンポーネント | ✅ |
|
|
85
|
+
|
|
86
|
+
## インストール
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
npm install open-grid
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
## クイックスタート
|
|
93
|
+
|
|
94
|
+
### Vanilla JavaScript / TypeScript
|
|
95
|
+
|
|
96
|
+
```typescript
|
|
97
|
+
import { OpenGrid } from 'open-grid';
|
|
98
|
+
import 'open-grid/style.css';
|
|
99
|
+
|
|
100
|
+
const grid = new OpenGrid('#container', {
|
|
101
|
+
columns: [
|
|
102
|
+
{ field: 'name', header: '이름', width: 120 },
|
|
103
|
+
{ field: 'price', header: '금액', width: 100, type: 'number', align: 'right' },
|
|
104
|
+
{ field: 'date', header: '날짜', width: 110, type: 'date' },
|
|
105
|
+
],
|
|
106
|
+
editable: true,
|
|
107
|
+
sortable: true,
|
|
108
|
+
rowNumber: true,
|
|
109
|
+
height: 500,
|
|
110
|
+
|
|
111
|
+
onReady: (g) => g.setData(myData),
|
|
112
|
+
onCellClick: (e) => console.log(e.field, e.value),
|
|
113
|
+
onEditEnd: (e) => console.log(e.oldValue, '→', e.newValue),
|
|
114
|
+
});
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
### Vue 3
|
|
118
|
+
|
|
119
|
+
```vue
|
|
120
|
+
<template>
|
|
121
|
+
<OpenGrid
|
|
122
|
+
:columns="columns"
|
|
123
|
+
:data="rows"
|
|
124
|
+
:editable="true"
|
|
125
|
+
:sortable="true"
|
|
126
|
+
:height="500"
|
|
127
|
+
@cell-click="onCellClick"
|
|
128
|
+
@edit-end="onEditEnd"
|
|
129
|
+
@update:data="rows = $event"
|
|
130
|
+
/>
|
|
131
|
+
</template>
|
|
132
|
+
|
|
133
|
+
<script setup lang="ts">
|
|
134
|
+
import { ref } from 'vue';
|
|
135
|
+
import { OpenGrid } from 'open-grid/vue';
|
|
136
|
+
import 'open-grid/style.css';
|
|
137
|
+
|
|
138
|
+
const columns = [
|
|
139
|
+
{ field: 'name', header: '이름', width: 120 },
|
|
140
|
+
{ field: 'price', header: '금액', width: 100, type: 'number', align: 'right' },
|
|
141
|
+
];
|
|
142
|
+
const rows = ref(myData);
|
|
143
|
+
</script>
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### React 18
|
|
147
|
+
|
|
148
|
+
```tsx
|
|
149
|
+
import { OpenGrid } from 'open-grid/react';
|
|
150
|
+
import 'open-grid/style.css';
|
|
151
|
+
|
|
152
|
+
function App() {
|
|
153
|
+
const [data, setData] = useState(myData);
|
|
154
|
+
const gridRef = useRef(null);
|
|
155
|
+
|
|
156
|
+
return (
|
|
157
|
+
<OpenGrid
|
|
158
|
+
columns={columns}
|
|
159
|
+
data={data}
|
|
160
|
+
editable sortable
|
|
161
|
+
height={500}
|
|
162
|
+
onReady={(g) => { gridRef.current = g; }}
|
|
163
|
+
onDataChange={setData}
|
|
164
|
+
/>
|
|
165
|
+
);
|
|
166
|
+
}
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
## API リファレンス
|
|
170
|
+
|
|
171
|
+
### コンストラクター
|
|
172
|
+
|
|
173
|
+
```typescript
|
|
174
|
+
new OpenGrid(container: string | HTMLElement, options: GridOptions)
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
### データ API
|
|
178
|
+
|
|
179
|
+
| メソッド | 説明 |
|
|
180
|
+
|---|---|
|
|
181
|
+
| `setData(data)` | データの設定。 |
|
|
182
|
+
| `getData()` | 現在表示中のデータを返す。 |
|
|
183
|
+
| `insertRow(item, position?)` | 行の追加(`'first'` / `'last'` / インデックス)。 |
|
|
184
|
+
| `deleteRow(rowIndex)` | 行の削除(ソフトデリート)。 |
|
|
185
|
+
| `pushRow(items)` | 末尾に行を追加。 |
|
|
186
|
+
| `unshiftRow(items)` | 先頭に行を追加。 |
|
|
187
|
+
| `readCell(rowIndex, field)` | セル値の読み取り。 |
|
|
188
|
+
| `writeCell(rowIndex, field, value)` | セル値の書き込み。 |
|
|
189
|
+
| `reorderRow(from, to)` | 行の順序を移動。 |
|
|
190
|
+
|
|
191
|
+
### 変更追跡 API(v0.1.2)
|
|
192
|
+
|
|
193
|
+
| メソッド | 説明 |
|
|
194
|
+
|---|---|
|
|
195
|
+
| `getChanges()` | `{ added, edited, removed }` をまとめて返す。edited の行には `_changedFields` を含む。 |
|
|
196
|
+
| `getEditedRows()` | 修正された行のみを返す。 |
|
|
197
|
+
| `getAddedRows()` | 追加された行を返す。 |
|
|
198
|
+
| `getRemovedRows()` | 削除された行を返す。 |
|
|
199
|
+
| `getChangedColumns()` | `{ row, fields, diff[] }` — 列単位の diff(oldValue/newValue)。 |
|
|
200
|
+
| `getOriginalRow(rowIndex)` | 修正前の元の行データを返す。 |
|
|
201
|
+
|
|
202
|
+
### フッター/小計 API(v0.1.2)
|
|
203
|
+
|
|
204
|
+
| メソッド | 説明 |
|
|
205
|
+
|---|---|
|
|
206
|
+
| `setFooter(FooterDef[])` | フッター集計の設定(SUM/AVG/MIN/MAX/COUNT、colspan、format)。 |
|
|
207
|
+
| `getFooterValue(field)` | 特定フィールドの集計結果を取得。 |
|
|
208
|
+
| `getFooterData()` | フッター集計データ全体を配列で返す。 |
|
|
209
|
+
|
|
210
|
+
```typescript
|
|
211
|
+
grid.setFooter([
|
|
212
|
+
{ label: '합계', colspan: 2, align: 'left' },
|
|
213
|
+
{ field: 'salary', op: 'SUM', format: '#,##0', align: 'right' },
|
|
214
|
+
{ field: 'rate', op: 'SUM', format: '#,##0.00', align: 'right' }, // OGDecimal 정밀계산
|
|
215
|
+
{ field: 'score', op: 'AVG', format: '#,##0.0', align: 'right' },
|
|
216
|
+
]);
|
|
217
|
+
|
|
218
|
+
const total = grid.getFooterValue('salary'); // 숫자 반환
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
### 列並べ替え API(v0.1.1)
|
|
222
|
+
|
|
223
|
+
```typescript
|
|
224
|
+
const grid = new OpenGrid('#container', {
|
|
225
|
+
columns,
|
|
226
|
+
columnReorder: true, // 헤더 드래그 활성화
|
|
227
|
+
onColumnReorder: ({ fromIndex, toIndex, field }) => {
|
|
228
|
+
console.log(`컬럼 이동: ${fromIndex} → ${toIndex} (${field})`);
|
|
229
|
+
},
|
|
230
|
+
});
|
|
231
|
+
|
|
232
|
+
grid.applyColumns([...originalColumns]); // 원래 순서로 복원
|
|
233
|
+
```
|
|
234
|
+
|
|
235
|
+
### ソート/フィルター
|
|
236
|
+
|
|
237
|
+
| メソッド | 説明 |
|
|
238
|
+
|---|---|
|
|
239
|
+
| `orderBy(field, dir?)` | ソート。 |
|
|
240
|
+
| `resetOrder()` | ソートの初期化。 |
|
|
241
|
+
| `setFilter(field, items)` | フィルターの設定。 |
|
|
242
|
+
| `resetFilter(field?)` | フィルターの初期化。 |
|
|
243
|
+
|
|
244
|
+
### グルーピング
|
|
245
|
+
|
|
246
|
+
| メソッド | 説明 |
|
|
247
|
+
|---|---|
|
|
248
|
+
| `groupBy(fields[])` | グループの設定。 |
|
|
249
|
+
| `clearGroup()` | グループの解除。 |
|
|
250
|
+
| `expandAll()` | すべて展開。 |
|
|
251
|
+
| `collapseAll()` | すべて折りたたみ。 |
|
|
252
|
+
|
|
253
|
+
### ツリーグリッド
|
|
254
|
+
|
|
255
|
+
| メソッド | 説明 |
|
|
256
|
+
|---|---|
|
|
257
|
+
| `enableTree()` | ツリーモードの有効化。 |
|
|
258
|
+
| `disableTree()` | ツリーモードの無効化。 |
|
|
259
|
+
| `expandNodes(ids, open?)` | 特定ノードの展開/折りたたみ。 |
|
|
260
|
+
| `expandAllNodes()` | すべて展開。 |
|
|
261
|
+
| `collapseAllNodes()` | すべて折りたたみ。 |
|
|
262
|
+
|
|
263
|
+
### セル結合
|
|
264
|
+
|
|
265
|
+
| メソッド | 説明 |
|
|
266
|
+
|---|---|
|
|
267
|
+
| `mergeCells(cells)` | 手動結合 `[{row, col, rowSpan?, colSpan?}]`。 |
|
|
268
|
+
| `autoMerge(fields[])` | 連続する同じ値を自動で rowSpan。 |
|
|
269
|
+
| `clearMerge()` | 結合の解除。 |
|
|
270
|
+
|
|
271
|
+
### エクスポート
|
|
272
|
+
|
|
273
|
+
| メソッド | 説明 |
|
|
274
|
+
|---|---|
|
|
275
|
+
| `exportExcel(options?)` | Excel(.xlsx)の書き出し。 |
|
|
276
|
+
| `exportCsv(options?)` | CSV の書き出し。 |
|
|
277
|
+
| `exportJson(options?)` | JSON の書き出し。 |
|
|
278
|
+
|
|
279
|
+
### UI
|
|
280
|
+
|
|
281
|
+
| メソッド | 説明 |
|
|
282
|
+
|---|---|
|
|
283
|
+
| `jumpToRow(rowIndex)` | 特定の行までスクロール。 |
|
|
284
|
+
| `setTheme(theme)` | テーマの変更(`'default'` / `'dark'`)。 |
|
|
285
|
+
| `resize(w?, h?)` | サイズの調整。 |
|
|
286
|
+
| `destroy()` | インスタンスの破棄。 |
|
|
287
|
+
|
|
288
|
+
## GridOptions
|
|
289
|
+
|
|
290
|
+
```typescript
|
|
291
|
+
interface GridOptions {
|
|
292
|
+
columns: ColumnDef[]; // 컬럼 정의 (필수)
|
|
293
|
+
height?: number | string; // 그리드 높이 (기본: '100%')
|
|
294
|
+
width?: number | string; // 그리드 너비 (기본: '100%')
|
|
295
|
+
editable?: boolean; // 인라인 편집 활성화
|
|
296
|
+
editMode?: 'click' | 'dblclick'; // 편집 진입 방식
|
|
297
|
+
sortable?: boolean; // 정렬 활성화
|
|
298
|
+
multiSort?: boolean; // 멀티소트 (Shift+클릭)
|
|
299
|
+
filterable?: boolean; // 필터 UI 활성화
|
|
300
|
+
rowNumber?: boolean; // 행 번호 컬럼
|
|
301
|
+
checkColumn?: boolean; // 체크박스 컬럼
|
|
302
|
+
stateColumn?: boolean; // 상태 표시 컬럼 (✚/✎/✖)
|
|
303
|
+
frozenColumns?: number; // 고정 컬럼 수
|
|
304
|
+
selection?: 'single' | 'multiple' | 'row';
|
|
305
|
+
clipboard?: boolean; // Ctrl+C/V 클립보드
|
|
306
|
+
draggable?: boolean; // 행 드래그앤드롭
|
|
307
|
+
pagination?: boolean; // 페이징 UI
|
|
308
|
+
pageSize?: number; // 페이지당 행 수
|
|
309
|
+
treeId?: string; // 트리 id 필드명 (기본: 'id')
|
|
310
|
+
treeParentId?: string; // 트리 parentId 필드명 (기본: 'parentId')
|
|
311
|
+
expandOnLoad?: boolean; // 트리 초기 전체 펼침
|
|
312
|
+
summary?: SummaryOptions; // 그룹 소계 설정
|
|
313
|
+
theme?: 'default' | 'dark';
|
|
314
|
+
defaultSort?: SortItem[]; // 초기 정렬
|
|
315
|
+
|
|
316
|
+
// 이벤트 콜백
|
|
317
|
+
onReady?: (grid: OpenGridInstance) => void;
|
|
318
|
+
onCellClick?: (e: CellEvent) => void;
|
|
319
|
+
onCellDblClick?: (e: CellEvent) => void;
|
|
320
|
+
onRowClick?: (e: RowEvent) => void;
|
|
321
|
+
onEditStart?: (e: EditEvent) => void;
|
|
322
|
+
onEditEnd?: (e: EditEvent) => void;
|
|
323
|
+
onSortChange?: (e: SortEvent) => void;
|
|
324
|
+
onFilterChange?: (e: FilterEvent) => void;
|
|
325
|
+
onDataChange?: (data: any[]) => void;
|
|
326
|
+
onSelectionChange?: (e: SelectionEvent) => void;
|
|
327
|
+
onRowDrop?: (e: { fromIndex: number; toIndex: number }) => void;
|
|
328
|
+
onPageChange?: (e: PageEvent) => void;
|
|
329
|
+
// v0.1.1+
|
|
330
|
+
columnReorder?: boolean; // 헤더 드래그 컬럼 순서 변경
|
|
331
|
+
onColumnReorder?: (e: { fromIndex: number; toIndex: number; field: string }) => void;
|
|
332
|
+
// v0.1.2+
|
|
333
|
+
footer?: FooterDef[]; // 초기 푸터 설정
|
|
334
|
+
}
|
|
335
|
+
```
|
|
336
|
+
|
|
337
|
+
## ColumnDef
|
|
338
|
+
|
|
339
|
+
```typescript
|
|
340
|
+
interface ColumnDef {
|
|
341
|
+
field: string; // 데이터 필드명 (필수)
|
|
342
|
+
header?: string; // 헤더 텍스트
|
|
343
|
+
width?: number; // 컬럼 너비 (px)
|
|
344
|
+
type?: 'text' | 'number' | 'date' | 'checkbox' | 'button' | 'badge' | 'link' | 'template';
|
|
345
|
+
align?: 'left' | 'center' | 'right';
|
|
346
|
+
editable?: boolean | ((row, rowIndex) => boolean);
|
|
347
|
+
sortable?: boolean;
|
|
348
|
+
filterable?: boolean;
|
|
349
|
+
resizable?: boolean;
|
|
350
|
+
hidden?: boolean;
|
|
351
|
+
format?: string; // 숫자 포맷 (예: '#,##0')
|
|
352
|
+
children?: ColumnDef[]; // 그룹 헤더
|
|
353
|
+
cellStyle?: CSSProperties | ((value, row, rowIndex) => CSSProperties);
|
|
354
|
+
renderer?: (ctx: RenderContext) => HTMLElement;
|
|
355
|
+
}
|
|
356
|
+
```
|
|
357
|
+
|
|
358
|
+
## パフォーマンス
|
|
359
|
+
|
|
360
|
+
10 万行を対象としたベンチマーク結果です。
|
|
361
|
+
|
|
362
|
+
| 処理 | 時間 |
|
|
363
|
+
|---|---|
|
|
364
|
+
| データ生成 | ~65ms |
|
|
365
|
+
| setData() | ~30ms |
|
|
366
|
+
| applySort(単一) | ~38ms |
|
|
367
|
+
| applySort(マルチ) | ~40ms |
|
|
368
|
+
| applyFilter | ~17ms |
|
|
369
|
+
| buildGroups | ~3ms |
|
|
370
|
+
| buildTree | ~25ms |
|
|
371
|
+
|
|
372
|
+
## CSS カスタマイズ
|
|
373
|
+
|
|
374
|
+
CSS 変数でテーマを完全にカスタマイズできます。
|
|
375
|
+
|
|
376
|
+
```css
|
|
377
|
+
.og-container {
|
|
378
|
+
--og-primary: #1976d2;
|
|
379
|
+
--og-header-bg: #f5f5f5;
|
|
380
|
+
--og-row-bg: #ffffff;
|
|
381
|
+
--og-row-alt-bg: #fafafa;
|
|
382
|
+
--og-row-selected-bg: #bbdefb;
|
|
383
|
+
--og-border-color: #e0e0e0;
|
|
384
|
+
--og-font-size: 13px;
|
|
385
|
+
--og-group-bg: #e8eaf6;
|
|
386
|
+
--og-tree-toggle-color: #1976d2;
|
|
387
|
+
}
|
|
388
|
+
```
|
|
389
|
+
|
|
390
|
+
## ローカライズ(i18n)
|
|
391
|
+
|
|
392
|
+
組み込み UI の文字列 — ラベル、`aria-label`、ライブリージョンのアナウンス、ツールチップ、
|
|
393
|
+
プレースホルダー — はすべて、コアから切り離した差し替え可能なロケールカタログに置いています。
|
|
394
|
+
**`ko`(既定)と `en`** を同梱します。既存アプリへの影響はありません。`locale`/`messages` オプションを
|
|
395
|
+
指定しなければ、出力は従来とバイト単位で同一です。
|
|
396
|
+
|
|
397
|
+
```ts
|
|
398
|
+
import { OpenGrid, localeRegistry } from 'open-grid';
|
|
399
|
+
|
|
400
|
+
// 1) Pick a built-in locale per instance
|
|
401
|
+
const grid = new OpenGrid(el, { columns, locale: 'en' });
|
|
402
|
+
|
|
403
|
+
// 2) Switch at runtime (re-labels chrome, updates the `lang` attribute, emits `localeChange`)
|
|
404
|
+
grid.setLocale('ko');
|
|
405
|
+
|
|
406
|
+
// 3) Override just a few messages for one instance
|
|
407
|
+
new OpenGrid(el, { locale: 'en', messages: { contextMenu: { sortAsc: 'Sort A→Z' } } });
|
|
408
|
+
|
|
409
|
+
// 4) Register a custom locale globally (partial dictionaries are fine — missing keys fall back)
|
|
410
|
+
localeRegistry.register('ja', { contextMenu: { find: '検索' }, pagination: { rowsPerPage: '行/ページ:' } });
|
|
411
|
+
new OpenGrid(el, { locale: 'ja' });
|
|
412
|
+
```
|
|
413
|
+
|
|
414
|
+
フォールバックの流れ: インスタンスの上書き → 有効なロケール → `ko`(完全なカタログ) → 生のキー。
|
|
415
|
+
数値・日付の書式と開発者向けのエラーメッセージは、意図的に対象外としています
|
|
416
|
+
(書式は `Intl` を使い、ログは grep で追える形のまま保ちます)。キーの全リファレンスは
|
|
417
|
+
[ローカライズガイド](https://foxnail.kr/open-grid/demo/v2/guide/index.php) をご覧ください。
|
|
418
|
+
|
|
419
|
+
## 変更履歴
|
|
420
|
+
|
|
421
|
+
リリースの全履歴は [`CHANGELOG.md`](CHANGELOG.md) をご覧ください。
|
|
422
|
+
|
|
423
|
+
最近の主なトピック:
|
|
424
|
+
|
|
425
|
+
- **1.4.0** — 拡張レジストリを公開(`TypedRegistry`、予約ネームスペースのガード)。
|
|
426
|
+
公開 API の JSDoc を韓国語・英語・日本語・中国語の 4 言語に。
|
|
427
|
+
- **1.3.1** — 公開 API の JSDoc を人が読んで分かる形に書き直し(コメントのみ、ロジックの変更なし)。
|
|
428
|
+
- **1.3.0** — 条件付き書式、統合チャートのサブシステム、リアルタイムデータソース、
|
|
429
|
+
外観の軸(density/texture)。
|
|
430
|
+
- **1.2.0** — ロケールリソースを分離した国際化対応(`LocaleRegistry`)。
|
|
431
|
+
- **1.1.0** — 範囲選択+フィル、マスター/ディテール、数式セル、統合チャート。
|
|
432
|
+
- **1.0.0** — `grid.override()` によるカスタマイズ面。
|
|
433
|
+
|
|
434
|
+
## ライセンス
|
|
435
|
+
|
|
436
|
+
MIT © OPEN_GRID Contributors
|
|
437
|
+
|
|
438
|
+
### ランタイム依存ゼロ(Excel 出力はそのまま動きます)
|
|
439
|
+
|
|
440
|
+
`npm install open-grid` が引き込む**外部ランタイム依存はありません**。グリッドのコアは
|
|
441
|
+
完全に自己完結しています。
|
|
442
|
+
|
|
443
|
+
**Excel エクスポートは追加インストールなしで、そのまま動きます。** これは SheetJS
|
|
444
|
+
(`xlsx-js-style`)を使っており、**パッケージの中(`dist/` 配下)にバンドル済み**で、実際に
|
|
445
|
+
エクスポートするときだけオンデマンドで読み込まれます。`xlsx`/`xlsx-js-style` をプロジェクトに
|
|
446
|
+
追加する必要は**ありません** — OPEN_GRID の中に同梱されています。(`devDependencies` に載っているのは、
|
|
447
|
+
バンドルを*ビルドする*ために必要だからであって、*使う*ために必要だからではありません。)
|
|
448
|
+
|
|
449
|
+
### サードパーティライセンス
|
|
450
|
+
|
|
451
|
+
同梱の Excel エクスポートは **SheetJS Community Edition(`xlsx`)** と
|
|
452
|
+
**`xlsx-js-style`** を使用しており、いずれも **Apache License, Version 2.0** の下で
|
|
453
|
+
ライセンスされています(© SheetJS LLC、およびスタイル版フォークについては Brent Ely)。
|
|
454
|
+
これらの attribution notice とライセンス全文は [`NOTICE`](NOTICE) と
|
|
455
|
+
[`THIRD_PARTY_LICENSES.txt`](THIRD_PARTY_LICENSES.txt) に収録しています。
|
|
456
|
+
|
|
457
|
+
> **1.0.2 以降**、この `NOTICE` と `THIRD_PARTY_LICENSES.txt` は、同梱コンポーネントに対する
|
|
458
|
+
> Apache-2.0 の attribution 要件を満たすため、公開パッケージの中に同梱して配布しています。
|
|
459
|
+
> これにより、以前のリリース(1.0.1 以下)にあったライセンスコンプライアンス上の潜在的な
|
|
460
|
+
> 不備 — MIT ライセンスのみを同梱し、必要な Apache-2.0 の notice を欠いていた点 — を解消しました。
|
|
461
|
+
> OPEN_GRID 自身の MIT ライセンスに変更はありません。MIT と Apache-2.0 は互換性があるため、
|
|
462
|
+
> これは attribution の修正のみです。詳細は [`CHANGELOG.md`](CHANGELOG.md) をご覧ください。
|