Global

Members

(constant) DEFAULT_DATE_FORMAT :string

Default date format used by the DatePicker utilities.

Type:

string

Since: 5.8.6
Source: modules/DatePicker/utils/index.js, line 1

(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 29

(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

convertTwoDigitYear(value) → {number}

Convert a two-digit year into a four-digit year using a mid-century pivot.

Parameters:

Name	Type	Description
`value`	number	The two-digit year.

Since: 5.8.6
Source: modules/DatePicker/utils/index.js, line 80

Returns:

The expanded four-digit year.

Type:: number

endCardDrag()

Resets the card drag state.

Since: 5.8.4
Source: modules/Kanban/index.js, line 356

endColumnDrag()

Resets the column drag state.

Since: 5.8.4
Source: modules/Kanban/index.js, line 235

formatDateWithPattern(pattern, date) → {string}

Format a date according to a tokenized pattern.

Parameters:

Name	Type	Description
`pattern`	string	The desired output pattern.
`date`	Date	The date to format.

Since: 5.8.6
Source: modules/DatePicker/utils/index.js, line 95

Returns:

The formatted date string.

Type:: string

formatValueWithFormat(format, value) → {string}

Normalize any supported value to a formatted string using a pattern or formatter function.

Parameters:

Name	Type	Description
`format`	string \| function	The format string or formatter function.
`value`	*	The value to format (Date, range, or primitive).

Since: 5.8.6
Source: modules/DatePicker/utils/index.js, line 121

Returns:

The formatted representation.

Type:: string

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 6

Returns:

The column style.

Type:: object

getPlacement(align, placement, popoverRef, triggerRef, containerRef) → {object}

Calculate the left and top position based on alignment and placement.

Parameters:

Name	Type	Description
`align`	string	The alignment of the popover.
`placement`	string	The placement of the popover.
`popoverRef`	object \| null	Ref to the popover element.
`triggerRef`	object \| null	Ref to the trigger element.
`containerRef`	object \| null	Ref to the container element.

Since: 6.0.1
Source: elements/Popover/index.js, line 10

Returns:

The calculated left and top position for the popover.

Type:: object

getSegmentsFromFormat(format) → {Array}

Tokenize a format string into literal and token segments.

Parameters:

Name	Type	Description
`format`	string	The format template to parse.

Since: 5.8.6
Source: modules/DatePicker/utils/index.js, line 42

Returns:

Ordered list of segment descriptors.

Type:: Array

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 68

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 54

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 40

Returns:

The date object of the start of day for today.

Type:: Date

isValidDate(value) → {boolean}

Determine whether a value is a valid Date instance.

Parameters:

Name	Type	Description
`value`	*	The value to test.

Since: 5.8.6
Source: modules/DatePicker/utils/index.js, line 13

Returns:

True when the value is a valid date.

Type:: boolean

maskDateInputValue(format, rawValue, caretDigitIndexnullable) → {string|object}

Apply a format-aware mask to user-entered date text.

Parameters:

Name	Type	Attributes	Description
`format`	string \| function		The active date format (string tokens only).
`rawValue`	string		The raw user input value.
`caretDigitIndex`	number	<nullable>	Optional number of digits before the caret. When provided, returns an object containing `{ value, caretPosition }`.

Since: 5.8.6
Source: modules/DatePicker/utils/index.js, line 152

Returns:

The masked input string or { value, caretPosition } when caret tracking is requested.

Type:: string | object

moveCard(fromId, toId, fromIndex, toIndex, itemId)

Moves a card from one column to another.

Parameters:

Name	Type	Description
`fromId`	string	The id of the column the card is being moved from.
`toId`	string	The id of the column the card is being moved to.
`fromIndex`	number	The index of the card being moved.
`toIndex`	number	The index to move the card to.
`itemId`	string	The ID of the card being moved.

Since: 5.8.4
Source: modules/Kanban/index.js, line 136

moveColumn(fromIndex, toIndex, itemId)

Moves a column from one index to another.

Parameters:

Name	Type	Description
`fromIndex`	number	The index of the column being moved.
`toIndex`	number	The index to move the column to.
`itemId`	string	The ID of the column being moved.

Since: 5.8.4
Source: modules/Kanban/index.js, line 72

onColumnDrop(item)

Handles the drop event for a column.

Parameters:

Name	Type	Description
`item`	object	The item being dropped.

Since: 5.8.4
Source: modules/Kanban/index.js, line 335

onColumnHover(item, monitor, columnId)

Handles the hover state for a column.

Parameters:

Name	Type	Description
`item`	object	The item being dragged.
`monitor`	object	The drag monitor.
`columnId`	string	The ID of the column being hovered over.

Since: 5.8.4
Source: modules/Kanban/index.js, line 249

parseDateFromMaskedValue(format, value) → (nullable) {Date}

Parse a masked date string into a Date instance when valid.

Parameters:

Name	Type	Description
`format`	string \| function	The format string describing the mask.
`value`	string	The masked input value.

Since: 5.8.6
Source: modules/DatePicker/utils/index.js, line 220

Returns:

Parsed date or null when invalid/incomplete.

Type:: Date

replaceTokens(pattern, replacements) → {string}

Replace all token occurrences in a pattern with provided values.

Parameters:

Name	Type	Description
`pattern`	string	The format pattern to transform.
`replacements`	Array	Array of replacement definitions `{ tokens, value }`.

Since: 5.8.6
Source: modules/DatePicker/utils/index.js, line 25

Returns:

The formatted string with tokens substituted.

Type:: string

updateColumnLabel(columnId, newLabelProps)

Updates the label properties of a column.

Parameters:

Name	Type	Description
`columnId`	string	The ID of the column to update.
`newLabelProps`	object	The new label properties to set.

Since: 5.8.4
Source: modules/Kanban/index.js, line 371