@aotearoan/neon 28.5.0 → 28.6.0

package/dist/src/components/layout/card-list/NeonCardList.d.ts

@@ -7,10 +7,12 @@ import type { NeonLoadOnDemandModel } from '@/model/layout/card-list/NeonLoadOnD
 import type { NeonPaginationModel } from '@/model/navigation/pagination/NeonPaginationModel';
 import type { NeonIdentifiable } from '@/model/common/entity/NeonIdentifiable';
 import type { NeonSelectable } from '@/model/common/entity/NeonSelectable';
+import { NeonState } from '@/model/common/state/NeonState';
+import { NeonCardListStyle } from '@/model/layout/card-list/NeonCardListStyle';
 /**
  * TODO: consider refactoring since it's no longer just a layout component when selectable.
  * Represent lists of objects as cards. This is intended to be a more responsive replacement for tables. This component
- * will display a list of items as cards with a count (x of y) and a <em>Show more</em> button to load more results.
+ * will display a list of items as cards with a count (Showing x of y) and a <em>Load more</em> button to load more results.
  * There is also a slot for adding filtering or other content above the list. A slot is provided with card model & index
  * parameters for customising how to display the model for each card.
  */
@@ -29,6 +31,13 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         type: () => NeonFunctionalColor;
         default: null;
     };
+    /**
+     * Specify the card list layout, either a 'List' of cards with 100% width or a responsive 'Grid' of cards.
+     */
+    listStyle: {
+        type: () => NeonCardListStyle;
+        default: () => NeonCardListStyle;
+    };
     /**
      * Make cards selectable.
      */
@@ -49,7 +58,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         type: () => NeonPaginationModel;
     };
     /**
-     * Show splash loader when loading new items.
+     * Show loading state when loading new items.
      */
     loading: {
         type: BooleanConstructor;
@@ -60,15 +69,15 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     NeonButtonStyle: typeof NeonButtonStyle;
     NeonFunctionalColor: typeof NeonFunctionalColor;
     NeonSize: typeof NeonSize;
-    ofLabel: import("vue").ComputedRef<string | undefined>;
     showMoreLabel: import("vue").ComputedRef<string | undefined>;
-    endOfResultsLabel: import("vue").ComputedRef<string | undefined>;
+    resultCountLabel: import("vue").ComputedRef<string | undefined>;
     total: import("vue").ComputedRef<number>;
     slots: Readonly<{
         [name: string]: import("vue").Slot<any> | undefined;
     }>;
     cards: import("vue").Ref<HTMLDivElement | undefined, HTMLDivElement | undefined>;
     onPageChange: (newPage: number) => void;
+    NeonState: typeof NeonState;
 }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("page-change" | "show-more" | "toggle-selected")[], "page-change" | "show-more" | "toggle-selected", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     /**
      * Items to display as cards. Each item should be a NeonCardListModel.
@@ -84,6 +93,13 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         type: () => NeonFunctionalColor;
         default: null;
     };
+    /**
+     * Specify the card list layout, either a 'List' of cards with 100% width or a responsive 'Grid' of cards.
+     */
+    listStyle: {
+        type: () => NeonCardListStyle;
+        default: () => NeonCardListStyle;
+    };
     /**
      * Make cards selectable.
      */
@@ -104,7 +120,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         type: () => NeonPaginationModel;
     };
     /**
-     * Show splash loader when loading new items.
+     * Show loading state when loading new items.
      */
     loading: {
         type: BooleanConstructor;
@@ -116,6 +132,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
 }>, {
     color: NeonFunctionalColor;
     loading: boolean;
+    listStyle: NeonCardListStyle;
     selectable: boolean;
 }, {}, {
     NeonSelectableCard: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
@@ -437,9 +454,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                 default: boolean;
             };
             alternateColor: {
-                type: () => NeonFunctionalColor; /**
-                 * Items to display as cards. Each item should be a NeonCardListModel.
-                 */
+                type: () => NeonFunctionalColor;
                 default: null;
             };
             icon: {
@@ -455,19 +470,15 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             };
             buttonStyle: {
                 type: () => NeonButtonStyle;
-                default: NeonButtonStyle; /**
-                 * Model for configuring the on-demand loading layout.
-                 */
-            }; /**
-             * Model for configuring the on-demand loading layout.
-             */
+                default: NeonButtonStyle;
+            };
             buttonType: {
                 type: () => import("../../../neon").NeonButtonType;
                 default: import("../../../neon").NeonButtonType;
             };
             state: {
-                type: () => import("../../../neon").NeonState;
-                default: import("../../../neon").NeonState;
+                type: () => NeonState;
+                default: NeonState;
             };
             disabled: {
                 type: BooleanConstructor;
@@ -542,9 +553,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                 default: boolean;
             };
             alternateColor: {
-                type: () => NeonFunctionalColor; /**
-                 * Items to display as cards. Each item should be a NeonCardListModel.
-                 */
+                type: () => NeonFunctionalColor;
                 default: null;
             };
             icon: {
@@ -560,19 +569,15 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             };
             buttonStyle: {
                 type: () => NeonButtonStyle;
-                default: NeonButtonStyle; /**
-                 * Model for configuring the on-demand loading layout.
-                 */
-            }; /**
-             * Model for configuring the on-demand loading layout.
-             */
+                default: NeonButtonStyle;
+            };
             buttonType: {
                 type: () => import("../../../neon").NeonButtonType;
                 default: import("../../../neon").NeonButtonType;
             };
             state: {
-                type: () => import("../../../neon").NeonState;
-                default: import("../../../neon").NeonState;
+                type: () => NeonState;
+                default: NeonState;
             };
             disabled: {
                 type: BooleanConstructor;
@@ -617,7 +622,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             iconPosition: import("../../../neon").NeonHorizontalPosition;
             buttonStyle: NeonButtonStyle;
             buttonType: import("../../../neon").NeonButtonType;
-            state: import("../../../neon").NeonState;
+            state: NeonState;
             transparent: boolean;
             circular: boolean;
             fullWidth: boolean;
@@ -741,9 +746,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                     [x: string]: unknown;
                 }>;
                 activeRoute: import("vue").ComputedRef<boolean | "" | undefined>;
-                exactRoute: import("vue").ComputedRef<boolean | "" | undefined>; /**
-                 * Model for configuring the on-demand loading layout.
-                 */
+                exactRoute: import("vue").ComputedRef<boolean | "" | undefined>;
                 onClick: () => void;
                 onSpace: () => Promise<void>;
             }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "click"[], "click", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
@@ -902,9 +905,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             default: boolean;
         };
         alternateColor: {
-            type: () => NeonFunctionalColor; /**
-             * Items to display as cards. Each item should be a NeonCardListModel.
-             */
+            type: () => NeonFunctionalColor;
             default: null;
         };
         icon: {
@@ -920,19 +921,15 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         };
         buttonStyle: {
             type: () => NeonButtonStyle;
-            default: NeonButtonStyle; /**
-             * Model for configuring the on-demand loading layout.
-             */
-        }; /**
-         * Model for configuring the on-demand loading layout.
-         */
+            default: NeonButtonStyle;
+        };
         buttonType: {
             type: () => import("../../../neon").NeonButtonType;
             default: import("../../../neon").NeonButtonType;
         };
         state: {
-            type: () => import("../../../neon").NeonState;
-            default: import("../../../neon").NeonState;
+            type: () => NeonState;
+            default: NeonState;
         };
         disabled: {
             type: BooleanConstructor;
@@ -1007,9 +1004,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             default: boolean;
         };
         alternateColor: {
-            type: () => NeonFunctionalColor; /**
-             * Items to display as cards. Each item should be a NeonCardListModel.
-             */
+            type: () => NeonFunctionalColor;
             default: null;
         };
         icon: {
@@ -1025,19 +1020,15 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         };
         buttonStyle: {
             type: () => NeonButtonStyle;
-            default: NeonButtonStyle; /**
-             * Model for configuring the on-demand loading layout.
-             */
-        }; /**
-         * Model for configuring the on-demand loading layout.
-         */
+            default: NeonButtonStyle;
+        };
         buttonType: {
             type: () => import("../../../neon").NeonButtonType;
             default: import("../../../neon").NeonButtonType;
         };
         state: {
-            type: () => import("../../../neon").NeonState;
-            default: import("../../../neon").NeonState;
+            type: () => NeonState;
+            default: NeonState;
         };
         disabled: {
             type: BooleanConstructor;
@@ -1082,7 +1073,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         iconPosition: import("../../../neon").NeonHorizontalPosition;
         buttonStyle: NeonButtonStyle;
         buttonType: import("../../../neon").NeonButtonType;
-        state: import("../../../neon").NeonState;
+        state: NeonState;
         transparent: boolean;
         circular: boolean;
         fullWidth: boolean;
@@ -1206,9 +1197,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                 [x: string]: unknown;
             }>;
             activeRoute: import("vue").ComputedRef<boolean | "" | undefined>;
-            exactRoute: import("vue").ComputedRef<boolean | "" | undefined>; /**
-             * Model for configuring the on-demand loading layout.
-             */
+            exactRoute: import("vue").ComputedRef<boolean | "" | undefined>;
             onClick: () => void;
             onSpace: () => Promise<void>;
         }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "click"[], "click", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
@@ -1334,9 +1323,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             [x: string]: unknown;
         }>;
         activeRoute: import("vue").ComputedRef<boolean | "" | undefined>;
-        exactRoute: import("vue").ComputedRef<boolean | "" | undefined>; /**
-         * Model for configuring the on-demand loading layout.
-         */
+        exactRoute: import("vue").ComputedRef<boolean | "" | undefined>;
         onClick: () => void;
         onSpace: () => Promise<void>;
     }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "click"[], "click", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{