Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion apps/docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@
"extensions/search",
"extensions/shape-container",
"extensions/shape-textbox",
"extensions/slash-menu",
"extensions/context-menu",
"extensions/strike",
"extensions/structured-content",
"extensions/tab",
Expand Down Expand Up @@ -391,6 +391,10 @@
"source": "/modules/collaboration/self-hosted/overview",
"destination": "/guides/collaboration/self-hosted-overview"
},
{
"source": "/extensions/slash-menu",
"destination": "/extensions/context-menu"
},
{
"source": "/guides/breaking-changes-v1",
"destination": "/guides/migration/breaking-changes-v1"
Expand Down
16 changes: 16 additions & 0 deletions apps/docs/extensions/context-menu.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: ContextMenu extension
sidebarTitle: "Context Menu"
keywords: "ContextMenu extension, superdoc ContextMenu, word ContextMenu, document ContextMenu, docx ContextMenu"
---

import Description from '/snippets/extensions/context-menu.mdx'

<Description />


## Source code

import { SourceCodeLink } from '/snippets/components/source-code-link.jsx'

<SourceCodeLink path="packages/super-editor/src/extensions/context-menu/context-menu.js" />
16 changes: 0 additions & 16 deletions apps/docs/extensions/slash-menu.mdx

This file was deleted.

14 changes: 7 additions & 7 deletions apps/docs/modules/context-menu.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ new SuperDoc({
new SuperDoc({
selector: '#editor',
modules: {
slashMenu: {
contextMenu: {
includeDefaultItems: true,
customItems: [],
menuProvider: null
Expand All @@ -37,15 +37,15 @@ new SuperDoc({
Top-level option to disable the context menu entirely
</ParamField>

<ParamField path="modules.slashMenu.includeDefaultItems" type="boolean" default="true">
<ParamField path="modules.contextMenu.includeDefaultItems" type="boolean" default="true">
Whether to include the built-in menu items
</ParamField>

<ParamField path="modules.slashMenu.customItems" type="Array" default="[]">
<ParamField path="modules.contextMenu.customItems" type="Array" default="[]">
Custom menu sections to add or merge. See [Custom Items](#custom-items).
</ParamField>

<ParamField path="modules.slashMenu.menuProvider" type="function">
<ParamField path="modules.contextMenu.menuProvider" type="function">
Advanced: function to fully control menu contents. See [Menu Provider](#menu-provider).
</ParamField>

Expand All @@ -72,7 +72,7 @@ Add custom items by defining sections in `customItems`. Each section has an `id`

```javascript
modules: {
slashMenu: {
contextMenu: {
customItems: [{
id: 'my-actions',
items: [
Expand Down Expand Up @@ -129,7 +129,7 @@ If a custom section has the same `id` as a default section, the items are merged

```javascript
modules: {
slashMenu: {
contextMenu: {
customItems: [{
// Adds items to the existing 'general' section
id: 'general',
Expand All @@ -151,7 +151,7 @@ For full control over menu contents, use `menuProvider`. It receives the context

```javascript
modules: {
slashMenu: {
contextMenu: {
menuProvider: (context, sections) => {
// Filter out clipboard section in editing mode
if (context.documentMode === 'editing') {
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/modules/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ const superdoc = new SuperDoc({
toolbar: { selector: '#toolbar' },
comments: { allowResolve: true },
collaboration: { ydoc, provider },
slashMenu: { includeDefaultItems: true }
contextMenu: { includeDefaultItems: true }
}
});
```
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/scripts/sync-sdk-docs.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ const SUPPORTED = [
'search',
'shape-container',
'shape-textbox',
'slash-menu',
'context-menu',
'strike',
'structured-content', // contains document-section
'tab',
Expand Down
4 changes: 2 additions & 2 deletions packages/super-editor/src/components/SuperEditor.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ vi.mock('./cursor-helpers.js', () => ({
checkNodeSpecificClicks: checkNodeSpecificClicksMock,
}));

vi.mock('./slash-menu/SlashMenu.vue', () => ({
default: { name: 'SlashMenu', render: () => null },
vi.mock('./context-menu/ContextMenu.vue', () => ({
default: { name: 'ContextMenu', render: () => null },
}));

vi.mock('./rulers/Ruler.vue', () => ({
Expand Down
8 changes: 4 additions & 4 deletions packages/super-editor/src/components/SuperEditor.vue
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { ref, onMounted, onBeforeUnmount, shallowRef, reactive, markRaw, compute
import { Editor } from '@superdoc/super-editor';
import { PresentationEditor } from '@core/presentation-editor/index.js';
import { getStarterExtensions } from '@extensions/index.js';
import SlashMenu from './slash-menu/SlashMenu.vue';
import ContextMenu from './context-menu/ContextMenu.vue';
import { onMarginClickCursorChange } from './cursor-helpers.js';
import Ruler from './rulers/Ruler.vue';
import GenericPopover from './popovers/GenericPopover.vue';
Expand Down Expand Up @@ -987,7 +987,7 @@ const handleMarginClick = (event) => {
if (target?.classList?.contains('ProseMirror')) return;

// Causes issues with node selection.
if (target?.closest?.('.presentation-editor, .superdoc-layout, .slash-menu')) {
if (target?.closest?.('.presentation-editor, .superdoc-layout, .context-menu')) {
return;
}

Expand Down Expand Up @@ -1075,8 +1075,8 @@ onBeforeUnmount(() => {
@mouseleave="handleOverlayHide"
>
<div ref="editorElem" class="editor-element super-editor__element" role="presentation"></div>
<!-- Single SlashMenu component, no Teleport needed -->
<SlashMenu
<!-- Single ContextMenu component, no Teleport needed -->
<ContextMenu
v-if="!contextMenuDisabled && editorReady && activeEditor"
:editor="activeEditor"
:popoverControls="popoverControls"
Expand Down
Loading
Loading