superdesk-ui-framework 3.1.4 → 3.1.5

package/examples/pages/react/TreeSelect.tsx

@@ -252,7 +252,7 @@ export class TreeSelectDocs extends React.Component<{}, IState> {
                                     label='TreeSelect Label'
                                     info='Info Message'
                                     searchPlaceholder='Search...'
-                                    getBackgroundColor={(item: any) => item.bgColor} 
+                                    getBackgroundColor={(item: any) => item.bgColor}
                                     valueTemplate={(item, Wrapper) => {
                                         return (
                                             <Wrapper backgroundColor={item.bgColor}>
@@ -278,7 +278,65 @@ export class TreeSelectDocs extends React.Component<{}, IState> {
                             label='TreeSelect Label'
                             info='Info Message'
                             searchPlaceholder='Search...'
-                            getBackgroundColor={(item: any) => item.bgColor} 
+                            getBackgroundColor={(item: any) => item.bgColor}
+                            valueTemplate={(item, Wrapper) => {
+                                return (
+                                    <Wrapper backgroundColor={item.bgColor}>
+                                        <span>{item.name}</span>
+                                    </Wrapper>
+                                );
+                            }}
+                            onChange={(e) => false}
+                        />
+                    `}</Markup.ReactMarkupCode>
+
+                </Markup.ReactMarkup>
+
+                <p className='docs-page__paragraph'>Sortable mode in TreeSelect.</p>
+                <Markup.ReactMarkup>
+                    <Markup.ReactMarkupPreview>
+                        <div className='docs-page__content-row docs-page__content-row--no-margin'>
+                            <div className='form__row'>
+                                <TreeSelect
+                                    kind='synchronous'
+                                    value={[{name: 'Category1'}, {name: 'Category2'}, {name: 'Category3'}]}
+                                    getOptions={() => options}
+                                    getId={(item) => item.name}
+                                    getLabel={(item) => item.name}
+                                    selectBranchWithChildren
+                                    allowMultiple
+                                    sortable
+                                    label='TreeSelect Label'
+                                    info='Info Message'
+                                    searchPlaceholder='Search...'
+                                    getBackgroundColor={(item: any) => item.bgColor}
+                                    valueTemplate={(item, Wrapper) => {
+                                        return (
+                                            <Wrapper backgroundColor={item.bgColor}>
+                                                <span>{item.name}</span>
+                                            </Wrapper>
+                                        );
+                                    }}
+                                    onChange={(e) => false}
+                                />
+                            </div>
+                        </div>
+                    </Markup.ReactMarkupPreview>
+
+                    <Markup.ReactMarkupCode>{`
+                        <TreeSelect
+                            kind='synchronous'
+                            value={[{name: 'Category1'}]}
+                            getOptions={() => options}
+                            getId={(item) => item.name}
+                            getLabel={(item) => item.name}
+                            selectBranchWithChildren
+                            allowMultiple
+                            sortable
+                            label='TreeSelect Label'
+                            info='Info Message'
+                            searchPlaceholder='Search...'
+                            getBackgroundColor={(item: any) => item.bgColor}
                             valueTemplate={(item, Wrapper) => {
                                 return (
                                     <Wrapper backgroundColor={item.bgColor}>
@@ -401,6 +459,7 @@ export class TreeSelectDocs extends React.Component<{}, IState> {
                     <Prop name='loading' isRequired={false} type='boolean' default='false' description='Adds a loading indicator in dropdown.'/>
                     <Prop name='allowMultiple' isRequired={false} type='boolean' default='/' description='Enable multi-select mode.'/>
                     <Prop name='singleLevelSearch' isRequired={false} type='boolean' default='/' description='Limit search to only the level that is displayed.'/>
+                    <Prop name='sortable' isRequired={false} type='boolean' default='/' description='Enable drag & drop functionality.'/>
                     <Prop name='placeholder' isRequired={false} type='string' default='/' description='Placeholder of component in single select mode.'/>
                     <Prop name='searchPlaceholder' isRequired={false} type='string' default='/' description='Filter input placeholder.'/>
                     <Prop name='getLabel' isRequired={true} type='Function' default='/' description='Callback to invoke when value changes.'/>
@@ -409,7 +468,6 @@ export class TreeSelectDocs extends React.Component<{}, IState> {
                     <Prop name='getBorderColor' isRequired={true} type='Function' default='/' description='Function to return border color of individual item in options in single-select mode.'/>
                     <Prop name='valueTemplate' isRequired={false} type='Function(item, Wrapper)' default='/' description='Function that gets an item in the value and returns the content for it.'/>
                     <Prop name='optionTemplate' isRequired={false} type='Function(item)' default='/' description='Function that gets the option and returns the content for it.'/>
-                    <Prop name='searchOptions' isRequired={false} type='Function' default='/' description='The function will be called when a search is initiated from UI in asynchronous mode.'/>
                     <Prop name='onChange' isRequired={true} type='Function' default='/' description='Callback to invoke when value changes.'/>
                     <Prop name='label' isRequired={false} type='string' default='/' description='Label of component.' />
                     <Prop name='inlineLabel' isRequired={false} type='boolean' default='false' description='Position labels as inline.' />

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "superdesk-ui-framework",
-  "version": "3.1.4",
+  "version": "3.1.5",
   "license": "AGPL-3.0",
   "repository": {
     "type": "git",

package/react/components/TreeSelect/TreeSelect.d.ts

@@ -1,5 +1,6 @@
 import * as React from "react";
 import { IInputWrapper } from '../Form/InputWrapper';
+import { DropResult } from "react-beautiful-dnd";
 interface IState<T> {
     value: Array<T>;
     options: Array<ITreeNode<T>>;
@@ -25,7 +26,10 @@ interface IPropsBase<T> extends IInputWrapper {
     singleLevelSearch?: boolean;
     placeholder?: string;
     searchPlaceholder?: string;
+    noResultsFoundMessage?: string;
+    dropdownInitiallyOpen?: boolean;
     zIndex?: number;
+    sortable?: boolean;
     'data-test-id'?: string;
     getLabel(item: T): string;
     getId(item: T): string;
@@ -83,6 +87,7 @@ export declare class TreeSelect<T> extends React.Component<IProps<T>, IState<T>>
     private debounceFn;
     private ICancelFn;
     handleDebounce(): void;
+    onDragEnd(result: DropResult): void;
     render(): JSX.Element;
 }
 export {};

package/react/components/TreeSelect/TreeSelect.js

@@ -14,6 +14,17 @@ var __extends = (this && this.__extends) || (function () {
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
     };
 })();
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -65,6 +76,13 @@ var TreeSelectPill_1 = require("./TreeSelectPill");
 var TreeSelectItem_1 = require("./TreeSelectItem");
 var KeyboardNavigation_1 = require("./KeyboardNavigation");
 var WithPortal_1 = require("../WithPortal");
+var react_beautiful_dnd_1 = require("react-beautiful-dnd");
+var reorder = function (list, startIndex, endIndex) {
+    var result = Array.from(list);
+    var removed = result.splice(startIndex, 1)[0];
+    result.splice(endIndex, 0, removed);
+    return result;
+};
 var TreeSelect = /** @class */ (function (_super) {
     __extends(TreeSelect, _super);
     function TreeSelect(props) {
@@ -120,6 +138,9 @@ var TreeSelect = /** @class */ (function (_super) {
             document.addEventListener("mousedown", _this.onMouseDown);
             document.addEventListener("keydown", _this.onKeyDown);
             document.addEventListener("keydown", _this.onPressEsc);
+            if (_this.props.dropdownInitiallyOpen) {
+                _this.setState({ openDropdown: true });
+            }
         };
         _this.debounceFn = (0, debounce_1.default)(_this.handleDebounce, 500);
         _this.state = {
@@ -155,6 +176,7 @@ var TreeSelect = /** @class */ (function (_super) {
         _this.openDropdownRef = React.createRef();
         _this.treeSelectRef = React.createRef();
         _this.popperInstance = null;
+        _this.onDragEnd = _this.onDragEnd.bind(_this);
         return _this;
     }
     TreeSelect.prototype.componentWillUnmount = function () {
@@ -398,6 +420,7 @@ var TreeSelect = /** @class */ (function (_super) {
     };
     TreeSelect.prototype.filteredItem = function (arr) {
         var _this = this;
+        var _a;
         if (this.props.kind === 'synchronous') {
             var filteredArr = arr.filter(function (item) {
                 if (_this.state.searchFieldValue) {
@@ -429,17 +452,22 @@ var TreeSelect = /** @class */ (function (_super) {
             }
         }
         else if (this.props.kind === 'asynchronous') {
-            return this.state.options.map(function (item, i) {
-                var selectedItem = _this.state.value.some(function (obj) {
-                    return _this.props.getId(obj) === _this.props.getId(item.value);
+            if (this.state.options.length > 0) {
+                return this.state.options.map(function (item, i) {
+                    var selectedItem = _this.state.value.some(function (obj) {
+                        return _this.props.getId(obj) === _this.props.getId(item.value);
+                    });
+                    return (React.createElement("li", { key: i, className: 'suggestion-item suggestion-item--multi-select', onClick: function (event) {
+                            _this.handleValue(event, item);
+                        } },
+                        React.createElement("button", { className: "suggestion-item--btn", "data-test-id": "option" }, _this.props.optionTemplate
+                            ? _this.props.optionTemplate(item.value)
+                            : (React.createElement("span", { className: selectedItem ? 'suggestion-item--selected' : undefined }, _this.props.getLabel(item.value))))));
                 });
-                return (React.createElement("li", { key: i, className: 'suggestion-item suggestion-item--multi-select', onClick: function (event) {
-                        _this.handleValue(event, item);
-                    } },
-                    React.createElement("button", { className: "suggestion-item--btn", "data-test-id": "option" }, _this.props.optionTemplate
-                        ? _this.props.optionTemplate(item.value)
-                        : (React.createElement("span", { className: selectedItem ? 'suggestion-item--selected' : undefined }, _this.props.getLabel(item.value))))));
-            });
+            }
+            else {
+                return React.createElement("li", { className: "suggestion-item--nothing-found" }, (_a = this.props.noResultsFoundMessage) !== null && _a !== void 0 ? _a : 'Nothing found');
+            }
         }
         else {
             return;
@@ -481,17 +509,26 @@ var TreeSelect = /** @class */ (function (_super) {
         this.setState({ options: [] });
         if (this.props.kind === 'asynchronous') {
             if (this.state.searchFieldValue) {
-                this.setState({
-                    loading: true,
-                });
                 this.ICancelFn = this.props.searchOptions(this.state.searchFieldValue, function (items) {
                     var _a;
                     _this.setState({ options: items, loading: false });
                     (_a = _this.popperInstance) === null || _a === void 0 ? void 0 : _a.update();
                 });
             }
+            else {
+                this.setState({ options: this.state.firstBranchOptions, loading: false });
+            }
         }
     };
+    TreeSelect.prototype.onDragEnd = function (result) {
+        if (!result.destination) {
+            return;
+        }
+        var value = reorder(this.state.value, result.source.index, result.destination.index);
+        this.setState({
+            value: value,
+        });
+    };
     TreeSelect.prototype.render = function () {
         var _this = this;
         var _a, _b;
@@ -506,6 +543,27 @@ var TreeSelect = /** @class */ (function (_super) {
                         getBorderColor: this.props.getBorderColor,
                     }, items: this.state.value, valueTemplate: this.props.valueTemplate, getLabel: this.props.getLabel }));
         }
+        var ListWrapper = this.props.sortable
+            ? function (_a) {
+                var children = _a.children;
+                return (React.createElement(react_beautiful_dnd_1.DragDropContext, { onDragEnd: _this.onDragEnd },
+                    React.createElement(react_beautiful_dnd_1.Droppable, { droppableId: "droppable", direction: "horizontal" }, function (provided, _snapshot) { return (React.createElement("ul", __assign({ className: "tags-input__tag-list", ref: provided.innerRef }, provided.droppableProps),
+                        children,
+                        provided.placeholder)); })));
+            }
+            : function (_a) {
+                var children = _a.children;
+                return React.createElement("ul", { className: "tags-input__tag-list" }, children);
+            };
+        var ItemWrapper = this.props.sortable
+            ? function (_a) {
+                var children = _a.children, itemId = _a.itemId, i = _a.i;
+                return (React.createElement(react_beautiful_dnd_1.Draggable, { draggableId: itemId, index: i }, function (provided2) { return (React.createElement("div", __assign({ ref: provided2.innerRef }, provided2.draggableProps, provided2.dragHandleProps), children)); }));
+            }
+            : function (_a) {
+                var children = _a.children;
+                return React.createElement(React.Fragment, null, children);
+            };
         return (React.createElement(Form_1.InputWrapper, { label: this.props.label, error: this.props.error, invalid: this.props.error != null, required: this.props.required, disabled: this.props.disabled, info: this.props.info, inlineLabel: this.props.inlineLabel, labelHidden: this.props.labelHidden, htmlId: this.htmlId, tabindex: this.props.tabindex, fullWidth: (_a = this.props.inputWidth === '100%') !== null && _a !== void 0 ? _a : false, "data-test-id": this.props['data-test-id'] },
             React.createElement("div", { className: "\n                        tags-input sd-input__input\n                        tags-input--".concat(this.props.allowMultiple ? 'multi-select' : 'single-select'), ref: this.treeSelectRef, "data-test-id": this.props.allowMultiple ? undefined : 'open-popover' }, this.props.allowMultiple
                 ? React.createElement("div", { className: "tags-input__tags" },
@@ -520,12 +578,13 @@ var TreeSelect = /** @class */ (function (_super) {
                                 }
                             }, "data-test-id": "open-popover" },
                             React.createElement("i", { className: "icon-plus-large" })),
-                    React.createElement("ul", { className: "tags-input__tag-list" }, this.state.value.map(function (item, i) {
+                    React.createElement(ListWrapper, null, this.state.value.map(function (item, i) {
                         var Wrapper = function (_a) {
                             var backgroundColor = _a.backgroundColor, children = _a.children;
-                            return (React.createElement(TreeSelectPill_1.TreeSelectPill, { item: item, readOnly: _this.props.readOnly, disabled: _this.props.disabled, valueTemplate: _this.props.valueTemplate, backgroundColor: backgroundColor, onRemove: function () { return _this.removeClick(i); }, getBackgroundColor: _this.props.getBackgroundColor }, children));
+                            return (React.createElement(TreeSelectPill_1.TreeSelectPill, { item: item, readOnly: _this.props.readOnly, disabled: _this.props.disabled, valueTemplate: _this.props.valueTemplate, backgroundColor: backgroundColor, onRemove: function () { return _this.removeClick(i); }, getBackgroundColor: _this.props.getBackgroundColor, draggable: _this.props.sortable }, children));
                         };
-                        return (React.createElement(React.Fragment, { key: i }, _this.props.valueTemplate
+                        var itemId = _this.props.getId(item);
+                        return (React.createElement(ItemWrapper, { itemId: itemId, key: itemId, i: i }, _this.props.valueTemplate
                             ? _this.props.valueTemplate(item, Wrapper)
                             : (React.createElement(Wrapper, null,
                                 React.createElement("span", null, _this.props.getLabel(item))))));
@@ -588,7 +647,11 @@ var TreeSelect = /** @class */ (function (_super) {
                                         if (_this.ICancelFn) {
                                             _this.ICancelFn();
                                         }
-                                        _this.setState({ searchFieldValue: event.target.value, options: [] });
+                                        _this.setState({
+                                            searchFieldValue: event.target.value,
+                                            options: [],
+                                            loading: true,
+                                        });
                                         (_b = _this.popperInstance) === null || _b === void 0 ? void 0 : _b.update();
                                         _this.debounceFn();
                                     }

package/react/components/TreeSelect/TreeSelectPill.d.ts

@@ -7,6 +7,7 @@ interface IProps<T> {
     onRemove(): void;
     valueTemplate?(item: T, Wrapper: React.ElementType): React.ComponentType<T> | JSX.Element;
     getBackgroundColor?(item: T): string;
+    draggable?: boolean;
 }
 export declare class TreeSelectPill<T> extends React.Component<IProps<T>> {
     render(): JSX.Element;

package/react/components/TreeSelect/TreeSelectPill.js

@@ -37,9 +37,14 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TreeSelectPill = void 0;
+var classnames_1 = __importDefault(require("classnames"));
 var React = __importStar(require("react"));
+var DragHandle_1 = require("../DragHandle");
 var Icon_1 = require("../Icon");
 var Label_1 = require("../Label");
 var TreeSelectPill = /** @class */ (function (_super) {
@@ -49,12 +54,15 @@ var TreeSelectPill = /** @class */ (function (_super) {
     }
     TreeSelectPill.prototype.render = function () {
         var _this = this;
-        return (React.createElement("li", { className: "tags-input__tag-item tags-input__tag-item--multi-select"
-                + (this.props.readOnly ? ' tags-input__tag-item--readonly' : ''), onClick: function () { return (!_this.props.readOnly && !_this.props.disabled)
-                && _this.props.onRemove(); }, style: this.props.valueTemplate
+        var classes = (0, classnames_1.default)('tags-input__tag-item tags-input__tag-item--multi-select', {
+            'tags-input__tag-item--readonly': this.props.readOnly,
+            'tags-input__tag-item--draggable': this.props.draggable,
+        });
+        return (React.createElement("li", { className: classes, style: this.props.valueTemplate
                 ? { backgroundColor: this.props.backgroundColor }
                 : this.props.getBackgroundColor
                     && { backgroundColor: this.props.getBackgroundColor(this.props.item) }, "data-test-id": "item" },
+            this.props.draggable && (React.createElement(DragHandle_1.DragHandle, { blank: true, dotsInRow: '3', dotRows: '4' })),
             React.createElement("span", { className: "tags-input__helper-box", style: {
                     color: this.props.backgroundColor
                         ? (0, Label_1.getTextColor)(this.props.backgroundColor)
@@ -63,7 +71,8 @@ var TreeSelectPill = /** @class */ (function (_super) {
                 } },
                 this.props.children,
                 !this.props.readOnly
-                    && React.createElement("span", { className: "tags-input__remove-button", "data-test-id": "remove" },
+                    && React.createElement("button", { className: "tags-input__remove-button", "data-test-id": "remove", onClick: function () { return (!_this.props.readOnly && !_this.props.disabled)
+                            && _this.props.onRemove(); } },
                         React.createElement(Icon_1.Icon, { name: "close-small" })))));
     };
     return TreeSelectPill;