@luscii-healthtech/web-ui 14.0.0 → 15.0.0

package/dist/components/TextEditor/TextEditor.d.ts

@@ -4,7 +4,43 @@ import "react-quill/dist/quill.snow.css";
 import "./TextEditor.scss";
 type TextEditorProps = Pick<ReactQuillProps, "defaultValue" | "placeholder"> & {
     onValueChange: ReactQuillProps["onChange"];
+    /**
+     * Which formats to allow in the editor, like "bold" and "italic".
+     *
+     * This is different from the buttons that are shown in the toolbar,
+     * because a user could paste in text that has bold formatting without
+     * having a bold button in the toolbar. This prop determines if that is
+     * allowed or not.
+     *
+     * @default
+     *
+     * ["bold", "italic", "underline", "strike", "list", "link"]
+     *
+     * @example
+     *
+     * ["bold", "italic, "color", "code"]
+     *
+     * See: https://github.com/zenoamaro/react-quill#custom-formats
+     */
     formats: TextEditorFormat[];
+    /**
+     * Which buttons to show in the toolbar, like "bold" and "italic".
+     *
+     * @default
+     * [
+     *   ["bold", "italic", "underline", "strike"],
+     *   [{ list: "ordered" }, { list: "bullet" }],
+     *   ["link"],
+     * ]
+     *
+     * @example
+     *
+     * [
+     *   ["bold", "italic", "underline", "strike"],
+     *   ["link", "video"],
+     * ]
+     * See: https://github.com/zenoamaro/react-quill#custom-toolbar
+     */
     toolbar: TextEditorToolbarOption[][];
 };
 type TextEditorToolbarOption = "bold" | "italic" | "underline" | "strike" | "link" | "video" | {

package/dist/index.development.js

@@ -4848,7 +4848,7 @@ styleInject(css_248z);
 const TextEditor = ({ defaultValue, onValueChange, placeholder, toolbar = [
   ["bold", "italic", "underline", "strike"],
   [{ list: "ordered" }, { list: "bullet" }],
-  ["link", "video"]
+  ["link"]
 ], formats = ["bold", "italic", "underline", "strike", "list", "link"] }) => {
   const quillRef = React.useRef(null);
   React.useEffect(() => {