0.4.3Компонент Select
Extends React.Component
(SelectProps)
const options = [
{ value: 'chocolate', label: 'Chocolate' },
{ value: 'strawberry', label: 'Strawberry' },
{ value: 'vanilla', label: 'Vanilla' },
];
<Select
options={options}
isMulti
onChange={r => console.log(r)}
/>
Props, передаваемые в Select
Type: {isMulti: boolean, options: Array<Option>, onChange: Function, selected: Array<any>, disableSearch: boolean?, shouldToggleOnHover: boolean, hasSelectAll: boolean, overrideStrings: {}?, maxHeight: number}
(boolean)
: включает функционал мультиселекта
(Function)
: коллбэк принимающий массив cо значениями выбранных элементов.
(boolean)
: отображать или нет пункт "Выбрать все".
(boolean)
: отображать ли строку поиска.
(boolean)
: если true то список будет раскрываться
при наведении на него мышкой.
(number)
: высота списка, при превышении которой появится скролл
({}?)
Функция для получения подписей элементов
(string)
строка - ключ объекта strings {
[key]
: 'label'} в котором хранятся
отображаемые по умолчанию наименования подписей элементов
(Object)
объект со значениями, которые нужно
перезаписать {
[ключ]
: 'новое наименование'}
string:
требуемое наименование
ItemHeader отрисовывает выбранный пункт в шапке компонента Dropdown
(ItemHeaderProps)
Компонент Dropdown - выводит список выбранных элементов и отображает панель выбора
Extends React.Component
Props, передаваемые в Dropdown
Type: {children: Object?, contentProps: Object, shouldToggleOnHover: boolean?}
(Object)
: элементы, которые будут отображаться в хедере
(выбранные элементы)
(Object)
: Props, которые не используются в этом компоненте
и которые нужно прокинуть дальше (в компонент SelectPanel)
(boolean)
: если true, то список с выбором будет открываться
при наведении курсора мышки на элемент (по умолчанию открывается после клика)
Компонент SelectPanel - выводит поисковую строку или строки выбора вариантов
Extends React.Component
Props передаваемые в SelectPanel
Type: {options: Array<Option>, selected: Array<any>, onSelectedChanged: function (selected: Array<any>): void, disableSearch: boolean?, hasSelectAll: boolean, overrideStrings: {}?, isMulti: boolean?, toggleExpanded: Function, getDirection: Function, resetState: Function, panelIsDown: boolean, maxHeight: number}
(function (selected: any): void)
: коллбэк, принимающий выбранные
элементы
(boolean)
: отображать ли строку поиска
(boolean)
: отображать или нет пункт "Выбрать все".
(Function)
: коллбэк скрывающий список.
(boolean)
: включает функционал мультиселекта
(Function)
: коллбэк получающий размеры элемента и вычисляющий
направление выпадения списка.
(Function)
: коллбэк сбрасывающий направление выпадения списка
на значение по умолчанию при размонтировании панели.
(boolean)
: направление открытия выпадающего списка
(number)
: высота, после превышения которой появится скролл
(Array<any>)
({}?)
Компонент SelectList - выводит список с вариантами выбора
Extends React.Component
Props передаваемые в SelectList
Type: {options: Array<Option>, selected: Array<string>, onSelectedChanged: function (selected: any): void, isMulti: boolean, toggleExpanded: Function}
Компонент SelectItem - отображает один элемент из списка выбора
Extends React.Component
Компонент DatePicker - рисует календарь и дает возможность выбора даты
Extends React.Component
(DatePickerProps)
Props, передаваемые в DatePicker
Type: {options: {}?, onChange: Function, value: any?}
(object)
: опции для доп. настройки, описание есть по ссылке
https://longbill.github.io/jquery-date-range-picker/#configuration
(Function)
: коллбэк принимающий объект с результатом выбора.
Объект следующей структуры:
{
date1: (Date object of the earlier date),
value: "2013-06-05 to 2013-06-07"
}
(any?)
Компонент DateRangePicker - рисует 2 календаря и дает возможность выбора диапазона дат
Extends React.Component
(DateRangePickerProps)
Props, передаваемые в DateRangePicker
Type: {options: {}?, onChange: Function, value: {start: any, end: any}}
(object)
: опции для доп. настройки, описание есть по ссылке
https://longbill.github.io/jquery-date-range-picker/#configuration
(Function)
: коллбэк принимающий объект с результатом выбора.
Объект следующей структуры:
{
date1: (Date object of the earlier date),
date2: (Date object of the later date),
value: "2013-06-05 to 2013-06-07"
}
(Object)
: дефолтные даты, отображающиеся при загрузке компонента.
передаются в формате { start: any, end: any }, start и end могут быть строкой, timestamp
или объектом moment.
Компонент DateTimeRangePicker - рисует 2 календаря и дает возможность выбора диапазона дат с указанием времени начальной даты и конечной
Extends React.Component
(DateTimeRangePickerProps)
Props, передаваемые в DateTimeRangePicker
Type: {options: {}?, onChange: Function, value: {start: any, end: any}}
(object)
: опции для доп. настройки, описание есть по ссылке
https://longbill.github.io/jquery-date-range-picker/#configuration
(Function)
: коллбэк принимающий объект с результатом выбора.
Объект следующей структуры:
{
date1: (Date object of the earlier date),
date2: (Date object of the later date),
value: "2013-06-05 to 2013-06-07"
}
(Object)
: дефолтные даты, отображающиеся при загрузке компонента.
передаются в формате { start: any, end: any }, start и end могут быть строкой, timestamp
или объектом moment.
Компонент Toggle - двухпозиционная кнопка
Extends React.Component
(ToggleProps)
<Toggle leftLabel='left' rightLabel='right' onChange={r => console.log(r)} />
Props, передаваемые в Toggle
Type: {leftLabel: string, rightLabel: string, rightPosition: boolean, disabled: boolean, onChange: Function}
(string)
: текст, отображаемый слева от кнопки
(string)
: текст, отображаемый справа от кнопки
(boolean)
: позиция переключателя true - справа, false - слева
(boolean)
: активен ли элемент, если true, то функция
переключения будет заблокирована
(Function)
: коллбэк вызывающийся когда происходит переключение переключателя
Компонент Modal - модальное окно
Extends React.Component
(ModalProps)
<Modal isOpen={this.state.modal}>
<Modal.Header toggle={this.toggle}>Заголовок</Modal.Header>
<Modal.Body>
Содержимое модального окна
{ this.state.isLoading && <div className='omni-modal__loader'/> }
</Modal.Body>
<Modal.Footer>Содержимое футера</Modal.Footer>
</Modal>
Компонент Header - шапка модального окна
(HeaderProps)
Props компонента Body
Type: {children: any}
(any)
: контент, отображаемый в компоненте Body модального окна
Компонент Footer - нижний колонтитул модального окна
(FooterProps)
Props компонента Footer
Type: {children: any}
(any)
: контент, отображаемый в компоненте Footer модального окна
Компонент Tooltip - подсказка, отображаемая при наведении/клике на элемент. Прикрепляется к родительскому элементу. У родительского элемента должен быть задан любой position, кроме static. Если не задан или static, то position будет насильно установлен в relative !!!
Extends React.Component
(TooltipProps)
<div style='position:relative'>
<Tooltip content='Содержимое подсказки' />
</div>
или
<div>
<Tooltip>Содержимое подсказки</Tooltip>
</div>
Props, передаваемые в Tooltip
Type: {isVisible: any, offset: string, event: string, fixed: boolean, maxHeight: number, arrowPosition: string, closeButton: boolean, title: string, content: any, children: any}
(boolean)
: виден или нет компонент
(string)
: с какой стороны от родительского элемента открывается подсказка,
возможные значения: top, bottom, left, right
(string)
: событие, при наступлении которого открывается подсказка,
возможные значения: hover, click, dblclick
(boolean)
: при выходе подсказки за границы окна она
не меняет расположение
(number)
: максимальная высота, после которой появляется скролл
(string)
: позация стрелки относительно блока с подсказкой,
возможные значения: left, center, right, top, bottom
(any)
: содержимое подсказки, переданное через свойство
(any)
: содержимое подсказки, обернутое компонентом (если установлено
свойство content, то children не отображается)
(boolean)
(string)
State компонента Tooltip
Type: {isVisible: boolean, offset: string, arrowPosition: string, callCounter: number}
(boolean)
: виден или нет компонент
(string)
: с какой стороны от родительского элемента открывается подсказка,
возможные значения: top, bottom, left, right
(string)
: позация стрелки относительно блока с подсказкой,
возможные значения: start, mid, end (порядок слева направо и сверху вниз, соответственно)
(number)
: счетчик вызовов функции расчета позиции, если
количество вызовов функции превышает количество вариантов расположения подсказки, то
устанавливается изначальное положение (заданное через props)
Заголовок окна с подсказкой
(TooltipHeaderProps)
Компонент Search - поисковая строка и список с результатами поиска
Extends React.Component
(SearchProps)
<Search
onChange={*функция, принимает значения введенные в поисковую строку и выполняет поиск*}
result={*массив - результат работы функции, переданной в onChange*}
onClickResult={*функция, принимает значение выбранного элемента из списка result*}
/>
Props, передаваемые в Search
Type: {onChange: Function, result: Array<any>, onClickResult: Function}
(Function)
: передается функция-коллбэк, которая принимает значения
введенные в поисковую форму
(Array<any>)
: массив с результатами поиска, элементы массива выводятся
всплывающим списком рядом с поисковой строкой
(Function)
: передается функция-коллбэк, которая принимает значение
выбранного (по которому кликнули мышкой) элемента из списка result
Компонент ResultItem - отображает один элемент из списка результатов поиска
Extends React.Component
(ResultItemProps)
Заменяет стандартный скролл. Использует библиотеку https://github.com/malte-wessel/react-custom-scrollbars