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.
Files changed (67) hide show
  1. package/CHANGELOG.md +77 -0
  2. package/README.ja.md +462 -0
  3. package/README.md +70 -19
  4. package/README.zh.md +455 -0
  5. package/dist/{OpenGrid-B7m7ei7f.cjs → OpenGrid-CT9bV6On.cjs} +7 -7
  6. package/dist/OpenGrid-CT9bV6On.cjs.map +1 -0
  7. package/dist/{OpenGrid-CeUdO_fM.js → OpenGrid-DACnZdEy.js} +7 -7
  8. package/dist/OpenGrid-DACnZdEy.js.map +1 -0
  9. package/dist/Registry-CPJYOqCn.js +74 -0
  10. package/dist/Registry-CPJYOqCn.js.map +1 -0
  11. package/dist/Registry-D74ZmdDz.cjs +71 -0
  12. package/dist/Registry-D74ZmdDz.cjs.map +1 -0
  13. package/dist/{index-JjfWY3Bt.cjs → index-Brfso4Ry.cjs} +92 -160
  14. package/dist/index-Brfso4Ry.cjs.map +1 -0
  15. package/dist/index-CeJ-0-80.cjs.map +1 -0
  16. package/dist/index-DnarQ4eR.js.map +1 -0
  17. package/dist/index-al9Mbv3E.js +481 -0
  18. package/dist/index-al9Mbv3E.js.map +1 -0
  19. package/dist/open-grid-base.css +98 -35
  20. package/dist/open-grid-header.cjs +188 -0
  21. package/dist/open-grid-header.cjs.map +1 -0
  22. package/dist/open-grid-header.css +386 -0
  23. package/dist/open-grid-header.js +197 -0
  24. package/dist/open-grid-header.js.map +1 -0
  25. package/dist/open-grid-react.cjs +1 -1
  26. package/dist/open-grid-react.cjs.map +1 -0
  27. package/dist/open-grid-react.js +1 -1
  28. package/dist/open-grid-react.js.map +1 -0
  29. package/dist/open-grid-themes.css +774 -1
  30. package/dist/open-grid-typography.cjs +97 -0
  31. package/dist/open-grid-typography.cjs.map +1 -0
  32. package/dist/open-grid-typography.css +181 -0
  33. package/dist/open-grid-typography.js +105 -0
  34. package/dist/open-grid-typography.js.map +1 -0
  35. package/dist/open-grid-vue.cjs +1 -1
  36. package/dist/open-grid-vue.cjs.map +1 -0
  37. package/dist/open-grid-vue.js +1 -1
  38. package/dist/open-grid-vue.js.map +1 -0
  39. package/dist/open-grid.cjs +31 -31
  40. package/dist/open-grid.cjs.map +1 -0
  41. package/dist/open-grid.js +86 -82
  42. package/dist/open-grid.js.map +1 -0
  43. package/dist/types/core/FilterSelect.d.ts +269 -33
  44. package/dist/types/core/GridShuttle.d.ts +160 -24
  45. package/dist/types/core/IconRegistry.d.ts +241 -33
  46. package/dist/types/core/OpenGrid.d.ts +2589 -327
  47. package/dist/types/core/OrgChart.d.ts +249 -32
  48. package/dist/types/core/SkinRegistry.d.ts +295 -60
  49. package/dist/types/core/XmlConverter.d.ts +388 -47
  50. package/dist/types/core/appearance/AppearanceAxis.d.ts +1 -1
  51. package/dist/types/core/appearance/HeaderRegistry.d.ts +236 -0
  52. package/dist/types/core/appearance/ThemeMetaRegistry.d.ts +1 -1
  53. package/dist/types/core/appearance/TypographyRegistry.d.ts +122 -0
  54. package/dist/types/core/appearance/index.d.ts +1 -0
  55. package/dist/types/core/chart/types.d.ts +1008 -126
  56. package/dist/types/core/extension/Registry.d.ts +389 -51
  57. package/dist/types/core/extension/reserved.d.ts +34 -5
  58. package/dist/types/core/i18n/LocaleRegistry.d.ts +271 -54
  59. package/dist/types/core/i18n/types.d.ts +636 -85
  60. package/dist/types/core/types.d.ts +3576 -426
  61. package/dist/types/header/index.d.ts +144 -0
  62. package/dist/types/index.d.ts +226 -17
  63. package/dist/types/typography/index.d.ts +128 -0
  64. package/dist/xlsx.min-BQ1o3sB6.cjs.map +1 -0
  65. package/dist/xlsx.min-Bbz2ZypC.js.map +1 -0
  66. package/package.json +126 -112
  67. package/dist/index-DrCPRuYi.js +0 -548
@@ -1,17 +1,61 @@
1
1
  import { FilterItem } from './types.js';
2
- /** i18n: 필터 셀렉트 라벨 해석기(주입 없으면 전역 t). / i18n: filter-select label resolver (global t when not injected). */
2
+ /**
3
+ * i18n: 필터 셀렉트 라벨 해석기(주입 없으면 전역 t).
4
+ *
5
+ * i18n: filter-select label resolver (global t when not injected).
6
+ *
7
+ * i18n: フィルターセレクトのラベル解決関数(注入されない場合はグローバルの t)。
8
+ *
9
+ * i18n: 筛选选择的标签解析函数(未注入时使用全局 t)。
10
+ */
3
11
  export type FilterSelectT = (key: string, params?: Record<string, string | number>) => string;
4
- /** 필터 셀렉트 옵션(값/표시 텍스트). / Filter-select option (value/display text). */
12
+ /**
13
+ * 필터 셀렉트 옵션(값/표시 텍스트).
14
+ *
15
+ * Filter-select option (value/display text).
16
+ *
17
+ * フィルターセレクトのオプション(値/表示テキスト)。
18
+ *
19
+ * 筛选选择的选项(值/显示文本)。
20
+ */
5
21
  export interface FilterSelectOption {
6
- /** 필터·선택에 사용할 값. / Value used for filtering/selection. */
22
+ /**
23
+ * 필터·선택에 사용할 값.
24
+ *
25
+ * Value used for filtering/selection.
26
+ *
27
+ * フィルター・選択に使用する値。
28
+ *
29
+ * 用于筛选/选择的值。
30
+ */
7
31
  value: string;
8
- /** 화면에 표시할 텍스트. / Text shown on screen. */
32
+ /**
33
+ * 화면에 표시할 텍스트.
34
+ *
35
+ * Text shown on screen.
36
+ *
37
+ * 画面に表示するテキスト。
38
+ *
39
+ * 显示在界面上的文本。
40
+ */
9
41
  text: string;
10
42
  }
11
43
  /**
12
- * 캐스케이딩 필터 셀렉트 컬럼 정의. / Cascading filter-select column definition.
44
+ * 캐스케이딩 필터 셀렉트 컬럼 정의.
45
+ *
46
+ * Cascading filter-select column definition.
47
+ *
48
+ * カスケーディングフィルターセレクトの列定義。
49
+ *
50
+ * 级联筛选选择的列定义。
51
+ *
52
+ * ### 데이터 공급 방식 (택 1)
53
+ *
54
+ * ### Data supply (pick one)
55
+ *
56
+ * ### データの供給方法(いずれか 1 つ)
13
57
  *
14
- * ### 데이터 공급 방식 (택 1) / Data supply (pick one)
58
+ * ### 数据供给方式(任选其一)
15
59
  *
16
60
  * **A. JSON 배열 바인딩** (권장)
17
61
  * ```ts
@@ -33,31 +77,98 @@ export interface FilterSelectOption {
33
77
  * ```
34
78
  */
35
79
  export interface FilterSelectColumn {
36
- /** 캐스케이딩 식별자 / 기본 필터 키. / Cascading identifier / default filter key. */
80
+ /**
81
+ * 캐스케이딩 식별자 / 기본 필터 키.
82
+ *
83
+ * Cascading identifier / default filter key.
84
+ *
85
+ * カスケーディング識別子 / デフォルトのフィルターキー。
86
+ *
87
+ * 级联标识符 / 默认筛选键。
88
+ */
37
89
  field: string;
38
- /** 화면 표시 라벨. / Display label. */
90
+ /**
91
+ * 화면 표시 라벨.
92
+ *
93
+ * Display label.
94
+ *
95
+ * 画面表示ラベル。
96
+ *
97
+ * 界面显示标签。
98
+ */
39
99
  label: string;
40
- /** 바인딩할 JSON 배열. / JSON array to bind. */
100
+ /**
101
+ * 바인딩할 JSON 배열.
102
+ *
103
+ * JSON array to bind.
104
+ *
105
+ * バインドする JSON 配列。
106
+ *
107
+ * 待绑定的 JSON 数组。
108
+ */
41
109
  data?: any[];
42
- /** data[] 에서 option value 로 사용할 키. / Key in data[] used as the option value. */
110
+ /**
111
+ * data[] 에서 option value 로 사용할 키.
112
+ *
113
+ * Key in data[] used as the option value.
114
+ *
115
+ * data[] で option value として使用するキー。
116
+ *
117
+ * data[] 中用作 option value 的键。
118
+ */
43
119
  valueKey?: string;
44
- /** data[] 에서 화면 표시 text 로 사용할 키(미지정 시 valueKey 사용). / Key in data[] used as display text (falls back to valueKey). */
120
+ /**
121
+ * data[] 에서 화면 표시 text 로 사용할 키(미지정 시 valueKey 사용).
122
+ *
123
+ * Key in data[] used as display text (falls back to valueKey).
124
+ *
125
+ * data[] で画面表示 text として使用するキー(未指定の場合は valueKey を使用)。
126
+ *
127
+ * data[] 中用作界面显示 text 的键(未指定时使用 valueKey)。
128
+ */
45
129
  textKey?: string;
46
130
  /**
47
131
  * 그리드 행 데이터에서 실제 필터링할 키. 미지정 시 `field` 값 그대로 사용.
48
- * / Key actually filtered against grid row data; falls back to `field`.
132
+ *
133
+ * Key actually filtered against grid row data; falls back to `field`.
134
+ *
135
+ * グリッドの行データで実際にフィルタリングするキー。未指定の場合は `field` の値をそのまま使用します。
136
+ *
137
+ * 在表格行数据中实际用于筛选的键。未指定时直接使用 `field` 的值。
49
138
  *
50
139
  * @example
51
- * // 그리드 row.category === selectedValue 로 필터링 / filter where row.category === selectedValue
140
+ * // filter where row.category === selectedValue
52
141
  * filterKey: 'category'
53
142
  */
54
143
  filterKey?: string;
55
- /** 정적 옵션 배열(data 대신 사용). / Static option array (used instead of data). */
144
+ /**
145
+ * 정적 옵션 배열(data 대신 사용).
146
+ *
147
+ * Static option array (used instead of data).
148
+ *
149
+ * 静的オプション配列(data の代わりに使用)。
150
+ *
151
+ * 静态选项数组(代替 data 使用)。
152
+ */
56
153
  options?: FilterSelectOption[];
57
- /** 부모 컬럼의 field 명. / Parent column's field name. */
154
+ /**
155
+ * 부모 컬럼의 field 명.
156
+ *
157
+ * Parent column's field name.
158
+ *
159
+ * 親列の field 名。
160
+ *
161
+ * 父列的 field 名。
162
+ */
58
163
  dependsOn?: string;
59
164
  /**
60
- * 자식 data[] 에서 부모 선택값과 비교할 키. / Key in the child data[] compared against the parent's selected value.
165
+ * 자식 data[] 에서 부모 선택값과 비교할 키.
166
+ *
167
+ * Key in the child data[] compared against the parent's selected value.
168
+ *
169
+ * 子の data[] で親の選択値と比較するキー。
170
+ *
171
+ * 子 data[] 中与父级选中值比较的键。
61
172
  *
62
173
  * @example
63
174
  * // brandList.filter(b => b.catCode === parentSelectedValue)
@@ -65,17 +176,47 @@ export interface FilterSelectColumn {
65
176
  */
66
177
  dependsOnKey?: string;
67
178
  }
68
- /** 필터 셀렉트 패널 구성. / Filter-select panel configuration. */
179
+ /**
180
+ * 필터 셀렉트 패널 구성.
181
+ *
182
+ * Filter-select panel configuration.
183
+ *
184
+ * フィルターセレクトパネルの構成。
185
+ *
186
+ * 筛选选择面板的配置。
187
+ */
69
188
  export interface FilterSelectConfig {
70
- /** 캐스케이딩 컬럼 정의 배열. / Cascading column definitions. */
189
+ /**
190
+ * 캐스케이딩 컬럼 정의 배열.
191
+ *
192
+ * Cascading column definitions.
193
+ *
194
+ * カスケーディング列定義の配列。
195
+ *
196
+ * 级联列定义数组。
197
+ */
71
198
  columns: FilterSelectColumn[];
72
- /** fieldset 제목(기본: 로케일 'filter.legend'). / fieldset legend (default: locale 'filter.legend'). */
199
+ /**
200
+ * fieldset 제목(기본: 로케일 'filter.legend').
201
+ *
202
+ * fieldset legend (default: locale 'filter.legend').
203
+ *
204
+ * fieldset の見出し(デフォルト: ロケールの 'filter.legend')。
205
+ *
206
+ * fieldset 的标题(默认: 区域设置的 'filter.legend')。
207
+ */
73
208
  legend?: string;
74
209
  }
75
210
  type FilterFn = (field: string, items: FilterItem[]) => void;
76
211
  type ResetFn = (field?: string) => void;
77
212
  /**
78
- * 캐스케이딩 필터 셀렉트 패널. / Cascading filter-select panel.
213
+ * 캐스케이딩 필터 셀렉트 패널.
214
+ *
215
+ * Cascading filter-select panel.
216
+ *
217
+ * カスケーディングフィルターセレクトパネル。
218
+ *
219
+ * 级联筛选选择面板。
79
220
  *
80
221
  * "카테고리를 고르면 브랜드 목록이 그 카테고리에 맞게 좁혀지는" 것처럼, 상위 셀렉트의 선택에
81
222
  * 따라 하위 셀렉트의 옵션이 자동으로 걸러지는 드롭다운 필터 묶음이 필요할 때 쓴다. 그리드
@@ -83,7 +224,8 @@ type ResetFn = (field?: string) => void;
83
224
  * 필터 콜백(onFilter/onReset)을 호출해 그리드를 걸러내고 → 종속된 자식 셀렉트의 옵션 목록을
84
225
  * 새 부모값 기준으로 다시 계산해 넣는다(재귀적으로 손자 셀렉트까지 전파).
85
226
  * 보통 직접 생성자를 호출하기보다 `grid.setFilterSelect(config)`를 통해 그리드에 붙인다.
86
- * / Use this when you need a group of dropdown filters where picking a value in a parent select
227
+ *
228
+ * Use this when you need a group of dropdown filters where picking a value in a parent select
87
229
  * narrows the options in a child select — e.g. picking a category narrows the brand list. It's
88
230
  * inserted as a fieldset ahead of the grid header. Operation order: the user changes a select →
89
231
  * internally the grid filter callbacks (onFilter/onReset) run to filter the grid → then the
@@ -91,8 +233,22 @@ type ResetFn = (field?: string) => void;
91
233
  * to grandchild selects). Usually attached via `grid.setFilterSelect(config)` rather than by
92
234
  * calling the constructor directly.
93
235
  *
236
+ * 「カテゴリーを選ぶとブランドの一覧がそのカテゴリーに合わせて絞り込まれる」ように、上位セレクトの
237
+ * 選択に応じて下位セレクトのオプションが自動的に絞り込まれるドロップダウンフィルターのまとまりが
238
+ * 必要なときに使います。グリッドヘッダーの前に fieldset の形で挿入されます。動作順序: ユーザーが
239
+ * セレクトを変更すると → 内部でグリッドのフィルターコールバック(onFilter/onReset)を呼び出して
240
+ * グリッドを絞り込み → 従属する子セレクトのオプション一覧を新しい親の値を基準に再計算して入れます
241
+ * (再帰的に孫セレクトまで伝播)。通常はコンストラクターを直接呼び出すよりも
242
+ * `grid.setFilterSelect(config)` を通じてグリッドに取り付けます。
243
+ *
244
+ * 当需要这样一组下拉筛选时使用: 上级下拉选中某个值后,下级下拉的选项自动随之收窄 —— 例如
245
+ * 选中类别后,品牌列表就缩小到该类别之内。面板以 fieldset 的形式插入在表格表头之前。执行顺序:
246
+ * 用户改变某个下拉 → 内部调用表格筛选回调(onFilter/onReset)筛选表格 → 再以新的父级值重新
247
+ * 计算从属子下拉的选项一览(递归传播到孙级下拉)。通常不直接调用构造函数,而是通过
248
+ * `grid.setFilterSelect(config)` 挂载到表格上。
249
+ *
94
250
  * @example
95
- * // 보통 이렇게 그리드를 통해 사용한다 / Typically wired through the grid like this:
251
+ * // Typically wired through the grid like this:
96
252
  * grid.setFilterSelect({
97
253
  * columns: [
98
254
  * { field: 'category', label: '카테고리', data: categoryList, valueKey: 'code', textKey: 'name' },
@@ -104,40 +260,120 @@ type ResetFn = (field?: string) => void;
104
260
  export declare class FilterSelectPanel {
105
261
  private _el;
106
262
  private _selects;
107
- /** 현재 선택 상태 { field → selectedValue } */
263
+ /**
264
+ * 현재 선택 상태 { field → selectedValue }
265
+ *
266
+ * 現在の選択状態 { field → selectedValue }
267
+ *
268
+ * 当前选中状态 { field → selectedValue }
269
+ */
108
270
  private _selected;
109
271
  private _config;
110
272
  private _onFilter;
111
273
  private _onReset;
112
274
  private _t;
113
275
  /**
114
- * @param container - 패널을 삽입할 컨테이너(그리드 헤더 앞에 prepend) / Container to insert the panel into (prepended before the grid header)
115
- * @param config - 패널 구성 / Panel configuration
116
- * @param onFilter - 필터 적용 콜백(field, items) / Filter-apply callback (field, items)
117
- * @param onReset - 필터 해제 콜백(field?) / Filter-reset callback (field?)
118
- * @param gridId - aria-controls 로 연결할 그리드 id(선택) / Grid id to link via aria-controls (optional)
119
- * @param t - 로케일 해석기(미주입 시 전역 t) / Locale resolver (global t when not injected)
276
+ * @param container - 패널을 삽입할 컨테이너(그리드 헤더 앞에 prepend)
277
+ *
278
+ * Container to insert the panel into (prepended before the grid header)
279
+ *
280
+ * パネルを挿入するコンテナー(グリッドヘッダーの前に prepend)
281
+ *
282
+ * 用于插入面板的容器(prepend 到表格表头之前)
283
+ *
284
+ * @param config - 패널 구성
285
+ *
286
+ * Panel configuration
287
+ *
288
+ * パネルの構成
289
+ *
290
+ * 面板配置
291
+ *
292
+ * @param onFilter - 필터 적용 콜백(field, items)
293
+ *
294
+ * Filter-apply callback (field, items)
295
+ *
296
+ * フィルター適用コールバック(field, items)
297
+ *
298
+ * 筛选应用回调(field, items)
299
+ *
300
+ * @param onReset - 필터 해제 콜백(field?)
301
+ *
302
+ * Filter-reset callback (field?)
303
+ *
304
+ * フィルター解除コールバック(field?)
305
+ *
306
+ * 筛选解除回调(field?)
307
+ *
308
+ * @param gridId - aria-controls 로 연결할 그리드 id(선택)
309
+ *
310
+ * Grid id to link via aria-controls (optional)
311
+ *
312
+ * aria-controls で紐づけるグリッドの id(任意)
313
+ *
314
+ * 通过 aria-controls 关联的表格 id(可选)
315
+ *
316
+ * @param t - 로케일 해석기(미주입 시 전역 t)
317
+ *
318
+ * Locale resolver (global t when not injected)
319
+ *
320
+ * ロケール解決関数(未注入の場合はグローバルの t)
321
+ *
322
+ * 区域设置解析函数(未注入时使用全局 t)
120
323
  */
121
324
  constructor(container: HTMLElement, config: FilterSelectConfig, onFilter: FilterFn, onReset: ResetFn, gridId?: string, t?: FilterSelectT);
122
325
  /**
123
326
  * 컬럼의 옵션 목록을 계산한다.
124
327
  *
328
+ * 列のオプション一覧を計算します。
329
+ *
330
+ * 计算列的选项一览。
331
+ *
125
332
  * @param col 대상 컬럼 정의
333
+ *
334
+ * 対象の列定義
335
+ *
336
+ * 目标列定义
337
+ *
126
338
  * @param parentValue 부모 선택값 (캐스케이딩 필터에 사용)
339
+ *
340
+ * 親の選択値(カスケーディングフィルターに使用)
341
+ *
342
+ * 父级选中值(用于级联筛选)
127
343
  */
128
344
  private _resolve;
129
345
  private _fill;
130
346
  private _onChange;
131
347
  /**
132
348
  * 부모 컬럼 변경 후 자식 컬럼 옵션을 재계산한다 (재귀).
349
+ *
350
+ * 親列の変更後に子列のオプションを再計算します(再帰)。
351
+ *
352
+ * 父列变更后重新计算子列的选项(递归)。
133
353
  */
134
354
  private _cascade;
135
355
  private _reset;
136
- /** 모든 필터 선택을 초기화한다("전체 초기화" 버튼과 동일 동작을 코드에서 트리거하고 싶을 때).
137
- * / Reset all filter selections (call this to trigger the same action as the "clear" button
138
- * from code). */
356
+ /**
357
+ * 모든 필터 선택을 초기화한다("전체 초기화" 버튼과 동일 동작을 코드에서 트리거하고 싶을 때).
358
+ *
359
+ * Reset all filter selections (call this to trigger the same action as the "clear" button
360
+ * from code).
361
+ *
362
+ * すべてのフィルター選択を初期化します(「全体初期化」ボタンと同じ動作をコードからトリガー
363
+ * したいとき)。
364
+ *
365
+ * 重置所有筛选选择(想在代码中触发与「全部重置」按钮相同的动作时调用)。
366
+ */
139
367
  reset(): void;
140
- /** 패널을 DOM 에서 제거한다. / Remove the panel from the DOM. */
368
+ /**
369
+ * 패널을 DOM 에서 제거한다.
370
+ *
371
+ * Remove the panel from the DOM.
372
+ *
373
+ * パネルを DOM から削除します。
374
+ *
375
+ * 从 DOM 中移除面板。
376
+ */
141
377
  destroy(): void;
142
378
  }
143
379
  export {};
@@ -1,24 +1,59 @@
1
1
  import { OpenGridInstance } from './types.js';
2
2
  /**
3
- * 그리드 셔틀 생성 옵션. / Grid shuttle construction options.
3
+ * 그리드 셔틀 생성 옵션.
4
+ *
5
+ * Grid shuttle construction options.
6
+ *
7
+ * グリッドシャトルの生成オプション。
8
+ *
9
+ * 表格穿梭框的构造选项。
4
10
  */
5
11
  export interface GridShuttleOptions {
6
- /** 버튼 배치 방향. 두 그리드가 가로로 나란히 있으면 'vertical'(위아래 버튼), 세로로 쌓여 있으면
12
+ /**
13
+ * 버튼 배치 방향. 두 그리드가 가로로 나란히 있으면 'vertical'(위아래 버튼), 세로로 쌓여 있으면
7
14
  * 'horizontal'을 쓴다. 기본 'vertical'.
8
- * / Button layout direction. Use 'vertical' (stacked buttons) when the two grids sit side by side,
15
+ *
16
+ * Button layout direction. Use 'vertical' (stacked buttons) when the two grids sit side by side,
9
17
  * or 'horizontal' when they're stacked vertically. Default 'vertical'.
10
- * @defaultValue 'vertical' */
18
+ *
19
+ * ボタンの配置方向。2つのグリッドが横に並んでいる場合は 'vertical'(上下のボタン)、縦に積まれて
20
+ * いる場合は 'horizontal' を使います。既定は 'vertical'。
21
+ *
22
+ * 按钮的排列方向。两个表格左右并排时用 'vertical'(上下排列的按钮),上下堆叠时用
23
+ * 'horizontal'。默认 'vertical'。
24
+ *
25
+ * @defaultValue 'vertical'
26
+ */
11
27
  layout?: 'vertical' | 'horizontal';
12
- /** 전체 이동(≫ ≪) 버튼도 표시. "전체 선택 후 이동"을 한 번의 클릭으로 줄이고 싶을 때 켠다.
28
+ /**
29
+ * 전체 이동(≫ ≪) 버튼도 표시. "전체 선택 후 이동"을 한 번의 클릭으로 줄이고 싶을 때 켠다.
13
30
  * 기본 false(개별 이동 버튼만 표시).
14
- * / Also show move-all (≫ ≪) buttons, so a full transfer takes one click instead of
31
+ *
32
+ * Also show move-all (≫ ≪) buttons, so a full transfer takes one click instead of
15
33
  * "select all, then move". Default false (only the per-check move buttons are shown).
16
- * @defaultValue false */
34
+ *
35
+ * 全件移動(≫ ≪)ボタンも表示します。「全選択してから移動」を1回のクリックに縮めたいときに
36
+ * 有効にします。既定は false(個別移動ボタンのみ表示)。
37
+ *
38
+ * 同时显示全部移动(≫ ≪)按钮,把「全选后再移动」缩短为一次点击。默认 false(仅显示单项
39
+ * 移动按钮)。
40
+ *
41
+ * @defaultValue false
42
+ */
17
43
  includeAll?: boolean;
18
- /** 버튼 라벨 커스터마이즈(다국어 문구를 직접 넣고 싶을 때). 생략 시 그리드 로케일의 기본
44
+ /**
45
+ * 버튼 라벨 커스터마이즈(다국어 문구를 직접 넣고 싶을 때). 생략 시 그리드 로케일의 기본
19
46
  * 문구(▶ ◀ ⏩ ⏪)를 사용한다.
20
- * / Customize button labels (e.g. to hardcode a specific phrase). Falls back to the grid's
21
- * locale defaults (▶ ◀ ⏩ ⏪) when omitted. */
47
+ *
48
+ * Customize button labels (e.g. to hardcode a specific phrase). Falls back to the grid's
49
+ * locale defaults (▶ ◀ ⏩ ⏪) when omitted.
50
+ *
51
+ * ボタンラベルのカスタマイズ(多言語の文言を直接入れたいとき)。省略した場合はグリッドロケールの
52
+ * 既定の文言(▶ ◀ ⏩ ⏪)を使います。
53
+ *
54
+ * 自定义按钮标签(需要直接写入多语言文案时)。省略时回退到表格区域设置的默认文案
55
+ * (▶ ◀ ⏩ ⏪)。
56
+ */
22
57
  labels?: {
23
58
  toRight?: string;
24
59
  toLeft?: string;
@@ -27,7 +62,13 @@ export interface GridShuttleOptions {
27
62
  };
28
63
  }
29
64
  /**
30
- * 두 그리드 사이의 셔틀 UI. / Shuttle UI between two grids.
65
+ * 두 그리드 사이의 셔틀 UI.
66
+ *
67
+ * Shuttle UI between two grids.
68
+ *
69
+ * 2つのグリッドの間に置くシャトルUI。
70
+ *
71
+ * 两个表格之间的穿梭框 UI。
31
72
  *
32
73
  * "가용 항목 그리드"와 "선택된 항목 그리드"를 나란히 두고, 그 사이에서 체크한 행을 화살표
33
74
  * 버튼으로 옮기고 싶을 때 쓴다(권한 배정, 컬럼 표시 여부 선택 같은 화면에 흔한 UI 패턴).
@@ -35,13 +76,26 @@ export interface GridShuttleOptions {
35
76
  * `grid.moveCheckedTo()` 가 호출되어 오른쪽 그리드로 행이 옮겨진다 — 이때 crossGridMapping
36
77
  * (필드 매핑)과 3단계 이벤트가 드래그로 옮길 때와 동일하게 적용되므로, 버튼 이동과 드래그
37
78
  * 이동을 섞어 써도 동작이 갈리지 않는다.
38
- * / Places arrow buttons between an "available items" grid and a "selected items" grid so
79
+ *
80
+ * Places arrow buttons between an "available items" grid and a "selected items" grid so
39
81
  * checked rows can be moved between them without dragging (a common pattern for permission
40
82
  * assignment, column visibility pickers, etc.). Operation order: the user checks rows in the
41
83
  * left grid and clicks ▶, which internally calls `grid.moveCheckedTo()` to move those rows into
42
84
  * the right grid — crossGridMapping (field mapping) and the 3-stage events apply identically to
43
85
  * drag-based moves, so mixing button moves with drag moves never behaves differently.
44
86
  *
87
+ * 「利用可能な項目のグリッド」と「選択された項目のグリッド」を並べて置き、その間でチェックした行を
88
+ * 矢印ボタンで移したいときに使います(権限の割り当てや、列の表示可否の選択といった画面によくあるUI
89
+ * パターンです)。動作の順序は次のとおりです。ユーザーが左のグリッドで行をチェックして ▶ ボタンを
90
+ * クリックすると、内部で `grid.moveCheckedTo()` が呼ばれ、右のグリッドへ行が移されます — このとき
91
+ * crossGridMapping(フィールドマッピング)と3段階のイベントがドラッグで移すときと同じように適用
92
+ * されるため、ボタン移動とドラッグ移動を混ぜて使っても動作が食い違うことはありません。
93
+ *
94
+ * 在「可用项目表格」和「已选项目表格」之间放置箭头按钮,无需拖拽即可移动勾选的行(权限分配、
95
+ * 列显示与否的选择等界面中常见的 UI 模式)。动作顺序如下:用户在左侧表格勾选行并点击 ▶,内部
96
+ * 就会调用 `grid.moveCheckedTo()` 把这些行移入右侧表格 — 此时 crossGridMapping(字段映射)
97
+ * 和 3 阶段事件与拖拽移动完全相同地生效,因此混用按钮移动和拖拽移动也不会出现动作分歧。
98
+ *
45
99
  * @example
46
100
  * const shuttle = new GridShuttle(leftGrid, rightGrid, document.querySelector('#mid')!, {
47
101
  * layout: 'vertical',
@@ -53,27 +107,109 @@ export declare class GridShuttle {
53
107
  private _right;
54
108
  private _el;
55
109
  /**
56
- * @param _left - 왼쪽 그리드 인스턴스 / Left grid instance
57
- * @param _right - 오른쪽 그리드 인스턴스 / Right grid instance
58
- * @param mount - 셔틀 버튼을 붙일 마운트 엘리먼트 / Mount element to attach the shuttle buttons
59
- * @param opts - 셔틀 옵션 / Shuttle options
110
+ * @param _left - 왼쪽 그리드 인스턴스
111
+ *
112
+ * Left grid instance.
113
+ *
114
+ * 左のグリッドインスタンス。
115
+ *
116
+ * 左侧表格实例。
117
+ *
118
+ * @param _right - 오른쪽 그리드 인스턴스
119
+ *
120
+ * Right grid instance.
121
+ *
122
+ * 右のグリッドインスタンス。
123
+ *
124
+ * 右侧表格实例。
125
+ *
126
+ * @param mount - 셔틀 버튼을 붙일 마운트 엘리먼트
127
+ *
128
+ * Mount element to attach the shuttle buttons.
129
+ *
130
+ * シャトルボタンを取り付けるマウント要素。
131
+ *
132
+ * 用于挂载穿梭框按钮的元素。
133
+ *
134
+ * @param opts - 셔틀 옵션
135
+ *
136
+ * Shuttle options.
137
+ *
138
+ * シャトルのオプション。
139
+ *
140
+ * 穿梭框选项。
60
141
  */
61
142
  constructor(_left: OpenGridInstance, _right: OpenGridInstance, mount: HTMLElement, opts?: GridShuttleOptions);
62
143
  private _moveAll;
63
- /** 셔틀 UI 를 DOM 에서 제거한다. / Remove the shuttle UI from the DOM. */
144
+ /**
145
+ * 셔틀 UI 를 DOM 에서 제거한다.
146
+ *
147
+ * Remove the shuttle UI from the DOM.
148
+ *
149
+ * シャトルUIをDOMから取り除きます。
150
+ *
151
+ * 从 DOM 中移除穿梭框 UI。
152
+ */
64
153
  destroy(): void;
65
154
  }
66
155
  /**
67
- * 두 그리드 사이에 셔틀(화살표 이동) 버튼을 만든다. / Create shuttle (arrow-move) buttons between two grids.
156
+ * 두 그리드 사이에 셔틀(화살표 이동) 버튼을 만든다.
157
+ *
158
+ * Create shuttle (arrow-move) buttons between two grids.
159
+ *
160
+ * 2つのグリッドの間にシャトル(矢印移動)ボタンを作ります。
161
+ *
162
+ * 在两个表格之间创建穿梭框(箭头移动)按钮。
68
163
  *
69
164
  * `new GridShuttle(...)` 과 동일하되, `new` 없이 함수 호출 한 줄로 끝내고 싶을 때 쓰는 편의 팩토리.
70
- * / Same as `new GridShuttle(...)`, but a convenience factory for callers who'd rather skip `new`.
71
165
  *
72
- * @param left - 왼쪽 그리드 인스턴스 / Left grid instance
73
- * @param right - 오른쪽 그리드 인스턴스 / Right grid instance
74
- * @param mount - 셔틀 버튼을 붙일 마운트 엘리먼트 / Mount element to attach the shuttle buttons
75
- * @param opts - 셔틀 옵션 / Shuttle options
76
- * @returns 생성된 GridShuttle 인스턴스 / The created GridShuttle instance
166
+ * Same as `new GridShuttle(...)`, but a convenience factory for callers who'd rather skip `new`.
167
+ *
168
+ * `new GridShuttle(...)` と同じですが、`new` なしで関数呼び出し1行で済ませたいときに使う便利
169
+ * ファクトリです。
170
+ *
171
+ * 与 `new GridShuttle(...)` 相同,只是为不想写 `new` 的调用方提供的便捷工厂。
172
+ *
173
+ * @param left - 왼쪽 그리드 인스턴스
174
+ *
175
+ * Left grid instance.
176
+ *
177
+ * 左のグリッドインスタンス。
178
+ *
179
+ * 左侧表格实例。
180
+ *
181
+ * @param right - 오른쪽 그리드 인스턴스
182
+ *
183
+ * Right grid instance.
184
+ *
185
+ * 右のグリッドインスタンス。
186
+ *
187
+ * 右侧表格实例。
188
+ *
189
+ * @param mount - 셔틀 버튼을 붙일 마운트 엘리먼트
190
+ *
191
+ * Mount element to attach the shuttle buttons.
192
+ *
193
+ * シャトルボタンを取り付けるマウント要素。
194
+ *
195
+ * 用于挂载穿梭框按钮的元素。
196
+ *
197
+ * @param opts - 셔틀 옵션
198
+ *
199
+ * Shuttle options.
200
+ *
201
+ * シャトルのオプション。
202
+ *
203
+ * 穿梭框选项。
204
+ *
205
+ * @returns 생성된 GridShuttle 인스턴스
206
+ *
207
+ * The created GridShuttle instance.
208
+ *
209
+ * 生成された GridShuttle インスタンス。
210
+ *
211
+ * 创建的 GridShuttle 实例。
212
+ *
77
213
  * @example
78
214
  * const shuttle = createGridShuttle(leftGrid, rightGrid, mountEl, { includeAll: true });
79
215
  */