@entur-partner/rich-text-editor 6.3.5 → 7.0.0

package/README.md

@@ -16,9 +16,30 @@ yarn add @entur-partner/rich-text-editor
 ## Requirements
 
 - Node.JS ~24
-- yarn ~4.9.2
+- yarn ~4.13
 
-You may use [Volta](https://docs.volta.sh/guide/) to manage your js command-line tools. Versions are pinned in `package.json` for seamless, per-project version [switching](https://docs.volta.sh/guide/understanding#managing-your-project).
+We use [mise](https://mise.jdx.dev/) to set up basic tooling and tasks to be used in the project.
+To install mise, run the following:
+
+```shell
+# Install mise
+brew install mise
+
+# Activate mise. If you use another shell than zsh, please refer to https://mise.jdx.dev/cli/activate.html
+echo 'eval "$(mise activate zsh)"' >> ~/.zshrc
+
+# Mark the mise configuration as trusted. This is needed due to using experimental features in the .mise.toml file.
+mise trust
+```
+
+Then, navigate to the project root and run:
+
+```shell
+mise install
+```
+
+This will install the required tools and dependencies specified in the `.mise.toml` file.
+**Note!** Remember to reload your terminal to ensure all changes take effect.
 
 ## Development
 
@@ -28,7 +49,7 @@ All dependencies are defined in `package.json` and are managed with [yarn](https
 initially install all dependencies and when the list dependency has changed, run `yarn`.
 
 ```
-$ yarn && yarn bootstrap
+$ yarn
 ```
 
 ### Build
@@ -41,7 +62,7 @@ $ yarn build
 
 ### Code style
 
-[BiomeJS](https://biomejs.dev/formatter/) is used for automatic code formatting.
+[Oxc](https://oxc.rs/) is used for automatic code formatting and linting.
 
 Format code:
 
@@ -55,19 +76,19 @@ Check that code is formatted correctly:
 $ yarn format-check
 ```
 
-Tip: See [Editor integration](https://biomejs.dev/reference/vscode/) for how to configure your editor to format code on save.
+Tip: See [Editor integration](https://oxc.rs/docs/guide/usage/formatter/editors.html) for how to configure your editor to format code on save.
 
 ### Linting
 
-BiomeJS is used for linting. Check linting:
+[Oxc](https://oxc.rs/) is used for linting. Check linting:
 
 ```
-$ yarn lint-check
+$ yarn lint
 ```
 
 ### Testing
 
-Uses [Jest](https://facebook.github.io/jest) to test unit and reducer testing
+Uses [Vitest](https://vitest.dev/) to test unit and reducer testing
 
 ```
 yarn test

package/dist/index.d.ts

@@ -1,5 +1,41 @@
-export { ExpandableMultiLanguageRichTextEditor } from "./ExpandableMultiLanguageRichTextEditor";
-export { default as RichTextEditor } from "./RichTextEditor";
-export { EditorConfigTypes, MinifiedConfigTypes, } from "./RichTextEditor/constants";
-export { editorStateToHtml, htmlToEditorState, } from "./RichTextEditor/htmlConvertion";
-export { editorStateToMarkdown, markdownToEditorState, markdownToHtml, } from "./RichTextEditor/markdownConvertion";
+import * as _$react_jsx_runtime0 from "react/jsx-runtime";
+
+//#region src/RichTextEditor/RichTextEditor.d.ts
+type RichTextEditorProps = {
+  className?: string;
+  label?: string;
+  initialValue: string;
+  onChange: (value: string) => void;
+  contentType?: 'markdown' | 'html';
+  maxNumberOfCharacters?: number;
+};
+/**
+ * RichTextEditor is a React component that provides a rich text editing interface using the Tiptap editor.
+ *
+ * @param {string} [className] - Optional additional class name for styling the editor container.
+ * @param {string} [label] - Optional label to display above the editor.
+ * @param {string} initialValue - The initial content of the editor, which can be in markdown or HTML format.
+ * @param {function} onChange - A callback function that is called whenever the content of the editor changes. It receives the current content as an argument.
+ * @param {'markdown' | 'html'} [contentType='html'] - The format of the content (either 'markdown' or 'html'). This determines how the content is processed and returned in the onChange callback.
+ * @param {number} [maxNumberOfCharacters=0] - The maximum number of characters allowed in the editor. This limits the amount of content that can be entered by the user. (0 means no limit)
+ * @returns {JSX.Element} A React component that renders a rich text editor with the specified configuration and functionality.
+ * @example
+ * <RichTextEditor
+ *   className="description-editor"
+ *   initialValue="# Hello World\n\nThis is **Markdown**!"
+ *   onChange={(value) => console.log(value)}
+ *   label="My Rich Text Editor"
+ *   contentType="markdown"
+ *   maxNumberOfCharacters={5000}
+ * />
+ */
+declare const RichTextEditor: ({
+  className,
+  label,
+  initialValue,
+  onChange,
+  contentType,
+  maxNumberOfCharacters
+}: RichTextEditorProps) => _$react_jsx_runtime0.JSX.Element | null;
+//#endregion
+export { RichTextEditor };