@tinymce/tinymce-react - npm Package Compare versions

Comparing version 5.1.2-feature.20240619151656946.shae2d5b34 to 5.1.2-feature.20240708060041889.sha4bce245

lib/cjs/main/ts/components/Editor.d.ts

@@ -24,18 +24,94 @@ import * as React from 'react';
 export interface IProps {
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#apikey React Tech Ref - apiKey}
+     * @description TinyMCE API key for deployments using Tiny Cloud.
+     */
     apiKey: string;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#id React Tech Ref - id}
+     * @description The ID of the element to render the editor into.
+     */
     id: string;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#inline React Tech Ref - inline}
+     * @description Whether the editor should be rendered inline. Equivalent to the `inline` option in TinyMCE.
+     */
     inline: boolean;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#initialvalue React Tech Ref - initialValue}
+     * @description The initial HTML content of the editor.
+     *
+     * IMPORTANT: Ensure that this is **not** updated by `onEditorChange` or the editor will be unusable.
+     */
     initialValue: string;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#oneditorchange React Tech Ref - onEditorChange}
+     * @description Used to store the state of the editor outside the component. Typically used for controlled components.
+     * @param a The current HTML content of the editor.
+     * @param editor The TinyMCE editor instance.
+     * @returns void
+     */
     onEditorChange: (a: string, editor: TinyMCEEditor) => void;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#value React Tech Ref - value}
+     * @description The current HTML content of the editor. Typically used for controlled components.
+     */
     value: string;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#init React Tech Ref - init}
+     * @description Additional settings passed to `tinymce.init()` when initializing the editor.
+     */
     init: InitOptions;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#tagname React Tech Ref - tagName}
+     * @description The tag name of the element to render the editor into. Only valid when `inline` is `true`.
+     */
     tagName: string;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#tabIndex React Tech Ref - tabIndex}
+     * @description The tab index of the element that the editor wraps.
+     */
     tabIndex: number;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#cloudchannel React Tech Ref - cloudChannel}
+     * @description The TinyMCE build to use when loading from Tiny Cloud.
+     */
     cloudChannel: Version;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#plugins React Tech Ref - plugins}
+     * @description The plugins to load into the editor. Equivalent to the `plugins` option in TinyMCE.
+     */
     plugins: NonNullable<EditorOptions['plugins']>;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#toolbar React Tech Ref - toolbar}
+     * @description The toolbar to load into the editor. Equivalent to the `toolbar` option in TinyMCE.
+     */
     toolbar: NonNullable<EditorOptions['toolbar']>;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#disabled React Tech Ref - disabled}
+     * @description Whether the editor should be "disabled" (read-only).
+     */
     disabled: boolean;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#textareaname React Tech Ref - textareaName}
+     * @description Set the `name` attribute of the `textarea` element used for the editor in forms. Only valid in iframe mode.
+     */
     textareaName: string;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#tinymcescriptsrc React Tech Ref - tinymceScriptSrc}
+     * @description The URL of the TinyMCE script to lazy load.
+     */
     tinymceScriptSrc: string | string[] | ScriptItem[];
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#rollback React Tech Ref - rollback}
+     * @description The number of milliseconds to wait after before reverting to the previous value when the editor's content changes.
+     */
     rollback: number | false;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#scriptloading React Tech Ref - scriptLoading}
+     * @description Options for how the TinyMCE script should be loaded.
+     * @property async Whether the script should be loaded with the `async` attribute.
+     * @property defer Whether the script should be loaded with the `defer` attribute.
+     * @property delay The number of milliseconds to wait before loading the script.
+     */
     scriptLoading: {
@@ -46,2 +122,6 @@ async?: boolean;
     };
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#licenseKey React Tech Ref - licenseKey}
+     * @description Tiny Cloud License Key for when self-hosting TinyMCE.
+     */
     licenseKey: string;
@@ -52,3 +132,3 @@ }
 /**
- * @see {@link https://www.tiny.cloud/docs/tinymce/7/react-ref/} for the TinyMCE React Technical Reference
+ * @see {@link https://www.tiny.cloud/docs/tinymce/7/react-ref/ TinyMCE React Technical Reference}
  */
@@ -55,0 +135,0 @@ export declare class Editor extends React.Component<IAllProps> {

lib/cjs/main/ts/components/Editor.js

@@ -36,3 +36,3 @@ "use strict";
 /**
- * @see {@link https://www.tiny.cloud/docs/tinymce/7/react-ref/} for the TinyMCE React Technical Reference
+ * @see {@link https://www.tiny.cloud/docs/tinymce/7/react-ref/ TinyMCE React Technical Reference}
  */
@@ -39,0 +39,0 @@ var Editor = /** @class */ (function (_super) {

lib/es2015/main/ts/components/Editor.d.ts

@@ -24,18 +24,94 @@ import * as React from 'react';
 export interface IProps {
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#apikey React Tech Ref - apiKey}
+     * @description TinyMCE API key for deployments using Tiny Cloud.
+     */
     apiKey: string;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#id React Tech Ref - id}
+     * @description The ID of the element to render the editor into.
+     */
     id: string;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#inline React Tech Ref - inline}
+     * @description Whether the editor should be rendered inline. Equivalent to the `inline` option in TinyMCE.
+     */
     inline: boolean;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#initialvalue React Tech Ref - initialValue}
+     * @description The initial HTML content of the editor.
+     *
+     * IMPORTANT: Ensure that this is **not** updated by `onEditorChange` or the editor will be unusable.
+     */
     initialValue: string;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#oneditorchange React Tech Ref - onEditorChange}
+     * @description Used to store the state of the editor outside the component. Typically used for controlled components.
+     * @param a The current HTML content of the editor.
+     * @param editor The TinyMCE editor instance.
+     * @returns void
+     */
     onEditorChange: (a: string, editor: TinyMCEEditor) => void;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#value React Tech Ref - value}
+     * @description The current HTML content of the editor. Typically used for controlled components.
+     */
     value: string;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#init React Tech Ref - init}
+     * @description Additional settings passed to `tinymce.init()` when initializing the editor.
+     */
     init: InitOptions;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#tagname React Tech Ref - tagName}
+     * @description The tag name of the element to render the editor into. Only valid when `inline` is `true`.
+     */
     tagName: string;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#tabIndex React Tech Ref - tabIndex}
+     * @description The tab index of the element that the editor wraps.
+     */
     tabIndex: number;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#cloudchannel React Tech Ref - cloudChannel}
+     * @description The TinyMCE build to use when loading from Tiny Cloud.
+     */
     cloudChannel: Version;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#plugins React Tech Ref - plugins}
+     * @description The plugins to load into the editor. Equivalent to the `plugins` option in TinyMCE.
+     */
     plugins: NonNullable<EditorOptions['plugins']>;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#toolbar React Tech Ref - toolbar}
+     * @description The toolbar to load into the editor. Equivalent to the `toolbar` option in TinyMCE.
+     */
     toolbar: NonNullable<EditorOptions['toolbar']>;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#disabled React Tech Ref - disabled}
+     * @description Whether the editor should be "disabled" (read-only).
+     */
     disabled: boolean;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#textareaname React Tech Ref - textareaName}
+     * @description Set the `name` attribute of the `textarea` element used for the editor in forms. Only valid in iframe mode.
+     */
     textareaName: string;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#tinymcescriptsrc React Tech Ref - tinymceScriptSrc}
+     * @description The URL of the TinyMCE script to lazy load.
+     */
     tinymceScriptSrc: string | string[] | ScriptItem[];
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#rollback React Tech Ref - rollback}
+     * @description The number of milliseconds to wait after before reverting to the previous value when the editor's content changes.
+     */
     rollback: number | false;
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#scriptloading React Tech Ref - scriptLoading}
+     * @description Options for how the TinyMCE script should be loaded.
+     * @property async Whether the script should be loaded with the `async` attribute.
+     * @property defer Whether the script should be loaded with the `defer` attribute.
+     * @property delay The number of milliseconds to wait before loading the script.
+     */
     scriptLoading: {
@@ -46,2 +122,6 @@ async?: boolean;
     };
+    /**
+     * @see {@link https://www.tiny.cloud/docs/tinymce/latest/react-ref/#licenseKey React Tech Ref - licenseKey}
+     * @description Tiny Cloud License Key for when self-hosting TinyMCE.
+     */
     licenseKey: string;
@@ -52,3 +132,3 @@ }
 /**
- * @see {@link https://www.tiny.cloud/docs/tinymce/7/react-ref/} for the TinyMCE React Technical Reference
+ * @see {@link https://www.tiny.cloud/docs/tinymce/7/react-ref/ TinyMCE React Technical Reference}
  */
@@ -55,0 +135,0 @@ export declare class Editor extends React.Component<IAllProps> {

lib/es2015/main/ts/components/Editor.js

@@ -33,3 +33,3 @@ var __extends = (this && this.__extends) || (function () {
 /**
- * @see {@link https://www.tiny.cloud/docs/tinymce/7/react-ref/} for the TinyMCE React Technical Reference
+ * @see {@link https://www.tiny.cloud/docs/tinymce/7/react-ref/ TinyMCE React Technical Reference}
  */
@@ -36,0 +36,0 @@ var Editor = /** @class */ (function (_super) {

package.json

@@ -73,4 +73,4 @@ {
   },
-  "version": "5.1.2-feature.20240619151656946.shae2d5b34",
+  "version": "5.1.2-feature.20240708060041889.sha4bce245",
   "name": "@tinymce/tinymce-react"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

110565

increased by8.66%

Lines of code

2028

increased by8.57%

No dependency changes