mirror of
https://github.com/Tencent/tmagic-editor.git
synced 2025-12-14 11:06:57 +08:00
94 lines
60 KiB
HTML
94 lines
60 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en-US" dir="ltr">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
<title>storageService方法 | tmagic-editor</title>
|
||
<meta name="description" content="页面可视化平台">
|
||
<meta name="generator" content="VitePress v1.6.4">
|
||
<link rel="preload stylesheet" href="/tmagic-editor/docs/assets/style.CZrNMGLM.css" as="style">
|
||
<link rel="preload stylesheet" href="/tmagic-editor/docs/vp-icons.css" as="style">
|
||
|
||
<script type="module" src="/tmagic-editor/docs/assets/app.BQO5-K90.js"></script>
|
||
<link rel="preload" href="/tmagic-editor/docs/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
|
||
<link rel="modulepreload" href="/tmagic-editor/docs/assets/chunks/theme.B4dNDs-I.js">
|
||
<link rel="modulepreload" href="/tmagic-editor/docs/assets/chunks/framework.DkLJC2NO.js">
|
||
<link rel="modulepreload" href="/tmagic-editor/docs/assets/api_editor_storageServiceMethods.md.DDiOwi5a.lean.js">
|
||
<meta name="theme-color" content="#646cff">
|
||
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
|
||
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
|
||
</head>
|
||
<body>
|
||
<div id="app"><div class="Layout" data-v-36591270><!--[--><!--]--><!--[--><span tabindex="-1" data-v-5856d2bc></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-5856d2bc>Skip to content</a><!--]--><!----><header class="VPNav" data-v-36591270 data-v-fcf6b202><div class="VPNavBar" data-v-fcf6b202 data-v-d86d8915><div class="wrapper" data-v-d86d8915><div class="container" data-v-d86d8915><div class="title" data-v-d86d8915><div class="VPNavBarTitle has-sidebar" data-v-d86d8915 data-v-4e485ca3><a class="title" href="/tmagic-editor/docs/" data-v-4e485ca3><!--[--><!--]--><!--[--><img class="VPImage logo" src="./favicon.png" alt data-v-d597c09a><!--]--><span data-v-4e485ca3>tmagic-editor</span><!--[--><!--]--></a></div></div><div class="content" data-v-d86d8915><div class="content-body" data-v-d86d8915><!--[--><!--]--><div class="VPNavBarSearch search" data-v-d86d8915><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-d86d8915 data-v-ff5533c3><span id="main-nav-aria-label" class="visually-hidden" data-v-ff5533c3> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/tmagic-editor/docs/guide/" tabindex="0" data-v-ff5533c3 data-v-67fc5a8e><!--[--><span data-v-67fc5a8e>文档</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink active" href="/tmagic-editor/docs/api/editor/props.html" tabindex="0" data-v-ff5533c3 data-v-67fc5a8e><!--[--><span data-v-67fc5a8e>API</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/tmagic-editor/docs/form-config/fields/text.html" tabindex="0" data-v-ff5533c3 data-v-67fc5a8e><!--[--><span data-v-67fc5a8e>表单配置</span><!--]--></a><!--]--><!--[--><a class="VPLink link vp-external-link-icon VPNavBarMenuLink" href="https://github.com/Tencent/tmagic-editor/releases" target="_blank" rel="noreferrer" tabindex="0" data-v-ff5533c3 data-v-67fc5a8e><!--[--><span data-v-67fc5a8e>更新日志</span><!--]--></a><!--]--><!--[--><a class="VPLink link vp-external-link-icon VPNavBarMenuLink" href="https://tencent.github.io/tmagic-editor/playground/index.html" target="_blank" rel="noreferrer" tabindex="0" data-v-ff5533c3 data-v-67fc5a8e><!--[--><span data-v-67fc5a8e>Playground</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-d86d8915 data-v-b495c88f><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-b495c88f data-v-2736d437 data-v-6c1c63e9><span class="check" data-v-6c1c63e9><span class="icon" data-v-6c1c63e9><!--[--><span class="vpi-sun sun" data-v-2736d437></span><span class="vpi-moon moon" data-v-2736d437></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-d86d8915 data-v-c0c31a4e data-v-98e6c5f3><!--[--><a class="VPSocialLink no-icon" href="https://github.com/Tencent/tmagic-editor" aria-label="github" target="_blank" rel="noopener" data-v-98e6c5f3 data-v-af4e3f83><span class="vpi-social-github"></span></a><!--]--></div><div class="VPFlyout VPNavBarExtra extra" data-v-d86d8915 data-v-a0fb53fe data-v-55d61167><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-55d61167><span class="vpi-more-horizontal icon" data-v-55d61167></span></button><div class="menu" data-v-55d61167><div class="VPMenu" data-v-55d61167 data-v-d54e0581><!----><!--[--><!--[--><!----><div class="group" data-v-a0fb53fe><div class="item appearance" data-v-a0fb53fe><p class="label" data-v-a0fb53fe>Appearance</p><div class="appearance-action" data-v-a0fb53fe><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-a0fb53fe data-v-2736d437 data-v-6c1c63e9><span class="check" data-v-6c1c63e9><span class="icon" data-v-6c1c63e9><!--[--><span class="vpi-sun sun" data-v-2736d437></span><span class="vpi-moon moon" data-v-2736d437></span><!--]--></span></span></button></div></div></div><div class="group" data-v-a0fb53fe><div class="item social-links" data-v-a0fb53fe><div class="VPSocialLinks social-links-list" data-v-a0fb53fe data-v-98e6c5f3><!--[--><a class="VPSocialLink no-icon" href="https://github.com/Tencent/tmagic-editor" aria-label="github" target="_blank" rel="noopener" data-v-98e6c5f3 data-v-af4e3f83><span class="vpi-social-github"></span></a><!--]--></div></div></div><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-d86d8915 data-v-fe6041d6><span class="container" data-v-fe6041d6><span class="top" data-v-fe6041d6></span><span class="middle" data-v-fe6041d6></span><span class="bottom" data-v-fe6041d6></span></span></button></div></div></div></div><div class="divider" data-v-d86d8915><div class="divider-line" data-v-d86d8915></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-36591270 data-v-cf58124c><div class="container" data-v-cf58124c><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-cf58124c><span class="vpi-align-left menu-icon" data-v-cf58124c></span><span class="menu-text" data-v-cf58124c>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-cf58124c data-v-b834c8bc><button data-v-b834c8bc>Return to top</button><!----></div></div></div><aside class="VPSidebar" data-v-36591270 data-v-5ef8d95b><div class="curtain" data-v-5ef8d95b></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-5ef8d95b><span class="visually-hidden" id="sidebar-aria-label" data-v-5ef8d95b> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="no-transition group" data-v-0aa5b47f><section class="VPSidebarItem level-0 has-active" data-v-0aa5b47f data-v-169b0f8b><div class="item" role="button" tabindex="0" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><h2 class="text" data-v-169b0f8b>编辑器</h2><!----></div><div class="items" data-v-169b0f8b><!--[--><section class="VPSidebarItem level-1" data-v-169b0f8b data-v-169b0f8b><div class="item" role="button" tabindex="0" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><h3 class="text" data-v-169b0f8b>Editor组件</h3><!----></div><div class="items" data-v-169b0f8b><!--[--><div class="VPSidebarItem level-2 is-link" data-v-169b0f8b data-v-169b0f8b><div class="item" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><a class="VPLink link link" href="/tmagic-editor/docs/api/editor/props.html" data-v-169b0f8b><!--[--><p class="text" data-v-169b0f8b>props</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-169b0f8b data-v-169b0f8b><div class="item" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><a class="VPLink link link" href="/tmagic-editor/docs/api/editor/slots.html" data-v-169b0f8b><!--[--><p class="text" data-v-169b0f8b>slots</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-169b0f8b data-v-169b0f8b><div class="item" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><a class="VPLink link link" href="/tmagic-editor/docs/api/editor/events.html" data-v-169b0f8b><!--[--><p class="text" data-v-169b0f8b>events</p><!--]--></a><!----></div><!----></div><!--]--></div></section><section class="VPSidebarItem level-1" data-v-169b0f8b data-v-169b0f8b><div class="item" role="button" tabindex="0" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><h3 class="text" data-v-169b0f8b>editorService</h3><!----></div><div class="items" data-v-169b0f8b><!--[--><div class="VPSidebarItem level-2 is-link" data-v-169b0f8b data-v-169b0f8b><div class="item" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><a class="VPLink link link" href="/tmagic-editor/docs/api/editor/editorServiceMethods.html" data-v-169b0f8b><!--[--><p class="text" data-v-169b0f8b>方法</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-169b0f8b data-v-169b0f8b><div class="item" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><a class="VPLink link link" href="/tmagic-editor/docs/api/editor/editorServiceEvents.html" data-v-169b0f8b><!--[--><p class="text" data-v-169b0f8b>事件</p><!--]--></a><!----></div><!----></div><!--]--></div></section><section class="VPSidebarItem level-1" data-v-169b0f8b data-v-169b0f8b><div class="item" role="button" tabindex="0" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><h3 class="text" data-v-169b0f8b>propsService</h3><!----></div><div class="items" data-v-169b0f8b><!--[--><div class="VPSidebarItem level-2 is-link" data-v-169b0f8b data-v-169b0f8b><div class="item" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><a class="VPLink link link" href="/tmagic-editor/docs/api/editor/propsServiceMethods.html" data-v-169b0f8b><!--[--><p class="text" data-v-169b0f8b>方法</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-169b0f8b data-v-169b0f8b><div class="item" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><a class="VPLink link link" href="/tmagic-editor/docs/api/editor/propsServiceEvents.html" data-v-169b0f8b><!--[--><p class="text" data-v-169b0f8b>事件</p><!--]--></a><!----></div><!----></div><!--]--></div></section><section class="VPSidebarItem level-1" data-v-169b0f8b data-v-169b0f8b><div class="item" role="button" tabindex="0" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><h3 class="text" data-v-169b0f8b>historyService</h3><!----></div><div class="items" data-v-169b0f8b><!--[--><div class="VPSidebarItem level-2 is-link" data-v-169b0f8b data-v-169b0f8b><div class="item" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><a class="VPLink link link" href="/tmagic-editor/docs/api/editor/historyServiceMethods.html" data-v-169b0f8b><!--[--><p class="text" data-v-169b0f8b>方法</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-169b0f8b data-v-169b0f8b><div class="item" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><a class="VPLink link link" href="/tmagic-editor/docs/api/editor/historyServiceEvents.html" data-v-169b0f8b><!--[--><p class="text" data-v-169b0f8b>事件</p><!--]--></a><!----></div><!----></div><!--]--></div></section><div class="VPSidebarItem level-1 is-link" data-v-169b0f8b data-v-169b0f8b><div class="item" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><a class="VPLink link link" href="/tmagic-editor/docs/api/editor/eventsServiceMethods.html" data-v-169b0f8b><!--[--><p class="text" data-v-169b0f8b>eventsService</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-169b0f8b data-v-169b0f8b><div class="item" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><a class="VPLink link link" href="/tmagic-editor/docs/api/editor/uiServiceMethods.html" data-v-169b0f8b><!--[--><p class="text" data-v-169b0f8b>uiService</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-169b0f8b data-v-169b0f8b><div class="item" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><a class="VPLink link link" href="/tmagic-editor/docs/api/editor/codeBlockServiceMethods.html" data-v-169b0f8b><!--[--><p class="text" data-v-169b0f8b>codeBlockService</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-169b0f8b data-v-169b0f8b><div class="item" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><a class="VPLink link link" href="/tmagic-editor/docs/api/editor/componentListServiceMethods.html" data-v-169b0f8b><!--[--><p class="text" data-v-169b0f8b>componentListService</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-169b0f8b data-v-169b0f8b><div class="item" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><a class="VPLink link link" href="/tmagic-editor/docs/api/editor/storageServiceMethods.html" data-v-169b0f8b><!--[--><p class="text" data-v-169b0f8b>storageService</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-0aa5b47f><section class="VPSidebarItem level-0" data-v-0aa5b47f data-v-169b0f8b><div class="item" role="button" tabindex="0" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><h2 class="text" data-v-169b0f8b>表单</h2><!----></div><div class="items" data-v-169b0f8b><!--[--><section class="VPSidebarItem level-1" data-v-169b0f8b data-v-169b0f8b><div class="item" role="button" tabindex="0" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><h3 class="text" data-v-169b0f8b>Form组件</h3><!----></div><div class="items" data-v-169b0f8b><!--[--><div class="VPSidebarItem level-2 is-link" data-v-169b0f8b data-v-169b0f8b><div class="item" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><a class="VPLink link link" href="/tmagic-editor/docs/api/form/form-props.html" data-v-169b0f8b><!--[--><p class="text" data-v-169b0f8b>props</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-169b0f8b data-v-169b0f8b><div class="item" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><a class="VPLink link link" href="/tmagic-editor/docs/api/form/form-methods.html" data-v-169b0f8b><!--[--><p class="text" data-v-169b0f8b>methods</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-169b0f8b data-v-169b0f8b><div class="item" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><a class="VPLink link link" href="/tmagic-editor/docs/api/form/form-events.html" data-v-169b0f8b><!--[--><p class="text" data-v-169b0f8b>events</p><!--]--></a><!----></div><!----></div><!--]--></div></section><section class="VPSidebarItem level-1" data-v-169b0f8b data-v-169b0f8b><div class="item" role="button" tabindex="0" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><h3 class="text" data-v-169b0f8b>FormDialog组件</h3><!----></div><div class="items" data-v-169b0f8b><!--[--><div class="VPSidebarItem level-2 is-link" data-v-169b0f8b data-v-169b0f8b><div class="item" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><a class="VPLink link link" href="/tmagic-editor/docs/api/form/form-dialog-props.html" data-v-169b0f8b><!--[--><p class="text" data-v-169b0f8b>props</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-169b0f8b data-v-169b0f8b><div class="item" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><a class="VPLink link link" href="/tmagic-editor/docs/api/form/form-dialog-methods.html" data-v-169b0f8b><!--[--><p class="text" data-v-169b0f8b>methods</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-169b0f8b data-v-169b0f8b><div class="item" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><a class="VPLink link link" href="/tmagic-editor/docs/api/form/form-dialog-events.html" data-v-169b0f8b><!--[--><p class="text" data-v-169b0f8b>events</p><!--]--></a><!----></div><!----></div><!--]--></div></section><!--]--></div></section></div><div class="no-transition group" data-v-0aa5b47f><section class="VPSidebarItem level-0" data-v-0aa5b47f data-v-169b0f8b><div class="item" role="button" tabindex="0" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><h2 class="text" data-v-169b0f8b>表格</h2><!----></div><div class="items" data-v-169b0f8b><!--[--><section class="VPSidebarItem level-1" data-v-169b0f8b data-v-169b0f8b><div class="item" role="button" tabindex="0" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><h3 class="text" data-v-169b0f8b>Table组件</h3><!----></div><div class="items" data-v-169b0f8b><!--[--><div class="VPSidebarItem level-2 is-link" data-v-169b0f8b data-v-169b0f8b><div class="item" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><a class="VPLink link link" href="/tmagic-editor/docs/api/table/props.html" data-v-169b0f8b><!--[--><p class="text" data-v-169b0f8b>props</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-169b0f8b data-v-169b0f8b><div class="item" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><a class="VPLink link link" href="/tmagic-editor/docs/api/table/methods.html" data-v-169b0f8b><!--[--><p class="text" data-v-169b0f8b>methods</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-169b0f8b data-v-169b0f8b><div class="item" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><a class="VPLink link link" href="/tmagic-editor/docs/api/table/events.html" data-v-169b0f8b><!--[--><p class="text" data-v-169b0f8b>events</p><!--]--></a><!----></div><!----></div><!--]--></div></section><!--]--></div></section></div><div class="no-transition group" data-v-0aa5b47f><section class="VPSidebarItem level-0" data-v-0aa5b47f data-v-169b0f8b><div class="item" role="button" tabindex="0" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><h2 class="text" data-v-169b0f8b>stage</h2><!----></div><div class="items" data-v-169b0f8b><!--[--><section class="VPSidebarItem level-1" data-v-169b0f8b data-v-169b0f8b><div class="item" role="button" tabindex="0" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><h3 class="text" data-v-169b0f8b>StageCore</h3><!----></div><div class="items" data-v-169b0f8b><!--[--><div class="VPSidebarItem level-2 is-link" data-v-169b0f8b data-v-169b0f8b><div class="item" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><a class="VPLink link link" href="/tmagic-editor/docs/api/stage/coreMethods.html" data-v-169b0f8b><!--[--><p class="text" data-v-169b0f8b>方法</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-169b0f8b data-v-169b0f8b><div class="item" data-v-169b0f8b><div class="indicator" data-v-169b0f8b></div><a class="VPLink link link" href="/tmagic-editor/docs/api/stage/coreEvents.html" data-v-169b0f8b><!--[--><p class="text" data-v-169b0f8b>事件</p><!--]--></a><!----></div><!----></div><!--]--></div></section><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-36591270 data-v-1a7b61fc><div class="VPDoc has-sidebar has-aside" data-v-1a7b61fc data-v-42ea4fcb><!--[--><!--]--><div class="container" data-v-42ea4fcb><div class="aside" data-v-42ea4fcb><div class="aside-curtain" data-v-42ea4fcb></div><div class="aside-container" data-v-42ea4fcb><div class="aside-content" data-v-42ea4fcb><div class="VPDocAside" data-v-42ea4fcb data-v-1d34bb44><!--[--><!--]--><!--[--><!--]--><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-1d34bb44 data-v-dcee81d9><div class="content" data-v-dcee81d9><div class="outline-marker" data-v-dcee81d9></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-dcee81d9>On this page</div><ul class="VPDocOutlineItem root" data-v-dcee81d9 data-v-f877905d><!--[--><!--]--></ul></div></nav><!--[--><!--]--><div class="spacer" data-v-1d34bb44></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-42ea4fcb><div class="content-container" data-v-42ea4fcb><!--[--><!--]--><main class="main" data-v-42ea4fcb><div style="position:relative;" class="vp-doc _tmagic-editor_docs_api_editor_storageServiceMethods" data-v-42ea4fcb><div><h1 id="storageservice方法" tabindex="-1">storageService方法 <a class="header-anchor" href="#storageservice方法" aria-label="Permalink to "storageService方法""></a></h1><h2 id="getstorage" tabindex="-1">getStorage <a class="header-anchor" href="#getstorage" aria-label="Permalink to "getStorage""></a></h2><ul><li><p><strong><a href="./../../guide/editor-expand.html#行为扩展">扩展支持</a>：</strong> 是</p></li><li><p><strong>参数：</strong> 无</p></li><li><p><strong>返回：</strong></p><ul><li><code>{Storage}</code> Storage 对象</li></ul></li><li><p><strong>详情：</strong></p><p>获取数据存储对象，默认返回 localStorage</p><p>可以通过插件机制替换为其他存储对象（如 sessionStorage）</p></li><li><p><strong>示例：</strong></p></li></ul><div class="language-js vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">js</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { storageService } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> '@tmagic/editor'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> storage</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> storageService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">getStorage</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">();</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">console.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">log</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(storage); </span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// localStorage</span></span>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// 通过插件替换为 sessionStorage</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">storageService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">usePlugin</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">({</span></span>
|
||
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> afterGetStorage</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">() {</span></span>
|
||
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> window.sessionStorage;</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> },</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><h2 id="getnamespace" tabindex="-1">getNamespace <a class="header-anchor" href="#getnamespace" aria-label="Permalink to "getNamespace""></a></h2><ul><li><p><strong><a href="./../../guide/editor-expand.html#行为扩展">扩展支持</a>：</strong> 是</p></li><li><p><strong>参数：</strong> 无</p></li><li><p><strong>返回：</strong></p><ul><li><code>{string}</code> 命名空间字符串</li></ul></li><li><p><strong>详情：</strong></p><p>获取存储项的命名空间，默认为 'tmagic'</p><p>命名空间用于区分不同应用的存储数据</p></li><li><p><strong>示例：</strong></p></li></ul><div class="language-js vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">js</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { storageService } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> '@tmagic/editor'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> namespace</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> storageService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">getNamespace</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">();</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">console.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">log</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(namespace); </span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// 'tmagic'</span></span></code></pre></div><h2 id="clear" tabindex="-1">clear <a class="header-anchor" href="#clear" aria-label="Permalink to "clear""></a></h2><ul><li><p><strong><a href="./../../guide/editor-expand.html#行为扩展">扩展支持</a>：</strong> 是</p></li><li><p><strong>参数：</strong> 无</p></li><li><p><strong>返回：</strong></p><ul><li><code>{void}</code></li></ul></li><li><p><strong>详情：</strong></p><p>清空当前存储对象中的所有数据</p></li><li><p><strong>示例：</strong></p></li></ul><div class="language-js vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">js</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { storageService } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> '@tmagic/editor'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">storageService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">clear</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">();</span></span></code></pre></div><h2 id="getitem" tabindex="-1">getItem <a class="header-anchor" href="#getitem" aria-label="Permalink to "getItem""></a></h2><ul><li><p><strong><a href="./../../guide/editor-expand.html#行为扩展">扩展支持</a>：</strong> 是</p></li><li><p><strong>参数：</strong></p><ul><li><code>{string}</code> key 存储项的键名</li><li><code>{Options}</code> options 可选配置 <ul><li><code>namespace?: string</code> 自定义命名空间</li><li><code>protocol?: Protocol</code> 数据协议类型</li></ul></li></ul></li><li><p><strong>返回：</strong></p><ul><li><code>{any}</code> 存储的值，如果不存在返回 null</li></ul></li><li><p><strong>详情：</strong></p><p>获取存储项，支持多种数据类型的自动解析</p><p>支持的协议类型：</p><ul><li><code>Protocol.OBJECT</code>: JavaScript 对象</li><li><code>Protocol.JSON</code>: JSON 格式</li><li><code>Protocol.NUMBER</code>: 数字类型</li><li><code>Protocol.BOOLEAN</code>: 布尔类型</li><li><code>Protocol.STRING</code>: 字符串类型</li></ul></li><li><p><strong>示例：</strong></p></li></ul><div class="language-js vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">js</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { storageService } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> '@tmagic/editor'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// 获取字符串</span></span>
|
||
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> str</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> storageService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">getItem</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'myKey'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// 使用自定义命名空间</span></span>
|
||
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> value</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> storageService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">getItem</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'key'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, { namespace: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'custom'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> });</span></span>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// 指定协议类型</span></span>
|
||
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> num</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> storageService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">getItem</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'count'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, { protocol: Protocol.</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">NUMBER</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> });</span></span></code></pre></div><h2 id="key" tabindex="-1">key <a class="header-anchor" href="#key" aria-label="Permalink to "key""></a></h2><ul><li><p><strong>参数：</strong></p><ul><li><code>{number}</code> index 索引位置</li></ul></li><li><p><strong>返回：</strong></p><ul><li><code>{string | null}</code> 指定位置的键名，不存在返回 null</li></ul></li><li><p><strong>详情：</strong></p><p>获取存储对象中指定索引位置的键名</p></li><li><p><strong>示例：</strong></p></li></ul><div class="language-js vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">js</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { storageService } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> '@tmagic/editor'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> firstKey</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> storageService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">key</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">0</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">console.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">log</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(firstKey);</span></span></code></pre></div><h2 id="removeitem" tabindex="-1">removeItem <a class="header-anchor" href="#removeitem" aria-label="Permalink to "removeItem""></a></h2><ul><li><p><strong><a href="./../../guide/editor-expand.html#行为扩展">扩展支持</a>：</strong> 是</p></li><li><p><strong>参数：</strong></p><ul><li><code>{string}</code> key 存储项的键名</li><li><code>{Options}</code> options 可选配置 <ul><li><code>namespace?: string</code> 自定义命名空间</li></ul></li></ul></li><li><p><strong>返回：</strong></p><ul><li><code>{void}</code></li></ul></li><li><p><strong>详情：</strong></p><p>移除指定的存储项</p></li><li><p><strong>示例：</strong></p></li></ul><div class="language-js vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">js</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { storageService } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> '@tmagic/editor'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// 移除默认命名空间下的存储项</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">storageService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">removeItem</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'myKey'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// 移除自定义命名空间下的存储项</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">storageService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">removeItem</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'key'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, { namespace: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'custom'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> });</span></span></code></pre></div><h2 id="setitem" tabindex="-1">setItem <a class="header-anchor" href="#setitem" aria-label="Permalink to "setItem""></a></h2><ul><li><p><strong><a href="./../../guide/editor-expand.html#行为扩展">扩展支持</a>：</strong> 是</p></li><li><p><strong>参数：</strong></p><ul><li><code>{string}</code> key 存储项的键名</li><li><code>{any}</code> value 要存储的值</li><li><code>{Options}</code> options 可选配置 <ul><li><code>namespace?: string</code> 自定义命名空间</li><li><code>protocol?: Protocol</code> 数据协议类型</li></ul></li></ul></li><li><p><strong>返回：</strong></p><ul><li><code>{void}</code></li></ul></li><li><p><strong>详情：</strong></p><p>设置存储项，自动序列化复杂数据类型</p></li><li><p><strong>示例：</strong></p></li></ul><div class="language-js vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">js</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { storageService, Protocol } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> '@tmagic/editor'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// 存储字符串</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">storageService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">setItem</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'name'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'tmagic'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// 存储对象</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">storageService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">setItem</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'config'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, { a: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">1</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, b: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">2</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> }, { protocol: Protocol.</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">OBJECT</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> });</span></span>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// 存储数字</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">storageService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">setItem</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'count'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">100</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, { protocol: Protocol.</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">NUMBER</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> });</span></span>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// 使用自定义命名空间</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">storageService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">setItem</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'key'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'value'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, { namespace: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'custom'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> });</span></span></code></pre></div><h2 id="destroy" tabindex="-1">destroy <a class="header-anchor" href="#destroy" aria-label="Permalink to "destroy""></a></h2><ul><li><p><strong>参数：</strong> 无</p></li><li><p><strong>返回：</strong></p><ul><li><code>{void}</code></li></ul></li><li><p><strong>详情：</strong></p><p>销毁 storageService，移除所有事件监听和插件</p></li><li><p><strong>示例：</strong></p></li></ul><div class="language-js vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">js</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { storageService } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> '@tmagic/editor'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">storageService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">destroy</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">();</span></span></code></pre></div><h2 id="use" tabindex="-1">use <a class="header-anchor" href="#use" aria-label="Permalink to "use""></a></h2><p>使用中间件的方式扩展方法，上述方法中标记有<code>扩展支持： 是</code>的方法都支持使用use扩展</p><ul><li><strong>示例：</strong></li></ul><div class="language-js vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">js</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { storageService } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> '@tmagic/editor'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">storageService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">use</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">({</span></span>
|
||
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> getItem</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">key</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">options</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">next</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) {</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> console.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">log</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'获取存储项:'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, key);</span></span>
|
||
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> next</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">();</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> },</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><h2 id="useplugin" tabindex="-1">usePlugin <a class="header-anchor" href="#useplugin" aria-label="Permalink to "usePlugin""></a></h2><ul><li><strong>详情：</strong></li></ul><p>相对于<a href="#use">use</a>, usePlugin支持更加灵活更加细致的扩展， 上述方法中标记有<code>扩展支持： 是</code>的方法都支持使用usePlugin扩展</p><p>每个支持扩展的方法都支持定制before、after两个hook来干预原有方法的行为，before可以用于修改传入参数，after可以用于修改返回的值</p><ul><li><strong>示例：</strong></li></ul><div class="language-js vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">js</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { storageService } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> '@tmagic/editor'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">storageService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">usePlugin</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">({</span></span>
|
||
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> beforeSetItem</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">key</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">value</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">options</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) {</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> console.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">log</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'设置前:'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, key, value);</span></span>
|
||
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> [key, value, options];</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> },</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> </span></span>
|
||
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> afterGetItem</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">result</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">key</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">options</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) {</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> console.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">log</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'获取后:'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, result);</span></span>
|
||
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> result;</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> },</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><h2 id="removeallplugins" tabindex="-1">removeAllPlugins <a class="header-anchor" href="#removeallplugins" aria-label="Permalink to "removeAllPlugins""></a></h2><ul><li><strong>详情：</strong></li></ul><p>删掉当前设置的所有扩展</p><ul><li><strong>示例：</strong></li></ul><div class="language-js vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">js</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { storageService } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> '@tmagic/editor'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">storageService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">removeAllPlugins</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">();</span></span></code></pre></div></div></div></main><footer class="VPDocFooter" data-v-42ea4fcb data-v-8365344e><!--[--><!--]--><!----><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-8365344e><span class="visually-hidden" id="doc-footer-aria-label" data-v-8365344e>Pager</span><div class="pager" data-v-8365344e><a class="VPLink link pager-link prev" href="/tmagic-editor/docs/api/editor/componentListServiceMethods.html" data-v-8365344e><!--[--><span class="desc" data-v-8365344e>Previous page</span><span class="title" data-v-8365344e>componentListService</span><!--]--></a></div><div class="pager" data-v-8365344e><a class="VPLink link pager-link next" href="/tmagic-editor/docs/api/form/form-props.html" data-v-8365344e><!--[--><span class="desc" data-v-8365344e>Next page</span><span class="title" data-v-8365344e>props</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-36591270 data-v-a79f70ae><div class="container" data-v-a79f70ae><p class="message" data-v-a79f70ae>Powered by 腾讯视频会员平台技术中心</p><p class="copyright" data-v-a79f70ae>Copyright (C) 2025 Tencent.</p></div></footer><!--[--><!--]--></div></div>
|
||
<script>window.__VP_HASH_MAP__=JSON.parse("{\"api_editor_codeblockservicemethods.md\":\"BX3_siEm\",\"api_editor_componentlistservicemethods.md\":\"CaiU5OMF\",\"api_editor_datasourceservicemethods.md\":\"CAoPyiGv\",\"api_editor_editorserviceevents.md\":\"gcFs85FS\",\"api_editor_editorservicemethods.md\":\"DKiiyoPz\",\"api_editor_events.md\":\"BykK47dJ\",\"api_editor_eventsservicemethods.md\":\"CQxboHVr\",\"api_editor_historyserviceevents.md\":\"B7KupcqD\",\"api_editor_historyservicemethods.md\":\"B4obX-T3\",\"api_editor_props.md\":\"DWCwb77u\",\"api_editor_propsserviceevents.md\":\"Bhooxxnn\",\"api_editor_propsservicemethods.md\":\"Bz1ljBiU\",\"api_editor_slots.md\":\"ChfXa7kw\",\"api_editor_storageservicemethods.md\":\"DDiOwi5a\",\"api_editor_uiservicemethods.md\":\"CpPtl7oI\",\"api_form_form-dialog-events.md\":\"BQrVPpPK\",\"api_form_form-dialog-methods.md\":\"DEL0Eh3K\",\"api_form_form-dialog-props.md\":\"BlahsoDf\",\"api_form_form-events.md\":\"CgPQ3xhz\",\"api_form_form-methods.md\":\"DVzlGQIE\",\"api_form_form-props.md\":\"B_-pPs7j\",\"api_stage_coreevents.md\":\"BJgI_eWC\",\"api_stage_coremethods.md\":\"cDBiJupB\",\"api_table_events.md\":\"uY2Q6YZ2\",\"api_table_methods.md\":\"QkOCzJ6I\",\"api_table_props.md\":\"_WrWithq\",\"form-config_compare.md\":\"CxuguNFe\",\"form-config_fields_cascader.md\":\"DDs-fgTi\",\"form-config_fields_checkbox.md\":\"9hHkO7zL\",\"form-config_fields_color-picker.md\":\"Bwmjw37v\",\"form-config_fields_date-picker.md\":\"DHFhUgO7\",\"form-config_fields_datetime-picker.md\":\"DBfKXCAu\",\"form-config_fields_display.md\":\"BaiQUX7K\",\"form-config_fields_hidden.md\":\"CY0o0qcd\",\"form-config_fields_link.md\":\"BO3PrLPD\",\"form-config_fields_number.md\":\"Cd3cTbQs\",\"form-config_fields_radio.md\":\"BuEqISL1\",\"form-config_fields_select.md\":\"D-hxYaPx\",\"form-config_fields_switch.md\":\"DRJauj9b\",\"form-config_fields_text.md\":\"D7E6aVnZ\",\"form-config_fields_textarea.md\":\"BytSbPPK\",\"form-config_fields_time-picker.md\":\"Cqzj5cz_\",\"form-config_layout.md\":\"2h_UimI8\",\"form-config_relate.md\":\"D4BEna2n\",\"guide_advanced_code-block.md\":\"B8iGTN8d\",\"guide_advanced_coupling.md\":\"DIxoB53H\",\"guide_advanced_data-source.md\":\"DG0DsdJV\",\"guide_advanced_js-schema.md\":\"HvE43RGl\",\"guide_advanced_layout.md\":\"B3q7H8Pu\",\"guide_advanced_page.md\":\"Db2dMbH0\",\"guide_advanced_tmagic-form.md\":\"Ctv1XIF5\",\"guide_advanced_tmagic-ui.md\":\"BKuDBLIF\",\"guide_component.md\":\"BxUtu8_5\",\"guide_conception.md\":\"BPjbVwPx\",\"guide_editor-expand.md\":\"hu4ukQA2\",\"guide_index.md\":\"M73_s1D3\",\"guide_introduction.md\":\"CTlEAu5R\",\"guide_migration.md\":\"DF5WlNCT\",\"guide_publish.md\":\"BxM8UPuD\",\"guide_runtime.md\":\"6KshBZZr\",\"guide_tutorial_hello-world.md\":\"BwBB0sLQ\",\"guide_tutorial_index.md\":\"DeQI3m9W\",\"guide_tutorial_render.md\":\"CmB0S1C1\",\"guide_tutorial_runtime.md\":\"DZf5WVK6\",\"index.md\":\"_vBFVjCB\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"tmagic-editor\",\"description\":\"页面可视化平台\",\"base\":\"/tmagic-editor/docs/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"./favicon.png\",\"search\":{\"provider\":\"local\"},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/Tencent/tmagic-editor\"}],\"footer\":{\"message\":\"Powered by 腾讯视频会员平台技术中心\",\"copyright\":\"Copyright (C) 2025 Tencent.\"},\"nav\":[{\"text\":\"文档\",\"link\":\"/guide/\",\"activeMatch\":\"/guide/\"},{\"text\":\"API\",\"link\":\"/api/editor/props\",\"activeMatch\":\"/api/\"},{\"text\":\"表单配置\",\"link\":\"/form-config/fields/text\",\"activeMatch\":\"/form-config/\"},{\"text\":\"更新日志\",\"link\":\"https://github.com/Tencent/tmagic-editor/releases\"},{\"text\":\"Playground\",\"link\":\"https://tencent.github.io/tmagic-editor/playground/index.html\"}],\"sidebar\":{\"/guide/\":[{\"text\":\"文档\",\"items\":[{\"text\":\"介绍\",\"link\":\"/guide/introduction.md\"},{\"text\":\"快速开始\",\"link\":\"/guide/\"},{\"text\":\"基础概念\",\"link\":\"/guide/conception.md\"},{\"text\":\"页面发布\",\"link\":\"/guide/publish.md\"},{\"text\":\"RUNTIME\",\"link\":\"/guide/runtime.md\"},{\"text\":\"组件开发\",\"link\":\"/guide/component.md\"},{\"text\":\"编辑器扩展\",\"link\":\"/guide/editor-expand.md\"},{\"text\":\"升级到1.5.x\",\"link\":\"/guide/migration.md\"}]},{\"text\":\"进阶指南\",\"items\":[{\"text\":\"JS Schema\",\"link\":\"/guide/advanced/js-schema.md\"},{\"text\":\"布局原理\",\"link\":\"/guide/advanced/layout.md\"},{\"text\":\"页面渲染\",\"link\":\"/guide/advanced/page.md\"},{\"text\":\"联动原理\",\"link\":\"/guide/advanced/coupling.md\"},{\"text\":\"代码块\",\"link\":\"/guide/advanced/code-block.md\"},{\"text\":\"数据源\",\"link\":\"/guide/advanced/data-source.md\"},{\"text\":\"@tmagic/ui\",\"link\":\"/guide/advanced/tmagic-ui.md\"},{\"text\":\"@tmagic/form\",\"link\":\"/guide/advanced/tmagic-form.md\"}]},{\"text\":\"教程\",\"items\":[{\"text\":\"写在前面\",\"link\":\"/guide/tutorial/\"},{\"text\":\"1.Hello World\",\"link\":\"/guide/tutorial/hello-world.md\"},{\"text\":\"2.Runtime\",\"link\":\"/guide/tutorial/runtime.md\"},{\"text\":\"3.DSL解析渲染\",\"link\":\"/guide/tutorial/render.md\"}]}],\"/api/\":[{\"text\":\"编辑器\",\"items\":[{\"text\":\"Editor组件\",\"items\":[{\"text\":\"props\",\"link\":\"/api/editor/props.md\"},{\"text\":\"slots\",\"link\":\"/api/editor/slots.md\"},{\"text\":\"events\",\"link\":\"/api/editor/events.md\"}]},{\"text\":\"editorService\",\"items\":[{\"text\":\"方法\",\"link\":\"/api/editor/editorServiceMethods.md\"},{\"text\":\"事件\",\"link\":\"/api/editor/editorServiceEvents.md\"}]},{\"text\":\"propsService\",\"items\":[{\"text\":\"方法\",\"link\":\"/api/editor/propsServiceMethods.md\"},{\"text\":\"事件\",\"link\":\"/api/editor/propsServiceEvents.md\"}]},{\"text\":\"historyService\",\"items\":[{\"text\":\"方法\",\"link\":\"/api/editor/historyServiceMethods.md\"},{\"text\":\"事件\",\"link\":\"/api/editor/historyServiceEvents.md\"}]},{\"text\":\"eventsService\",\"link\":\"/api/editor/eventsServiceMethods.md\"},{\"text\":\"uiService\",\"link\":\"/api/editor/uiServiceMethods.md\"},{\"text\":\"codeBlockService\",\"link\":\"/api/editor/codeBlockServiceMethods.md\"},{\"text\":\"componentListService\",\"link\":\"/api/editor/componentListServiceMethods.md\"},{\"text\":\"storageService\",\"link\":\"/api/editor/storageServiceMethods.md\"}]},{\"text\":\"表单\",\"items\":[{\"text\":\"Form组件\",\"items\":[{\"text\":\"props\",\"link\":\"/api/form/form-props\"},{\"text\":\"methods\",\"link\":\"/api/form/form-methods\"},{\"text\":\"events\",\"link\":\"/api/form/form-events\"}]},{\"text\":\"FormDialog组件\",\"items\":[{\"text\":\"props\",\"link\":\"/api/form/form-dialog-props\"},{\"text\":\"methods\",\"link\":\"/api/form/form-dialog-methods\"},{\"text\":\"events\",\"link\":\"/api/form/form-dialog-events\"}]}]},{\"text\":\"表格\",\"items\":[{\"text\":\"Table组件\",\"items\":[{\"text\":\"props\",\"link\":\"/api/table/props\"},{\"text\":\"methods\",\"link\":\"/api/table/methods\"},{\"text\":\"events\",\"link\":\"/api/table/events\"}]}]},{\"text\":\"stage\",\"items\":[{\"text\":\"StageCore\",\"items\":[{\"text\":\"方法\",\"link\":\"/api/stage/coreMethods\"},{\"text\":\"事件\",\"link\":\"/api/stage/coreEvents\"}]}]}],\"/form-config/\":[{\"text\":\"基础配置\",\"items\":[{\"text\":\"Input输入框\",\"link\":\"/form-config/fields/text.md\"},{\"text\":\"Textarea文本域\",\"link\":\"/form-config/fields/textarea.md\"},{\"text\":\"InputNumber计数器\",\"link\":\"/form-config/fields/number.md\"},{\"text\":\"Display只读文本\",\"link\":\"/form-config/fields/display.md\"},{\"text\":\"Hidden隐藏域\",\"link\":\"/form-config/fields/hidden.md\"},{\"text\":\"Link链接\",\"link\":\"/form-config/fields/link.md\"},{\"text\":\"Checkbox多选框\",\"link\":\"/form-config/fields/checkbox.md\"},{\"text\":\"Radio单选框\",\"link\":\"/form-config/fields/radio.md\"},{\"text\":\"Switch开关\",\"link\":\"/form-config/fields/switch.md\"},{\"text\":\"Select选择器\",\"link\":\"/form-config/fields/select.md\"},{\"text\":\"Cascader级联选择器\",\"link\":\"/form-config/fields/cascader.md\"},{\"text\":\"ColorPicker颜色选择器\",\"link\":\"/form-config/fields/color-picker.md\"},{\"text\":\"DatePick日期选择器\",\"link\":\"/form-config/fields/date-picker.md\"},{\"text\":\"DatetimePick日期时间选择器\",\"link\":\"/form-config/fields/datetime-picker.md\"},{\"text\":\"TimePick时间选择器\",\"link\":\"/form-config/fields/time-picker.md\"}]},{\"text\":\"布局配置\",\"items\":[{\"text\":\"布局\",\"link\":\"/form-config/layout.md\"}]},{\"text\":\"联动配置\",\"items\":[{\"text\":\"联动\",\"link\":\"/form-config/relate.md\"}]},{\"text\":\"表单对比\",\"items\":[{\"text\":\"表单对比\",\"link\":\"/form-config/compare.md\"}]}]}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
|
||
|
||
</body>
|
||
</html> |