Global

Members

(constant) defaultCalendarAttributes :object

Default attributes for the ReactCalendar component.

Type:

object

Properties

Name	Type	Description
`nextLabel`	string \| JSX.Element	The next button label.
`next2Label`	string \| JSX.Element	The next2 button label.
`onChange`	function	The onChange event handler.
`prevLabel`	string \| JSX.Element	The previous button label.
`prev2Label`	string \| JSX.Element	The previous2 button label.

Since: 4.4.0
Source: modules/Calendar/index.js, line 22

(constant) defaultPaginationProps :object

Default props for the ReactPagination component.

Type:

object

Properties

Name	Type	Description
`activeClassName`	string	The classname for the active page. It is concatenated to base class pageClassName.
`activeLinkClassName`	string	The classname for the active page link. It is concatenated to base class pageLinkClassName.
`breakAriaLabels`	string	Aria labels of ellipsis elements (Default are { forward: 'Jump forward', backward: 'Jump backward' }).
`breakClassName`	string	The classname on tag li of the ellipsis element.
`breakLabel`	string	The label of the ellipsis element.
`breakLinkClassName`	string	The classname on tag a of the ellipsis element.
`className`	string	The classname for the pagination container.
`disabledClassName`	string	The classname for disabled previous and next buttons.
`disabledLinkClassName`	string	The classname on tag a for disabled previous and next buttons.
`disableInitialCallback`	boolean	Disable onPageChange callback with initial page. Default: false
`hrefAllControls`	boolean	By default the hrefBuilder add href only to active controls. Set this prop to true so href are generated on all controls.
`initialPage`	number	The initial page selected when the component is first mounted.
`marginPagesDisplayed`	number	The number of pages to display for margins.
`nextAriaLabel`	string	The aria label for the next button.
`nextClassName`	string	The classname on tag li of the next button.
`nextLabel`	string	The label for the next button.
`nextLinkClassName`	string	The classname on tag a of the next button.
`nextPageRel`	string	The rel property on the a tag just before the selected page. Default value prev. Set to null to disable.
`nextRel`	string	The rel propery on the a tag for the next page control. Default value next. Set to null to disable.
`pageClassName`	string	The classname on tag li of each page element.
`pageCount`	number	The total number of pages.
`pageLinkClassName`	string	The classname on tag a of each page element.
`pageRangeDisplayed`	number	The number of pages to display for margins.
`previousAriaLabel`	string	The aria label for the previous button.
`previousClassName`	string	The classname on tag li of the previous button.
`previousLabel`	string	The label for the previous button.
`previousLinkClassName`	string	The classname on tag a of the previous button.
`prevPageRel`	string	The rel property on the a tag just before the selected page. Default value prev. Set to null to disable.
`prevRel`	string	The rel property on the a tag for the previous page control. Default value prev. Set to null to disable.
`renderOnZeroPageCount`	function \| null	Render component even with zero pages. Default: undefined
`selectedPageRel`	string	The rel property on the a tag for the selected page. Default value null. Set to null to disable.

Since: 3.3.0
Source: modules/Pagination/index.js, line 45

Methods

getColumnStyle(styleProps, equalGrid) → {object}

Get the column style.

Parameters:

Name	Type	Description
`styleProps`	object	The style properties.
`equalGrid`	boolean	Whether the grid is equal or not.

Since: 4.3.0
Source: modules/DataGrid/utils/index.js, line 1

Returns:

The column style.

Type:: object

getListItems(items, propsWithState, depth) → {Array}

Helper function to get droplist items.

Parameters:

Name	Type	Description
`items`	Array	List of items to render.
`propsWithState`	object	Props and state to pass to the list items.
`depth`	number	Depth of the item.

Since: 4.3.0
Source: modules/Droplist/index.js, line 10

Returns:

The list of items.

Type:: Array

getModules(modules, moduleNames) → {object}

Get the modules from module names provided

Parameters:

Name	Type	Description
`modules`	Array	The modules to filter.
`moduleNames`	Array	The module names to filter.

Since: 4.3.0
Source: modules/DataGrid/utils/index.js, line 34

Returns:

The modules.

Type:: object

getRequestDataFromState(state, modules) → {object}

Get request data from state.

Parameters:

Name	Type	Description
`state`	object	The state object.
`modules`	Array	The modules for the data grid.

Since: TBD
Source: modules/DataGrid/utils/index.js, line 63

Returns:

The request data.

Type:: object

getStart(rangeType, date) → {Date}

Get the start date based on range type.

Parameters:

Name	Type	Description
`rangeType`	string	The range type, one of `century`, `decade`, `year`, or `month`.
`date`	Date	The date object.

Since: 4.4.0
Source: modules/Calendar/index.js, line 61

Returns:

The start of range type date object.

Type:: Date

getTodayEndOfDay() → {Date}

Get the date object of the end of day for today.

Since: 4.4.0
Source: modules/Calendar/index.js, line 47

Returns:

The date object of the end of day for today.

Type:: Date

getTodayStartOfDay() → {Date}

Get the date object of the start of day for today.

Since: 4.4.0
Source: modules/Calendar/index.js, line 33

Returns:

The date object of the start of day for today.

Type:: Date