@microsoft/sp-listview-extensibility 1.14.0-beta.5 → 1.14.0-rc.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/d37b65ee-c7d8-4570-bc74-2b294ff3b380.manifest.json +1 -1
- package/dist/index-internal-beta.d.ts +13 -26
- package/dist/index-internal-public.d.ts +241 -18
- package/dist/index-internal.d.ts +13 -26
- package/dist/sp-listview-extensibility_none_a53ef3010444ac520245.js +1 -0
- package/lib-commonjs/commandSet/ListViewCommandSetContext.js +2 -1
- package/lib-commonjs/common/ListViewAccessor.js +1 -2
- package/lib-commonjs/common/ListViewAccessorState.js +1 -1
- package/package.json +5 -5
- package/dist/sp-listview-extensibility_none_ed92a9a99f00e681761d.js +0 -1
|
@@ -151,6 +151,10 @@ export declare class Command {
|
|
|
151
151
|
* True if the command is visible.
|
|
152
152
|
*/
|
|
153
153
|
visible: boolean;
|
|
154
|
+
/**
|
|
155
|
+
* Whether the command is currently disabled.
|
|
156
|
+
*/
|
|
157
|
+
disabled: boolean | undefined;
|
|
154
158
|
}
|
|
155
159
|
|
|
156
160
|
/**
|
|
@@ -182,7 +186,7 @@ export declare class FieldCustomizerContext extends ExtensionContext {
|
|
|
182
186
|
/**
|
|
183
187
|
* Provides information about the state of a column in the list view
|
|
184
188
|
*
|
|
185
|
-
* @
|
|
189
|
+
* @public
|
|
186
190
|
*/
|
|
187
191
|
export declare interface IColumn {
|
|
188
192
|
/**
|
|
@@ -260,7 +264,7 @@ export declare interface IFieldCustomizerCellEventParameters {
|
|
|
260
264
|
/**
|
|
261
265
|
* Provides information about the state of the filters applied to the ListView.
|
|
262
266
|
*
|
|
263
|
-
* @
|
|
267
|
+
* @public
|
|
264
268
|
*/
|
|
265
269
|
export declare interface IFilter {
|
|
266
270
|
/**
|
|
@@ -276,7 +280,7 @@ export declare interface IFilter {
|
|
|
276
280
|
/**
|
|
277
281
|
* Provides information about the state of the folder in the ListView.
|
|
278
282
|
*
|
|
279
|
-
* @
|
|
283
|
+
* @public
|
|
280
284
|
*/
|
|
281
285
|
export declare interface IFolderInfo {
|
|
282
286
|
/**
|
|
@@ -288,7 +292,7 @@ export declare interface IFolderInfo {
|
|
|
288
292
|
/**
|
|
289
293
|
* Provides information about the list rendered by the ListView.
|
|
290
294
|
*
|
|
291
|
-
* @
|
|
295
|
+
* @public
|
|
292
296
|
*/
|
|
293
297
|
export declare interface IList {
|
|
294
298
|
/**
|
|
@@ -308,7 +312,7 @@ export declare interface IList {
|
|
|
308
312
|
/**
|
|
309
313
|
* Provides information about the state of the ListView.
|
|
310
314
|
*
|
|
311
|
-
* @
|
|
315
|
+
* @public
|
|
312
316
|
*/
|
|
313
317
|
export declare interface IListViewAccessorState {
|
|
314
318
|
/**
|
|
@@ -385,7 +389,7 @@ export declare interface IListViewCommandSetListViewUpdatedParameters {
|
|
|
385
389
|
/**
|
|
386
390
|
* Provides information about the list item's state rendered by the ListView.
|
|
387
391
|
*
|
|
388
|
-
* @
|
|
392
|
+
* @public
|
|
389
393
|
*/
|
|
390
394
|
export declare interface IRow {
|
|
391
395
|
/**
|
|
@@ -400,7 +404,7 @@ export declare interface IRow {
|
|
|
400
404
|
/**
|
|
401
405
|
* Provides information about the view rendered by the ListView.
|
|
402
406
|
*
|
|
403
|
-
* @
|
|
407
|
+
* @public
|
|
404
408
|
*/
|
|
405
409
|
export declare interface IView {
|
|
406
410
|
/**
|
|
@@ -476,52 +480,36 @@ export declare abstract class ListViewAccessor implements IDisposable {
|
|
|
476
480
|
abstract get columns(): ReadonlyArray<ColumnAccessor>;
|
|
477
481
|
/**
|
|
478
482
|
* Currently rendered rows in the list view.
|
|
479
|
-
*
|
|
480
|
-
* @beta
|
|
481
483
|
*/
|
|
482
484
|
abstract get rows(): ReadonlyArray<RowAccessor>;
|
|
483
485
|
/**
|
|
484
486
|
* Selected rows in the list view.
|
|
485
|
-
*
|
|
486
|
-
* @beta
|
|
487
487
|
*/
|
|
488
488
|
abstract get selectedRows(): ReadonlyArray<RowAccessor> | undefined;
|
|
489
489
|
/**
|
|
490
490
|
* Basic information about the list rendered by the list view.
|
|
491
|
-
*
|
|
492
|
-
* @beta
|
|
493
491
|
*/
|
|
494
492
|
abstract get list(): IList | undefined;
|
|
495
493
|
/**
|
|
496
494
|
* Basic information about the view rendered by the list view.
|
|
497
|
-
*
|
|
498
|
-
* @beta
|
|
499
495
|
*/
|
|
500
496
|
abstract get view(): IView | undefined;
|
|
501
497
|
/**
|
|
502
498
|
* Folder information for the list view.
|
|
503
|
-
*
|
|
504
|
-
* @beta
|
|
505
499
|
*/
|
|
506
500
|
abstract get folderInfo(): IFolderInfo | undefined;
|
|
507
501
|
/**
|
|
508
502
|
* Filters applied to the list view.
|
|
509
|
-
*
|
|
510
|
-
* @beta
|
|
511
503
|
*/
|
|
512
504
|
abstract get appliedFilters(): {
|
|
513
505
|
[fieldName: string]: IFilter;
|
|
514
506
|
} | undefined;
|
|
515
507
|
/**
|
|
516
508
|
* Sort field name
|
|
517
|
-
*
|
|
518
|
-
* @beta
|
|
519
509
|
*/
|
|
520
510
|
abstract get sortField(): string | undefined;
|
|
521
511
|
/**
|
|
522
512
|
* Specifies whether the list view is sorted ascending or descending.
|
|
523
|
-
*
|
|
524
|
-
* @beta
|
|
525
513
|
*/
|
|
526
514
|
abstract get sortAscending(): boolean | undefined;
|
|
527
515
|
/**
|
|
@@ -537,7 +525,6 @@ export declare abstract class ListViewAccessor implements IDisposable {
|
|
|
537
525
|
/**
|
|
538
526
|
* Event that gets raised every time the list view state changes.
|
|
539
527
|
*
|
|
540
|
-
* @beta
|
|
541
528
|
* @eventproperty
|
|
542
529
|
*/
|
|
543
530
|
get listViewStateChangedEvent(): SPEvent<ListViewStateChangedEventArgs>;
|
|
@@ -548,7 +535,7 @@ export declare abstract class ListViewAccessor implements IDisposable {
|
|
|
548
535
|
/**
|
|
549
536
|
* Describes the type of list view state changes.
|
|
550
537
|
*
|
|
551
|
-
* @
|
|
538
|
+
* @public
|
|
552
539
|
*/
|
|
553
540
|
export declare enum ListViewAccessorStateChanges {
|
|
554
541
|
None = 0,
|
|
@@ -584,7 +571,7 @@ export declare class ListViewCommandSetContext extends ExtensionContext {
|
|
|
584
571
|
/**
|
|
585
572
|
* Arguments for the list view state changed event.
|
|
586
573
|
*
|
|
587
|
-
* @
|
|
574
|
+
* @public
|
|
588
575
|
*/
|
|
589
576
|
export declare class ListViewStateChangedEventArgs extends SPEventArgs {
|
|
590
577
|
/**
|
|
@@ -151,6 +151,10 @@ export declare class Command {
|
|
|
151
151
|
* True if the command is visible.
|
|
152
152
|
*/
|
|
153
153
|
visible: boolean;
|
|
154
|
+
/**
|
|
155
|
+
* Whether the command is currently disabled.
|
|
156
|
+
*/
|
|
157
|
+
disabled: boolean | undefined;
|
|
154
158
|
}
|
|
155
159
|
|
|
156
160
|
/**
|
|
@@ -179,7 +183,49 @@ export declare class FieldCustomizerContext extends ExtensionContext {
|
|
|
179
183
|
get field(): SPField;
|
|
180
184
|
}
|
|
181
185
|
|
|
182
|
-
|
|
186
|
+
/**
|
|
187
|
+
* Provides information about the state of a column in the list view
|
|
188
|
+
*
|
|
189
|
+
* @public
|
|
190
|
+
*/
|
|
191
|
+
export declare interface IColumn {
|
|
192
|
+
/**
|
|
193
|
+
* The GUID identifier for this field.
|
|
194
|
+
*/
|
|
195
|
+
readonly id: Guid;
|
|
196
|
+
/**
|
|
197
|
+
* The internal name of the field. This name is usually used to find the field.
|
|
198
|
+
*/
|
|
199
|
+
readonly internalName: string;
|
|
200
|
+
/**
|
|
201
|
+
* The type of the field represented as a string
|
|
202
|
+
*/
|
|
203
|
+
readonly fieldType: string;
|
|
204
|
+
/**
|
|
205
|
+
* Whether the field is required for each list item in the list
|
|
206
|
+
*/
|
|
207
|
+
readonly isRequired: boolean;
|
|
208
|
+
/**
|
|
209
|
+
* Whether the column is visible in the view
|
|
210
|
+
*/
|
|
211
|
+
readonly isVisible: boolean;
|
|
212
|
+
/**
|
|
213
|
+
* The display name of the field. This name is shown as column name in UI.
|
|
214
|
+
*/
|
|
215
|
+
readonly displayName: string;
|
|
216
|
+
/**
|
|
217
|
+
* The unique identifier of the client-side component associated with the field.
|
|
218
|
+
*/
|
|
219
|
+
readonly clientSideComponentId: Guid | undefined;
|
|
220
|
+
/**
|
|
221
|
+
* This property is only used when a `ClientSideComponentId` is specified. It is optional.
|
|
222
|
+
*
|
|
223
|
+
* @remarks
|
|
224
|
+
* If non-empty, the string must contain a JSON object with custom initialization properties
|
|
225
|
+
* whose format and meaning are defined by the client-side component.
|
|
226
|
+
*/
|
|
227
|
+
readonly clientSideComponentProperties: string;
|
|
228
|
+
}
|
|
183
229
|
|
|
184
230
|
/* Excluded from this release type: _IExtensionContextParameters */
|
|
185
231
|
|
|
@@ -215,13 +261,99 @@ export declare interface IFieldCustomizerCellEventParameters {
|
|
|
215
261
|
|
|
216
262
|
/* Excluded from this release type: _IFieldCustomizerContextParameters */
|
|
217
263
|
|
|
218
|
-
|
|
264
|
+
/**
|
|
265
|
+
* Provides information about the state of the filters applied to the ListView.
|
|
266
|
+
*
|
|
267
|
+
* @public
|
|
268
|
+
*/
|
|
269
|
+
export declare interface IFilter {
|
|
270
|
+
/**
|
|
271
|
+
* Field name to filter on.
|
|
272
|
+
*/
|
|
273
|
+
readonly fieldName: string;
|
|
274
|
+
/**
|
|
275
|
+
* Values to filter on.
|
|
276
|
+
*/
|
|
277
|
+
values: ReadonlyArray<string>;
|
|
278
|
+
}
|
|
219
279
|
|
|
220
|
-
|
|
280
|
+
/**
|
|
281
|
+
* Provides information about the state of the folder in the ListView.
|
|
282
|
+
*
|
|
283
|
+
* @public
|
|
284
|
+
*/
|
|
285
|
+
export declare interface IFolderInfo {
|
|
286
|
+
/**
|
|
287
|
+
* Folder path.
|
|
288
|
+
*/
|
|
289
|
+
readonly folderPath: string;
|
|
290
|
+
}
|
|
221
291
|
|
|
222
|
-
|
|
292
|
+
/**
|
|
293
|
+
* Provides information about the list rendered by the ListView.
|
|
294
|
+
*
|
|
295
|
+
* @public
|
|
296
|
+
*/
|
|
297
|
+
export declare interface IList {
|
|
298
|
+
/**
|
|
299
|
+
* List id.
|
|
300
|
+
*/
|
|
301
|
+
readonly guid: Guid;
|
|
302
|
+
/**
|
|
303
|
+
* List title.
|
|
304
|
+
*/
|
|
305
|
+
readonly title: string;
|
|
306
|
+
/**
|
|
307
|
+
* List server relative url.
|
|
308
|
+
*/
|
|
309
|
+
readonly serverRelativeUrl: string;
|
|
310
|
+
}
|
|
223
311
|
|
|
224
|
-
|
|
312
|
+
/**
|
|
313
|
+
* Provides information about the state of the ListView.
|
|
314
|
+
*
|
|
315
|
+
* @public
|
|
316
|
+
*/
|
|
317
|
+
export declare interface IListViewAccessorState {
|
|
318
|
+
/**
|
|
319
|
+
* List information.
|
|
320
|
+
*/
|
|
321
|
+
readonly list?: IList;
|
|
322
|
+
/**
|
|
323
|
+
* View information.
|
|
324
|
+
*/
|
|
325
|
+
readonly view?: IView;
|
|
326
|
+
/**
|
|
327
|
+
* Current folder information.
|
|
328
|
+
*/
|
|
329
|
+
readonly folderInfo?: IFolderInfo;
|
|
330
|
+
/**
|
|
331
|
+
* Columns information.
|
|
332
|
+
*/
|
|
333
|
+
readonly columns: ReadonlyArray<IColumn>;
|
|
334
|
+
/**
|
|
335
|
+
* Selected rows information.
|
|
336
|
+
*/
|
|
337
|
+
readonly selectedRows?: ReadonlyArray<IRow>;
|
|
338
|
+
/**
|
|
339
|
+
* Rows information.
|
|
340
|
+
*/
|
|
341
|
+
readonly rows: ReadonlyArray<IRow>;
|
|
342
|
+
/**
|
|
343
|
+
* Applied filters information.
|
|
344
|
+
*/
|
|
345
|
+
readonly appliedFilters?: {
|
|
346
|
+
[fieldName: string]: IFilter;
|
|
347
|
+
};
|
|
348
|
+
/**
|
|
349
|
+
* Sort field name.
|
|
350
|
+
*/
|
|
351
|
+
readonly sortField?: string;
|
|
352
|
+
/**
|
|
353
|
+
* Sort direction.
|
|
354
|
+
*/
|
|
355
|
+
readonly sortAscending?: boolean;
|
|
356
|
+
}
|
|
225
357
|
|
|
226
358
|
/* Excluded from this release type: _IListViewCommandSetContextParameters */
|
|
227
359
|
|
|
@@ -254,9 +386,40 @@ export declare interface IListViewCommandSetListViewUpdatedParameters {
|
|
|
254
386
|
readonly selectedRows: ReadonlyArray<RowAccessor>;
|
|
255
387
|
}
|
|
256
388
|
|
|
257
|
-
|
|
389
|
+
/**
|
|
390
|
+
* Provides information about the list item's state rendered by the ListView.
|
|
391
|
+
*
|
|
392
|
+
* @public
|
|
393
|
+
*/
|
|
394
|
+
export declare interface IRow {
|
|
395
|
+
/**
|
|
396
|
+
* A map of column values for the row. They key is the column internal name and the value
|
|
397
|
+
* is its corresponding value in the row.
|
|
398
|
+
*/
|
|
399
|
+
readonly values: {
|
|
400
|
+
[columnInternalName: string]: Readonly<any>;
|
|
401
|
+
};
|
|
402
|
+
}
|
|
258
403
|
|
|
259
|
-
|
|
404
|
+
/**
|
|
405
|
+
* Provides information about the view rendered by the ListView.
|
|
406
|
+
*
|
|
407
|
+
* @public
|
|
408
|
+
*/
|
|
409
|
+
export declare interface IView {
|
|
410
|
+
/**
|
|
411
|
+
* View id.
|
|
412
|
+
*/
|
|
413
|
+
readonly id: Guid;
|
|
414
|
+
/**
|
|
415
|
+
* View title.
|
|
416
|
+
*/
|
|
417
|
+
readonly title: string;
|
|
418
|
+
/**
|
|
419
|
+
* View server relative url.
|
|
420
|
+
*/
|
|
421
|
+
readonly url: string;
|
|
422
|
+
}
|
|
260
423
|
|
|
261
424
|
/**
|
|
262
425
|
* When a field customizer extension is rendering a field, the ListItemAccessor provides
|
|
@@ -315,14 +478,40 @@ export declare abstract class ListViewAccessor implements IDisposable {
|
|
|
315
478
|
* The columns in associated with this view, including hidden columns.
|
|
316
479
|
*/
|
|
317
480
|
abstract get columns(): ReadonlyArray<ColumnAccessor>;
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
481
|
+
/**
|
|
482
|
+
* Currently rendered rows in the list view.
|
|
483
|
+
*/
|
|
484
|
+
abstract get rows(): ReadonlyArray<RowAccessor>;
|
|
485
|
+
/**
|
|
486
|
+
* Selected rows in the list view.
|
|
487
|
+
*/
|
|
488
|
+
abstract get selectedRows(): ReadonlyArray<RowAccessor> | undefined;
|
|
489
|
+
/**
|
|
490
|
+
* Basic information about the list rendered by the list view.
|
|
491
|
+
*/
|
|
492
|
+
abstract get list(): IList | undefined;
|
|
493
|
+
/**
|
|
494
|
+
* Basic information about the view rendered by the list view.
|
|
495
|
+
*/
|
|
496
|
+
abstract get view(): IView | undefined;
|
|
497
|
+
/**
|
|
498
|
+
* Folder information for the list view.
|
|
499
|
+
*/
|
|
500
|
+
abstract get folderInfo(): IFolderInfo | undefined;
|
|
501
|
+
/**
|
|
502
|
+
* Filters applied to the list view.
|
|
503
|
+
*/
|
|
504
|
+
abstract get appliedFilters(): {
|
|
505
|
+
[fieldName: string]: IFilter;
|
|
506
|
+
} | undefined;
|
|
507
|
+
/**
|
|
508
|
+
* Sort field name
|
|
509
|
+
*/
|
|
510
|
+
abstract get sortField(): string | undefined;
|
|
511
|
+
/**
|
|
512
|
+
* Specifies whether the list view is sorted ascending or descending.
|
|
513
|
+
*/
|
|
514
|
+
abstract get sortAscending(): boolean | undefined;
|
|
326
515
|
/**
|
|
327
516
|
* Returns the list view column corresponding to the field with the specified internal name,
|
|
328
517
|
* or undefined if none is found.
|
|
@@ -333,12 +522,32 @@ export declare abstract class ListViewAccessor implements IDisposable {
|
|
|
333
522
|
* @eventproperty
|
|
334
523
|
*/
|
|
335
524
|
get selectedRowsChangedEvent(): SPEvent<SelectedRowsChangedEventArgs>;
|
|
336
|
-
|
|
525
|
+
/**
|
|
526
|
+
* Event that gets raised every time the list view state changes.
|
|
527
|
+
*
|
|
528
|
+
* @eventproperty
|
|
529
|
+
*/
|
|
530
|
+
get listViewStateChangedEvent(): SPEvent<ListViewStateChangedEventArgs>;
|
|
337
531
|
/* Excluded from this release type: dispose */
|
|
338
532
|
/* Excluded from this release type: isDisposed */
|
|
339
533
|
}
|
|
340
534
|
|
|
341
|
-
|
|
535
|
+
/**
|
|
536
|
+
* Describes the type of list view state changes.
|
|
537
|
+
*
|
|
538
|
+
* @public
|
|
539
|
+
*/
|
|
540
|
+
export declare enum ListViewAccessorStateChanges {
|
|
541
|
+
None = 0,
|
|
542
|
+
List = 1,
|
|
543
|
+
View = 2,
|
|
544
|
+
Columns = 4,
|
|
545
|
+
SelectedRows = 8,
|
|
546
|
+
Rows = 16,
|
|
547
|
+
AppliedFilters = 32,
|
|
548
|
+
Sort = 64,
|
|
549
|
+
FolderInfo = 128
|
|
550
|
+
}
|
|
342
551
|
|
|
343
552
|
/**
|
|
344
553
|
* This object provides contextual information for BaseListViewCommandSet.
|
|
@@ -359,7 +568,21 @@ export declare class ListViewCommandSetContext extends ExtensionContext {
|
|
|
359
568
|
/* Excluded from this release type: _commands */
|
|
360
569
|
}
|
|
361
570
|
|
|
362
|
-
|
|
571
|
+
/**
|
|
572
|
+
* Arguments for the list view state changed event.
|
|
573
|
+
*
|
|
574
|
+
* @public
|
|
575
|
+
*/
|
|
576
|
+
export declare class ListViewStateChangedEventArgs extends SPEventArgs {
|
|
577
|
+
/**
|
|
578
|
+
* Previous state of the ListView.
|
|
579
|
+
*/
|
|
580
|
+
prevState: Readonly<IListViewAccessorState>;
|
|
581
|
+
/**
|
|
582
|
+
* Changes that were made to the ListView state.
|
|
583
|
+
*/
|
|
584
|
+
stateChanges: ListViewAccessorStateChanges;
|
|
585
|
+
}
|
|
363
586
|
|
|
364
587
|
/**
|
|
365
588
|
* Provides access to a ListView row, which is the visual presentation
|
package/dist/index-internal.d.ts
CHANGED
|
@@ -151,6 +151,10 @@ export declare class Command {
|
|
|
151
151
|
* True if the command is visible.
|
|
152
152
|
*/
|
|
153
153
|
visible: boolean;
|
|
154
|
+
/**
|
|
155
|
+
* Whether the command is currently disabled.
|
|
156
|
+
*/
|
|
157
|
+
disabled: boolean | undefined;
|
|
154
158
|
}
|
|
155
159
|
|
|
156
160
|
/**
|
|
@@ -182,7 +186,7 @@ export declare class FieldCustomizerContext extends ExtensionContext {
|
|
|
182
186
|
/**
|
|
183
187
|
* Provides information about the state of a column in the list view
|
|
184
188
|
*
|
|
185
|
-
* @
|
|
189
|
+
* @public
|
|
186
190
|
*/
|
|
187
191
|
export declare interface IColumn {
|
|
188
192
|
/**
|
|
@@ -260,7 +264,7 @@ export declare interface IFieldCustomizerCellEventParameters {
|
|
|
260
264
|
/**
|
|
261
265
|
* Provides information about the state of the filters applied to the ListView.
|
|
262
266
|
*
|
|
263
|
-
* @
|
|
267
|
+
* @public
|
|
264
268
|
*/
|
|
265
269
|
export declare interface IFilter {
|
|
266
270
|
/**
|
|
@@ -276,7 +280,7 @@ export declare interface IFilter {
|
|
|
276
280
|
/**
|
|
277
281
|
* Provides information about the state of the folder in the ListView.
|
|
278
282
|
*
|
|
279
|
-
* @
|
|
283
|
+
* @public
|
|
280
284
|
*/
|
|
281
285
|
export declare interface IFolderInfo {
|
|
282
286
|
/**
|
|
@@ -288,7 +292,7 @@ export declare interface IFolderInfo {
|
|
|
288
292
|
/**
|
|
289
293
|
* Provides information about the list rendered by the ListView.
|
|
290
294
|
*
|
|
291
|
-
* @
|
|
295
|
+
* @public
|
|
292
296
|
*/
|
|
293
297
|
export declare interface IList {
|
|
294
298
|
/**
|
|
@@ -308,7 +312,7 @@ export declare interface IList {
|
|
|
308
312
|
/**
|
|
309
313
|
* Provides information about the state of the ListView.
|
|
310
314
|
*
|
|
311
|
-
* @
|
|
315
|
+
* @public
|
|
312
316
|
*/
|
|
313
317
|
export declare interface IListViewAccessorState {
|
|
314
318
|
/**
|
|
@@ -385,7 +389,7 @@ export declare interface IListViewCommandSetListViewUpdatedParameters {
|
|
|
385
389
|
/**
|
|
386
390
|
* Provides information about the list item's state rendered by the ListView.
|
|
387
391
|
*
|
|
388
|
-
* @
|
|
392
|
+
* @public
|
|
389
393
|
*/
|
|
390
394
|
export declare interface IRow {
|
|
391
395
|
/**
|
|
@@ -400,7 +404,7 @@ export declare interface IRow {
|
|
|
400
404
|
/**
|
|
401
405
|
* Provides information about the view rendered by the ListView.
|
|
402
406
|
*
|
|
403
|
-
* @
|
|
407
|
+
* @public
|
|
404
408
|
*/
|
|
405
409
|
export declare interface IView {
|
|
406
410
|
/**
|
|
@@ -476,52 +480,36 @@ export declare abstract class ListViewAccessor implements IDisposable {
|
|
|
476
480
|
abstract get columns(): ReadonlyArray<ColumnAccessor>;
|
|
477
481
|
/**
|
|
478
482
|
* Currently rendered rows in the list view.
|
|
479
|
-
*
|
|
480
|
-
* @beta
|
|
481
483
|
*/
|
|
482
484
|
abstract get rows(): ReadonlyArray<RowAccessor>;
|
|
483
485
|
/**
|
|
484
486
|
* Selected rows in the list view.
|
|
485
|
-
*
|
|
486
|
-
* @beta
|
|
487
487
|
*/
|
|
488
488
|
abstract get selectedRows(): ReadonlyArray<RowAccessor> | undefined;
|
|
489
489
|
/**
|
|
490
490
|
* Basic information about the list rendered by the list view.
|
|
491
|
-
*
|
|
492
|
-
* @beta
|
|
493
491
|
*/
|
|
494
492
|
abstract get list(): IList | undefined;
|
|
495
493
|
/**
|
|
496
494
|
* Basic information about the view rendered by the list view.
|
|
497
|
-
*
|
|
498
|
-
* @beta
|
|
499
495
|
*/
|
|
500
496
|
abstract get view(): IView | undefined;
|
|
501
497
|
/**
|
|
502
498
|
* Folder information for the list view.
|
|
503
|
-
*
|
|
504
|
-
* @beta
|
|
505
499
|
*/
|
|
506
500
|
abstract get folderInfo(): IFolderInfo | undefined;
|
|
507
501
|
/**
|
|
508
502
|
* Filters applied to the list view.
|
|
509
|
-
*
|
|
510
|
-
* @beta
|
|
511
503
|
*/
|
|
512
504
|
abstract get appliedFilters(): {
|
|
513
505
|
[fieldName: string]: IFilter;
|
|
514
506
|
} | undefined;
|
|
515
507
|
/**
|
|
516
508
|
* Sort field name
|
|
517
|
-
*
|
|
518
|
-
* @beta
|
|
519
509
|
*/
|
|
520
510
|
abstract get sortField(): string | undefined;
|
|
521
511
|
/**
|
|
522
512
|
* Specifies whether the list view is sorted ascending or descending.
|
|
523
|
-
*
|
|
524
|
-
* @beta
|
|
525
513
|
*/
|
|
526
514
|
abstract get sortAscending(): boolean | undefined;
|
|
527
515
|
/**
|
|
@@ -537,7 +525,6 @@ export declare abstract class ListViewAccessor implements IDisposable {
|
|
|
537
525
|
/**
|
|
538
526
|
* Event that gets raised every time the list view state changes.
|
|
539
527
|
*
|
|
540
|
-
* @beta
|
|
541
528
|
* @eventproperty
|
|
542
529
|
*/
|
|
543
530
|
get listViewStateChangedEvent(): SPEvent<ListViewStateChangedEventArgs>;
|
|
@@ -548,7 +535,7 @@ export declare abstract class ListViewAccessor implements IDisposable {
|
|
|
548
535
|
/**
|
|
549
536
|
* Describes the type of list view state changes.
|
|
550
537
|
*
|
|
551
|
-
* @
|
|
538
|
+
* @public
|
|
552
539
|
*/
|
|
553
540
|
export declare enum ListViewAccessorStateChanges {
|
|
554
541
|
None = 0,
|
|
@@ -584,7 +571,7 @@ export declare class ListViewCommandSetContext extends ExtensionContext {
|
|
|
584
571
|
/**
|
|
585
572
|
* Arguments for the list view state changed event.
|
|
586
573
|
*
|
|
587
|
-
* @
|
|
574
|
+
* @public
|
|
588
575
|
*/
|
|
589
576
|
export declare class ListViewStateChangedEventArgs extends SPEventArgs {
|
|
590
577
|
/**
|
|
@@ -0,0 +1 @@
|
|
|
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,disabled:void 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={}))}})});
|
|
@@ -66,7 +66,7 @@ exports.SelectedRowsChangedEventArgs = SelectedRowsChangedEventArgs;
|
|
|
66
66
|
/**
|
|
67
67
|
* Arguments for the list view state changed event.
|
|
68
68
|
*
|
|
69
|
-
* @
|
|
69
|
+
* @public
|
|
70
70
|
*/
|
|
71
71
|
var ListViewStateChangedEventArgs = /** @class */ (function (_super) {
|
|
72
72
|
tslib_1.__extends(ListViewStateChangedEventArgs, _super);
|
|
@@ -106,7 +106,6 @@ var ListViewAccessor = /** @class */ (function () {
|
|
|
106
106
|
/**
|
|
107
107
|
* Event that gets raised every time the list view state changes.
|
|
108
108
|
*
|
|
109
|
-
* @beta
|
|
110
109
|
* @eventproperty
|
|
111
110
|
*/
|
|
112
111
|
get: function () {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@microsoft/sp-listview-extensibility",
|
|
3
|
-
"version": "1.14.0-
|
|
3
|
+
"version": "1.14.0-rc.2",
|
|
4
4
|
"description": "SharePoint Framework developer support for customizing the list view",
|
|
5
5
|
"license": "UNLICENSED",
|
|
6
6
|
"main": "lib-commonjs/index.js",
|
|
@@ -10,10 +10,10 @@
|
|
|
10
10
|
"tsdocFlavor": "AEDoc"
|
|
11
11
|
},
|
|
12
12
|
"dependencies": {
|
|
13
|
-
"@microsoft/sp-core-library": "1.14.0-
|
|
14
|
-
"@microsoft/sp-extension-base": "1.14.0-
|
|
15
|
-
"@microsoft/sp-module-interfaces": "1.14.0-
|
|
16
|
-
"@microsoft/sp-page-context": "1.14.0-
|
|
13
|
+
"@microsoft/sp-core-library": "1.14.0-rc.2",
|
|
14
|
+
"@microsoft/sp-extension-base": "1.14.0-rc.2",
|
|
15
|
+
"@microsoft/sp-module-interfaces": "1.14.0-rc.2",
|
|
16
|
+
"@microsoft/sp-page-context": "1.14.0-rc.2",
|
|
17
17
|
"tslib": "~1.10.0"
|
|
18
18
|
},
|
|
19
19
|
"scripts": {},
|
|
@@ -1 +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={}))}})});
|