API Docs for: 0.0.1
Show:

Component Class

Defined in: lib/component.jsx:3
Module: component.jsx

Description here

Copyright (c) 2016 ItsAsbreuk - http://itsasbreuk.nl
New BSD License - http://choosealicense.com/licenses/bsd-3-clause/

Methods

componentDidMount

()

Defined in lib/component.jsx:62

Available since 15.0.0

componentDidMount will set an eventlistener to the app:passwordresetrequest-event

defineMovementKeys

()

Defined in lib/component.jsx:102

Available since 15.0.0

Extracts this.props.keyUp and this.props.keyDown into an array of objects and defines them into this._keysUp and this._keysDown.

focusActiveElement

() chainable

Defined in lib/component.jsx:151

Available since 0.0.1

Sets the focus on the active Element of the Container.

focusElement

(
  • index
)
chainable

Defined in lib/component.jsx:167

Available since 0.0.1

Sets the focus on the specified Element of the Container.

Parameters:

  • index Number

    the index of the item to be focussed

render

()

Defined in lib/component.jsx:270

Available since 15.0.0

React render-method --> renderes the Component.

Returns:

ReactComponent

Properties

children

String | | Object | | Array

Defined in lib/component.jsx:328

Available since 15.0.0

The Component its children

className

String

Defined in lib/component.jsx:337

Available since 15.0.0

The classname for the container

disabled

Boolean

Defined in lib/component.jsx:346

Available since 15.0.0

Whether the focuscontainer is disabled (doesn't response to focusevents)

focusOnContainerClick

Boolean

Defined in lib/component.jsx:355

Available since 15.0.10

Whether a click on the container (outside its elements, should lead into focussing the container

Default: false

initialFocus

String | Number

Defined in lib/component.jsx:366

Available since 15.0.0

A selector or index of the focussable items that should get the initial focus. In case of a selector, it might return multiple nodes: the one that is being used is determined by

initialFocusIndex

Number | "last"

Defined in lib/component.jsx:377

Available since 15.0.0

In case initialFocus is a selector, it might return multiple nodes: the one that is being used. In case of "last", it will return the last node.

Default: 0

keyDown

String | Number | Array

Defined in lib/component.jsx:388

Available since 15.0.0

What key/keys are responsible for re-focussing down. Valid values are charcodes possible prepende with a special key: 9 or shift+9 or ctrl+shift+9. Multiple key combinations can be defined bydefining an array of keyDown-values.

Default: 9

keyEnter

String | Number | Array

Defined in lib/component.jsx:399

Available since 15.0.0

Whenever keyEnter is set, then the focus-container will become a nested- focuscontainer. Nested focuscontainers will automaticcaly become focussable by their parent-container.

The keyEnter determines what key/keys are responsible for entering this container. Valid values are charcodes possible prepende with a special key: 39 or shift+39 or ctrl+shift+39. Multiple key combinations can be defined bydefining an array of keyUp-values.

keyLeave

String | Number | Array

Defined in lib/component.jsx:412

Available since 15.0.0

The keyLeave determines what key/keys are responsible for leaving this container and go to the parent focus-container. Valid values are charcodes possible prepende with a special key: 39 or shift+39 or ctrl+shift+39. Multiple key combinations can be defined bydefining an array of keyUp-values.

Default: 27

keyUp

String | Number | Array

Defined in lib/component.jsx:424

Available since 15.0.0

What key/keys are responsible for re-focussing up. Valid values are charcodes possible prepended with a special key: 9 or shift+9 or ctrl+shift+9. Multiple key combinations can be defined bydefining an array of keyUp-values.

Default: "shift+9"

loop

Boolean

Defined in lib/component.jsx:435

Available since 15.0.0

Whether the loop the focus when the last/first item is reached.

Default: true

onClick

Function

Defined in lib/component.jsx:445

Available since 0.0.1

Callback whenever the focuscontainer gets clicked. The callback recieves 2 arguments: e {Object} --> eventobject nested {Boolean} --> whether the click happened inside a nested focus-container

onMount

Function

Defined in lib/component.jsx:456

Available since 15.0.8

Callback for when the component did mount.

refocusOnEnterInput

Boolean

Defined in lib/component.jsx:465

Available since 15.0.0

Whether to focus on the next item whenever a enter is pressed on an input-element.

Default: true

scrollIntoView

String

Defined in lib/component.jsx:475

Available since 15.0.30

Whether the focussed item should be scrolled into the view when the focusselector focuses it.

Default: true

selector

String

Defined in lib/component.jsx:485

Available since 15.0.0

Selector on which the focusmanager should check against when refocussing

style

Object

Defined in lib/component.jsx:494

Available since 15.0.0

Inline styles for the focus-container

tabIndex

Number

Defined in lib/component.jsx:503

Available since 0.0.1

The tabIndex

transitionTime

Number

Defined in lib/component.jsx:512

Available since 15.0.0

The transition-time when the window needs to be scrolled in order to get the focussable node into the view.