@solidev/data 0.10.0 → 1.0.0-beta.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solidev/data",
-  "version": "0.10.0",
+  "version": "1.0.0-beta.2",
   "peerDependencies": {
     "@angular/common": "^22",
     "@angular/core": "^22",

package/types/solidev-data-richedit.d.ts

@@ -4,34 +4,89 @@ import { Toolbar, Editor } from 'ngx-editor';
 import { FormControl } from '@angular/forms';
 import { DataModel, BaseFieldManager } from '@solidev/data';
 
+/**
+ * Named toolbar presets for {@link RicheditComponent}, selectable through its
+ * `toolbar` input.
+ *
+ * - `default`: the full set — marks, code and quote, lists, headings, links,
+ *   colours and alignment.
+ * - `light`: a reduced set — basic marks, lists, text colour and alignment.
+ * - `none`: empty; the component hides the menu bar entirely for this value.
+ *
+ * A `Toolbar` can also be passed directly to the component when neither preset
+ * fits.
+ */
 declare const RichEditToolbars: {
     [index: string]: Toolbar;
 };
 declare class RicheditComponent<FT, T extends DataModel> implements OnInit, OnDestroy {
+    /** Model instance holding the field. */
     model?: T;
+    /** Name of the rich text field to edit. */
     field?: string;
+    /** Whether {@link toggleEdit} is allowed to enable editing. */
     editable: boolean;
+    /** Whether the editor is currently enabled. Defaults to true. */
     edit: boolean;
+    /**
+     * Layout, and whether {@link save} persists.
+     *
+     * `dd` renders a `<dt>`/`<dd>` block and is the only mode that saves to the
+     * API; `inline` and `form` render a label plus the editor and leave saving to
+     * the caller.
+     */
     mode: "dd" | "inline" | "form";
     /** Hide label (for inline forms) */
     hideLabel: boolean;
-    /** Hide button (for changed usage) */
+    /**
+     * Hide the built-in save button, for callers driving persistence themselves
+     * from the {@link changed} output.
+     */
     hideButton: boolean;
-    /** Form control, from outside or created */
+    /**
+     * Form control backing the editor.
+     *
+     * When supplied, the component uses it as-is and skips its own setup — no
+     * field manager lookup, no seeding from the model, and no {@link changed}
+     * emissions. When absent, one is created and wired up from `[model]` and
+     * `[field]`.
+     */
     fc: FormControl<string | null>;
-    /** Toolbar mode */
+    /** Toolbar preset name from {@link RichEditToolbars}, or an explicit toolbar. */
     toolbar: "none" | "default" | "light" | Toolbar;
+    /** Emits the editor's HTML on every change. Only wired for an internal `fc`. */
     changed: EventEmitter<string | null>;
-    /** Field manager */
+    /** Field manager for {@link field}; only resolved when `fc` is created here. */
     manager?: BaseFieldManager<FT>;
-    /** Computed required */
+    /** Whether the manager declares the field required. */
     required: boolean;
+    /** Underlying ngx-editor instance; destroyed with the component. */
     editor: Editor;
+    /** Unused; kept for backwards compatibility. */
     html: string;
+    /** Toolbar actually rendered, resolved from {@link toolbar}. */
     realToolbar: Toolbar;
+    /**
+     * Create the editor, resolve the toolbar, and — unless a `[fc]` was given —
+     * build a control seeded from the model field, enabled per `[edit]`, and
+     * relaying changes to {@link changed}.
+     */
     ngOnInit(): void;
+    /** Destroy the ngx-editor instance to release its resources. */
     ngOnDestroy(): void;
+    /**
+     * Switch between read-only and editing by enabling or disabling the control.
+     * Forces read-only when `[editable]` is false.
+     */
     toggleEdit(): void;
+    /**
+     * Write the editor content back to the model field, and persist it in `dd`
+     * mode only.
+     *
+     * In `inline` / `form` modes the model is updated in memory but no request is
+     * sent, leaving the save to the surrounding form. Does nothing without both a
+     * `[model]` and a `[field]`.
+     */
     save(): Promise<void>;
     static ɵfac: i0.ɵɵFactoryDeclaration<RicheditComponent<any, any>, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<RicheditComponent<any, any>, "data-richedit", never, { "model": { "alias": "model"; "required": false; }; "field": { "alias": "field"; "required": false; }; "editable": { "alias": "editable"; "required": false; }; "edit": { "alias": "edit"; "required": false; }; "mode": { "alias": "mode"; "required": false; }; "hideLabel": { "alias": "hideLabel"; "required": false; }; "hideButton": { "alias": "hideButton"; "required": false; }; "fc": { "alias": "fc"; "required": false; }; "toolbar": { "alias": "toolbar"; "required": false; }; }, { "changed": "changed"; }, never, ["*"], true, never>;