Merge branch 'feature_listPicker' of https://github.com/parithon/sp-dev-fx-controls-react into parithon-feature_listPicker

Author: estruyf

src/ListPicker.ts

@@ -0,0 +1 @@
+export * from './controls/listPicker/index';

src/common/SPEntities.ts

@@ -1,3 +1,19 @@
+/**
+ * Represents SP List
+ */
+export interface ISPList {
+    Id: string;
+    Title: string;
+    BaseTemplate: string;
+}
+
+/**
+ * Replica of the returned value from the REST api
+ */
+export interface ISPLists {
+    value: ISPList[];
+}
+
 /**
  * Represents SP Field
  */

src/controls/listPicker/IListPicker.ts

@@ -0,0 +1,67 @@
+import IWebPartContext from "@microsoft/sp-webpart-base/lib/core/IWebPartContext";
+import { IDropdownOption } from "office-ui-fabric-react/lib/Dropdown";
+
+import { LibsOrderBy } from "../../services/ISPService";
+
+export interface IListPickerProps {
+    /**
+     * The web part context
+     */
+    context: IWebPartContext;
+    /**
+     * If provided, additional class name to provide on the dropdown element.
+     */
+    className?: string;
+    /**
+     * Whether or not the control is disabled
+     */
+    disabled?: boolean;
+    /**
+     * The SharePoint BaseTemplate to filter the list options by
+     */
+    baseTemplate?: number;
+    /**
+     * Whether or not to include hidden lists. Default is true
+     */
+    includeHidden?: boolean;
+    /**
+     * How to order the lists retrieved from SharePoint
+     */
+    orderBy?: LibsOrderBy;
+    /**
+    * Keys of the selected item(s). If you provide this, you must maintain selection
+    * state by observing onSelectionChanged events and passing a new value in when changed.
+    */
+    selectedList?: string | string[];
+    /**
+     * Optional mode indicates if multi-choice selections is allowed.  Default to false
+     */
+    multiSelect?: boolean;
+    /**
+     * The label to use
+     */
+    label?: string;
+    /**
+     * Input placeholder text. Displayed until option is selected.
+     */
+    placeHolder?: string;
+    /**
+     * Callback issues when the selected option changes
+     */
+    onSelectionChanged?: (newValue: string | string[]) => void;
+}
+
+export interface IListPickerState {
+    /**
+     * The options available to the listPicker
+     */
+    options: IDropdownOption[];
+    /**
+     * Whether or not the listPicker options are loading
+     */    
+    loading: boolean;
+    /**
+    * Keys of the currently selected item(s).
+    */
+    selectedList?: string | string[];
+}

src/controls/listPicker/ListPicker.module.scss

@@ -0,0 +1,7 @@
+.listPicker {
+    .spinner {
+        float: right;
+        margin-top: 10px;
+        margin-right: -20px;
+    }
+}

src/controls/listPicker/ListPicker.tsx

@@ -0,0 +1,142 @@
+import * as React from 'react';
+import { IDropdownOption, IDropdownProps, Dropdown } from 'office-ui-fabric-react/lib/components/Dropdown';
+import { Spinner, SpinnerSize } from 'office-ui-fabric-react/lib/components/Spinner';
+
+import { IListPickerProps, IListPickerState } from './IListPicker';
+import { ISPService } from '../../services/ISPService';
+import { SPServiceFactory } from '../../services/SPServiceFactory';
+
+import styles from './ListPicker.module.scss';
+
+/**
+ * Empty list value, to be checked for single list selection
+ */
+const EMPTY_LIST_KEY = 'NO_LIST_SELECTED';
+
+/**
+ * Renders the controls for the ListPicker component
+ */
+export class ListPicker extends React.Component<IListPickerProps, IListPickerState> {
+    private _options: IDropdownOption[] = [];
+    private _selectedList: string | string[];
+    
+    /**
+     * Constructor method
+     */
+    constructor(props: IListPickerProps) {
+        super(props);
+        
+        console.debug('selectedList', this.props.selectedList);
+
+        this.state = {
+            options: this._options,
+            loading: false
+        };
+
+        this.onChanged = this.onChanged.bind(this);
+    }
+
+    /**
+     * Lifecycle hook when component is mounted
+     */
+    public componentDidMount() {
+        this.loadLists();
+    }
+
+    /**
+     * Loads the list from SharePoint current web site
+     */
+    private loadLists() {
+        const { context, baseTemplate, includeHidden, orderBy, multiSelect, selectedList } = this.props;
+
+        // Show the loading indicator and disable the dropdown
+        this.setState({ loading: true });
+
+        const service: ISPService = SPServiceFactory.createService(context, true, 5000);
+        service.getLibs({ 
+            baseTemplate: baseTemplate,
+            includeHidden: includeHidden,
+            orderBy: orderBy
+        }).then((results) => {
+            // Start mapping the lists to the dropdown option
+            results.value.map(list => {                
+                this._options.push({
+                    key: list.Id,
+                    text: list.Title
+                });
+            });
+
+            if (multiSelect !== true) {
+                // Add option to unselct list
+                this._options.unshift({
+                    key: EMPTY_LIST_KEY,
+                    text: ''
+                });
+            }
+
+            this._selectedList = this.props.selectedList;
+
+            // Hide the loading indicator and set the dropdown options and enable the dropdown
+            this.setState({
+                loading: false,
+                options: this._options,
+                selectedList: this._selectedList
+            });
+        });
+    }
+
+    /**
+     * Raises when a list has been selected
+     * @param option the new selection
+     * @param index the index of the selection
+     */
+    private onChanged(option: IDropdownOption, index?: number): void {
+        const { multiSelect, onSelectionChanged } = this.props;
+        
+        if (multiSelect === true) {
+            if (this._selectedList === undefined) {
+                this._selectedList = new Array<string>();
+            }
+            (this._selectedList as string[]).push(option.key as string);
+        } else {
+            this._selectedList = option.key as string;
+        }
+
+        if (onSelectionChanged) {
+            onSelectionChanged(this._selectedList);
+        }
+    }
+
+    /**
+     * Renders the ListPicker controls with Office UI Fabric
+     */
+    public render(): JSX.Element {
+        const { loading, options, selectedList } = this.state;
+        const { className, disabled, multiSelect, label, placeHolder } = this.props;
+
+        const dropdownOptions: IDropdownProps = {
+            className: className,
+            options: options,
+            disabled: ( loading || disabled ),
+            label: label,
+            placeHolder: placeHolder,
+            onChanged: this.onChanged
+        };
+
+        if (multiSelect === true) {
+            dropdownOptions.multiSelect = true;
+            dropdownOptions.selectedKeys = selectedList as string[];
+        } else {
+            dropdownOptions.selectedKey = selectedList as string;
+        }
+
+        return (
+            <div className={ styles.listPicker }>
+                { loading && <Spinner className={ styles.spinner } size={SpinnerSize.xSmall} /> }
+                <Dropdown {...dropdownOptions} />
+            </div>
+        );
+    }
+}
+
+export default ListPicker;

src/controls/listPicker/index.ts

@@ -0,0 +1,2 @@
+export * from './IListPicker';
+export * from './ListPicker';

src/index.ts

@@ -4,6 +4,8 @@ export * from './Placeholder';
 export * from './SiteBreadcrumb';
 export * from './TaxonomyPicker';
 export * from './WebPartTitle';
+export * from './ListPicker';
+
 export * from './IFrameDialog';
 export * from './Common';
 export * from './Utilities';

src/services/ISPService.ts

@@ -0,0 +1,21 @@
+import { ISPLists } from "../common/SPEntities";
+
+export enum LibsOrderBy {
+    Id = 1,
+    Title
+}
+/**
+ * Options used to sort and filter
+ */
+export interface ILibsOptions {
+    orderBy?: LibsOrderBy;
+    baseTemplate?: number;
+    includeHidden?: boolean;
+}
+export interface ISPService {
+    /**
+     * Get the lists from SharePoint
+     * @param options Options used to order and filter during the API query
+     */
+    getLibs(options?: ILibsOptions): Promise<ISPLists>;
+}

src/services/SPService.ts

@@ -0,0 +1,32 @@
+import { ISPService, ILibsOptions, LibsOrderBy } from "./ISPService";
+import { ISPLists } from "../common/SPEntities";
+import { IWebPartContext } from "@microsoft/sp-webpart-base";
+import { SPHttpClient, SPHttpClientResponse } from "@microsoft/sp-http";
+
+export class SPService implements ISPService {
+    private readonly _context: IWebPartContext;
+    constructor(context: IWebPartContext) {
+        this._context = context;
+    }
+    public getLibs(options?: ILibsOptions): Promise<ISPLists> {
+        let filtered: boolean;
+        let queryUrl: string = `${this._context.pageContext.web.absoluteUrl}/_api/web/lists?$select=Title,id,BaseTemplate`;
+        if (options.orderBy !== null) {
+            queryUrl += `&$orderby=${options.orderBy === LibsOrderBy.Id ? 'Id': 'Title'}`;
+        }
+        if (options.baseTemplate !== null) {
+            queryUrl += `&$filter=BaseTemplate eq ${options.baseTemplate}`;
+            filtered = true;
+        }
+        if (options.includeHidden === false) {
+            queryUrl += filtered ? ' and Hidden eq false' : '&$filter=Hidden eq false';
+            filtered = true;
+        }
+        return this._context.spHttpClient.get(queryUrl, SPHttpClient.configurations.v1)
+            .then((response: SPHttpClientResponse) => {
+                return response.json();
+            }) as Promise<ISPLists>;
+    }
+}
+
+export default SPService;

src/services/SPServiceFactory.ts

@@ -0,0 +1,14 @@
+import { IWebPartContext } from "@microsoft/sp-webpart-base";
+import { ISPService } from "./ISPService";
+import { Environment, EnvironmentType } from "@microsoft/sp-core-library";
+import SPServiceMock from "./SPServiceMock";
+import SPService from "./SPService";
+
+export class SPServiceFactory {
+    public static createService(context: IWebPartContext, includeDelay?: boolean, delayTimeout?: number): ISPService {
+        if (Environment.type === EnvironmentType.Local) {
+            return new SPServiceMock(includeDelay, delayTimeout);
+        }
+        return new SPService(context);
+    }
+}