Référence de l’API

@univerjs-pro/docs-sdt-ui

Cette page API est actuellement disponible en anglais. Les signatures et identifiants restent identiques dans toutes les langues.

Insertion menus, properties popups, interaction, and highlighting for Docs content controls.

TypeScript
import { UniverDocsSdtPlugin } from '@univerjs-pro/docs-sdt'import { UniverDocsSdtUIPlugin } from '@univerjs-pro/docs-sdt-ui'import DocsSdtUIEnUS from '@univerjs-pro/docs-sdt-ui/locale/en-US'import { LocaleType } from '@univerjs/core'import '@univerjs-pro/docs-sdt-ui/lib/index.css'univerAPI.loadLocales(LocaleType.EN_US, DocsSdtUIEnUS)univer.registerPlugin(UniverDocsSdtPlugin)univer.registerPlugin(UniverDocsSdtUIPlugin)

Merge DocsSdtUIEnUS into the application's locales. Register Docs core, Docs UI, the render engine, and the license plugin first. This UI accepts menu?: MenuConfig and has no Facade entry. The current Docs advanced preset does not include the SDT plugins.

Insert a control

TypeScript
import { InsertSdtCommand } from '@univerjs-pro/docs-sdt-ui'await univerAPI.executeCommand(InsertSdtCommand.id, { kind: 'checkbox' })

The command uses the active document and text selection. kind supports richText, text, checkbox, date, dropDownList, comboBox, picture, group, repeatingSection, and docPartObj. Repeating-section items are created through their parent section rather than inserted independently.

The root also exports IInsertSdtCommandParams, InsertableSdtKind, and SdtPopupService. See the content-controls guide.

Que pensez-vous de ce guide ?

© 2026 DreamNum Co., Ltd.