@tailor-cms/ce-html-edit 0.2.1 → 2.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Studion
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1 +1,54 @@
-# Content element `Edit` component
+# @tailor-cms/ce-html-edit
+
+Authoring component for the **HTML** content element in [Tailor CMS](https://github.com/tailor-cms/author).
+
+Renders the element inside the Tailor authoring interface, where content is created and edited.
+
+## Installation
+
+```sh
+npm install @tailor-cms/ce-html-edit
+```
+
+## Usage
+
+Content elements are normally registered with Tailor through the element
+registry rather than imported directly, but the package can be consumed on its
+own:
+
+```ts
+import { Edit } from '@tailor-cms/ce-html-edit';
+```
+
+## Element
+
+| Property | Value |
+| --- | --- |
+| Name | HTML |
+| Type | `TIPTAP_HTML` |
+| Icon | [`mdi-text-box-outline`](https://pictogrammers.com/library/mdi/) |
+| Composite | No |
+
+## Packages
+
+This element ships as four packages, published together from the
+[`ce-html`](https://github.com/tailor-cms/ce_html_default) repository:
+
+| Package | Role |
+| --- | --- |
+| [`@tailor-cms/ce-html-manifest`](https://www.npmjs.com/package/@tailor-cms/ce-html-manifest) | Shared element definition |
+| [`@tailor-cms/ce-html-edit`](https://www.npmjs.com/package/@tailor-cms/ce-html-edit) | Authoring component |
+| [`@tailor-cms/ce-html-display`](https://www.npmjs.com/package/@tailor-cms/ce-html-display) | End-user component |
+| [`@tailor-cms/ce-html-server`](https://www.npmjs.com/package/@tailor-cms/ce-html-server) | Server-side module |
+
+## Development
+
+```sh
+pnpm install
+pnpm dev     # start the Content Element Kit runtime
+pnpm build   # build all packages
+pnpm test    # Playwright end-to-end suite
+```
+
+Changes are released with [changesets](https://github.com/changesets/changesets);
+run `pnpm changeset` to record one.

package/dist/components/Edit.vue.d.ts

@@ -1,4 +1,4 @@
-import { Element } from '@tailor-cms/ce-html-manifest';
+import type { Element, ElementData } from '@tailor-cms/ce-html-manifest';
 type __VLS_Props = {
     element: Element;
     isDragged: boolean;
@@ -6,9 +6,9 @@ type __VLS_Props = {
     isReadonly: boolean;
 };
 declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    save: (...args: any[]) => void;
+    save: (data: ElementData) => any;
 }, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
-    onSave?: ((...args: any[]) => any) | undefined;
+    onSave?: ((data: ElementData) => any) | undefined;
 }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare const _default: typeof __VLS_export;
 export default _default;

package/dist/components/IconButton.vue.d.ts

@@ -1,8 +1,8 @@
 type __VLS_Props = {
     active?: boolean;
     disabled?: boolean;
-    density?: string;
-    size?: string;
+    density?: 'default' | 'comfortable' | 'compact';
+    size?: string | number;
     label: string;
     icon: string;
 };

package/dist/components/TopToolbar.vue.d.ts

@@ -1,10 +1,11 @@
+import type { Element, ElementData } from '@tailor-cms/ce-html-manifest';
 type __VLS_Props = {
     element: Element;
 };
 declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    save: (...args: any[]) => void;
+    save: (data: ElementData) => any;
 }, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
-    onSave?: ((...args: any[]) => any) | undefined;
+    onSave?: ((data: ElementData) => any) | undefined;
 }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare const _default: typeof __VLS_export;
 export default _default;