Skip to content
This repository was archived by the owner on Sep 23, 2024. It is now read-only.

TransMux/SiYuan-Attributes-Panel

Folders and files

NameName
Last commit message
Last commit date

Latest commit

author
Mux
Jan 16, 2024
48ece4f · Jan 16, 2024
Dec 29, 2023
Dec 29, 2023
Nov 1, 2023
Jan 14, 2024
Nov 1, 2023
Nov 1, 2023
Nov 1, 2023
Nov 1, 2023
Nov 1, 2023
Jan 14, 2024
Jan 14, 2024
Nov 1, 2023
Jan 14, 2024
Jan 14, 2024
Dec 29, 2023
Jan 16, 2024
Dec 29, 2023
Nov 1, 2023
Nov 1, 2023
Nov 1, 2023
Nov 2, 2023

Repository files navigation

属性面板SiYuan-Attributes-Panel

注意:目前数据库中的单选,多选,日期选择修改存在一些奇怪的问题(比如会造成属性类型的混乱),还需要进一步研究,目前最好不要修改这些类型的数据。所以这几个类型目前是只读状态,很快修复!

即将推出的功能...

快的话这周就能完工, 欢迎跟踪进度 / 催更 / 提建议

插件功能

目前没有任何设置项,开箱即用

通过这个插件可以实现:

  1. 在文档下面显示一个属性面板,展示文档级自定义属性,支持增删改查
  2. 支持暗黑模式
  3. 目前就这样... 比较简单,因为最初是写给我自己使用的,后面根据大家的反馈再增加新功能,所以如果有需求一定要反馈(反馈方式见下面)给我!!!不然我也不知道该往哪个方向开发

为什么开发这个插件

相关讨论可见这个issue: siyuan-note/siyuan#10084

兼容性说明

开发版本为v2.11.4, 暂时精力会放在核心功能开发上面, 暂时不会支持手机端(手机本来界面就小,没什么余地可以放下这个属性,如果要做的话需要仔细考虑交互,欢迎交流想法~)

因为本插件依赖的API非常基础,并不依赖于最新更新的特性,所以理论上更低的版本也能兼容,但是未经测试

版本号 电脑端 网页端 手机端
v2.11.4 不支持

✅:经过测试,全部功能可用

数据安全声明

出于对数据安全的绝对重视,本插件特此声明插件使用的所有API,同时代码完全开源(未编译未混淆),欢迎大家报告安全问题

本插件依赖的API有且仅有:

  1. /api/attr/getBlockAttrs:用于获取已有属性
  2. /api/attr/setBlockAttrs:用于设置属性
  3. /api/block/getBlockBreadcrumb:未来可以通过悬浮面板,支持对任意块属性的增删改查,通过这个API获取文档路径和文档内容以定位(目前没用)
  4. EventBus监听:loaded-protyle-static,即页面打开操作,以在适当的时机插入属性面板

插件权限

  • 关于数据:本插件对您数据的修改仅限于在用户操作下,根据用户指示,对指定块的属性做出指定的修改,不会修改其他任何内容
  • 关于UI:本插件对用户界面的修改仅限于在文档标题下增加一个属性面板,对其他部分均无任何影响
  • 关于联网:本插件完全本地,不包括任何外网通信

实现原理

为了快速开发,本插件使用如下技术栈:

框架Vue,组件库TDesign,其中自定义组件的支持完全来自于组件库

支持与反馈

有多种反馈方法任您选择:

  1. 在QQ群中找到我:思源笔记官方群一群二群三群以及折腾群里都能找到我(QQ:2294227991),您可以直接at我或者加我好友,但是QQ不常用,不保证一定能看到消息,更稳妥的话可以选择下面三个方法
  2. 通过微信:您可以直接扫描下面这个二维码添加我的微信,对您来说,这样是最快最高效的方式,但是我比较忙,可能回复的不会那么及时在此表示抱歉
微信二维码(如果看不到图请搜索微信号 `TransMux`)

  1. 通过Github Issue:您可以直接提一个Issue,这样的话便于大家一起讨论,但是可能及时性不会那么高
  2. 或者您是大佬,直接提一个PR进行改进:非常欢迎,荣幸之至!感谢您的贡献!