Documentation

Global

Members

# constant COLUMNS

Definition of the content and functionality of the columns of the data table.

View Source common/components/Table/DataTableBase.jsx, line 9

# constant customSelectStyles

Base select custom style

View Source common/components/Select/SelectBase.jsx, line 7

# constant formatDate

View Source common/utils/date.js, line 6

Methods

# App() → {JSX.Element}

View Source app/App.jsx, line 11

JSX.Element

# CreateEmployee() → {JSX.Element}

Displays the employee creation page.

View Source features/create-employee/CreateEmployee.jsx, line 17

JSX.Element

# CustomHeader(props) → {JSX.Element}

Displays the custom date picker header.

Parameters:
Name Type Description
props Object
date Date
changeYear function
changeMonth function
decreaseMonth function
increaseMonth function
prevMonthDisabled Boolean
nextMonthButtonDisabled Boolean

View Source common/components/Datepicker/custom-parts/CustomHeader.jsx, line 22

JSX.Element

# DataTableBase(DataTableBaseProps) → {JSX.Element}

Basic data table design.

Parameters:
Name Type Description
DataTableBaseProps DataTableBaseProps

View Source common/components/Table/DataTableBase.jsx, line 86

JSX.Element

# DatePickerBase(DatePickerBasePropsopt) → {JSX.Element}

Basic date picker design.

Parameters:
Name Type Attributes Description
DatePickerBaseProps Object <optional>
inputId String <optional>
selectedValue Date | null <optional>
handleChange handleChange <optional>

View Source common/components/Datepicker/DatepickerBase.jsx, line 30

JSX.Element

# EmployeeList() → {JSX.Element}

Displays the list of company employees.

View Source features/employee-list/EmployeeList.jsx, line 20

JSX.Element

# filterEmployees(employeeList, userInput) → {Array.<Object>}

Parameters:
Name Type Description
employeeList Array.<Object>
userInput String

View Source common/utils/SearchEngine.js, line 9

The list of employees that match the user's search or the initial list if the userInput parameter is an empty string.

Array.<Object>

# FormField(props) → {JSX.Element}

Parameters:
Name Type Attributes Description
props Object
children String
label String
labelFor String <optional>
errorMessage String <optional>
styleModifier Object <optional>
styleModifier.container String <optional>
styleModifier.label String <optional>

View Source common/components/FormField/index.jsx, line 16

JSX.Element
Parameters:
Name Type Attributes Default Description
SearchBarProps Object <optional>
filterText String <optional>
 ""
onFilter onFilterCallback <optional>
 (event) => {}
onClear onClearCallback <optional>
 (event) => {}

View Source common/components/Table/custom-parts/SearchBar.jsx, line 23

JSX.Element

# SelectBase(SelectProps) → {JSX.Element}

Basic select design.

Parameters:
Name Type Attributes Description
SelectProps Object
inputId String
options Array.<Object>

see Option type
value * <optional>
handleChange handleChange <optional>

View Source common/components/Select/SelectBase.jsx, line 66

JSX.Element

# SlidingMenu(SlidingMenuProps) → {JSX.Element}

Parameters:
Name Type Description
SlidingMenuProps Object
isOpen Boolean
handleTheOpeningToggle Boolean

View Source common/components/SlidingMenu/index.jsx, line 14

JSX.Element

# SuccessModal(SuccessModalProps) → {JSX.Element}

Parameters:
Name Type Description
SuccessModalProps SuccessModalProps

View Source common/components/Modal/SuccessModal.jsx, line 20

JSX.Element

# useDatePicker(date) → {DatePickerState}

Manages the state of the date picker value.

Parameters:
Name Type Description
date Date | null

View Source common/components/Datepicker/hooks/useDatePicker.js, line 26

DatePickerState

Type Definitions

# changeDate(date) → {Date}

Parameters:
Name Type Description
date Date

View Source common/components/Datepicker/hooks/useDatePicker.js, line 3

Date
Object

# DataTableBaseProps

Properties:
Name Type Description
data Array.<any>
defaultSortFieldId number
subHeaderComponent React.ReactNode

Displays the data table search bar
noDataComponent React.ReactNode

View Source common/components/Table/DataTableBase.jsx, line 66

Object

# DatePickerState

Properties:
Name Type Description
selected Date
changeDate changeDate

View Source common/components/Datepicker/hooks/useDatePicker.js, line 10

Object

# EmployeeInfos

Properties:
Name Type Description
firstName String
lastName String
startDate String
department String
dateOfBirth String
street String
city String
state String
zipCode String

View Source features/shared/data-formatters/Employee.js, line 2

# handleChange(date, event) → {void}

Change the value of the date picker when the user clicks on a date or enters one in the text field.

Parameters:
Name Type Description
date Date | null
event React.SyntheticEvent.<any, Event> | undefined

View Source common/components/Datepicker/DatepickerBase.jsx, line 7

void

# handleChange(newValue, actionMeta) → {void}

Change the value of the select when the user clicks on an option.

Parameters:
Name Type Description
newValue *
actionMeta *

View Source common/components/Select/SelectBase.jsx, line 43

void

# onClearCallback(clickEvent)

Parameters:
Name Type Description
clickEvent MouseEvent

View Source common/components/Table/custom-parts/SearchBar.jsx, line 9

# onFilterCallback(changeEvent)

Parameters:
Name Type Description
changeEvent Event

View Source common/components/Table/custom-parts/SearchBar.jsx, line 4

object

# SuccessModalProps

Properties:
Name Type Description
isOpen boolean
handleClickOutside VoidFunction
handleClickOnCloseButton VoidFunction

View Source common/components/Modal/SuccessModal.jsx, line 6