superdesk-ui-framework 2.4.12 → 2.4.17

package/app/scripts/modals.js

@@ -60,9 +60,8 @@ function sdModal($document, $rootScope) {
             };
 
             $document.bind('keydown', (evt) => {
-                evt.preventDefault();
-
                 if (evt.which === 27 && $rootScope.modals > 0) {
+                    evt.preventDefault();
                     closeModal();
                 }
             });

package/app/styles/app.scss

@@ -73,6 +73,7 @@
 @import 'form-elements/checkbox';
 @import 'form-elements/radio';
 @import 'form-elements/autocomplete';
+@import 'form-elements/select-grid';
 
 // Menus
 @import 'menus/sd-sidebar-menu';

package/app/styles/form-elements/_select-grid.scss

@@ -0,0 +1,77 @@
+.select-grid__overlay-panel {
+    z-index: 1500 !important;
+    margin-top: 1px;
+}
+
+.select-grid__panel {
+    width: 450px;
+    max-height: 550px;
+    background-color: var(--color-bg-00);
+    display: flex;
+    flex-direction: column;
+}
+
+.select-grid__header {
+    padding: 1rem;
+    box-shadow: 0 1px 0 0 rgba(0, 0, 0, 0.1);
+}
+
+.select-grid__body {
+    overflow-y: auto;
+    margin: 0;
+    padding: 1rem;
+    position: relative;
+}
+
+.select-grid__item {
+    display: flex;
+    flex-direction: column;
+    align-items: center;
+    color: $sd-text;
+
+    &:hover, &:focus {
+        color: $sd-blue;
+        cursor: pointer;
+
+        i {
+            color: $sd-blue;
+        }
+    }
+
+    &:hover {
+        background: $sd-colour-background__menu-item--hover;
+    }
+
+    &:focus {
+        outline: 2px solid $sd-colour-interactive__base;
+        outline-offset: -2px;
+    }
+}
+
+.sd-input--grid-select {
+    .btn {
+        grid-row: 2/3;
+        grid-column: 2/4;
+        background-color: var(--color-input-bg);
+        border-bottom: 1px solid var(--color-input-border);
+        width: 3.2rem;
+    }
+
+    .btn:hover {
+        background-color: var(--color-input-bg--hover);
+        border-color: var(--color-input-border-hover);
+    }
+
+    .btn:focus {
+        background-color: var(--color-input-bg--focus);
+        box-shadow: 0 1px 0 0 $sd-blue;
+    }
+}
+
+.form__item--auto-width {
+    .sd-input--grid-select {
+        .btn {
+            margin-top: 0;
+        }
+    }
+}

package/app-typescript/components/Dropdown.tsx

@@ -158,7 +158,6 @@ export const Dropdown = ({
                     if (toggleRef && menuRef) {
                         createPopper(toggleRef, menuRef, {
                             placement: checkAlign() ? 'bottom-end' : 'bottom-start',
-                            strategy: 'fixed',
                         });
                         menuRef.style.display = 'block';
                     }

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/SelectGrid.tsx

@@ -0,0 +1,233 @@
+import React from 'react';
+import nextId from "react-id-generator";
+import { OverlayPanel } from '@superdesk/primereact/overlaypanel';
+import { Loader } from "./Loader";
+
+/**
+ * @ngdoc react
+ * @name SelectGrid
+ * @description searchable select component with grid view of items
+ */
+
+export interface IItem {
+    value: string;
+    label: string;
+    [extra: string]: any;
+}
+
+interface IProps {
+    getItems(searchString: string | null): Promise<Array<IItem>>;
+    onChange(value: IItem): void;
+    itemTemplate: React.ComponentType<{ item: IItem | null }>;
+    triggerTemplate: React.ComponentType<any>;
+    label: string;
+    filterPlaceholder?: string;
+}
+
+interface IState {
+    items: Array<IItem>;
+    loading: boolean;
+    isOpen: boolean;
+}
+
+export class SelectGrid extends React.PureComponent<IProps, IState> {
+    htmlId = nextId();
+    buttonContainer: React.RefObject<HTMLDivElement>;
+    overlayPanel: React.RefObject<OverlayPanel>;
+    searchInput: React.RefObject<HTMLInputElement>;
+    gridContainer: React.RefObject<HTMLDivElement>;
+
+    constructor(props: IProps) {
+        super(props);
+
+        this.state = { items: [], loading: true, isOpen: false };
+
+        this.buttonContainer = React.createRef();
+        this.overlayPanel = React.createRef();
+        this.searchInput = React.createRef();
+        this.gridContainer = React.createRef();
+    }
+
+    componentDidMount() {
+        this.props.getItems(null).then((items) => {
+            this.setState({ items, loading: false });
+        });
+    }
+
+    componentWillUnmount() {
+        document.removeEventListener('keydown', this.handleKeydown);
+    }
+
+    togglePopup = (event?: React.SyntheticEvent) => {
+        if (!event) {
+            // @ts-ignore
+            this.overlayPanel.current.hide();
+        } else {
+            // @ts-ignore
+            this.overlayPanel.current.toggle(event);
+        }
+
+        setTimeout(() => {
+            // Now that the popup has (dis)appeared handle items and events
+
+            if (this.state.isOpen) {
+                document.removeEventListener('keydown', this.handleKeydown);
+                // @ts-ignore
+                this.buttonContainer.current.querySelector('button')?.focus();
+            } else {
+                document.addEventListener('keydown', this.handleKeydown);
+                this.loadItems();
+                // @ts-ignore
+                this.searchInput.current.focus();
+            }
+
+            this.setState({ isOpen: !this.state.isOpen });
+        });
+
+    }
+
+    search = (event: React.ChangeEvent<HTMLInputElement>) => {
+        const searchString: string = event.target.value.toLowerCase();
+        this.loadItems(searchString);
+    }
+
+    loadItems = (searchString: string | null = null) => {
+        this.setState({ loading: true });
+        this.props.getItems(searchString).then((items) => {
+            this.setState({ items, loading: false });
+        });
+    }
+
+    select = (item: IItem) => {
+        this.props.onChange(item);
+        this.togglePopup();
+    }
+
+    getItemElement = (index: number): HTMLDivElement | null | undefined => {
+        return this.gridContainer.current?.querySelector(`[data-item-index="${index}"]`);
+    }
+
+    handleKeydown = (event: KeyboardEvent) => {
+        const navKeys = [
+            "Enter",
+            "ArrowRight",
+            "ArrowLeft",
+            "ArrowUp",
+            "ArrowDown",
+            "PageDown",
+            "PageUp",
+        ];
+        const activeElement = document.activeElement;
+
+        if (event.code === "Escape") {
+            event.preventDefault();
+            event.stopPropagation();
+            this.togglePopup();
+        } else if (activeElement === this.searchInput?.current) {
+            if (event.code === "ArrowDown") {
+                event.preventDefault();
+                this.getItemElement(0)?.focus();
+            } else if (event.code === "Enter" && this.state.items.length === 1) {
+                event.preventDefault();
+                this.select(this.state.items[0]);
+            }
+            // @ts-ignore
+        } else if (document.activeElement.getAttribute('data-item-index') && navKeys.includes(event.code)) {
+            // @ts-ignore
+            let itemIndex = parseInt(activeElement.getAttribute('data-item-index'), 10);
+
+            // Prevent default behaviour, such as scrolling
+            event.preventDefault();
+            if (event.code === "Enter") {
+                this.select(this.state.items[itemIndex]);
+                return;
+            } else if (event.code === "ArrowRight") {
+                itemIndex += 1;
+            } else if (event.code === "ArrowLeft") {
+                itemIndex -= 1;
+            } else if (event.code === "ArrowDown") {
+                itemIndex += 4;
+            } else if (event.code === "ArrowUp") {
+                if (itemIndex === 0) {
+                    this.searchInput?.current?.focus();
+                    return;
+                }
+                itemIndex -= 4;
+            } else if (event.code === "PageDown") {
+                itemIndex += 16;
+            } else if (event.code === "PageUp") {
+                itemIndex -= 16;
+            }
+
+            if (itemIndex < 0) {
+                itemIndex = 0;
+            } else if (itemIndex >= this.state.items.length) {
+                itemIndex = this.state.items.length - 1;
+            }
+
+            this.getItemElement(itemIndex)?.focus();
+        }
+    }
+
+    render() {
+        const ItemTemplate = this.props.itemTemplate;
+        const TriggerTemplate = this.props.triggerTemplate;
+
+        return (
+            <React.Fragment>
+                <div
+                    className="sd-input sd-input--grid-select"
+                    ref={this.buttonContainer}
+                    aria-label={this.props.label}
+                >
+                    <label className="sd-input__label">
+                        {this.props.label}
+                    </label>
+                    <TriggerTemplate onClick={this.togglePopup} />
+
+                </div>
+                <OverlayPanel
+                    ref={this.overlayPanel}
+                    dismissable={true}
+                    className="select-grid__overlay-panel"
+                    appendTo={document.body} // making it work inside `overflow:hidden`
+                >
+                    <div className="sd-shadow--z3 select-grid__panel">
+                        <div className="select-grid__header">
+                            <div className="sd-searchbar sd-searchbar--boxed">
+                                <label className="sd-searchbar__icon" />
+                                <input
+                                    className="sd-searchbar__input"
+                                    placeholder={this.props.filterPlaceholder || 'Search...'}
+                                    type="text"
+                                    onChange={this.search}
+                                    ref={this.searchInput}
+                                />
+                            </div>
+                        </div>
+                        <div
+                            className="select-grid__body flex-grid flex-grid--wrap-items flex-grid--small-4 flex-grid--boxed"
+                            ref={this.gridContainer}
+
+                        >
+                            <Loader overlay={this.state.loading} />
+                            {this.state.items.map((item, index) => (
+                                <div
+                                    key={this.htmlId + item.label}
+                                    data-item-index={index}
+                                    className="flex-grid__item select-grid__item sd-padding-y--2"
+                                    tabIndex={0}
+                                    role="button"
+                                    aria-label={item.name}
+                                    onClick={() => this.select(item)}
+                                >
+                                    <ItemTemplate item={item} />
+                                </div>
+                            ))}
+                        </div>
+                    </div>
+                </OverlayPanel>
+            </React.Fragment>
+        );
+    }
+}

package/app-typescript/index.ts

@@ -63,6 +63,8 @@ export { GridItem, GridItemContent, GridItemMedia, GridItemFooter, GridItemConte
 export { toasted } from './components/Toast';
 export { Menu } from './components/Menu';
 export { ToggleBox } from './components/Togglebox';
+export { SelectGrid } from './components/SelectGrid';
+export { IconPicker } from './components/IconPicker';
 
 export { Skeleton } from './components/Skeleton';
 export { ListItemLoader } from './components/ListItemLoader';