Overflow set

common/changes/master_2017-05-02-22-52.json

@@ -8,3 +8,4 @@
   ],
   "email": "micahgodbolt@gmail.com"
 }
+

common/changes/overflow-set_2017-04-17-21-47.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "office-ui-fabric-react",
+      "comment": "OverflowSet: New Overflow Set componet to create sets of elements with overflow showing in callout",
+      "type": "patch"
+    }
+  ],
+  "email": "micahgodbolt@gmail.com"
+}

packages/office-ui-fabric-react/src/OverflowSet.ts

@@ -0,0 +1 @@
+export * from './components/OverflowSet/index';

packages/office-ui-fabric-react/src/components/OverflowSet/OverflowSet.Props.ts

@@ -0,0 +1,29 @@
+import * as React from 'react';
+import { OverflowSet } from './OverflowSet';
+import { IContextualMenuItem } from '../../ContextualMenu';
+import { IButtonProps } from '../../Button';
+import { IRenderFunction } from '../../Utilities';
+import { IObjectWithKey } from '../../Selection';
+
+export interface IOverflowSetProps extends React.Props<OverflowSet> {
+
+  /**
+   * An array of items to be rendered by your onRenderItem function in the primary content area
+  */
+  items?: any[] | IObjectWithKey[];
+
+  /**
+   * An array of items to be passed to overflow contextual menu
+  */
+  overflowItems?: IContextualMenuItem[];
+
+  /**
+   * Method to call when trying to render an item.
+  */
+  onRenderItem: IRenderFunction<any>;
+
+  /**
+   * Rendering method for overflow button and contextual menu.
+  */
+  onRenderOverflowButton: IRenderFunction<IButtonProps>;
+}

packages/office-ui-fabric-react/src/components/OverflowSet/OverflowSet.scss

@@ -0,0 +1,11 @@
+@import '../../common/common';
+
+.root {
+  position: relative;
+  display: flex;
+  flex-wrap: nowrap;
+}
+
+.item {
+  flex-shrink: 0;
+}

packages/office-ui-fabric-react/src/components/OverflowSet/OverflowSet.tsx

@@ -0,0 +1,46 @@
+import * as React from 'react';
+import {
+  css,
+  autobind,
+  BaseComponent
+} from '../../Utilities';
+import { IButtonProps } from '../../Button';
+import { IOverflowSetProps } from './OverflowSet.Props';
+import { FocusZone, FocusZoneDirection } from '../../FocusZone';
+
+import * as stylesImport from './OverflowSet.scss';
+const styles: any = stylesImport;
+
+export class OverflowSet extends BaseComponent<IOverflowSetProps, null> {
+
+  public render() {
+    let {
+      items,
+      overflowItems,
+      onRenderOverflowButton
+    } = this.props;
+
+    const overflowButtonProps: IButtonProps = {
+      menuProps: { items: overflowItems }
+    };
+
+    return (
+      <FocusZone className={ css('ms-OverflowSet', styles.root) } direction={ FocusZoneDirection.horizontal } role='menubar' >
+        { items && this._onRenderItems(items) }
+        { overflowItems.length && onRenderOverflowButton(overflowButtonProps) }
+      </FocusZone>
+    );
+  }
+
+  @autobind
+  private _onRenderItems(items: any[]): JSX.Element[] {
+    return items.map((item, i) => {
+      let key = item.key ? item.key : i;
+      return (
+        <div key={ key } className={ css('ms-OverflowSet-item', styles.item) }>
+          { this.props.onRenderItem(item) }
+        </div>
+      );
+    });
+  }
+}

packages/office-ui-fabric-react/src/components/OverflowSet/OverflowSetPage.tsx

@@ -0,0 +1,49 @@
+import * as React from 'react';
+import { Link } from 'office-ui-fabric-react/lib/Link';
+import { LayerHost } from 'office-ui-fabric-react/lib/Layer';
+import {
+  ExampleCard,
+  ComponentPage,
+  PropertiesTableSet
+} from '@uifabric/example-app-base';
+import { OverflowSetCustomExample } from './examples/OverflowSet.Custom.Example';
+import { OverflowSetBasicExample } from './examples/OverflowSet.Basic.Example';
+
+const OverflowSetCustomExampleCode = require('!raw-loader!office-ui-fabric-react/src/components/OverflowSet/examples/OverflowSet.Custom.Example.tsx') as string;
+const OverflowSetBasicExampleCode = require('!raw-loader!office-ui-fabric-react/src/components/OverflowSet/examples/OverflowSet.Basic.Example.tsx') as string;
+
+export class OverflowSetPage extends React.Component<any, any> {
+  public render() {
+    return (
+      <ComponentPage
+        title='OverflowSet'
+        componentName='OverflowSetExample'
+        overview={
+          <div>
+            <p>
+              The OverflowSet is a flexible container component that is useful for displaying a primary set of content with additional content in an overflow callout.
+              Note that the example below is only an example of how to render the component, not a specific use case.
+            </p>
+          </div>
+        }
+        exampleCards={
+          <LayerHost>
+            <ExampleCard title='OverflowSet Basic Example' code={ OverflowSetBasicExampleCode }>
+              <OverflowSetBasicExample />
+            </ExampleCard>
+            <ExampleCard title='OverflowSet Custom Example' code={ OverflowSetCustomExampleCode }>
+              <OverflowSetCustomExample />
+            </ExampleCard>
+          </LayerHost>
+        }
+        propertiesTables={
+          <PropertiesTableSet
+            sources={ [
+              require<string>('!raw-loader!office-ui-fabric-react/src/components/OverflowSet/OverflowSet.Props.ts')
+            ] }
+          />
+        }
+      />
+    );
+  }
+}

packages/office-ui-fabric-react/src/components/OverflowSet/examples/OverflowSet.Basic.Example.tsx

@@ -0,0 +1,71 @@
+/* tslint:disable:no-unused-variable */
+import * as React from 'react';
+/* tslint:enable:no-unused-variable */
+import { BaseComponent, css } from 'office-ui-fabric-react/lib/Utilities';
+import { IconButton } from 'office-ui-fabric-react/lib/Button';
+import { Link } from 'office-ui-fabric-react/lib/Link';
+import {
+  OverflowSet
+} from 'office-ui-fabric-react/lib/OverflowSet';
+
+import * as stylesImport from './OverflowSet.Example.scss';
+const styles: any = stylesImport;
+
+export class OverflowSetBasicExample extends BaseComponent<any, any> {
+
+  public render() {
+    return (
+      <OverflowSet
+        items={ [
+          {
+            key: 'item1',
+            name: 'Link 1',
+            ariaLabel: 'New. Use left and right arrow keys to navigate',
+            onClick: () => { return; },
+          },
+          {
+            key: 'item2',
+            name: 'Link 2',
+            onClick: () => { return; },
+          },
+          {
+            key: 'item3',
+            name: 'Link 3',
+            onClick: () => { return; }
+          }
+        ] }
+        overflowItems={ [
+          {
+            key: 'item4',
+            name: 'Overflow Link 1',
+            onClick: () => { return; }
+          },
+          {
+            key: 'item5',
+            name: 'Overflow Link 2',
+            onClick: () => { return; }
+          }
+        ]
+        }
+        onRenderOverflowButton={ (buttonProps) => {
+          return (
+            <IconButton
+              className={ css(styles.overflowButton) }
+              iconProps={ { iconName: 'More' } }
+              menuIconProps={ null }
+              menuProps={ buttonProps.menuProps }
+            />
+          );
+        } }
+        onRenderItem={ (item) => {
+          return (
+            <Link
+              className={ css(styles.overflowLinks) }
+              onClick={ item.onClick }
+            >{ item.name }</Link>
+          );
+        } }
+      />
+    );
+  }
+}

packages/office-ui-fabric-react/src/components/OverflowSet/examples/OverflowSet.Custom.Example.tsx

@@ -0,0 +1,140 @@
+/* tslint:disable:no-unused-variable */
+import * as React from 'react';
+/* tslint:enable:no-unused-variable */
+import { BaseComponent, css } from 'office-ui-fabric-react/lib/Utilities';
+import { DefaultButton } from 'office-ui-fabric-react/lib/Button';
+import { SearchBox } from 'office-ui-fabric-react/lib/SearchBox';
+import {
+  OverflowSet
+} from 'office-ui-fabric-react/lib/OverflowSet';
+
+import * as stylesImport from './OverflowSet.Example.scss';
+const styles: any = stylesImport;
+
+export class OverflowSetCustomExample extends BaseComponent<any, any> {
+
+  public render() {
+    return (
+      <OverflowSet
+        items={ [
+          {
+            key: 'search',
+            'onRender': (item) => {
+              return (
+                <SearchBox
+                  labelText='Search'
+                />
+              );
+            }
+          },
+          {
+            key: 'newItem',
+            name: 'New',
+            icon: 'Add',
+            ariaLabel: 'New. Use left and right arrow keys to navigate',
+            onClick: () => { return; },
+            subMenuProps: {
+              items: [
+                {
+                  key: 'emailMessage',
+                  name: 'Email message',
+                  icon: 'Mail',
+                },
+                {
+                  key: 'calendarEvent',
+                  name: 'Calendar event',
+                  icon: 'Calendar'
+                }
+              ],
+            },
+          },
+          {
+            key: 'upload',
+            name: 'Upload',
+            icon: 'Upload',
+            onClick: () => { return; },
+          },
+          {
+            key: 'share',
+            name: 'Share',
+            icon: 'Share',
+            onClick: () => { return; }
+          }
+        ] }
+        overflowItems={ [
+          {
+            key: 'newItem',
+            name: 'Add',
+            icon: 'Add',
+            ariaLabel: 'New. Use left and right arrow keys to navigate',
+            onClick: () => { return; },
+            subMenuProps: {
+              items: [
+                {
+                  key: 'emailMessage',
+                  name: 'Email message',
+                  icon: 'Mail',
+                },
+                {
+                  key: 'calendarEvent',
+                  name: 'Calendar event',
+                  icon: 'Calendar'
+                }
+              ],
+            },
+          },
+          {
+            key: 'move',
+            name: 'Move to...',
+            icon: 'MoveToFolder',
+            onClick: () => { return; }
+          },
+          {
+            key: 'copy',
+            name: 'Copy to...',
+            icon: 'Copy',
+            onClick: () => { return; }
+          },
+          {
+            key: 'rename',
+            name: 'Rename...',
+            icon: 'Edit',
+            onClick: () => { return; }
+          },
+          {
+            key: 'disabled',
+            name: 'Disabled...',
+            icon: 'Cancel',
+            disabled: true,
+            onClick: () => { return; }
+          }
+        ]
+        }
+        onRenderOverflowButton={ (buttonProps) => {
+          return (
+            <DefaultButton
+              className={ css(styles.overflowButton) }
+              iconProps={ { iconName: 'More' } }
+              menuIconProps={ null }
+              menuProps={ buttonProps.menuProps }
+            />
+          );
+        } }
+        onRenderItem={ (item) => {
+          if (item.onRender) {
+            return (
+              item.onRender(item)
+            );
+          }
+          return (
+            <DefaultButton
+              iconProps={ { iconName: item.icon } }
+              menuProps={ item.subMenuProps }
+              text={ item.name }
+            >  </DefaultButton>
+          );
+        } }
+      />
+    );
+  }
+}