Skip to content

A fully open source & end-to-end encrypted note taking alternative to Evernote.

web: add character, spaces, paragraphs count in status bar popup (#8311)

01zulfi3ca0089ee842
diff --git a/apps/web/src/components/editor/footer.tsx b/apps/web/src/components/editor/footer.tsx
index 81bd6ebe2..1e23466f3 100644
--- a/apps/web/src/components/editor/footer.tsx
+++ b/apps/web/src/components/editor/footer.tsx
@@ -28,23 +28,21 @@ import {
Plus,
Minus,
EditorNormalWidth,
- TableOfContents,
ExitFullscreen,
Fullscreen,
EditorFullWidth,
- NormalMode
+ NormalMode,
+ Cross
} from "../icons";
-import {
- useEditorConfig,
- useNoteStatistics,
- useEditorManager
-} from "./manager";
+import { useEditorConfig, useNoteStatistics } from "./manager";
import { getFormattedDate } from "@notesnook/common";
-import { MAX_AUTO_SAVEABLE_WORDS } from "./types";
+import { MAX_AUTO_SAVEABLE_WORDS, NoteStatistics } from "./types";
import { strings } from "@notesnook/intl";
import { EDITOR_ZOOM } from "./common";
import { useWindowControls } from "../../hooks/use-window-controls";
import { exitFullscreen } from "../../utils/fullscreen";
+import { useRef, useState } from "react";
+import { PopupPresenter } from "@notesnook/ui";
const SAVE_STATE_ICON_MAP = {
"-1": NotSaved,
@@ -54,11 +52,13 @@ const SAVE_STATE_ICON_MAP = {
function EditorFooter() {
const { isFullscreen } = useWindowControls();
- const { words } = useNoteStatistics();
+ const statistics = useNoteStatistics();
const session = useEditorStore((store) => store.getActiveSession());
const { editorConfig, setEditorConfig } = useEditorConfig();
const editorMargins = useEditorStore((store) => store.editorMargins);
const isFocusMode = useAppStore((store) => store.isFocusMode);
+ const [isStatisticsPopupOpen, setIsStatisticsPopupOpen] = useState(false);
+ const statisticsRef = useRef<HTMLButtonElement | null>(null);
if (!session) return null;
@@ -169,7 +169,7 @@ function EditorFooter() {
<Plus size={13} />
</Button>
</Flex>
- {words.total > MAX_AUTO_SAVEABLE_WORDS ? (
+ {statistics.words.total > MAX_AUTO_SAVEABLE_WORDS ? (
<Text
className="selectable"
variant="subBody"
@@ -178,15 +178,76 @@ function EditorFooter() {
{strings.autoSaveOff()}
</Text>
) : null}
- <Text
+ <Button
className="selectable"
data-test-id="editor-word-count"
- variant="subBody"
- sx={{ color: "paragraph" }}
+ variant="statusitem"
+ ref={statisticsRef}
+ onClick={() => setIsStatisticsPopupOpen(true)}
>
- {strings.totalWords(words.total)}
- {words.selected ? ` (${strings.selectedWords(words.selected)})` : ""}
- </Text>
+ <Text variant="subBody" sx={{ color: "paragraph" }}>
+ {strings.totalWords(statistics.words.total)}
+ {statistics.words.selected
+ ? ` (${strings.selectedWords(statistics.words.selected)})`
+ : ""}
+ </Text>
+ </Button>
+ <PopupPresenter
+ isOpen={isStatisticsPopupOpen}
+ onClose={() => setIsStatisticsPopupOpen(false)}
+ position={{
+ isTargetAbsolute: true,
+ target: statisticsRef.current,
+ location: "top",
+ align: "center",
+ yOffset: 5
+ }}
+ >
+ <Flex
+ sx={{
+ width: ["100%", "fit-content"],
+ border: "1px solid",
+ borderColor: "border",
+ borderRadius: "dialog",
+ boxShadow: "0px 0px 15px 0px #00000011",
+ bg: "background-secondary",
+ flexDirection: "column",
+ gap: 2,
+ pt: 2,
+ justifyContent: "center"
+ }}
+ >
+ {Object.entries(statistics).map(([key, value]) => (
+ <Flex key={key} sx={{ justifyContent: "space-between", px: 4 }}>
+ <Text variant="body" sx={{ width: 100 }}>
+ {strings[key as keyof NoteStatistics]()}
+ </Text>
+ <Text
+ variant="body"
+ sx={{ color: "paragraph", fontWeight: "bold" }}
+ >
+ {value.total}
+ {value.selected ? (
+ <span style={{ fontWeight: "normal" }}>
+ {" "}
+ ({value.selected} selected)
+ </span>
+ ) : (
+ ""
+ )}
+ </Text>
+ </Flex>
+ ))}
+ <Button
+ data-test-id="dialog-no"
+ onClick={() => setIsStatisticsPopupOpen(false)}
+ color="paragraph"
+ variant="icon"
+ >
+ <Cross size={12} />
+ </Button>
+ </Flex>
+ </PopupPresenter>
{dateEdited > 0 ? (
<Text
className="selectable"
diff --git a/apps/web/src/components/editor/manager.ts b/apps/web/src/components/editor/manager.ts
index b15124799..5b0e4bf5e 100644
--- a/apps/web/src/components/editor/manager.ts
+++ b/apps/web/src/components/editor/manager.ts
@@ -119,7 +119,10 @@ export function useNoteStatistics(): NoteStatistics {
(store) =>
(store.activeEditorId &&
store.editors[store.activeEditorId]?.statistics) || {
- words: { total: 0 }
+ words: { total: 0 },
+ characters: { total: 0 },
+ paragraphs: { total: 0 },
+ spaces: { total: 0 }
}
);
}
diff --git a/apps/web/src/components/editor/tiptap.tsx b/apps/web/src/components/editor/tiptap.tsx
index aed0e1be1..035363db9 100644
--- a/apps/web/src/components/editor/tiptap.tsx
+++ b/apps/web/src/components/editor/tiptap.tsx
@@ -37,7 +37,8 @@ import {
Attachment,
getTableOfContents,
getChangedNodes,
- LinkAttributes
+ LinkAttributes,
+ type Selection
} from "@notesnook/editor";
import { Box, Flex } from "@theme-ui/components";
import {
@@ -107,19 +108,51 @@ type TipTapProps = {
fontLigatures: boolean;
};
-function updateWordCount(id: string, content: () => Fragment) {
+function countCharacters(text: string) {
+ return text.length;
+}
+
+function countParagraphs(fragment: Fragment) {
+ let count = 0;
+ fragment.nodesBetween(0, fragment.size, (node) => {
+ if (node.type.name === "paragraph") {
+ count++;
+ }
+ return true;
+ });
+ return count;
+}
+
+function countSpaces(text: string) {
+ return (text.match(/ /g) || []).length;
+}
+
+function updateNoteStatistics(id: string, content: () => Fragment) {
const fragment = content();
+ const documentText = fragment.textBetween(0, fragment.size, "\n", " ");
useEditorManager.getState().updateEditor(id, {
statistics: {
words: {
- total: countWords(fragment.textBetween(0, fragment.size, "\n", " ")),
+ total: countWords(documentText),
+ selected: 0
+ },
+ characters: {
+ total: countCharacters(removeNewlineCharacters(documentText)),
+ selected: 0
+ },
+ paragraphs: {
+ total: countParagraphs(fragment),
+ selected: 0
+ },
+ spaces: {
+ total: countSpaces(documentText),
selected: 0
}
}
});
}
-const deferredUpdateWordCount = debounce(updateWordCount, 1000);
+const deferredUpdateNoteStatistics = debounce(updateNoteStatistics, 1000);
function TipTap(props: TipTapProps) {
const {
@@ -222,6 +255,18 @@ function TipTap(props: TipTapProps) {
words: {
total: totalWords,
selected: 0
+ },
+ characters: {
+ total: countCharacters(editor.state.doc.textContent),
+ selected: 0
+ },
+ paragraphs: {
+ total: countParagraphs(editor.state.doc.content),
+ selected: 0
+ },
+ spaces: {
+ total: countSpaces(editor.state.doc.textContent),
+ selected: 0
}
},
tableOfContents: getTableOfContents(editor.view.dom)
@@ -240,7 +285,7 @@ function TipTap(props: TipTapProps) {
onContentChange?.();
- deferredUpdateWordCount(id, () => editor.state.doc.content);
+ deferredUpdateNoteStatistics(id, () => editor.state.doc.content);
const preventSave = transaction?.getMeta("preventSave") as boolean;
const ignoreEdit = transaction.getMeta("ignoreEdit") as boolean;
@@ -274,22 +319,63 @@ function TipTap(props: TipTapProps) {
useEditorManager.getState().updateEditor(id, (old) => {
const oldSelected = old.statistics?.words?.selected;
const oldWords = old.statistics?.words.total || 0;
- if (isEmptySelection)
+ const oldParagraphs = old.statistics?.paragraphs.total || 0;
+ const oldSpaces = old.statistics?.spaces.total || 0;
+ const oldCharacters = old.statistics?.characters.total || 0;
+ if (isEmptySelection) {
return oldSelected
? {
- statistics: { words: { total: oldWords, selected: 0 } }
+ statistics: {
+ words: { total: oldWords, selected: 0 },
+ characters: {
+ total: oldCharacters,
+ selected: 0
+ },
+ paragraphs: {
+ total: oldParagraphs,
+ selected: 0
+ },
+ spaces: {
+ total: oldSpaces,
+ selected: 0
+ }
+ }
}
: old;
+ }
- const selectedWords = getSelectedWords(
+ const selectedText = editor.state.doc.textBetween(
+ transaction.selection.from,
+ transaction.selection.to,
+ "\n",
+ " "
+ );
+ const selectedWords = countWords(selectedText);
+ const selectedSpaces = countSpaces(selectedText);
+ const selectedParagraphs = getSelectedParagraphs(
editor as Editor,
transaction.selection
);
+ const selectedCharacters = countCharacters(
+ removeNewlineCharacters(selectedText)
+ );
return {
statistics: {
words: {
total: oldWords,
selected: selectedWords
+ },
+ characters: {
+ total: oldCharacters,
+ selected: selectedCharacters
+ },
+ paragraphs: {
+ total: oldParagraphs,
+ selected: selectedParagraphs
+ },
+ spaces: {
+ total: oldSpaces,
+ selected: selectedSpaces
}
}
};
@@ -620,12 +706,17 @@ function toIEditor(editor: Editor): IEditor {
};
}
-function getSelectedWords(
- editor: Editor,
- selection: { from: number; to: number; empty: boolean }
-): number {
- const selectedText = selection.empty
- ? ""
- : editor.state.doc.textBetween(selection.from, selection.to, "\n", " ");
- return countWords(selectedText);
+function getSelectedParagraphs(editor: Editor, selection: Selection): number {
+ let count = 0;
+ editor.state.doc.nodesBetween(selection.from, selection.to, (node) => {
+ if (node.type.name === "paragraph") {
+ count++;
+ }
+ return true;
+ });
+ return count;
+}
+
+function removeNewlineCharacters(text: string) {
+ return text.replaceAll(/\n/g, "");
}
diff --git a/apps/web/src/components/editor/types.ts b/apps/web/src/components/editor/types.ts
index b1fff4983..477fafbf8 100644
--- a/apps/web/src/components/editor/types.ts
+++ b/apps/web/src/components/editor/types.ts
@@ -26,6 +26,18 @@ export type NoteStatistics = {
total: number;
selected?: number;
};
+ characters: {
+ total: number;
+ selected?: number;
+ };
+ paragraphs: {
+ total: number;
+ selected?: number;
+ };
+ spaces: {
+ total: number;
+ selected?: number;
+ };
};
export interface IEditor {
diff --git a/packages/editor/src/index.ts b/packages/editor/src/index.ts
index 29f6ac8fa..a0333ade4 100644
--- a/packages/editor/src/index.ts
+++ b/packages/editor/src/index.ts
@@ -438,3 +438,4 @@ export {
};
export { replaceDateTime } from "./extensions/date-time/index.js";
export type * from "./extension-imports.js";
+export { type Selection } from "@tiptap/pm/state";
diff --git a/packages/intl/locale/en.po b/packages/intl/locale/en.po
index ae567805a..1a5b2b775 100644
--- a/packages/intl/locale/en.po
+++ b/packages/intl/locale/en.po
@@ -6,6 +6,12 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n"
"X-Generator: @lingui/cli\n"
"Language: en\n"
+"Project-Id-Version: \n"
+"Report-Msgid-Bugs-To: \n"
+"PO-Revision-Date: \n"
+"Last-Translator: \n"
+"Language-Team: \n"
+"Plural-Forms: \n"
#: src/strings.ts:2410
msgid " \"Notebook > Notes\""
@@ -1340,6 +1346,10 @@ msgstr "Changes from other devices won't be updated in the editor in real-time."
msgid "Changing password is an irreversible process. You will be logged out from all your devices. Please make sure you do not close the app while your password is changing and have good internet connection."
msgstr "Changing password is an irreversible process. You will be logged out from all your devices. Please make sure you do not close the app while your password is changing and have good internet connection."
+#: src/strings.ts:2490
+msgid "Characters"
+msgstr "Characters"
+
#: src/strings.ts:1295
msgid "Check for new version of Notesnook"
msgstr "Check for new version of Notesnook"
@@ -4256,6 +4266,10 @@ msgstr "Outline list"
msgid "Paragraph"
msgstr "Paragraph"
+#: src/strings.ts:2491
+msgid "Paragraphs"
+msgstr "Paragraphs"
+
#: src/strings.ts:2100
msgid "Partial backups contain all your data except attachments. They are created from data already available on your device and do not require an Internet connection."
msgstr "Partial backups contain all your data except attachments. They are created from data already available on your device and do not require an Internet connection."
@@ -6837,6 +6851,10 @@ msgstr "What went wrong?"
msgid "Width"
msgstr "Width"
+#: src/strings.ts:2489
+msgid "Words"
+msgstr "Words"
+
#: src/strings.ts:2412
msgid "Work & Office"
msgstr "Work & Office"
diff --git a/packages/intl/locale/pseudo-LOCALE.po b/packages/intl/locale/pseudo-LOCALE.po
index e464c9dfb..642d9c231 100644
--- a/packages/intl/locale/pseudo-LOCALE.po
+++ b/packages/intl/locale/pseudo-LOCALE.po
@@ -6,6 +6,12 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n"
"X-Generator: @lingui/cli\n"
"Language: pseudo-LOCALE\n"
+"Project-Id-Version: \n"
+"Report-Msgid-Bugs-To: \n"
+"PO-Revision-Date: \n"
+"Last-Translator: \n"
+"Language-Team: \n"
+"Plural-Forms: \n"
#: src/strings.ts:2410
msgid " \"Notebook > Notes\""
@@ -1340,6 +1346,10 @@ msgstr ""
msgid "Changing password is an irreversible process. You will be logged out from all your devices. Please make sure you do not close the app while your password is changing and have good internet connection."
msgstr ""
+#: src/strings.ts:2490
+msgid "Characters"
+msgstr ""
+
#: src/strings.ts:1295
msgid "Check for new version of Notesnook"
msgstr ""
@@ -4230,6 +4240,10 @@ msgstr ""
msgid "Paragraph"
msgstr ""
+#: src/strings.ts:2491
+msgid "Paragraphs"
+msgstr ""
+
#: src/strings.ts:2100
msgid "Partial backups contain all your data except attachments. They are created from data already available on your device and do not require an Internet connection."
msgstr ""
@@ -6788,6 +6802,10 @@ msgstr ""
msgid "Width"
msgstr ""
+#: src/strings.ts:2489
+msgid "Words"
+msgstr ""
+
#: src/strings.ts:2412
msgid "Work & Office"
msgstr ""
diff --git a/packages/intl/src/strings.ts b/packages/intl/src/strings.ts
index 427301eb9..627d6c8e7 100644
--- a/packages/intl/src/strings.ts
+++ b/packages/intl/src/strings.ts
@@ -2485,5 +2485,8 @@ Use this if changes from other devices are not appearing on this device. This wi
yourArchiveIsEmpty: () => t`Your archive is empty`,
unarchive: () => t`Unarchive`,
moveNotebookDesc: () =>
- t`Select a notebook to move this notebook into, or unselect to move it to the root level.`
+ t`Select a notebook to move this notebook into, or unselect to move it to the root level.`,
+ words: () => t`Words`,
+ characters: () => t`Characters`,
+ paragraphs: () => t`Paragraphs`
};