@limetech/lime-elements 37.19.1 → 37.21.0

package/dist/types/components/text-editor/prosemirror-adapter.d.ts

@@ -0,0 +1,32 @@
+/**
+ * The ProseMirror adapter offers a rich text editing experience with markdown support,
+ * in the sense that you can easily type markdown syntax and see the rendered
+ * result as rich text in real-time. For instance, you can type `# Hello, world!`
+ * and see it directly turning to a heading 1 (an `<h1>` HTML element).
+ *
+ * Naturally, you can use standard keyboard hotkeys such as <kbd>Ctrl</kbd> + <kbd>B</kbd>
+ * to toggle bold text, <kbd>Ctrl</kbd> + <kbd>I</kbd> to toggle italic text, and so on.
+ *
+ * @exampleComponent limel-example-prosemirror-adapter-basic
+ * @beta
+ * @private
+ */
+export declare class ProsemirrorAdapter {
+  /**
+   * The value of the editor
+   */
+  value: {
+    html: string;
+  };
+  private host;
+  private view;
+  /**
+   * Dispatched when a change is made to the editor
+   */
+  private change;
+  componentWillLoad(): void;
+  render(): any;
+  componentDidLoad(): void;
+  private getHTML;
+}
+//# sourceMappingURL=prosemirror-adapter.d.ts.map

package/dist/types/components/text-editor/text-editor.d.ts

@@ -1,25 +1,64 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+import { FormComponent } from '../form/form.types';
 /**
- * This editor offers a rich text editing experience with markdown support,
- * in the sense that you can easily type markdown syntax and see the rendered
- * result as rich text in real-time. For instance, you can type `# Hello, world!`
- * and see it directly turning to a heading 1 (an `<h1>` HTML element).
- *
- * Naturally, you can use standard keyboard hotkeys such as <kbd>Ctrl</kbd> + <kbd>B</kbd>
- * to toggle bold text, <kbd>Ctrl</kbd> + <kbd>I</kbd> to toggle italic text, and so on.
+ * A rich text editor that allows the user to input and format text
+ * The `limel-text-editor` can be used as a form field
  *
  * @exampleComponent limel-example-text-editor-basic
  * @beta
  * @private
  */
-export declare class TextEditor {
-  private host;
-  private view;
+export declare class TextEditor implements FormComponent<{
+  html: string;
+}> {
+  /**
+   * Set to `true` to disable the field.
+   * Use `disabled` to indicate that the field can normally be interacted
+   * with, but is currently disabled. This tells the user that if certain
+   * requirements are met, the field may become enabled again.
+   */
+  disabled?: boolean;
+  /**
+   * Set to `true` to make the component read-only.
+   * Use `readonly` when the field is only there to present the data it holds,
+   * and will not become possible for the current user to edit.
+   * :::note
+   * Consider that it might be better to use `limel-markdown`
+   * instead of `limel-text-editor` when the goal is visualizing data.
+   * :::
+   */
+  readonly?: boolean;
+  /**
+   * Optional helper text to display below the input field when it has focus
+   */
+  helperText?: string;
+  /**
+   * The placeholder text shown inside the input field,
+   * when the field is empty.
+   */
+  placeholder?: string;
+  /**
+   * The label of the editor
+   */
+  label?: string;
+  /**
+   * Set to `true` to indicate that the current value of the editor is
+   * invalid.
+   */
+  invalid?: boolean;
+  /**
+   * Description of the text inside the editor
+   */
+  value: {
+    html: string;
+  };
   /**
    * Dispatched when a change is made to the editor
    */
-  private change;
-  componentWillLoad(): void;
+  change: EventEmitter<{
+    html: string;
+  }>;
   render(): any;
-  componentDidLoad(): void;
+  private handleChange;
 }
 //# sourceMappingURL=text-editor.d.ts.map

package/dist/types/components.d.ts

@@ -2053,6 +2053,23 @@ export namespace Components {
          */
         "readonly": boolean;
     }
+    /**
+     * The ProseMirror adapter offers a rich text editing experience with markdown support,
+     * in the sense that you can easily type markdown syntax and see the rendered
+     * result as rich text in real-time. For instance, you can type `# Hello, world!`
+     * and see it directly turning to a heading 1 (an `<h1>` HTML element).
+     * Naturally, you can use standard keyboard hotkeys such as <kbd>Ctrl</kbd> + <kbd>B</kbd>
+     * to toggle bold text, <kbd>Ctrl</kbd> + <kbd>I</kbd> to toggle italic text, and so on.
+     * @exampleComponent limel-example-prosemirror-adapter-basic
+     * @beta 
+     * @private 
+     */
+    interface LimelProsemirrorAdapter {
+        /**
+          * The value of the editor
+         */
+        "value": { html: string };
+    }
     /**
      * @exampleComponent limel-example-select
      * @exampleComponent limel-example-select-with-icons
@@ -2458,17 +2475,41 @@ export namespace Components {
         "totalRows": number;
     }
     /**
-     * This editor offers a rich text editing experience with markdown support,
-     * in the sense that you can easily type markdown syntax and see the rendered
-     * result as rich text in real-time. For instance, you can type `# Hello, world!`
-     * and see it directly turning to a heading 1 (an `<h1>` HTML element).
-     * Naturally, you can use standard keyboard hotkeys such as <kbd>Ctrl</kbd> + <kbd>B</kbd>
-     * to toggle bold text, <kbd>Ctrl</kbd> + <kbd>I</kbd> to toggle italic text, and so on.
+     * A rich text editor that allows the user to input and format text
+     * The `limel-text-editor` can be used as a form field
      * @exampleComponent limel-example-text-editor-basic
      * @beta 
      * @private 
      */
     interface LimelTextEditor {
+        /**
+          * Set to `true` to disable the field. Use `disabled` to indicate that the field can normally be interacted with, but is currently disabled. This tells the user that if certain requirements are met, the field may become enabled again.
+         */
+        "disabled"?: boolean;
+        /**
+          * Optional helper text to display below the input field when it has focus
+         */
+        "helperText"?: string;
+        /**
+          * Set to `true` to indicate that the current value of the editor is invalid.
+         */
+        "invalid"?: boolean;
+        /**
+          * The label of the editor
+         */
+        "label"?: string;
+        /**
+          * The placeholder text shown inside the input field, when the field is empty.
+         */
+        "placeholder"?: string;
+        /**
+          * Set to `true` to make the component read-only. Use `readonly` when the field is only there to present the data it holds, and will not become possible for the current user to edit. :::note Consider that it might be better to use `limel-markdown` instead of `limel-text-editor` when the goal is visualizing data. :::
+         */
+        "readonly"?: boolean;
+        /**
+          * Description of the text inside the editor
+         */
+        "value": { html: string };
     }
     /**
      * A tooltip can be used to display a descriptive text for any element.
@@ -2674,6 +2715,10 @@ export interface LimelProgressFlowItemCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLLimelProgressFlowItemElement;
 }
+export interface LimelProsemirrorAdapterCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLLimelProsemirrorAdapterElement;
+}
 export interface LimelSelectCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLLimelSelectElement;
@@ -3757,6 +3802,23 @@ declare global {
         prototype: HTMLLimelProgressFlowItemElement;
         new (): HTMLLimelProgressFlowItemElement;
     };
+    /**
+     * The ProseMirror adapter offers a rich text editing experience with markdown support,
+     * in the sense that you can easily type markdown syntax and see the rendered
+     * result as rich text in real-time. For instance, you can type `# Hello, world!`
+     * and see it directly turning to a heading 1 (an `<h1>` HTML element).
+     * Naturally, you can use standard keyboard hotkeys such as <kbd>Ctrl</kbd> + <kbd>B</kbd>
+     * to toggle bold text, <kbd>Ctrl</kbd> + <kbd>I</kbd> to toggle italic text, and so on.
+     * @exampleComponent limel-example-prosemirror-adapter-basic
+     * @beta 
+     * @private 
+     */
+    interface HTMLLimelProsemirrorAdapterElement extends Components.LimelProsemirrorAdapter, HTMLStencilElement {
+    }
+    var HTMLLimelProsemirrorAdapterElement: {
+        prototype: HTMLLimelProsemirrorAdapterElement;
+        new (): HTMLLimelProsemirrorAdapterElement;
+    };
     /**
      * @exampleComponent limel-example-select
      * @exampleComponent limel-example-select-with-icons
@@ -3953,12 +4015,8 @@ declare global {
         new (): HTMLLimelTableElement;
     };
     /**
-     * This editor offers a rich text editing experience with markdown support,
-     * in the sense that you can easily type markdown syntax and see the rendered
-     * result as rich text in real-time. For instance, you can type `# Hello, world!`
-     * and see it directly turning to a heading 1 (an `<h1>` HTML element).
-     * Naturally, you can use standard keyboard hotkeys such as <kbd>Ctrl</kbd> + <kbd>B</kbd>
-     * to toggle bold text, <kbd>Ctrl</kbd> + <kbd>I</kbd> to toggle italic text, and so on.
+     * A rich text editor that allows the user to input and format text
+     * The `limel-text-editor` can be used as a form field
      * @exampleComponent limel-example-text-editor-basic
      * @beta 
      * @private 
@@ -4076,6 +4134,7 @@ declare global {
         "limel-portal": HTMLLimelPortalElement;
         "limel-progress-flow": HTMLLimelProgressFlowElement;
         "limel-progress-flow-item": HTMLLimelProgressFlowItemElement;
+        "limel-prosemirror-adapter": HTMLLimelProsemirrorAdapterElement;
         "limel-select": HTMLLimelSelectElement;
         "limel-shortcut": HTMLLimelShortcutElement;
         "limel-slider": HTMLLimelSliderElement;
@@ -6249,6 +6308,27 @@ declare namespace LocalJSX {
          */
         "readonly"?: boolean;
     }
+    /**
+     * The ProseMirror adapter offers a rich text editing experience with markdown support,
+     * in the sense that you can easily type markdown syntax and see the rendered
+     * result as rich text in real-time. For instance, you can type `# Hello, world!`
+     * and see it directly turning to a heading 1 (an `<h1>` HTML element).
+     * Naturally, you can use standard keyboard hotkeys such as <kbd>Ctrl</kbd> + <kbd>B</kbd>
+     * to toggle bold text, <kbd>Ctrl</kbd> + <kbd>I</kbd> to toggle italic text, and so on.
+     * @exampleComponent limel-example-prosemirror-adapter-basic
+     * @beta 
+     * @private 
+     */
+    interface LimelProsemirrorAdapter {
+        /**
+          * Dispatched when a change is made to the editor
+         */
+        "onChange"?: (event: LimelProsemirrorAdapterCustomEvent<{ html: string }>) => void;
+        /**
+          * The value of the editor
+         */
+        "value"?: { html: string };
+    }
     /**
      * @exampleComponent limel-example-select
      * @exampleComponent limel-example-select-with-icons
@@ -6710,21 +6790,45 @@ declare namespace LocalJSX {
         "totalRows"?: number;
     }
     /**
-     * This editor offers a rich text editing experience with markdown support,
-     * in the sense that you can easily type markdown syntax and see the rendered
-     * result as rich text in real-time. For instance, you can type `# Hello, world!`
-     * and see it directly turning to a heading 1 (an `<h1>` HTML element).
-     * Naturally, you can use standard keyboard hotkeys such as <kbd>Ctrl</kbd> + <kbd>B</kbd>
-     * to toggle bold text, <kbd>Ctrl</kbd> + <kbd>I</kbd> to toggle italic text, and so on.
+     * A rich text editor that allows the user to input and format text
+     * The `limel-text-editor` can be used as a form field
      * @exampleComponent limel-example-text-editor-basic
      * @beta 
      * @private 
      */
     interface LimelTextEditor {
+        /**
+          * Set to `true` to disable the field. Use `disabled` to indicate that the field can normally be interacted with, but is currently disabled. This tells the user that if certain requirements are met, the field may become enabled again.
+         */
+        "disabled"?: boolean;
+        /**
+          * Optional helper text to display below the input field when it has focus
+         */
+        "helperText"?: string;
+        /**
+          * Set to `true` to indicate that the current value of the editor is invalid.
+         */
+        "invalid"?: boolean;
+        /**
+          * The label of the editor
+         */
+        "label"?: string;
         /**
           * Dispatched when a change is made to the editor
          */
         "onChange"?: (event: LimelTextEditorCustomEvent<{ html: string }>) => void;
+        /**
+          * The placeholder text shown inside the input field, when the field is empty.
+         */
+        "placeholder"?: string;
+        /**
+          * Set to `true` to make the component read-only. Use `readonly` when the field is only there to present the data it holds, and will not become possible for the current user to edit. :::note Consider that it might be better to use `limel-markdown` instead of `limel-text-editor` when the goal is visualizing data. :::
+         */
+        "readonly"?: boolean;
+        /**
+          * Description of the text inside the editor
+         */
+        "value"?: { html: string };
     }
     /**
      * A tooltip can be used to display a descriptive text for any element.
@@ -6857,6 +6961,7 @@ declare namespace LocalJSX {
         "limel-portal": LimelPortal;
         "limel-progress-flow": LimelProgressFlow;
         "limel-progress-flow-item": LimelProgressFlowItem;
+        "limel-prosemirror-adapter": LimelProsemirrorAdapter;
         "limel-select": LimelSelect;
         "limel-shortcut": LimelShortcut;
         "limel-slider": LimelSlider;
@@ -7667,6 +7772,18 @@ declare module "@stencil/core" {
              * @private 
              */
             "limel-progress-flow-item": LocalJSX.LimelProgressFlowItem & JSXBase.HTMLAttributes<HTMLLimelProgressFlowItemElement>;
+            /**
+             * The ProseMirror adapter offers a rich text editing experience with markdown support,
+             * in the sense that you can easily type markdown syntax and see the rendered
+             * result as rich text in real-time. For instance, you can type `# Hello, world!`
+             * and see it directly turning to a heading 1 (an `<h1>` HTML element).
+             * Naturally, you can use standard keyboard hotkeys such as <kbd>Ctrl</kbd> + <kbd>B</kbd>
+             * to toggle bold text, <kbd>Ctrl</kbd> + <kbd>I</kbd> to toggle italic text, and so on.
+             * @exampleComponent limel-example-prosemirror-adapter-basic
+             * @beta 
+             * @private 
+             */
+            "limel-prosemirror-adapter": LocalJSX.LimelProsemirrorAdapter & JSXBase.HTMLAttributes<HTMLLimelProsemirrorAdapterElement>;
             /**
              * @exampleComponent limel-example-select
              * @exampleComponent limel-example-select-with-icons
@@ -7813,12 +7930,8 @@ declare module "@stencil/core" {
              */
             "limel-table": LocalJSX.LimelTable & JSXBase.HTMLAttributes<HTMLLimelTableElement>;
             /**
-             * This editor offers a rich text editing experience with markdown support,
-             * in the sense that you can easily type markdown syntax and see the rendered
-             * result as rich text in real-time. For instance, you can type `# Hello, world!`
-             * and see it directly turning to a heading 1 (an `<h1>` HTML element).
-             * Naturally, you can use standard keyboard hotkeys such as <kbd>Ctrl</kbd> + <kbd>B</kbd>
-             * to toggle bold text, <kbd>Ctrl</kbd> + <kbd>I</kbd> to toggle italic text, and so on.
+             * A rich text editor that allows the user to input and format text
+             * The `limel-text-editor` can be used as a form field
              * @exampleComponent limel-example-text-editor-basic
              * @beta 
              * @private 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@limetech/lime-elements",
-  "version": "37.19.1",
+  "version": "37.21.0",
   "description": "Lime Elements",
   "author": "Lime Technologies",
   "license": "Apache-2.0",