dolphin-components 2.0.0

package/LICENSE

@@ -0,0 +1,229 @@
+Apache License
+
+Version 2.0, January 2004
+
+http://www.apache.org/licenses/ TERMS
+AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+     
+
+
+      "License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+      
+
+     
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+      
+
+      "Legal Entity" shall mean the
+union of the acting entity and all other entities that control, are controlled
+by, or are under common control with that entity. For the purposes of this
+definition, "control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or otherwise, or (ii)
+ownership of fifty percent (50%) or more of the outstanding shares, or (iii)
+beneficial ownership of such entity.
+
+      
+
+      "You" (or "Your") shall mean
+an individual or Legal Entity exercising permissions granted by this License.
+
+  
+
+
+      "Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation source, and
+configuration files.
+
+      
+
+      "Object" form shall mean any form resulting
+from mechanical transformation or translation of a Source form, including but not
+limited to compiled object code, generated documentation, and conversions to
+other media types.
+
+      
+
+      "Work" shall mean the work of authorship,
+whether in Source or Object form, made available under the License, as indicated
+by a copyright notice that is included in or attached to the work (an example is
+provided in the Appendix below).
+
+      
+
+      "Derivative Works" shall mean any
+work, whether in Source or Object form, that is based on (or derived from) the
+Work and for which the editorial revisions, annotations, elaborations, or other
+modifications represent, as a whole, an original work of authorship. For the
+purposes of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of, the Work
+and Derivative Works thereof.
+
+      
+
+      "Contribution" shall mean any work
+of authorship, including the original version of the Work and any modifications
+or additions to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner or by an
+individual or Legal Entity authorized to submit on behalf of the copyright owner.
+For the purposes of this definition, "submitted" means any form of electronic,
+verbal, or written communication sent to the Licensor or its representatives,
+including but not limited to communication on electronic mailing lists, source
+code control systems, and issue tracking systems that are managed by, or on
+behalf of, the Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise designated in
+writing by the copyright owner as "Not a Contribution."
+
+      
+
+     
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of
+whom a Contribution has been received by Licensor and subsequently incorporated
+within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and
+conditions of this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license
+to reproduce, prepare Derivative Works of, publicly display, publicly perform,
+sublicense, and distribute the Work and such Derivative Works in Source or Object
+form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this
+section) patent license to make, have made, use, offer to sell, sell, import, and
+otherwise transfer the Work, where such license applies only to those patent
+claims licensable by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s) with the Work to
+which such Contribution(s) was submitted. If You institute patent litigation
+against any entity (including a cross-claim or counterclaim in a lawsuit)
+alleging that the Work or a Contribution incorporated within the Work constitutes
+direct or contributory patent infringement, then any patent licenses granted to
+You under this License for that Work shall terminate as of the date such
+litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute
+copies of the Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You meet the following
+conditions:
+
+      (a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+      (b) You must cause any
+modified files to carry prominent notices stating that You changed the files;
+and
+
+      (c) You must retain, in the Source form of any Derivative Works that
+You distribute, all copyright, patent, trademark, and attribution notices from
+the Source form of the Work, excluding those notices that do not pertain to any
+part of the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text
+file as part of its distribution, then any Derivative Works that You distribute
+must include a readable copy of the attribution notices contained within such
+NOTICE file, excluding those notices that do not pertain to any part of the
+Derivative Works, in at least one of the following places: within a NOTICE text
+file distributed as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or, within a display
+generated by the Derivative Works, if and wherever such third-party notices
+normally appear. The contents of the NOTICE file are for informational purposes
+only and do not modify the License. You may add Your own attribution notices
+within Derivative Works that You distribute, alongside or as an addendum to the
+NOTICE text from the Work, provided that such additional attribution notices
+cannot be construed as modifying the License.
+
+      You may add Your own
+copyright statement to Your modifications and may provide additional or different
+license terms and conditions for use, reproduction, or distribution of Your
+modifications, or for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with the conditions
+stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly
+state otherwise, any Contribution intentionally submitted for inclusion in the
+Work by You to the Licensor shall be under the terms and conditions of this
+License, without any additional terms or conditions. Notwithstanding the above,
+nothing herein shall supersede or modify the terms of any separate license
+agreement you may have executed with Licensor regarding such Contributions.
+
+  
+6. Trademarks. This License does not grant permission to use the trade names,
+trademarks, service marks, or product names of the Licensor, except as required
+for reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless
+required by applicable law or agreed to in writing, Licensor provides the Work
+(and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including,
+without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT,
+MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible
+for determining the appropriateness of using or redistributing the Work and
+assume any risks associated with Your exercise of permissions under this
+License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise, unless required
+by applicable law (such as deliberate and grossly negligent acts) or agreed to in
+writing, shall any Contributor be liable to You for damages, including any
+direct, indirect, special, incidental, or consequential damages of any character
+arising as a result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill, work stoppage,
+computer failure or malfunction, or any and all other commercial damages or
+losses), even if such Contributor has been advised of the possibility of such
+damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer, and charge a fee
+for, acceptance of support, warranty, indemnity, or other liability obligations
+and/or rights consistent with this License. However, in accepting such
+obligations, You may act only on Your own behalf and on Your sole responsibility,
+not on behalf of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability incurred by, or
+claims asserted against, such Contributor by reason of your accepting any such
+warranty or additional liability. END OF TERMS AND CONDITIONS
+
+APPENDIX: How to
+apply the Apache License to your work.
+
+To apply the Apache License to your work,
+attach the following boilerplate notice, with the fields enclosed by brackets
+"[]" replaced with your own identifying information. (Don't include the
+brackets!) The text should be enclosed in the appropriate comment syntax for the
+file format. We also recommend that a file or class name and description of
+purpose be included on the same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright [yyyy] Sandip
+
+Licensed
+under the Apache License, Version 2.0 (the "License");
+
+you may not use this file
+except in compliance with the License.
+
+You may obtain a copy of the License
+at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law
+or agreed to in writing, software
+
+distributed under the License is distributed
+on an "AS IS" BASIS,
+
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+express or implied.
+
+See the License for the specific language governing
+permissions and
+
+limitations under the License.

package/README.md

@@ -0,0 +1,133 @@
+# Dolphin Component Library
+
+![npm](https://img.shields.io/npm/v/dolphin-components) ![License](https://img.shields.io/npm/l/dolphin-components) ![Vue](https://img.shields.io/badge/vue-3.x-brightgreen)
+
+A Vue component library built with TypeScript, Vite, Vue, TailwindCSS, Multiselect, Sweetalert2, and Tabulator.
+
+## Installation
+
+Install the package via npm:
+
+```sh
+npm install dolphin-components
+```
+
+## Usage
+
+### 1. Import Styles
+
+Make sure to import the CSS styles in your main entry file (e.g., `main.ts` or `main.js`):
+
+```ts
+import 'dolphin-components/dist/dolphin-components.css';
+```
+
+### 2. Register Components
+
+#### Global Registration
+
+You can globally register all components in your Vue app:
+
+```ts
+import { createApp } from 'vue';
+import App from './App.vue';
+import { ContentLayout, Modal, Switch, Tabulator, Toggle, Towser } from 'dolphin-components';
+
+const app = createApp(App);
+
+app.component('ContentLayout', ContentLayout);
+app.component('Modal', Modal);
+app.component('Switch', Switch);
+app.component('Tabulator', Tabulator);
+app.component('Toggle', Toggle);
+app.component('Towser', Towser);
+
+app.mount('#app');
+```
+
+### 3. Available Components
+
+#### ContentLayout
+
+**Props:**
+- `title` (Array of `ContentTitle[]`, required) - Defines the content titles with optional links.
+- `action` (Array of `ContentAction[]`, optional) - Defines actions with a title, emit event, and optional class.
+- `bodyClass` (String, optional) - Additional class for the body.
+- `titleClass` (String, optional) - Additional class for the title.
+
+#### Modal
+
+**Props:**
+- `title` (Array of `ModalTitle[]`, required) - Defines modal titles with optional links.
+- `action` (Array of `ModalAction[]`, required) - Defines actions with an emit event and optional class.
+- `show` (Boolean, required) - Controls modal visibility.
+- `width` (String, optional) - Defines modal width.
+
+#### Switch
+
+**Props:**
+- `modelValue` (Boolean, required) - The v-model value.
+- `background` (String, optional) - Background color.
+- `disable` (Boolean, optional) - Disable Switch.
+
+#### Tabulator
+
+**Props:**
+- `data` (Array of `TabulatorData[]`, required) - Defines table data.
+- `columns` (Array of `TabulatorHeader[]`, required) - Defines table headers.
+- `placeholder` (String, required) - Placeholder text when no data is present.
+- `paginationSize` (Number, required) - Pagination size.
+- `paginationSizeSelector` (Array of numbers, required) - Pagination size options.
+- `action` (Boolean, required) - Enables or disables action buttons.
+- `actionButtons` (Array of `TabulatorAction[]`, required) - Defines action buttons.
+- `heightOffset` (Number, required) - Adjusts table height.
+
+#### Toggle
+
+**Props:**
+- `modelValue` (Boolean, required) - The v-model value.
+- `onText` (String, optional) - Text when toogle on.
+- `offText` (String, optional) - Text when toogle off.
+- `width` (String, optional) - Width of Toggle [Eg: 100px].
+- `disable` (Boolean, optional) - Disable Toggle.
+
+#### Towser
+
+**Props:**
+- `show` (Boolean, required) - Controls visibility.
+- `title` (Array of `TowserTitle[]`, required) - Defines the titles with optional links.
+- `action` (Array of `TowserAction[]`, optional) - Defines actions.
+- `double` (Boolean, optional) - Enables double-pane layout.
+- `bodyWidth` (Number, optional) - Width of the main body.
+- `body2Width` (Number, optional) - Width of the secondary body.
+
+### 4. Register Directives
+``` ts
+import { InputError } from 'dolphin-components';
+app.directive('error', InputError)
+
+```
+
+### 5. Available Directives
+
+#### Input Error
+
+A Vue directive for handling form input error states and displaying error messages.
+
+**Usage:**
+```vue
+<div v-error="error">
+  <input type="text" v-model="fieldValue" />
+</div>
+```
+
+**Properties:**
+- `error` (String, required) - Error message to display
+
+## TypeScript Support
+
+This package includes TypeScript support with full typings for all components.
+
+## License
+
+This project is licensed under the Apache 2.0 License. See the [LICENSE](https://opensource.org/license/apache-2-0) file for more details.

package/dist/Directives/ErrorDirective.d.ts

@@ -0,0 +1,5 @@
+import { DirectiveBinding } from "vue";
+export declare const InputError: {
+    mounted: (el: HTMLElement, binding: DirectiveBinding) => void;
+    updated: (el: HTMLElement, binding: DirectiveBinding) => void;
+};

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

@@ -0,0 +1,29 @@
+import type { ContentAction, ContentProps } from '../types';
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: {
+        'action-before'?(_: {}): any;
+        'action-after'?(_: {}): any;
+        default?(_: {}): any;
+    };
+    refs: {};
+    rootEl: HTMLDivElement;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import("vue").DefineComponent<ContentProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
+    [x: string]: never;
+}, string, import("vue").PublicProps, Readonly<ContentProps> & Readonly<{
+    [x: `on${Capitalize<string>}`]: (...args: unknown[]) => any;
+}>, {
+    title: import("../types").ContentTitle[];
+    action: ContentAction[];
+    bodyClass: string;
+    titleClass: string;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, HTMLDivElement>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -0,0 +1,30 @@
+import type { ModalProps } from '../types';
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: {
+        default?(_: {}): any;
+    };
+    refs: {
+        dynamicDiv: HTMLDivElement;
+    };
+    rootEl: any;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import("vue").DefineComponent<ModalProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
+    [x: string]: never;
+}, string, import("vue").PublicProps, Readonly<ModalProps> & Readonly<{
+    [x: `on${Capitalize<string>}`]: (...args: unknown[]) => any;
+}>, {
+    show: boolean;
+    width: string;
+    title: import("../types").ModalTitle[];
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {
+    dynamicDiv: HTMLDivElement;
+}, any>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -0,0 +1,11 @@
+import type { SwitchProps } from '../types';
+declare const _default: import("vue").DefineComponent<SwitchProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
+    "update:modelValue": (value: boolean) => any;
+}, string, import("vue").PublicProps, Readonly<SwitchProps> & Readonly<{
+    "onUpdate:modelValue"?: (value: boolean) => any;
+}>, {
+    background: string;
+    modelValue: boolean;
+    disable: boolean;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, HTMLButtonElement>;
+export default _default;

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

@@ -0,0 +1,18 @@
+import { type TabulatorHeader, type TabulatorProps } from '../types';
+declare const _default: import("vue").DefineComponent<TabulatorProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
+    [x: string]: never;
+}, string, import("vue").PublicProps, Readonly<TabulatorProps> & Readonly<{
+    [x: `on${Capitalize<string>}`]: (...args: unknown[]) => any;
+}>, {
+    data: import("../types").TabulatorData[];
+    columns: TabulatorHeader[];
+    action: boolean;
+    placeholder: string;
+    paginationSize: number;
+    paginationSizeSelector: number[];
+    actionButtons: import("../types").TabulatorAction[];
+    heightOffset: number;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {
+    table: HTMLDivElement;
+}, HTMLDivElement>;
+export default _default;

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

@@ -0,0 +1,13 @@
+import type { ToggleProps } from '../types';
+declare const _default: import("vue").DefineComponent<ToggleProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
+    "update:modelValue": (value: boolean) => any;
+}, string, import("vue").PublicProps, Readonly<ToggleProps> & Readonly<{
+    "onUpdate:modelValue"?: (value: boolean) => any;
+}>, {
+    width: string;
+    modelValue: boolean;
+    disable: boolean;
+    onText: string;
+    offText: string;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, HTMLButtonElement>;
+export default _default;

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

@@ -0,0 +1,30 @@
+import type { TowserProps } from '../types';
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: {
+        default?(_: {}): any;
+        body2?(_: {}): any;
+    };
+    refs: {};
+    rootEl: any;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import("vue").DefineComponent<TowserProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
+    [x: string]: never;
+}, string, import("vue").PublicProps, Readonly<TowserProps> & Readonly<{
+    [x: `on${Capitalize<string>}`]: (...args: unknown[]) => any;
+}>, {
+    show: boolean;
+    title: import("../types").TowserTitle[];
+    action: import("../types").TowserAction[];
+    double: boolean;
+    bodyWidth: number;
+    body2Width: number;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};