virtua 0.51.3 → 0.52.0

package/lib/vue/VGrid.d.ts

@@ -0,0 +1,194 @@
+import { VNode, PublicProps } from 'vue';
+import { VGridScrollToIndexOpts, VGridAxis, VGridCell, VGridSize, VGridSpan } from '../core/index.js';
+/**
+ * Props of {@link VGrid}.
+ */
+export interface VGridProps<R = number, C = number> extends PublicProps {
+    /**
+     * The rows of the grid. See {@link VGridAxis} for the accepted values.
+     */
+    rows: VGridAxis<R>;
+    /**
+     * The columns of the grid. See {@link VGridAxis} for the accepted values.
+     */
+    cols: VGridAxis<C>;
+    /**
+     * The heights of the rows. See {@link VGridSize} for the accepted values.
+     */
+    rowHeight: NoInfer<VGridSize<R>>;
+    /**
+     * The widths of the columns. See {@link VGridSize} for the accepted values.
+     */
+    colWidth: NoInfer<VGridSize<C>>;
+    /**
+     * The number of the leading rows pinned to the start, which are the column headers (`role="columnheader"`).
+     *
+     * **The pinned cells are rendered over the other cells, so give them an opaque background.**
+     * @defaultValue 0
+     */
+    headerRows?: number;
+    /**
+     * Indexes of the rows which start sections. A section lasts until the next section row or the footer rows, and its first row sticks below the header rows while the section is scrolled through.
+     *
+     * **The section rows are rendered over the other cells while they stick, so give them an opaque background.**
+     */
+    sectionRows?: readonly number[];
+    /**
+     * The number of the trailing rows pinned to the end.
+     *
+     * **The pinned cells are rendered over the other cells, so give them an opaque background.**
+     * @defaultValue 0
+     */
+    footerRows?: number;
+    /**
+     * The number of the leading columns pinned to the start, the last of which is the row header (`role="rowheader"`).
+     *
+     * **The pinned cells are rendered over the other cells, so give them an opaque background.**
+     * @defaultValue 0
+     */
+    headerCols?: number;
+    /**
+     * The number of the trailing columns pinned to the end.
+     *
+     * **The pinned cells are rendered over the other cells, so give them an opaque background.**
+     * @defaultValue 0
+     */
+    footerCols?: number;
+    /**
+     * Cells merged over multiple rows and/or columns. See {@link VGridSpan} for the accepted values.
+     *
+     * The cell at the origin is stretched over the merged area, and the other cells in it are not rendered. Spans must not overlap each other or cross the boundaries of the pinned rows/columns or the sections. A spanning cell is not measured for `"auto"` sizes on the axes it spans, and doesn't enlarge those tracks.
+     */
+    spans?: readonly VGridSpan[];
+    /**
+     * List of cells that should be always mounted, even when off screen.
+     */
+    keepMounted?: readonly VGridCell[];
+    /**
+     * Extra space in pixels to render before/after the viewport. The minimum value is 0. Lower value will give better performance but you can increase to avoid showing blank cells in fast scrolling.
+     * @defaultValue 200
+     */
+    bufferSize?: number;
+    /**
+     * The gap between the rows and the columns in pixels, which is not included in the sizes. Must not be changed after mount.
+     * @defaultValue 0
+     */
+    gap?: number;
+    /**
+     * The header cell of the sorted column or row, and the sort order (`aria-sort`).
+     */
+    ariaSort?: VGridCell & {
+        order: "ascending" | "descending" | "other";
+    };
+    /**
+     * Callback invoked whenever the vertical scroll offset changes.
+     * @param offset Current scrollTop.
+     */
+    onVerticalScroll?: (offset: number) => void;
+    /**
+     * Callback invoked whenever the horizontal scroll offset changes.
+     * @param offset Current scrollLeft. Always positive even in RTL.
+     */
+    onHorizontalScroll?: (offset: number) => void;
+    /**
+     * Callback invoked when scrolling stops.
+     */
+    onScrollEnd?: () => void;
+}
+/**
+ * Methods of {@link VGrid}.
+ */
+export interface VGridHandle {
+    /**
+     * Get current scrollTop.
+     */
+    readonly verticalScrollOffset: number;
+    /**
+     * Get current scrollLeft. Always positive even in RTL.
+     */
+    readonly horizontalScrollOffset: number;
+    /**
+     * Get current scrollHeight.
+     */
+    readonly scrollHeight: number;
+    /**
+     * Get current scrollWidth.
+     */
+    readonly scrollWidth: number;
+    /**
+     * Get current clientHeight.
+     */
+    readonly viewportHeight: number;
+    /**
+     * Get current clientWidth.
+     */
+    readonly viewportWidth: number;
+    /**
+     * Find nearest row index from offset.
+     * @param offset offset in pixels from the top of the scroll container
+     */
+    findRowIndex(offset: number): number;
+    /**
+     * Find nearest column index from offset.
+     * @param offset offset in pixels from the start of the scroll container
+     */
+    findColIndex(offset: number): number;
+    /**
+     * Get offset of the row from the top.
+     * @param index index of row
+     */
+    getRowOffset(index: number): number;
+    /**
+     * Get offset of the column from the start.
+     * @param index index of column
+     */
+    getColOffset(index: number): number;
+    /**
+     * Get size of the row.
+     * @param index index of row
+     */
+    getRowSize(index: number): number;
+    /**
+     * Get size of the column.
+     * @param index index of column
+     */
+    getColSize(index: number): number;
+    /**
+     * Scroll to the cell specified by the indexes. The cell is not hidden behind the rows and the columns sticking over it.
+     * @param opts the indexes of the cell and the options. See {@link VGridScrollToIndexOpts}.
+     */
+    scrollToIndex(opts: VGridScrollToIndexOpts): void;
+    /**
+     * Scroll to the given offsets from the top/start of the scroll container.
+     * @param offset the offsets. The axis whose offset is omitted is not scrolled.
+     */
+    scrollTo(offset: {
+        vertical?: number;
+        horizontal?: number;
+    }): void;
+    /**
+     * Scroll by the given offsets from the current position.
+     * @param offset the offsets. The axis whose offset is omitted is not scrolled.
+     */
+    scrollBy(offset: {
+        vertical?: number;
+        horizontal?: number;
+    }): void;
+}
+interface VGridInstance<R = number, C = number> extends VGridHandle {
+    $props: VGridProps<R, C>;
+    $slots: {
+        default: (arg: {
+            row: R;
+            col: C;
+            cell: Readonly<VGridCell>;
+        }) => VNode[];
+    };
+}
+/**
+ * Virtualized grid component for tabular data. See {@link VGridProps} and {@link VGridHandle}.
+ */
+export declare const VGrid: {
+    new <R = number, C = number>(props: VGridProps<R, C>): VGridInstance<R, C>;
+};
+export {};