@laserfiche/types-lf-ui-components 14.0.0 → 14.0.1--preview-4533248281

package/index.d.ts

@@ -24,6 +24,11 @@
 
 
 
+
+
+
+
+
 
 
 
@@ -79,6 +84,20 @@ export declare interface ChecklistOption {
     disabled: boolean;
 }
 
+declare interface ColumnDef {
+    id: string;
+    displayName: string;
+    defaultWidth: string;
+    minWidthPx?: number;
+    sortable?: boolean;
+    resizable?: boolean;
+}
+
+declare interface ColumnOrderBy {
+    columnId: string;
+    isDesc: boolean;
+}
+
 /** FieldFormat copied from Web Access */
 declare enum FieldFormat {
     None = "None",
@@ -627,30 +646,83 @@ export declare class LfRepositoryBrowserComponent {
 
 
 
-
-
+    /**
+     * read-only property to get current breadcrumbs
+     */
     get breadcrumbs(): LfTreeNode[];
+    /**
+     * read-only property to retrieve currently opened LfTreeNode
+     */
     get currentFolder(): LfTreeNode | undefined;
-    itemSize: number;
     /**
-     * function to initialize the lf-repository-browser component
+     * Property to set height in pixels of each item in lf-repository-browser
+     */
+    set item_size(value: number | string);
+    get item_size(): number;
+    /**
+     * Property to set number of items rendered, should be set to more than the number of visible nodes
+     */
+    set page_size(value: number | string);
+    get page_size(): number;
+    /**
+     * Property to get and set the current column to order by
+     */
+    get column_order_by(): ColumnOrderBy | undefined;
+    set column_order_by(orderBy: ColumnOrderBy | undefined);
+    /**
+     * Property to set whether or not to always show header. By default will only show header if there is more than one column
+     */
+    set always_show_header(showHeader: boolean | undefined | string);
+    /**
+     * Function to set additional columns to display. You can use this to set a specific name column as well, or accept the default.
+     */
+    setAdditionalColumnsToDisplay: (cols: ColumnDef[]) => void;
+    /**
+     * Function to initialize the lf-repository-browser component
      * @param provider LfRepositoryService service
      * @param selectedNode the id of the node to select, or a Entry starting from the selected entry
      */
     initAsync: (treeNodeService: LfTreeNodeService, selectedNode?: LfTreeNode) => Promise<void>;
+    /**
+     * This function will be called for each LfTreeNode to determine if it is selectable, when it is rendered
+     */
     isSelectable?: (treeNode: LfTreeNode) => Promise<boolean>;
-    multiple: boolean;
+    /**
+     * Property to get and set whether multiple select is enabled on the component
+     */
+    set multiple(value: boolean | string);
+    get multiple(): boolean;
+    /**
+     * Function to set selectedNodes. If current data does not include all the requested node, it will call getFolderChildren until there are no more, or maxFetchIterations is reached.
+     * @param nodesToSelect array of LfTreeNodes to select by id
+     * @param maxFetchIterations Max number of times to get data if the current data doesn't contain all of the requested nodes. Default is 5.
+     * @returns void
+     */
     setSelectedNodesAsync: (nodesToSelect: LfTreeNode[], maxFetchIterations?: number) => Promise<void>;
-    refreshAsync: () => Promise<void>;
+    /**
+     * Function to refresh data in folder (get first page)
+     * @param clearSelectedValues Optional parameter to clear all the currently selected values. Default is true.
+     */
+    refreshAsync: (clearSelectedValues?: boolean) => Promise<void>;
+    /**
+     * Function to open selected node(s). If there is just one container node it will open the container in the UI and emit the entryDblClicked event,
+     * if there is more than one node or it is not a container, it will just emit the entryDblClicked event
+     */
     openSelectedNodesAsync: () => Promise<void>;
+    /**
+     * Function to open focused node. If there is just one container node it will open the container in the UI and emit the entryDblClicked event
+     */
     openFocusedNodeAsync: () => Promise<void>;
     /**
      * Focuses the first item in the repository browser list
      * TODO: Add an optional parameter to allow for focusing a specific node
      */
     focus: () => void;
+    /** Event triggered on double click (open) of a node. This can be accompanied by the UI opening a single container */
     entryDblClicked: CustomEvent<LfTreeNode[]>;
+    /** Event triggered on selection (click/space bar) of a node.*/
     entrySelected: CustomEvent<LfTreeNode[] | undefined>;
+    /** Event triggered on focus of a node.*/
     entryFocused: CustomEvent<LfTreeNode | undefined>;
 
 
@@ -687,16 +759,23 @@ export declare class LfRepositoryBrowserComponent {
 
 
 
-    private makeDataCall;
 
 
-}
 
-export declare class LfRepositoryBrowserModule {
+
+
+
+
+
+
+
+
+
 
 }
 
-export declare class LfSelectionListModule {
+export declare class LfRepositoryBrowserModule {
+
 }
 
 export declare class LfToolbarComponent {
@@ -719,6 +798,7 @@ export declare interface LfTreeNode {
     isLeaf: boolean;
     name: string;
     path: string;
+    attributes?: Map<string, PropertyValue>;
 }
 
 export declare interface LfTreeNodePage {
@@ -735,7 +815,7 @@ export declare interface LfTreeNodeService {
      * @param folder: string that represents the ID of the folder to get data from
      * @param nextPage: string representing the next page requested. If undefined, the first page is returned
      **/
-    getFolderChildrenAsync(folder: LfTreeNode, nextPage?: string): Promise<LfTreeNodePage>;
+    getFolderChildrenAsync(folder: LfTreeNode, nextPage?: string, orderBy?: ColumnOrderBy): Promise<LfTreeNodePage>;
     /**
      * Returns the root LfTreeNode
      */
@@ -782,6 +862,11 @@ declare enum LoginState {
     LoggedOut = "LoggedOut"
 }
 
+declare interface PropertyValue {
+    value?: string | Date | number;
+    displayValue?: string;
+}
+
 declare enum RedirectBehavior {
     Replace = "Replace",
     Popup = "Popup",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@laserfiche/types-lf-ui-components",
-  "version": "14.0.0",
+  "version": "14.0.1--preview-4533248281",
   "scripts": {},
   "dependencies": {},
   "devDependencies": {},