Function default

Whatever content is passed to this component will be rendered inside a scrollable container.

HEADS-UP! Use the flag childrenAreChips to indicate that the children are chips since they require special handling.

The user can scroll the content by clicking the arrows either side of the container.

There is also a keyboard navigation feature that allows the user to navigate the content using the arrow keys. The Tab key will initially focus on the first element in the scroller. The user can then navigate using the arrow keys. This is so that keyboard users can navigate the content without having to tab through all the elements in the scroller.

  • default(props, deprecatedLegacyContext?): ReactNode

  • Parameters

    Returns ReactNode

Properties

contextTypes? defaultProps? displayName? propTypes?

Properties

OptionalcontextTypes

contextTypes?: ValidationMap<any>

Deprecated

Lets you specify which legacy context is consumed by this component.

See

Legacy React Docs

OptionaldefaultProps

defaultProps?: Partial<ScrollableContainerProps>

Used to define default values for the props accepted by the component.

See

React Docs

Example

type Props = { name?: string }

const MyComponent: FC<Props> = (props) => {
  return <div>{props.name}</div>
}

MyComponent.defaultProps = {
  name: 'John Doe'
}

Deprecated

Use values for destructuring assignments instead.

OptionaldisplayName

displayName?: string

Used in debugging messages. You might want to set it explicitly if you want to display a different name for debugging purposes.

See

Legacy React Docs

Example


const MyComponent: FC = () => {
  return <div>Hello!</div>
}

MyComponent.displayName = 'MyAwesomeComponent'

OptionalpropTypes

propTypes?: WeakValidationMap<ScrollableContainerProps>

Used to declare the types of the props accepted by the component. These types will be checked during rendering and in development only.

We recommend using TypeScript instead of checking prop types at runtime.

See

React Docs

Settings

Member Visibility

On This Page

Properties