react-native-enriched-html 1.0.0 → 1.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-enriched-html",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "HTML-based Rich Text solution for React Native",
   "source": "./src/index.tsx",
   "main": "./lib/module/index.js",
@@ -88,24 +88,26 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@tiptap/core": "3.20.4",
-    "@tiptap/extension-blockquote": "3.20.4",
-    "@tiptap/extension-bold": "3.20.4",
-    "@tiptap/extension-code": "3.20.4",
-    "@tiptap/extension-document": "3.20.4",
-    "@tiptap/extension-heading": "3.20.4",
-    "@tiptap/extension-history": "3.20.4",
-    "@tiptap/extension-image": "3.20.4",
-    "@tiptap/extension-italic": "3.20.4",
-    "@tiptap/extension-link": "3.20.4",
-    "@tiptap/extension-list": "3.20.4",
-    "@tiptap/extension-paragraph": "3.20.4",
-    "@tiptap/extension-strike": "3.20.4",
-    "@tiptap/extension-text": "3.20.4",
-    "@tiptap/extension-underline": "3.20.4",
-    "@tiptap/extensions": "3.20.4",
-    "@tiptap/pm": "3.20.4",
-    "@tiptap/react": "3.20.4"
+    "@tiptap/core": "3.27.1",
+    "@tiptap/extension-blockquote": "3.27.1",
+    "@tiptap/extension-bold": "3.27.1",
+    "@tiptap/extension-code": "3.27.1",
+    "@tiptap/extension-document": "3.27.1",
+    "@tiptap/extension-heading": "3.27.1",
+    "@tiptap/extension-history": "3.27.1",
+    "@tiptap/extension-image": "3.27.1",
+    "@tiptap/extension-italic": "3.27.1",
+    "@tiptap/extension-link": "3.27.1",
+    "@tiptap/extension-list": "3.27.1",
+    "@tiptap/extension-paragraph": "3.27.1",
+    "@tiptap/extension-strike": "3.27.1",
+    "@tiptap/extension-text": "3.27.1",
+    "@tiptap/extension-text-align": "3.27.1",
+    "@tiptap/extension-underline": "3.27.1",
+    "@tiptap/extensions": "3.27.1",
+    "@tiptap/pm": "3.27.1",
+    "@tiptap/react": "3.27.1",
+    "dompurify": "3.4.11"
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^19.6.0",
@@ -127,6 +129,7 @@
     "eslint-config-prettier": "^10.1.1",
     "eslint-plugin-prettier": "^5.2.3",
     "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
     "playwright": "1.58.2",
     "prettier": "^3.0.3",
     "react": "19.1.0",
@@ -145,17 +148,40 @@
     "apps/example",
     "apps/example-web"
   ],
+  "resolutions": {
+    "shell-quote": "1.8.4"
+  },
   "packageManager": "yarn@4.13.0",
   "jest": {
-    "preset": "react-native",
-    "modulePathIgnorePatterns": [
-      "<rootDir>/apps/example/node_modules",
-      "<rootDir>/lib/"
-    ],
-    "testPathIgnorePatterns": [
-      "/node_modules/",
-      "<rootDir>/.playwright/",
-      "<rootDir>/apps/example-web/"
+    "projects": [
+      {
+        "displayName": "native",
+        "preset": "react-native",
+        "modulePathIgnorePatterns": [
+          "<rootDir>/apps/example/node_modules",
+          "<rootDir>/lib/"
+        ],
+        "testPathIgnorePatterns": [
+          "/node_modules/",
+          "<rootDir>/.playwright/",
+          "<rootDir>/apps/example-web/",
+          "<rootDir>/src/web/"
+        ]
+      },
+      {
+        "displayName": "web",
+        "testEnvironment": "jsdom",
+        "testMatch": [
+          "<rootDir>/src/web/**/__tests__/**/*.test.{ts,tsx}"
+        ],
+        "modulePathIgnorePatterns": [
+          "<rootDir>/apps/example/node_modules",
+          "<rootDir>/lib/"
+        ],
+        "transform": {
+          "^.+\\.(js|ts|tsx)$": "babel-jest"
+        }
+      }
     ]
   },
   "commitlint": {

package/src/index.tsx

@@ -1,4 +1,5 @@
 export { EnrichedTextInput } from './web/EnrichedTextInput';
+export { EnrichedText } from './web/EnrichedText';
 export type {
   EnrichedInputStyle,
   EnrichedTextInputProps,

package/src/types.ts

@@ -838,13 +838,15 @@ export interface EnrichedTextProps extends ViewProps {
   onMentionPress?: (event: OnMentionPressEvent) => void;
 }
 
-interface EnrichedTextMentionStyleProperties extends MentionStyleProperties {
+export interface EnrichedTextMentionStyleProperties extends MentionStyleProperties {
   pressColor?: ColorValue;
   pressBackgroundColor?: ColorValue;
 }
 
-export interface EnrichedTextHtmlStyle
-  extends Omit<HtmlStyle, 'a' | 'mention'> {
+export interface EnrichedTextHtmlStyle extends Omit<
+  HtmlStyle,
+  'a' | 'mention'
+> {
   a?: HtmlStyle['a'] & {
     pressColor?: ColorValue;
   };

package/src/utils/expandMentionStylesForIndicators.ts

@@ -1,15 +1,15 @@
 import type { HtmlStyle, MentionStyleProperties } from '../types';
-import { DEFAULT_HTML_STYLE } from './defaultHtmlStyle';
 import { isMentionStyleRecord } from './isMentionStyleRecord';
 
 export function expandMentionStylesForIndicators(
   mention: HtmlStyle['mention'] | undefined,
-  indicators: string[]
+  indicators: string[],
+  htmlStyleToMergeWith: HtmlStyle
 ): Record<string, MentionStyleProperties> {
   const out: Record<string, MentionStyleProperties> = {};
   for (const indicator of indicators) {
     out[indicator] = {
-      ...DEFAULT_HTML_STYLE.mention,
+      ...htmlStyleToMergeWith.mention,
       ...(isMentionStyleRecord(mention)
         ? (mention[indicator] ?? mention.default ?? {})
         : mention),

package/src/utils/normalizeHtmlStyle.ts

@@ -36,7 +36,8 @@ const convertToHtmlStyleInternal = (
 ): HtmlStyleInternal => {
   const mentionStyles = expandMentionStylesForIndicators(
     style.mention,
-    mentionIndicators
+    mentionIndicators,
+    DEFAULT_HTML_STYLE
   );
 
   let markerFontWeight: string | undefined;

package/src/web/EnrichedText.css

@@ -0,0 +1,343 @@
+.tiptap.ProseMirror p {
+  margin-top: 0;
+  margin-bottom: 0;
+}
+
+.tiptap.ProseMirror-focused {
+  outline: none;
+}
+
+.et-view {
+  white-space: pre-wrap;
+  overflow-wrap: anywhere;
+}
+
+.et-view p {
+  margin-top: 0;
+  margin-bottom: 0;
+}
+
+.eti-editor p.is-editor-empty:first-child::before {
+  color: var(--et-placeholder-text-color, #adb5bd);
+  content: attr(data-placeholder);
+  float: left;
+  height: 0;
+  pointer-events: none;
+}
+
+.eti-editor ::selection,
+.et-view ::selection {
+  background-color: var(--et-selection-color, Highlight);
+}
+
+.eti-editor code,
+.et-view code {
+  font-family: monospace;
+  background-color: var(--et-code-bg-color);
+  color: var(--et-code-color);
+  display: inline;
+  padding: 0;
+  line-height: inherit;
+  vertical-align: baseline;
+}
+
+.eti-editor h1,
+.et-view h1 {
+  font-size: var(--et-h1-font-size);
+  font-weight: var(--et-h1-font-weight);
+  margin: 0;
+  line-height: normal;
+}
+.eti-editor h2,
+.et-view h2 {
+  font-size: var(--et-h2-font-size);
+  font-weight: var(--et-h2-font-weight);
+  margin: 0;
+  line-height: normal;
+}
+.eti-editor h3,
+.et-view h3 {
+  font-size: var(--et-h3-font-size);
+  font-weight: var(--et-h3-font-weight);
+  margin: 0;
+  line-height: normal;
+}
+.eti-editor h4,
+.et-view h4 {
+  font-size: var(--et-h4-font-size);
+  font-weight: var(--et-h4-font-weight);
+  margin: 0;
+  line-height: normal;
+}
+.eti-editor h5,
+.et-view h5 {
+  font-size: var(--et-h5-font-size);
+  font-weight: var(--et-h5-font-weight);
+  margin: 0;
+  line-height: normal;
+}
+.eti-editor h6,
+.et-view h6 {
+  font-size: var(--et-h6-font-size);
+  font-weight: var(--et-h6-font-weight);
+  margin: 0;
+  line-height: normal;
+}
+
+.eti-editor blockquote,
+.et-view blockquote {
+  border-left: var(--et-blockquote-border-width) solid
+    var(--et-blockquote-border-color);
+  padding-left: var(--et-blockquote-gap-width);
+  margin: 0;
+  color: var(--et-blockquote-color);
+}
+
+.eti-editor blockquote p,
+.et-view blockquote p {
+  margin: 0;
+}
+
+.eti-editor codeblock,
+.et-view codeblock {
+  display: block;
+  font-family: monospace;
+  background-color: var(--et-codeblock-bg-color);
+  color: var(--et-codeblock-color);
+  border-radius: var(--et-codeblock-border-radius);
+}
+
+.eti-editor codeblock p,
+.et-view codeblock p {
+  margin: 0;
+}
+
+.eti-editor a,
+.et-view a {
+  color: var(--et-link-color);
+  text-decoration-line: var(--et-link-text-decoration-line);
+}
+
+.eti-editor li,
+.et-view li {
+  margin: 0;
+  min-height: 1.2em;
+}
+
+@supports (min-height: 1lh) {
+  .eti-editor li,
+  .et-view li {
+    min-height: 1lh;
+  }
+}
+
+/* Zero-width space to correctly display empty list elements */
+.eti-editor ul:not([data-type]) > li > p:empty::after,
+.et-view ul:not([data-type]) > li > p:empty::after,
+.eti-editor ol > li > p:empty::after,
+.et-view ol > li > p:empty::after,
+.eti-editor ul[data-type='checkboxList'] > li > div:empty::after,
+.et-view ul[data-type="checkbox"] > li > label:empty::after {
+  content: '\200b';
+}
+
+.eti-editor ul:not([data-type]),
+.et-view ul:not([data-type]) {
+  margin: 0;
+  list-style: none;
+  padding-left: calc(var(--et-ul-margin-left, 16px) + var(--et-ul-gap-width, 16px));
+}
+
+.eti-editor ul:not([data-type]) > li,
+.et-view ul:not([data-type]) > li {
+  margin: 0;
+  display: flex;
+  align-items: baseline;
+}
+
+.eti-editor ul:not([data-type]) > li::before,
+.et-view ul:not([data-type]) > li::before {
+  content: '';
+  flex-shrink: 0;
+  width: var(--et-ul-bullet-size, 8px);
+  height: var(--et-ul-bullet-size, 8px);
+  border-radius: 50%;
+  background-color: var(--et-ul-bullet-color, currentColor);
+
+  margin-left: calc(-1 * (var(--et-ul-bullet-size, 8px) + var(--et-ul-gap-width, 16px)));
+  margin-right: var(--et-ul-gap-width, 16px);
+
+  position: relative;
+  top: -0.1em;
+}
+
+.eti-editor ol,
+.et-view ol {
+  margin: 0;
+  list-style: none;
+  padding-left: calc(var(--et-ol-margin-left, 16px) + var(--et-ol-gap-width, 16px));
+  counter-reset: et-ol;
+}
+
+.eti-editor ol > li,
+.et-view ol > li {
+  margin: 0;
+  counter-increment: et-ol;
+  display: flex;
+  align-items: baseline;
+}
+
+.eti-editor ol > li::before,
+.et-view ol > li::before {
+  content: counter(et-ol) '.';
+  flex-shrink: 0;
+  width: var(--et-ol-margin-left, 16px);
+  text-align: right;
+  margin-right: calc(var(--et-ol-gap-width, 16px) / 2);
+  margin-left: calc(-1 * (var(--et-ol-margin-left, 16px) + (var(--et-ol-gap-width, 16px) / 2)));
+
+  color: var(--et-ol-marker-color, currentColor);
+  font-weight: var(--et-ol-marker-font-weight, inherit);
+  white-space: nowrap;
+}
+
+.eti-editor ul:not([data-type]) > li > p,
+.et-view ul:not([data-type]) > li > p,
+.eti-editor ol > li > p,
+.et-view ol > li > p {
+  display: block;
+  flex: 1 1 auto;
+  min-width: 0;
+  margin: 0;
+}
+
+.eti-editor li p,
+.et-view li p {
+  margin: 0;
+}
+
+.eti-editor .eti-inline-image {
+  vertical-align: text-bottom;
+  line-height: 0;
+  display: inline-block;
+}
+
+.eti-editor .eti-inline-image-img {
+  object-fit: contain;
+}
+
+.eti-editor .eti-inline-image--placeholder {
+  display: inline-block;
+  overflow: hidden;
+  color: inherit;
+}
+
+.eti-editor .eti-inline-image-broken-glyph {
+  display: block;
+  width: 100%;
+  height: 100%;
+}
+
+.eti-editor
+  .react-renderer.node-image.ProseMirror-selectednode
+  .eti-inline-image {
+  box-shadow: inset 0 0 0 999px Highlight;
+}
+
+.eti-editor ul[data-type='checkboxList'] {
+  margin: 0;
+  list-style: none;
+  padding-left: calc(var(--et-checkbox-margin-left, 16px) + var(--et-checkbox-gap-width, 16px));
+}
+
+.eti-editor ul[data-type='checkboxList'] > li {
+  margin: 0;
+  display: flex;
+  align-items: baseline;
+}
+
+.eti-editor ul[data-type='checkboxList'] > li > label {
+  display: inline-flex;
+  align-items: center;
+  flex-shrink: 0;
+  width: var(--et-checkbox-box-size, 24px);
+  height: var(--et-checkbox-box-size, 24px);
+
+  margin-left: calc(-1 * (var(--et-checkbox-box-size, 24px) + var(--et-checkbox-gap-width, 16px)));
+  margin-right: var(--et-checkbox-gap-width, 16px);
+
+  margin-top: 0;
+  position: relative;
+  top: 0.15em;
+}
+
+.eti-editor ul[data-type='checkboxList'] > li > label input[type='checkbox'] {
+  width: 100%;
+  height: 100%;
+  margin: 0;
+  flex-shrink: 0;
+  accent-color: var(--et-checkbox-box-color, #0000ff);
+}
+
+.eti-editor ul[data-type='checkboxList'] > li > div {
+  display: block;
+  flex: 1 1 auto;
+  min-width: 0;
+  margin: 0;
+}
+
+.et-view ul[data-type="checkbox"] {
+  margin: 0;
+  list-style: none;
+  padding-left: calc(
+    var(--et-checkbox-margin-left, 16px) + var(--et-checkbox-gap-width, 16px)
+  );
+}
+
+.et-view ul[data-type="checkbox"] > li {
+  margin: 0;
+  display: flex;
+  align-items: baseline;
+}
+
+.et-view ul[data-type="checkbox"] > li > input[type='checkbox'] {
+  flex-shrink: 0;
+
+  margin-left: calc(-1 * (var(--et-checkbox-box-size, 24px) + var(--et-checkbox-gap-width, 16px)));
+  margin-right: var(--et-checkbox-gap-width, 16px);
+  margin-bottom: 0;
+
+  width: var(--et-checkbox-box-size, 24px);
+  height: var(--et-checkbox-box-size, 24px);
+  accent-color: var(--et-checkbox-box-color, #0000ff);
+
+  /* disable checkbox press style as it's read-only */
+  pointer-events: none;
+  -webkit-tap-highlight-color: transparent;
+
+  margin-top: 0;
+  position: relative;
+  top: 0.15em;
+}
+
+.et-view ul[data-type="checkbox"] > li > label {
+  display: block;
+  flex: 1 1 auto;
+  min-width: 0;
+  margin: 0;
+  padding: 0;
+}
+
+.et-view img {
+  display: inline-block;
+  position: relative;
+  overflow: hidden;
+  vertical-align: text-bottom;
+}
+
+.et-view img.error {
+  content: linear-gradient(transparent, transparent);
+  background-color: currentColor;
+  -webkit-mask: var(--et-broken-image-glyph) no-repeat center / contain;
+  mask: var(--et-broken-image-glyph) no-repeat center / contain;
+}

package/src/web/EnrichedText.tsx

@@ -0,0 +1,82 @@
+import { memo, useMemo, useRef, type CSSProperties } from 'react';
+import type { EnrichedTextProps } from '../types';
+import './EnrichedText.css';
+import { enrichedTextStyleToCSSProperties } from './styleConversion/enrichedTextStyleToCSSProperties';
+import {
+  htmlStyleToCSSVariables,
+  mergeWithDefaultEnrichedTextHtmlStyle,
+} from './styleConversion/htmlStyleToCSSVariables';
+import { ENRICHED_TEXT_CLASSNAME } from './constants/classNames';
+import { enrichedInputThemingToCSSProperties } from './styleConversion/enrichedThemingToCSSProperties';
+import { buildMentionRulesCSS } from './styleConversion/buildMentionRulesCSS';
+import { sanitizeHtml } from './sanitization/htmlSanitizer';
+import { prepareHtmlForWeb } from './normalization/prepareHtmlForWeb';
+import { INLINE_IMAGE_CSS_VARIABLES } from './styleConversion/inlineImageCSSVariables';
+import { useImageErrorFallback } from './useImageErrorFallback';
+import { usePressInteractions } from './usePressInteractions';
+
+export const EnrichedText = memo(
+  ({ children, htmlStyle, style, selectionColor }: EnrichedTextProps) => {
+    const containerRef = useRef<HTMLDivElement>(null);
+
+    const sanitizedHtml = useMemo(() => sanitizeHtml(children), [children]);
+
+    const finalHtml = useMemo(
+      () => prepareHtmlForWeb(sanitizedHtml),
+      [sanitizedHtml]
+    );
+
+    const resolvedHtmlStyle = useMemo(
+      () => mergeWithDefaultEnrichedTextHtmlStyle(htmlStyle),
+      [htmlStyle]
+    );
+
+    const textStyle: CSSProperties = useMemo(
+      () => enrichedTextStyleToCSSProperties(style ?? {}),
+      [style]
+    );
+
+    const cssVars = useMemo(
+      () => ({
+        ...htmlStyleToCSSVariables(resolvedHtmlStyle),
+        ...INLINE_IMAGE_CSS_VARIABLES,
+      }),
+      [resolvedHtmlStyle]
+    );
+
+    const themingStyle = useMemo(
+      () => enrichedInputThemingToCSSProperties({ selectionColor }),
+      [selectionColor]
+    );
+
+    const mentionRulesCSS = useMemo(
+      () => buildMentionRulesCSS(resolvedHtmlStyle),
+      [resolvedHtmlStyle]
+    );
+
+    const finalStyle = useMemo(
+      () =>
+        ({
+          ...textStyle,
+          ...themingStyle,
+          ...cssVars,
+        }) as CSSProperties,
+      [textStyle, themingStyle, cssVars]
+    );
+
+    usePressInteractions(containerRef);
+    useImageErrorFallback(containerRef);
+
+    return (
+      <>
+        {mentionRulesCSS ? <style>{mentionRulesCSS}</style> : null}
+        <div
+          ref={containerRef}
+          style={finalStyle}
+          className={ENRICHED_TEXT_CLASSNAME}
+          dangerouslySetInnerHTML={{ __html: finalHtml }}
+        />
+      </>
+    );
+  }
+);