@bigbinary/neeto-editor 0.6.8 → 0.7.2

package/CHANGELOG.md

@@ -22,6 +22,18 @@ Prefix the change with one of these keywords:
 - *Fixed*: for any bug fixes.
 - *Security*: in case of vulnerabilities.
 
+## 0.7.2 - 2022-09-01
+
+- Added: type support to all the exported components.
+
+## 0.7.1 - 2022-08-29
+
+- Changed: CodeBlock theme to light.
+
+## 0.7.0 - 2022-08-25
+
+- Changed: **BREAKING** the CDN for editor content styles from https://cdn.jsdelivr.net/gh/bigbinary/neeto-editor-tiptap@master/dist/editor-content.min.css to https://cdn.jsdelivr.net/gh/bigbinary/neeto-editor@master/dist/editor-content.min.css.
+
 ## 0.6.8 - 2022-08-24
 
 - Fixed issue where variables added get appended to starting of the existing content rather than at the end.

package/dist/editor-content.min.css

@@ -0,0 +1 @@
+@charset "UTF-8";@import url("https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.7.2/styles/github.min.css");.neeto-editor-content{white-space:pre-wrap;word-break:break-word}.neeto-editor-content h1,.neeto-editor-content h2,.neeto-editor-content h3,.neeto-editor-content h4,.neeto-editor-content h5,.neeto-editor-content h6{font-size:revert}.neeto-editor-content p{line-height:1.625;margin-bottom:16px}.neeto-editor-content p:empty:after{content:" "}.neeto-editor-content p:last-child{margin-bottom:0}.neeto-editor-content code{background-color:rgba(175,184,193,.2);border-radius:6px;font-family:ui-monospace,SFMono-Regular,SF Mono,Menlo,Consolas,Liberation Mono,monospace;font-size:85%;padding:.2em .4em}.neeto-editor-content pre{background-color:#f6f8fa;border-radius:2px;font-size:14px;line-height:20px;margin-bottom:8px;margin-top:8px;overflow-x:auto;padding:16px}.neeto-editor-content pre>code{background-color:transparent;border-radius:0;border-width:0;color:inherit;font-family:inherit;font-size:inherit;font-weight:400;line-height:inherit;padding:0}.neeto-editor-content blockquote{border-left-color:#e5e7eb;border-left-width:4px;color:#1b1f23;font-weight:500;margin:8px 0;padding-left:12px;quotes:"“" "”" "‘" "’"}.neeto-editor-content blockquote>p:after,.neeto-editor-content blockquote>p:before{content:""!important}.neeto-editor-content ol,.neeto-editor-content ul{list-style:revert;margin:revert;padding:revert}.neeto-editor-content ol>li>p,.neeto-editor-content ul>li>p{margin-bottom:.375rem!important;margin-top:0!important}.neeto-editor-content ol li:before,.neeto-editor-content ul li:before{background-color:#1b1f23}.neeto-editor-content a[href]{color:#276ef1}.neeto-editor-content .video-wrapper{height:315px;margin:auto;width:560px}.neeto-editor-content mark{background:#c9e4cc;border-radius:2px;color:inherit;padding:0 4px}.neeto-editor-content [data-variable]{background-color:rgba(233,235,237,.5);border-radius:2px;color:#49545c;display:inline-flex;line-height:1;padding:4px 6px}.neeto-editor-content [data-mention]{opacity:.6}.neeto-editor-content--hidden{display:none}.neeto-editor__image{border:1.5px solid #eaf3fc;display:inline-block;margin:0 12px}.neeto-editor__image figure{margin:16px 12px;outline:none}.neeto-editor__image figure img{height:100%;-o-object-fit:contain;object-fit:contain;-webkit-user-select:auto;-moz-user-select:auto;user-select:auto;width:100%}.neeto-editor__image figure figcaption{color:#49545c;text-align:center}.neeto-editor__image-defaults{width:-webkit-fit-content;width:-moz-fit-content;width:fit-content}.neeto-editor__image--none{display:flex;justify-content:center}.neeto-editor__image--left{float:left;margin-left:0}.neeto-editor__image--right{float:right;margin-right:0}.neeto-editor__image--center{margin:0 auto}

package/dist/editor-output.js

@@ -0,0 +1,3 @@
+var css = "@charset \"UTF-8\";@import url(\"https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.7.2/styles/github.min.css\");.neeto-editor-content{white-space:pre-wrap;word-break:break-word}.neeto-editor-content h1,.neeto-editor-content h2,.neeto-editor-content h3,.neeto-editor-content h4,.neeto-editor-content h5,.neeto-editor-content h6{font-size:revert}.neeto-editor-content p{line-height:1.625;margin-bottom:16px}.neeto-editor-content p:empty:after{content:\" \"}.neeto-editor-content p:last-child{margin-bottom:0}.neeto-editor-content code{background-color:rgba(175,184,193,.2);border-radius:6px;font-family:ui-monospace,SFMono-Regular,SF Mono,Menlo,Consolas,Liberation Mono,monospace;font-size:85%;padding:.2em .4em}.neeto-editor-content pre{background-color:#f6f8fa;border-radius:2px;font-size:14px;line-height:20px;margin-bottom:8px;margin-top:8px;overflow-x:auto;padding:16px}.neeto-editor-content pre>code{background-color:transparent;border-radius:0;border-width:0;color:inherit;font-family:inherit;font-size:inherit;font-weight:400;line-height:inherit;padding:0}.neeto-editor-content blockquote{border-left-color:#e5e7eb;border-left-width:4px;color:#1b1f23;font-weight:500;margin:8px 0;padding-left:12px;quotes:\"“\" \"”\" \"‘\" \"’\"}.neeto-editor-content blockquote>p:after,.neeto-editor-content blockquote>p:before{content:\"\"!important}.neeto-editor-content ol,.neeto-editor-content ul{list-style:revert;margin:revert;padding:revert}.neeto-editor-content ol>li>p,.neeto-editor-content ul>li>p{margin-bottom:.375rem!important;margin-top:0!important}.neeto-editor-content ol li:before,.neeto-editor-content ul li:before{background-color:#1b1f23}.neeto-editor-content a[href]{color:#276ef1}.neeto-editor-content .video-wrapper{height:315px;margin:auto;width:560px}.neeto-editor-content mark{background:#c9e4cc;border-radius:2px;color:inherit;padding:0 4px}.neeto-editor-content [data-variable]{background-color:rgba(233,235,237,.5);border-radius:2px;color:#49545c;display:inline-flex;line-height:1;padding:4px 6px}.neeto-editor-content [data-mention]{opacity:.6}.neeto-editor-content--hidden{display:none}.neeto-editor__image{border:1.5px solid #eaf3fc;display:inline-block;margin:0 12px}.neeto-editor__image figure{margin:16px 12px;outline:none}.neeto-editor__image figure img{height:100%;-o-object-fit:contain;object-fit:contain;-webkit-user-select:auto;-moz-user-select:auto;user-select:auto;width:100%}.neeto-editor__image figure figcaption{color:#49545c;text-align:center}.neeto-editor__image-defaults{width:-webkit-fit-content;width:-moz-fit-content;width:fit-content}.neeto-editor__image--none{display:flex;justify-content:center}.neeto-editor__image--left{float:left;margin-left:0}.neeto-editor__image--right{float:right;margin-right:0}.neeto-editor__image--center{margin:0 auto}";
+
+export { css, css as default };

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@bigbinary/neeto-editor",
-  "version": "0.6.8",
+  "version": "0.7.2",
   "main": "./build/index.js",
+  "types": "./types.d.ts",
   "description": "neetoEditor is the library that drives the rich text experience in all neeto products built at BigBinary",
   "keywords": [
     "ui",
@@ -9,6 +10,10 @@
     "editor",
     "react"
   ],
+  "files": [
+    "dist",
+    "types.d.ts"
+  ],
   "author": "BigBinary",
   "license": "MIT",
   "devDependencies": {
@@ -142,10 +147,10 @@
   },
   "proxy": "http://localhost:3000",
   "bugs": {
-    "url": "https://github.com/bigbinary/neeto-editor-tiptap/issues"
+    "url": "https://github.com/bigbinary/neeto-editor/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/bigbinary/neeto-editor-tiptap.git"
+    "url": "git+https://github.com/bigbinary/neeto-editor.git"
   }
 }

package/types.d.ts

@@ -0,0 +1,78 @@
+import { UppyOptions } from "@uppy/core/types";
+import {
+  Editor as TiptapEditor,
+  Extension,
+  Node,
+} from "@tiptap/core/dist/packages/core/src";
+import { Range } from "@tiptap/core/dist/packages/core/src/types";
+import { Transaction } from "prosemirror-state";
+
+interface Command {
+  title: string;
+  Icon: Function;
+  description?: string;
+  optionName: string;
+  command?: (props: { editor: TiptapEditor; range: Range }) => void;
+  items?: Command[];
+}
+
+interface Variable {
+  category_key: string;
+  category_label: string;
+  variables?: Array<{ key: string; label: string }>;
+}
+
+interface Mention {
+  key?: string;
+  name: string;
+  imageUrl?: string;
+}
+
+type KeyboardShortcuts = {
+  [shortcut: string]: (props: { editor: TiptapEditor }) => boolean | void;
+};
+
+type EditorFocus = (props: {
+  editor: TiptapEditor;
+  event: FocusEvent;
+  transaction: Transaction;
+}) => void;
+
+export function Editor(props: {
+  forceTitle?: boolean;
+  titleError?: boolean;
+  hideSlashCommands?: boolean;
+  defaults?: string[];
+  addons?: string[];
+  addonCommands?: Command[];
+  className?: string;
+  uploadEndpoint?: string;
+  uploadConfig?: UppyOptions<Record<string, unknown>>;
+  initialValue?: string;
+  onChange?: (htmlContent: string) => void;
+  onFocus?: EditorFocus;
+  onBlur?: EditorFocus;
+  menuType?: string;
+  variables?: Variable[];
+  mentions?: Mention[];
+  showImageInMention?: boolean;
+  placeholder?: { title: string } | string | null;
+  extensions?: Array<Node | Extension>;
+  contentClassName?: string[];
+  characterLimit?: number;
+  editorSecrets?: Array<{ unsplash?: string }>;
+  rows?: number;
+  autoFocus?: boolean;
+  onSubmit?: (htmlContent: string) => void;
+  heightStrategy?: string;
+  characterCountStrategy?: string;
+  keyboardShortcuts?: KeyboardShortcuts;
+  error?: string;
+  [otherProps: string]: any;
+}): JSX.Element;
+
+export function EditorContent(props: {
+  content?: string;
+  className?: string;
+  [otherProps: string]: any;
+}): JSX.Element;