vitepress-plugin-filelist 0.5.0 → 0.6.0

package/dist/client/ssr/index.d.ts

@@ -18,6 +18,8 @@ interface FileListLabels {
   loading: string;
   loadFailed: string;
   guestHint: string;
+  /** Shown (and appended to toasts) for browser network errors, usually CORS. */
+  /** Shown (and appended to toasts) for browser network errors, usually CORS. */
   corsHint: string;
   retry: string;
   empty: string;
@@ -75,7 +77,7 @@ interface FileListLabels {
   /** Refresh failed; the old rows stay. `{message}` */
   refreshFailed: string;
   cancel: string;
-  /** Placeholder / accessible name of a folder's password input. `{name}` */
+  /** Accessible name of a folder's password input. `{name}` */
   passwordFor: string;
   /** OpenList cannot tell a wrong password from missing permission. */
   passwordWrong: string;
@@ -88,8 +90,31 @@ interface FileListLabels {
   forgetPassword: string;
   /** Lock button on a folder that needs a password. `{name}` */
   unlockFolder: string;
-  /** Appended to failure toasts for browser network errors (usually CORS). */
+  /** @deprecated Network failures now append `corsHint`. */
   networkHint: string;
+  /** Batch progress detail. `{done}` `{total}` sizes, `{files}` `{count}` file counts */
+  batchProgress: string;
+  /** Batch finished. `{name}` `{count}` `{size}` */
+  batchDone: string;
+  batchCanceled: string;
+  /** In-memory ZIP over `zipWarnSize`. `{size}` */
+  zipWarnTitle: string;
+  /** `{limit}` */
+  zipWarnText: string;
+  /** Desktop browsers that cannot stream: point to one that can. */
+  zipStreamTip: string;
+  zipContinue: string;
+  /** In-memory ZIP over `zipMaxSize`. `{size}` */
+  zipBlockTitle: string;
+  /** `{limit}` */
+  zipBlockText: string;
+  gotIt: string;
+  /** Last row of a long folder. `{count}` */
+  moreRemaining: string;
+  showMore: string;
+  showAll: string;
+  /** Fewer than a page left. `{count}` */
+  showRest: string;
 }
 interface FileListSource {
   /** OpenList path, directory or single file. */
@@ -121,6 +146,21 @@ interface FileListProps {
    * cleared when the tab closes). Defaults to `true`; `false` hides the option.
    */
   rememberPassword?: boolean;
+  /**
+   * Rows shown per folder before “Show more”. Defaults to `200`; `0` shows
+   * everything. Data is still loaded in full; only rendering is limited.
+   */
+  pageSize?: number;
+  /**
+   * Browsers that must build the ZIP in memory (Firefox, Safari) ask first above
+   * this many MB. Defaults to 500 (200 on touch devices); `0` never asks.
+   */
+  zipWarnSize?: number;
+  /**
+   * …and refuse above this many MB. Defaults to 2048 (1024 on touch devices);
+   * `0` means no limit. Chrome and Edge stream to disk and skip both checks.
+   */
+  zipMaxSize?: number;
   /** Built-in locale. Defaults to `zh-CN`. */
   locale?: FileListLocale;
   /** Per-key label overrides on top of the locale preset. */
@@ -146,6 +186,7 @@ declare const _default: import("vue").DefineComponent<FileListProps, {}, {}, {},
   password: string;
   title: string;
   rememberPassword: boolean;
+  pageSize: number;
   locale: FileListLocale;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare global {
@@ -225,13 +266,13 @@ declare global {
 export declare const fileListLocales: Record<FileListLocale, FileListLabels>;
 export declare function formatLabel(template: string, values?: Record<string, string | number>): string;
 export declare function resolveLabels(locale?: FileListLocale, overrides?: Partial<FileListLabels>): FileListLabels;
-export interface SortableNode {
+interface SortableNode {
   name: string;
   size: number;
   is_dir: boolean;
   modified: string;
 }
-export type SortKey = 'name' | 'size' | 'modified';
+type SortKey = 'name' | 'size' | 'modified';
 export declare function joinPath(parent: string, name: string): string;
 export declare function encodePath(path: string): string;
 /**
@@ -246,24 +287,26 @@ export declare function zipEntryName(segments: string[]): string;
  * The suffix goes before the extension of the last segment. Adds the result to `used`.
  */
 export declare function uniqueEntryName(name: string, used: Set<string>): string;
+/** Human-readable size. `0` reads `0 B`; missing, negative or invalid sizes read `-`. */
 export declare function formatSize(size: number): string;
 export declare function formatDate(iso: string): string;
+/** Upper-case extension for the type badge, e.g. `PDF`. */
 export declare function extOf(name: string): string;
-export type FileKind = 'doc' | 'sheet' | 'slide' | 'pdf' | 'image' | 'media' | 'archive' | 'code' | 'other';
+type FileKind = 'doc' | 'sheet' | 'slide' | 'pdf' | 'image' | 'media' | 'archive' | 'code' | 'other';
+type PreviewKind = 'image' | 'video' | 'audio' | 'text' | 'pdf' | 'none';
 /** Rough file family, used to colour the type badge. */
 export declare function fileKind(name: string): FileKind;
-/** Sum of the `size` of the given entries, ignoring missing or invalid sizes. */
-export declare function totalSize(items: Array<{
-  size?: number;
-}>): number;
-export declare function compareNodes(a: SortableNode, b: SortableNode, key: SortKey, ascending?: boolean): number;
-export type PreviewKind = 'image' | 'video' | 'audio' | 'text' | 'pdf' | 'none';
 /**
  * How a file is shown in the preview dialog. Office documents and anything
  * else the browser cannot render are `none` (info + download).
  */
 export declare function previewKind(name: string): PreviewKind;
-export interface IframePreview {
+/** Sum of the `size` of the given entries, ignoring missing or invalid sizes. */
+export declare function totalSize(items: Array<{
+  size?: number;
+}>): number;
+export declare function compareNodes(a: SortableNode, b: SortableNode, key: SortKey, ascending?: boolean): number;
+interface IframePreview {
   label: string;
   scheme: string;
 }
@@ -300,4 +343,4 @@ export declare function fillPreviewUrl(scheme: string, args: {
  * ```
  */
 export declare function enhanceAppWithFileList({ app }: EnhanceAppContext): void;
-export { _default as FileList, _default as VPFileList, type FileListLabels, type FileListLocale, type FileListProps, type FileListSource, type OpenListEntry };
+export { type FileKind, _default as FileList, _default as VPFileList, type FileListLabels, type FileListLocale, type FileListProps, type FileListSource, type IframePreview, type OpenListEntry, type PreviewKind, type SortKey, type SortableNode };