@aiquants/period-slider 0.13.0 → 0.15.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 +129 -3
- package/README.md +213 -85
- package/dist/DateSelector.d.ts +13 -20
- package/dist/DateSelector.d.ts.map +1 -1
- package/dist/MonthSelector.d.ts +13 -14
- package/dist/MonthSelector.d.ts.map +1 -1
- package/dist/PeriodSlider.d.ts +53 -42
- package/dist/PeriodSlider.d.ts.map +1 -1
- package/dist/VirtualDateDropdown.d.ts +16 -0
- package/dist/VirtualDateDropdown.d.ts.map +1 -1
- package/dist/YearSelector.d.ts +23 -15
- package/dist/YearSelector.d.ts.map +1 -1
- package/dist/dateOptionDomain.d.ts +11 -23
- package/dist/dateOptionDomain.d.ts.map +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.d.cts +14 -6
- package/dist/index.d.ts +14 -6
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2220 -2047
- package/dist/labels.d.ts +144 -0
- package/dist/labels.d.ts.map +1 -0
- package/dist/optionText.d.ts +5 -5
- package/dist/optionText.d.ts.map +1 -1
- package/dist/usePeriodSlider.d.ts +16 -8
- package/dist/usePeriodSlider.d.ts.map +1 -1
- package/dist/useResolvedLabels.d.ts +17 -0
- package/dist/useResolvedLabels.d.ts.map +1 -0
- package/dist/valueSet.d.ts +121 -0
- package/dist/valueSet.d.ts.map +1 -0
- package/package.json +3 -3
- package/src/DateSelector.tsx +67 -105
- package/src/MonthSelector.tsx +93 -98
- package/src/PeriodSlider.tsx +155 -149
- package/src/VirtualDateDropdown.tsx +25 -4
- package/src/YearSelector.tsx +150 -82
- package/src/dateOptionDomain.ts +48 -63
- package/src/index.ts +13 -6
- package/src/labels.ts +407 -0
- package/src/optionText.ts +21 -21
- package/src/usePeriodSlider.ts +80 -31
- package/src/useResolvedLabels.ts +35 -0
- package/src/valueSet.ts +260 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,11 +1,137 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
3
|
All notable changes to `@aiquants/period-slider` are documented here.
|
|
4
|
-
|
|
5
|
-
(改めないと、同梱される release notes が公開後も `## Unreleased` のままになります)。
|
|
4
|
+
見出しは版番号です。次の公開に入る変更は、その版番号と作成日の見出し (`## 0.14.0 (2026-09-24)` の形) の下へ書きます。
|
|
6
5
|
本書は 0.10.0 で起こしたため、0.7.0 以前の項はありません (0.8.0 と 0.9.0 は公開済みの差分から起こした要約です)。
|
|
7
6
|
|
|
8
|
-
##
|
|
7
|
+
## 0.15.0 (2026-09-25)
|
|
8
|
+
|
|
9
|
+
「その値は描かれているか」「端はどこか」「その向きの次はどれか」「集合が動いたとき対はどこへ行くか」の 4 つを
|
|
10
|
+
非公開モジュール `valueSet.ts` の整数規則 1 か所へ集め、レール・選択肢一覧・3 セレクタがそこへ委譲するようにしました。
|
|
11
|
+
公開 API に増えたのは `YearSelector` の `allowedYears` 1 つだけですが、**既定の挙動が 5 か所変わります** (下の「移行」を参照)。
|
|
12
|
+
|
|
13
|
+
### 追加
|
|
14
|
+
|
|
15
|
+
- **`YearSelector` に `allowedYears?: Date[]` を加えました**。各要素を「それを含む年」(`yearStartMonth` 準拠) として読み、
|
|
16
|
+
重複を畳み、境界と積を取ります。指定すると連続範囲を置き換えるため、候補の無い年は選択肢からもステッパーの行き先からも
|
|
17
|
+
外れます。指定時は境界必須の条件も満たします (`MonthSelector` の `allowedMonths` / `DateSelector` の `allowedDates` と
|
|
18
|
+
同じ扱いで、集合を宣言することは窓の発明ではありません)。`allowedYears={[]}` は「選択可能年なし」、要素の Invalid Date は
|
|
19
|
+
添字付きの `RangeError`、参照比較で再描画を判定するため利用側でメモ化します。
|
|
20
|
+
|
|
21
|
+
### 変更 (既定の挙動)
|
|
22
|
+
|
|
23
|
+
- **3 セレクタの ◀▶ は、集合から離れていても集合へ戻る向きが有効になります**。押すとその向きで最も近い選択可能値
|
|
24
|
+
(連続指定なら境界、離散指定なら候補そのもの) を発行します。0.14 までは「1 歩先が集合内か」で可否を決めていたため、
|
|
25
|
+
集合から 2 単位以上離れた保持値では**両方の矢印が使用不可**になり、画面から戻る手段がありませんでした。
|
|
26
|
+
集合の外にあることを伝えるのはルートの `data-out-of-range="true"` だけで、両矢印の使用不可はその合図ではありません。
|
|
27
|
+
- **`DateSelector variant="dropdown"` は、集合外の保持値では最も近い行にアクティブを置いて開きます** (同距離では早い側の
|
|
28
|
+
日付)。0.14 までは先頭行から開いたため、100 年の定義域では 3 万行以上離れた場所が開いていました。`aria-selected="true"`
|
|
29
|
+
の行は 1 つも立たず、操作要素の表示テキストとルートの `data-out-of-range` は動きません。
|
|
30
|
+
- **`mode="vernier"` は、`macroUnit` の解像度で 1 単位に収まる定義域を受理します**。0.14 までは
|
|
31
|
+
`RangeError: PeriodSlider: macroUnit "..." cannot distinguish minDate from maxDate` で描画そのものを拒んでいました。
|
|
32
|
+
マクロレールの目盛りは 1 つ (両つまみが同じ符号値を名乗る)、マクロ操作は何も動かさない (`onChangeMacroRange` は鳴らない)、
|
|
33
|
+
ミクロレールは従来どおり「その 1 単位 ∩ `[minDate, maxDate]`」を張り、ミクロ操作は完全に生きています。
|
|
34
|
+
定義域を 1 単位広げて回避していたホストは、その回避を外してください (広げた分だけ `maxDate` より後ろの日付が選べていました)。
|
|
35
|
+
- **離散レールの `aria-valuemin` / `aria-valuemax` は、窓の端ではなく候補集合の端を名乗ります**。レールが決して置かない値を
|
|
36
|
+
読み上げないためで、ステッパーの使用可否も同じ縁で決まります (0.14 でも可否は候補の端で決まっていたため、
|
|
37
|
+
読み上げだけが 1 段広い値を名乗っていました)。
|
|
38
|
+
- **窓ごとの平行移動でミクロ選択の長さが保たれます**。`Shift` + ホイールと `useVernierSliderRange().shiftMacroRange` は
|
|
39
|
+
0.14 まで各端を独立にクランプしていたため、新しい窓が選択に重ならない平行移動で**選択が幅 0 の 1 点へ潰れていました**
|
|
40
|
+
(`macro-connect` のドラッグだけが長さを保っていました)。3 経路とも `placePairIntoMacroWindow` 1 つを読みます。
|
|
41
|
+
片側の縁だけを動かす操作 (マクロつまみ 1 本・利用側が名指す `macroRange` の変更) は従来どおり切り落としです。
|
|
42
|
+
|
|
43
|
+
### 移行
|
|
44
|
+
|
|
45
|
+
上の 5 点はいずれも Props を増やさない既定の変更です。次のいずれかを固定している利用側のテストは赤になります。
|
|
46
|
+
|
|
47
|
+
1. 集合の外にある保持値で「両矢印が使用不可」であること → 戻る向きは有効になりました。
|
|
48
|
+
2. 集合外の保持値で開いたポップアップの先頭行 → 最近傍の行になりました。
|
|
49
|
+
3. 1 マクロ単位の定義域で `RangeError` が投げられること → 描かれるようになりました。
|
|
50
|
+
4. 離散レールの `aria-valuemin` / `aria-valuemax` が窓の端であること → 候補集合の端になりました。
|
|
51
|
+
5. `Shift` + ホイールや `shiftMacroRange` の後にミクロ選択が幅 0 になること → 長さが保たれます。
|
|
52
|
+
|
|
53
|
+
`allowedYears` を渡していないホストの DOM は、上の 5 点以外は 1 バイトも変わりません。
|
|
54
|
+
|
|
55
|
+
## 0.14.0 (2026-09-24)
|
|
56
|
+
|
|
57
|
+
部品の名前を読み手の言語で名乗らせる UI クローム言語 (`locale` / `labels`) を加え、日付書式のロケールを `formatLocale` へ
|
|
58
|
+
改名。2 つは独立した軸で、一方から他方を導出しません。**0.x の破壊的変更を含むマイナー版です** (下の「移行」を参照)。
|
|
59
|
+
|
|
60
|
+
### 追加
|
|
61
|
+
|
|
62
|
+
- **`locale?: "en" | "ja"` (UI クローム言語) を `PeriodSlider` / `YearSelector` / `MonthSelector` / `DateSelector` が
|
|
63
|
+
受け取ります**。つまみ・ステッパー・セレクト・コンボボックス・ポップアップの `listbox` の名前を凍結カタログ
|
|
64
|
+
`PERIOD_SLIDER_LABEL_CATALOGS` から選びます。既定は `"en"` で、その文言は 0.13 の英語既定と 1 バイトも違わないため、
|
|
65
|
+
`locale` を渡さないホストの DOM は変わりません。`"en"` / `"ja"` 以外 (`"ja-JP"`・`"EN"`・`""`・`null` 等) は
|
|
66
|
+
`RangeError: [period-slider] locale is the UI language, not a BCP 47 tag (date formatting reads formatLocale): ...`
|
|
67
|
+
です (エンジンの `RangeError` を `cause` に保持)。言語ネゴシエーションは行いません (`navigator.language` からの対応付けはホストの責務です)。
|
|
68
|
+
- **`labels?: PeriodSliderLabelOverrides` でカタログをキー単位に上書きできます**。全 29 キー (エンジン 7 + 固有 22) の
|
|
69
|
+
閉じた集合で、各部品は自分のキーだけを読むため、1 つのオブジェクトをスライダーと全セレクタへ渡せます。
|
|
70
|
+
解決規則は `@aiquants/virtualscroll` と同じです: 素のオブジェクトだけを受け付け自身のプロパティだけを読む、未知キーは
|
|
71
|
+
`RangeError`、値は空白以外を含む文字列、`undefined` はカタログ値のまま、結果は凍結。
|
|
72
|
+
- **`DateSelector variant="dropdown"` のポップアップに埋め込まれた VirtualScroll へ `locale` とエンジン 7 キーを転送します**。
|
|
73
|
+
0.13 まで翻訳できなかったスクロールバー矢印の名前 (`Scroll up` / `Scroll down`) が、`locale="ja"` で
|
|
74
|
+
`上へスクロール` / `下へスクロール` になり、`labels.scrollUp` / `labels.scrollDown` で上書きできます。エンジンの文言は
|
|
75
|
+
`VIRTUAL_SCROLL_LABEL_CATALOGS` をそのまま再利用し、本パッケージでは書き直しません。
|
|
76
|
+
- **公開 API**: `PERIOD_SLIDER_LABEL_KEYS`・`PERIOD_SLIDER_LABEL_CATALOGS`・`resolvePeriodSliderLabels(locale, overrides)`、
|
|
77
|
+
型 `PeriodSliderLocale` (`VirtualScrollLocale` と同一)・`PeriodSliderLabels`・`PeriodSliderLabelOverrides`。
|
|
78
|
+
- **4 つのフックは `locale` と `labels` を `sliderProps` と全 `SelectorProps` へ配ります** (`formatLocale` / `formatOption` と同じ経路)。
|
|
79
|
+
- **インラインの `labels={{ ... }}` でも文字列が同じ間は再描画しません**。4 部品のメモ比較器は `labels` を自身のキーの
|
|
80
|
+
値で比較し、解決結果も値で安定化するため、内蔵 VirtualScroll へ渡すラベルの同一性も保たれます。
|
|
81
|
+
- デモに `?lang=en` / `?lang=ja` と言語切替ボタンを加えました (日付の書式は `formatLocale="ja-JP"` のままです)。
|
|
82
|
+
|
|
83
|
+
### 変更 (破壊的)
|
|
84
|
+
|
|
85
|
+
- **日付書式の BCP 47 タグ `locale?: string` を `formatLocale?: string` へ改名しました** (別名は残していません)。
|
|
86
|
+
4 部品の Props・4 フックのオプション・`SelectorProps` のすべてが対象です。検証メッセージも新しい名前を名乗ります
|
|
87
|
+
(例: `PeriodSlider: formatLocale must be a valid BCP 47 language tag (received: "")`)。`formatLabel` /
|
|
88
|
+
`formatScreenReaderLabel` / `formatOptionText` の第 4 引数は位置引数のため呼び出しは変わりません (引数名だけが
|
|
89
|
+
`formatLocale` になりました)。
|
|
90
|
+
- **4 部品の `*AriaLabel` Props (延べ 19 個、名前としては 17 種: `selectAriaLabel` は 3 つのセレクタに共通) と
|
|
91
|
+
`AccessibleSliderLabels` 型を撤去し、`labels` へ統合しました**。`formatAriaValueText`
|
|
92
|
+
は `BasePeriodSliderProps` へ移り、そのまま使えます。ノギスのミクロつまみは 0.13 まで `lowerAriaLabel` /
|
|
93
|
+
`upperAriaLabel` / `pointAriaLabel` を range / point モードと共有していましたが、専用のキー (`microRangeStart` /
|
|
94
|
+
`microRangeEnd` / `microSelectedDate`) を読むようになりました。
|
|
95
|
+
- **`@aiquants/virtualscroll` は 3.7.0 以上が必要です** (`locale` / `labels` の受け口)。公開時の peer 範囲は `^3.7.0` へ展開されます。
|
|
96
|
+
|
|
97
|
+
### 移行
|
|
98
|
+
|
|
99
|
+
> [!WARNING]
|
|
100
|
+
> **0.13 で `locale="ja"` / `locale="en"` を渡していたホストは、型エラーも実行時エラーも出ないまま意味が変わります**。
|
|
101
|
+
> `"ja"` / `"en"` は 0.13 では日付書式の正当な BCP 47 タグでしたが、0.14 では UI 言語の `locale` の受理値そのものです。
|
|
102
|
+
> `formatLocale` へ改名しない限り、日付テキストは黙って ISO 8601 へ戻り (`2024/01` → `2024-01`、`04/15/2025` → `2025-04-15`)、
|
|
103
|
+
> `"ja"` では部品の名前も日本語カタログへ切り替わります (`Previous month` → `前月`)。
|
|
104
|
+
> **0.13 の `locale` は値が何であれ、すべて `formatLocale` へ改名してください**。日本語の名前が欲しい場合に限り、そのあとで `locale="ja"` を加えます。
|
|
105
|
+
|
|
106
|
+
- `locale="ja-JP"` (日付書式) → `formatLocale="ja-JP"`。フックの `{ locale: "ja-JP" }` も `{ formatLocale: "ja-JP" }` へ。
|
|
107
|
+
`"ja"` / `"en"` 以外のタグを旧名のまま渡すと、UI 言語の `locale` として
|
|
108
|
+
`RangeError: [period-slider] locale is the UI language, not a BCP 47 tag (date formatting reads formatLocale): ...`
|
|
109
|
+
になります。`"ja"` / `"en"` は拒否されないため (上の警告)、エラーの有無に関わらず改名が必要です。
|
|
110
|
+
- アクセシブル名の Props → `labels` のキー:
|
|
111
|
+
|
|
112
|
+
| 撤去した Prop | 部品 | `labels` のキー |
|
|
113
|
+
| :--- | :--- | :--- |
|
|
114
|
+
| `lowerAriaLabel` / `upperAriaLabel` | `PeriodSlider` | `rangeStart` / `rangeEnd` (ノギスのミクロ期間形態では `microRangeStart` / `microRangeEnd`) |
|
|
115
|
+
| `pointAriaLabel` | `PeriodSlider` | `selectedDate` (ノギスのミクロ時点形態では `microSelectedDate`) |
|
|
116
|
+
| `macroLowerAriaLabel` / `macroUpperAriaLabel` | `PeriodSlider` | `macroRangeStart` / `macroRangeEnd` |
|
|
117
|
+
| `decreaseAriaLabel` / `increaseAriaLabel` | `PeriodSlider` | `decrease` / `increase` |
|
|
118
|
+
| `prevYearAriaLabel` / `nextYearAriaLabel` / `selectAriaLabel` | `YearSelector` | `previousYear` / `nextYear` / `yearSelect` |
|
|
119
|
+
| `prevMonthAriaLabel` / `nextMonthAriaLabel` / `selectAriaLabel` | `MonthSelector` | `previousMonth` / `nextMonth` / `monthSelect` |
|
|
120
|
+
| `prevDateAriaLabel` / `nextDateAriaLabel` / `selectAriaLabel` | `DateSelector` | `previousDay` / `nextDay` / `dateSelect` |
|
|
121
|
+
| `yearAriaLabel` / `monthAriaLabel` / `dayAriaLabel` | `DateSelector` | `splitYear` / `splitMonth` / `splitDay` |
|
|
122
|
+
|
|
123
|
+
- 日本語名を個別に与えていたホストは、`locale="ja"` でカタログに任せ、カタログと違う名前だけを `labels` に残すのが最小の書き換えです。
|
|
124
|
+
- 撤去した `*AriaLabel` 名を `labels` のキーとして渡すと、未知キーとして `RangeError` になります (黙って無視されません)。
|
|
125
|
+
- 何も渡していなかったホスト (英語名・ISO 表記に依存するテストを含む) は変更不要です。
|
|
126
|
+
|
|
127
|
+
### 修正
|
|
128
|
+
|
|
129
|
+
- **`usePeriodSliderRange` の `startSelectorProps` / `endSelectorProps` が、書式の変更に追従しないことがありました**。
|
|
130
|
+
メモの依存に `formatLocale` (0.13 の `locale`) と `formatOption` が無く、フックへ渡す値を実行中に変えても
|
|
131
|
+
セレクタだけが初回の値を配り続けていました。4 つの値 (`formatLocale` / `formatOption` / `locale` / `labels`) を依存へ加えました。
|
|
132
|
+
- 本書の 0.13.0 の見出しが `## Unreleased` のまま残っていたため、版番号へ改めました。
|
|
133
|
+
|
|
134
|
+
## 0.13.0
|
|
9
135
|
|
|
10
136
|
パッケージが所有するテキスト面を、1 つのフォーマッタ契約 (`PeriodOptionFormatter`) へ統一。
|
|
11
137
|
|