@unofficialbox/box-open-elements 0.1.0

package/dist/patterns/content-explorer/content-explorer.d.ts

@@ -0,0 +1,85 @@
+import { type ExplorerItemAction, type ExplorerItem, type ExplorerItemGesture, type ExplorerSelectionMode, type ExplorerState, type ExplorerTransport } from "./types.js";
+import { BaseElement } from "../../core/index.js";
+export interface BoxContentExplorerTemplateContext {
+    element: BoxContentExplorerElement;
+    state: Readonly<ExplorerState> | null;
+}
+export interface BoxContentExplorerFolderTemplateArgs extends BoxContentExplorerTemplateContext {
+    breadcrumbsMarkup: string;
+}
+export interface BoxContentExplorerBreadcrumbTemplateArgs extends BoxContentExplorerTemplateContext {
+    buttonAttributes: string;
+    id: string;
+    name: string;
+}
+export interface BoxContentExplorerItemActionTemplateArgs extends BoxContentExplorerTemplateContext {
+    action: ExplorerItemAction;
+    buttonAttributes: string;
+    item: ExplorerItem;
+}
+export interface BoxContentExplorerItemTemplateArgs extends BoxContentExplorerTemplateContext {
+    isSelected: boolean;
+    item: ExplorerItem;
+    itemActionsMarkup: string;
+    itemButtonAttributes: string;
+}
+export interface BoxContentExplorerTemplates {
+    renderBreadcrumb?: (args: BoxContentExplorerBreadcrumbTemplateArgs) => string;
+    renderFolder?: (args: BoxContentExplorerFolderTemplateArgs) => string;
+    renderItem?: (args: BoxContentExplorerItemTemplateArgs) => string;
+    renderItemAction?: (args: BoxContentExplorerItemActionTemplateArgs) => string;
+}
+export declare class BoxContentExplorerElement extends BaseElement {
+    static get observedAttributes(): string[];
+    private controller;
+    private pendingStart;
+    private focusItemId;
+    private unsubscribeFns;
+    private transportValue;
+    private itemActionsValue;
+    private templatesValue;
+    get language(): string | null;
+    set language(value: string | null);
+    get pageSize(): number | undefined;
+    get selectionMode(): ExplorerSelectionMode | null;
+    set selectionMode(value: ExplorerSelectionMode | null);
+    get itemGesture(): ExplorerItemGesture;
+    set itemGesture(value: ExplorerItemGesture);
+    set pageSize(value: number | undefined);
+    get rootFolderId(): string | null;
+    set rootFolderId(value: string | null);
+    get token(): string | null;
+    set token(value: string | null);
+    get transport(): ExplorerTransport | null;
+    set transport(value: ExplorerTransport | null);
+    get itemActions(): ExplorerItemAction[];
+    set itemActions(value: ExplorerItemAction[]);
+    get templates(): BoxContentExplorerTemplates;
+    set templates(value: BoxContentExplorerTemplates);
+    get state(): Readonly<ExplorerState> | null;
+    get searchQuery(): string | null;
+    set searchQuery(value: string | null);
+    attributeChangedCallback(name: string, oldValue: string | null, newValue: string | null): void;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    loadNextPage(): Promise<void>;
+    refresh(): Promise<void>;
+    activateItem(itemId: string): Promise<void>;
+    navigateTo(folderId: string): Promise<void>;
+    search(query: string): Promise<void>;
+    clearSearch(): Promise<void>;
+    select(itemIds: string[]): void;
+    toggleSelection(itemId: string): void;
+    clearSelection(): void;
+    invokeItemAction(itemId: string, actionId: string): void;
+    private updateStringAttribute;
+    private scheduleStart;
+    private startController;
+    private readConfig;
+    private subscribeToController;
+    private teardownController;
+    private getFocusableItemIds;
+    protected renderTemplate(): void;
+    protected update(): void;
+}
+export declare const defineBoxContentExplorerElement: (tagName?: string) => typeof BoxContentExplorerElement;