dsh-better-left-sidebar 0.1.0 → 0.1.1

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 (6) hide show
  1. package/README.en.md +36 -10
  2. package/README.md +37 -11
  3. package/lib/client.js +1475 -197
  4. package/lib/index.js +12 -2
  5. package/lib/slots.d.ts +18 -0
  6. package/package.json +9 -3
package/README.en.md CHANGED
@@ -23,22 +23,35 @@ You need a cleaner DeepSeek Harness sidebar: keep workspaces and conversations i
23
23
 
24
24
  ## Features
25
25
 
26
- - **Keep conversations in the foreground**: workspaces and conversations stay in a dedicated wide pane; navigation overlays it instead of squeezing the conversation area.
26
+ > `0.1.1` adds compact rail widgets, a configurable clock, grouped settings, and short-window navigation improvements.
27
+
28
+ - **Keep conversations in the foreground**: workspaces and conversations stay in a dedicated wide pane; expanded navigation overlays it instead of squeezing the conversation area.
27
29
  - **Tuck global entry points out of the way**: place the brand, panels, and tools along a narrow left rail to leave more room for browsing sessions.
28
30
  - **Choose the interaction that fits**: hover or keyboard focus expands the rail by default; click mode pins it open and closes on another click, Escape, or an outside click.
29
- - **Shape the sidebar around your workflow**: reposition the brand, global navigation, and tools, then compare the saved layout with an unsaved preview before applying it.
31
+ - **Shape the sidebar around your workflow**: reposition the brand, global navigation, and tools, then review the layout preview before applying it.
30
32
  - **Keep DSH's native actions**: New Session, panels, workspaces, settings, and footer tools keep their DSH entry points and behavior.
33
+ - **See widgets in the compact rail**: the clock and widgets you choose sit at the bottom of the rail. In settings you can enable, disable, and reorder them, and change the clock's hour cycle, month/day, weekday, and time color.
31
34
 
32
35
  ## Install
33
36
 
34
- Verified on DSH `0.2.0-rc.2`, `0.2.1-rc.2`, and `0.2.1-rc.3` in the `web` profile. See the [compatibility record](docs/compatibility.md) for the supported range.
37
+ The current source was verified on DSH `0.2.1-rc.3` in the `web` profile. See the [compatibility record](docs/compatibility.md) for the supported range.
38
+
39
+ ### Everyday users: npm release
40
+
41
+ Install the exact version:
42
+
43
+ ```sh
44
+ dsh plugin --profile web add dsh-better-left-sidebar@0.1.1
45
+ ```
46
+
47
+ Restart DSH after installing.
35
48
 
36
- ### Everyday users: GitHub preview
49
+ ### Install from GitHub
37
50
 
38
- There is no npm package or versioned GitHub release yet. You can install the preview from the public `main` branch. It is a rolling preview channel; installed copies do not update automatically.
51
+ You can also install the matching GitHub Release:
39
52
 
40
53
  ```sh
41
- dsh plugin --profile web add github:exoticknight/dsh-better-left-sidebar#main
54
+ dsh plugin --profile web add github:exoticknight/dsh-better-left-sidebar#v0.1.1
42
55
  ```
43
56
 
44
57
  Restart DSH after installing.
@@ -64,6 +77,11 @@ pnpm dev
64
77
  1. When enabled, the workspace and conversation list stay open; the far-left rail holds the DSH brand, global panels, and tools.
65
78
  2. In the default mode, hover over the rail or keyboard-focus a navigation item to reveal the full navigation. It closes after you leave it. Choose click mode in the plugin settings to pin or close the rail with the toggle button.
66
79
  3. Open **Plugins** in the sidebar, then **Better Left Sidebar** to configure expansion, animation, and region placement. Review the preview and select **Save settings** to apply changes. Copy follows DSH's active language; switch between Chinese and English in **Settings → General**.
80
+ 4. Use **[Compact widgets](docs/compact-widgets.md)** on the same settings page to manage the clock and compatible widgets. Expand **Display settings** under the clock to change its hour cycle, date, weekday, and time color. Date and Weekday can both be checked, and the **Effect preview** uses the same width as the rail. A widget that does not fit is marked **Hidden: not enough space**. New registrations are enabled by default, and their order and enablement are saved in the current profile.
81
+
82
+ ### Adapt your plugin to the compact rail
83
+
84
+ Plugin authors can register display-only widgets by following the [compact widget guide](docs/compact-widgets.md). Saved preferences remain available while a plugin is unloaded.
67
85
 
68
86
  ## Configuration
69
87
 
@@ -76,16 +94,24 @@ After you select **Save settings**, layout preferences are stored in the current
76
94
  | Brand | `navigation-top` | Place the brand at the top of the rail, at the top of the conversation pane, or hide it. |
77
95
  | Global navigation | `rail` | Keep global navigation in the rail or move it above conversations. |
78
96
  | Tools and status | `rail-bottom` | Keep tools at the bottom of the rail or move them below conversations. |
97
+ | [Compact widgets](docs/compact-widgets.md) | Clock and new registrations enabled | Enable, disable, and reorder widgets in plugin settings; preferences are saved in the current DSH profile. |
98
+ | Clock | 24-hour, month/day, primary color | 12-hour mode adds P or A after the time. Date and Weekday can both be checked. Choose Follow theme or Custom color; custom colors stay fixed across themes. The preview follows the draft, and the rail updates when you save. |
79
99
 
80
100
  ## Update, roll back, remove
81
101
 
82
- The current user install is a preview from `main`, with no versioned release yet. To update it, remove the preview and install it again using the command above. A versioned rollback will be available once GitHub Releases has a tagged release.
102
+ To update to or reinstall `0.1.1`, remove the plugin and install the exact version:
83
103
 
84
104
  ```sh
85
105
  dsh plugin --profile web remove dsh-better-left-sidebar
86
106
  ```
87
107
 
88
- [View GitHub Releases](https://github.com/exoticknight/dsh-better-left-sidebar/releases).
108
+ ```sh
109
+ dsh plugin --profile web add dsh-better-left-sidebar@0.1.1
110
+ ```
111
+
112
+ To roll back, replace the version in the install command with `0.1.0`. [View GitHub Releases](https://github.com/exoticknight/dsh-better-left-sidebar/releases).
113
+
114
+ Removing the plugin uninstalls its package; conversations and other plugins in the DSH profile remain.
89
115
 
90
116
  Developers can remove the plugin from the isolated preview profile:
91
117
 
@@ -95,11 +121,11 @@ pnpm dev:dsh --profile web plugin remove dsh-better-left-sidebar
95
121
 
96
122
  ## Privacy and data
97
123
 
98
- The plugin rearranges DSH's existing sidebar and uses DSH's built-in configuration service to save layout preferences you explicitly submit. It makes no direct network requests, reads no conversation content, writes no workspace files, stores no credentials, and collects no telemetry. DSH manages the profile's configuration storage and sync.
124
+ The plugin rearranges DSH's existing sidebar and uses DSH's built-in configuration service to save the layout, widget order and enablement, and clock display preferences you explicitly submit. It makes no direct network requests, reads no conversation content, writes no workspace files, stores no credentials, and collects no telemetry. DSH manages the profile's configuration storage and sync.
99
125
 
100
126
  ## Compatibility
101
127
 
102
- Supports the `web` profile on DSH `>=0.2.0-rc.2 <0.2.2-0`. The plugin keeps DSH's native sidebar width. At a `567×626` viewport, DSH's “Standard mode” label can truncate at the default `280px` or minimum `264px` width; widen the DSH sidebar if the full label matters. See the [compatibility record](docs/compatibility.md).
128
+ Supports the `web` profile on DSH `>=0.2.0-rc.2 <0.2.2-0`. With Global navigation set to Above conversations, the global-navigation list scrolls independently to leave room for conversation content and footer tools; it shrinks first in short windows and can reach `0` at extreme heights. DSH's native “Standard mode” label can still truncate at a `567×626` viewport and the default `280px` or minimum `264px` sidebar width; widen the DSH sidebar if the full label matters. See the [compatibility record](docs/compatibility.md).
103
129
 
104
130
  ## Development
105
131
 
package/README.md CHANGED
@@ -23,22 +23,35 @@
23
23
 
24
24
  ## 功能
25
25
 
26
- - **让会话始终留在主位**：工作区和会话列表保留在独立宽栏；导航展开时覆盖在其上方，不会挤窄对话区。
27
- - **把全局入口收纳起来**：品牌、面板和工具可以分布在左侧窄栏，空出更完整的会话浏览区域。
26
+ > `0.1.1` 加入收起栏小组件、可配置时钟和分组设置，并包含小窗口导航改进。
27
+
28
+ - **让会话始终留在主位**：工作区和会话列表保留在独立宽栏；展开导航时覆盖在其上，不会挤窄对话区。
29
+ - **把全局入口收纳起来**：品牌、面板和工具可分布在左侧窄栏，空出更完整的会话浏览区域。
28
30
  - **鼠标、键盘、点击都能顺手操作**：默认悬停或聚焦时展开；也可切换为点击固定展开，并用再次点击、Esc 或外部点击收起。
29
- - **按自己的习惯安排侧栏**：调整品牌、全局导航和工具区的位置；保存前可对照当前布局与未保存预览。
31
+ - **按自己的习惯安排侧栏**：调整品牌、全局导航和工具区的位置；保存前可查看布局效果预览。
30
32
  - **保留 DSH 原生操作**：新建会话、面板、工作区、设置和页脚工具仍使用 DSH 自己的入口与处理逻辑。
33
+ - **在收起栏查看小组件**：时钟和你选择的插件小组件显示在导航栏底部。设置里可以启用、停用、排序，并调整时钟的小时制、月/日、星期和时间颜色。
31
34
 
32
35
  ## 安装
33
36
 
34
- 已在 DSH `0.2.0-rc.2`、`0.2.1-rc.2` 和 `0.2.1-rc.3` 的 `web` profile 验证；支持范围见[兼容性记录](docs/compatibility.md)。
37
+ 当前源码已在 DSH `0.2.1-rc.3` 的 `web` profile 验证；支持范围见[兼容性记录](docs/compatibility.md)。
38
+
39
+ ### 普通用户：npm 发布版
40
+
41
+ 安装精确版本：
42
+
43
+ ```sh
44
+ dsh plugin --profile web add dsh-better-left-sidebar@0.1.1
45
+ ```
46
+
47
+ 安装后重启 DSH。
35
48
 
36
- ### 普通使用者：GitHub 预览版
49
+ ### 从 GitHub 安装
37
50
 
38
- 目前还没有 npm 包或正式 GitHub Release。可以从公开仓库安装 `main` 分支的预览版；它是持续更新的预览渠道，已安装的插件不会自动更新。
51
+ 也可以安装对应版本的 GitHub Release：
39
52
 
40
53
  ```sh
41
- dsh plugin --profile web add github:exoticknight/dsh-better-left-sidebar#main
54
+ dsh plugin --profile web add github:exoticknight/dsh-better-left-sidebar#v0.1.1
42
55
  ```
43
56
 
44
57
  安装后重启 DSH。
@@ -64,6 +77,11 @@ pnpm dev
64
77
  1. 插件启用后，工作区与会话列表保持展开；最左侧窄栏放置 DSH 品牌、全局面板和工具入口。
65
78
  2. 默认将鼠标移入导航栏，或用键盘聚焦导航项，即可展开完整导航；离开导航区域且不再聚焦时自动收起。也可在插件设置中选择“点击展开”，通过点击固定或收起导航。
66
79
  3. 打开侧栏的“插件”页，进入“更顺手的左侧栏”配置展开方式、动画和区域位置；修改布局后先看预览，再点“保存设置”。文案跟随 DSH 当前语言；在“设置 → 通用设置”切换简体中文或 English。
80
+ 4. 在同一设置页的“[收起栏小组件](docs/compact-widgets.md)”管理时钟和适配插件的小组件。展开时钟的“显示设置”，可改小时制、日期、星期和时间颜色；日期与星期可同时勾选，旁边的“效果预览”与收起栏同宽。空间不足时，组件行会显示“空间不足，暂未显示”。首次注册默认启用，顺序与启用状态保存在当前 profile。
81
+
82
+ ### 让你的插件适配收起栏
83
+
84
+ 开发者可按[收起栏小组件指南](docs/compact-widgets.md)注册只展示信息的小组件。卸载或暂时未加载的插件仍会保留已保存的设置。
67
85
 
68
86
  ## 配置
69
87
 
@@ -76,16 +94,24 @@ pnpm dev
76
94
  | 品牌区 | `navigation-top` | 可放在导航栏顶部、对话面板顶部，或隐藏。 |
77
95
  | 全局导航 | `rail` | 可放在左侧导航栏，或移到对话列表上方。 |
78
96
  | 工具与状态 | `rail-bottom` | 可放在导航栏底部，或移到对话列表下方。 |
97
+ | [收起栏小组件](docs/compact-widgets.md) | 时钟与已注册项目默认启用 | 在插件设置中启用、停用和排序；偏好保存在当前 DSH profile。 |
98
+ | 时钟 | 24 小时，月/日，主色 | 小时制可选 12 小时，时间后加 P 或 A。日期和星期可以同时勾选。时间颜色可选“跟随主题”或“自定义颜色”，自定义颜色不随主题变化。预览跟随草稿，保存后收起栏才变。 |
79
99
 
80
100
  ## 更新、回滚与卸载
81
101
 
82
- 当前普通用户安装来源是 `main` 预览版，还没有带版本号的正式发行包。更新预览版时，先卸载再按上方命令重新安装；回滚到正式版本需等 GitHub Releases 提供带版本号的发行版。
102
+ 更新到 `0.1.1` 或重新安装时，先移除插件，再安装精确版本：
83
103
 
84
104
  ```sh
85
105
  dsh plugin --profile web remove dsh-better-left-sidebar
86
106
  ```
87
107
 
88
- [查看 GitHub Releases](https://github.com/exoticknight/dsh-better-left-sidebar/releases)。
108
+ ```sh
109
+ dsh plugin --profile web add dsh-better-left-sidebar@0.1.1
110
+ ```
111
+
112
+ 需要回滚时，将安装命令中的版本改为 `0.1.0`。[查看 GitHub Releases](https://github.com/exoticknight/dsh-better-left-sidebar/releases)。
113
+
114
+ 移除插件只会卸载插件包；当前 DSH profile 中的会话和其他插件会保留。
89
115
 
90
116
  开发者可从隔离的预览 profile 移除插件：
91
117
 
@@ -95,11 +121,11 @@ pnpm dev:dsh --profile web plugin remove dsh-better-left-sidebar
95
121
 
96
122
  ## 隐私与数据
97
123
 
98
- 插件只调整 DSH 现有侧栏，并通过 DSH 内置配置服务保存你明确提交的布局偏好。插件不直接发起网络请求、不读取对话内容、不写入工作区文件、不保存凭据，也不采集遥测；配置的存储与同步由 DSH profile 管理。
124
+ 插件只调整 DSH 现有侧栏，并通过 DSH 内置配置服务保存你明确提交的布局、组件排序与启用状态、时钟显示偏好。插件不直接发起网络请求、不读取对话内容、不写入工作区文件、不保存凭据，也不采集遥测；配置的存储与同步由 DSH profile 管理。
99
125
 
100
126
  ## 兼容性
101
127
 
102
- 支持 DSH `>=0.2.0-rc.2 <0.2.2-0` 的 `web` profile。插件沿用 DSH 原生侧栏宽度；DSH 自带的“Standard mode”标签在 `567×626` 窗口和默认 `280px` 或最小 `264px` 侧栏宽度下可能被截断，可调宽 DSH 侧栏。详见[兼容性记录](docs/compatibility.md)。
128
+ 支持 DSH `>=0.2.0-rc.2 <0.2.2-0` 的 `web` profile。将“全局导航”设为“对话列表上方”时，导航列表独立滚动，为会话内容和底部工具留出空间；窗口变矮时导航区优先收缩，极端高度下可缩至 `0`。DSH 自带的“Standard mode”标签在 `567×626` 窗口和默认 `280px` 或最小 `264px` 侧栏宽度下仍可能被截断，可调宽 DSH 侧栏。详见[兼容性记录](docs/compatibility.md)。
103
129
 
104
130
  ## 开发
105
131