@aiquants/period-slider 0.13.0 → 0.14.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 +81 -3
- package/README.md +194 -78
- 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 +29 -42
- package/dist/PeriodSlider.d.ts.map +1 -1
- package/dist/VirtualDateDropdown.d.ts +8 -0
- package/dist/VirtualDateDropdown.d.ts.map +1 -1
- package/dist/YearSelector.d.ts +13 -14
- package/dist/YearSelector.d.ts.map +1 -1
- package/dist/dateOptionDomain.d.ts +6 -6
- 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 +2129 -2038
- 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/package.json +3 -3
- package/src/DateSelector.tsx +51 -73
- package/src/MonthSelector.tsx +48 -64
- package/src/PeriodSlider.tsx +70 -87
- package/src/VirtualDateDropdown.tsx +14 -2
- package/src/YearSelector.tsx +39 -53
- package/src/dateOptionDomain.ts +8 -8
- package/src/index.ts +13 -6
- package/src/labels.ts +407 -0
- package/src/optionText.ts +21 -21
- package/src/usePeriodSlider.ts +46 -18
- package/src/useResolvedLabels.ts +35 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,11 +1,89 @@
|
|
|
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.14.0 (2026-09-24)
|
|
8
|
+
|
|
9
|
+
部品の名前を読み手の言語で名乗らせる UI クローム言語 (`locale` / `labels`) を加え、日付書式のロケールを `formatLocale` へ
|
|
10
|
+
改名。2 つは独立した軸で、一方から他方を導出しません。**0.x の破壊的変更を含むマイナー版です** (下の「移行」を参照)。
|
|
11
|
+
|
|
12
|
+
### 追加
|
|
13
|
+
|
|
14
|
+
- **`locale?: "en" | "ja"` (UI クローム言語) を `PeriodSlider` / `YearSelector` / `MonthSelector` / `DateSelector` が
|
|
15
|
+
受け取ります**。つまみ・ステッパー・セレクト・コンボボックス・ポップアップの `listbox` の名前を凍結カタログ
|
|
16
|
+
`PERIOD_SLIDER_LABEL_CATALOGS` から選びます。既定は `"en"` で、その文言は 0.13 の英語既定と 1 バイトも違わないため、
|
|
17
|
+
`locale` を渡さないホストの DOM は変わりません。`"en"` / `"ja"` 以外 (`"ja-JP"`・`"EN"`・`""`・`null` 等) は
|
|
18
|
+
`RangeError: [period-slider] locale is the UI language, not a BCP 47 tag (date formatting reads formatLocale): ...`
|
|
19
|
+
です (エンジンの `RangeError` を `cause` に保持)。言語ネゴシエーションは行いません (`navigator.language` からの対応付けはホストの責務です)。
|
|
20
|
+
- **`labels?: PeriodSliderLabelOverrides` でカタログをキー単位に上書きできます**。全 29 キー (エンジン 7 + 固有 22) の
|
|
21
|
+
閉じた集合で、各部品は自分のキーだけを読むため、1 つのオブジェクトをスライダーと全セレクタへ渡せます。
|
|
22
|
+
解決規則は `@aiquants/virtualscroll` と同じです: 素のオブジェクトだけを受け付け自身のプロパティだけを読む、未知キーは
|
|
23
|
+
`RangeError`、値は空白以外を含む文字列、`undefined` はカタログ値のまま、結果は凍結。
|
|
24
|
+
- **`DateSelector variant="dropdown"` のポップアップに埋め込まれた VirtualScroll へ `locale` とエンジン 7 キーを転送します**。
|
|
25
|
+
0.13 まで翻訳できなかったスクロールバー矢印の名前 (`Scroll up` / `Scroll down`) が、`locale="ja"` で
|
|
26
|
+
`上へスクロール` / `下へスクロール` になり、`labels.scrollUp` / `labels.scrollDown` で上書きできます。エンジンの文言は
|
|
27
|
+
`VIRTUAL_SCROLL_LABEL_CATALOGS` をそのまま再利用し、本パッケージでは書き直しません。
|
|
28
|
+
- **公開 API**: `PERIOD_SLIDER_LABEL_KEYS`・`PERIOD_SLIDER_LABEL_CATALOGS`・`resolvePeriodSliderLabels(locale, overrides)`、
|
|
29
|
+
型 `PeriodSliderLocale` (`VirtualScrollLocale` と同一)・`PeriodSliderLabels`・`PeriodSliderLabelOverrides`。
|
|
30
|
+
- **4 つのフックは `locale` と `labels` を `sliderProps` と全 `SelectorProps` へ配ります** (`formatLocale` / `formatOption` と同じ経路)。
|
|
31
|
+
- **インラインの `labels={{ ... }}` でも文字列が同じ間は再描画しません**。4 部品のメモ比較器は `labels` を自身のキーの
|
|
32
|
+
値で比較し、解決結果も値で安定化するため、内蔵 VirtualScroll へ渡すラベルの同一性も保たれます。
|
|
33
|
+
- デモに `?lang=en` / `?lang=ja` と言語切替ボタンを加えました (日付の書式は `formatLocale="ja-JP"` のままです)。
|
|
34
|
+
|
|
35
|
+
### 変更 (破壊的)
|
|
36
|
+
|
|
37
|
+
- **日付書式の BCP 47 タグ `locale?: string` を `formatLocale?: string` へ改名しました** (別名は残していません)。
|
|
38
|
+
4 部品の Props・4 フックのオプション・`SelectorProps` のすべてが対象です。検証メッセージも新しい名前を名乗ります
|
|
39
|
+
(例: `PeriodSlider: formatLocale must be a valid BCP 47 language tag (received: "")`)。`formatLabel` /
|
|
40
|
+
`formatScreenReaderLabel` / `formatOptionText` の第 4 引数は位置引数のため呼び出しは変わりません (引数名だけが
|
|
41
|
+
`formatLocale` になりました)。
|
|
42
|
+
- **4 部品の `*AriaLabel` Props (延べ 19 個、名前としては 17 種: `selectAriaLabel` は 3 つのセレクタに共通) と
|
|
43
|
+
`AccessibleSliderLabels` 型を撤去し、`labels` へ統合しました**。`formatAriaValueText`
|
|
44
|
+
は `BasePeriodSliderProps` へ移り、そのまま使えます。ノギスのミクロつまみは 0.13 まで `lowerAriaLabel` /
|
|
45
|
+
`upperAriaLabel` / `pointAriaLabel` を range / point モードと共有していましたが、専用のキー (`microRangeStart` /
|
|
46
|
+
`microRangeEnd` / `microSelectedDate`) を読むようになりました。
|
|
47
|
+
- **`@aiquants/virtualscroll` は 3.7.0 以上が必要です** (`locale` / `labels` の受け口)。公開時の peer 範囲は `^3.7.0` へ展開されます。
|
|
48
|
+
|
|
49
|
+
### 移行
|
|
50
|
+
|
|
51
|
+
> [!WARNING]
|
|
52
|
+
> **0.13 で `locale="ja"` / `locale="en"` を渡していたホストは、型エラーも実行時エラーも出ないまま意味が変わります**。
|
|
53
|
+
> `"ja"` / `"en"` は 0.13 では日付書式の正当な BCP 47 タグでしたが、0.14 では UI 言語の `locale` の受理値そのものです。
|
|
54
|
+
> `formatLocale` へ改名しない限り、日付テキストは黙って ISO 8601 へ戻り (`2024/01` → `2024-01`、`04/15/2025` → `2025-04-15`)、
|
|
55
|
+
> `"ja"` では部品の名前も日本語カタログへ切り替わります (`Previous month` → `前月`)。
|
|
56
|
+
> **0.13 の `locale` は値が何であれ、すべて `formatLocale` へ改名してください**。日本語の名前が欲しい場合に限り、そのあとで `locale="ja"` を加えます。
|
|
57
|
+
|
|
58
|
+
- `locale="ja-JP"` (日付書式) → `formatLocale="ja-JP"`。フックの `{ locale: "ja-JP" }` も `{ formatLocale: "ja-JP" }` へ。
|
|
59
|
+
`"ja"` / `"en"` 以外のタグを旧名のまま渡すと、UI 言語の `locale` として
|
|
60
|
+
`RangeError: [period-slider] locale is the UI language, not a BCP 47 tag (date formatting reads formatLocale): ...`
|
|
61
|
+
になります。`"ja"` / `"en"` は拒否されないため (上の警告)、エラーの有無に関わらず改名が必要です。
|
|
62
|
+
- アクセシブル名の Props → `labels` のキー:
|
|
63
|
+
|
|
64
|
+
| 撤去した Prop | 部品 | `labels` のキー |
|
|
65
|
+
| :--- | :--- | :--- |
|
|
66
|
+
| `lowerAriaLabel` / `upperAriaLabel` | `PeriodSlider` | `rangeStart` / `rangeEnd` (ノギスのミクロ期間形態では `microRangeStart` / `microRangeEnd`) |
|
|
67
|
+
| `pointAriaLabel` | `PeriodSlider` | `selectedDate` (ノギスのミクロ時点形態では `microSelectedDate`) |
|
|
68
|
+
| `macroLowerAriaLabel` / `macroUpperAriaLabel` | `PeriodSlider` | `macroRangeStart` / `macroRangeEnd` |
|
|
69
|
+
| `decreaseAriaLabel` / `increaseAriaLabel` | `PeriodSlider` | `decrease` / `increase` |
|
|
70
|
+
| `prevYearAriaLabel` / `nextYearAriaLabel` / `selectAriaLabel` | `YearSelector` | `previousYear` / `nextYear` / `yearSelect` |
|
|
71
|
+
| `prevMonthAriaLabel` / `nextMonthAriaLabel` / `selectAriaLabel` | `MonthSelector` | `previousMonth` / `nextMonth` / `monthSelect` |
|
|
72
|
+
| `prevDateAriaLabel` / `nextDateAriaLabel` / `selectAriaLabel` | `DateSelector` | `previousDay` / `nextDay` / `dateSelect` |
|
|
73
|
+
| `yearAriaLabel` / `monthAriaLabel` / `dayAriaLabel` | `DateSelector` | `splitYear` / `splitMonth` / `splitDay` |
|
|
74
|
+
|
|
75
|
+
- 日本語名を個別に与えていたホストは、`locale="ja"` でカタログに任せ、カタログと違う名前だけを `labels` に残すのが最小の書き換えです。
|
|
76
|
+
- 撤去した `*AriaLabel` 名を `labels` のキーとして渡すと、未知キーとして `RangeError` になります (黙って無視されません)。
|
|
77
|
+
- 何も渡していなかったホスト (英語名・ISO 表記に依存するテストを含む) は変更不要です。
|
|
78
|
+
|
|
79
|
+
### 修正
|
|
80
|
+
|
|
81
|
+
- **`usePeriodSliderRange` の `startSelectorProps` / `endSelectorProps` が、書式の変更に追従しないことがありました**。
|
|
82
|
+
メモの依存に `formatLocale` (0.13 の `locale`) と `formatOption` が無く、フックへ渡す値を実行中に変えても
|
|
83
|
+
セレクタだけが初回の値を配り続けていました。4 つの値 (`formatLocale` / `formatOption` / `locale` / `labels`) を依存へ加えました。
|
|
84
|
+
- 本書の 0.13.0 の見出しが `## Unreleased` のまま残っていたため、版番号へ改めました。
|
|
85
|
+
|
|
86
|
+
## 0.13.0
|
|
9
87
|
|
|
10
88
|
パッケージが所有するテキスト面を、1 つのフォーマッタ契約 (`PeriodOptionFormatter`) へ統一。
|
|
11
89
|
|