metawrite/Storage/FileList.svelte.d.ts

Appwrite SDK with ready to go components for Svelte / SvelteKit

import { SvelteComponentTyped } from "svelte";
declare const __propDef: {
    props: {
        bucketId: string;
        search?: string;
        limit?: number;
        offset?: number;
        cursor?: string;
        cursorDirection?: string;
        orderType?: string;
    };
    events: {
        [evt: string]: CustomEvent<any>;
    };
    slots: {
        loading: {};
        default: {
            files: import("appwrite").Models.File[];
            actions: {
                reload: () => Promise<import("appwrite").Models.FileList>;
            };
        };
        error: {
            error: any;
        };
    };
};
export declare type FileListProps = typeof __propDef.props;
export declare type FileListEvents = typeof __propDef.events;
export declare type FileListSlots = typeof __propDef.slots;
/**
 * ### `<FileList />`
 *
 * #### Arguments
 *
 * - bucketId - *required* `@type - {string}`
 * - search - *optional* `@type - {string}`
 * - limit - *optional* `@type - {number}`
 * - offset - *optional* `@type - {number}`
 * - cursor - *optional* `@type - {string}`
 * - cursorDirection - *optional* `@type - {string}`
 * - orderType - *optional* `@type - {string} ` => write  `"ASC"` or `"DESC"`
 *
 * #### Slots
 *
 * - **loading**
 * - **error**
 *
 * #### Directives
 *
 * **let:actions**
 * | Name | Description |
 * | --- | --- |
 * | `reload()` | Reload. |
 *
 * - **let:files**
 * - **let:error**
 *
 * #### Example
 *
 * ```svelte
 * <script>
 * import { FileList } from "metawrite"
 *
 * // Optional
 * let bucketId = 'default';
 * let search = '';
 * let limit = 10;
 * let offset = 0;
 * let orderType = 'ASC';
 * </script>
 *
 * <FileList {bucketId} {search} {limit} {offset} {orderType}let:actions let:files>
 * {#each files as file}
 *     <p>File: {file.name}</p>
 * {/each}
 * <button on:click={actions.reload()}>Reload</button>
 * </FileList>
 * ```
 */
export default class FileList extends SvelteComponentTyped<FileListProps, FileListEvents, FileListSlots> {
}
export {};