Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: move the character-count extension into @tiptap/extensions #6059

Merged
merged 1 commit into from
Jan 27, 2025
Merged
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
19 changes: 18 additions & 1 deletion .changeset/chilly-lemons-remember.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,24 @@
'@tiptap/extensions': major
---

Adds the new `@tiptap/extensions` package which packages multiple utility extensions like `History`, `Placeholder`, `DropCursor`, `GapCursor`, `TrailingNode`, `Focus`, and `Selection`.
Adds the new `@tiptap/extensions` package which packages multiple utility extensions like `History`, `Placeholder`, `CharacterCount`, `DropCursor`, `GapCursor`, `TrailingNode`, `Focus`, and `Selection`.

## CharacterCount

This extension adds a cursor that indicates where a new node will be inserted when dragging and dropping.

Migrate from `@tiptap/extension-character-count` to `@tiptap/extensions`:

```diff
- import CharacterCount from '@tiptap/extension-character-count'
+ import { CharacterCount } from '@tiptap/extensions'
```

Usage:

```ts
import { CharacterCount, CharacterCountOptions } from '@tiptap/extensions'
```

## DropCursor

Expand Down
2 changes: 1 addition & 1 deletion demos/src/Demos/CollaborationSplitPane/React/Editor.jsx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import CharacterCount from '@tiptap/extension-character-count'
import Collaboration from '@tiptap/extension-collaboration'
import CollaborationCursor from '@tiptap/extension-collaboration-cursor'
import Highlight from '@tiptap/extension-highlight'
import { TaskItem, TaskList } from '@tiptap/extension-list'
import { CharacterCount } from '@tiptap/extensions'
import { EditorContent, useEditor } from '@tiptap/react'
import StarterKit from '@tiptap/starter-kit'
import React, { useCallback, useEffect, useState } from 'react'
Expand Down
2 changes: 1 addition & 1 deletion demos/src/Demos/SingleRoomCollab/React/index.jsx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import './styles.scss'

import { TiptapCollabProvider } from '@hocuspocus/provider'
import CharacterCount from '@tiptap/extension-character-count'
import Collaboration from '@tiptap/extension-collaboration'
import CollaborationCursor from '@tiptap/extension-collaboration-cursor'
import { CharacterCount } from '@tiptap/extensions'
import { EditorContent, useEditor } from '@tiptap/react'
import StarterKit from '@tiptap/starter-kit'
import React, { useCallback, useEffect, useState } from 'react'
Expand Down
2 changes: 1 addition & 1 deletion demos/src/Examples/CollaborativeEditing/React/index.jsx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import './styles.scss'

import { TiptapCollabProvider } from '@hocuspocus/provider'
import CharacterCount from '@tiptap/extension-character-count'
import Collaboration from '@tiptap/extension-collaboration'
import CollaborationCursor from '@tiptap/extension-collaboration-cursor'
import Highlight from '@tiptap/extension-highlight'
import { TaskItem, TaskList } from '@tiptap/extension-list'
import { CharacterCount } from '@tiptap/extensions'
import { EditorContent, useEditor } from '@tiptap/react'
import StarterKit from '@tiptap/starter-kit'
import React, { useCallback, useEffect, useState } from 'react'
Expand Down
2 changes: 1 addition & 1 deletion demos/src/Examples/CollaborativeEditing/Vue/index.vue
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@

<script>
import { TiptapCollabProvider } from '@hocuspocus/provider'
import CharacterCount from '@tiptap/extension-character-count'
import Collaboration from '@tiptap/extension-collaboration'
import CollaborationCursor from '@tiptap/extension-collaboration-cursor'
import Highlight from '@tiptap/extension-highlight'
import { TaskItem, TaskList } from '@tiptap/extension-list'
import { CharacterCount } from '@tiptap/extensions'
import StarterKit from '@tiptap/starter-kit'
import { Editor, EditorContent } from '@tiptap/vue-3'
import * as Y from 'yjs'
Expand Down
2 changes: 1 addition & 1 deletion demos/src/Examples/Community/React/index.jsx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import './styles.scss'

import CharacterCount from '@tiptap/extension-character-count'
import Document from '@tiptap/extension-document'
import Mention from '@tiptap/extension-mention'
import Paragraph from '@tiptap/extension-paragraph'
import Text from '@tiptap/extension-text'
import { CharacterCount } from '@tiptap/extensions'
import { EditorContent, useEditor, useEditorState } from '@tiptap/react'
import React from 'react'

Expand Down
2 changes: 1 addition & 1 deletion demos/src/Examples/Community/Vue/index.vue
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@
</template>

<script>
import CharacterCount from '@tiptap/extension-character-count'
import Document from '@tiptap/extension-document'
import Mention from '@tiptap/extension-mention'
import Paragraph from '@tiptap/extension-paragraph'
import Text from '@tiptap/extension-text'
import { CharacterCount } from '@tiptap/extensions'
import { Editor, EditorContent } from '@tiptap/vue-3'

import suggestion from './suggestion.js'
Expand Down
2 changes: 1 addition & 1 deletion demos/src/Extensions/CharacterCount/React/index.jsx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import './styles.scss'

import CharacterCount from '@tiptap/extension-character-count'
import Document from '@tiptap/extension-document'
import Paragraph from '@tiptap/extension-paragraph'
import Text from '@tiptap/extension-text'
import { CharacterCount } from '@tiptap/extensions'
import { EditorContent, useEditor } from '@tiptap/react'
import React from 'react'

Expand Down
2 changes: 1 addition & 1 deletion demos/src/Extensions/CharacterCount/Vue/index.vue
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@
</template>

<script>
import CharacterCount from '@tiptap/extension-character-count'
import Document from '@tiptap/extension-document'
import Paragraph from '@tiptap/extension-paragraph'
import Text from '@tiptap/extension-text'
import { CharacterCount } from '@tiptap/extensions'
import { Editor, EditorContent } from '@tiptap/vue-3'

export default {
Expand Down
6 changes: 2 additions & 4 deletions packages/extension-character-count/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,10 @@
"dist"
],
"devDependencies": {
"@tiptap/core": "^3.0.0-next.4",
"@tiptap/pm": "^3.0.0-next.4"
"@tiptap/extensions": "^3.0.0-next.4"
},
"peerDependencies": {
"@tiptap/core": "^3.0.0-next.1",
"@tiptap/pm": "^3.0.0-next.1"
"@tiptap/extensions": "^3.0.0-next.3"
},
"repository": {
"type": "git",
Expand Down
4 changes: 2 additions & 2 deletions packages/extension-character-count/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { CharacterCount } from './character-count.js'
import { CharacterCount } from '@tiptap/extensions'

export * from './character-count.js'
export { CharacterCount, CharacterCountOptions } from '@tiptap/extensions'

export default CharacterCount
8 changes: 8 additions & 0 deletions packages/extensions/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,14 @@
"import": "./dist/index.js",
"require": "./dist/index.cjs"
},
"./character-count": {
"types": {
"import": "./dist/character-count/index.d.ts",
"require": "./dist/character-count/index.d.cts"
},
"import": "./dist/character-count/index.js",
"require": "./dist/character-count/index.cjs"
},
"./drop-cursor": {
"types": {
"import": "./dist/drop-cursor/index.d.ts",
Expand Down
1 change: 1 addition & 0 deletions packages/extensions/src/character-count/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from './character-count.js'
1 change: 1 addition & 0 deletions packages/extensions/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
export * from './character-count/index.js'
export * from './drop-cursor/index.js'
export * from './focus/index.js'
export * from './gap-cursor/index.js'
Expand Down
7 changes: 2 additions & 5 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading