@openreachtech/furo-vue 1.3.1

package/types/generated/components/molecules/FuroPagination/FuroPaginationContext.d.ts

@@ -0,0 +1,271 @@
+/**
+ * Context class for FuroPagination organism.
+ *
+ * @extends {BaseFuroContext<null, Props, EmitEventName>}
+ */
+export default class FuroPaginationContext extends BaseFuroContext<null, Props, "PAGE_CHANGE" | "UPDATE_PAGE"> {
+    /**
+     * Factory method.
+     *
+     * @template {X extends typeof FuroPaginationContext ? X : never} T, X
+     * @override
+     * @param {FuroPaginationContextFactoryParams} params - Parameters of this factory method.
+     * @returns {InstanceType<T>} An instance of this class.
+     * @this {T}
+     */
+    static override create<T extends X extends typeof FuroPaginationContext ? X : never, X>(this: T, { props, componentContext, refHash, }: FuroPaginationContextFactoryParams): InstanceType<T>;
+    /**
+     * Build ref hash.
+     *
+     * @override
+     * @returns {FuroPaginationContextParams['refHash']}
+     */
+    static override buildRefHash(): FuroPaginationContextParams["refHash"];
+    /**
+     * Get emit event name.
+     *
+     * @override
+     * @returns {Readonly<{
+     *   PAGE_CHANGE: 'page:change'
+     *   UPDATE_PAGE: 'update:page'
+     * }>}
+     */
+    static override get EMIT_EVENT_NAME(): Readonly<{
+        PAGE_CHANGE: "page:change";
+        UPDATE_PAGE: "update:page";
+    }>;
+    /**
+     * Get emit options.
+     *
+     * @returns {{
+     *   'page:change': (payload: {
+     *     page: number
+     *     offset: number
+     *     limit: number
+     *   }) => void
+     *   'update:page': (page: number) => void
+     * }}
+     */
+    static get EMIT_EVENT_HASH(): {
+        "page:change": (payload: {
+            page: number;
+            offset: number;
+            limit: number;
+        }) => void;
+        "update:page": (page: number) => void;
+    };
+    /**
+     * Constructor.
+     *
+     * @param {FuroPaginationContextParams} params - Parameters of this constructor.
+     */
+    constructor({ props, componentContext, refHash, }: FuroPaginationContextParams);
+    refHash: {
+        pageRef: import("vue").Ref<number>;
+    };
+    /**
+     * get: Constructor of this class.
+     *
+     * @override
+     * @returns {typeof FuroPaginationContext}
+     */
+    override get Ctor(): typeof FuroPaginationContext;
+    /**
+     * Get internal page ref (uncontrolled mode).
+     *
+     * @returns {import('vue').Ref<number>}
+     */
+    get pageRef(): import("vue").Ref<number>;
+    /**
+     * Whether the current page is controlled via `parcel.page`.
+     *
+     * @returns {boolean}
+     */
+    isPageControlled(): boolean;
+    /**
+     * Whether the current page is controlled via `parcel.offset`
+     * (offset/limit-style state, e.g. GraphQL pagination).
+     *
+     * @returns {boolean}
+     */
+    isOffsetControlled(): boolean;
+    /**
+     * Whether the page is controlled by the parent (via `page` or `offset`).
+     *
+     * @returns {boolean}
+     */
+    isControlled(): boolean;
+    /**
+     * Whether controlled `page` and `offset` are both set but disagree
+     * (i.e. `offset` is not the offset of `page`).
+     *
+     * @returns {boolean}
+     */
+    hasControlledConflict(): boolean;
+    /**
+     * Fail when controlled `page` and `offset` disagree. Production keeps letting
+     * `page` win and ignores the mismatched `offset`.
+     *
+     * @returns {void}
+     * @throws {Error} When controlled `page` and `offset` disagree.
+     */
+    throwOnControlledConflict(): void;
+    /**
+     * Whether the whole pagination control is disabled.
+     *
+     * @returns {boolean}
+     */
+    isDisabled(): boolean;
+    /**
+     * Whether the first and last pages stay pinned with ellipsis gaps.
+     *
+     * @returns {boolean}
+     */
+    shouldShowEdges(): boolean;
+    /**
+     * Resolve the current page for the root host element.
+     * `page` takes precedence over `offset` when both are provided.
+     *
+     * @returns {number}
+     */
+    extractPageValue(): number;
+    /**
+     * Resolve the number of records per page.
+     *
+     * @returns {number}
+     */
+    extractLimit(): number;
+    /**
+     * Resolve the total record count.
+     *
+     * @returns {number}
+     */
+    extractTotalRecords(): number;
+    /**
+     * Resolve how many sibling pages render on each side of the current page.
+     *
+     * @returns {number}
+     */
+    extractSiblingCount(): number;
+    /**
+     * Extract root class names.
+     *
+     * @returns {Record<string, boolean>}
+     */
+    extractRootClassNames(): Record<string, boolean>;
+    /**
+     * Whether a rendered range entry is a page button (vs. an ellipsis gap).
+     *
+     * @param {{
+     *   entry: {
+     *     type: string
+     *     value?: number
+     *   }
+     * }} params
+     * @returns {boolean}
+     */
+    isPageEntry({ entry, }: {
+        entry: {
+            type: string;
+            value?: number;
+        };
+    }): boolean;
+    /**
+     * Extract the page number from a range entry.
+     *
+     * @param {{
+     *   entry: {
+     *     type: string
+     *     value?: number
+     *   }
+     * }} params
+     * @returns {number}
+     */
+    extractEntryPage({ entry, }: {
+        entry: {
+            type: string;
+            value?: number;
+        };
+    }): number;
+    /**
+     * Whether the consumer provides a custom per-page slot (e.g. anchor links).
+     *
+     * @returns {boolean}
+     */
+    hasPageSlot(): boolean;
+    /**
+     * Generate the zero-based record offset for a page.
+     * Convenience for offset/limit-style data sources (e.g. GraphQL pagination).
+     *
+     * @param {{
+     *   page: number
+     * }} params
+     * @returns {number}
+     */
+    generateOffset({ page, }: {
+        page: number;
+    }): number;
+    /**
+     * Generate the 1-based page that contains a given zero-based offset.
+     * Inverse of {@link generateOffset} for offset/limit-style state.
+     *
+     * @param {{
+     *   offset: number
+     * }} params
+     * @returns {number}
+     */
+    generatePageFromOffset({ offset, }: {
+        offset: number;
+    }): number;
+    /**
+     * Handle page updates from the root host element.
+     *
+     * @param {{
+     *   page: number
+     * }} params
+     */
+    onPageChange({ page, }: {
+        page: number;
+    }): void;
+}
+export type FuroPaginationContextParams = import("../../../contexts/BaseFuroContext.js").BaseFuroContextParams & {
+    props: Props;
+    componentContext: ComponentContext;
+    refHash: {
+        pageRef: import("vue").Ref<number>;
+    };
+};
+export type FuroPaginationContextFactoryParams = Omit<FuroPaginationContextParams, "refHash"> & {
+    refHash?: FuroPaginationContextParams["refHash"];
+};
+export type EmitEventName = keyof typeof FuroPaginationContext.EMIT_EVENT_NAME;
+export type Props = import("vue").HTMLAttributes & {
+    parcel?: FuroPaginationParcel | null;
+};
+/**
+ * Closed-set Furo behavior for `<FuroPagination>`.
+ * JSON-serializable only. Not an open passthrough to the internal pagination primitive.
+ */
+export type FuroPaginationParcel = {
+    page?: number | null;
+    offset?: number | null;
+    limit?: number;
+    totalRecords?: number;
+    siblingCount?: number;
+    showEdges?: boolean;
+    disabled?: boolean;
+};
+export type ComponentContext = import("vue").SetupContext<FuroPaginationEmitHash, FuroPaginationSlots>;
+export type FuroPaginationEmitHash = typeof FuroPaginationContext.EMIT_EVENT_HASH;
+export type FuroPaginationSlots = import("vue").SlotsType<{
+    previous: {};
+    next: {};
+    ellipsis: {};
+    page: {
+        page: number;
+    };
+}>;
+export type FuroPaginationSetup = (props: Props, componentContext: ComponentContext) => {
+    context: FuroPaginationContext;
+};
+import BaseFuroContext from '../../../contexts/BaseFuroContext.js';