@microsoft/sp-listview-extensibility 1.22.0-beta.1 → 1.22.0-beta.3

package/lib/commandSet/BaseListViewCommandSet.d.ts

@@ -0,0 +1,82 @@
+import { BaseExtension } from '@microsoft/sp-extension-base';
+import type ListViewCommandSetContext from './ListViewCommandSetContext';
+import type Command from './Command';
+import type { RowAccessor } from '../common/ListViewAccessor';
+/**
+ * Parameters for {@link BaseListViewCommandSet.onListViewUpdated}
+ *
+ * @public
+ */
+export interface IListViewCommandSetListViewUpdatedParameters {
+    /**
+     * The currently selected ListView rows, at the time when the event occurred.
+     */
+    readonly selectedRows: ReadonlyArray<RowAccessor>;
+}
+/**
+ * Parameters for {@link BaseListViewCommandSet.onExecute}
+ *
+ * @public
+ */
+export interface IListViewCommandSetExecuteEventParameters {
+    /**
+     * The unique identifier for the command.  This is specified as ICommandDefinition.commandId
+     * in the component manifest.
+     */
+    readonly itemId: string;
+    /**
+     * The currently selected ListView rows, at the time when the event occurred.
+     */
+    readonly selectedRows: ReadonlyArray<RowAccessor>;
+}
+/**
+ * This is the base class that third parties should extend when implementing
+ * a client-side extension that provides a command set for a SharePoint list view.
+ *
+ * @remarks
+ * In the component manifest, the "extensionType" should be set to "ListViewCommandSet".
+ *
+ * @privateRemarks
+ *
+ * Eventually other command set classes will be introduced, and then we will introduce a base class
+ * so the hierarchy goes `BaseListViewCommandSet <- BaseCommandSet <- BaseExtension <- BaseComponent`.
+ *
+ * @public
+ */
+declare abstract class BaseListViewCommandSet<TProperties> extends BaseExtension<TProperties> {
+    /**
+     * {@inheritDoc @microsoft/sp-extension-base#BaseExtension.context}
+     */
+    readonly context: ListViewCommandSetContext;
+    /**
+     * @internal
+     */
+    _raiseOnChange?: () => void;
+    /**
+     * Returns the command with the given id.
+     * Returns undefined if there is not command with the given id.
+     * @param id - Id of the command
+     */
+    tryGetCommand(id: string): Command;
+    /**
+     * This event occurs whenever the ListView state changes.
+     * virtual
+     * @remarks
+     * This event allows the implementor to tailor the visibility of the command.
+     *
+     * @deprecated Use context.listView.listViewStateChangedEvent instead.
+     */
+    onListViewUpdated(event: IListViewCommandSetListViewUpdatedParameters): void;
+    /**
+     * This event occurs when the command is invoked, e.g. because the user
+     * clicked on the toolbar button or menu item.
+     * virtual
+     */
+    onExecute(event: IListViewCommandSetExecuteEventParameters): void;
+    /**
+     * Use this method to fire OnChange event and initialize a reflow of the ListView.
+     */
+    raiseOnChange(): void;
+}
+export default BaseListViewCommandSet;
+//# sourceMappingURL=BaseListViewCommandSet.d.ts.map

package/lib/commandSet/BaseListViewCommandSet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseListViewCommandSet.d.ts","sourceRoot":"","sources":["../../src/commandSet/BaseListViewCommandSet.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAE7D,OAAO,KAAK,yBAAyB,MAAM,6BAA6B,CAAC;AACzE,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AAErC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAE9D;;;;GAIG;AACH,MAAM,WAAW,4CAA4C;IAC3D;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC;CACnD;AAED;;;;GAIG;AACH,MAAM,WAAW,yCAAyC;IACxD;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC;CACnD;AAED;;;;;;;;;;;;;GAaG;AACH,uBAAe,sBAAsB,CAAC,WAAW,CAAE,SAAQ,aAAa,CAAC,WAAW,CAAC;IACnF;;OAEG;IAEH,SAAgB,OAAO,EAAG,yBAAyB,CAAC;IAEpD;;OAEG;IACI,cAAc,CAAC,EAAE,MAAM,IAAI,CAAa;IAE/C;;;;OAIG;IACI,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAMzC;;;;;;;OAOG;IACI,iBAAiB,CAAC,KAAK,EAAE,4CAA4C,GAAG,IAAI;IAInF;;;;OAIG;IACI,SAAS,CAAC,KAAK,EAAE,yCAAyC,GAAG,IAAI;IAIxE;;OAEG;IACI,aAAa,IAAI,IAAI;CAK7B;AAED,eAAe,sBAAsB,CAAC"}

package/lib/commandSet/BaseListViewCommandSet.js

@@ -0,0 +1,68 @@
+import { __extends } from "tslib";
+import { Validate } from '@microsoft/sp-core-library';
+import { BaseExtension } from '@microsoft/sp-extension-base';
+/**
+ * This is the base class that third parties should extend when implementing
+ * a client-side extension that provides a command set for a SharePoint list view.
+ *
+ * @remarks
+ * In the component manifest, the "extensionType" should be set to "ListViewCommandSet".
+ *
+ * @privateRemarks
+ *
+ * Eventually other command set classes will be introduced, and then we will introduce a base class
+ * so the hierarchy goes `BaseListViewCommandSet <- BaseCommandSet <- BaseExtension <- BaseComponent`.
+ *
+ * @public
+ */
+var BaseListViewCommandSet = /** @class */ (function (_super) {
+    __extends(BaseListViewCommandSet, _super);
+    function BaseListViewCommandSet() {
+        var _this = _super !== null && _super.apply(this, arguments) || this;
+        /**
+         * @internal
+         */
+        _this._raiseOnChange = undefined; // provided by Command set adapter
+        return _this;
+    }
+    /**
+     * Returns the command with the given id.
+     * Returns undefined if there is not command with the given id.
+     * @param id - Id of the command
+     */
+    BaseListViewCommandSet.prototype.tryGetCommand = function (id) {
+        Validate.isNonemptyString(id, 'id');
+        var commands = this.context._commands.filter(function (command) { return command.id === id; });
+        return commands[0];
+    };
+    /**
+     * This event occurs whenever the ListView state changes.
+     * 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)
+    };
+    /**
+     * This event occurs when the command is invoked, e.g. because the user
+     * clicked on the toolbar button or menu item.
+     * virtual
+     */
+    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;
+}(BaseExtension));
+export default BaseListViewCommandSet;
+//# sourceMappingURL=BaseListViewCommandSet.js.map

package/lib/commandSet/Command.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Represents a command belonging to a command set.
+ *
+ * @remarks
+ * The BaseListViewCommandSet extension type exposes generalized commands that may be displayed as tool bar buttons,
+ * context menu items, etc. These commands are initially defined in the extension's manifest file. At runtime, the
+ * corresponding Command object can be obtained by calling {@link BaseListViewCommandSet.tryGetCommand}.
+ * The command's appearance can be customized by assigning its properties, for example to hide a command that is not
+ * contextually relevant, or to pluralize the title based on the number of selected items.
+ * @public
+ */
+export default class Command {
+    /**
+     * Id of the command.
+     */
+    id: string;
+    /**
+     * A short label to be displayed by the associated button, menu item, etc.
+     * @remarks
+     * Example: "Show information"
+     *
+     * Altering the title property is intended to allow minor changes to the title, e.g. “Submit these 3 items” or
+     * toggling between “Schedule” and “Unschedule”. Developers are discouraged from assigning a title that radically
+     * alters the meaning of the command, because administrators should be able to examine the extension manifest to
+     * understand which commands are being implemented by a given extension.
+     */
+    title: string;
+    /**
+     * An optional URL for an image to be displayed next to the command. The requirements for this image
+     * are defined by the type of extension; some extension types may not display the image at all.
+     *
+     * @remarks
+     * This must be a absolute URL.
+     */
+    iconImageUrl: string | undefined;
+    /**
+     * Custom accessibility text for the browser's "aria-label" attribute.  If omitted, the title property
+     * will be used by default.
+     * Example: "Show information.  Press ENTER to select."
+     */
+    ariaLabel: string | undefined;
+    /**
+     * True if the command is visible.
+     */
+    visible: boolean;
+    /**
+     * Whether the command is currently disabled.
+     */
+    disabled: boolean | undefined;
+}
+//# sourceMappingURL=Command.d.ts.map

package/lib/commandSet/Command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Command.d.ts","sourceRoot":"","sources":["../../src/commandSet/Command.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,MAAM,CAAC,OAAO,OAAO,OAAO;IAC1B;;OAEG;IACI,EAAE,EAAG,MAAM,CAAC;IAEnB;;;;;;;;;OASG;IACI,KAAK,EAAG,MAAM,CAAC;IAEtB;;;;;;OAMG;IACI,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAExC;;;;OAIG;IACI,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAErC;;OAEG;IACI,OAAO,EAAG,OAAO,CAAC;IAEzB;;OAEG;IACI,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;CACtC"}

package/lib/commandSet/Command.js

@@ -0,0 +1,18 @@
+/**
+ * Represents a command belonging to a command set.
+ *
+ * @remarks
+ * The BaseListViewCommandSet extension type exposes generalized commands that may be displayed as tool bar buttons,
+ * context menu items, etc. These commands are initially defined in the extension's manifest file. At runtime, the
+ * corresponding Command object can be obtained by calling {@link BaseListViewCommandSet.tryGetCommand}.
+ * The command's appearance can be customized by assigning its properties, for example to hide a command that is not
+ * contextually relevant, or to pluralize the title based on the number of selected items.
+ * @public
+ */
+var Command = /** @class */ (function () {
+    function Command() {
+    }
+    return Command;
+}());
+export default Command;
+//# sourceMappingURL=Command.js.map

package/lib/commandSet/ListViewCommandSetContext.d.ts

@@ -0,0 +1,43 @@
+import { ExtensionContext, type _IExtensionContextParameters } from '@microsoft/sp-extension-base';
+import type { ICommandSetExtensionManifest } from '@microsoft/sp-module-interfaces';
+import type ListViewAccessor from '../common/ListViewAccessor';
+import type Command from './Command';
+/**
+ * Constructor parameters for `ListViewCommandSetContext`.
+ *
+ * @internal
+ */
+export interface IListViewCommandSetContextParameters {
+    readonly listView: ListViewAccessor;
+}
+/**
+ * This object provides contextual information for BaseListViewCommandSet.
+ * @public
+ */
+export default class ListViewCommandSetContext extends ExtensionContext {
+    /**
+     * {@inheritDoc @microsoft/sp-component-base#BaseComponentContext.manifest}
+     */
+    readonly manifest: ICommandSetExtensionManifest;
+    private _listView;
+    private _commandArray;
+    /**
+     * @internal
+     */
+    constructor(extensionContextParameters: _IExtensionContextParameters, listViewCommandSetContextParameters: IListViewCommandSetContextParameters);
+    /**
+     * Provides access to the ListView control that the customizer will operate on.
+     */
+    get listView(): ListViewAccessor;
+    /**
+     * Returns an array with all commands.
+     *
+     * @privateRemarks
+     * In the future commands won't be a flat list. This allows us to get all commands together, so we can
+     * provide a straight-forward API tryGetCommand in the BaseListViewCommandSet itself.
+     *
+     * @internal
+     */
+    get _commands(): ReadonlyArray<Command>;
+}
+//# sourceMappingURL=ListViewCommandSetContext.d.ts.map

package/lib/commandSet/ListViewCommandSetContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ListViewCommandSetContext.d.ts","sourceRoot":"","sources":["../../src/commandSet/ListViewCommandSetContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,KAAK,4BAA4B,EAAE,MAAM,8BAA8B,CAAC;AACnG,OAAO,KAAK,EACV,4BAA4B,EAG7B,MAAM,iCAAiC,CAAC;AAGzC,OAAO,KAAK,gBAAgB,MAAM,4BAA4B,CAAC;AAC/D,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AAGrC;;;;GAIG;AACH,MAAM,WAAW,oCAAoC;IACnD,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;CACrC;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,yBAA0B,SAAQ,gBAAgB;IACrE;;OAEG;IACH,SAAgB,QAAQ,EAAG,4BAA4B,CAAC;IACxD,OAAO,CAAC,SAAS,CAAmB;IACpC,OAAO,CAAC,aAAa,CAAY;IAEjC;;OAEG;gBAED,0BAA0B,EAAE,4BAA4B,EACxD,mCAAmC,EAAE,oCAAoC;IAiD3E;;OAEG;IACH,IAAW,QAAQ,IAAI,gBAAgB,CAEtC;IAED;;;;;;;;OAQG;IACH,IAAW,SAAS,IAAI,aAAa,CAAC,OAAO,CAAC,CAE7C;CACF"}

package/lib/commandSet/ListViewCommandSetContext.js

@@ -0,0 +1,84 @@
+import { __extends } from "tslib";
+import { ExtensionContext } from '@microsoft/sp-extension-base';
+import { Text, UrlUtilities } from '@microsoft/sp-core-library';
+import { PageContext } from '@microsoft/sp-page-context';
+/**
+ * This object provides contextual information for BaseListViewCommandSet.
+ * @public
+ */
+var ListViewCommandSetContext = /** @class */ (function (_super) {
+    __extends(ListViewCommandSetContext, _super);
+    /**
+     * @internal
+     */
+    function ListViewCommandSetContext(extensionContextParameters, listViewCommandSetContextParameters) {
+        var _this = _super.call(this, extensionContextParameters) || this;
+        _this._listView = listViewCommandSetContextParameters.listView;
+        _this._commandArray = [];
+        var itemsMap = _this.manifest.items;
+        for (var _i = 0, _a = Object.keys(itemsMap); _i < _a.length; _i++) {
+            var itemId = _a[_i];
+            // Future proof for grouping
+            if (itemsMap[itemId].type === 'command') {
+                var iconUrl = itemsMap[itemId].iconImageUrl;
+                if (iconUrl && !UrlUtilities.isDataUrl(iconUrl)) {
+                    iconUrl = UrlUtilities.resolve(iconUrl, _this.manifest.loaderConfig.internalModuleBaseUrls[0]);
+                }
+                _this._commandArray.push({
+                    id: itemId,
+                    title: itemsMap[itemId].title.default || '',
+                    ariaLabel: itemsMap[itemId].ariaLabel
+                        ? itemsMap[itemId].ariaLabel.default
+                        : undefined,
+                    iconImageUrl: iconUrl,
+                    visible: true,
+                    disabled: undefined
+                });
+            }
+        }
+        // updating title and ariaLabel based on UI culture
+        if (_this._commandArray.length) {
+            _this.serviceScope.whenFinished(function () {
+                var pageContext = _this.serviceScope.consume(PageContext.serviceKey);
+                var currentUICulture = pageContext.cultureInfo.currentUICultureName;
+                _this._commandArray.forEach(function (command) {
+                    var item = itemsMap[command.id];
+                    command.title = Text._getLocalizedString(item.title, currentUICulture) || '';
+                    if (item.ariaLabel) {
+                        command.ariaLabel = Text._getLocalizedString(item.ariaLabel, currentUICulture);
+                    }
+                });
+            });
+        }
+        return _this;
+    }
+    Object.defineProperty(ListViewCommandSetContext.prototype, "listView", {
+        /**
+         * Provides access to the ListView control that the customizer will operate on.
+         */
+        get: function () {
+            return this._listView;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ListViewCommandSetContext.prototype, "_commands", {
+        /**
+         * Returns an array with all commands.
+         *
+         * @privateRemarks
+         * In the future commands won't be a flat list. This allows us to get all commands together, so we can
+         * provide a straight-forward API tryGetCommand in the BaseListViewCommandSet itself.
+         *
+         * @internal
+         */
+        get: function () {
+            return this._commandArray;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    return ListViewCommandSetContext;
+}(ExtensionContext));
+export default ListViewCommandSetContext;
+//# sourceMappingURL=ListViewCommandSetContext.js.map

package/lib/common/IListItem.d.ts

@@ -0,0 +1,9 @@
+import type { IODataListItem } from '@microsoft/sp-odata-types';
+/**
+ * @public
+ *
+ * Represents an SP.ListItem data (OData).
+ */
+export interface IListItem extends IODataListItem {
+}
+//# sourceMappingURL=IListItem.d.ts.map

package/lib/common/IListItem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IListItem.d.ts","sourceRoot":"","sources":["../../src/common/IListItem.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAEhE;;;;GAIG;AACH,MAAM,WAAW,SAAU,SAAQ,cAAc;CAAG"}

package/lib/common/IListItem.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IListItem.js.map

package/lib/common/ListItemAccessor.d.ts

@@ -0,0 +1,42 @@
+import type { SPField } from '@microsoft/sp-page-context';
+/**
+ * When a field customizer extension is rendering a field, the ListItemAccessor provides
+ * access to the associated SharePoint list item.
+ *
+ * @remarks
+ *
+ * ListItemAccessor allows a field customizer extension to determine which fields are available
+ * in the editor and retrieve the current values for those fields.  In the future, it may
+ * also support validation and editing operations.
+ *
+ * When the editor is the SharePoint list view, the ListViewAccessor uses the RowAccessor
+ * subclass instead of the ListItemAccessor base class.  This allows additional functionality
+ * to be exposed, for example determining whether the associated table row is selected or not.
+ *
+ * @public
+ */
+export default abstract class ListItemAccessor {
+    /** @internal */
+    constructor();
+    /**
+     * The SharePoint fields that are currently available in the editor for this list item.
+     *
+     * @remarks
+     * The set of available fields depends on the editing context.  For example, if a list view
+     * column is hidden, the corresponding field definition may not be loaded.  Field customizers
+     * should not assume that a given field will be available, even if it is defined in the
+     * content type.
+     */
+    abstract get fields(): ReadonlyArray<SPField>;
+    /**
+     * Retrieves the current data value for the field with the specified internal name.
+     * The value will be a primitive JavaScript object such as a string, number, etc.
+     */
+    abstract getValueByName(internalName: string): any;
+    /**
+     * Retrieves the current data value for the specified field.
+     * The value will be a primitive JavaScript object such as a string, number, etc.
+     */
+    abstract getValue(field: SPField): any;
+}
+//# sourceMappingURL=ListItemAccessor.d.ts.map

package/lib/common/ListItemAccessor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ListItemAccessor.d.ts","sourceRoot":"","sources":["../../src/common/ListItemAccessor.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAE1D;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,gBAAgB;IAC5C,gBAAgB;;IAKhB;;;;;;;;OAQG;IACH,aAAoB,MAAM,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;IAErD;;;OAGG;aAEa,cAAc,CAAC,YAAY,EAAE,MAAM,GAAG,GAAG;IAEzD;;;OAGG;aAEa,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,GAAG;CAC9C"}

package/lib/common/ListItemAccessor.js

@@ -0,0 +1,25 @@
+/**
+ * When a field customizer extension is rendering a field, the ListItemAccessor provides
+ * access to the associated SharePoint list item.
+ *
+ * @remarks
+ *
+ * ListItemAccessor allows a field customizer extension to determine which fields are available
+ * in the editor and retrieve the current values for those fields.  In the future, it may
+ * also support validation and editing operations.
+ *
+ * When the editor is the SharePoint list view, the ListViewAccessor uses the RowAccessor
+ * subclass instead of the ListItemAccessor base class.  This allows additional functionality
+ * to be exposed, for example determining whether the associated table row is selected or not.
+ *
+ * @public
+ */
+var ListItemAccessor = /** @class */ (function () {
+    /** @internal */
+    function ListItemAccessor() {
+        // (mark constructor as internal)
+    }
+    return ListItemAccessor;
+}());
+export default ListItemAccessor;
+//# sourceMappingURL=ListItemAccessor.js.map

package/lib/common/ListViewAccessor.d.ts

@@ -0,0 +1,168 @@
+import type { SPField } from '@microsoft/sp-page-context';
+import { type IDisposable, SPEvent, SPEventArgs } from '@microsoft/sp-core-library';
+import ListItemAccessor from './ListItemAccessor';
+import type { IFilter, IFolderInfo, IList, IListViewAccessorState, IView, ListViewAccessorStateChanges } from './ListViewAccessorState';
+/**
+ * Provides access to a ListView column, which is the visual presentation
+ * of a field.
+ *
+ * @remarks
+ *
+ * A SharePoint "field" (SPField) defines the data storage for a property of a list item.
+ * (If the list item represents a document, then the field is sometimes called a "property".)
+ *
+ * A "column" is the visual presentation of a field, when displayed by the ListView.
+ *
+ * @public
+ */
+export declare abstract class ColumnAccessor {
+    /** @internal */
+    constructor();
+    /**
+     * The server-side definition of the field.
+     * This property is read-only.
+     */
+    abstract get field(): SPField;
+    /**
+     * Whether to show this column in the list view.
+     * This property is read-only.
+     */
+    abstract get visible(): boolean;
+}
+/**
+ * Provides access to a ListView row, which is the visual presentation
+ * of a SharePoint list item.
+ *
+ * @remarks
+ *
+ * A SharePoint "list item" (SPListItem) is a data storage record in the content
+ * management system; it stores an array of values for the associated fields.
+ *
+ * A "row" is the visual presentation of a list item, when displayed by the ListView;
+ * it stores an array of cell values for the associated columns.
+ *
+ * @public
+ */
+export declare abstract class RowAccessor extends ListItemAccessor {
+    /**
+     * @internal
+     */
+    constructor();
+}
+/**
+ * Arguments for the selected rows changed event.
+ *
+ * @public
+ */
+export declare class SelectedRowsChangedEventArgs extends SPEventArgs {
+    /**
+     * The list of rows that were selected in the list view at the time when the event was fired.
+     */
+    selectedRows: ReadonlyArray<RowAccessor>;
+}
+/**
+ * Arguments for the list view state changed event.
+ *
+ * @public
+ */
+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 SharePoint ListView control.
+ *
+ * @public
+ */
+declare abstract class ListViewAccessor implements IDisposable {
+    /**
+     * SPEvent name when the selected rows in a list have changed.
+     *
+     * @internal
+     */
+    static _selectedRowsChangedEventName: string;
+    /**
+     * SPEvent name when the list view state has changed.
+     *
+     * @internal
+     */
+    static _listViewStateChangedEventName: string;
+    private _selectedRowsChangedEvent;
+    private _listViewStateChangedEvent;
+    private readonly _listViewStateChangedEventName;
+    private _isDisposed;
+    /**
+     * @internal
+     */
+    constructor(eventPrefix?: string);
+    /**
+     * The columns in associated with this view, including hidden columns.
+     */
+    abstract get columns(): ReadonlyArray<ColumnAccessor>;
+    /**
+     * Currently rendered rows in the list view.
+     */
+    abstract get rows(): ReadonlyArray<RowAccessor>;
+    /**
+     * Selected rows in the list view.
+     */
+    abstract get selectedRows(): ReadonlyArray<RowAccessor> | undefined;
+    /**
+     * Basic information about the list rendered by the list view.
+     */
+    abstract get list(): IList | undefined;
+    /**
+     * Basic information about the view rendered by the list view.
+     */
+    abstract get view(): IView | undefined;
+    /**
+     * Folder information for the list view.
+     */
+    abstract get folderInfo(): IFolderInfo | undefined;
+    /**
+     * Filters applied to the list view.
+     */
+    abstract get appliedFilters(): {
+        [fieldName: string]: IFilter;
+    } | undefined;
+    /**
+     * Sort field name
+     */
+    abstract get sortField(): string | undefined;
+    /**
+     * Specifies whether the list view is sorted ascending or descending.
+     */
+    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.
+     */
+    abstract tryGetColumnByName(internalName: string): ColumnAccessor | undefined;
+    /**
+     * Event that gets raised every time the selected items in the list view change.
+     * @eventproperty
+     */
+    get selectedRowsChangedEvent(): SPEvent<SelectedRowsChangedEventArgs>;
+    /**
+     * Event that gets raised every time the list view state changes.
+     *
+     * @eventproperty
+     */
+    get listViewStateChangedEvent(): SPEvent<ListViewStateChangedEventArgs>;
+    /**
+     * @internal
+     */
+    dispose(): void;
+    /**
+     * @internal
+     */
+    get isDisposed(): boolean;
+}
+export default ListViewAccessor;
+//# sourceMappingURL=ListViewAccessor.d.ts.map

package/lib/common/ListViewAccessor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ListViewAccessor.d.ts","sourceRoot":"","sources":["../../src/common/ListViewAccessor.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,KAAK,WAAW,EAAE,OAAO,EAAE,WAAW,EAAmB,MAAM,4BAA4B,CAAC;AACrG,OAAO,gBAAgB,MAAM,oBAAoB,CAAC;AAClD,OAAO,KAAK,EACV,OAAO,EACP,WAAW,EACX,KAAK,EACL,sBAAsB,EACtB,KAAK,EACL,4BAA4B,EAC7B,MAAM,yBAAyB,CAAC;AAEjC;;;;;;;;;;;;GAYG;AACH,8BAAsB,cAAc;IAClC,gBAAgB;;IAKhB;;;OAGG;IACH,aAAoB,KAAK,IAAI,OAAO,CAAC;IAErC;;;OAGG;IACH,aAAoB,OAAO,IAAI,OAAO,CAAC;CACxC;AAED;;;;;;;;;;;;;GAaG;AACH,8BAAsB,WAAY,SAAQ,gBAAgB;IACxD;;OAEG;;CAIJ;AAED;;;;GAIG;AACH,qBAAa,4BAA6B,SAAQ,WAAW;IAC3D;;OAEG;IACI,YAAY,EAAG,aAAa,CAAC,WAAW,CAAC,CAAC;CAClD;AAED;;;;GAIG;AACH,qBAAa,6BAA8B,SAAQ,WAAW;IAC5D;;OAEG;IACI,SAAS,EAAG,QAAQ,CAAC,sBAAsB,CAAC,CAAC;IACpD;;OAEG;IACI,YAAY,EAAG,4BAA4B,CAAC;CACpD;AAED;;;;GAIG;AACH,uBAAe,gBAAiB,YAAW,WAAW;IACpD;;;;OAIG;IACH,OAAc,6BAA6B,EAAE,MAAM,CAAkC;IAErF;;;;OAIG;IACH,OAAc,8BAA8B,EAAE,MAAM,CAA2B;IAE/E,OAAO,CAAC,yBAAyB,CAAwC;IACzE,OAAO,CAAC,0BAA0B,CAAyC;IAC3E,OAAO,CAAC,QAAQ,CAAC,8BAA8B,CAAS;IAExD,OAAO,CAAC,WAAW,CAAkB;IAErC;;OAEG;gBACgB,WAAW,CAAC,EAAE,MAAM;IAcvC;;OAEG;IACH,aAAoB,OAAO,IAAI,aAAa,CAAC,cAAc,CAAC,CAAC;IAE7D;;OAEG;IACH,aAAoB,IAAI,IAAI,aAAa,CAAC,WAAW,CAAC,CAAC;IAEvD;;OAEG;IACH,aAAoB,YAAY,IAAI,aAAa,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;IAE3E;;OAEG;IACH,aAAoB,IAAI,IAAI,KAAK,GAAG,SAAS,CAAC;IAE9C;;OAEG;IACH,aAAoB,IAAI,IAAI,KAAK,GAAG,SAAS,CAAC;IAE9C;;OAEG;IACH,aAAoB,UAAU,IAAI,WAAW,GAAG,SAAS,CAAC;IAE1D;;OAEG;IACH,aAAoB,cAAc,IAAI;QAAE,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,SAAS,CAAC;IAEnF;;OAEG;IACH,aAAoB,SAAS,IAAI,MAAM,GAAG,SAAS,CAAC;IAEpD;;OAEG;IACH,aAAoB,aAAa,IAAI,OAAO,GAAG,SAAS,CAAC;IAEzD;;;OAGG;aACa,kBAAkB,CAAC,YAAY,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAEpF;;;OAGG;IACH,IAAW,wBAAwB,IAAI,OAAO,CAAC,4BAA4B,CAAC,CAE3E;IAED;;;;OAIG;IACH,IAAW,yBAAyB,IAAI,OAAO,CAAC,6BAA6B,CAAC,CAE7E;IAED;;OAEG;IACI,OAAO,IAAI,IAAI;IAKtB;;OAEG;IACH,IAAW,UAAU,IAAI,OAAO,CAE/B;CACF;AAED,eAAe,gBAAgB,CAAC"}