feat(Accessibility): Make Grid keyboard navigable by adding Grid Behavior

docs/src/examples/components/Grid/Variations/GridExampleKeyboardNavigable.shorthand.tsx

@@ -0,0 +1,74 @@
+import React from 'react'
+import { Grid, Image, Button, gridBehavior } from '@stardust-ui/react'
+import _ from 'lodash'
+
+const imageNames = [
+  'ade',
+  'chris',
+  'christian',
+  'daniel',
+  'elliot',
+  'helen',
+  'jenny',
+  'joe',
+  'justen',
+  'laura',
+  'matt',
+  'nan',
+  'nom',
+  'stevie',
+  'steve',
+  'tom',
+  'veronika',
+]
+
+const imageButtonStyles = {
+  minWidth: '72px',
+  maxWidth: '72px',
+  height: '72px',
+  padding: '0',
+  margin: '0',
+  background: '#fff',
+}
+const renderImages = () => {
+  return _.map(imageNames, imageName => (
+    <Image
+      key={imageName}
+      fluid
+      src={`public/images/avatar/large/${imageName}.jpg`}
+      data-is-focusable="true"
+    />
+  ))
+}
+
+const renderImageButtons = () => {
+  return _.map(imageNames, imageName => (
+    <Button key={imageName} styles={imageButtonStyles}>
+      <Image fluid src={`public/images/avatar/large/${imageName}.jpg`} />
+    </Button>
+  ))
+}
+
+const gridStyles = {
+  gridColumnGap: '10px',
+  gridRowGap: '10px',
+}
+
+const GridExample = () => (
+  <div>
+    Grid with images, which are not natively focusable elements. Set 'data-is-focusable=true' to
+    each item to make grid items focusable and navigable.
+    <Grid accessibility={gridBehavior} styles={gridStyles} columns="7" content={renderImages()} />
+    <br />
+    Grid with images, wrapped with buttons, which are natively focusable elements. No need to add
+    'data-is-focusable'='true'.
+    <Grid
+      accessibility={gridBehavior}
+      styles={gridStyles}
+      columns="7"
+      content={renderImageButtons()}
+    />
+  </div>
+)
+
+export default GridExample

docs/src/examples/components/Grid/Variations/GridExampleKeyboardNavigable.tsx

@@ -0,0 +1,73 @@
+import React from 'react'
+import { Grid, Image, Button, gridBehavior } from '@stardust-ui/react'
+import _ from 'lodash'
+
+const imageNames = [
+  'ade',
+  'chris',
+  'christian',
+  'daniel',
+  'elliot',
+  'helen',
+  'jenny',
+  'joe',
+  'justen',
+  'laura',
+  'matt',
+  'nan',
+  'nom',
+  'stevie',
+  'steve',
+  'tom',
+  'veronika',
+]
+
+const imageButtonStyles = {
+  minWidth: '72px',
+  maxWidth: '72px',
+  height: '72px',
+  padding: '0',
+  margin: '0',
+  background: '#fff',
+}
+const renderImages = () => {
+  return _.map(imageNames, imageName => (
+    <Image
+      key={imageName}
+      fluid
+      src={`public/images/avatar/large/${imageName}.jpg`}
+      data-is-focusable="true"
+    />
+  ))
+}
+
+const renderImageButtons = () => {
+  return _.map(imageNames, imageName => (
+    <Button key={imageName} styles={imageButtonStyles}>
+      <Image fluid src={`public/images/avatar/large/${imageName}.jpg`} />
+    </Button>
+  ))
+}
+
+const gridStyles = {
+  gridColumnGap: '10px',
+  gridRowGap: '10px',
+}
+
+const GridExample = () => (
+  <div>
+    Grid with images, which are not natively focusable elements. Set 'data-is-focusable=true' to
+    each item to make grid items focusable and navigable.
+    <Grid accessibility={gridBehavior} styles={gridStyles} columns="7">
+      {renderImages()}
+    </Grid>
+    <br />
+    Grid with images, wrapped with button components, which are natively focusable elements. No need
+    to add 'data-is-focusable'='true'
+    <Grid accessibility={gridBehavior} styles={gridStyles} columns="7">
+      {renderImageButtons()}
+    </Grid>
+  </div>
+)
+
+export default GridExample

docs/src/examples/components/Grid/Variations/index.tsx

@@ -19,6 +19,11 @@ const Variations = () => (
       description="We can specify a certain amount of columns and rows or the explicit columns and rows for a grid."
       examplePath="components/Grid/Variations/GridExampleColumnsAndRows"
     />
+    <ComponentExample
+      title="Navigable with keyboard arrow buttons"
+      description="Use a Grid accessibility behavior, so Grid items can be keyboard navigable by adding 'data-is-focusable=true' attribute to each item. This attribute can be skipped if the Grid items are natively focusable elements, like buttons, anchors etc."
+      examplePath="components/Grid/Variations/GridExampleKeyboardNavigable"
+    />
   </ExampleSection>
 )
 

src/components/Grid/Grid.tsx

@@ -3,10 +3,14 @@ import * as React from 'react'
 import { UIComponent, childrenExist, customPropTypes, RenderResultConfig } from '../../lib'
 import { ComponentVariablesInput, ComponentSlotStyle } from '../../themes/types'
 import { Extendable, ShorthandValue, ReactChildren } from '../../../types/utils'
+import { Accessibility } from '../../lib/accessibility/types'
+import { defaultBehavior } from '../../lib/accessibility'
+
 import ReactNode = React.ReactNode
 
 export interface GridProps {
   as?: any
+  accessibility?: Accessibility
   className?: string
   children?: ReactChildren
   columns?: string | number
@@ -59,10 +63,14 @@ class Grid extends UIComponent<Extendable<GridProps>, any> {
 
     /** Override for theme site variables to allow modifications of component styling via themes. */
     variables: PropTypes.oneOfType([PropTypes.object, PropTypes.func]),
+
+    /** Accessibility behavior if overridden by the user. */
+    accessibility: PropTypes.func,
   }
 
-  public static defaultProps = {
+  public static defaultProps: GridProps = {
     as: 'div',
+    accessibility: defaultBehavior,
   }
 
   public renderComponent({ ElementType, classes, rest }: RenderResultConfig<any>): ReactNode {

src/index.ts

@@ -118,6 +118,7 @@ export {
 export {
   default as chatMessageEnterEscBehavior,
 } from './lib/accessibility/Behaviors/Chat/chatMessageEnterEscBehavior'
+export { default as gridBehavior } from './lib/accessibility/Behaviors/Grid/gridBehavior'
 
 //
 // Utilities

src/lib/accessibility/Behaviors/Grid/gridBehavior.ts

@@ -0,0 +1,16 @@
+import { Accessibility, FocusZoneMode } from '../../types'
+
+/**
+ * @description
+ * Wraps component in FocusZone allowing arrow key navigation through the children of the component.
+ */
+const gridBehavior: Accessibility = (props: any) => ({
+  focusZone: {
+    mode: FocusZoneMode.Wrap,
+    props: {
+      isCircularNavigation: true,
+    },
+  },
+})
+
+export default gridBehavior

src/lib/accessibility/index.ts

@@ -26,3 +26,4 @@ export { default as chatMessageBehavior } from './Behaviors/Chat/chatMessageBeha
 export {
   default as chatMessageEnterEscBehavior,
 } from './Behaviors/Chat/chatMessageEnterEscBehavior'
+export { default as gridBehavior } from './Behaviors/Grid/gridBehavior'