[js] 文档树文档置顶和设置颜色 [0.0.8 完美版]

本贴最后更新于 289 天前,其中的信息可能已经东海扬尘

功能

  1. 文档树中,选择文档或文件夹,右键置顶,即在父级文件夹中置顶选中的文档或文件夹。
  2. 文档树中,选择文档或文件夹,右键选择颜色,即为选中的文档或文件夹添加指定的颜色。
  3. 文档树中,右键菜单出现时,按住 shift(手机版长按置顶按钮),可以置顶到顶层(支持文档和文件夹)。
  4. 兼容 pc 版和手机版

注意:暂不支持笔记本的置顶和设置颜色。

最新版 0.0.8

  1. 增加记住顶层置顶文件夹展开状态;
  2. 修复文件夹置顶到顶层后定位不到问题;
  3. 增加置顶/取消置顶时自动定位到目标文档;
  4. 修复文档全部折叠后顶层置顶恢复后需要刷新才能显示的问题;
  5. 修复已取消的顶层置顶无法实时同步问题;
  6. 优化交互体验细节

效果

动画演示
r119.gif

pc 版
image.png

手机版
image.png

使用说明

参数说明

// 是否开启置顶功能,true 开启,false 不开启
const isEnableTopmost = true;

// 是否开启颜色功能,true 开启,false 不开启
const isEnableColor = true;

// 是否开启顶层置顶功能,true 开启,false 不开启
const isEnableTopmostLevel1 = true;

// 预设颜色列表,格式 {"主题":{"明暗风格":{"编码":{style:"颜色值", "description":"颜色描述"}}}},编码值必须唯一,编码修改则原来设置的颜色将失效
// "---1": {}, 代表分割线,后面的序号必须递增
// (切换主题或亮色暗色风格时自动会切换配色方案)
// 为了让目录树的颜色更突出,默认加了加粗显示(font-weight:bold 样式),如果你不需要去掉这个样式即可

let colors = {
    "default": {
        "light": {
            "now": { "style": "color:#1D4ED8;font-weight:bold;", "description": "NOW" },
            ...
        },
        "dark": {
            "now": { "style": "color:#42A5F5;font-weight:bold;", "description": "NOW" },
            ...
        }
    }
};

第一次运行后,会把该默认配置保存到 /data/storage/tree_colors_user_config.json 中,以后配置颜色只需要修改该文件即可,这样不受代码片段升级的影响。

也可以把 tree_colors_user_config.json 发出来与大家分享您的创意。

该配色灵感来自 @Floria233 大佬提供的配色方案,感谢 @Floria233 大佬!

see [js] 文档树文档置顶和设置颜色 [0.0.8 完美版] - Floria233 的回帖

存储文件及使用说明
  1. 修改/data/storage/tree_colors_user_config.json 文件即可修改默认配色方案(第一次运行后生成)
  2. 取消全部置顶只需删除/data/storage/tree_topmost.json 文件即可(第一次置顶时生成)
  3. 取消全部颜色只需删除/data/storage/tree_colors.json 文件即可(第一次设置颜色时生成)
  4. 取消全部顶层置顶只需删除/data/storage/tree_topmost_level1.json 文件即可(第一次设置顶层置顶时生成)
更新说明

0.0.4 版本及以前的用户升级,需要先备份好代码里的 colors 参数配置再升级。

0.0.5 及以后的用户升级,只需要备份好/data/storage/tree_colors_user_config.json 文件即可。

获取已标记颜色的文档

可以用 F 佬的书签 + 实现,操作步骤如下图

image.png

JavaScript 代码如下:

async function main() {
    let colors = await getFile('/data/storage/tree_colors.json') || '{}';
    try {
        colors = JSON.parse(colors);
    } catch (e) {}
    const colorIds = Object.keys(colors) || [];
    return colorIds;
    async function getFile(path, type = 'text') {
        return fetch("/api/file/getFile", {
            method: "POST",
            headers: { "Content-Type": "application/json" },
            body: JSON.stringify({ path }),
        }).then((response) => {
            if (response.ok) {
                if(type==='json') return response.json();
                else if(type==='blob') return response.blob();
                else return response.text();
            } else {
                throw new Error("Failed to get file content");
            }
        }).catch((error) => {
            console.error(error);
        });
    }
}
return main();

缘起

看到论坛小伙伴们和我都有置顶的需求,就实现了这个功能,顺便也把我想要的颜色配置也实现了。

起初本想用插件来着,后来鉴于能用就不折腾的思想,一切从简了。

分享您的配色方案

也可以把您的 tree_colors_user_config.json 配色方案贴出来与大家分享。

默认配色方案如下(切换主题或亮色暗色风格时自动会切换颜色方案)

亮色主题
image.png

image.png

image.png

暗色主题
image.png

image.png

image.png

多个风格主题,可在不同文件夹中使用不同风格样式。

旧版本(0.0.4 版)

与 0.0.5+ 的区别是不支持根据主题及明暗风格配置颜色方案。

代码

https://gitee.com/wish163/mysoft/blob/db03ef3d4206b5235ee7b85d2dd273f717b315d1/%E6%80%9D%E6%BA%90/%E7%BB%99%E6%96%87%E6%A1%A3%E6%A0%91%E6%96%87%E6%A1%A3%E6%B7%BB%E5%8A%A0%E9%A2%9C%E8%89%B2%E5%92%8C%E7%BD%AE%E9%A1%B6.js

效果

pc 版

image.png

手机版

image.png

参数说明
// 是否开启置顶功能,true开启,false不开启
const isEnableTopmost = true;

// 是否开启颜色功能,true开启,false不开启
const isEnableColor = true;
  
  
// 预设颜色列表,格式 {"编码":{style:"颜色值", "description":"颜色描述"}},编码值必须唯一
// 也可以把该配置贴出来与大家分享您的创意
//默认颜色组采用20种人类最易识别的颜色 see https://zhuanlan.zhihu.com/p/508870810
const colors = {
   "orangeRed": { style: "color:#e6194B", description: "橙红色" },
   "green": { style: "color:#3cb44b", description: "绿色" },
   "yellow": { style: "color:#ffe119", description: "黄色" },
   ...
}

鸣谢

再次感谢 @Floria233 大佬的配色灵感及提供这么多好的配色方案!

打赏作者

image.png

代码

👇 打赏后可见(为什么要打赏后可见?主要想通过这种方式统计使用人数及用户需求,以帮助作者分析哪些功能是用户最需要的)

打赏 30 积分后可见
30 积分 • 26 打赏
  • 思源笔记

    思源笔记是一款隐私优先的个人知识管理系统,支持完全离线使用,同时也支持端到端加密同步。

    融合块、大纲和双向链接,重构你的思维。

    28446 引用 • 119783 回帖
  • 代码片段

    代码片段分为 CSS 与 JS 两种代码,添加在 [设置 - 外观 - 代码片段] 中,这些代码会在思源笔记加载时自动执行,用于改善笔记的样式或功能。

    用户在该标签下分享代码片段时需在帖子标题前添加 [css] [js] 用于区分代码片段类型。

    285 引用 • 1986 回帖

相关帖子

优质回帖

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...
  • wilsons

    没有,这种情况应该是你存储的代码片段和思源页面的编码不一致导致的。

    如果你把代码片段存储到单纯的文件中,检查下文件的编码是否 utf-8

  • 其他回帖
  • 在新工作空间中也试了一下,只装载了这个 JS,能复现这个问题,即:

    • 在文档树菜单中,连续右击文档时,第一次会出现置顶及调色选项,第二次及以后不出现。
    • 这个问题,只在连续右击文档时,才会出现;只要做过其他操作,就会正常显示。
    • 其实也不影响使用,毕竟这种连续右击的情况比较少。
    1 回复
  • wilsons

    抛砖引玉,分享一个颜色方案。

    image.pngimage.png

    {
        "default": {
            "light": {
                "draft": {
                    "style": "color:#FF9800;font-weight:bold;",
                    "description": "草稿"
                },
                "archived": {
                    "style": "color:#9E9E9E;font-weight:bold;",
                    "description": "存档"
                },
                "published": {
                    "style": "color:#4CAF50;font-weight:bold;",
                    "description": "已发布"
                },
                "deleted": {
                    "style": "color:#F44336;font-weight:bold;",
                    "description": "删除"
                },
                "being_edited": {
                    "style": "color:#9C27B0;font-weight:bold;",
                    "description": "修改中"
                },
                "scheduled": {
                    "style": "color:#2196F3;font-weight:bold;",
                    "description": "待发布"
                }
            },
            "dark": {
                "draft": {
                    "style": "color:#FFB300;font-weight:bold;",
                    "description": "草稿"
                },
                "archived": {
                    "style": "color:#B0BEC5;font-weight:bold;",
                    "description": "存档"
                },
                "published": {
                    "style": "color:#66BB6A;font-weight:bold;",
                    "description": "已发布"
                },
                "deleted": {
                    "style": "color:#FF5252;font-weight:bold;",
                    "description": "删除"
                },
                "being_edited": {
                    "style": "color:#AB47BC;font-weight:bold;",
                    "description": "修改中"
                },
                "scheduled": {
                    "style": "color:#29B6F6;font-weight:bold;",
                    "description": "待发布"
                }
            }
        }
    }
    
    1 回复
  • 我用的是 0.0.3 版,今早更新的。思源版本是最新的 3.1.24。

    之前主题用的是 Savor,用 QYL 或默认主题都一样。以下录屏是默认主题,关闭了所有 CSS 代码,JS 代码仅开了本体,重启思源之后录的。

    关掉所有插件,结果也是一样(见下面的录屏)。而且我发现:

    • 如果每次右击文档后,光标在正文点一下,再去右击文档,那就会有选项;
    • 但如果右击文档后,直接再去右击另一个文档,那第二次及之后就没有选项。
  • 查看全部回帖
wilsons
正式入驻知乎了,以后新贴主要在这里。 欢迎大家订阅关注! 你的关注对我是莫大鼓励,也能让我持续产出优质内容,我们一起成长 🙏 点这里立即关注:https://www.zhihu.com/people/wilsonses