@tiptap/extension-character-count 2.0.0-beta.2 → 2.0.0-beta.200

package/README.md

@@ -7,8 +7,8 @@
 ## Introduction
 tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a toolkit for building rich text WYSIWYG editors, which is already in use at many well-known companies such as *New York Times*, *The Guardian* or *Atlassian*.
 
-## Offical Documentation
+## Official Documentation
 Documentation can be found on the [tiptap website](https://tiptap.dev).
 
 ## License
-tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md).
+tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap/blob/main/LICENSE.md).

package/dist/packages/extension-character-count/src/character-count.d.ts

@@ -1,7 +1,28 @@
 import { Extension } from '@tiptap/core';
-import { PluginKey } from 'prosemirror-state';
-export declare const pluginKey: PluginKey<any, any>;
+import { Node as ProseMirrorNode } from 'prosemirror-model';
 export interface CharacterCountOptions {
-    limit?: number;
+    /**
+     * The maximum number of characters that should be allowed. Defaults to `0`.
+     */
+    limit: number | null | undefined;
+    /**
+     * The mode by which the size is calculated. Defaults to 'textSize'.
+     */
+    mode: 'textSize' | 'nodeSize';
 }
-export declare const CharacterCount: Extension<CharacterCountOptions>;
+export interface CharacterCountStorage {
+    /**
+     * Get the number of characters for the current document.
+     */
+    characters: (options?: {
+        node?: ProseMirrorNode;
+        mode?: 'textSize' | 'nodeSize';
+    }) => number;
+    /**
+     * Get the number of words for the current document.
+     */
+    words: (options?: {
+        node?: ProseMirrorNode;
+    }) => number;
+}
+export declare const CharacterCount: Extension<CharacterCountOptions, CharacterCountStorage>;