@microsoft/sp-listview-extensibility 1.14.0-beta.4 → 1.14.0-beta.5

package/dist/d37b65ee-c7d8-4570-bc74-2b294ff3b380.manifest.json

@@ -12,7 +12,7 @@
     "scriptResources": {
       "sp-listview-extensibility": {
         "type": "path",
-        "path": "sp-listview-extensibility_none_7c3cbbaef8efd67369bb.js"
+        "path": "sp-listview-extensibility_none_ed92a9a99f00e681761d.js"
       },
       "tslib": {
         "type": "component",

package/dist/index-internal-beta.d.ts

@@ -6,7 +6,9 @@
 
 import { BaseExtension } from '@microsoft/sp-extension-base';
 import { ExtensionContext } from '@microsoft/sp-extension-base';
+import { Guid } from '@microsoft/sp-core-library';
 import { ICommandSetExtensionManifest } from '@microsoft/sp-module-interfaces';
+import { IDisposable } from '@microsoft/sp-core-library';
 import { SPEvent } from '@microsoft/sp-core-library';
 import { SPEventArgs } from '@microsoft/sp-core-library';
 import { SPField } from '@microsoft/sp-page-context';
@@ -48,6 +50,7 @@ export declare abstract class BaseListViewCommandSet<TProperties> extends BaseEx
      * {@inheritDoc @microsoft/sp-extension-base#BaseExtension.context}
      */
     readonly context: ListViewCommandSetContext;
+    /* Excluded from this release type: _raiseOnChange */
     /* Excluded from this release type: __constructor */
     /**
      * Returns the command with the given id.
@@ -60,6 +63,8 @@ export declare abstract class BaseListViewCommandSet<TProperties> extends BaseEx
      * virtual
      * @remarks
      * This event allows the implementor to tailor the visibility of the command.
+     *
+     * @deprecated Use context.listView.listViewStateChangedEvent instead.
      */
     onListViewUpdated(event: IListViewCommandSetListViewUpdatedParameters): void;
     /**
@@ -68,6 +73,10 @@ export declare abstract class BaseListViewCommandSet<TProperties> extends BaseEx
      * virtual
      */
     onExecute(event: IListViewCommandSetExecuteEventParameters): void;
+    /**
+     * Use this method to fire OnChange event and initialize a reflow of the ListView.
+     */
+    raiseOnChange(): void;
 }
 
 /**
@@ -170,6 +179,50 @@ export declare class FieldCustomizerContext extends ExtensionContext {
     get field(): SPField;
 }
 
+/**
+ * Provides information about the state of a column in the list view
+ *
+ * @beta
+ */
+export declare interface IColumn {
+    /**
+     * The GUID identifier for this field.
+     */
+    readonly id: Guid;
+    /**
+     * The internal name of the field. This name is usually used to find the field.
+     */
+    readonly internalName: string;
+    /**
+     * The type of the field represented as a string
+     */
+    readonly fieldType: string;
+    /**
+     * Whether the field is required for each list item in the list
+     */
+    readonly isRequired: boolean;
+    /**
+     * Whether the column is visible in the view
+     */
+    readonly isVisible: boolean;
+    /**
+     * The display name of the field. This name is shown as column name in UI.
+     */
+    readonly displayName: string;
+    /**
+     * The unique identifier of the client-side component associated with the field.
+     */
+    readonly clientSideComponentId: Guid | undefined;
+    /**
+     * This property is only used when a `ClientSideComponentId` is specified.  It is optional.
+     *
+     * @remarks
+     * If non-empty, the string must contain a JSON object with custom initialization properties
+     * whose format and meaning are defined by the client-side component.
+     */
+    readonly clientSideComponentProperties: string;
+}
+
 /* Excluded from this release type: _IExtensionContextParameters */
 
 /**
@@ -204,6 +257,100 @@ export declare interface IFieldCustomizerCellEventParameters {
 
 /* Excluded from this release type: _IFieldCustomizerContextParameters */
 
+/**
+ * Provides information about the state of the filters applied to the ListView.
+ *
+ * @beta
+ */
+export declare interface IFilter {
+    /**
+     * Field name to filter on.
+     */
+    readonly fieldName: string;
+    /**
+     * Values to filter on.
+     */
+    values: ReadonlyArray<string>;
+}
+
+/**
+ * Provides information about the state of the folder in the ListView.
+ *
+ * @beta
+ */
+export declare interface IFolderInfo {
+    /**
+     * Folder path.
+     */
+    readonly folderPath: string;
+}
+
+/**
+ * Provides information about the list rendered by the ListView.
+ *
+ * @beta
+ */
+export declare interface IList {
+    /**
+     * List id.
+     */
+    readonly guid: Guid;
+    /**
+     * List title.
+     */
+    readonly title: string;
+    /**
+     * List server relative url.
+     */
+    readonly serverRelativeUrl: string;
+}
+
+/**
+ * Provides information about the state of the ListView.
+ *
+ * @beta
+ */
+export declare interface IListViewAccessorState {
+    /**
+     * List information.
+     */
+    readonly list?: IList;
+    /**
+     * View information.
+     */
+    readonly view?: IView;
+    /**
+     * Current folder information.
+     */
+    readonly folderInfo?: IFolderInfo;
+    /**
+     * Columns information.
+     */
+    readonly columns: ReadonlyArray<IColumn>;
+    /**
+     * Selected rows information.
+     */
+    readonly selectedRows?: ReadonlyArray<IRow>;
+    /**
+     * Rows information.
+     */
+    readonly rows: ReadonlyArray<IRow>;
+    /**
+     * Applied filters information.
+     */
+    readonly appliedFilters?: {
+        [fieldName: string]: IFilter;
+    };
+    /**
+     * Sort field name.
+     */
+    readonly sortField?: string;
+    /**
+     * Sort direction.
+     */
+    readonly sortAscending?: boolean;
+}
+
 /* Excluded from this release type: _IListViewCommandSetContextParameters */
 
 /**
@@ -235,6 +382,41 @@ export declare interface IListViewCommandSetListViewUpdatedParameters {
     readonly selectedRows: ReadonlyArray<RowAccessor>;
 }
 
+/**
+ * Provides information about the list item's state rendered by the ListView.
+ *
+ * @beta
+ */
+export declare interface IRow {
+    /**
+     * A map of column values for the row. They key is the column internal name and the value
+     * is its corresponding value in the row.
+     */
+    readonly values: {
+        [columnInternalName: string]: Readonly<any>;
+    };
+}
+
+/**
+ * Provides information about the view rendered by the ListView.
+ *
+ * @beta
+ */
+export declare interface IView {
+    /**
+     * View id.
+     */
+    readonly id: Guid;
+    /**
+     * View title.
+     */
+    readonly title: string;
+    /**
+     * View server relative url.
+     */
+    readonly url: string;
+}
+
 /**
  * When a field customizer extension is rendering a field, the ListItemAccessor provides
  * access to the associated SharePoint list item.
@@ -280,14 +462,68 @@ export declare abstract class ListItemAccessor {
  *
  * @public
  */
-export declare abstract class ListViewAccessor {
+export declare abstract class ListViewAccessor implements IDisposable {
     /* Excluded from this release type: _selectedRowsChangedEventName */
+    /* Excluded from this release type: _listViewStateChangedEventName */
     private _selectedRowsChangedEvent;
+    private _listViewStateChangedEvent;
+    private readonly _listViewStateChangedEventName;
+    private _isDisposed;
     /* Excluded from this release type: __constructor */
     /**
      * The columns in associated with this view, including hidden columns.
      */
     abstract get columns(): ReadonlyArray<ColumnAccessor>;
+    /**
+     * Currently rendered rows in the list view.
+     *
+     * @beta
+     */
+    abstract get rows(): ReadonlyArray<RowAccessor>;
+    /**
+     * Selected rows in the list view.
+     *
+     * @beta
+     */
+    abstract get selectedRows(): ReadonlyArray<RowAccessor> | undefined;
+    /**
+     * Basic information about the list rendered by the list view.
+     *
+     * @beta
+     */
+    abstract get list(): IList | undefined;
+    /**
+     * Basic information about the view rendered by the list view.
+     *
+     * @beta
+     */
+    abstract get view(): IView | undefined;
+    /**
+     * Folder information for the list view.
+     *
+     * @beta
+     */
+    abstract get folderInfo(): IFolderInfo | undefined;
+    /**
+     * Filters applied to the list view.
+     *
+     * @beta
+     */
+    abstract get appliedFilters(): {
+        [fieldName: string]: IFilter;
+    } | undefined;
+    /**
+     * Sort field name
+     *
+     * @beta
+     */
+    abstract get sortField(): string | undefined;
+    /**
+     * Specifies whether the list view is sorted ascending or descending.
+     *
+     * @beta
+     */
+    abstract get sortAscending(): boolean | undefined;
     /**
      * Returns the list view column corresponding to the field with the specified internal name,
      * or undefined if none is found.
@@ -298,6 +534,32 @@ export declare abstract class ListViewAccessor {
      * @eventproperty
      */
     get selectedRowsChangedEvent(): SPEvent<SelectedRowsChangedEventArgs>;
+    /**
+     * Event that gets raised every time the list view state changes.
+     *
+     * @beta
+     * @eventproperty
+     */
+    get listViewStateChangedEvent(): SPEvent<ListViewStateChangedEventArgs>;
+    /* Excluded from this release type: dispose */
+    /* Excluded from this release type: isDisposed */
+}
+
+/**
+ * Describes the type of list view state changes.
+ *
+ * @beta
+ */
+export declare enum ListViewAccessorStateChanges {
+    None = 0,
+    List = 1,
+    View = 2,
+    Columns = 4,
+    SelectedRows = 8,
+    Rows = 16,
+    AppliedFilters = 32,
+    Sort = 64,
+    FolderInfo = 128
 }
 
 /**
@@ -319,6 +581,22 @@ export declare class ListViewCommandSetContext extends ExtensionContext {
     /* Excluded from this release type: _commands */
 }
 
+/**
+ * Arguments for the list view state changed event.
+ *
+ * @beta
+ */
+export declare class ListViewStateChangedEventArgs extends SPEventArgs {
+    /**
+     * Previous state of the ListView.
+     */
+    prevState: Readonly<IListViewAccessorState>;
+    /**
+     * Changes that were made to the ListView state.
+     */
+    stateChanges: ListViewAccessorStateChanges;
+}
+
 /**
  * Provides access to a ListView row, which is the visual presentation
  * of a SharePoint list item.

package/dist/index-internal-public.d.ts

@@ -6,7 +6,9 @@
 
 import { BaseExtension } from '@microsoft/sp-extension-base';
 import { ExtensionContext } from '@microsoft/sp-extension-base';
+import { Guid } from '@microsoft/sp-core-library';
 import { ICommandSetExtensionManifest } from '@microsoft/sp-module-interfaces';
+import { IDisposable } from '@microsoft/sp-core-library';
 import { SPEvent } from '@microsoft/sp-core-library';
 import { SPEventArgs } from '@microsoft/sp-core-library';
 import { SPField } from '@microsoft/sp-page-context';
@@ -48,6 +50,7 @@ export declare abstract class BaseListViewCommandSet<TProperties> extends BaseEx
      * {@inheritDoc @microsoft/sp-extension-base#BaseExtension.context}
      */
     readonly context: ListViewCommandSetContext;
+    /* Excluded from this release type: _raiseOnChange */
     /* Excluded from this release type: __constructor */
     /**
      * Returns the command with the given id.
@@ -60,6 +63,8 @@ export declare abstract class BaseListViewCommandSet<TProperties> extends BaseEx
      * virtual
      * @remarks
      * This event allows the implementor to tailor the visibility of the command.
+     *
+     * @deprecated Use context.listView.listViewStateChangedEvent instead.
      */
     onListViewUpdated(event: IListViewCommandSetListViewUpdatedParameters): void;
     /**
@@ -68,6 +73,10 @@ export declare abstract class BaseListViewCommandSet<TProperties> extends BaseEx
      * virtual
      */
     onExecute(event: IListViewCommandSetExecuteEventParameters): void;
+    /**
+     * Use this method to fire OnChange event and initialize a reflow of the ListView.
+     */
+    raiseOnChange(): void;
 }
 
 /**
@@ -170,6 +179,8 @@ export declare class FieldCustomizerContext extends ExtensionContext {
     get field(): SPField;
 }
 
+/* Excluded from this release type: IColumn */
+
 /* Excluded from this release type: _IExtensionContextParameters */
 
 /**
@@ -204,6 +215,14 @@ export declare interface IFieldCustomizerCellEventParameters {
 
 /* Excluded from this release type: _IFieldCustomizerContextParameters */
 
+/* Excluded from this release type: IFilter */
+
+/* Excluded from this release type: IFolderInfo */
+
+/* Excluded from this release type: IList */
+
+/* Excluded from this release type: IListViewAccessorState */
+
 /* Excluded from this release type: _IListViewCommandSetContextParameters */
 
 /**
@@ -235,6 +254,10 @@ export declare interface IListViewCommandSetListViewUpdatedParameters {
     readonly selectedRows: ReadonlyArray<RowAccessor>;
 }
 
+/* Excluded from this release type: IRow */
+
+/* Excluded from this release type: IView */
+
 /**
  * When a field customizer extension is rendering a field, the ListItemAccessor provides
  * access to the associated SharePoint list item.
@@ -280,14 +303,26 @@ export declare abstract class ListItemAccessor {
  *
  * @public
  */
-export declare abstract class ListViewAccessor {
+export declare abstract class ListViewAccessor implements IDisposable {
     /* Excluded from this release type: _selectedRowsChangedEventName */
+    /* Excluded from this release type: _listViewStateChangedEventName */
     private _selectedRowsChangedEvent;
+    private _listViewStateChangedEvent;
+    private readonly _listViewStateChangedEventName;
+    private _isDisposed;
     /* Excluded from this release type: __constructor */
     /**
      * The columns in associated with this view, including hidden columns.
      */
     abstract get columns(): ReadonlyArray<ColumnAccessor>;
+    /* Excluded from this release type: rows */
+    /* Excluded from this release type: selectedRows */
+    /* Excluded from this release type: list */
+    /* Excluded from this release type: view */
+    /* Excluded from this release type: folderInfo */
+    /* Excluded from this release type: appliedFilters */
+    /* Excluded from this release type: sortField */
+    /* Excluded from this release type: sortAscending */
     /**
      * Returns the list view column corresponding to the field with the specified internal name,
      * or undefined if none is found.
@@ -298,8 +333,13 @@ export declare abstract class ListViewAccessor {
      * @eventproperty
      */
     get selectedRowsChangedEvent(): SPEvent<SelectedRowsChangedEventArgs>;
+    /* Excluded from this release type: listViewStateChangedEvent */
+    /* Excluded from this release type: dispose */
+    /* Excluded from this release type: isDisposed */
 }
 
+/* Excluded from this release type: ListViewAccessorStateChanges */
+
 /**
  * This object provides contextual information for BaseListViewCommandSet.
  * @public
@@ -319,6 +359,8 @@ export declare class ListViewCommandSetContext extends ExtensionContext {
     /* Excluded from this release type: _commands */
 }
 
+/* Excluded from this release type: ListViewStateChangedEventArgs */
+
 /**
  * Provides access to a ListView row, which is the visual presentation
  * of a SharePoint list item.

package/dist/index-internal.d.ts

@@ -6,7 +6,9 @@
 
 import { BaseExtension } from '@microsoft/sp-extension-base';
 import { ExtensionContext } from '@microsoft/sp-extension-base';
+import { Guid } from '@microsoft/sp-core-library';
 import { ICommandSetExtensionManifest } from '@microsoft/sp-module-interfaces';
+import { IDisposable } from '@microsoft/sp-core-library';
 import { SPEvent } from '@microsoft/sp-core-library';
 import { SPEventArgs } from '@microsoft/sp-core-library';
 import { SPField } from '@microsoft/sp-page-context';
@@ -48,6 +50,7 @@ export declare abstract class BaseListViewCommandSet<TProperties> extends BaseEx
      * {@inheritDoc @microsoft/sp-extension-base#BaseExtension.context}
      */
     readonly context: ListViewCommandSetContext;
+    /* Excluded from this release type: _raiseOnChange */
     /* Excluded from this release type: __constructor */
     /**
      * Returns the command with the given id.
@@ -60,6 +63,8 @@ export declare abstract class BaseListViewCommandSet<TProperties> extends BaseEx
      * virtual
      * @remarks
      * This event allows the implementor to tailor the visibility of the command.
+     *
+     * @deprecated Use context.listView.listViewStateChangedEvent instead.
      */
     onListViewUpdated(event: IListViewCommandSetListViewUpdatedParameters): void;
     /**
@@ -68,6 +73,10 @@ export declare abstract class BaseListViewCommandSet<TProperties> extends BaseEx
      * virtual
      */
     onExecute(event: IListViewCommandSetExecuteEventParameters): void;
+    /**
+     * Use this method to fire OnChange event and initialize a reflow of the ListView.
+     */
+    raiseOnChange(): void;
 }
 
 /**
@@ -170,6 +179,50 @@ export declare class FieldCustomizerContext extends ExtensionContext {
     get field(): SPField;
 }
 
+/**
+ * Provides information about the state of a column in the list view
+ *
+ * @beta
+ */
+export declare interface IColumn {
+    /**
+     * The GUID identifier for this field.
+     */
+    readonly id: Guid;
+    /**
+     * The internal name of the field. This name is usually used to find the field.
+     */
+    readonly internalName: string;
+    /**
+     * The type of the field represented as a string
+     */
+    readonly fieldType: string;
+    /**
+     * Whether the field is required for each list item in the list
+     */
+    readonly isRequired: boolean;
+    /**
+     * Whether the column is visible in the view
+     */
+    readonly isVisible: boolean;
+    /**
+     * The display name of the field. This name is shown as column name in UI.
+     */
+    readonly displayName: string;
+    /**
+     * The unique identifier of the client-side component associated with the field.
+     */
+    readonly clientSideComponentId: Guid | undefined;
+    /**
+     * This property is only used when a `ClientSideComponentId` is specified.  It is optional.
+     *
+     * @remarks
+     * If non-empty, the string must contain a JSON object with custom initialization properties
+     * whose format and meaning are defined by the client-side component.
+     */
+    readonly clientSideComponentProperties: string;
+}
+
 /* Excluded from this release type: _IExtensionContextParameters */
 
 /**
@@ -204,6 +257,100 @@ export declare interface IFieldCustomizerCellEventParameters {
 
 /* Excluded from this release type: _IFieldCustomizerContextParameters */
 
+/**
+ * Provides information about the state of the filters applied to the ListView.
+ *
+ * @beta
+ */
+export declare interface IFilter {
+    /**
+     * Field name to filter on.
+     */
+    readonly fieldName: string;
+    /**
+     * Values to filter on.
+     */
+    values: ReadonlyArray<string>;
+}
+
+/**
+ * Provides information about the state of the folder in the ListView.
+ *
+ * @beta
+ */
+export declare interface IFolderInfo {
+    /**
+     * Folder path.
+     */
+    readonly folderPath: string;
+}
+
+/**
+ * Provides information about the list rendered by the ListView.
+ *
+ * @beta
+ */
+export declare interface IList {
+    /**
+     * List id.
+     */
+    readonly guid: Guid;
+    /**
+     * List title.
+     */
+    readonly title: string;
+    /**
+     * List server relative url.
+     */
+    readonly serverRelativeUrl: string;
+}
+
+/**
+ * Provides information about the state of the ListView.
+ *
+ * @beta
+ */
+export declare interface IListViewAccessorState {
+    /**
+     * List information.
+     */
+    readonly list?: IList;
+    /**
+     * View information.
+     */
+    readonly view?: IView;
+    /**
+     * Current folder information.
+     */
+    readonly folderInfo?: IFolderInfo;
+    /**
+     * Columns information.
+     */
+    readonly columns: ReadonlyArray<IColumn>;
+    /**
+     * Selected rows information.
+     */
+    readonly selectedRows?: ReadonlyArray<IRow>;
+    /**
+     * Rows information.
+     */
+    readonly rows: ReadonlyArray<IRow>;
+    /**
+     * Applied filters information.
+     */
+    readonly appliedFilters?: {
+        [fieldName: string]: IFilter;
+    };
+    /**
+     * Sort field name.
+     */
+    readonly sortField?: string;
+    /**
+     * Sort direction.
+     */
+    readonly sortAscending?: boolean;
+}
+
 /* Excluded from this release type: _IListViewCommandSetContextParameters */
 
 /**
@@ -235,6 +382,41 @@ export declare interface IListViewCommandSetListViewUpdatedParameters {
     readonly selectedRows: ReadonlyArray<RowAccessor>;
 }
 
+/**
+ * Provides information about the list item's state rendered by the ListView.
+ *
+ * @beta
+ */
+export declare interface IRow {
+    /**
+     * A map of column values for the row. They key is the column internal name and the value
+     * is its corresponding value in the row.
+     */
+    readonly values: {
+        [columnInternalName: string]: Readonly<any>;
+    };
+}
+
+/**
+ * Provides information about the view rendered by the ListView.
+ *
+ * @beta
+ */
+export declare interface IView {
+    /**
+     * View id.
+     */
+    readonly id: Guid;
+    /**
+     * View title.
+     */
+    readonly title: string;
+    /**
+     * View server relative url.
+     */
+    readonly url: string;
+}
+
 /**
  * When a field customizer extension is rendering a field, the ListItemAccessor provides
  * access to the associated SharePoint list item.
@@ -280,14 +462,68 @@ export declare abstract class ListItemAccessor {
  *
  * @public
  */
-export declare abstract class ListViewAccessor {
+export declare abstract class ListViewAccessor implements IDisposable {
     /* Excluded from this release type: _selectedRowsChangedEventName */
+    /* Excluded from this release type: _listViewStateChangedEventName */
     private _selectedRowsChangedEvent;
+    private _listViewStateChangedEvent;
+    private readonly _listViewStateChangedEventName;
+    private _isDisposed;
     /* Excluded from this release type: __constructor */
     /**
      * The columns in associated with this view, including hidden columns.
      */
     abstract get columns(): ReadonlyArray<ColumnAccessor>;
+    /**
+     * Currently rendered rows in the list view.
+     *
+     * @beta
+     */
+    abstract get rows(): ReadonlyArray<RowAccessor>;
+    /**
+     * Selected rows in the list view.
+     *
+     * @beta
+     */
+    abstract get selectedRows(): ReadonlyArray<RowAccessor> | undefined;
+    /**
+     * Basic information about the list rendered by the list view.
+     *
+     * @beta
+     */
+    abstract get list(): IList | undefined;
+    /**
+     * Basic information about the view rendered by the list view.
+     *
+     * @beta
+     */
+    abstract get view(): IView | undefined;
+    /**
+     * Folder information for the list view.
+     *
+     * @beta
+     */
+    abstract get folderInfo(): IFolderInfo | undefined;
+    /**
+     * Filters applied to the list view.
+     *
+     * @beta
+     */
+    abstract get appliedFilters(): {
+        [fieldName: string]: IFilter;
+    } | undefined;
+    /**
+     * Sort field name
+     *
+     * @beta
+     */
+    abstract get sortField(): string | undefined;
+    /**
+     * Specifies whether the list view is sorted ascending or descending.
+     *
+     * @beta
+     */
+    abstract get sortAscending(): boolean | undefined;
     /**
      * Returns the list view column corresponding to the field with the specified internal name,
      * or undefined if none is found.
@@ -298,6 +534,32 @@ export declare abstract class ListViewAccessor {
      * @eventproperty
      */
     get selectedRowsChangedEvent(): SPEvent<SelectedRowsChangedEventArgs>;
+    /**
+     * Event that gets raised every time the list view state changes.
+     *
+     * @beta
+     * @eventproperty
+     */
+    get listViewStateChangedEvent(): SPEvent<ListViewStateChangedEventArgs>;
+    /* Excluded from this release type: dispose */
+    /* Excluded from this release type: isDisposed */
+}
+
+/**
+ * Describes the type of list view state changes.
+ *
+ * @beta
+ */
+export declare enum ListViewAccessorStateChanges {
+    None = 0,
+    List = 1,
+    View = 2,
+    Columns = 4,
+    SelectedRows = 8,
+    Rows = 16,
+    AppliedFilters = 32,
+    Sort = 64,
+    FolderInfo = 128
 }
 
 /**
@@ -319,6 +581,22 @@ export declare class ListViewCommandSetContext extends ExtensionContext {
     /* Excluded from this release type: _commands */
 }
 
+/**
+ * Arguments for the list view state changed event.
+ *
+ * @beta
+ */
+export declare class ListViewStateChangedEventArgs extends SPEventArgs {
+    /**
+     * Previous state of the ListView.
+     */
+    prevState: Readonly<IListViewAccessorState>;
+    /**
+     * Changes that were made to the ListView state.
+     */
+    stateChanges: ListViewAccessorStateChanges;
+}
+
 /**
  * Provides access to a ListView row, which is the visual presentation
  * of a SharePoint list item.

package/dist/sp-listview-extensibility_none_ed92a9a99f00e681761d.js

@@ -0,0 +1 @@
+define("d37b65ee-c7d8-4570-bc74-2b294ff3b380_1.14.0",["tslib","@microsoft/sp-core-library","@microsoft/sp-page-context","@microsoft/sp-extension-base"],function(n,a,i,r){return function(e){var t={};function n(a){if(t[a])return t[a].exports;var i=t[a]={i:a,l:!1,exports:{}};return e[a].call(i.exports,i,i.exports,n),i.l=!0,i.exports}return n.m=e,n.c=t,n.d=function(e,t,a){n.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:a})},n.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},n.t=function(e,t){if(1&t&&(e=n(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var a=Object.create(null);if(n.r(a),Object.defineProperty(a,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var i in e)n.d(a,i,function(t){return e[t]}.bind(null,i));return a},n.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return n.d(t,"a",t),t},n.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},n.p="",n(n.s="mwqp")}({"17wl":function(e,t){e.exports=n},UWqr:function(e,t){e.exports=a},"X+PM":function(e,t){e.exports=i},ZFc5:function(e,t){e.exports=r},mwqp:function(e,t,n){"use strict";n.r(t),n.d(t,"BaseListViewCommandSet",function(){return s}),n.d(t,"Command",function(){return c}),n.d(t,"ListViewCommandSetContext",function(){return l}),n.d(t,"BaseFieldCustomizer",function(){return f}),n.d(t,"FieldCustomizerContext",function(){return p}),n.d(t,"ListItemAccessor",function(){return m}),n.d(t,"ColumnAccessor",function(){return _}),n.d(t,"RowAccessor",function(){return h}),n.d(t,"SelectedRowsChangedEventArgs",function(){return b}),n.d(t,"ListViewStateChangedEventArgs",function(){return g}),n.d(t,"ListViewAccessor",function(){return v}),n.d(t,"ListViewAccessorStateChanges",function(){return a});var a,i=n("17wl"),r=n("UWqr"),o=n("ZFc5"),s=function(e){function t(){var t=e.call(this)||this;return t._raiseOnChange=void 0,t}return Object(i.__extends)(t,e),t.prototype.tryGetCommand=function(e){return r.Validate.isNonemptyString(e,"id"),this.context._commands.filter(function(t){return t.id===e})[0]},t.prototype.onListViewUpdated=function(e){},t.prototype.onExecute=function(e){},t.prototype.raiseOnChange=function(){this._raiseOnChange&&this._raiseOnChange()},t}(o.BaseExtension),c=function(){},d=n("X+PM"),l=function(e){function t(t,n){var a=e.call(this,t)||this;a._listView=n.listView,a._commandArray=[];for(var i=a.manifest.items,o=0,s=Object.keys(i);o<s.length;o++){var c=s[o];if("command"===i[c].type){var l=i[c].iconImageUrl;l&&!r.UrlUtilities.isDataUrl(l)&&(l=r.UrlUtilities.resolve(l,a.manifest.loaderConfig.internalModuleBaseUrls[0])),a._commandArray.push({id:c,title:i[c].title.default||"",ariaLabel:i[c].ariaLabel?i[c].ariaLabel.default:void 0,iconImageUrl:l,visible:!0})}}return!r._SPKillSwitch.isActivated("38c1f92c-5240-42ea-9c8c-8485ae721247")&&a._commandArray.length&&a.serviceScope.whenFinished(function(){var e=a.serviceScope.consume(d.PageContext.serviceKey).cultureInfo.currentUICultureName;a._commandArray.forEach(function(t){var n=i[t.id];t.title=r.Text._getLocalizedString(n.title,e)||"",n.ariaLabel&&(t.ariaLabel=r.Text._getLocalizedString(n.ariaLabel,e))})}),a}return Object(i.__extends)(t,e),Object.defineProperty(t.prototype,"listView",{get:function(){return this._listView},enumerable:!1,configurable:!0}),Object.defineProperty(t.prototype,"_commands",{get:function(){return this._commandArray},enumerable:!1,configurable:!0}),t}(o.ExtensionContext),u=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(i.__extends)(t,e),t.prototype.onRenderCell=function(e){var t=""+e.fieldValue;e.fieldValue.innerText=t},t.prototype.onDisposeCell=function(e){},t}(o.BaseExtension),f=u,p=function(e){function t(t,n){var a=e.call(this,t)||this;return a._listView=n.listView,a._field=n.field,a}return Object(i.__extends)(t,e),t.prototype.tryGetListView=function(){return this._listView},Object.defineProperty(t.prototype,"field",{get:function(){return this._field},enumerable:!1,configurable:!0}),t}(o.ExtensionContext),m=function(){},_=function(){},h=function(e){function t(){return e.call(this)||this}return Object(i.__extends)(t,e),t}(m),b=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(i.__extends)(t,e),t}(r.SPEventArgs),g=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(i.__extends)(t,e),t}(r.SPEventArgs),v=function(){function e(t){this._isDisposed=!1,this._selectedRowsChangedEvent=new r.SPEvent(e._selectedRowsChangedEventName),this._listViewStateChangedEventName=""+e._listViewStateChangedEventName+(t||""),this._listViewStateChangedEvent=new r.SPEvent(this._listViewStateChangedEventName)}return Object.defineProperty(e.prototype,"selectedRowsChangedEvent",{get:function(){return this._selectedRowsChangedEvent},enumerable:!1,configurable:!0}),Object.defineProperty(e.prototype,"listViewStateChangedEvent",{get:function(){return this._listViewStateChangedEvent},enumerable:!1,configurable:!0}),e.prototype.dispose=function(){r._SPEventManager.instance.removeEvent(this._listViewStateChangedEventName),this._isDisposed=!0},Object.defineProperty(e.prototype,"isDisposed",{get:function(){return this._isDisposed},enumerable:!1,configurable:!0}),e._selectedRowsChangedEventName="listView.selectedRowsChanged",e._listViewStateChangedEventName="listView.stateChanged",e}();!function(e){e[e.None=0]="None",e[e.List=1]="List",e[e.View=2]="View",e[e.Columns=4]="Columns",e[e.SelectedRows=8]="SelectedRows",e[e.Rows=16]="Rows",e[e.AppliedFilters=32]="AppliedFilters",e[e.Sort=64]="Sort",e[e.FolderInfo=128]="FolderInfo"}(a||(a={}))}})});

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.18.15"
+      "packageVersion": "7.19.4"
     }
   ]
 }

package/lib-commonjs/commandSet/BaseListViewCommandSet.js

@@ -23,7 +23,12 @@ var BaseListViewCommandSet = /** @class */ (function (_super) {
      * @internal
      */
     function BaseListViewCommandSet() {
-        return _super.call(this) || this;
+        var _this = _super.call(this) || this;
+        /**
+         * @internal
+         */
+        _this._raiseOnChange = undefined; // provided by Command set adapter
+        return _this;
     }
     /**
      * Returns the command with the given id.
@@ -40,6 +45,8 @@ var BaseListViewCommandSet = /** @class */ (function (_super) {
      * virtual
      * @remarks
      * This event allows the implementor to tailor the visibility of the command.
+     *
+     * @deprecated Use context.listView.listViewStateChangedEvent instead.
      */
     BaseListViewCommandSet.prototype.onListViewUpdated = function (event) {
         // (implemented by child class)
@@ -52,6 +59,14 @@ var BaseListViewCommandSet = /** @class */ (function (_super) {
     BaseListViewCommandSet.prototype.onExecute = function (event) {
         // (implemented by child class)
     };
+    /**
+     * Use this method to fire OnChange event and initialize a reflow of the ListView.
+     */
+    BaseListViewCommandSet.prototype.raiseOnChange = function () {
+        if (this._raiseOnChange) {
+            this._raiseOnChange();
+        }
+    };
     return BaseListViewCommandSet;
 }(sp_extension_base_1.BaseExtension));
 exports.default = BaseListViewCommandSet;

package/lib-commonjs/common/ListViewAccessor.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SelectedRowsChangedEventArgs = exports.RowAccessor = exports.ColumnAccessor = void 0;
+exports.ListViewStateChangedEventArgs = exports.SelectedRowsChangedEventArgs = exports.RowAccessor = exports.ColumnAccessor = void 0;
 var tslib_1 = require("tslib");
 var sp_core_library_1 = require("@microsoft/sp-core-library");
 var ListItemAccessor_1 = tslib_1.__importDefault(require("./ListItemAccessor"));
@@ -63,6 +63,19 @@ var SelectedRowsChangedEventArgs = /** @class */ (function (_super) {
     return SelectedRowsChangedEventArgs;
 }(sp_core_library_1.SPEventArgs));
 exports.SelectedRowsChangedEventArgs = SelectedRowsChangedEventArgs;
+/**
+ * Arguments for the list view state changed event.
+ *
+ * @beta
+ */
+var ListViewStateChangedEventArgs = /** @class */ (function (_super) {
+    tslib_1.__extends(ListViewStateChangedEventArgs, _super);
+    function ListViewStateChangedEventArgs() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return ListViewStateChangedEventArgs;
+}(sp_core_library_1.SPEventArgs));
+exports.ListViewStateChangedEventArgs = ListViewStateChangedEventArgs;
 /**
  * Provides access to a SharePoint ListView control.
  *
@@ -72,8 +85,11 @@ var ListViewAccessor = /** @class */ (function () {
     /**
      * @internal
      */
-    function ListViewAccessor() {
+    function ListViewAccessor(eventPrefix) {
+        this._isDisposed = false;
         this._selectedRowsChangedEvent = new sp_core_library_1.SPEvent(ListViewAccessor._selectedRowsChangedEventName);
+        this._listViewStateChangedEventName = "" + ListViewAccessor._listViewStateChangedEventName + (eventPrefix || '');
+        this._listViewStateChangedEvent = new sp_core_library_1.SPEvent(this._listViewStateChangedEventName);
     }
     Object.defineProperty(ListViewAccessor.prototype, "selectedRowsChangedEvent", {
         /**
@@ -86,11 +102,48 @@ var ListViewAccessor = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    Object.defineProperty(ListViewAccessor.prototype, "listViewStateChangedEvent", {
+        /**
+         * Event that gets raised every time the list view state changes.
+         *
+         * @beta
+         * @eventproperty
+         */
+        get: function () {
+            return this._listViewStateChangedEvent;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * @internal
+     */
+    ListViewAccessor.prototype.dispose = function () {
+        sp_core_library_1._SPEventManager.instance.removeEvent(this._listViewStateChangedEventName);
+        this._isDisposed = true;
+    };
+    Object.defineProperty(ListViewAccessor.prototype, "isDisposed", {
+        /**
+         * @internal
+         */
+        get: function () {
+            return this._isDisposed;
+        },
+        enumerable: false,
+        configurable: true
+    });
     /**
      * SPEvent name when the selected rows in a list have changed.
+     *
      * @internal
      */
     ListViewAccessor._selectedRowsChangedEventName = 'listView.selectedRowsChanged';
+    /**
+     * SPEvent name when the list view state has changed.
+     *
+     * @internal
+     */
+    ListViewAccessor._listViewStateChangedEventName = 'listView.stateChanged';
     return ListViewAccessor;
 }());
 exports.default = ListViewAccessor;

package/lib-commonjs/common/ListViewAccessorState.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListViewAccessorStateChanges = void 0;
+/**
+ * Describes the type of list view state changes.
+ *
+ * @beta
+ */
+var ListViewAccessorStateChanges;
+(function (ListViewAccessorStateChanges) {
+    ListViewAccessorStateChanges[ListViewAccessorStateChanges["None"] = 0] = "None";
+    ListViewAccessorStateChanges[ListViewAccessorStateChanges["List"] = 1] = "List";
+    ListViewAccessorStateChanges[ListViewAccessorStateChanges["View"] = 2] = "View";
+    ListViewAccessorStateChanges[ListViewAccessorStateChanges["Columns"] = 4] = "Columns";
+    ListViewAccessorStateChanges[ListViewAccessorStateChanges["SelectedRows"] = 8] = "SelectedRows";
+    ListViewAccessorStateChanges[ListViewAccessorStateChanges["Rows"] = 16] = "Rows";
+    ListViewAccessorStateChanges[ListViewAccessorStateChanges["AppliedFilters"] = 32] = "AppliedFilters";
+    ListViewAccessorStateChanges[ListViewAccessorStateChanges["Sort"] = 64] = "Sort";
+    ListViewAccessorStateChanges[ListViewAccessorStateChanges["FolderInfo"] = 128] = "FolderInfo";
+})(ListViewAccessorStateChanges = exports.ListViewAccessorStateChanges || (exports.ListViewAccessorStateChanges = {}));
+//# sourceMappingURL=ListViewAccessorState.js.map

package/lib-commonjs/index.js

@@ -21,5 +21,8 @@ var ListViewAccessor_1 = require("./common/ListViewAccessor");
 Object.defineProperty(exports, "ColumnAccessor", { enumerable: true, get: function () { return ListViewAccessor_1.ColumnAccessor; } });
 Object.defineProperty(exports, "RowAccessor", { enumerable: true, get: function () { return ListViewAccessor_1.RowAccessor; } });
 Object.defineProperty(exports, "SelectedRowsChangedEventArgs", { enumerable: true, get: function () { return ListViewAccessor_1.SelectedRowsChangedEventArgs; } });
+Object.defineProperty(exports, "ListViewStateChangedEventArgs", { enumerable: true, get: function () { return ListViewAccessor_1.ListViewStateChangedEventArgs; } });
 Object.defineProperty(exports, "ListViewAccessor", { enumerable: true, get: function () { return ListViewAccessor_1.default; } });
+var ListViewAccessorState_1 = require("./common/ListViewAccessorState");
+Object.defineProperty(exports, "ListViewAccessorStateChanges", { enumerable: true, get: function () { return ListViewAccessorState_1.ListViewAccessorStateChanges; } });
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/sp-listview-extensibility",
-  "version": "1.14.0-beta.4",
+  "version": "1.14.0-beta.5",
   "description": "SharePoint Framework developer support for customizing the list view",
   "license": "UNLICENSED",
   "main": "lib-commonjs/index.js",
@@ -10,10 +10,10 @@
     "tsdocFlavor": "AEDoc"
   },
   "dependencies": {
-    "@microsoft/sp-core-library": "1.14.0-beta.4",
-    "@microsoft/sp-extension-base": "1.14.0-beta.4",
-    "@microsoft/sp-module-interfaces": "1.14.0-beta.4",
-    "@microsoft/sp-page-context": "1.14.0-beta.4",
+    "@microsoft/sp-core-library": "1.14.0-beta.5",
+    "@microsoft/sp-extension-base": "1.14.0-beta.5",
+    "@microsoft/sp-module-interfaces": "1.14.0-beta.5",
+    "@microsoft/sp-page-context": "1.14.0-beta.5",
     "tslib": "~1.10.0"
   },
   "scripts": {},

package/dist/sp-listview-extensibility_none_7c3cbbaef8efd67369bb.js

@@ -1 +0,0 @@
-define("d37b65ee-c7d8-4570-bc74-2b294ff3b380_1.14.0",["tslib","@microsoft/sp-core-library","@microsoft/sp-page-context","@microsoft/sp-extension-base"],function(n,a,i,r){return function(e){var t={};function n(a){if(t[a])return t[a].exports;var i=t[a]={i:a,l:!1,exports:{}};return e[a].call(i.exports,i,i.exports,n),i.l=!0,i.exports}return n.m=e,n.c=t,n.d=function(e,t,a){n.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:a})},n.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},n.t=function(e,t){if(1&t&&(e=n(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var a=Object.create(null);if(n.r(a),Object.defineProperty(a,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var i in e)n.d(a,i,function(t){return e[t]}.bind(null,i));return a},n.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return n.d(t,"a",t),t},n.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},n.p="",n(n.s="mwqp")}({"17wl":function(e,t){e.exports=n},UWqr:function(e,t){e.exports=a},"X+PM":function(e,t){e.exports=i},ZFc5:function(e,t){e.exports=r},mwqp:function(e,t,n){"use strict";n.r(t),n.d(t,"BaseListViewCommandSet",function(){return o}),n.d(t,"Command",function(){return s}),n.d(t,"ListViewCommandSetContext",function(){return d}),n.d(t,"BaseFieldCustomizer",function(){return l}),n.d(t,"FieldCustomizerContext",function(){return u}),n.d(t,"ListItemAccessor",function(){return f}),n.d(t,"ColumnAccessor",function(){return p}),n.d(t,"RowAccessor",function(){return m}),n.d(t,"SelectedRowsChangedEventArgs",function(){return _}),n.d(t,"ListViewAccessor",function(){return h});var a=n("17wl"),i=n("UWqr"),r=n("ZFc5"),o=function(e){function t(){return e.call(this)||this}return Object(a.__extends)(t,e),t.prototype.tryGetCommand=function(e){return i.Validate.isNonemptyString(e,"id"),this.context._commands.filter(function(t){return t.id===e})[0]},t.prototype.onListViewUpdated=function(e){},t.prototype.onExecute=function(e){},t}(r.BaseExtension),s=function(){},c=n("X+PM"),d=function(e){function t(t,n){var a=e.call(this,t)||this;a._listView=n.listView,a._commandArray=[];for(var r=a.manifest.items,o=0,s=Object.keys(r);o<s.length;o++){var d=s[o];if("command"===r[d].type){var l=r[d].iconImageUrl;l&&!i.UrlUtilities.isDataUrl(l)&&(l=i.UrlUtilities.resolve(l,a.manifest.loaderConfig.internalModuleBaseUrls[0])),a._commandArray.push({id:d,title:r[d].title.default||"",ariaLabel:r[d].ariaLabel?r[d].ariaLabel.default:void 0,iconImageUrl:l,visible:!0})}}return!i._SPKillSwitch.isActivated("38c1f92c-5240-42ea-9c8c-8485ae721247")&&a._commandArray.length&&a.serviceScope.whenFinished(function(){var e=a.serviceScope.consume(c.PageContext.serviceKey).cultureInfo.currentUICultureName;a._commandArray.forEach(function(t){var n=r[t.id];t.title=i.Text._getLocalizedString(n.title,e)||"",n.ariaLabel&&(t.ariaLabel=i.Text._getLocalizedString(n.ariaLabel,e))})}),a}return Object(a.__extends)(t,e),Object.defineProperty(t.prototype,"listView",{get:function(){return this._listView},enumerable:!1,configurable:!0}),Object.defineProperty(t.prototype,"_commands",{get:function(){return this._commandArray},enumerable:!1,configurable:!0}),t}(r.ExtensionContext),l=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(a.__extends)(t,e),t.prototype.onRenderCell=function(e){var t=""+e.fieldValue;e.fieldValue.innerText=t},t.prototype.onDisposeCell=function(e){},t}(r.BaseExtension),u=function(e){function t(t,n){var a=e.call(this,t)||this;return a._listView=n.listView,a._field=n.field,a}return Object(a.__extends)(t,e),t.prototype.tryGetListView=function(){return this._listView},Object.defineProperty(t.prototype,"field",{get:function(){return this._field},enumerable:!1,configurable:!0}),t}(r.ExtensionContext),f=function(){},p=function(){},m=function(e){function t(){return e.call(this)||this}return Object(a.__extends)(t,e),t}(f),_=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(a.__extends)(t,e),t}(i.SPEventArgs),h=function(){function e(){this._selectedRowsChangedEvent=new i.SPEvent(e._selectedRowsChangedEventName)}return Object.defineProperty(e.prototype,"selectedRowsChangedEvent",{get:function(){return this._selectedRowsChangedEvent},enumerable:!1,configurable:!0}),e._selectedRowsChangedEventName="listView.selectedRowsChanged",e}()}})});