feat: update component methods and demo page

Author: ChrisUser

lib/ContentEditable.tsx

@@ -6,11 +6,13 @@ interface ContentEditableProps {
   placeholderClassName?: string
   placeholder?: string
   disabled?: boolean
+  updatedContent?: string
   onChange: (content: string) => void
   onKeyUp?: (e: React.KeyboardEvent) => void
   onKeyDown?: (e: React.KeyboardEvent) => void
   onFocus?: (e: React.FocusEvent) => void
   onBlur?: (e: React.FocusEvent) => void
+  onContentExternalUpdate?: (content: string) => void
 }
 
 const ContentEditable: React.FC<ContentEditableProps> = ({
@@ -19,26 +21,35 @@ const ContentEditable: React.FC<ContentEditableProps> = ({
   placeholderClassName,
   placeholder,
   disabled,
+  updatedContent,
   onChange,
   onKeyUp,
   onKeyDown,
   onFocus,
   onBlur,
+  onContentExternalUpdate,
 }) => {
   const [content, setContent] = useState("")
   const divRef = useRef<HTMLDivElement | null>(null)
 
+  useEffect(() => {
+    if (updatedContent) {
+      setContent(updatedContent)
+      if (onContentExternalUpdate) onContentExternalUpdate(updatedContent)
+    }
+  }, [updatedContent, onContentExternalUpdate])
+
   useEffect(() => {
     if (divRef.current) {
       divRef.current.style.height = "auto"
-      // divRef.current.style.height = divRef.current.scrollHeight + "px"
       onChange(content)
     }
   }, [content, onChange])
 
   /**
-   * Check if the caret is on the last line of an element
-   * Returns `false` when the caret is part of a selection
+   * Checks if the caret is on the last line of a contenteditable element
+   * @param element - The HTMLDivElement to check
+   * @returns A boolean indicating whether the caret is on the last line or `false` when the caret is part of a selection
    */
   const isCaretOnLastLine = useCallback((element: HTMLDivElement): boolean => {
     if (element.ownerDocument.activeElement !== element) return false
@@ -82,6 +93,10 @@ const ContentEditable: React.FC<ContentEditableProps> = ({
     return originalCaretRect.bottom === endOfElementRect.bottom
   }, [])
 
+  /**
+   * Handles the caret scroll behavior based on keyboard events
+   * @param e - The keyboard event
+   */
   const handleCaretScroll = useCallback(
     (e: KeyboardEvent) => {
       if (!divRef.current) return
@@ -136,6 +151,10 @@ const ContentEditable: React.FC<ContentEditableProps> = ({
     }
   }
 
+  /**
+   * Inserts the specified text at the current caret position in the contentEditable element
+   * @param text - The text to be inserted
+   */
   function insertTextAtCaret(text: string) {
     if (!divRef.current) return
     const currentCaretPos = getCaretPosition(divRef.current)
@@ -152,6 +171,13 @@ const ContentEditable: React.FC<ContentEditableProps> = ({
 
   // Note: setSelectionRange and createTextRange are not supported by contenteditable elements
 
+  /**
+   * Sets the caret position within the contentEditable element
+   * If the element is empty, it will be focused
+   *
+   * @param elem - The contentEditable element
+   * @param pos - The position to set the caret to
+   */
   function setCaretPosition(elem: HTMLElement, pos: number) {
     // Create a new range
     const range = document.createRange()
@@ -178,6 +204,11 @@ const ContentEditable: React.FC<ContentEditableProps> = ({
     }
   }
 
+  /**
+   * Retrieves the caret position within the contentEditable element
+   * @param editableDiv - The contentEditable element
+   * @returns The caret position as a number
+   */
   function getCaretPosition(editableDiv: HTMLElement) {
     let caretPos = 0,
       range
@@ -207,7 +238,6 @@ const ContentEditable: React.FC<ContentEditableProps> = ({
   function handleKeyDown(e: React.KeyboardEvent) {
     if (onKeyDown) onKeyDown(e)
     if ((e.key === "Delete" || e.key === "Backspace") && isAllTextSelected()) {
-      console.log("delete all", isAllTextSelected())
       e.preventDefault()
       if (divRef.current) {
         divRef.current.innerText = ""
@@ -237,13 +267,7 @@ const ContentEditable: React.FC<ContentEditableProps> = ({
   return (
     <div
       className={containerClassName}
-      style={{
-        display: "flex",
-        justifyContent: "flex-start",
-        alignItems: "center",
-        width: "calc(100% - 32px)",
-        padding: "0 16px",
-      }}
+      style={{ display: "flex", alignItems: "center" }}
     >
       <div
         ref={divRef}
@@ -255,15 +279,9 @@ const ContentEditable: React.FC<ContentEditableProps> = ({
         aria-label={placeholder ?? ""}
         className={contentEditableClassName}
         style={{
-          width: "100%",
-          border: "1px solid #ccc",
-          borderRadius: "0.35rem",
           padding: "calc((1.5rem * 1.3125)/2) 0 calc((1.5rem * 1.3125)/2) 1rem",
-          minHeight: "19px",
-          maxHeight: "160px",
           overflow: "auto",
           height: "auto",
-          lineHeight: 1.3,
           textAlign: "initial",
           wordBreak: "break-word",
           unicodeBidi: "plaintext",
@@ -297,10 +315,8 @@ const ContentEditable: React.FC<ContentEditableProps> = ({
           className={placeholderClassName}
           style={{
             position: "absolute",
-            color: "#a2acb4",
             pointerEvents: "none",
             textAlign: "initial",
-            marginLeft: "1rem",
           }}
         >
           {placeholder ?? ""}

src/App.css

@@ -1,42 +1,24 @@
-#root {
-  max-width: 1280px;
-  margin: 0 auto;
-  padding: 2rem;
-  text-align: center;
-}
-
-.logo {
-  height: 6em;
-  padding: 1.5em;
-  will-change: filter;
-  transition: filter 300ms;
-}
-.logo:hover {
-  filter: drop-shadow(0 0 2em #646cffaa);
-}
-.logo.react:hover {
-  filter: drop-shadow(0 0 2em #61dafbaa);
-}
-
-@keyframes logo-spin {
-  from {
-    transform: rotate(0deg);
-  }
-  to {
-    transform: rotate(360deg);
-  }
-}
-
-@media (prefers-reduced-motion: no-preference) {
-  a:nth-of-type(2) .logo {
-    animation: logo-spin infinite 20s linear;
-  }
-}
-
-.card {
-  padding: 2em;
-}
-
-.read-the-docs {
-  color: #888;
+.main-container {
+  padding: 3rem;
+  display: flex;
+  justify-content: center;
+  align-items: center;
+}
+.full-width {
+  width: 100%;
+}
+.input-container {
+  padding: 0 1rem;
+  position: relative;
+}
+.input-element {
+  border: 1px solid #ccc;
+  border-radius: 0.35rem;
+  line-height: 1.3;
+  min-height: 1.188rem;
+  max-height: 10rem;
+}
+.input-placeholder {
+  color: #a2acb4;
+  margin-left: 1rem;
 }

src/App.tsx

@@ -5,10 +5,13 @@ import { useState } from "react"
 function App() {
   const [content, setContent] = useState("")
   return (
-    <div>
+    <div className="main-container full-width">
       <div style={{ whiteSpace: "pre-wrap" }}>{content}</div>
       <ContentEditable
         placeholder="Type here"
+        containerClassName="full-width input-container"
+        contentEditableClassName="full-width input-element"
+        placeholderClassName="input-placeholder"
         onChange={(content) => setContent(content)}
       />
     </div>

src/index.css

@@ -1,27 +1,12 @@
 :root {
   font-family: Inter, system-ui, Avenir, Helvetica, Arial, sans-serif;
-  line-height: 1.5;
   font-weight: 400;
-
-  color-scheme: light dark;
-  color: rgba(255, 255, 255, 0.87);
-  background-color: #242424;
-
   font-synthesis: none;
   text-rendering: optimizeLegibility;
   -webkit-font-smoothing: antialiased;
   -moz-osx-font-smoothing: grayscale;
 }
 
-a {
-  font-weight: 500;
-  color: #646cff;
-  text-decoration: inherit;
-}
-a:hover {
-  color: #535bf2;
-}
-
 body {
   margin: 0;
   display: flex;
@@ -30,39 +15,9 @@ body {
   min-height: 100vh;
 }
 
-h1 {
-  font-size: 3.2em;
-  line-height: 1.1;
-}
-
-button {
-  border-radius: 8px;
-  border: 1px solid transparent;
-  padding: 0.6em 1.2em;
-  font-size: 1em;
-  font-weight: 500;
-  font-family: inherit;
-  background-color: #1a1a1a;
-  cursor: pointer;
-  transition: border-color 0.25s;
-}
-button:hover {
-  border-color: #646cff;
-}
-button:focus,
-button:focus-visible {
-  outline: 4px auto -webkit-focus-ring-color;
-}
-
-@media (prefers-color-scheme: light) {
-  :root {
-    color: #213547;
-    background-color: #ffffff;
-  }
-  a:hover {
-    color: #747bff;
-  }
-  button {
-    background-color: #f9f9f9;
-  }
+#root {
+  width: 100%;
+  display: flex;
+  justify-content: center;
+  align-items: center;
 }