superdesk-ui-framework 2.4.14 → 2.4.15

package/app-typescript/components/IconPicker.tsx

@@ -0,0 +1,277 @@
+import * as React from 'react';
+// @ts-ignore
+import * as iconFont from '../../app/styles/_icon-font.scss';
+import { Button } from './Button';
+import { Icon } from './Icon';
+import { IItem, SelectGrid } from "./SelectGrid";
+
+interface IProps {
+    label?: string;
+    filterPlaceholder?: string;
+    translateFunction?: (text: string) => string;
+    value: string;
+    onChange(icon: string): void;
+}
+
+interface IState {
+    icons: Array<IItem>;
+}
+
+export class IconPicker extends React.PureComponent<IProps, IState> {
+
+    constructor(props: IProps) {
+        super(props);
+        this.state = { icons: [] };
+    }
+
+    componentDidMount() {
+        const translateFunction = this.props.translateFunction ?
+            this.props.translateFunction : (text: string): string => text;
+        this.setState({
+            icons: getIcons(translateFunction),
+        });
+    }
+
+    getItems = (searchString: string | null): Promise<Array<IItem>> => {
+        return new Promise((resolve) => {
+            let icons = [...this.state.icons];
+
+            if (searchString) {
+                icons = icons.filter(
+                    (icon) => (
+                        icon.value.toLowerCase().includes(searchString) ||
+                        icon.label.toLowerCase().includes(searchString)
+                    ),
+                );
+            }
+            resolve(icons);
+        });
+    }
+
+    onChange = (item: IItem) => {
+        this.props.onChange(item.value);
+    }
+
+    triggerTemplate = (props: any) => <Button
+        icon={this.props.value}
+        text={this.props.value}
+        onClick={(e) => { props.onClick(e); }}
+        iconOnly={true} />
+
+    itemTemplate = ({ item }: { item: IItem | null }) => item ?
+        (<>
+            <Icon name={item.value} />
+            <span className="sd-text__normal sd-padding-t--1">
+                {item.label}
+            </span>
+        </>) : null
+
+    render() {
+        return (
+            <SelectGrid
+                label={this.props.label || "Icon"}
+                filterPlaceholder={this.props.filterPlaceholder || "Search..."}
+                getItems={this.getItems}
+                onChange={this.onChange}
+                itemTemplate={this.itemTemplate}
+                triggerTemplate={this.triggerTemplate}
+            />
+        );
+    }
+}
+
+const getIcons = (translateFunction: (text: string) => string): Array<IItem> => {
+    const translatedIconNameMap: any = {
+        'add-gallery': 'Add Gallery',
+        'add-image': 'Add Image',
+        'adjust': 'Adjust',
+        'align-center': 'Align Center',
+        'align-justify': 'Align Justify',
+        'align-left': 'Align Left',
+        'align-right': 'Align Right',
+        'amp': 'AMP',
+        'analytics': 'Analytics',
+        'archive': 'Archive',
+        'arrow-left': 'Arrow Left',
+        'arrow-right': 'Arrow Right',
+        'arrow-small': 'Arrow Small',
+        'ascending': 'Ascending',
+        'assign': 'Assign',
+        'attachment': 'Attachment',
+        'attachment-large': 'Attachment Large',
+        'audio': 'Audio',
+        'backward-thin': 'Backward Thin',
+        'ban-circle': 'Ban Circle',
+        'bell': 'Bell',
+        'bold': 'Bold',
+        'broadcast': 'Broadcast',
+        'broadcast-create': 'Broadcast Create',
+        'business': 'Business',
+        'calendar': 'Calendar',
+        'calendar-list': 'Calendar List',
+        'chevron-down-thin': 'Chevron Down Thin',
+        'chevron-left-thin': 'Chevron Left Thin',
+        'chevron-right-thin': 'Chevron Right Thin',
+        'chevron-up-thin': 'Chevron Up Thin',
+        'clear-all': 'Clear All',
+        'clear-format': 'Clear Format',
+        'close-small': 'Close Small',
+        'close-thick': 'Close Thick',
+        'code': 'Code',
+        'collapse': 'Collapse',
+        'comment': 'Comment',
+        'composite': 'Composite',
+        'copy': 'Copy',
+        'crop': 'Crop',
+        'cut': 'Cut',
+        'descending': 'Descending',
+        'dots': 'Dots',
+        'dots-vertical': 'Dots Vertical',
+        'download': 'Download',
+        'download-alt': 'Download Alternate',
+        'edit-line': 'Edit Line',
+        'envelope': 'Envelope',
+        'event': 'Event',
+        'exclamation-sign': 'Exclamation Sign',
+        'expand': 'Expand',
+        'expand-thin': 'Expand Thin',
+        'external': 'External',
+        'eye-open': 'Eye Open',
+        'facebook': 'Facebook',
+        'facebook-circle': 'Facebook Circle',
+        'fast_forward': 'Fast Forward',
+        'fast_rewind': 'Fast Rewind',
+        'fetch-as': 'Fetch As',
+        'file': 'File',
+        'filter-large': 'Filter Large',
+        'flip-horizontal': 'Flip Horizontal',
+        'flip-vertical': 'Flip Vertical',
+        'folder-close': 'Folder Close',
+        'folder-open': 'Folder Open',
+        'font': 'Font',
+        'forward-thin': 'Forward Thin',
+        'fullscreen': 'Fullscreen',
+        'globe': 'Globe',
+        'graphic': 'Graphic',
+        'grid-view': 'Grid View',
+        'grid-view-large': 'Grid View Large',
+        'heading-1': 'Heading 1',
+        'heading-2': 'Heading 2',
+        'heading-3': 'Heading 3',
+        'heading-4': 'Heading 4',
+        'heading-5': 'Heading 5',
+        'heading-6': 'Heading 6',
+        'heart': 'Heart',
+        'help-large': 'Help Large',
+        'highlight-package': 'Highlight Package',
+        'home': 'Home',
+        'indent-left': 'Indent Left',
+        'indent-right': 'Indent Right',
+        'info-large': 'Info Large',
+        'info-sign': 'Info Sign',
+        'ingest': 'Ingest',
+        'instagram': 'Instagram',
+        'italic': 'Italic',
+        'kanban-view': 'Kanban View',
+        'kill': 'Kill',
+        'link': 'Link',
+        'linked-in': 'LinkedIn',
+        'linked-in-circle': 'LinkedIn Circle',
+        'list-alt': 'List Alternate',
+        'list-menu': 'List Menu',
+        'list-plus': 'List Plus',
+        'list-view': 'List View',
+        'lock': 'Lock',
+        'map-marker': 'Map Marker',
+        'minus-sign': 'Minus Sign',
+        'minus-small': 'Minus Small',
+        'mobile': 'Mobile',
+        'move': 'Move',
+        'multi-star': 'Multi Start',
+        'multiedit': 'Multi Edit',
+        'new-doc': 'New Document',
+        'ok': 'Okay',
+        'ordered-list': 'Ordered List',
+        'package-create': 'Package Create',
+        'package-plus': 'Package Plus',
+        'paragraph': 'Paragraph',
+        'paste': 'Paste',
+        'pause': 'Pause',
+        'paywall': 'Paywall',
+        'pencil': 'Pencil',
+        'phone': 'Phone',
+        'photo': 'Photo',
+        'pick': 'Pick',
+        'picture': 'Picture',
+        'pin': 'Pin',
+        'play': 'Play',
+        'plus-large': 'Plus Large',
+        'plus-sign': 'Plus Sign',
+        'plus-small': 'Plus Small',
+        'post': 'Post',
+        'preformatted': 'Preformatted',
+        'preview-mode': 'Preview Mode',
+        'print': 'Print',
+        'question-sign': 'Question Sign',
+        'quote': 'Quote',
+        'random': 'Random',
+        'recurring': 'Recurring',
+        'redo': 'Redo',
+        'refresh': 'Refresh',
+        'remove-sign': 'Remove Sign',
+        'repeat': 'Repeat',
+        'retweet': 'Retweet',
+        'revert': 'Revert',
+        'rotate-left': 'Rotate Left',
+        'rotate-right': 'Rotate Right',
+        'search': 'Search',
+        'settings': 'Settings',
+        'share-alt': 'Share Alternate',
+        'signal': 'Signal',
+        'skip_next': 'Skip Next',
+        'skip_previous': 'Skip Previous',
+        'slideshow': 'Slideshow',
+        'star': 'Star',
+        'star-empty': 'Star Empty',
+        'stop': 'Stop',
+        'stream': 'Stream',
+        'strikethrough': 'Strikethrough',
+        'subscript': 'Subscript',
+        'suggestion': 'Suggestion',
+        'superscript': 'Superscript',
+        'switches': 'Switches',
+        'table': 'Table',
+        'takes-package': 'Takes Package',
+        'tasks': 'Tasks',
+        'text': 'Text',
+        'text-format': 'Text Format',
+        'th': 'Table Header',
+        'th-large': 'Table Header Large',
+        'th-list': 'Table Header List',
+        'time': 'Time',
+        'to-lowercase': 'To Lowercase',
+        'to-uppercase': 'To Uppercase',
+        'trash': 'Trash',
+        'twitter': 'Twitter',
+        'twitter-circle': 'Twitter Circle',
+        'underline': 'Underline',
+        'undo': 'Undo',
+        'unlocked': 'Unlocked',
+        'unordered-list': 'Unordered List',
+        'unspike': 'Unspike',
+        'upload': 'Upload',
+        'user': 'User',
+        'video': 'Video',
+        'warning-sign': 'Warning Sign',
+        'zoom-in': 'Zoom In',
+        'zoom-out': 'Zoom Out',
+    };
+
+    return iconFont.icon
+        .split(', ')
+        .sort()
+        .map((icon: string) => ({
+            value: icon,
+            label: translatedIconNameMap[icon] ? translateFunction(translatedIconNameMap[icon]) : icon,
+        }));
+};

package/app-typescript/components/ListItemLoader.tsx

@@ -0,0 +1,30 @@
+import * as React from 'react';
+import { Skeleton } from './Skeleton';
+
+export class ListItemLoader extends React.Component<{}> {
+    render() {
+        return (
+            <div className="sd-list-item sd-shadow--z1 sd-list-item--no-hover">
+                <div className="sd-list-item__border"></div>
+                <div className="sd-list-item__column">
+                    <Skeleton shape="circle" size="2rem" />
+                </div>
+                <div className="sd-list-item__column sd-padding-y--1">
+                    <Skeleton shape="circle" size="2rem" className="sd-margin-b--0-5" />
+                    <Skeleton shape="circle" size="2rem" />
+                </div>
+                <div className="sd-list-item__column sd-list-item__column--grow sd-list-item__column--no-border">
+                    <div className="sd-list-item__row sd-padding-b--0-5">
+                        <Skeleton borderRadius="16px" />
+                        <Skeleton width="10rem" borderRadius="16px" className="sd-margin-l--0-5" />
+                    </div>
+                    <div className="sd-list-item__row">
+                        <Skeleton width="8rem" borderRadius="16px" />
+                        <Skeleton width="8rem" borderRadius="16px" className="sd-margin-l--0-5" />
+                        <Skeleton width="8rem" borderRadius="16px" className="sd-margin-l--0-5" />
+                    </div>
+                </div>
+            </div>
+        );
+    }
+}

package/app-typescript/components/Menu.tsx

@@ -0,0 +1,149 @@
+import React, {SyntheticEvent} from 'react';
+import {TieredMenu} from '@superdesk/primereact/tieredmenu';
+
+/**
+ * Known issues:
+ *
+ * 1. Menu detaches from trigger element when scrolling.
+ * Closing the menu on scroll would fix it,
+ * but in case there are more items than
+ * can fit in the screen, some wouldn't be selectable.
+ *
+ * 2. In some cases, menus will be rendered outside of viewport.
+ * When the menu is triggered, it will check whether
+ * there is more space available on the left or right
+ * and will render submenus in that direction.
+ * It only checks available space relatively to the trigger element.
+ * If there's no space left after n submenus have been opened,
+ * it won't change direction.
+ *
+ * Accessibility features:
+ * * ESC closes the last sub-menu or entire menu
+ * * When menu is closed via ESC, focus returns to the element that was focused before opening the menu
+ * * Focuses the first item on activation
+ * * Focuses first sub-menu item when sub-menu opens
+ * * ENTER/ESC or arrow keys work for entering/leaving submenus
+ */
+
+export type IMenuItem = IMenuBranch | IMenuLeaf | ISeparator;
+
+/**
+ * Available icons are listed here:
+ * https://ui-framework.superdesk.org/#/components/icons
+ */
+type IIconName = string;
+
+interface ISeparator {
+    separator: true;
+}
+
+interface IMenuLeaf {
+    label: string;
+    icon?: IIconName;
+    onClick(): void;
+    disabled?: boolean;
+}
+
+interface IMenuBranch {
+    label: string;
+    icon?: IIconName;
+    children: Array<IMenuItem>;
+}
+
+interface IProps {
+    items: Array<IMenuItem>;
+    children: (toggle: (event: SyntheticEvent) => void) => JSX.Element;
+    zIndex?: number;
+}
+
+const superdeskTopBarZIndex = 1030;
+
+export class Menu extends React.Component<IProps, {}> {
+    private menu: TieredMenu | null;
+    private focusedBefore: Element | null;
+
+    constructor(props: IProps) {
+        super(props);
+
+        this.menu = null;
+        this.focusedBefore = null;
+
+        this.close = this.close.bind(this);
+        this.toggle = this.toggle.bind(this);
+        this.toPrimeReactInterface = this.toPrimeReactInterface.bind(this);
+    }
+
+    private toPrimeReactInterface(items: Array<any>): any {
+        return items.map((item) => {
+            if (item.separator != null) {
+                return {separator: true};
+            } else if (item.children != null) {
+                return {
+                    label: item.label,
+                    icon: item.icon,
+                    items: this.toPrimeReactInterface(item.children),
+                };
+            } else {
+                return {
+                    label: item.label,
+                    icon: item.icon,
+                    command: (event: SyntheticEvent) => {
+                        this.close(event);
+                        item.onClick();
+                    },
+                    disabled: item.disabled,
+                };
+            }
+        });
+    }
+
+    private toggle(event: SyntheticEvent) {
+        this.menu?.toggle(event);
+    }
+
+    private close(event: SyntheticEvent) {
+        this.menu?.toggle(event);
+    }
+
+    render() {
+        return (
+            <div>
+                {
+                    this.props.children(this.toggle)
+                }
+
+                <div
+                    onKeyDown={(event) => {
+                        if (event.key === 'Escape') {
+                            event.stopPropagation();
+
+                            this.close(event);
+
+                            if (this.focusedBefore instanceof HTMLElement) {
+                                this.focusedBefore.focus();
+                            }
+                        }
+                    }}
+                >
+                    <TieredMenu
+                        popup
+                        model={this.toPrimeReactInterface(this.props.items)}
+                        ref={(el) => this.menu = el}
+                        appendTo={document.body}
+                        onShow={() => {
+                            this.focusedBefore = document.activeElement;
+
+                            const firstMenuItem = document.querySelectorAll('.p-tieredmenu [role="menuitem"]')[0];
+
+                            if (firstMenuItem instanceof HTMLElement) {
+                                firstMenuItem.focus();
+                            }
+                        }}
+                        data-test-id="menu"
+                        baseZIndex={this.props.zIndex ?? superdeskTopBarZIndex}
+                    />
+                </div>
+            </div>
+        );
+    }
+}

package/app-typescript/components/PropsList.tsx

@@ -2,7 +2,7 @@ import * as React from 'react';
 
 interface IProps {
     name: string;
-    isRequered: boolean;
+    isRequired: boolean;
     type: string;
     default: string;
     description: string;
@@ -14,7 +14,7 @@ class Prop extends React.PureComponent<IProps> {
             <React.Fragment>
                 <tr>
                     <td>{this.props.name}</td>
-                    <td>{this.props.isRequered ? 'yes' : 'no'}</td>
+                    <td>{this.props.isRequired ? 'yes' : 'no'}</td>
                     <td>{this.props.type}</td>
                     <td>{this.props.default}</td>
                     <td>{this.props.description}</td>

package/app-typescript/components/Radio.tsx

@@ -1,15 +1,18 @@
 import * as React from 'react';
-import nextId from "react-id-generator";
+import nextId from 'react-id-generator';
+
+interface IOption {
+    label: string;
+    value: string;
+    disabled?: boolean;
+}
+
 interface IProps {
-    value?: string;
-    options: Array<{
-        label: string,
-        value: string,
-        disabled?: boolean
-    }>;
+    value?: IOption['value'];
+    options: Array<IOption>;
     labelSide?: 'left' | 'right'; // defaults to 'right'
     required?: boolean;
-    onChange(nextValue: string): void;
+    onChange(nextValue: IOption['value']): void;
 }
 export class Radio extends React.Component<IProps> {
     htmlId = nextId();
@@ -33,11 +36,17 @@ export class Radio extends React.Component<IProps> {
                     label-position={this.props.labelSide || null}
                     tabIndex={-1}>
 
-                    <input type="radio" className="sd-check-new__input" id={this.htmlId + index} tabIndex={0}
+                    <input
+                        type="radio"
+                        className="sd-check-new__input"
+                        id={this.htmlId + index}
+                        tabIndex={0}
                         name={this.htmlId}
                         onChange={() => this.handleChange(item)}
                         disabled={item.disabled}
-                        required={this.props.required} />
+                        required={this.props.required}
+                        checked={item.value === this.props.value}
+                    />
 
                     <span className="sd-radio-new"></span>
                     <label htmlFor={this.htmlId + index} >{item.label}</label>