@db-ux/v-core-components 5.5.0 → 5.6.1

package/dist/components/pagination/model.d.ts

@@ -0,0 +1,117 @@
+import type { GlobalProps, GlobalState, SizeProps } from '../../shared/model.js';
+/**
+ * A single item the option/`items` API generates. `page` is the one-based page
+ * number, `layout` decides whether the collapsing hides it, and `ellipsis` holds the
+ * gap tokens it borders. This describes what the pagination writes onto the DOM; it is
+ * not a prop the consumer sets.
+ */
+export type PaginationItemType = {
+    page: number;
+    layout: 'always' | 'wide';
+    /**
+     * Space separated gap tokens (`wide-before`, `wide-after`,
+     * `collapsed-before`, `collapsed-after`). Every layout marks its own gaps,
+     * because a marker inherits the visibility of the page that carries it - one
+     * hidden below the breakpoint would take its ellipsis with it. One token per
+     * side, so a page standing between two gaps carries two of them instead of a
+     * value meaning both.
+     */
+    ellipsis?: string;
+    disabled?: boolean;
+    label?: string;
+    /**
+     * Identity of the item across page changes. Keying by list position instead
+     * would move the focus to an adjacent page whenever the window shifts, because
+     * the framework reuses the element for whatever page now sits at that position.
+     */
+    key: string;
+};
+/**
+ * An entry of the `items` prop. A consumer who drives the pagination through data
+ * rather than composed children passes these; `disabled` greys a single page out,
+ * which the design otherwise cannot express.
+ */
+export type PaginationItemOption = {
+    disabled?: boolean | string;
+    label?: string;
+};
+export type DBPaginationDefaultProps = {
+    /**
+     * One-based number of the currently active page. Defaults to `1`.
+     */
+    currentPage?: number | string;
+    /**
+     * Total number of records across all pages. With `pageSize` it decides the page
+     * count. Defaults to `0`.
+     */
+    totalCount?: number | string;
+    /**
+     * Number of records on one page. Defaults to `10`.
+     */
+    pageSize?: number | string;
+    /**
+     * Number of page buttons shown on each side of the current page.
+     */
+    siblingCount?: number | string;
+    /**
+     * Number of page buttons always shown at the start and end. Below the collapsing
+     * breakpoint at most one page is pinned per end, whatever this says - the
+     * collapsed layout exists to be narrow.
+     */
+    boundaryCount?: number | string;
+    /**
+     * Per-page options for the data-driven API, one entry per page. Lets a single
+     * page be disabled. When omitted the pagination derives the pages from
+     * `totalCount` and `pageSize`.
+     */
+    items?: PaginationItemOption[];
+    /**
+     * Accessible label for the pagination navigation landmark.
+     */
+    label?: string;
+    /**
+     * Accessible label for the previous-page button.
+     */
+    previousLabel?: string;
+    /**
+     * Accessible label for the next-page button.
+     */
+    nextLabel?: string;
+    /**
+     * Accessible page-button label. `{page}` and `{totalPages}` are replaced. The
+     * visible text of a page is only its number, so the context lives in this label.
+     */
+    pageLabel?: string;
+    /**
+     * Informs the parent that a different page was requested. The parent must
+     * update `currentPage`; the component never changes it internally.
+     */
+    onPageChange?: (page: number) => void;
+};
+export type DBPaginationProps = DBPaginationDefaultProps & GlobalProps & SizeProps;
+export type DBPaginationDefaultState = {
+    getInteger: (value: number | string | undefined, fallback: number, minimum: number) => number;
+    getRange: (start: number, end: number) => number[];
+    isDataDriven: () => boolean;
+    getTotalPages: () => number;
+    getCurrentPage: () => number;
+    isPageDisabled: (page: number) => boolean;
+    getStepPage: (direction: number) => number;
+    getPages: (siblingCount: number) => number[];
+    getCollapsedPages: () => number[];
+    getPaginationItems: () => PaginationItemType[];
+    getEllipsisTokens: (layout: string, pages: number[], page: number, totalPages: number) => string[];
+    getPageText: (page: number) => string;
+    getPageLabel: (page: number) => string;
+    applyItem: (item: any, page: number, description: any) => void;
+    syncItems: () => void;
+    _setupObserver: () => void;
+    _observer: any;
+    _pendingRafId: number | null;
+    isModifiedLinkClick: (event: any) => boolean;
+    preventCurrentPageNavigation: (event: any) => void;
+    handleClick: (event: any) => void;
+    stepToPage: (page: number) => void;
+    handlePageChange: (page: number) => void;
+};
+export type DBPaginationState = DBPaginationDefaultState & GlobalState;

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

@@ -0,0 +1,31 @@
+import type { DBPaginationProps } from "./model.js";
+declare var __VLS_6: {};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_6) => any;
+};
+declare const __VLS_base: import("@vue/runtime-core").DefineComponent<DBPaginationProps, {}, {}, {}, {}, import("@vue/runtime-core").ComponentOptionsMixin, import("@vue/runtime-core").ComponentOptionsMixin, {}, string, import("@vue/runtime-core").PublicProps, Readonly<DBPaginationProps> & Readonly<{}>, {
+    id: string;
+    children: any;
+    className: string;
+    propOverrides: import("../../index.js", { with: { "resolution-mode": "import" } }).PropOverridesType;
+    label: string;
+    items: import("./model.js", { with: { "resolution-mode": "import" } }).PaginationItemOption[];
+    size: import("../../index.js", { with: { "resolution-mode": "import" } }).SizeType;
+    currentPage: number | string;
+    totalCount: number | string;
+    pageSize: number | string;
+    siblingCount: number | string;
+    boundaryCount: number | string;
+    previousLabel: string;
+    nextLabel: string;
+    pageLabel: string;
+    onPageChange: (page: number) => void;
+}, {}, {}, {}, string, import("@vue/runtime-core").ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/pagination-item/index.d.ts

@@ -0,0 +1 @@
+export { default as DBPaginationItem } from './pagination-item.vue';

package/dist/components/pagination-item/model.d.ts

@@ -0,0 +1,5 @@
+import type { GlobalProps, GlobalState, TextProps } from '../../shared/model.js';
+export type DBPaginationItemDefaultProps = {};
+export type DBPaginationItemProps = DBPaginationItemDefaultProps & GlobalProps & TextProps;
+export type DBPaginationItemDefaultState = {};
+export type DBPaginationItemState = DBPaginationItemDefaultState & GlobalState;

package/dist/components/pagination-item/pagination-item.vue.d.ts

@@ -0,0 +1,14 @@
+import type { DBPaginationItemProps } from "./model.js";
+declare var __VLS_1: {};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_1) => any;
+};
+declare const __VLS_base: import("@vue/runtime-core").DefineComponent<DBPaginationItemProps, {}, {}, {}, {}, import("@vue/runtime-core").ComponentOptionsMixin, import("@vue/runtime-core").ComponentOptionsMixin, {}, string, import("@vue/runtime-core").PublicProps, Readonly<DBPaginationItemProps> & Readonly<{}>, {}, {}, {}, {}, string, import("@vue/runtime-core").ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -15,8 +15,8 @@ declare const __VLS_base: import("@vue/runtime-core").DefineComponent<DBPopoverP
     width: import("../../index.js", { with: { "resolution-mode": "import" } }).PopoverWidthType;
     spacing: import("../../index.js", { with: { "resolution-mode": "import" } }).SpacingType | string;
     forceAbsolute: boolean | string;
-    delay: import("../../index.js", { with: { "resolution-mode": "import" } }).PopoverDelayType;
     animation: boolean | string;
+    delay: import("../../index.js", { with: { "resolution-mode": "import" } }).PopoverDelayType;
     gap: boolean | string;
 }, {}, {}, {}, string, import("@vue/runtime-core").ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;

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

@@ -16,8 +16,8 @@ declare const __VLS_base: import("@vue/runtime-core").DefineComponent<DBTooltipP
     width: import("../../shared/model.js", { with: { "resolution-mode": "import" } }).PopoverWidthType;
     forceAbsolute: boolean | string;
     showArrow: boolean | string;
-    delay: import("../../shared/model.js", { with: { "resolution-mode": "import" } }).PopoverDelayType;
     animation: boolean | string;
+    delay: import("../../shared/model.js", { with: { "resolution-mode": "import" } }).PopoverDelayType;
 }, {}, {}, {}, string, import("@vue/runtime-core").ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
 declare const _default: typeof __VLS_export;