vueye-table 2.0.0-alpha.3 → 2.0.0-alpha.4

package/LICENSE

@@ -1,20 +1,21 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2017 Antério Vieira
+Copyright (c) 2023 radix-vue
 
-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:
+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.
+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,30 +1,56 @@
-# Vueye-table
-
-:warning: **This project is still in development.**
-
-## Tools and conventions
-
--   [x] Eslint
--   [x] Prettier
--   [x] Conventional Commit
--   [x] Pre-commit
--   [x] Lint-staged
--   [x] Semantic-release
--   [x] TypeScript
-
-## TODO
-
-1. Data Rendering ✅
-2. Sorting
-3. Filtering
-4. Pagination ✅
-5. Selection
-6. Editing
-7. Resizing and Reordering
-8. Row Expansion
-9. Grouping by columns ✅
-10. Exporting
-11. Responsive Design
-12. Customization
-13. Accessibility
-14. ...
+# VueyeTableProps TypeScript Definition
+
+This Markdown file provides documentation for the TypeScript `VueyeTableProps` type and its associated default values.
+
+## VueyeTableProps Type
+
+`VueyeTableProps` is a TypeScript type that represents the properties for a Vueye table component.
+
+### Properties
+
+-   `itemValue?: string` (Optional)
+
+    -   The key used to identify items in the data array.
+    -   Default: `'id'`
+
+-   `columnHeaders: TColumn[]`
+
+    -   An array of column headers.
+
+-   `data: TData[]`
+
+    -   An array of data.
+
+-   `perPage?: number` (Optional)
+
+    -   The number of items to display per page.
+    -   Default: `10`
+
+-   `currentPage?: number` (Optional)
+
+    -   The current page number.
+    -   Default: `1`
+
+-   `perPageOptions?: number[]` (Optional)
+
+    -   An array of options for the number of items to display per page.
+    -   Default: `[5, 10, 20, 30]`
+
+-   `loading?: boolean` (Optional)
+
+    -   Indicates whether the table is in a loading state.
+    -   Default: `false`
+
+-   `selectable?: boolean` (Optional)
+
+    -   Indicates whether items in the table are selectable.
+    -   Default: `false`
+
+-   `caption?: string` (Optional)
+
+    -   A caption for the table.
+    -   Default: `''`
+
+-   `summary?: string` (Optional)
+    -   A summary for the table.
+    -   Default: `''`

package/dist/components/core/VueyeTable/VueyeTable.vue.d.ts

@@ -1,15 +1,15 @@
-import { ColumnHeader } from './types';
+import type { ColumnHeader } from './types';
 declare const _default: <TData extends Record<string, unknown>, TColumn extends ColumnHeader>(__VLS_props: {
-    loading?: boolean | undefined;
     caption?: string | undefined;
     data: TData[];
     summary?: string | undefined;
+    itemValue?: string | undefined;
+    columnHeaders: TColumn[];
     perPage?: number | undefined;
     currentPage?: number | undefined;
     perPageOptions?: number[] | undefined;
+    loading?: boolean | undefined;
     selectable?: boolean | undefined;
-    itemValue?: string | undefined;
-    columnHeaders: TColumn[];
 } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, __VLS_ctx?: {
     attrs: any;
     slots: Readonly<import("./types").SlotHeaderCell<TData> & import("./types").SlotHeaderCellContent<TData> & {
@@ -19,16 +19,16 @@ declare const _default: <TData extends Record<string, unknown>, TColumn extends
     emit: any;
 } | undefined, __VLS_expose?: ((exposed: {}) => void) | undefined, __VLS_setup?: Promise<{
     props: {
-        loading?: boolean | undefined;
         caption?: string | undefined;
         data: TData[];
         summary?: string | undefined;
+        itemValue?: string | undefined;
+        columnHeaders: TColumn[];
         perPage?: number | undefined;
         currentPage?: number | undefined;
         perPageOptions?: number[] | undefined;
+        loading?: boolean | undefined;
         selectable?: boolean | undefined;
-        itemValue?: string | undefined;
-        columnHeaders: TColumn[];
     } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps;
     expose(exposed: {}): void;
     attrs: any;
@@ -42,16 +42,16 @@ declare const _default: <TData extends Record<string, unknown>, TColumn extends
 }> & {
     __ctx?: {
         props: {
-            loading?: boolean | undefined;
             caption?: string | undefined;
             data: TData[];
             summary?: string | undefined;
+            itemValue?: string | undefined;
+            columnHeaders: TColumn[];
             perPage?: number | undefined;
             currentPage?: number | undefined;
             perPageOptions?: number[] | undefined;
+            loading?: boolean | undefined;
             selectable?: boolean | undefined;
-            itemValue?: string | undefined;
-            columnHeaders: TColumn[];
         } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps;
         expose(exposed: {}): void;
         attrs: any;

package/dist/components/core/VueyeTable/api.d.ts

@@ -0,0 +1,14 @@
+import { InferDefaults } from './types';
+export type VueyeTableProps<TColumn = any, TData = any> = {
+    itemValue?: string;
+    columnHeaders: TColumn[];
+    data: TData[];
+    perPage?: number;
+    currentPage?: number;
+    perPageOptions?: number[];
+    loading?: boolean;
+    selectable?: boolean;
+    caption?: string;
+    summary?: string;
+};
+export declare const VueyeTablePropsDefaults: InferDefaults<VueyeTableProps>;

package/dist/components/core/VueyeTable/{VueyeBody → components/VueyeBody}/VueyeBody.vue.d.ts

@@ -1,5 +1,9 @@
-import { Row } from '../types';
 declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+    itemValue: {
+        type: globalThis.PropType<string>;
+        required: true;
+        default: string;
+    };
     loading: {
         type: globalThis.PropType<boolean>;
         required: true;
@@ -10,12 +14,12 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         required: true;
         default: () => never[];
     };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<globalThis.ExtractPropTypes<{
     itemValue: {
         type: globalThis.PropType<string>;
         required: true;
         default: string;
     };
-}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<globalThis.ExtractPropTypes<{
     loading: {
         type: globalThis.PropType<boolean>;
         required: true;
@@ -26,18 +30,13 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         required: true;
         default: () => never[];
     };
-    itemValue: {
-        type: globalThis.PropType<string>;
-        required: true;
-        default: string;
-    };
 }>>, {
+    itemValue: string;
     loading: boolean;
     bodyRows: Row[];
-    itemValue: string;
 }, {}>, {
     default?(_: {
-        cell: any;
+        cell: Row;
         key: string;
     }): any;
 }>;

package/dist/components/core/VueyeTable/components/VueyeBody/index.d.ts

@@ -0,0 +1,2 @@
+import VueyeBody from './VueyeBody.vue';
+export { VueyeBody };

package/dist/components/core/VueyeTable/components/VueyeDropdown/api.d.ts

@@ -0,0 +1,17 @@
+export type OptionValue = string | number | boolean | object | symbol;
+interface Option {
+    content: OptionValue;
+    label: string;
+}
+export type dropdownProps = {
+    options: Option[];
+    modelValue: string | number;
+    label: string;
+    defaultValue?: Option;
+};
+export declare const dropdownPropsDefaults: {
+    options: () => never[];
+    modelValue: string;
+    label: string;
+};
+export {};

package/dist/components/core/VueyeTable/components/VueyeDropdown/index.d.ts

@@ -0,0 +1,4 @@
+import type { OptionValue } from './api';
+import VueyeDropdown from './VueyeDropdown.vue';
+export { VueyeDropdown };
+export type { OptionValue };

package/dist/components/core/VueyeTable/{VueyeHead → components/VueyeHead}/VueyeHead.vue.d.ts

@@ -1,4 +1,3 @@
-import type { ColumnHeader } from '../types';
 declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     columnHeaders: {
         type: globalThis.PropType<ColumnHeader[][]>;
@@ -13,7 +12,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     };
 }>>, {
     columnHeaders: ColumnHeader[][];
-}, {}>, Readonly<import("../types").SlotHeaderCell<Record<string, string>> & import("../types").SlotHeaderCellContent<Record<string, string>>>>;
+}, {}>, Readonly<any>>;
 export default _default;
 type __VLS_WithTemplateSlots<T, S> = T & {
     new (): {

package/dist/components/core/VueyeTable/components/VueyePagination/index.d.ts

@@ -0,0 +1,2 @@
+import VueyePagination from './VueyePagination.vue';
+export { VueyePagination };

package/dist/components/core/VueyeTable/components/index.d.ts

@@ -0,0 +1,4 @@
+export * from './VueyeDropdown';
+export * from './VueyeBody';
+export * from './VueyeHead';
+export * from './VueyePagination';

package/dist/components/core/VueyeTable/composables/index.d.ts

@@ -1 +1,4 @@
 export * from './useHeaderKeys';
+export * from './usePagination';
+export * from './useBodyRows';
+export * from './useHeaders';

package/dist/components/core/VueyeTable/composables/usePagination.d.ts

@@ -0,0 +1,11 @@
+export declare function usePagination(props?: {
+    perPage?: number;
+    currentPage?: number;
+}): {
+    pagination: globalThis.Ref<{
+        perPage: number;
+        currentPage: number;
+    }>;
+    updateCurrentPage: (page: number) => void;
+    updatePerPage: (perPage: number) => void;
+};

package/dist/components/core/VueyeTable/types/Utils.d.ts

@@ -11,3 +11,9 @@ export type DeepKeyValues<T extends readonly object[]> = {
         children: infer C;
     } ? C extends readonly object[] ? U | DeepKeyValues<C> : never : U : never : never;
 }[number];
+type NativeType = null | number | string | boolean | symbol | Function;
+type InferDefault<P, T> = ((props: P) => T & {}) | (T extends NativeType ? T : never);
+export type InferDefaults<T> = {
+    [K in keyof T]?: InferDefault<T, T[K]>;
+};
+export {};

package/dist/style.css

@@ -1 +1 @@
-.pagination__wrapper[data-v-d06f6d12]{display:flex;align-items:center;-moz-column-gap:.75rem;column-gap:.75rem}.pagination__details[data-v-d06f6d12]{font-size:.875rem;line-height:1.25rem;--tw-text-opacity: 1;color:rgb(107 114 128 / var(--tw-text-opacity))}[data-v-d06f6d12]:is(.dark .pagination__details){--tw-text-opacity: 1;color:rgb(156 163 175 / var(--tw-text-opacity))}.pagination__btn-list[data-v-d06f6d12]{display:flex}.pagination__btn[data-v-d06f6d12]{display:flex;height:2rem;width:2rem;align-items:center;justify-content:center;border-width:1px;--tw-border-opacity: 1;border-color:rgb(186 227 253 / var(--tw-border-opacity));background-color:transparent;padding:.5rem}.pagination__btn[data-v-d06f6d12]:disabled{cursor:not-allowed;opacity:.5}[data-v-d06f6d12]:is(.dark .pagination__btn){--tw-border-opacity: 1;border-color:rgb(6 83 134 / var(--tw-border-opacity))}.pagination__btn--current[data-v-d06f6d12]{--tw-bg-opacity: 1;background-color:rgb(186 227 253 / var(--tw-bg-opacity))}[data-v-d06f6d12]:is(.dark .pagination__btn--current){--tw-bg-opacity: 1;background-color:rgb(6 83 134 / var(--tw-bg-opacity))}table{min-width:800px;border-collapse:collapse;border-radius:.25rem!important;border-width:1px;--tw-border-opacity: 1;border-color:rgb(55 179 249 / var(--tw-border-opacity));font-size:.875rem;line-height:1.25rem;letter-spacing:.025em}th{border-width:1px;--tw-border-opacity: 1;border-color:rgb(55 179 249 / var(--tw-border-opacity));--tw-bg-opacity: 1;background-color:rgb(224 241 254 / var(--tw-bg-opacity));padding:.5rem 1rem}:is(.dark th){--tw-border-opacity: 1;border-color:rgb(6 83 134 / var(--tw-border-opacity));--tw-bg-opacity: 1;background-color:rgb(8 44 73 / var(--tw-bg-opacity))}td{border-width:1px;--tw-border-opacity: 1;border-color:rgb(55 179 249 / var(--tw-border-opacity));padding:.5rem 1rem}:is(.dark td){--tw-border-opacity: 1;border-color:rgb(6 83 134 / var(--tw-border-opacity))}table{text-align:center}tr:nth-child(2n) td{--tw-bg-opacity: 1;background-color:rgb(224 241 254 / var(--tw-bg-opacity))}:is(.dark tr:nth-child(2n) td){--tw-bg-opacity: 1;background-color:rgb(8 44 73 / var(--tw-bg-opacity))}tr:nth-child(odd) td{--tw-bg-opacity: 1;background-color:rgb(240 248 255 / var(--tw-bg-opacity))}:is(.dark tr:nth-child(odd) td){--tw-bg-opacity: 1;background-color:rgb(11 69 111 / var(--tw-bg-opacity))}caption{padding:.5rem}.table__wrapper{display:flex;width:-moz-max-content;width:max-content;flex-direction:column}.table__pagination-wrapper{display:flex;justify-content:flex-end;padding-top:1rem;padding-bottom:1rem}
+.dropdown__wrapper{position:relative}.dropdown__trigger{display:flex;align-items:center}.dropdown__trigger>:not([hidden])~:not([hidden]){--tw-space-x-reverse: 0;margin-right:calc(.5rem * var(--tw-space-x-reverse));margin-left:calc(.5rem * calc(1 - var(--tw-space-x-reverse)))}.dropdown__trigger{border-radius:.375rem;border-width:1px;--tw-border-opacity: 1;border-color:rgb(124 205 253 / var(--tw-border-opacity));--tw-bg-opacity: 1;background-color:rgb(241 245 249 / var(--tw-bg-opacity));padding:.5rem 1rem;font-size:.875rem;line-height:1.25rem;font-weight:500;--tw-text-opacity: 1;color:rgb(51 65 85 / var(--tw-text-opacity));--tw-shadow: 0 1px 2px 0 rgb(0 0 0 / .05);--tw-shadow-colored: 0 1px 2px 0 var(--tw-shadow-color);box-shadow:var(--tw-ring-offset-shadow, 0 0 #0000),var(--tw-ring-shadow, 0 0 #0000),var(--tw-shadow)}.dropdown__trigger:focus{outline:2px solid transparent;outline-offset:2px;--tw-ring-offset-shadow: var(--tw-ring-inset) 0 0 0 var(--tw-ring-offset-width) var(--tw-ring-offset-color);--tw-ring-shadow: var(--tw-ring-inset) 0 0 0 calc(2px + var(--tw-ring-offset-width)) var(--tw-ring-color);box-shadow:var(--tw-ring-offset-shadow),var(--tw-ring-shadow),var(--tw-shadow, 0 0 #0000);--tw-ring-opacity: 1;--tw-ring-color: rgb(59 130 246 / var(--tw-ring-opacity));--tw-ring-offset-width: 2px }:is([dir=rtl] .dropdown__trigger)>:not([hidden])~:not([hidden]){--tw-space-x-reverse: 1 }:is(.dark .dropdown__trigger){--tw-border-opacity: 1;border-color:rgb(11 69 111 / var(--tw-border-opacity));--tw-bg-opacity: 1;background-color:rgb(11 69 111 / var(--tw-bg-opacity));--tw-text-opacity: 1;color:rgb(248 250 252 / var(--tw-text-opacity))}.dropdown__menu{position:absolute;bottom:100%;right:0;z-index:45;margin-top:.5rem;width:14rem;transform-origin:top right;border-radius:.375rem;--tw-bg-opacity: 1;background-color:rgb(241 245 249 / var(--tw-bg-opacity));--tw-shadow: 0 10px 15px -3px rgb(0 0 0 / .1), 0 4px 6px -4px rgb(0 0 0 / .1);--tw-shadow-colored: 0 10px 15px -3px var(--tw-shadow-color), 0 4px 6px -4px var(--tw-shadow-color);box-shadow:var(--tw-ring-offset-shadow, 0 0 #0000),var(--tw-ring-shadow, 0 0 #0000),var(--tw-shadow);--tw-ring-offset-shadow: var(--tw-ring-inset) 0 0 0 var(--tw-ring-offset-width) var(--tw-ring-offset-color);--tw-ring-shadow: var(--tw-ring-inset) 0 0 0 calc(1px + var(--tw-ring-offset-width)) var(--tw-ring-color);box-shadow:var(--tw-ring-offset-shadow),var(--tw-ring-shadow),var(--tw-shadow, 0 0 #0000);--tw-ring-color: rgb(0 0 0 / var(--tw-ring-opacity));--tw-ring-opacity: .05 }.dropdown__menu:focus{outline:2px solid transparent;outline-offset:2px}:is(.dark .dropdown__menu){--tw-bg-opacity: 1;background-color:rgb(8 44 73 / var(--tw-bg-opacity))}.dropdown__menu__item{display:block;width:100%;padding:.5rem 1rem;text-align:left;font-size:.875rem;line-height:1.25rem;--tw-text-opacity: 1;color:rgb(51 65 85 / var(--tw-text-opacity))}.dropdown__menu__item:hover{--tw-bg-opacity: 1;background-color:rgb(226 232 240 / var(--tw-bg-opacity));--tw-text-opacity: 1;color:rgb(15 23 42 / var(--tw-text-opacity))}.dropdown__menu__item:focus{--tw-bg-opacity: 1;background-color:rgb(241 245 249 / var(--tw-bg-opacity));--tw-text-opacity: 1;color:rgb(15 23 42 / var(--tw-text-opacity));outline:2px solid transparent;outline-offset:2px}:is(.dark .dropdown__menu__item){--tw-text-opacity: 1;color:rgb(248 250 252 / var(--tw-text-opacity))}:is(.dark .dropdown__menu__item:hover){--tw-bg-opacity: 1;background-color:rgb(11 69 111 / var(--tw-bg-opacity));--tw-text-opacity: 1;color:rgb(203 213 225 / var(--tw-text-opacity))}.dropdown__menu__item--selected{--tw-bg-opacity: 1;background-color:rgb(226 232 240 / var(--tw-bg-opacity))}:is(.dark .dropdown__menu__item--selected){--tw-bg-opacity: 1;background-color:rgb(11 69 111 / var(--tw-bg-opacity));--tw-text-opacity: 1;color:rgb(203 213 225 / var(--tw-text-opacity))}.dropdown__overlay{position:fixed;right:0;bottom:0;top:0;left:0;z-index:40;cursor:default;background-color:transparent}.pagination__wrapper{display:flex;align-items:center;-moz-column-gap:.75rem;column-gap:.75rem}.pagination__details{font-size:.875rem;line-height:1.25rem;--tw-text-opacity: 1;color:rgb(107 114 128 / var(--tw-text-opacity))}:is(.dark .pagination__details){--tw-text-opacity: 1;color:rgb(156 163 175 / var(--tw-text-opacity))}.pagination__btn-list{display:flex}.pagination__btn{display:flex;height:2rem;width:2rem;align-items:center;justify-content:center;border-width:1px;--tw-border-opacity: 1;border-color:rgb(186 227 253 / var(--tw-border-opacity));background-color:transparent;padding:.5rem}.pagination__btn:disabled{cursor:not-allowed;opacity:.5}:is(.dark .pagination__btn){--tw-border-opacity: 1;border-color:rgb(6 83 134 / var(--tw-border-opacity))}.pagination__btn--current{--tw-bg-opacity: 1;background-color:rgb(186 227 253 / var(--tw-bg-opacity))}:is(.dark .pagination__btn--current){--tw-bg-opacity: 1;background-color:rgb(6 83 134 / var(--tw-bg-opacity))}table{min-width:800px;border-collapse:collapse;border-radius:.25rem!important;border-width:1px;--tw-border-opacity: 1;border-color:rgb(55 179 249 / var(--tw-border-opacity));font-size:.875rem;line-height:1.25rem;letter-spacing:.025em}th{border-width:1px;--tw-border-opacity: 1;border-color:rgb(55 179 249 / var(--tw-border-opacity));--tw-bg-opacity: 1;background-color:rgb(224 241 254 / var(--tw-bg-opacity));padding:.5rem 1rem}:is(.dark th){--tw-border-opacity: 1;border-color:rgb(6 83 134 / var(--tw-border-opacity));--tw-bg-opacity: 1;background-color:rgb(8 44 73 / var(--tw-bg-opacity))}td{border-width:1px;--tw-border-opacity: 1;border-color:rgb(55 179 249 / var(--tw-border-opacity));padding:.5rem 1rem}:is(.dark td){--tw-border-opacity: 1;border-color:rgb(6 83 134 / var(--tw-border-opacity))}table{text-align:center}tr:nth-child(2n) td{--tw-bg-opacity: 1;background-color:rgb(224 241 254 / var(--tw-bg-opacity))}:is(.dark tr:nth-child(2n) td){--tw-bg-opacity: 1;background-color:rgb(8 44 73 / var(--tw-bg-opacity))}tr:nth-child(odd) td{--tw-bg-opacity: 1;background-color:rgb(240 248 255 / var(--tw-bg-opacity))}:is(.dark tr:nth-child(odd) td){--tw-bg-opacity: 1;background-color:rgb(11 69 111 / var(--tw-bg-opacity))}caption{padding:.5rem}.table__wrapper{display:flex;width:-moz-max-content;width:max-content;flex-direction:column}.table__pagination-wrapper{display:flex;justify-content:flex-end;padding-top:1rem;padding-bottom:1rem}