介绍
@theia/preferences-api 是一个用于实现个人喜好管理的可扩展 API，可以用于 Theia、VSCode 等编辑器的扩展开发。
安装
使用 npm，即可快速集成 @theia/preferences-api
npm install @theia/preferences-api
代码示例
也可以通过以下代码快速实现一个用户首选项配置项：
-- -------------------- ---- -------
------ - ------------------ ---------------- - ---- ------------------------
------ -------- ------------------- ---------------- -
----- ----------------- - --- -------------------
--------- ----------------
--------- -
----- ----- -----
--------- ---------
--------- ---
------ ------
-
---
----- ---------------- - --- ----------------------
------------------ -----------------
---
------------------------------------------- -------------------
------------------------------------------ ------------------
-这个代码片段在启动时，将自动创建名为 my.ext.schema 的首选项，并自动填充默认的信息。同时这段代码还包含了服务注册的逻辑，以便服务能够在应用程序中使用。
指南
构建首选项维护界面
为了更好的利用 @theia/preferences-api 的功能，建议动手搭建自己的 UI 界面来维护首选项。这能够让用户更直观的进行配置，同时也可以增加自己的特色功能，提升用户体验。
为了快速实现这个功能，推荐使用 React 组件来搭建界面，示例代码如下：
-- -------------------- ---- -------
------ - ---------- - ---- ------------
------ - -- ----- ---- --------
------ - ------------------ ---------------- - ---- -------------------------
--------- ------------------ -
------------------ ------------------
-
--------- ------------------ -
----- -------
--------- -------
--------- -------
------ ------- - -------
-
-------------
------ ----- ------------------- ------- ----------------------------------- ------------------- -
------------------ ------------------- -
-------------
----- ----------- - ----------------------------------------------
---------- - -
----- --------------------
--------- ------------------------
--------- ------------------------
------ --------------------
--
-
-------------------- ---- -
----- -------- - ------- ---- -- -
---------------------------------
--
--------------------------------------------------------------
-
----------------------- ---- -
---------------------------------------------------------------
-
----------------- - ------- ------------------------------------ -- -
----- ------ - --------------------
--------------------- -- -- --------- -------------- ------------ ----
-----------------------
-
------------------ - ------- ------------------------------------- -- -
----- ------ - --------------------
--------------------- -- -- --------- -------------- ------------ ----
-----------------------
-
------------ - ------- --------------------------------- -- -
--------------------------------------------------------
-----------------------
-
-------- -
------ -
----- -----------------------------
-------
-----
------ ----------- ----------- ----------------------- --------------------------------- --
--------
-------
---------
------- --------------- --------------------------- -----------------------------------
------- --------------------------------------
------- --------------------------------------
------- ------------------------------
---------
--------
-------
---- -----
------ ------------- --------------- --------------------------- --------------------------------- --
--------
-------
------
------- ------------ ------------------------ -----------------------------------
------- ----------------------------
------- --------------------------
---------
--------
------ ------------- ------------ --
-------
--
-
-这个示例代码中，我们可以看到一个与 @theia/preferences-api 集成的 React 组件。其中，我们通过 PreferenceService 来获取当前已经保存的首选项，并在组件状态中存储。在 componentDidMount 生命周期中，我们注册了一个 PreferenceService 的监听器来实现双向数据绑定。在 handleSubmit 中，通过 PreferenceService 内部实现的 API 来更新保存在服务器端的首选项。
总结
@theia/preferences-api 是一个十分方便的工具，通过它，我们可以轻松实现个人喜好管理的功能。同时，对于扩展开发者而言，它也提供了充足的支持。如果在开发过程中遇到一些问题，可以多去官网搜索资料，或是在社区寻求帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005784a81e8991b448eaee9