superdesk-ui-framework 3.0.0-beta.0 → 3.0.0-rc12

package/app-typescript/components/Lists/TableList.tsx

@@ -0,0 +1,405 @@
+import * as React from 'react';
+import classNames from 'classnames';
+import { DragDropContext, Droppable, Draggable, DropResult } from "react-beautiful-dnd";
+import { Tooltip } from '../Tooltip';
+import { Button } from '../Button';
+import { Dropdown, IMenuItem, ISubmenu, IMenuGroup } from '../Dropdown';
+import ReactDOM from 'react-dom';
+
+export interface IProps {
+    array: Array<IPropsArrayItem>;
+    addItem?: boolean;
+    dragAndDrop?: boolean;
+    className?: string;
+    readOnly?: boolean;
+    showDragHandle?: 'always' | 'onHover' | 'none'; // always default
+    append?: boolean;
+    onDrag?(start: number, end: number): void;
+    onAddItem?(index: number, item?: IPropsArrayItem): void;
+    itemsDropdown?(index?: number): Array<IMenuItem | ISubmenu | IMenuGroup | 'divider'>;
+}
+
+export interface IPropsArrayItem {
+    start?: React.ReactNode;
+    center?: React.ReactNode;
+    end?: React.ReactNode;
+    action?: React.ReactNode;
+    hexColor?: string;
+    onClick?(): void;
+    onDoubleClick?(): void;
+    locked?: boolean;
+    positionLocked?: boolean;
+}
+
+interface IState {
+    items: Array<IPropsArrayItem>;
+}
+
+const reorder = (list: Array<IPropsArrayItem>, startIndex: number, endIndex: number) => {
+    const result = Array.from(list);
+    const [removed] = result.splice(startIndex, 1);
+    result.splice(endIndex, 0, removed);
+
+    return result;
+};
+
+class TableList extends React.PureComponent<IProps, IState> {
+    constructor(props: IProps) {
+        super(props);
+        this.state = {
+            items: [],
+        };
+
+        this.onDragEnd = this.onDragEnd.bind(this);
+        this.dropDown = this.dropDown.bind(this);
+    }
+
+    componentDidMount(): void {
+        if (this.props.array) {
+            this.setState({ items: this.props.array });
+        }
+    }
+
+    componentDidUpdate(prevProps: IProps): void {
+        if (this.props.array) {
+            if (prevProps.array !== this.props.array) {
+                this.setState({
+                    items: this.props.array,
+                });
+            }
+        }
+    }
+
+    onDragEnd(result: DropResult) {
+        if (!result.destination) {
+            return;
+        }
+        const items = reorder(
+            this.state.items,
+            result.source.index,
+            result.destination.index,
+        );
+        this.setState({
+            items: items,
+        });
+
+        return this.props.onDrag ?
+            this.props.onDrag(result.source.index, result.destination.index) : null;
+    }
+
+    dropDown() {
+        return (
+            <Dropdown
+                items={this.props.itemsDropdown ? this.props.itemsDropdown() : []}>
+                <Button
+                    type="primary"
+                    icon="plus-large"
+                    text="Add item"
+                    size="small"
+                    shape="round"
+                    iconOnly={true}
+                    onClick={() => false}
+                />
+            </Dropdown>
+        );
+    }
+
+    render() {
+        let classes = classNames('', {
+            'table-list': !this.props.addItem,
+            'table-list--read-only': this.props.readOnly,
+            [`${this.props.className}`]: this.props.className,
+        });
+
+        return (
+            this.state.items.length > 0
+                ? this.props.dragAndDrop
+                    ? <DragDropContext onDragEnd={this.onDragEnd}>
+                        <Droppable droppableId="droppable">
+                            {(provided, _snapshot) => (
+                                <div
+                                    role='list'
+                                    className={classes}
+                                    ref={provided.innerRef}
+                                    {...provided.droppableProps} >
+                                    {this.state.items.map((item: IPropsArrayItem, index: number) => (
+                                        <Draggable key={index} draggableId={`${index}`} index={index}>
+                                            {(provided2, snapshot) => (
+                                                this.props.append
+                                                    ? <PortalItem
+                                                        provided={provided2}
+                                                        snapshot={snapshot}
+                                                        item={item}
+                                                        index={index}
+                                                        dragAndDrop={this.props.dragAndDrop}
+                                                        showDragHandle={this.props.showDragHandle}
+                                                        addItem={this.props.addItem}
+                                                        onAddItem={() => this.props.onAddItem
+                                                            && this.props.onAddItem(index, item)}
+                                                        itemsDropdown={() => this.props.itemsDropdown
+                                                            ? this.props.itemsDropdown(index)
+                                                            : []}
+                                                    />
+                                                    : <div
+                                                        ref={provided2.innerRef}
+                                                        {...provided2.draggableProps}
+                                                        {...provided2.dragHandleProps} >
+                                                        <TableListItem
+                                                            dragAndDrop={this.props.dragAndDrop}
+                                                            start={item.start}
+                                                            center={item.center}
+                                                            end={item.end}
+                                                            action={item.action}
+                                                            onClick={item.onClick ? item.onClick : undefined}
+                                                            onDoubleClick={item.onDoubleClick
+                                                                ? item.onDoubleClick
+                                                                : undefined}
+                                                            addItem={this.props.addItem}
+                                                            itemsDropdown={() => this.props.itemsDropdown
+                                                                ? this.props.itemsDropdown(index)
+                                                                : []}
+                                                            hexColor={item.hexColor}
+                                                            locked={item.locked}
+                                                            positionLocked={item.positionLocked}
+                                                            onAddItem={() => this.props.onAddItem
+                                                                && this.props.onAddItem(index, item)}
+                                                            showDragHandle={this.props.showDragHandle}
+                                                        />
+                                                    </div>
+                                            )}
+                                        </Draggable>
+                                    ))}
+                                    {provided.placeholder}
+                                    {(this.props.addItem && !this.props.readOnly) &&
+                                        <div className={`table-list__add-item table-list__item--margin`}>
+                                            <Tooltip text='Add item' flow='top' appendToBody={true}>
+                                                <div className='table-list__add-item--container sd-margin-x--auto'>
+                                                    {this.dropDown()}
+                                                </div>
+                                            </Tooltip>
+                                        </div>
+                                    }
+                                </div>
+                            )}
+                        </Droppable>
+                    </DragDropContext>
+                    : <div role='list' className={classes}>
+                        {this.state.items.map((item: IPropsArrayItem, index: number) => (
+                            <TableListItem
+                                key={index}
+                                start={item.start}
+                                center={item.center}
+                                end={item.end}
+                                action={item.action}
+                                onClick={item.onClick ? item.onClick : undefined}
+                                onDoubleClick={item.onDoubleClick
+                                    ? item.onDoubleClick
+                                    : undefined}
+                                addItem={this.props.addItem}
+                                itemsDropdown={() => this.props.itemsDropdown ? this.props.itemsDropdown(index) : []}
+                                hexColor={item.hexColor}
+                                locked={item.locked}
+                                positionLocked={item.positionLocked}
+                                onAddItem={() => this.props.onAddItem
+                                    && this.props.onAddItem(index, item)}
+                            />
+                        ))}
+                        {(this.props.addItem && !this.props.readOnly) &&
+                            <div className={`table-list__add-item table-list__item--margin`}>
+                                <Tooltip text='Add item' flow='top' appendToBody={true}>
+                                    <div className='table-list__add-item--container sd-margin-x--auto'>
+                                        {this.dropDown()}
+                                    </div>
+                                </Tooltip>
+                            </div>
+                        }
+                    </div>
+                : (this.props.addItem && !this.props.readOnly) ? <div role='list' className={classes}>
+                    <div className={`table-list__add-item table-list__item--margin`}>
+                        <Tooltip text='Add item' flow='top' appendToBody={true}>
+                            <div className='table-list__add-item--container sd-margin-x--auto'>
+                                {this.dropDown()}
+                            </div>
+                        </Tooltip>
+                    </div>
+                </div>
+                    : null
+        );
+    }
+}
+
+export interface IPropsItem {
+    start?: React.ReactNode;
+    center?: React.ReactNode;
+    end?: React.ReactNode;
+    action?: React.ReactNode;
+    addItem?: boolean;
+    dragAndDrop?: boolean;
+    hexColor?: string;
+    showDragHandle?: 'always' | 'onHover' | 'none';
+    locked?: boolean;
+    positionLocked?: boolean;
+    onClick?(): void;
+    onDoubleClick?(): void;
+    onSelect?(): void;
+    onAddItem?(e: number): void;
+    itemsDropdown?(index?: number): Array<IMenuItem | ISubmenu | IMenuGroup | 'divider'>;
+}
+
+class TableListItem extends React.PureComponent<IPropsItem> {
+    private timer: any;
+    private delay = 200;
+    private prevent = false;
+
+    onSingleClick = () => {
+        this.timer = setTimeout(() => {
+            if (!this.prevent) {
+                if (this.props.onClick) {
+                    this.props.onClick();
+                }
+            }
+        }, this.delay);
+    }
+
+    onDoubleClick = () => {
+        clearTimeout(this.timer);
+        this.prevent = true;
+        if (this.props.onDoubleClick) {
+            this.props.onDoubleClick();
+        }
+        setTimeout(() => {
+            this.prevent = false;
+        }, this.delay);
+    }
+
+    onActionMenuClick = (event: React.MouseEvent<HTMLElement>) => {
+        event.preventDefault();
+        event.stopPropagation();
+    }
+
+    render() {
+
+        let classes = classNames('table-list__item', {
+            'table-list__item--clickable': this.props.onClick,
+            'table-list__item--draggable': this.props.dragAndDrop,
+            'table-list__item--locked': this.props.locked,
+            'table-list__item--position-locked': this.props.positionLocked,
+            'table-list__item--drag-handles-always': !this.props.showDragHandle,
+            'table-list__item--drag-handles-none': this.props.showDragHandle === 'none',
+        });
+
+        return (
+            this.props.addItem ?
+                <div className='table-list__item-container'>
+                    <div
+                        role='listitem'
+                        onClick={() => this.onSingleClick()}
+                        onDoubleClick={() => this.onDoubleClick()}
+                        className={classes}>
+                        <div className='table-list__item-border' style={{ backgroundColor: this.props.hexColor }}></div>
+                        <div className='table-list__item-content'>
+                            <div className='table-list__item-content-block'>
+                                {this.props.start && this.props.start}
+                            </div>
+                            <div className='table-list__item-content-block table-list__item-content-block--center'>
+                                {this.props.center && this.props.center}
+                            </div>
+                            <div className='table-list__item-content-block'>
+                                {this.props.end && this.props.end}
+                            </div>
+                        </div>
+                        {this.props.action && <div className='table-list__slide-in-actions' onClick={this.onActionMenuClick}>
+                            {this.props.action}
+                        </div>}
+                    </div>
+                    <div className='table-list__add-bar-container'>
+                        <Tooltip text='Add item' flow='top' appendToBody={true}>
+                            <div className='table-list__add-bar'>
+                                <Dropdown
+                                    onChange={this.props.onAddItem}
+                                    items={this.props.itemsDropdown ? this.props.itemsDropdown() : []}>
+                                    <Button
+                                        type="primary"
+                                        icon="plus-large"
+                                        text="Add item"
+                                        size="small"
+                                        shape="round"
+                                        iconOnly={true}
+                                        onClick={() => false}
+                                    />
+                                </Dropdown>
+                            </div>
+                        </Tooltip>
+                    </div>
+                </div>
+                : <div
+                    role='listitem'
+                    className={`${classes} table-list__item--margin`}
+                    onClick={() => this.onSingleClick()}
+                    onDoubleClick={() => this.onDoubleClick()}>
+                    <div className='table-list__item-border' style={{ backgroundColor: this.props.hexColor }}></div>
+                    <div className='table-list__item-content'>
+                        <div className='table-list__item-content-block'>
+                            {this.props.start && this.props.start}
+                        </div>
+                        <div className='table-list__item-content-block table-list__item-content-block--center'>
+                            {this.props.center && this.props.center}
+                        </div>
+                        <div className='table-list__item-content-block'>
+                            {this.props.end && this.props.end}
+                        </div>
+                    </div>
+                    {this.props.action && <div className='table-list__slide-in-actions' onClick={this.onActionMenuClick}>
+                        {this.props.action}
+                    </div>}
+                </div>
+        );
+    }
+}
+
+class PortalItem extends React.PureComponent {
+    props: any;
+    render() {
+        const provided = this.props.provided;
+        const snapshot = this.props.snapshot;
+
+        const usePortal: boolean = snapshot.isDragging;
+
+        const child = (
+            <div
+                ref={provided.innerRef}
+                {...provided.draggableProps}
+                {...provided.dragHandleProps}>
+                <TableListItem
+                    dragAndDrop={this.props.dragAndDrop}
+                    start={this.props.item.start}
+                    center={this.props.item.center}
+                    end={this.props.item.end}
+                    action={this.props.item.action}
+                    onClick={this.props.item.onClick ? this.props.item.onClick : undefined}
+                    onDoubleClick={this.props.item.onDoubleClick
+                        ? this.props.item.onDoubleClick
+                        : undefined}
+                    addItem={this.props.addItem}
+                    itemsDropdown={this.props.itemsDropdown}
+                    hexColor={this.props.item.hexColor}
+                    locked={this.props.item.locked}
+                    positionLocked={this.props.item.positionLocked}
+                    onAddItem={() => this.props.onAddItem}
+                    showDragHandle={this.props.showDragHandle}
+                />
+            </div>
+        );
+
+        if (!usePortal) {
+            return child;
+        }
+
+        // if dragging - put the item in a portal
+        return ReactDOM.createPortal(child, document.body);
+    }
+}
+
+export {
+    TableList, TableListItem
+};

package/app-typescript/components/Lists/index.tsx

@@ -0,0 +1,2 @@
+export { SimpleList, SimpleListItem } from './SimpleList';
+export { BoxedList, BoxedListItem, BoxedListContentRow } from './BoxedList';

package/app-typescript/components/Menu.tsx

@@ -1,5 +1,9 @@
-import React, {SyntheticEvent} from 'react';
+import * as React from 'react';
+import {SyntheticEvent} from 'react';
+
 import {TieredMenu} from '@superdesk/primereact/tieredmenu';
+import {MenuItem as IPrimeMenuItem} from '@superdesk/primereact/components/menuitem/MenuItem';
+import {assertNever} from '../helpers';
 
 /**
  * Known issues:
@@ -58,6 +62,18 @@ interface IProps {
 
 const superdeskTopBarZIndex = 1030;
 
+function isSeparator(item: IMenuItem): item is ISeparator {
+    return (item as any)['separator'] === true;
+}
+
+function isMenuLeaf(item: IMenuItem): item is IMenuLeaf {
+    return (item as any)['onClick'] != null;
+}
+
+function isMenuBranch(item: IMenuItem): item is IMenuBranch {
+    return isSeparator(item) !== true && isMenuLeaf(item) !== true;
+}
+
 export class Menu extends React.Component<IProps, {}> {
     private menu: TieredMenu | null;
     private focusedBefore: Element | null;
@@ -73,26 +89,34 @@ export class Menu extends React.Component<IProps, {}> {
         this.toPrimeReactInterface = this.toPrimeReactInterface.bind(this);
     }
 
-    private toPrimeReactInterface(items: Array<any>): any {
+    private toPrimeReactInterface(items: Array<IMenuItem>): Array<IPrimeMenuItem> {
         return items.map((item) => {
-            if (item.separator != null) {
+            if (isSeparator(item)) {
                 return {separator: true};
-            } else if (item.children != null) {
+            } else if (isMenuBranch(item)) {
                 return {
                     label: item.label,
                     icon: item.icon,
                     items: this.toPrimeReactInterface(item.children),
                 };
-            } else {
+            } else if (isMenuLeaf(item)) {
                 return {
                     label: item.label,
                     icon: item.icon,
-                    command: (event: SyntheticEvent) => {
-                        this.close(event);
+                    command: (event) => {
+                        /**
+                         * a click on menu item should not trigger other click handlers
+                         * above in the DOM tree. e.g. if menu is inside a clickable list item
+                         */
+                        event.originalEvent.stopPropagation();
+
+                        this.close(event.originalEvent as unknown as SyntheticEvent);
                         item.onClick();
                     },
                     disabled: item.disabled,
                 };
+            } else {
+                return assertNever(item);
             }
         });
     }
@@ -107,7 +131,7 @@ export class Menu extends React.Component<IProps, {}> {
 
     render() {
         return (
-            <div>
+            <React.Fragment>
                 {
                     this.props.children(this.toggle)
                 }
@@ -143,7 +167,7 @@ export class Menu extends React.Component<IProps, {}> {
                         baseZIndex={this.props.zIndex ?? superdeskTopBarZIndex}
                     />
                 </div>
-            </div>
+            </React.Fragment>
         );
     }
 }

package/app-typescript/components/Modal.tsx

@@ -1,38 +1,51 @@
-import React from 'react';
+import * as React from 'react';
 import { Dialog as PrimeDialog } from '@superdesk/primereact/dialog';
+import classNames from 'classnames';
 
 interface IProps {
     id?: string;
     className?: string;
     theme?: string;
     visible?: boolean;
+    contentBg?: 'default' | 'medium' | 'dark';
+    contentPadding?: 'none' | 'small' | 'medium' | 'large';
     size?: 'small' | 'medium' | 'large' | 'x-large';
     maximized?: boolean;
     headerTemplate?: JSX.Element | string;
     footerTemplate?: JSX.Element | string;
     closeOnEscape?: boolean;
+    zIndex?: number;
     onShow?(): void;
     onHide(): void;
 }
 
 export class Modal extends React.Component<IProps, {}> {
     render() {
-        return <div style={{display: 'content'}}
-            data-theme={this.props.theme !== 'dark' ? '' : 'dark-ui' }
-            className={this.props.className}>
-            <PrimeDialog
-                id={this.props.id}
-                visible={this.props.visible}
-                header={this.props.headerTemplate}
-                footer={this.props.footerTemplate}
-                closeOnEscape={this.props.closeOnEscape}
-                maximized={this.props.maximized}
-                contentClassName={this.props.size ?
-                    ('p-dialog-content--' + this.props.size) : undefined}
-                onShow={this.props.onShow}
-                onHide={this.props.onHide}>
-                {this.props.children}
-            </PrimeDialog>
-        </div>;
+        let classes = classNames({
+            [`p-dialog-content--${this.props.size}`]: this.props.size,
+            'p-dialog-content--default': this.props.contentBg === undefined,
+            [`p-dialog-content--${this.props.contentBg}`]: this.props.contentBg,
+            'p-dialog-content--s-padding': this.props.contentPadding === undefined,
+            [`p-dialog-content--${this.props.contentPadding}`]: this.props.contentPadding,
+        }, this.props.className);
+        return (
+            <div style={{display: 'content'}}
+                data-theme={this.props.theme !== 'dark' ? null : 'dark-ui' }>
+                <PrimeDialog
+                    id={this.props.id}
+                    visible={this.props.visible}
+                    header={this.props.headerTemplate}
+                    footer={this.props.footerTemplate}
+                    closeOnEscape={this.props.closeOnEscape}
+                    maximized={this.props.maximized}
+                    contentClassName={classes}
+                    onShow={this.props.onShow}
+                    onHide={this.props.onHide}
+                    zIndex={this.props.zIndex}
+                >
+                    {this.props.children}
+                </PrimeDialog>
+            </div>
+        );
     }
 }

package/app-typescript/components/MultiSelect.tsx

@@ -0,0 +1,99 @@
+import * as React from "react";
+import { MultiSelect as PrimeMultiSelect } from "@superdesk/primereact/multiselect";
+import classNames from 'classnames';
+import nextId from "react-id-generator";
+import { InputWrapper } from "./Form";
+
+interface IProps<T> {
+    value: Array<T>;
+    options: Array<T>;
+    placeholder?: string;
+    optionLabel: string;
+    emptyFilterMessage?: string;
+    filterPlaceholder?: string;
+    maxSelectedLabels?: number;
+    selectedItemsLabel?: string;
+    ariaLabelledBy?: string;
+    tabIndex?: string | any;
+    filter?: boolean;
+    showClear?: boolean;
+    showSelectAll?: boolean;
+    itemTemplate?(item: any): JSX.Element | undefined;
+    selectedItemTemplate?(value: any): JSX.Element | undefined;
+    onChange(newValue: string): void;
+    invalid?: boolean;
+    inlineLabel?: boolean;
+    labelHidden?: boolean;
+    tabindex?: number;
+    fullWidth?: boolean;
+    info?: string;
+    error?: string;
+    required?: boolean;
+    label?: string;
+    disabled?: boolean;
+}
+
+interface IState<T> {
+    options: Array<T>;
+    value: Array<T>;
+    invalid: boolean;
+}
+
+export class MultiSelect<T> extends React.Component<IProps<T>, IState<T>> {
+    private htmlId = nextId();
+
+    constructor(props: IProps<T>) {
+        super(props);
+        this.state = {
+            value: [],
+            options: [],
+            invalid: this.props.invalid ? this.props.invalid : false,
+        };
+    }
+
+    render() {
+
+        let classes = classNames({
+            'showSelectAll': this.props.showSelectAll,
+            'showFilter': this.props.filter,
+        });
+
+        return (
+            <InputWrapper
+            label={this.props.label}
+            error={this.props.error}
+            required={this.props.required}
+            disabled={this.props.disabled}
+            invalid={this.state.invalid}
+            info={this.props.info}
+            inlineLabel={this.props.inlineLabel}
+            labelHidden={this.props.labelHidden}
+            fullWidth={this.props.fullWidth}
+            htmlId={this.htmlId}
+            tabindex={this.props.tabindex}>
+                <PrimeMultiSelect
+                panelClassName={classes}
+                value={this.props.value}
+                options={this.props.options}
+                onChange={(e: any) => this.props.onChange(e)}
+                display="chip"
+                filter={this.props.filter}
+                filterBy={this.props.optionLabel}
+                appendTo={document.body}
+                placeholder={this.props.placeholder}
+                optionLabel={this.props.optionLabel}
+                emptyFilterMessage={this.props.emptyFilterMessage}
+                filterPlaceholder={this.props.filterPlaceholder}
+                itemTemplate={this.props.itemTemplate}
+                selectedItemTemplate={this.props.selectedItemTemplate}
+                maxSelectedLabels={this.props.maxSelectedLabels ?? 4}
+                selectedItemsLabel={this.props.selectedItemsLabel}
+                ariaLabelledBy={this.htmlId + 'label'}
+                tabIndex={this.props.tabIndex ? this.props.tabIndex : '0'}
+                showClear={this.props.showClear}
+                disabled={this.props.disabled}
+                inputId={this.htmlId} />
+            </InputWrapper>
+        );
+    }
+}