Function
| Static Public Summary | ||
| public |
Компонент отображения отсутствия данных |
|
| public |
BaseNode(objectPattern: {"prefixCls": *, "iconFieldId": *, "imageFieldId": *, "labelFieldId": *, "badgeFieldId": *, "valueFieldId": *, "badgeColorFieldId": *, "searchValue": *, "searchKeys": *, "data": *, "filter": *}): * |
|
| public |
BlankFieldset(objectPattern: {"render": *, "rows": *}): * |
|
| public |
Buttons(objectPattern: {"visible": *, "searchLabel": *, "resetLabel": *, "onSearch": *, "onReset": *}): * |
|
| public |
Card(linear: boolean, circle: boolean, items: array, inverse:: boolean, outline:: boolean, children: node, rest: ...any): * Контейнер для карточек |
|
| public |
CardLayout(children: node, className: string, rest: ...any): * Лайоут для Карточек |
|
| public |
Collapse(activeKey: string | array, defaultActiveKey: string | array, destroyInactivePanel: boolean, accordion: boolean): * Компонент Collapse |
|
| public |
CollapseFieldSet(objectPattern: {"render": *, "rows": *, "type": *, "label": *, "expand": *, "hasArrow": *}): * |
|
| public |
|
|
| public |
|
|
| public |
Контрол поля формы |
|
| public |
DateInterval(objectPattern: {"value": *, "defaultTime": *, "defaultValue": *, "onChange": *, ...rest: Object}): * Компонент для выбора временного интервала. |
|
| public |
DefaultBreadcrumb(objectPattern: {"items": *}): * |
|
| public |
Description(objectPattern: {"value": *, ...props: Object}) |
|
| public |
DropdownCustomItem(objectPattern: {"color": *, ...rest: Object}): * |
|
| public |
ErrorPage(objectPattern: {"status": *, "error": *}): * |
|
| public |
ExpandBtn(objectPattern: {"onShowAll": *, "onHideAll": *}): * |
|
| public |
Factory(props: *, context: *): * |
|
| public |
FieldActions(actions: array): * Компонент, содержащий экшены поля |
|
| public |
FileUploaderControl(WrappedComponent: *): * |
|
| public |
Form(objectPattern: {"rows": *, "cols": *}): * |
|
| public |
GlobalAlerts(alerts: array, onDismiss: function): JSX Глобальные алерты |
|
| public |
HeaderFooterTemplate(objectPattern: {"children": *}): * |
|
| public |
Html(objectPattern: {"value": *, "visible": *, "disabled": *}): * |
|
| public |
Inline-спиннер (лоадер), находится справа |
|
| public |
InputAddon(objectPattern: {"item": *, "iconFieldId": *, "imageFieldId": *, "setRef": *}): null InputAddon - дополнение с иконкой/картинкой для инпута {@Link InputSelectGroup} |
|
| public |
InputContent(objectPattern: {"disabled": *, "value": *, "placeholder": *, "onRemoveItem": *, "onFocus": *, "onBlur": *, "inputFocus": *, "isSelected": *, "selected": *, "labelFieldId": *, "valueFieldId": *, "clearSelected": *, "multiSelect": *, "collapseSelected": *, "lengthToGroup": *, "onInputChange": *, "openPopUp": *, "closePopUp": *, "activeValueId": *, "setActiveValueId": *, "disabledValues": *, "options": *, "onSelect": *, "onClick": *, "isExpanded": *, "autoFocus": *, "selectedPadding": *, "setTextareaRef": *, "setSelectedListRef": *, "_textarea": *, "_selectedList": *, "setRef": *}): * InputSelectGroup |
|
| public |
InputElements(objectPattern: {"onRemoveItem": *, "selected": *, "labelFieldId": *, "disabled": *, "collapseSelected": *, "lengthToGroup": *, "onDeleteAll": *, "setRef": *}): * Компонент выбранных элементов для {@Link InputSelectGroup} |
|
| public |
InputHidden(props: *): * |
|
| public |
InputSelectGroup(objectPattern: {"className": *, "loading": *, "isExpanded": *, "multiSelect": *, "iconFieldId": *, "imageFieldId": *, "onButtonClick": *, "selected": *, "input": *, "cleanable": *, "children": *, "isInputInFocus": *, "onClearClick": *, "setIsExpanded": *, "disabled": *, "setSelectedItemsRef": *}): * InputSelectGroup |
|
| public |
Label(id: string, value: string | element, required: boolean, className: string, style: string, help: string, props: object): * Лейбел поля |
|
| public |
LeftTopBottom(props: object): * Layout виджета; Places: left, top, bottom |
|
| public |
List(objectPattern: {"paragraphs": *, "rows": *, "avatar": *}): * |
|
| public |
ListItem(leftTop: Node | Object, leftBottom: Node | Object, header: Node | String, subHeader: Node | String, body: Node | String, rightTop: Node | String, rightBottom: Node | String, extra: Node | String, selected: boolean, onClick: function, divider: boolean, style: object, hasSelect: object): * Компонент ListItem виджета ListWidget |
|
| public |
ListMoreButton(onClick: function, style: object): * Кнопка "Загрузить еще" |
|
| public |
Компонент-размерность |
|
| public |
NavItemContainer(props: object): * Контейнер navItem'ов, в зависимости от type, создает внутри линк, дропдаун или текст |
|
| public |
NavbarBrandContent(props: *): * Рендер бренда и лого |
|
| public |
NotFoundFactory(objectPattern: {"src": *, "level": *}): * |
|
| public |
|
|
| public |
OLD_SidebarFixTemplate(objectPattern: {"children": *, "className": *}): * |
|
| public |
Panel(header: string, type: string, showArrow: boolean, openAnimation: object, disabled: boolean, forceRender: boolean): * Панель Collapse |
|
| public |
Panel(objectPattern: {"className": *, "isFullScreen": *, "style": *, "onToggle": *, "open": *, "color": *, "onKeyPress": *, "children": *, "innerRef": *}): * Компонент панели |
|
| public |
PanelBody(objectPattern: {"id": *, "activeKey": *, "hasTabs": *, "children": *}): * Компонент тела Panel |
|
| public |
PanelFooter(objectPattern: {"children": *}): * Компонент подвала Panel |
|
| public |
PanelHeading(objectPattern: {"children": *}): * Компонент шапки для Panel |
|
| public |
PanelMenu(objectPattern: {"children": *, "collapsible": *, "onToggle": *, "fullScreen": *, "onFullScreenClick": *, "isOpen": *, "fullScreenIcon": *}): * Компонент меню для Panel |
|
| public |
PanelNavItem(objectPattern: {"id": *, "onClick": *, "active": *, "disabled": *, "className": *, "isToolBar": *, "children": *}): * Компонент элемента меню для Panel |
|
| public |
PanelTabBody(objectPattern: {"eventKey": *, "children": *}): * Компонент тела таба для Panel |
|
| public |
PanelTitle(objectPattern: {"icon": *, "children": *}): * Компонент заголовка для Panel |
|
| public |
|
|
| public |
Pills(data: *, rest: *): * Контролл Pills |
|
| public |
PopupItems(objectPattern: {"options": *, "activeLabel": *, "setActiveLabel": *, "labelFieldId": *, "iconFieldId": *, "valueFieldId": *, "imageFieldId": *, "disabledValues": *, "selected": *, "groupFieldId": *, "hasCheckboxes": *, "format": *, "badgeFieldId": *, "badgeColorFieldId": *, "onRemoveItem": *, "onSelect": *, "setActiveValueId": *, "activeValueId": *}): * Компонент попапа для InputSelect |
|
| public |
PopupList(objectPattern: {"children": *, "inputSelect": *, "isExpanded": *, "onScrollEnd": *, "expandPopUp": *, "filterValue": *, "needAddFilter": *, ...rest: Object}): * Компонент попапа для InputSelect |
|
| public |
SecurityNotRender(config: *, component: *, rest: *): * Вспомогательная функция для SecurityCheck |
|
| public |
SidebarItemContainer(item: *, activeId: *, sidebarOpen: *): * Sidebar Item |
|
| public |
SimpleHeaderTest(): * |
|
| public |
SimpleTemplate(objectPattern: {"children": *}): * |
|
| public |
StandardWidgetLayout(className: string): * Стандартный Layout виджета, Places: top, topLeft, topRight, center, bottomLeft, bottomRight, bottom |
|
| public |
Table(objectPattern: {"cols": *, "rows": *}): * |
|
| public |
|
|
| public |
Компонент, который отображает текст |
|
| public |
TextArea(className: string, style: object, disabled: boolean, disabled: boolean, placeholder: string, rows: number, maxRows: number, value: string | number, onChange: function): * Компонент TextAreat |
|
| public |
Компонент поле текст |
|
| public |
|
|
| public |
TitleFieldset(objectPattern: {"render": *, "rows": *, "title": *, "showLine": *, "className": *, "subTitle": *}): * |
|
| public |
Tree(objectPattern: {"rows": *, "chevron": *}): * |
|
| public |
TreeItem(objectPattern: {"node": *, "options": *}): * |
|
| public |
TreeNode(options: object, disabled: boolean, key: string, format: string, children: node, rest: object): * Компонент TreeNode |
|
| public |
TreeNode(objectPattern: {"children": *, "item": *, "disabled": *, "selected": *, "hasChildren": *, "expanded": *, "onDelete": *, "onSelect": *, "onExpandClick": *, ...rest: Object}): * Элемент дерева |
|
| public |
Wireframe(objectPattern: {"title": *, "className": *, "height": *}) |
|
| public |
addAlert(key: *, alerts: *): * Добавить предупреждения |
|
| public |
* addAlertSideEffect(config: *, action: *) |
|
| public |
addAlerts(key: *, alerts: *): * Добавляет массив предупреждений |
|
| public |
addFieldMessage(form: *, name: *, message: *, isTouched: *): * Добавить сообщение (после валидации) к полю |
|
| public |
addTime(date: *, hours: *, mins: *): * добавить часы и минуты к дате |
|
| public |
* addTouched(objectPattern: {"payload": *}) |
|
| public |
* alertEffect(action: *) |
|
| public |
|
|
| public |
alertsSelector(state: *): * Селектор всех алертов |
|
| public |
apiProvider(type: *, options: *): * |
|
| public |
|
|
| public |
auth(state: *, objectPattern1: {"type": *, "payload": *, "meta": *}): * |
|
| public |
authSelector(state: *): * |
|
| public |
buildDateFormat(dateFormat: *, timeFormat: *, divider: *): * |
|
| public |
calculateMaxFreeSpace(input: *, popUp: *, window: *): * Вычисляем наибольшее свободное пространство рядом с элементом Возвращаем одно из вариантов [left, top, right, bottom] |
|
| public |
callActionImpl(key: *, actionSrc: *, options: *): * Вызов функции эшкен импла |
|
| public |
|
|
| public |
* catchAction(dispatch: *) |
|
| public |
changeButtonClass(key: *, className: *): * Экшен изменения css-класса кнопки |
|
| public |
changeButtonColor(key: *, color: *): * Экшен изменения цета кнопки |
|
| public |
changeButtonCount(key: *, count: *): * Экшен изменения счетчика кнопки |
|
| public |
changeButtonDisabled(key: *, disabled: *): * Экшен изменения свойства блокировки |
|
| public |
changeButtonHint(key: *, hint: *): * Экшен изменения подсказки кнопки |
|
| public |
changeButtonIcon(key: *, icon: *): * Экшен изменения иконки кнопки |
|
| public |
changeButtonSize(key: *, size: *): * Экшен изменения размера кнопки |
|
| public |
changeButtonStyle(key: *, style: *): * Экшен изменения объекта стиля кнопки |
|
| public |
changeButtonTitle(key: *, title: *): * Экшен изменения заголовка кнопки |
|
| public |
changeButtonVisiblity(key: *, visible: *): * Экшен смены видимости кнопки |
|
| public |
changeColumnDisabled(widgetId: *, columnId: *, disabled: *): * |
|
| public |
changeColumnVisiblity(widgetId: *, columnId: *, visible: *): * Изменение видимсоти колонки таблицы |
|
| public |
changeCountWidget(widgetId: *, count: *): * Меняет количество записей в виджете. |
|
| public |
changeFiltersVisibility(widgetId: *, isFilterVisible: *): * Изменить видимость фильтров виджета |
|
| public |
changeLocale(locale: *): * Сменить язык интерфейса |
|
| public |
changePageWidget(widgetId: *, page: *): * Меняет номер страницы виджета Этот параметр используется при запросах на сервер |
|
| public |
changeRootPage(rootPageId: *): * Сменить текущую страницу |
|
| public |
changeSizeWidget(widgetId: *, size: *): * Меняет размер выборки виджета Этот параметр используется при запросах на сервер |
|
| public |
* checkAndModify(values: *, fields: *, formName: *, fieldName: *, actionType: *) |
|
| public |
* checkOnDirtyForm(name: *): IterableIterator<*> Проверка на изменение данных в формах |
|
| public |
* checkPrompt(action: *): IterableIterator<*> Функция показа подтверждения закрытия |
|
| public |
classSelector(key: *) селектор класса кнопки |
|
| public |
* clearForm(action: *) |
|
| public |
* clearFormEffect(action: *) |
|
| public |
clearModel(prefix: *, key: *, exclude: *): * Очистка модели. |
|
| public |
* clearOnDisable(action: *) |
|
| public |
cloneObject(obj: *) |
|
| public |
closeModal(name: *, prompt: *): * События при попытке закрыть модальное окно |
|
| public |
collectionToComponentObject(Component: *, props: *): * Превращаем коллекцию в обьект с ключами id и value Element [{ id: 1, ...}, { id: 2, ... |
|
| public |
colorSelector(key: *) селектор цвета кнопки |
|
| public |
combineModels(combine: *): * |
|
| public |
compareAndResolve(models: *, stateModels: *): * Дополнительная функция для observeModels. |
|
| public |
compileUrl(url: *, objectPattern1: {"pathMapping": *, "queryMapping": *}, state: *, objectPattern3: {"extraPathParams": *, "extraQueryParams": *}): * |
|
| public |
Валидация js-condition |
|
| public |
configureStore(initialState: *, history: *, config: {}): * |
|
| public |
async constraint(fieldId: *, values: *, options: *, dispatch: *): boolean | * Валидация с отправкой запроса на сервер |
|
| public |
convertData(value: *, data: *, labelFieldId: *, valueFieldId: *): * Функция для преобразования данных с помоцию ключей указывающих на значение |
|
| public |
convertSize(size: *, step: number): * |
|
| public |
Копирование модели по префиксу и ключу в другую модель, по префиксу и ключу |
|
| public |
countSelector(key: *) селектор счетчика кнопки |
|
| public |
createActionHelper(type: *, payloadFunc: *, metaFunc: *): * Обертка вокруг createAction с дефолтными мапперами |
|
| public |
createContextFn(vars: *, code: *): * Создает функцию с контекстом |
|
| public |
createErrorPages(objectPattern: {"notFound": *, "forbidden": *, "serverError": *}): undefined[] |
|
| public |
createFactoryConfig(customConfig: *): * |
|
| public |
createObjectByDotNotationKey(key: *, obj: *, delimiter: *): {} Create object dy dot notation string and set value from context. |
|
| public |
createObjectFromDotString(string: String, defaultValue: *, delimiter: *, $resultObject: Object): Object Create object form string with dot notation |
|
| public |
createRegExp(searchText: *, filter: *): * |
|
| public |
createTreeFn(Component: *): * |
|
| public |
createValidator(validationConfig: {}, formName: *, state: *): {"asyncValidate": *, "asyncChangeFields": *} |
|
| public |
createWidgetContainer(initialConfig: *, widgetType: *): * HOC, оборачивает в виджет контейнер, Выполняет запрос за данными и связь с redux |
|
| public |
customTreeActions(objectPattern: {"key": *, "treeRef": *, "datasource": *, "expandedKeys": *, "prefixCls": *, "valueFieldId": *, "parentFieldId": *, "hasCheckboxes": *}): boolean |
|
| public |
dataRequestWidget(widgetId: *, options: *): * Запрос за данными |
|
| public |
delay(ms: *) |
|
| public |
deleteFile(url: *, id: *) |
|
| public |
dependency(WrappedComponent: *): * НОС - создает зависимость |
|
| public |
dependencySelector(formName: *, fieldName: *) |
|
| public |
destroyModal(): * Удалить модальное окно |
|
| public |
difference(object: Object, base: Object): Object Глубокое сравнение двух объектов |
|
| public |
disableField(form: *, name: *): * экшен дизактивации поля |
|
| public |
disableFields(form: *, names: *): * экшен дизактивации полей формы |
|
| public |
disablePage(pageId: *): * заблокировать страницу |
|
| public |
disableWidget(widgetId: *): * Сделать виджет заблокированым |
|
| public |
disableWidgetOnFetch(widgetId: *): * |
|
| public |
|
|
| public |
Валидация того, что email |
|
| public |
enableField(form: *, name: *): * экшен активирования поля(из неактивного состояния(disabled)) |
|
| public |
enableFields(form: *, names: *): * экшен активации полей формы |
|
| public |
enablePage(pageId: *): * разблокировать страницу |
|
| public |
enableWidget(widgetId: *): * Сделать виджет разблокированым |
|
| public |
errorSelector(key: *) селектор ошибок экшена кнопки |
|
| public |
evalExpression(expression: *, context: *): * Выполняет JS выражение с контекстом |
|
| public |
factoryResolver(props: Object, defaultComponent: String, type: String): Object Функция преобразует ссылку в метаданных на компонент, на React компонент. |
|
| public |
fetchCancel(fetchType: *, options: *): * |
|
| public |
fetchEnd(fetchType: *, options: *, response: *): * |
|
| public |
fetchError(fetchType: *, options: *, error: *): * |
|
| public |
fetchErrorContinue(): * |
|
| public |
fetchIfChangeDependencyValue(prevState: *, state: *, ref: *) Запрашивает данные, если зависимое значение было изменено |
|
| public |
fetchInputSelectData(options: *, model: *, settings: {"apiPrefix": undefined, "basePath": undefined}): * |
|
| public |
* fetchInvoke(dataProvider: *, model: *): IterableIterator<*> Отправка запроса |
|
| public |
* fetchSaga(fetchType: *, options: *): * |
|
| public |
fetchStart(fetchType: *, options: *): * |
|
| public |
filterSelector(formName: *, fieldName: *) |
|
| public |
flatFields(obj: *, fields: *): * Делает из сложного объекта с филдами разных уровнях плоский массив филдов (обходит объект рекурсивно) |
|
| public |
* flowDefaultModels(config: *): boolean Сага для первоначальной установки моделей по умолчанию и подписка на изменения через канал |
|
| public |
* forceUpdateDependency(state: *, widgetsDependencies: *, widgetId: *) |
|
| public |
formatToFloat(val: *, precision: *): * |
|
| public |
formatToMask(format: *): * |
|
| public |
formsSelector(state: *): {} селектор для редакс-форм |
|
| public |
generateErrorMeta(msg: *): {"alert": *} |
|
| public |
generateFlatQuery(objectAim: *, Key: *, $Res: *, delimiter: *): String Make "flat" query string from object Json and extends params |
|
| public |
generateKey(containerKey: *, columnId: *): string |
|
| public |
generateParamQuery(objectAim: *, Key: *, $Res: *, delimiter: *): String Make "flat" query string from object Json and extends params with new paramize method |
|
| public |
generateSagas(dispatch: *, config: *): * |
|
| public |
getAbsoluteHeight(el: *): * узнать высоту DOM-элемента |
|
| public |
getAbsoluteWidth(el: *): * узнать ширину DOM-элемента |
|
| public |
getAutoFocusId(fields: *): * Возвращает id первового поля, на котором может быть установлен автофокус |
|
| public |
getCheckedStrategy(key: *): * |
|
| public |
* getConfig(action: *) Сага для вызова настроек приложения |
|
| public |
getContainerButtons(containerKey: *) |
|
| public |
getContainerColumns(key: *) |
|
| public |
Возвращает тип createElement() на основе props компонента. |
|
| public |
getFirstNotDisabledId(data: *, selected: *, disabled: *, valueFieldId: *): * |
|
| public |
getIndex(data: *, selectedId: *): * |
|
| public |
getIndex(datasource: *, selectedId: *): * |
|
| public |
getModelSelector(modelLink: *): * Селектор получения модели по линку |
|
| public |
getModelsByDependency(dependency: *): * |
|
| public |
getNextId(data: *, currentId: *, valueFieldId: *, selected: *, disabled: *) |
|
| public |
getParams(mapping: *, state: *): * |
|
| public |
getPathValue(object: *, path: *): * get value from sub-path object |
|
| public |
getPrecision(step: *): * |
|
| public |
getPrevId(data: *, currentId: *, valueFieldId: *, selected: *, disabled: *) |
|
| public |
getTimeout(alert: *, config: *): * |
|
| public |
getTreeLinerRoute(data: *, expandedKeys: *, parentFieldId: *, valueFieldId: *): Array Вспомогогательная функция для клавиатуры Определяет путь по которому будет двигаться клавиатура возвращает массив из id |
|
| public |
getWidgetId(pageId: *, cntId: *): string Возвращается widgetId на основе page и container |
|
| public |
getWithoutSelectedId(options: *, location: *, selectedId: *, prevSelectedId: *): * |
|
| public |
globalSelector(state: *) Селектор глоабльных настроек |
|
| public |
groupData(data: *, field: *): * |
|
| public |
groupData(data: *, groupFieldId: *) |
|
| public |
guid(): * |
|
| public |
* handleAction(action: *) вызов экшена |
|
| public |
* handleAction(action: *) |
|
| public |
* handleFailInvoke(metaInvokeFail: *, widgetId: *, metaResponse: *) |
|
| public |
* handleFetch(widgetId: *, options: *, isQueryEqual: *, prevSelectedId: *) |
|
| public |
* handleInvoke(action: *) вызов экшена |
|
| public |
hasInsideMixMax(date: *, dateFormat: *, max: *, min: *): boolean Функция проверки находится ли дата в промежутке max и min |
|
| public |
hideField(form: *, name: *): * экшен скрытия поля |
|
| public |
hideFields(form: *, names: *): * экшен скрытия полей формы |
|
| public |
hideModal(name: *): * Скрыть модальное окно |
|
| public |
hidePrompt(name: *): * Скрыть подтверждение закрытия модального окна |
|
| public |
hideWidget(widgetId: *): * Сделать виджет невидимым |
|
| public |
hideWidgetFilters(widgetId: *): * Скрыть филтры виджета |
|
| public |
hintPositionSelector(key: *, id: *) селектор расположения посказаки кнопки |
|
| public |
hintSelector(key: *, id: *) селектор посказаки кнопки |
|
| public |
HOC компонент для настройки работы с клавиатурой. |
|
| public |
http_params_query(data: *): String new method conversion in url for query see {NNO-266} |
|
| public |
iconSelector(key: *) селектор иконки кнопки |
|
| public |
id(): * |
|
| public |
inArray(array: *[], item: {}): * |
|
| public |
initUid(WrappedComponenet: *): * |
|
| public |
insertModal(name: *, visible: *, title: *, size: *, closeButton: *, pageId: *, src: *): * Регистрация модального окна в редаксе |
|
| public |
Валидация того, что integer |
|
| public |
isDateFromNextMonth(date: *, displayedMonth: *): * Дата (date) была после конца месяца другой даты(displayedMonth) или нет |
|
| public |
isDateFromPrevMonth(date: *, displayedMonth: *): * Дата (date) была до начала месяца другой даты(displayedMonth) или нет |
|
| public |
isDisabled(item: *, selected: *, disabled: *) |
|
| public |
isDisabledSelector(key: *, id: *) |
|
| public |
isDisabledSelector(formName: *, fieldName: *) селектор для значения активности поля |
|
| public |
isDisabledSelector(key: *, id: *) |
|
| public |
isInitSelector(key: *, id: *) |
|
| public |
isInitSelector(formName: *, fieldName: *) селектор для свойства, отвечающего за инициализацию дополнительных свойств |
|
| public |
isInitSelector(key: *) селектор для того, чтобы узнать зарегистрирована кнопка или нет |
|
| public |
isLoading(key: *) селектор выполнения |
|
| public |
isOverflown(element: *): * |
|
| public |
Проверка является ли объект Promise |
|
| public |
isValid(val: *, min: *, max: *): * |
|
| public |
isVisibleSelector(key: *, id: *) |
|
| public |
isVisibleSelector(formName: *, fieldName: *) селектор для значения видимости поля |
|
| public |
isVisibleSelector(key: *) селектор видимости кнопки |
|
| public |
layoutPlaceResolver(LayoutComponent: *): * |
|
| public |
linkImpl(objectPattern: {"dispatch": *, "state": *, "target": *, "path": *, "pathMapping": *, "queryMapping": *}) |
|
| public |
linkResolver(state: *, link: *, value: *): * Получение значения по ссылке и выражению. |
|
| public |
listContainer(WrappedComponent: *): * Композер хоков {@Link withFetchData} & {@Link withListContainer} |
|
| public |
loadingWidget(widgetId: *): * Активировать анимацию загрузки у виджета |
|
| public |
makeAlertByKeyAndIdSelector(key: *, id: *) Селектор алерта по ключу(widgetId) и id алерта |
|
| public |
makeAlertsByKeySelector(key: *) Селектор алертов по ключу(widgetId) |
|
| public |
makeFieldByName(formName: *, fieldName: *) селктор для поля формы |
|
| public |
makeFormByName(name: *) селектор для конкретной формы |
|
| public |
makeGetFilterModelSelector(key: *) Селектор-генератор для получения filter модели |
|
| public |
makeGetModelByPrefixSelector(prefix: *, key: *) Селектор-генератор для получения конкретной модели |
|
| public |
makeGetResolveModelSelector(key: *) Селектор-генератор для получения resolve модели |
|
| public |
makeIsActiveSelector(widgetId: *) |
|
| public |
makeModalsbyName(i: *) селектор модального окна по индексу |
|
| public |
makeModelsByPrefixSelector(prefix: *) Селектор-генератор для получения списка моделей по префиксу |
|
| public |
makePageActionsByIdSelector(pageId: *) |
|
| public |
makePageByIdSelector(pageId: *) Селектор-генератор для получения страницы по ID |
|
| public |
makePageDisabledByIdSelector(pageId: *) Получение свойства disabled страницы по ее id |
|
| public |
makePageErrorByIdSelector(pageId: *) Селектор-генератор для получения статуса ошибки по ID |
|
| public |
makePageLoadingByIdSelector(pageId: *) Селектор-генератор для получения статуса загрузки по ID |
|
| public |
makePageMetadataByIdSelector(pageId: *) Селектор-генератор для получения метеданных страницы по ID |
|
| public |
makePageRoutesByIdSelector(pageId: *) Селектор-генератор для получения статуса загрузки по ID |
|
| public |
makePageStatusByIdSelected(pageId: *) Получение свойсва status страницы по ee d |
|
| public |
makePageTitleByIdSelector(pageId: *) |
|
| public |
makePageToolbarByIdSelector(pageId: *) |
|
| public |
makePageWidgetsByIdSelector(pageId: *) Селектор-генератор для получения виджетов страницы по ID |
|
| public |
makeSelectedIdSelector(widgetId: *) |
|
| public |
makeShowPromptByName(name: *) |
|
| public |
makeTypeSelector(widgetId: *) |
|
| public |
makeWidgetByIdSelector(widgetId: *): * Селектор-генератор для получения виджета по ID |
|
| public |
makeWidgetCountSelector(widgetId: *) Селектор-генератор для получения свойства виджета - count |
|
| public |
makeWidgetDataProviderSelector(widgetId: *) |
|
| public |
makeWidgetEnabledSelector(widgetId: *) Селектор-генератор для получения свойства виджета - isEnabled |
|
| public |
makeWidgetFilterVisibilitySelector(widgetId: *) Селектор-генератор для получения свойства виджета - isFilterVisible |
|
| public |
makeWidgetIsInitSelector(widgetId: *) Селектор-генератор для получения свойства виджета - isInit |
|
| public |
makeWidgetLoadingSelector(widgetId: *) Селектор-генератор для получения свойства виджета - isLoading |
|
| public |
makeWidgetMetadataSelector(pageId: *, widgetId: *) |
|
| public |
makeWidgetPageIdSelector(widgetId: *) |
|
| public |
makeWidgetPageSelector(widgetId: *) Селектор-генератор для получения свойства виджета - page |
|
| public |
makeWidgetSizeSelector(widgetId: *) Селектор-генератор для получения свойства виджета - size |
|
| public |
makeWidgetSortingSelector(widgetId: *) Селектор-генератор для получения свойства виджета - sorting |
|
| public |
makeWidgetValidationSelector(widgetId: *) Селектор-генератор для получения свойства виджета - sorting |
|
| public |
makeWidgetVisibleSelector(widgetId: *) Селектор-генератор для получения свойства виджета - isVisible |
|
| public |
mapProp(prop: *): * |
|
| public |
mapToDefaultTime(val: *, defaultTime: *, defaultName: *): * Установаить дефолтное время |
|
| public |
mapToNum(count: *, callback: *, objectPattern2: {"increment": *, "start": *, "inclusive": *}): * |
|
| public |
mapToNumOrStr(count: *, callback: *) |
|
| public |
mapToValue(val: *, defaultTime: *, dateFormat: *, locale: *, defaultName: *): * Привести по пропсам к нужному формату |
|
| public |
mapUrl(pageId: *): * |
|
| public |
Соответствие поля значению из метаданных |
|
| public |
matchesWhiteList(val: *): * |
|
| public |
Валиадация максимальной длины |
|
| public |
messageSelector(formName: *, fieldName: *) |
|
| public |
* messagesFormEffect(objectPattern: {"meta": *}) |
|
| public |
metadataRequest(pageId: *, rootPage: *, pageUrl: *, mapping: *): * Запрос за метаданными страницы |
|
| public |
Валидация минимальной длины |
|
| public |
modals(state: *[], action: *): * Редюсер экшенов модалок |
|
| public |
modalsSelector(state: *): * селектор модольных окон |
|
| public |
modelsSelector(state: *): * Базовый селектор всех моделей |
|
| public |
* modify(values: *, formName: *, fieldName: *, type: *, options: {}) |
|
| public |
moveCursorToEnd(el: *) |
|
| public |
observeStore(store: Object, select: Function, onChange: Function): * Утилита позволяющая подписываться на изменения хранилища через селектор. |
|
| public |
omitDeep(collection: *, excludeKeys: *): * Глубокое удаление ключей |
|
| public |
pagesSelector(state: *): * Базовый селектор всех страниц |
|
| public |
parseDate(value: *, dateFormat: *): * преобразовать дату к moment-объекту |
|
| public |
parseExpression(value: *): * Проверяет и возвращает значение, если это js выражение |
|
| public |
parseFormatter(data: *, typeAndformat: *): * Преобразует строку по формату Примеры форматов: format="date DD.MM.YYYY HH:mm" format="date DD.MM.YYYY" format="dateFromNow" format="password" format="number 0,0.00" format="number 0,0.00[000]" |
|
| public |
parseToFloat(value: *) |
|
| public |
parseToInt(value: *) |
|
| public |
performAction(objectPattern: {"dispatch": *, "type": *, "payload": *, "meta": *, "actionId": *}) |
|
| public |
placementwithTooltip(component: *, hint: *, hintPosition: *, id: *): * Если есть подсказка, возвращаем с тултипом |
|
| public |
post(url: *, file: *, onProgress: *, onUpload: *, onError: *) |
|
| public |
preFilterIsFunction(value: *): * get func from preFilter |
|
| public |
prepareButton(buttons: *, payload: *): * |
|
| public |
* prepareFetch(widgetId: *): IterableIterator<*> Подготовка данных |
|
| public |
prepareStyle(vertical: *, style: *): * Кастомный стиль если vertical=true |
|
| public |
prepareValue(currentValue: *, id: *, multiSelect: *): * Функция для подготовки выбранных данных |
|
| public |
propsResolver(props: Object, data: Object): Object Функция преобразует шаблоные props свойства вида `name` в константные данные из контекста |
|
| public |
* redirectEffect(action: *) |
|
| public |
reduceFunction(isTrue: *, objectPattern1: {"model": *, "config": *}): * |
|
| public |
reducers(history: *, customReducers: {}) |
|
| public |
* refreshEffect(action: *) |
|
| public |
registerButton(key: *, id: *, size: *, title: *, count: *, icon: *, color: *, visible: *, disabled: *, hint: *, className: *, style: *): * Экшен регистрации кнопки в редаксе |
|
| public |
registerColumn(widgetId: *, columnId: *, label: *, disabled: *, visible: *): * Зарегистрировать колонку в редаксе |
|
| public |
registerDependency(widgetId: *, dependency: *): * Регистрация зависимости |
|
| public |
registerFieldDependency(form: *, name: *, dependency: *): * Зарегестрировать зависимости поля от других полей |
|
| public |
registerFieldExtra(form: *, name: *, initialState: *): * регистрирование дополнительных свойств у поля формы |
|
| public |
registerWidget(widgetId: *, initProps: *): * Регистрация виджета в хранилище |
|
| public |
registerWidgetDependency(widgetsDependencies: *, widgetId: *, dependency: *): {} Добавляет в хранилище новопришедший виджет с его widgetId и dependency |
|
| public |
removeAlert(key: *, id: *): * Удалить предупреждение |
|
| public |
* removeAlertSideEffect(action: *, alert: *, timeout: *) |
|
| public |
removeAlerts(key: *): * Удалить все предупреждения по ключу |
|
| public |
removeAllModel(key: *): * Удаление всех моделей из хранилища |
|
| public |
removeFieldMessage(form: *, name: *): * Удалить сообщение поля |
|
| public |
* removeMessage(action: *) |
|
| public |
removeModel(prefix: *, key: *): * Удаление модели из хранилища |
|
| public |
removeWidget(widgetId: *): * Удаляет виджет из хранилища |
|
| public |
renderIcon(icon: *, label: *, type: *, sidebarOpen: *, subItems: *): * Рендер иконки |
|
| public |
replaceDictionary(tmp: *): undefined[] |
|
| public |
Обрабытываемый запрос по URL через fetch. |
|
| public |
request(): * |
|
| public |
requestConfig(params: *): * Запрос за базовой настройкой приложения |
|
| public |
requestConfigFail(error: *): * Ошибки при запросе за настройкой приложения |
|
| public |
requestConfigSuccess(config: *): * Успешный вызов настройки приложения |
|
| public |
required(fieldId: *, values: *, options: *): * Валидация того, что поле непустое |
|
| public |
requiredSelector(formName: *, fieldName: *) |
|
| public |
resetPage(pageId: *): * сбросить состояние страницы в дефолтное положение |
|
| public |
resetWidgetState(widgetId: *): * |
|
| public |
resolve(code: *): * |
|
| public |
* resolveAuth(objectPattern: {"authProvider": *, "redirectPath": *, "externalLoginUrl": *}, objectPattern1: {"type": *, "payload": *}) |
|
| public |
* resolveButton(button: *, model: *) резолв всех условий |
|
| public |
resolveChange(state: *, payload: *, meta: *): any Резолв изменения поля в redux form с учетом keepDirty |
|
| public |
resolveConditions(conditions: *, model: *): boolean резолв кондишена кнопки |
|
| public |
* resolveDependency(dependencyType: *, widgetId: *, model: *, isVisible: *, prevIsVisible: *): IterableIterator<*|CallEffect> Резолв конкретной зависимости по типу |
|
| public |
* resolveDependency(action: *) |
|
| public |
* resolveEnabledDependency(widgetId: *, model: *): IterableIterator<*> Резолв активности |
|
| public |
resolveExportTable(dispatch: *, state: *, widgetId: *) Экшен экспорта таблицы |
|
| public |
* resolveFetchDependency(widgetId: *): IterableIterator<*> Резолв запросов |
|
| public |
resolveLink(state: *, links: *): * this function was deprecated. Клиентский парсинг глобальных ссылок. Устарел.
FORMAT { PREFIX -> WidgetLink : FieldId } |
|
| public |
* resolveMapping(dataProvider: *, state: *): * |
|
| public |
resolveSelector(state: *): * Селектор получения resolve моделей |
|
| public |
* resolveUrl(state: *, dataProvider: *, widgetState: *, options: *): IterableIterator<*> Получение basePath и baseQuery |
|
| public |
* resolveVisibleDependency(widgetId: *, model: *): IterableIterator<*> Резолв видимости |
|
| public |
resolveWidget(widgetId: *): * Вызывает действие разрешения виджета. |
|
| public |
* resolveWidgetDependency(prevState: *, state: *, widgetsDependencies: *): IterableIterator<*|CallEffect> Резолв всех зависимостей виджета |
|
| public |
routerSelector(state: *) Селектор роутинга |
|
| public |
* routesQueryMapping(state: *, routes: *, location: *) |
|
| public |
* runResolve(action: *) |
|
| public |
setActive(widgetId: *): * |
|
| public |
setButtonDisabled(key: *): * Экшен блокирования кнопки |
|
| public |
setButtonEnabled(key: *): * Экшен разблокирования кнопки |
|
| public |
setButtonHidden(key: *): * Экшен скрытия кнопки |
|
| public |
setButtonVisible(key: *): * Экшен показа кнопки |
|
| public |
setColumnHidden(widgetId: *, columnId: *): * Скрыть колонку |
|
| public |
setColumnVisible(widgetId: *, columnId: *): * Сделать колонку видимой |
|
| public |
setFilterValue(form: *, name: *, filter: *): * |
|
| public |
Не мутабельный set |
|
| public |
setModel(prefix: *, key: *, model: *): * Установка значений модели по префиксу и ключу |
|
| public |
* setParentVisibleIfAllChildChangeVisible(key: *, id: *) Функция для мониторинга изменения видимости родителя списка |
|
| public |
setRequired(form: *, name: *): * установить флаг обазяательного поля |
|
| public |
setStatus(pageId: *, status: *): * Присвоить статус запроса метаданных страницы |
|
| public |
setTableSelectedId(widgetId: *, selectedId: *): * Изменить выбранную запись в виджете |
|
| public |
setWatchDependency(state: *, props: *, dependencyType: *): * |
|
| public |
* setWidgetDataSuccess(widgetId: *, widgetState: *, basePath: *, baseQuery: *, currentDatasource: *) |
|
| public |
setWidgetMetadata(pageId: *, widgetId: *, metadata: *): * |
|
| public |
showField(form: *, name: *): * экшен показа поля |
|
| public |
showFields(form: *, names: *): * экшен показа полей формы |
|
| public |
showModal(name: *): * Показать модальное окно |
|
| public |
showPrompt(name: *): * Показать подтверждение закрытия модального окна |
|
| public |
showWidget(widgetId: *): * Сделать виджет видимым |
|
| public |
showWidgetFilters(widgetId: *): * Показать фильтры виджета |
|
| public |
singleDoubleClickFilter(singleCallback: *, doubleCallback: *, timeout: *): * |
|
| public |
sizeSelector(key: *) селектор пазмера кнопки |
|
| public |
sortDependency(dependency: *): * |
|
| public |
splitSearchText(text: *, searchText: *, filter: *): * |
|
| public |
startInvoke(widgetId: *, dataProvider: *, data: *, modelLink: *, meta: {"refresh": boolean}): * |
|
| public |
stringConverter(convertProps: *): function HOC для преобразования заданных пропсов из строки в число |
|
| public |
styleSelector(key: *) селектор стиля кнопки |
|
| public |
syncModel(prefix: *, keys: *, model: *): * this function is experimental. Этот экшен работает экспериментальном режиме
Установка значений в несколько моделей |
|
| public |
takeKeysWhenSearching(props: *): *[] |
|
| public |
titleSelector(key: *) селектор имени кнопки |
|
| public |
toggleButtonDisabled(key: *): * Экшен изменнения свойства блокировки на противоположенное |
|
| public |
toggleButtonVisiblity(key: *): * Экшен изменения видимости кнопки на противоположенное |
|
| public |
toggleColumnVisiblity(widgetId: *, columnId: *): * Поменять видимость колонки на противоположенную |
|
| public |
toggleWidgetFilters(widgetId: *): * Изменить видимость фильтров виджета на противоположенную |
|
| public |
toolbarSelector(state: *): * |
|
| public |
treeToCollection(tree: *, parentFieldId: *, valueFieldId: *): * Создаем коллекцию из дерева tree -> [{ id: ..., parentId: ... |
|
| public |
unloadingWidget(widgetId: *): * Деактивировать анимацию загрузки у виджета |
|
| public |
unsetRequired(form: *, name: *): * снять флаг обазяательного поля |
|
| public |
updateMapModel(prefix: *, key: *, field: *, value: *, map: *): * обновление массива с маппингом |
|
| public |
updateModel(prefix: *, key: *, field: *, value: *): * Обновление значения в модели |
|
| public |
updateWidgetDependency(widgetId: *): * Запуск зависимости |
|
| public |
* updateWidgetDependencyEffect(objectPattern: {"meta": *}) |
|
| public |
userCheck(payload: *): {"type": *, "payload": *, "meta": *} |
|
| public |
userCheckError(payload: *): {"type": *, "payload": *, "meta": *} |
|
| public |
userCheckSuccess(payload: *): {"type": *, "payload": *, "meta": *} |
|
| public |
userLogin(payload: *): {"type": *, "payload": *, "meta": *} |
|
| public |
userLoginError(payload: *): {"type": *, "payload": *, "meta": *} |
|
| public |
userLoginSuccess(payload: *): {"type": *, "payload": *, "meta": *} |
|
| public |
userLogout(payload: *): {"type": *, "payload": *, "meta": *} |
|
| public |
userLogoutError(payload: *): {"type": *, "payload": *, "meta": *} |
|
| public |
userLogoutSuccess(payload: *): {"type": *, "payload": *, "meta": *} |
|
| public |
* validate(options: *): * |
|
| public |
validateField(validationConfig: *, formName: *, state: *, isTouched: *): Promise<any[]> функция валидации |
|
| public |
visiblePartPopup(item: *, objectPattern1: {"prefixCls": *, "iconFieldId": *, "imageFieldId": *, "labelFieldId": *, "badgeFieldId": *, "badgeColorFieldId": *}) |
|
| public |
* watchDependency(): IterableIterator<*> Наблюдение за регистрацией зависимостей виджетов и изменением модели |
|
| public |
* watchModel(buttons: *, objectPattern1: {"payload": *}) |
|
| public |
* watcherDefaultModels(config: *) Для закрытия канала используем race c экшеном сброса (обнуление) метаданных страницы |
|
| public |
weeks(firstDay: *): * Возвращает массив из недель(каждая неделя - массив из дней) |
|
| public |
widgetSelector(state: *, props: *): * селектор всего виджета |
|
| public |
widgetsSelector(state: *): * Базовый селектор всех виджетов |
|
| public |
withActions(Component: *): * |
|
| public |
withActionsEditableCell(EditableCell: *): * |
|
| public |
withAdvancedTableRef(Component: *): * |
|
| public |
withCell(WrappedComponent: *): * HOC для оборачивания Cell Переопределяет свойство onClick в компонентах для посылки экшена |
|
| public |
withColumn(WrappedComponent: *): * колонка-контейнер |
|
| public |
withDependency(handleEventConfig: *): * |
|
| public |
withFetchData(WrappedComponent: *, apiCaller: *): * HOC для работы с данными |
|
| public |
withFieldContainer(Field: *): * HOC обертка для полей, в которой содержится мэппинг свойств редакса и регистрация дополнительных свойств полей |
|
| public |
withGetWidget(WrappedComponent: *): * HOC для работы с данными |
|
| public |
withListContainer(WrappedComponent: *): * HOC для контейнеров {@Link InputSelectContainer} и {@Link N2OSelectContainer} |
|
| public |
withLocale(date: *, locale: *): * добавть локаль |
|
| public |
withObserveDependency(config: *): * |
|
| public |
withRegisterDependency(Component: *): * |
|
| public |
withSecurity(WrappedComponent: *): * |
|
Static Public
public AdvancedTableEmptyText(): * source
import AdvancedTableEmptyText from 'n2o/src/components/widgets/AdvancedTable/AdvancedTableEmptyText.jsx'Компонент отображения отсутствия данных
Return:
| * |
public BaseNode(objectPattern: {"prefixCls": *, "iconFieldId": *, "imageFieldId": *, "labelFieldId": *, "badgeFieldId": *, "valueFieldId": *, "badgeColorFieldId": *, "searchValue": *, "searchKeys": *, "data": *, "filter": *}): * source
import BaseNode from 'n2o/src/components/widgets/Tree/TreeNodes/BaseNode/BaseNode.jsx'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"prefixCls": *, "iconFieldId": *, "imageFieldId": *, "labelFieldId": *, "badgeFieldId": *, "valueFieldId": *, "badgeColorFieldId": *, "searchValue": *, "searchKeys": *, "data": *, "filter": *} |
|
Return:
| * |
public BlankFieldset(objectPattern: {"render": *, "rows": *}): * source
import BlankFieldset from 'n2o/src/components/widgets/Form/fieldsets/BlankFieldset.js'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"render": *, "rows": *} |
|
Return:
| * |
public Buttons(objectPattern: {"visible": *, "searchLabel": *, "resetLabel": *, "onSearch": *, "onReset": *}): * source
import Buttons from 'n2o/src/components/snippets/Filter/Buttons.jsx'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"visible": *, "searchLabel": *, "resetLabel": *, "onSearch": *, "onReset": *} |
|
Return:
| * |
public Card(linear: boolean, circle: boolean, items: array, inverse:: boolean, outline:: boolean, children: node, rest: ...any): * source
import Card from 'n2o/src/components/widgets/Card/Card.jsx'Контейнер для карточек
Return:
| * |
public CardLayout(children: node, className: string, rest: ...any): * source
import CardLayout from 'n2o/src/components/widgets/Card/CardLayout.jsx'Лайоут для Карточек
Params:
| Name | Type | Attribute | Description |
| children | node | элемент потомок компонента CardLayout |
|
| className | string | Кастомный класс для компонента |
|
| rest | ...any |
Return:
| * |
public Collapse(activeKey: string | array, defaultActiveKey: string | array, destroyInactivePanel: boolean, accordion: boolean): * source
import Collapse from 'n2o/src/components/snippets/Collapse/Collapse.jsx'Компонент Collapse
Params:
| Name | Type | Attribute | Description |
| activeKey | string | array | активный ключ панели (При совпадении с ключами Panel происходит открытие последней) |
|
| defaultActiveKey | string | array | активный ключ по умолчанию |
|
| destroyInactivePanel | boolean | при закрытии панели удалить внутреннее содержимое. |
|
| accordion | boolean | включить режим accordion (При открытии панели захлопнуть предыдущую панель) |
Return:
| * |
public CollapseFieldSet(objectPattern: {"render": *, "rows": *, "type": *, "label": *, "expand": *, "hasArrow": *}): * source
import CollapseFieldSet from 'n2o/src/components/widgets/Form/fieldsets/CollapseFieldset/CollapseFieldSet.jsx'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"render": *, "rows": *, "type": *, "label": *, "expand": *, "hasArrow": *} |
|
Return:
| * |
public Control(props: object, component: component | string, className: component | string): * source
import Control from 'n2o/src/components/widgets/Form/fields/StandardField/Control.jsx'Контрол поля формы
Return:
| * |
Example:
<Control component={Input} {...props}/>
public DateInterval(objectPattern: {"value": *, "defaultTime": *, "defaultValue": *, "onChange": *, ...rest: Object}): * source
import DateInterval from 'n2o/src/components/controls/DatePicker/DateInterval.jsx'Компонент для выбора временного интервала. Состоит 2 DatePicker
Params:
| Name | Type | Attribute | Description |
| objectPattern | {"value": *, "defaultTime": *, "defaultValue": *, "onChange": *, ...rest: Object} |
|
Return:
| * |
Example:
<DatePicker defaultTime = '12:11'/>
public DefaultBreadcrumb(objectPattern: {"items": *}): * source
import DefaultBreadcrumb from 'n2o/src/components/core/Breadcrumb/DefaultBreadcrumb.jsx'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"items": *} |
|
Return:
| * |
public Description(objectPattern: {"value": *, ...props: Object}) source
import Description from 'n2o/src/components/widgets/Form/fields/StandardField/Description.jsx'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"value": *, ...props: Object} |
|
public DropdownCustomItem(objectPattern: {"color": *, ...rest: Object}): * source
import DropdownCustomItem from 'n2o/src/components/snippets/DropdownCustomItem/DropdownCustomItem.jsx'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"color": *, ...rest: Object} |
|
Return:
| * |
public ErrorPage(objectPattern: {"status": *, "error": *}): * source
import ErrorPage from 'n2o/src/components/errors/ErrorPage.jsx'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"status": *, "error": *} |
|
Return:
| * |
public ExpandBtn(objectPattern: {"onShowAll": *, "onHideAll": *}): * source
import ExpandBtn from 'n2o/src/components/widgets/Tree/component/ExpandBtn.jsx'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"onShowAll": *, "onHideAll": *} |
|
Return:
| * |
public Factory(props: *, context: *): * source
import Factory from 'n2o/src/core/factory/Factory.jsx'Params:
| Name | Type | Attribute | Description |
| props | * | ||
| context | * |
Return:
| * |
public FieldActions(actions: array): * source
import FieldActions from 'n2o/src/components/widgets/Form/fields/StandardField/FieldActions.jsx'Компонент, содержащий экшены поля
Params:
| Name | Type | Attribute | Description |
| actions | array | массив экшенов |
Return:
| * |
public FileUploaderControl(WrappedComponent: *): * source
import FileUploaderControl from 'n2o/src/components/controls/FileUploader/withFileUploader.jsx'Params:
| Name | Type | Attribute | Description |
| WrappedComponent | * |
Return:
| * |
public Form(objectPattern: {"rows": *, "cols": *}): * source
import Form from 'n2o/src/components/snippets/Placeholder/components/Form/Form.jsx'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"rows": *, "cols": *} |
|
Return:
| * |
public GlobalAlerts(alerts: array, onDismiss: function): JSX source
import {GlobalAlerts} from 'n2o/src/components/core/GlobalAlerts.jsx'Глобальные алерты
Params:
| Name | Type | Attribute | Description |
| alerts | array | массив алертов |
|
| onDismiss | function | функция закрытия |
Return:
| JSX |
public HeaderFooterTemplate(objectPattern: {"children": *}): * source
import HeaderFooterTemplate from 'n2o/src/components/core/templates/HeaderFooterTemplate.jsx'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"children": *} |
|
Return:
| * |
public Html(objectPattern: {"value": *, "visible": *, "disabled": *}): * source
import Html from 'n2o/src/components/controls/Html/Html.jsx'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"value": *, "visible": *, "disabled": *} |
|
Return:
| * |
public InlineSpinner() source
import InlineSpinner from 'n2o/src/components/snippets/Spinner/InlineSpinner.jsx'Inline-спиннер (лоадер), находится справа
public InputAddon(objectPattern: {"item": *, "iconFieldId": *, "imageFieldId": *, "setRef": *}): null source
import InputAddon from 'n2o/src/components/controls/InputSelect/InputAddon.jsx'InputAddon - дополнение с иконкой/картинкой для инпута {@Link InputSelectGroup}
Params:
| Name | Type | Attribute | Description |
| objectPattern | {"item": *, "iconFieldId": *, "imageFieldId": *, "setRef": *} |
|
public InputContent(objectPattern: {"disabled": *, "value": *, "placeholder": *, "onRemoveItem": *, "onFocus": *, "onBlur": *, "inputFocus": *, "isSelected": *, "selected": *, "labelFieldId": *, "valueFieldId": *, "clearSelected": *, "multiSelect": *, "collapseSelected": *, "lengthToGroup": *, "onInputChange": *, "openPopUp": *, "closePopUp": *, "activeValueId": *, "setActiveValueId": *, "disabledValues": *, "options": *, "onSelect": *, "onClick": *, "isExpanded": *, "autoFocus": *, "selectedPadding": *, "setTextareaRef": *, "setSelectedListRef": *, "_textarea": *, "_selectedList": *, "setRef": *}): * source
import InputContent from 'n2o/src/components/controls/InputSelect/InputContent.jsx'InputSelectGroup
Params:
| Name | Type | Attribute | Description |
| objectPattern | {"disabled": *, "value": *, "placeholder": *, "onRemoveItem": *, "onFocus": *, "onBlur": *, "inputFocus": *, "isSelected": *, "selected": *, "labelFieldId": *, "valueFieldId": *, "clearSelected": *, "multiSelect": *, "collapseSelected": *, "lengthToGroup": *, "onInputChange": *, "openPopUp": *, "closePopUp": *, "activeValueId": *, "setActiveValueId": *, "disabledValues": *, "options": *, "onSelect": *, "onClick": *, "isExpanded": *, "autoFocus": *, "selectedPadding": *, "setTextareaRef": *, "setSelectedListRef": *, "_textarea": *, "_selectedList": *, "setRef": *} |
|
Return:
| * |
public InputElements(objectPattern: {"onRemoveItem": *, "selected": *, "labelFieldId": *, "disabled": *, "collapseSelected": *, "lengthToGroup": *, "onDeleteAll": *, "setRef": *}): * source
import InputElements from 'n2o/src/components/controls/InputSelect/SelectedItems.jsx'Компонент выбранных элементов для {@Link InputSelectGroup}
Params:
| Name | Type | Attribute | Description |
| objectPattern | {"onRemoveItem": *, "selected": *, "labelFieldId": *, "disabled": *, "collapseSelected": *, "lengthToGroup": *, "onDeleteAll": *, "setRef": *} |
|
Return:
| * |
public InputHidden(props: *): * source
import InputHidden from 'n2o/src/components/controls/InputHidden/InputHidden.jsx'Params:
| Name | Type | Attribute | Description |
| props | * |
Return:
| * |
public InputSelectGroup(objectPattern: {"className": *, "loading": *, "isExpanded": *, "multiSelect": *, "iconFieldId": *, "imageFieldId": *, "onButtonClick": *, "selected": *, "input": *, "cleanable": *, "children": *, "isInputInFocus": *, "onClearClick": *, "setIsExpanded": *, "disabled": *, "setSelectedItemsRef": *}): * source
import InputSelectGroup from 'n2o/src/components/controls/InputSelect/InputSelectGroup.jsx'InputSelectGroup
Params:
| Name | Type | Attribute | Description |
| objectPattern | {"className": *, "loading": *, "isExpanded": *, "multiSelect": *, "iconFieldId": *, "imageFieldId": *, "onButtonClick": *, "selected": *, "input": *, "cleanable": *, "children": *, "isInputInFocus": *, "onClearClick": *, "setIsExpanded": *, "disabled": *, "setSelectedItemsRef": *} |
|
Return:
| * |
public Label(id: string, value: string | element, required: boolean, className: string, style: string, help: string, props: object): * source
import Label from 'n2o/src/components/widgets/Form/fields/StandardField/Label.jsx'Лейбел поля
Params:
| Name | Type | Attribute | Description |
| id | string | уникальный индефикатор |
|
| value | string | element | текст/элемент лейбела |
|
| required | boolean | поле обязательное(к лейбелу добавляется звездочка) или нет |
|
| className | string | дополнительный класс стиля |
|
| style | string | дополнительный dom стиль |
|
| help | string | подсказка |
|
| props | object | остальные пропсы |
Return:
| * |
Example:
<Label value='Телефон'/ required={true} />
public LeftTopBottom(props: object): * source
import LeftTopBottom from 'n2o/src/components/layouts/LeftTopBottom/LeftTopBottom.jsx'Layout виджета; Places: left, top, bottom
Return:
| * |
Example:
<LeftTopBottom>
<Section place="left">
<div>N2O is awesome</div>
</Section>
<Section place="bottom">
<div>N2O is awesome</div>
</Section>
<Section place="top">
<div>N2O is awesome</div>
</Section>
<LeftTopBottom/>
public List(objectPattern: {"paragraphs": *, "rows": *, "avatar": *}): * source
import List from 'n2o/src/components/snippets/Placeholder/components/List/List.jsx'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"paragraphs": *, "rows": *, "avatar": *} |
|
Return:
| * |
public ListItem(leftTop: Node | Object, leftBottom: Node | Object, header: Node | String, subHeader: Node | String, body: Node | String, rightTop: Node | String, rightBottom: Node | String, extra: Node | String, selected: boolean, onClick: function, divider: boolean, style: object, hasSelect: object): * source
import ListItem from 'n2o/src/components/widgets/List/ListItem.jsx'Компонент ListItem виджета ListWidget
Params:
| Name | Type | Attribute | Description |
| leftTop | Node | Object | секция картинки |
|
| leftBottom | Node | Object | секция картинки |
|
| header | Node | String | секция заголовка |
|
| subHeader | Node | String | секция подзаголовка |
|
| body | Node | String | секция тела |
|
| rightTop | Node | String | секция справа сверху |
|
| rightBottom | Node | String | секция справа снизу |
|
| extra | Node | String | extra секция |
|
| selected | boolean | флаг активности строки |
|
| onClick | function | callback на клик по строке |
|
| divider | boolean | разделить между строками |
|
| style | object | стили |
|
| hasSelect | object |
Return:
| * |
public ListMoreButton(onClick: function, style: object): * source
import ListMoreButton from 'n2o/src/components/widgets/List/ListMoreButton.jsx'Кнопка "Загрузить еще"
Return:
| * |
public Measure(value: string, props: object) source
import Measure from 'n2o/src/components/widgets/Form/fields/StandardField/Measure.jsx'Компонент-размерность
Example:
<Measure value="м"/>
public NavItemContainer(props: object): * source
import NavItemContainer from 'n2o/src/plugins/Header/SimpleHeader/NavItemContainer.jsx'Контейнер navItem'ов, в зависимости от type, создает внутри линк, дропдаун или текст
Return:
| * |
public NavbarBrandContent(props: *): * source
import NavbarBrandContent from 'n2o/src/plugins/Header/SimpleHeader/NavbarBrandContent.jsx'Рендер бренда и лого
Params:
| Name | Type | Attribute | Description |
| props | * | пропсы |
|
| props.brand | string | element | брэнд(текст) |
|
| props.brandImage | string | element | брэнд(изображение) |
Return:
| * |
public NotFoundFactory(objectPattern: {"src": *, "level": *}): * source
import NotFoundFactory from 'n2o/src/core/factory/NotFoundFactory.jsx'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"src": *, "level": *} |
|
Return:
| * |
public NothingFound() source
import NothingFound from 'n2o/src/components/controls/InputSelect/NothingFound.jsx'public OLD_SidebarFixTemplate(objectPattern: {"children": *, "className": *}): * source
import OLD_SidebarFixTemplate from 'n2o/src/plugins/OLD_SidebarFixTemplate.jsx'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"children": *, "className": *} |
|
Return:
| * |
public Panel(header: string, type: string, showArrow: boolean, openAnimation: object, disabled: boolean, forceRender: boolean): * source
import Panel from 'n2o/src/components/snippets/Collapse/Panel.jsx'Панель Collapse
Params:
| Name | Type | Attribute | Description |
| header | string | Заголовок панели |
|
| type | string | тип отображения панели( 'default', 'line', 'divider' ) |
|
| showArrow | boolean | показать иконку |
|
| openAnimation | object | обьект для изменения анимации открытия и закрытия панели |
|
| disabled | boolean | сделать панель неактивным |
|
| forceRender | boolean | Рендерить неактивные панели |
Return:
| * |
public Panel(objectPattern: {"className": *, "isFullScreen": *, "style": *, "onToggle": *, "open": *, "color": *, "onKeyPress": *, "children": *, "innerRef": *}): * source
import Panel from 'n2o/src/components/snippets/Panel/Panel.jsx'Компонент панели
Params:
| Name | Type | Attribute | Description |
| objectPattern | {"className": *, "isFullScreen": *, "style": *, "onToggle": *, "open": *, "color": *, "onKeyPress": *, "children": *, "innerRef": *} |
|
Return:
| * |
public PanelBody(objectPattern: {"id": *, "activeKey": *, "hasTabs": *, "children": *}): * source
import PanelBody from 'n2o/src/components/snippets/Panel/PanelBody.jsx'Компонент тела Panel
Params:
| Name | Type | Attribute | Description |
| objectPattern | {"id": *, "activeKey": *, "hasTabs": *, "children": *} |
|
Return:
| * |
public PanelFooter(objectPattern: {"children": *}): * source
import PanelFooter from 'n2o/src/components/snippets/Panel/PanelFooter.jsx'Компонент подвала Panel
Params:
| Name | Type | Attribute | Description |
| objectPattern | {"children": *} |
|
Return:
| * |
public PanelHeading(objectPattern: {"children": *}): * source
import PanelHeading from 'n2o/src/components/snippets/Panel/PanelHeading.jsx'Компонент шапки для Panel
Params:
| Name | Type | Attribute | Description |
| objectPattern | {"children": *} |
|
Return:
| * |
public PanelMenu(objectPattern: {"children": *, "collapsible": *, "onToggle": *, "fullScreen": *, "onFullScreenClick": *, "isOpen": *, "fullScreenIcon": *}): * source
import PanelMenu from 'n2o/src/components/snippets/Panel/PanelMenu.jsx'Компонент меню для Panel
Params:
| Name | Type | Attribute | Description |
| objectPattern | {"children": *, "collapsible": *, "onToggle": *, "fullScreen": *, "onFullScreenClick": *, "isOpen": *, "fullScreenIcon": *} |
|
Return:
| * |
public PanelNavItem(objectPattern: {"id": *, "onClick": *, "active": *, "disabled": *, "className": *, "isToolBar": *, "children": *}): * source
import PanelNavItem from 'n2o/src/components/snippets/Panel/PanelNavItem.jsx'Компонент элемента меню для Panel
Params:
| Name | Type | Attribute | Description |
| objectPattern | {"id": *, "onClick": *, "active": *, "disabled": *, "className": *, "isToolBar": *, "children": *} |
|
Return:
| * |
public PanelTabBody(objectPattern: {"eventKey": *, "children": *}): * source
import PanelTabBody from 'n2o/src/components/snippets/Panel/PanelTabBody.jsx'Компонент тела таба для Panel
Params:
| Name | Type | Attribute | Description |
| objectPattern | {"eventKey": *, "children": *} |
|
Return:
| * |
public PanelTitle(objectPattern: {"icon": *, "children": *}): * source
import PanelTitle from 'n2o/src/components/snippets/Panel/PanelTitle.jsx'Компонент заголовка для Panel
Params:
| Name | Type | Attribute | Description |
| objectPattern | {"icon": *, "children": *} |
|
Return:
| * |
public Paragraph(objectPattern: {...rest: Object}): * source
import Paragraph from 'n2o/src/components/snippets/Typography/Paragraph/Paragraph.jsx'Params:
| Name | Type | Attribute | Description |
| objectPattern | {...rest: Object} |
|
Return:
| * |
public Pills(data: *, rest: *): * source
import Pills from 'n2o/src/components/controls/Pills/Pills.jsx'Контролл Pills
Params:
| Name | Type | Attribute | Description |
| data | * | данные |
|
| rest | * |
Return:
| * |
public PopupItems(objectPattern: {"options": *, "activeLabel": *, "setActiveLabel": *, "labelFieldId": *, "iconFieldId": *, "valueFieldId": *, "imageFieldId": *, "disabledValues": *, "selected": *, "groupFieldId": *, "hasCheckboxes": *, "format": *, "badgeFieldId": *, "badgeColorFieldId": *, "onRemoveItem": *, "onSelect": *, "setActiveValueId": *, "activeValueId": *}): * source
import PopupItems from 'n2o/src/components/controls/InputSelect/PopupItems.jsx'Компонент попапа для InputSelect
Params:
| Name | Type | Attribute | Description |
| objectPattern | {"options": *, "activeLabel": *, "setActiveLabel": *, "labelFieldId": *, "iconFieldId": *, "valueFieldId": *, "imageFieldId": *, "disabledValues": *, "selected": *, "groupFieldId": *, "hasCheckboxes": *, "format": *, "badgeFieldId": *, "badgeColorFieldId": *, "onRemoveItem": *, "onSelect": *, "setActiveValueId": *, "activeValueId": *} |
|
Return:
| * |
public PopupList(objectPattern: {"children": *, "inputSelect": *, "isExpanded": *, "onScrollEnd": *, "expandPopUp": *, "filterValue": *, "needAddFilter": *, ...rest: Object}): * source
import PopupList from 'n2o/src/components/controls/InputSelect/PopupList.jsx'Компонент попапа для InputSelect
Params:
| Name | Type | Attribute | Description |
| objectPattern | {"children": *, "inputSelect": *, "isExpanded": *, "onScrollEnd": *, "expandPopUp": *, "filterValue": *, "needAddFilter": *, ...rest: Object} |
|
Return:
| * |
public SecurityNotRender(config: *, component: *, rest: *): * source
import SecurityNotRender from 'n2o/src/core/auth/SecurityNotRender.jsx'Вспомогательная функция для SecurityCheck
Params:
| Name | Type | Attribute | Description |
| config | * | ||
| component | * | ||
| rest | * |
Return:
| * |
public SidebarItemContainer(item: *, activeId: *, sidebarOpen: *): * source
import SidebarItemContainer from 'n2o/src/plugins/SideBar/SidebarItemContainer.js'Sidebar Item
Params:
| Name | Type | Attribute | Description |
| item | * | объект итема |
|
| activeId | * | активный элемент |
|
| sidebarOpen | * | флаг сжатия сайдбара |
Return:
| * |
public SimpleHeaderTest(): * source
import SimpleHeaderTest from 'n2o/src/plugins/Header/SimpleHeader/SimpleHeaderTest.jsx'Return:
| * |
public SimpleTemplate(objectPattern: {"children": *}): * source
import SimpleTemplate from 'n2o/src/components/core/templates/SimpleTemplate.jsx'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"children": *} |
|
Return:
| * |
public StandardWidgetLayout(className: string): * source
import StandardWidgetLayout from 'n2o/src/components/layouts/StandardWidgetLayout/StandardWidgetLayout.jsx'Стандартный Layout виджета, Places: top, topLeft, topRight, center, bottomLeft, bottomRight, bottom
Params:
| Name | Type | Attribute | Description |
| className | string | css-класс |
Return:
| * |
Example:
<StandardWidgetLayout/>
<Section place="top">
<div>N2O is awesome</div>
</Section>
<Section place="bottom">
<div>N2O is awesome</div>
</Section>
<Section place="topLeft">
<div>N2O is awesome</div>
</Section>
<Section place="bottomLeft">
<div>N2O is awesome</div>
</Section>
<Section place="bottomRight">
<div>N2O is awesome</div>
</Section>
<Section place="topRight">
<div>N2O is awesome</div>
</Section>
</StandardWidgetLayout>
public Table(objectPattern: {"cols": *, "rows": *}): * source
import Table from 'n2o/src/components/snippets/Placeholder/components/Table/Table.jsx'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"cols": *, "rows": *} |
|
Return:
| * |
public Text(objectPattern: {...rest: Object}): * source
import Text from 'n2o/src/components/snippets/Typography/Text/Text.jsx'Params:
| Name | Type | Attribute | Description |
| objectPattern | {...rest: Object} |
|
Return:
| * |
public Text(objectPattern: {"text": *, "format": *, ...rest: Object}): * source
import Text from 'n2o/src/components/snippets/Text/Text.jsx'Компонент, который отображает текст
Params:
| Name | Type | Attribute | Description |
| objectPattern | {"text": *, "format": *, ...rest: Object} |
|
Return:
| * |
public TextArea(className: string, style: object, disabled: boolean, disabled: boolean, placeholder: string, rows: number, maxRows: number, value: string | number, onChange: function): * source
import TextArea from 'n2o/src/components/controls/TextArea/TextArea.jsx'Компонент TextAreat
Return:
| * |
public TextField(text: string, visible: boolean, format: string, className: string, style: object): * source
import TextField from 'n2o/src/components/widgets/Form/fields/TextField/TextField.jsx'Компонент поле текст
Return:
| * |
public Title(objectPattern: {"level": *, ...rest: Object}): * source
import Title from 'n2o/src/components/snippets/Typography/Title/Title.jsx'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"level": *, ...rest: Object} |
|
Return:
| * |
public TitleFieldset(objectPattern: {"render": *, "rows": *, "title": *, "showLine": *, "className": *, "subTitle": *}): * source
import TitleFieldset from 'n2o/src/components/widgets/Form/fieldsets/TitleFieldset/TitleFieldset.jsx'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"render": *, "rows": *, "title": *, "showLine": *, "className": *, "subTitle": *} |
|
Return:
| * |
public Tree(objectPattern: {"rows": *, "chevron": *}): * source
import Tree from 'n2o/src/components/snippets/Placeholder/components/Tree/Tree.jsx'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"rows": *, "chevron": *} |
|
Return:
| * |
public TreeItem(objectPattern: {"node": *, "options": *}): * source
import TreeItem from 'n2o/src/components/controls/InputSelectTreeOldDeprecated/TreeItem.jsx'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"node": *, "options": *} |
|
Return:
| * |
public TreeNode(options: object, disabled: boolean, key: string, format: string, children: node, rest: object): * source
import TreeNode from 'n2o/src/components/controls/InputSelectTree/TreeSelectNode.jsx'Компонент TreeNode
Return:
| * |
public TreeNode(objectPattern: {"children": *, "item": *, "disabled": *, "selected": *, "hasChildren": *, "expanded": *, "onDelete": *, "onSelect": *, "onExpandClick": *, ...rest: Object}): * source
import TreeNode from 'n2o/src/components/controls/InputSelectTreeOldDeprecated/TreeNode.jsx'Элемент дерева
Params:
| Name | Type | Attribute | Description |
| objectPattern | {"children": *, "item": *, "disabled": *, "selected": *, "hasChildren": *, "expanded": *, "onDelete": *, "onSelect": *, "onExpandClick": *, ...rest: Object} |
|
Return:
| * |
public Wireframe(objectPattern: {"title": *, "className": *, "height": *}) source
import Wireframe from 'n2o/src/components/widgets/Wireframe/Wireframe.jsx'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"title": *, "className": *, "height": *} |
|
public addAlert(key: *, alerts: *): * source
import {addAlert} from 'n2o/src/actions/alerts.js'Добавить предупреждения
Params:
| Name | Type | Attribute | Description |
| key | * | ||
| alerts | * |
Return:
| * |
public * addAlertSideEffect(config: *, action: *) source
import {addAlertSideEffect} from 'n2o/src/sagas/alerts.js'Params:
| Name | Type | Attribute | Description |
| config | * | ||
| action | * |
public addAlerts(key: *, alerts: *): * source
import {addAlerts} from 'n2o/src/actions/alerts.js'Добавляет массив предупреждений
Params:
| Name | Type | Attribute | Description |
| key | * | ||
| alerts | * |
Return:
| * |
public addFieldMessage(form: *, name: *, message: *, isTouched: *): * source
import {addFieldMessage} from 'n2o/src/actions/formPlugin.js'Добавить сообщение (после валидации) к полю
Params:
| Name | Type | Attribute | Description |
| form | * | название формы |
|
| name | * | названия филдов формы |
|
| message | * | сообщение |
|
| isTouched | * | флаг для вставки touch у филда |
Return:
| * |
public addTime(date: *, hours: *, mins: *): * source
import {addTime} from 'n2o/src/components/controls/DatePicker/utils.js'добавить часы и минуты к дате
Params:
| Name | Type | Attribute | Description |
| date | * | ||
| hours | * | ||
| mins | * |
Return:
| * |
public * addTouched(objectPattern: {"payload": *}) source
import {addTouched} from 'n2o/src/sagas/formPlugin.js'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"payload": *} |
|
public * alertEffect(action: *) source
import {alertEffect} from 'n2o/src/sagas/meta.js'Params:
| Name | Type | Attribute | Description |
| action | * |
public alerts(config: *): undefined[] source
import alerts from 'n2o/src/sagas/alerts.js'Params:
| Name | Type | Attribute | Description |
| config | * |
public alertsSelector(state: *): * source
import {alertsSelector} from 'n2o/src/selectors/alerts.js'Селектор всех алертов
Params:
| Name | Type | Attribute | Description |
| state | * |
Return:
| * |
public apiProvider(type: *, options: *): * source
import apiProvider from 'n2o/src/core/api.js'Params:
| Name | Type | Attribute | Description |
| type | * | ||
| options | * |
Return:
| * |
public auth(config: *): undefined[] source
import auth from 'n2o/src/sagas/auth.js'Params:
| Name | Type | Attribute | Description |
| config | * |
public auth(state: *, objectPattern1: {"type": *, "payload": *, "meta": *}): * source
import auth from 'n2o/src/reducers/auth.js'Params:
| Name | Type | Attribute | Description |
| state | * |
|
|
| objectPattern1 | {"type": *, "payload": *, "meta": *} |
|
Return:
| * |
public authSelector(state: *): * source
import {authSelector} from 'n2o/src/selectors/auth.js'Params:
| Name | Type | Attribute | Description |
| state | * |
Return:
| * |
public buildDateFormat(dateFormat: *, timeFormat: *, divider: *): * source
import {buildDateFormat} from 'n2o/src/components/controls/DatePicker/utils.js'Params:
| Name | Type | Attribute | Description |
| dateFormat | * | ||
| timeFormat | * | ||
| divider | * |
Return:
| * |
public calculateMaxFreeSpace(input: *, popUp: *, window: *): * source
import {calculateMaxFreeSpace} from 'n2o/src/components/controls/DatePicker/utils.js'Вычисляем наибольшее свободное пространство рядом с элементом Возвращаем одно из вариантов [left, top, right, bottom]
Params:
| Name | Type | Attribute | Description |
| input | * | input dateInterval |
|
| popUp | * | popUp dateInterval |
|
| window | * | глобальный обьект window |
Return:
| * |
public callActionImpl(key: *, actionSrc: *, options: *): * source
import {callActionImpl} from 'n2o/src/actions/toolbar.js'Вызов функции эшкен импла
Params:
| Name | Type | Attribute | Description |
| key | * | ||
| actionSrc | * | ||
| options | * |
Return:
| * |
public * catchAction(dispatch: *) source
import {catchAction} from 'n2o/src/sagas/fieldDependency.js'Params:
| Name | Type | Attribute | Description |
| dispatch | * |
public changeButtonClass(key: *, className: *): * source
import {changeButtonClass} from 'n2o/src/actions/toolbar.js'Экшен изменения css-класса кнопки
Params:
| Name | Type | Attribute | Description |
| key | * | ||
| className | * |
Return:
| * |
public changeButtonColor(key: *, color: *): * source
import {changeButtonColor} from 'n2o/src/actions/toolbar.js'Экшен изменения цета кнопки
Params:
| Name | Type | Attribute | Description |
| key | * | ||
| color | * |
Return:
| * |
public changeButtonCount(key: *, count: *): * source
import {changeButtonCount} from 'n2o/src/actions/toolbar.js'Экшен изменения счетчика кнопки
Params:
| Name | Type | Attribute | Description |
| key | * | ||
| count | * |
Return:
| * |
public changeButtonDisabled(key: *, disabled: *): * source
import {changeButtonDisabled} from 'n2o/src/actions/toolbar.js'Экшен изменения свойства блокировки
Params:
| Name | Type | Attribute | Description |
| key | * | ||
| disabled | * |
Return:
| * |
public changeButtonHint(key: *, hint: *): * source
import {changeButtonHint} from 'n2o/src/actions/toolbar.js'Экшен изменения подсказки кнопки
Params:
| Name | Type | Attribute | Description |
| key | * | ||
| hint | * |
Return:
| * |
public changeButtonIcon(key: *, icon: *): * source
import {changeButtonIcon} from 'n2o/src/actions/toolbar.js'Экшен изменения иконки кнопки
Params:
| Name | Type | Attribute | Description |
| key | * | ||
| icon | * |
Return:
| * |
public changeButtonSize(key: *, size: *): * source
import {changeButtonSize} from 'n2o/src/actions/toolbar.js'Экшен изменения размера кнопки
Params:
| Name | Type | Attribute | Description |
| key | * | ||
| size | * |
Return:
| * |
public changeButtonStyle(key: *, style: *): * source
import {changeButtonStyle} from 'n2o/src/actions/toolbar.js'Экшен изменения объекта стиля кнопки
Params:
| Name | Type | Attribute | Description |
| key | * | ||
| style | * |
Return:
| * |
public changeButtonTitle(key: *, title: *): * source
import {changeButtonTitle} from 'n2o/src/actions/toolbar.js'Экшен изменения заголовка кнопки
Params:
| Name | Type | Attribute | Description |
| key | * | ||
| title | * |
Return:
| * |
public changeButtonVisiblity(key: *, visible: *): * source
import {changeButtonVisiblity} from 'n2o/src/actions/toolbar.js'Экшен смены видимости кнопки
Params:
| Name | Type | Attribute | Description |
| key | * | ||
| visible | * |
Return:
| * |
public changeColumnDisabled(widgetId: *, columnId: *, disabled: *): * source
import {changeColumnDisabled} from 'n2o/src/actions/columns.js'Params:
| Name | Type | Attribute | Description |
| widgetId | * | ||
| columnId | * | ||
| disabled | * |
Return:
| * |
public changeColumnVisiblity(widgetId: *, columnId: *, visible: *): * source
import {changeColumnVisiblity} from 'n2o/src/actions/columns.js'Изменение видимсоти колонки таблицы
Params:
| Name | Type | Attribute | Description |
| widgetId | * | ||
| columnId | * | ||
| visible | * |
Return:
| * |
public changeCountWidget(widgetId: *, count: *): * source
import {changeCountWidget} from 'n2o/src/actions/widgets.js'Меняет количество записей в виджете. Этот параметр служит для отрисовки пейджинга
Params:
| Name | Type | Attribute | Description |
| widgetId | * | уникальный индефикатор виджета |
|
| count | * | кол-во записей |
Return:
| * |
public changeFiltersVisibility(widgetId: *, isFilterVisible: *): * source
import {changeFiltersVisibility} from 'n2o/src/actions/widgets.js'Изменить видимость фильтров виджета
Params:
| Name | Type | Attribute | Description |
| widgetId | * | ||
| isFilterVisible | * |
Return:
| * |
public changeLocale(locale: *): * source
import {changeLocale} from 'n2o/src/actions/global.js'Сменить язык интерфейса
Params:
| Name | Type | Attribute | Description |
| locale | * |
Return:
| * |
public changePageWidget(widgetId: *, page: *): * source
import {changePageWidget} from 'n2o/src/actions/widgets.js'Меняет номер страницы виджета Этот параметр используется при запросах на сервер
Params:
| Name | Type | Attribute | Description |
| widgetId | * | уникальный индефикатор виджета |
|
| page | * | номер страницы |
Return:
| * |
public changeRootPage(rootPageId: *): * source
import {changeRootPage} from 'n2o/src/actions/global.js'Сменить текущую страницу
Params:
| Name | Type | Attribute | Description |
| rootPageId | * |
Return:
| * |
public changeSizeWidget(widgetId: *, size: *): * source
import {changeSizeWidget} from 'n2o/src/actions/widgets.js'Меняет размер выборки виджета Этот параметр используется при запросах на сервер
Params:
| Name | Type | Attribute | Description |
| widgetId | * | уникальный индефикатор виджета |
|
| size | * | размер выборки |
Return:
| * |
public * checkAndModify(values: *, fields: *, formName: *, fieldName: *, actionType: *) source
import {checkAndModify} from 'n2o/src/sagas/fieldDependency.js'Params:
| Name | Type | Attribute | Description |
| values | * | ||
| fields | * | ||
| formName | * | ||
| fieldName | * | ||
| actionType | * |
public * checkOnDirtyForm(name: *): IterableIterator<*> source
import {checkOnDirtyForm} from 'n2o/src/sagas/modals.js'Проверка на изменение данных в формах
Params:
| Name | Type | Attribute | Description |
| name | * |
Return:
| IterableIterator<*> |
public * checkPrompt(action: *): IterableIterator<*> source
import {checkPrompt} from 'n2o/src/sagas/modals.js'Функция показа подтверждения закрытия
Params:
| Name | Type | Attribute | Description |
| action | * |
Return:
| IterableIterator<*> |
public classSelector(key: *) source
import {classSelector} from 'n2o/src/selectors/toolbar.js'селектор класса кнопки
Params:
| Name | Type | Attribute | Description |
| key | * |
public * clearForm(action: *) source
import {clearForm} from 'n2o/src/sagas/widgets.js'Params:
| Name | Type | Attribute | Description |
| action | * |
public * clearFormEffect(action: *) source
import {clearFormEffect} from 'n2o/src/sagas/meta.js'Params:
| Name | Type | Attribute | Description |
| action | * |
public clearModel(prefix: *, key: *, exclude: *): * source
import {clearModel} from 'n2o/src/actions/models.js'Очистка модели. которая учивает список исключений (поля которые не нужно очищать)
Params:
| Name | Type | Attribute | Description |
| prefix | * | ||
| key | * | ||
| exclude | * |
Return:
| * |
public * clearOnDisable(action: *) source
import {clearOnDisable} from 'n2o/src/sagas/widgets.js'Params:
| Name | Type | Attribute | Description |
| action | * |
public cloneObject(obj: *) source
import cloneObject from 'n2o/src/utils/cloneObject.js'Params:
| Name | Type | Attribute | Description |
| obj | * |
public closeModal(name: *, prompt: *): * source
import {closeModal} from 'n2o/src/actions/modals.js'События при попытке закрыть модальное окно
Params:
| Name | Type | Attribute | Description |
| name | * | ||
| prompt | * |
Return:
| * |
public collectionToComponentObject(Component: *, props: *): * source
import {collectionToComponentObject} from 'n2o/src/components/widgets/Tree/until.js'Превращаем коллекцию в обьект с ключами id и value Element [{ id: 1, ...}, { id: 2, ... }] => { 1: {...}, 2: {...} }
Params:
| Name | Type | Attribute | Description |
| Component | * | ||
| props | * |
Return:
| * |
public colorSelector(key: *) source
import {colorSelector} from 'n2o/src/selectors/toolbar.js'селектор цвета кнопки
Params:
| Name | Type | Attribute | Description |
| key | * |
public combineModels(combine: *): * source
import {combineModels} from 'n2o/src/actions/models.js'Params:
| Name | Type | Attribute | Description |
| combine | * |
Return:
| * |
public compareAndResolve(models: *, stateModels: *): * source
import {compareAndResolve} from 'n2o/src/sagas/pages.js'Дополнительная функция для observeModels. резолвит и сравнивает модели из стейта и резолв модели.
Params:
| Name | Type | Attribute | Description |
| models | * | модели для резолва |
|
| stateModels | * | модели из стейта |
Return:
| * |
public compileUrl(url: *, objectPattern1: {"pathMapping": *, "queryMapping": *}, state: *, objectPattern3: {"extraPathParams": *, "extraQueryParams": *}): * source
import compileUrl from 'n2o/src/utils/compileUrl.js'Params:
| Name | Type | Attribute | Description |
| url | * | ||
| objectPattern1 | {"pathMapping": *, "queryMapping": *} |
|
|
| state | * | ||
| objectPattern3 | {"extraPathParams": *, "extraQueryParams": *} |
|
Return:
| * |
public condition(fieldId: *, values: *, options: *): boolean source
import {condition} from 'n2o/src/core/validation/presets.js'Валидация js-condition
Params:
| Name | Type | Attribute | Description |
| fieldId | * | ||
| values | * | ||
| options | * |
public configureStore(initialState: *, history: *, config: {}): * source
import configureStore from 'n2o/src/store.js'Params:
| Name | Type | Attribute | Description |
| initialState | * | ||
| history | * | ||
| config | {} |
|
Return:
| * |
public async constraint(fieldId: *, values: *, options: *, dispatch: *): boolean | * source
import {constraint} from 'n2o/src/core/validation/presets.js'Валидация с отправкой запроса на сервер
Params:
| Name | Type | Attribute | Description |
| fieldId | * | ||
| values | * | ||
| options | * | ||
| dispatch | * |
public convertData(value: *, data: *, labelFieldId: *, valueFieldId: *): * source
import {convertData} from 'n2o/src/components/controls/Pills/utils.js'Функция для преобразования данных с помоцию ключей указывающих на значение
Params:
| Name | Type | Attribute | Description |
| value | * | текущее значение |
|
| data | * | массив данных |
|
| labelFieldId | * | ключ лейбла |
|
| valueFieldId | * |
|
Return:
| * |
public convertSize(size: *, step: number): * source
import {convertSize} from 'n2o/src/components/controls/FileUploader/utils.js'Params:
| Name | Type | Attribute | Description |
| size | * | ||
| step | number |
|
Return:
| * |
public copyModel(source: object, target: object): * source
import {copyModel} from 'n2o/src/actions/models.js'Копирование модели по префиксу и ключу в другую модель, по префиксу и ключу
Return:
| * |
public countSelector(key: *) source
import {countSelector} from 'n2o/src/selectors/toolbar.js'селектор счетчика кнопки
Params:
| Name | Type | Attribute | Description |
| key | * |
public createActionHelper(type: *, payloadFunc: *, metaFunc: *): * source
import createActionHelper from 'n2o/src/actions/createActionHelper.js'Обертка вокруг createAction с дефолтными мапперами
Params:
| Name | Type | Attribute | Description |
| type | * | ||
| payloadFunc | * | ||
| metaFunc | * |
Return:
| * |
public createContextFn(vars: *, code: *): * source
import {createContextFn} from 'n2o/src/utils/evalExpression.js'Создает функцию с контекстом
Params:
| Name | Type | Attribute | Description |
| vars | * | массив переменных |
|
| code | * | код для выполнения |
Return:
| * |
public createErrorPages(objectPattern: {"notFound": *, "forbidden": *, "serverError": *}): undefined[] source
import createErrorPages from 'n2o/src/components/errors/index.js'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"notFound": *, "forbidden": *, "serverError": *} |
|
public createFactoryConfig(customConfig: *): * source
import createFactoryConfig from 'n2o/src/core/factory/createFactoryConfig.js'Params:
| Name | Type | Attribute | Description |
| customConfig | * |
Return:
| * |
public createObjectByDotNotationKey(key: *, obj: *, delimiter: *): {} source
import {createObjectByDotNotationKey} from 'n2o/src/tools/helpers.js'Create object dy dot notation string and set value from context.
Params:
| Name | Type | Attribute | Description |
| key | * | string with dot notation |
|
| obj | * | ||
| delimiter | * |
|
Return:
| {} |
public createObjectFromDotString(string: String, defaultValue: *, delimiter: *, $resultObject: Object): Object source
import {createObjectFromDotString} from 'n2o/src/tools/helpers.js'Create object form string with dot notation
Example:
"Page.sdf.test" => {
Page: {
sdf: {
test: 'default value'
}
}
}
public createRegExp(searchText: *, filter: *): * source
import {createRegExp} from 'n2o/src/components/widgets/Tree/until.js'Params:
| Name | Type | Attribute | Description |
| searchText | * | ||
| filter | * |
Return:
| * |
public createTreeFn(Component: *): * source
import {createTreeFn} from 'n2o/src/components/widgets/Tree/until.js'Params:
| Name | Type | Attribute | Description |
| Component | * |
Return:
| * |
public createValidator(validationConfig: {}, formName: *, state: *): {"asyncValidate": *, "asyncChangeFields": *} source
import createValidator from 'n2o/src/core/validation/createValidator.js'Params:
| Name | Type | Attribute | Description |
| validationConfig | {} |
|
|
| formName | * | ||
| state | * |
Return:
| {"asyncValidate": *, "asyncChangeFields": *} |
public createWidgetContainer(initialConfig: *, widgetType: *): * source
import createWidgetContainer from 'n2o/src/components/widgets/WidgetContainer.jsx'HOC, оборачивает в виджет контейнер, Выполняет запрос за данными и связь с redux
Params:
| Name | Type | Attribute | Description |
| initialConfig | * | ||
| widgetType | * |
Return:
| * |
public customTreeActions(objectPattern: {"key": *, "treeRef": *, "datasource": *, "expandedKeys": *, "prefixCls": *, "valueFieldId": *, "parentFieldId": *, "hasCheckboxes": *}): boolean source
import {customTreeActions} from 'n2o/src/components/widgets/Tree/until.js'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"key": *, "treeRef": *, "datasource": *, "expandedKeys": *, "prefixCls": *, "valueFieldId": *, "parentFieldId": *, "hasCheckboxes": *} |
|
public dataRequestWidget(widgetId: *, options: *): * source
import {dataRequestWidget} from 'n2o/src/actions/widgets.js'Запрос за данными
Params:
| Name | Type | Attribute | Description |
| widgetId | * | уникальный индефикатор виджета |
|
| options | * | опции для |
Return:
| * |
Example:
dispatch(dataRequestWidget("Page.Widget", {size: 200}))
public delay(ms: *) source
import {delay} from 'n2o/src/components/snippets/Typography/utils.js'Params:
| Name | Type | Attribute | Description |
| ms | * |
public deleteFile(url: *, id: *) source
import {deleteFile} from 'n2o/src/components/controls/FileUploader/utils.js'Params:
| Name | Type | Attribute | Description |
| url | * | ||
| id | * |
public dependency(WrappedComponent: *): * source
import dependency from 'n2o/src/core/dependency.jsx'НОС - создает зависимость
Params:
| Name | Type | Attribute | Description |
| WrappedComponent | * |
Return:
| * |
public dependencySelector(formName: *, fieldName: *) source
import {dependencySelector} from 'n2o/src/selectors/formPlugin.js'Params:
| Name | Type | Attribute | Description |
| formName | * | ||
| fieldName | * |
public destroyModal(): * source
import {destroyModal} from 'n2o/src/actions/modals.js'Удалить модальное окно
Return:
| * |
public difference(object: Object, base: Object): Object source
import {difference} from 'n2o/src/tools/helpers.js'Глубокое сравнение двух объектов
public disableField(form: *, name: *): * source
import {disableField} from 'n2o/src/actions/formPlugin.js'экшен дизактивации поля
Params:
| Name | Type | Attribute | Description |
| form | * | ||
| name | * |
Return:
| * |
public disableFields(form: *, names: *): * source
import {disableFields} from 'n2o/src/actions/formPlugin.js'экшен дизактивации полей формы
Params:
| Name | Type | Attribute | Description |
| form | * | название формы |
|
| names | * | массив названия филдов формы |
Return:
| * |
public disablePage(pageId: *): * source
import {disablePage} from 'n2o/src/actions/pages.js'заблокировать страницу
Params:
| Name | Type | Attribute | Description |
| pageId | * |
Return:
| * |
public disableWidget(widgetId: *): * source
import {disableWidget} from 'n2o/src/actions/widgets.js'Сделать виджет заблокированым
Params:
| Name | Type | Attribute | Description |
| widgetId | * | уникальный индефикатор виджета |
Return:
| * |
Example:
dispatch(disableWidget("Page.Widget"))
public disableWidgetOnFetch(widgetId: *): * source
import {disableWidgetOnFetch} from 'n2o/src/actions/widgets.js'Params:
| Name | Type | Attribute | Description |
| widgetId | * |
Return:
| * |
public dummyImpl(objectPattern: {"dispatch": *, ...options: Object}) source
import dummyImpl from 'n2o/src/impl/actions/dummy.js'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"dispatch": *, ...options: Object} |
|
public email(fieldId: *, values: *): boolean source
import {email} from 'n2o/src/core/validation/presets.js'Валидация того, что email
Params:
| Name | Type | Attribute | Description |
| fieldId | * | ||
| values | * |
public enableField(form: *, name: *): * source
import {enableField} from 'n2o/src/actions/formPlugin.js'экшен активирования поля(из неактивного состояния(disabled))
Params:
| Name | Type | Attribute | Description |
| form | * | ||
| name | * |
Return:
| * |
public enableFields(form: *, names: *): * source
import {enableFields} from 'n2o/src/actions/formPlugin.js'экшен активации полей формы
Params:
| Name | Type | Attribute | Description |
| form | * | название формы |
|
| names | * | массив названия филдов формы |
Return:
| * |
public enablePage(pageId: *): * source
import {enablePage} from 'n2o/src/actions/pages.js'разблокировать страницу
Params:
| Name | Type | Attribute | Description |
| pageId | * |
Return:
| * |
public enableWidget(widgetId: *): * source
import {enableWidget} from 'n2o/src/actions/widgets.js'Сделать виджет разблокированым
Params:
| Name | Type | Attribute | Description |
| widgetId | * | уникальный индефикатор виджета |
Return:
| * |
Example:
dispatch(enableWidget("Page.Widget"))
public errorSelector(key: *) source
import {errorSelector} from 'n2o/src/selectors/toolbar.js'селектор ошибок экшена кнопки
Params:
| Name | Type | Attribute | Description |
| key | * |
public evalExpression(expression: *, context: *): * source
import evalExpression from 'n2o/src/utils/evalExpression.js'Выполняет JS выражение с контекстом
Params:
| Name | Type | Attribute | Description |
| expression | * | ||
| context | * |
Return:
| * |
public factoryResolver(props: Object, defaultComponent: String, type: String): Object source
import factoryResolver from 'n2o/src/utils/factoryResolver.js'Функция преобразует ссылку в метаданных на компонент, на React компонент. Производит поиск свойства src и заменяет его на свойство component, где значение компонент из компонентных карт.
Example:
const props = {
widgetId: "Test.test",
src: "TableWidget"
}
console.log(factoryResolver(props, 'widgets'))
//- {widgetId: "Test.test", component: TableWidget}
public fetchCancel(fetchType: *, options: *): * source
import {fetchCancel} from 'n2o/src/actions/fetch.js'Params:
| Name | Type | Attribute | Description |
| fetchType | * | ||
| options | * |
Return:
| * |
public fetchEnd(fetchType: *, options: *, response: *): * source
import {fetchEnd} from 'n2o/src/actions/fetch.js'Params:
| Name | Type | Attribute | Description |
| fetchType | * | ||
| options | * | ||
| response | * |
Return:
| * |
public fetchError(fetchType: *, options: *, error: *): * source
import {fetchError} from 'n2o/src/actions/fetch.js'Params:
| Name | Type | Attribute | Description |
| fetchType | * | ||
| options | * | ||
| error | * |
Return:
| * |
public fetchErrorContinue(): * source
import {fetchErrorContinue} from 'n2o/src/actions/fetch.js'Return:
| * |
public fetchIfChangeDependencyValue(prevState: *, state: *, ref: *) source
import {fetchIfChangeDependencyValue} from 'n2o/src/components/widgets/Form/utils.js'Запрашивает данные, если зависимое значение было изменено
Params:
| Name | Type | Attribute | Description |
| prevState | * | ||
| state | * | ||
| ref | * |
public fetchInputSelectData(options: *, model: *, settings: {"apiPrefix": undefined, "basePath": undefined}): * source
import {fetchInputSelectData} from 'n2o/src/core/api.js'Return:
| * |
public * fetchInvoke(dataProvider: *, model: *): IterableIterator<*> source
import {fetchInvoke} from 'n2o/src/sagas/actionsImpl.js'Отправка запроса
Params:
| Name | Type | Attribute | Description |
| dataProvider | * | ||
| model | * |
Return:
| IterableIterator<*> |
public * fetchSaga(fetchType: *, options: *): * source
import fetchSaga from 'n2o/src/sagas/fetch.js'Params:
| Name | Type | Attribute | Description |
| fetchType | * | ||
| options | * |
Return:
| * |
public fetchStart(fetchType: *, options: *): * source
import {fetchStart} from 'n2o/src/actions/fetch.js'Params:
| Name | Type | Attribute | Description |
| fetchType | * | ||
| options | * |
Return:
| * |
public filterSelector(formName: *, fieldName: *) source
import {filterSelector} from 'n2o/src/selectors/formPlugin.js'Params:
| Name | Type | Attribute | Description |
| formName | * | ||
| fieldName | * |
public flatFields(obj: *, fields: *): * source
import {flatFields} from 'n2o/src/components/widgets/Form/utils.js'Делает из сложного объекта с филдами разных уровнях плоский массив филдов (обходит объект рекурсивно)
Params:
| Name | Type | Attribute | Description |
| obj | * | объект, откуда достаем филды |
|
| fields | * | текущий массив филдов |
Return:
| * |
Example:
// вернет плоский массив филдов fieldset'а
flatFields(fieldset, [])
public * flowDefaultModels(config: *): boolean source
import {flowDefaultModels} from 'n2o/src/sagas/pages.js'Сага для первоначальной установки моделей по умолчанию и подписка на изменения через канал
Params:
| Name | Type | Attribute | Description |
| config | * | конфиг для моделей по умолчанию |
public * forceUpdateDependency(state: *, widgetsDependencies: *, widgetId: *) source
import {forceUpdateDependency} from 'n2o/src/sagas/widgetDependency.js'Params:
| Name | Type | Attribute | Description |
| state | * | ||
| widgetsDependencies | * | ||
| widgetId | * |
public formatToFloat(val: *, precision: *): * source
import {formatToFloat} from 'n2o/src/components/controls/InputNumber/utils.js'Params:
| Name | Type | Attribute | Description |
| val | * | ||
| precision | * |
Return:
| * |
public formatToMask(format: *): * source
import {formatToMask} from 'n2o/src/components/controls/DatePicker/utils.js'Params:
| Name | Type | Attribute | Description |
| format | * |
Return:
| * |
public formsSelector(state: *): {} source
import {formsSelector} from 'n2o/src/selectors/formPlugin.js'селектор для редакс-форм
Params:
| Name | Type | Attribute | Description |
| state | * |
Return:
| {} |
public generateErrorMeta(msg: *): {"alert": *} source
import {generateErrorMeta} from 'n2o/src/utils/generateErrorMeta.js'Params:
| Name | Type | Attribute | Description |
| msg | * |
Return:
| {"alert": *} |
public generateFlatQuery(objectAim: *, Key: *, $Res: *, delimiter: *): String source
import {generateFlatQuery} from 'n2o/src/tools/helpers.js'Make "flat" query string from object Json and extends params
Params:
| Name | Type | Attribute | Description |
| objectAim | * | ||
| Key | * |
|
key id start |
| $Res | * |
|
extender result object |
| delimiter | * |
|
extender result object |
public generateKey(containerKey: *, columnId: *): string source
import {generateKey} from 'n2o/src/utils/id.js'Params:
| Name | Type | Attribute | Description |
| containerKey | * | ||
| columnId | * |
public generateParamQuery(objectAim: *, Key: *, $Res: *, delimiter: *): String source
import {generateParamQuery} from 'n2o/src/tools/helpers.js'Make "flat" query string from object Json and extends params with new paramize method
Params:
| Name | Type | Attribute | Description |
| objectAim | * | ||
| Key | * |
|
key id start |
| $Res | * |
|
extender result object |
| delimiter | * |
|
extender result object |
public generateSagas(dispatch: *, config: *): * source
import generateSagas from 'n2o/src/sagas.js'Params:
| Name | Type | Attribute | Description |
| dispatch | * | ||
| config | * |
Return:
| * |
public getAbsoluteHeight(el: *): * source
import {getAbsoluteHeight} from 'n2o/src/components/controls/DatePicker/utils.js'узнать высоту DOM-элемента
Params:
| Name | Type | Attribute | Description |
| el | * |
Return:
| * |
public getAbsoluteWidth(el: *): * source
import {getAbsoluteWidth} from 'n2o/src/components/controls/DatePicker/utils.js'узнать ширину DOM-элемента
Params:
| Name | Type | Attribute | Description |
| el | * |
Return:
| * |
public getAutoFocusId(fields: *): * source
import {getAutoFocusId} from 'n2o/src/components/widgets/Form/utils.js'Возвращает id первового поля, на котором может быть установлен автофокус
Params:
| Name | Type | Attribute | Description |
| fields | * |
Return:
| * |
public getCheckedStrategy(key: *): * source
import {getCheckedStrategy} from 'n2o/src/components/controls/InputSelectTree/until.js'Params:
| Name | Type | Attribute | Description |
| key | * |
Return:
| * |
public * getConfig(action: *) source
import {getConfig} from 'n2o/src/sagas/global.js'Сага для вызова настроек приложения
Params:
| Name | Type | Attribute | Description |
| action | * |
public getContainerButtons(containerKey: *) source
import {getContainerButtons} from 'n2o/src/selectors/toolbar.js'Params:
| Name | Type | Attribute | Description |
| containerKey | * |
public getContainerColumns(key: *) source
import {getContainerColumns} from 'n2o/src/selectors/columns.js'Params:
| Name | Type | Attribute | Description |
| key | * |
public getElementType(Component: function, props: object, getDefault: function): string | function source
import getElementType from 'n2o/src/tools/getElementType.js'Возвращает тип createElement() на основе props компонента. Полезно для расчета того, какой тип компонента должен отображаться.
public getFirstNotDisabledId(data: *, selected: *, disabled: *, valueFieldId: *): * source
import {getFirstNotDisabledId} from 'n2o/src/components/controls/InputSelect/utils.js'Params:
| Name | Type | Attribute | Description |
| data | * | ||
| selected | * | ||
| disabled | * | ||
| valueFieldId | * |
Return:
| * |
public getIndex(data: *, selectedId: *): * source
import {getIndex} from 'n2o/src/components/widgets/AdvancedTable/AdvancedTable.jsx'Params:
| Name | Type | Attribute | Description |
| data | * | ||
| selectedId | * |
Return:
| * |
public getIndex(datasource: *, selectedId: *): * source
import {getIndex} from 'n2o/src/components/widgets/Table/Table.jsx'Params:
| Name | Type | Attribute | Description |
| datasource | * | ||
| selectedId | * |
Return:
| * |
public getModelSelector(modelLink: *): * source
import {getModelSelector} from 'n2o/src/selectors/models.js'Селектор получения модели по линку
Params:
| Name | Type | Attribute | Description |
| modelLink | * |
Return:
| * |
public getModelsByDependency(dependency: *): * source
import {getModelsByDependency} from 'n2o/src/selectors/models.js'Params:
| Name | Type | Attribute | Description |
| dependency | * |
Return:
| * |
public getNextId(data: *, currentId: *, valueFieldId: *, selected: *, disabled: *) source
import {getNextId} from 'n2o/src/components/controls/InputSelect/utils.js'Params:
| Name | Type | Attribute | Description |
| data | * | ||
| currentId | * | ||
| valueFieldId | * | ||
| selected | * | ||
| disabled | * |
public getParams(mapping: *, state: *): * source
import {getParams} from 'n2o/src/utils/compileUrl.js'Params:
| Name | Type | Attribute | Description |
| mapping | * | ||
| state | * |
Return:
| * |
public getPathValue(object: *, path: *): * source
import {getPathValue} from 'n2o/src/tools/helpers.js'get value from sub-path object
Params:
| Name | Type | Attribute | Description |
| object | * | ||
| path | * |
Return:
| * |
public getPrecision(step: *): * source
import {getPrecision} from 'n2o/src/components/controls/InputNumber/utils.js'Params:
| Name | Type | Attribute | Description |
| step | * |
Return:
| * |
public getPrevId(data: *, currentId: *, valueFieldId: *, selected: *, disabled: *) source
import {getPrevId} from 'n2o/src/components/controls/InputSelect/utils.js'Params:
| Name | Type | Attribute | Description |
| data | * | ||
| currentId | * | ||
| valueFieldId | * | ||
| selected | * | ||
| disabled | * |
public getTimeout(alert: *, config: *): * source
import {getTimeout} from 'n2o/src/sagas/alerts.js'Params:
| Name | Type | Attribute | Description |
| alert | * | ||
| config | * |
Return:
| * |
public getTreeLinerRoute(data: *, expandedKeys: *, parentFieldId: *, valueFieldId: *): Array source
import {getTreeLinerRoute} from 'n2o/src/components/widgets/Tree/until.js'Вспомогогательная функция для клавиатуры Определяет путь по которому будет двигаться клавиатура возвращает массив из id
Params:
| Name | Type | Attribute | Description |
| data | * | ||
| expandedKeys | * | открытые ключи |
|
| parentFieldId | * | ||
| valueFieldId | * |
public getWidgetId(pageId: *, cntId: *): string source
import {getWidgetId} from 'n2o/src/tools/helpers.js'Возвращается widgetId на основе page и container
Params:
| Name | Type | Attribute | Description |
| pageId | * | ||
| cntId | * |
public getWithoutSelectedId(options: *, location: *, selectedId: *, prevSelectedId: *): * source
import {getWithoutSelectedId} from 'n2o/src/sagas/widgets.js'Params:
| Name | Type | Attribute | Description |
| options | * | ||
| location | * | ||
| selectedId | * | ||
| prevSelectedId | * |
Return:
| * |
public globalSelector(state: *) source
import {globalSelector} from 'n2o/src/selectors/global.js'Селектор глоабльных настроек
Params:
| Name | Type | Attribute | Description |
| state | * |
public groupData(data: *, field: *): * source
import groupData from 'n2o/src/utils/groupData.js'Params:
| Name | Type | Attribute | Description |
| data | * | ||
| field | * |
Return:
| * |
public groupData(data: *, groupFieldId: *) source
import {groupData} from 'n2o/src/components/controls/InputSelect/utils.js'Params:
| Name | Type | Attribute | Description |
| data | * | ||
| groupFieldId | * |
public * handleAction(action: *) source
import {handleAction} from 'n2o/src/sagas/actionsImpl.js'вызов экшена
Params:
| Name | Type | Attribute | Description |
| action | * |
public * handleAction(action: *) source
import {handleAction} from 'n2o/src/sagas/toolbar.js'Params:
| Name | Type | Attribute | Description |
| action | * |
public * handleFailInvoke(metaInvokeFail: *, widgetId: *, metaResponse: *) source
import {handleFailInvoke} from 'n2o/src/sagas/actionsImpl.js'Params:
| Name | Type | Attribute | Description |
| metaInvokeFail | * | ||
| widgetId | * | ||
| metaResponse | * |
public * handleFetch(widgetId: *, options: *, isQueryEqual: *, prevSelectedId: *) source
import {handleFetch} from 'n2o/src/sagas/widgets.js'Params:
| Name | Type | Attribute | Description |
| widgetId | * | ||
| options | * | ||
| isQueryEqual | * | ||
| prevSelectedId | * |
public * handleInvoke(action: *) source
import {handleInvoke} from 'n2o/src/sagas/actionsImpl.js'вызов экшена
Params:
| Name | Type | Attribute | Description |
| action | * |
public hasInsideMixMax(date: *, dateFormat: *, max: *, min: *): boolean source
import {hasInsideMixMax} from 'n2o/src/components/controls/DatePicker/utils.js'Функция проверки находится ли дата в промежутке max и min
Params:
| Name | Type | Attribute | Description |
| date | * | ||
| dateFormat | * | ||
| max | * | ||
| min | * |
public hideField(form: *, name: *): * source
import {hideField} from 'n2o/src/actions/formPlugin.js'экшен скрытия поля
Params:
| Name | Type | Attribute | Description |
| form | * | ||
| name | * |
Return:
| * |
public hideFields(form: *, names: *): * source
import {hideFields} from 'n2o/src/actions/formPlugin.js'экшен скрытия полей формы
Params:
| Name | Type | Attribute | Description |
| form | * | название формы |
|
| names | * | массив названия филдов формы |
Return:
| * |
public hideModal(name: *): * source
import {hideModal} from 'n2o/src/actions/modals.js'Скрыть модальное окно
Params:
| Name | Type | Attribute | Description |
| name | * |
Return:
| * |
public hidePrompt(name: *): * source
import {hidePrompt} from 'n2o/src/actions/modals.js'Скрыть подтверждение закрытия модального окна
Params:
| Name | Type | Attribute | Description |
| name | * |
Return:
| * |
public hideWidget(widgetId: *): * source
import {hideWidget} from 'n2o/src/actions/widgets.js'Сделать виджет невидимым
Params:
| Name | Type | Attribute | Description |
| widgetId | * | уникальный индефикатор виджета |
Return:
| * |
Example:
dispatch(hideWidget("Page.Widget"))
public hideWidgetFilters(widgetId: *): * source
import {hideWidgetFilters} from 'n2o/src/actions/widgets.js'Скрыть филтры виджета
Params:
| Name | Type | Attribute | Description |
| widgetId | * |
Return:
| * |
public hintPositionSelector(key: *, id: *) source
import {hintPositionSelector} from 'n2o/src/selectors/toolbar.js'селектор расположения посказаки кнопки
Params:
| Name | Type | Attribute | Description |
| key | * | ||
| id | * |
public hintSelector(key: *, id: *) source
import {hintSelector} from 'n2o/src/selectors/toolbar.js'селектор посказаки кнопки
Params:
| Name | Type | Attribute | Description |
| key | * | ||
| id | * |
public hotkeys(BaseComponent: *, config: object): * source
import {hotkeys} from 'n2o/src/tools/hotkeys.js'HOC компонент для настройки работы с клавиатурой. Важно! Component не должен быть в другой оберетке, требуется компонент в котором буду методы из config
Params:
| Name | Type | Attribute | Description |
| BaseComponent | * | компонент который надо обернуть и в котором находятся методы |
|
| config | object | мапа вида {KEY_CODE: METHOD_NAME} |
Return:
| * |
Example:
hotkeys(Component, confg)
public http_params_query(data: *): String source
import {http_params_query} from 'n2o/src/tools/helpers.js'new method conversion in url for query see {NNO-266}
Params:
| Name | Type | Attribute | Description |
| data | * |
public iconSelector(key: *) source
import {iconSelector} from 'n2o/src/selectors/toolbar.js'селектор иконки кнопки
Params:
| Name | Type | Attribute | Description |
| key | * |
public inArray(array: *[], item: {}): * source
import {inArray} from 'n2o/src/components/controls/InputSelect/utils.js'Params:
| Name | Type | Attribute | Description |
| array | *[] |
|
|
| item | {} |
|
Return:
| * |
public initUid(WrappedComponenet: *): * source
import {initUid} from 'n2o/src/components/widgets/Table/cells/ButtonsCell/until.js'Params:
| Name | Type | Attribute | Description |
| WrappedComponenet | * |
Return:
| * |
public insertModal(name: *, visible: *, title: *, size: *, closeButton: *, pageId: *, src: *): * source
import {insertModal} from 'n2o/src/actions/modals.js'Регистрация модального окна в редаксе
Params:
| Name | Type | Attribute | Description |
| name | * | ||
| visible | * | ||
| title | * | ||
| size | * | ||
| closeButton | * | ||
| pageId | * | ||
| src | * |
Return:
| * |
public integer(fieldId: *, values: *): boolean source
import {integer} from 'n2o/src/core/validation/presets.js'Валидация того, что integer
Params:
| Name | Type | Attribute | Description |
| fieldId | * | ||
| values | * |
public isDateFromNextMonth(date: *, displayedMonth: *): * source
import {isDateFromNextMonth} from 'n2o/src/components/controls/DatePicker/utils.js'Дата (date) была после конца месяца другой даты(displayedMonth) или нет
Params:
| Name | Type | Attribute | Description |
| date | * | ||
| displayedMonth | * |
Return:
| * |
public isDateFromPrevMonth(date: *, displayedMonth: *): * source
import {isDateFromPrevMonth} from 'n2o/src/components/controls/DatePicker/utils.js'Дата (date) была до начала месяца другой даты(displayedMonth) или нет
Params:
| Name | Type | Attribute | Description |
| date | * | ||
| displayedMonth | * |
Return:
| * |
public isDisabled(item: *, selected: *, disabled: *) source
import {isDisabled} from 'n2o/src/components/controls/InputSelect/utils.js'Params:
| Name | Type | Attribute | Description |
| item | * | ||
| selected | * | ||
| disabled | * |
public isDisabledSelector(key: *, id: *) source
import {isDisabledSelector} from 'n2o/src/selectors/toolbar.js'Params:
| Name | Type | Attribute | Description |
| key | * | ||
| id | * |
public isDisabledSelector(formName: *, fieldName: *) source
import {isDisabledSelector} from 'n2o/src/selectors/formPlugin.js'селектор для значения активности поля
Params:
| Name | Type | Attribute | Description |
| formName | * | ||
| fieldName | * |
public isDisabledSelector(key: *, id: *) source
import {isDisabledSelector} from 'n2o/src/selectors/columns.js'Params:
| Name | Type | Attribute | Description |
| key | * | ||
| id | * |
public isInitSelector(key: *, id: *) source
import {isInitSelector} from 'n2o/src/selectors/columns.js'Params:
| Name | Type | Attribute | Description |
| key | * | ||
| id | * |
public isInitSelector(formName: *, fieldName: *) source
import {isInitSelector} from 'n2o/src/selectors/formPlugin.js'селектор для свойства, отвечающего за инициализацию дополнительных свойств
Params:
| Name | Type | Attribute | Description |
| formName | * | ||
| fieldName | * |
public isInitSelector(key: *) source
import {isInitSelector} from 'n2o/src/selectors/toolbar.js'селектор для того, чтобы узнать зарегистрирована кнопка или нет
Params:
| Name | Type | Attribute | Description |
| key | * |
public isLoading(key: *) source
import {isLoading} from 'n2o/src/selectors/toolbar.js'селектор выполнения
Params:
| Name | Type | Attribute | Description |
| key | * |
public isOverflown(element: *): * source
import {isOverflown} from 'n2o/src/plugins/SideBar/utils.js'Params:
| Name | Type | Attribute | Description |
| element | * |
Return:
| * |
public isPromise(obj: *): boolean source
import {isPromise} from 'n2o/src/tools/helpers.js'Проверка является ли объект Promise
Params:
| Name | Type | Attribute | Description |
| obj | * |
public isValid(val: *, min: *, max: *): * source
import {isValid} from 'n2o/src/components/controls/InputNumber/utils.js'Params:
| Name | Type | Attribute | Description |
| val | * | ||
| min | * | ||
| max | * |
Return:
| * |
public isVisibleSelector(key: *, id: *) source
import {isVisibleSelector} from 'n2o/src/selectors/columns.js'Params:
| Name | Type | Attribute | Description |
| key | * | ||
| id | * |
public isVisibleSelector(formName: *, fieldName: *) source
import {isVisibleSelector} from 'n2o/src/selectors/formPlugin.js'селектор для значения видимости поля
Params:
| Name | Type | Attribute | Description |
| formName | * | ||
| fieldName | * |
public isVisibleSelector(key: *) source
import {isVisibleSelector} from 'n2o/src/selectors/toolbar.js'селектор видимости кнопки
Params:
| Name | Type | Attribute | Description |
| key | * |
public layoutPlaceResolver(LayoutComponent: *): * source
import layoutPlaceResolver from 'n2o/src/components/layouts/LayoutPlaceResolver.jsx'НОС парсит все children Section внутри какого-то Layout, содержимое которых будет расположено внутри Place
Params:
| Name | Type | Attribute | Description |
| LayoutComponent | * |
Return:
| * |
Example:
layoutPlaceResolver(StandardWidgetLayout)
public linkImpl(objectPattern: {"dispatch": *, "state": *, "target": *, "path": *, "pathMapping": *, "queryMapping": *}) source
import linkImpl from 'n2o/src/impl/actions/link/link.js'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"dispatch": *, "state": *, "target": *, "path": *, "pathMapping": *, "queryMapping": *} |
|
public linkResolver(state: *, link: *, value: *): * source
import linkResolver from 'n2o/src/utils/linkResolver.js'Получение значения по ссылке и выражению.
Params:
| Name | Type | Attribute | Description |
| state | * | ||
| link | * | ||
| value | * |
Return:
| * |
public listContainer(WrappedComponent: *): * source
import listContainer from 'n2o/src/components/controls/listContainer.js'Композер хоков {@Link withFetchData} & {@Link withListContainer}
Params:
| Name | Type | Attribute | Description |
| WrappedComponent | * | оборачиваемый компонент |
Return:
| * |
public loadingWidget(widgetId: *): * source
import {loadingWidget} from 'n2o/src/actions/widgets.js'Активировать анимацию загрузки у виджета
Params:
| Name | Type | Attribute | Description |
| widgetId | * | уникальный индефикатор виджета |
Return:
| * |
Example:
dispatch(loadingWidget("Page.Widget"))
public makeAlertByKeyAndIdSelector(key: *, id: *) source
import {makeAlertByKeyAndIdSelector} from 'n2o/src/selectors/alerts.js'Селектор алерта по ключу(widgetId) и id алерта
Params:
| Name | Type | Attribute | Description |
| key | * | ||
| id | * |
public makeAlertsByKeySelector(key: *) source
import {makeAlertsByKeySelector} from 'n2o/src/selectors/alerts.js'Селектор алертов по ключу(widgetId)
Params:
| Name | Type | Attribute | Description |
| key | * |
public makeFieldByName(formName: *, fieldName: *) source
import {makeFieldByName} from 'n2o/src/selectors/formPlugin.js'селктор для поля формы
Params:
| Name | Type | Attribute | Description |
| formName | * | ||
| fieldName | * |
public makeFormByName(name: *) source
import {makeFormByName} from 'n2o/src/selectors/formPlugin.js'селектор для конкретной формы
Params:
| Name | Type | Attribute | Description |
| name | * |
public makeGetFilterModelSelector(key: *) source
import {makeGetFilterModelSelector} from 'n2o/src/selectors/models.js'Селектор-генератор для получения filter модели
Params:
| Name | Type | Attribute | Description |
| key | * |
public makeGetModelByPrefixSelector(prefix: *, key: *) source
import {makeGetModelByPrefixSelector} from 'n2o/src/selectors/models.js'Селектор-генератор для получения конкретной модели
Params:
| Name | Type | Attribute | Description |
| prefix | * | ||
| key | * |
public makeGetResolveModelSelector(key: *) source
import {makeGetResolveModelSelector} from 'n2o/src/selectors/models.js'Селектор-генератор для получения resolve модели
Params:
| Name | Type | Attribute | Description |
| key | * |
public makeIsActiveSelector(widgetId: *) source
import {makeIsActiveSelector} from 'n2o/src/selectors/widgets.js'Params:
| Name | Type | Attribute | Description |
| widgetId | * |
public makeModalsbyName(i: *) source
import {makeModalsbyName} from 'n2o/src/selectors/modals.js'селектор модального окна по индексу
Params:
| Name | Type | Attribute | Description |
| i | * |
public makeModelsByPrefixSelector(prefix: *) source
import {makeModelsByPrefixSelector} from 'n2o/src/selectors/models.js'Селектор-генератор для получения списка моделей по префиксу
Params:
| Name | Type | Attribute | Description |
| prefix | * |
public makePageActionsByIdSelector(pageId: *) source
import {makePageActionsByIdSelector} from 'n2o/src/selectors/pages.js'Params:
| Name | Type | Attribute | Description |
| pageId | * |
public makePageByIdSelector(pageId: *) source
import {makePageByIdSelector} from 'n2o/src/selectors/pages.js'Селектор-генератор для получения страницы по ID
Params:
| Name | Type | Attribute | Description |
| pageId | * |
public makePageDisabledByIdSelector(pageId: *) source
import {makePageDisabledByIdSelector} from 'n2o/src/selectors/pages.js'Получение свойства disabled страницы по ее id
Params:
| Name | Type | Attribute | Description |
| pageId | * |
public makePageErrorByIdSelector(pageId: *) source
import {makePageErrorByIdSelector} from 'n2o/src/selectors/pages.js'Селектор-генератор для получения статуса ошибки по ID
Params:
| Name | Type | Attribute | Description |
| pageId | * |
public makePageLoadingByIdSelector(pageId: *) source
import {makePageLoadingByIdSelector} from 'n2o/src/selectors/pages.js'Селектор-генератор для получения статуса загрузки по ID
Params:
| Name | Type | Attribute | Description |
| pageId | * |
public makePageMetadataByIdSelector(pageId: *) source
import {makePageMetadataByIdSelector} from 'n2o/src/selectors/pages.js'Селектор-генератор для получения метеданных страницы по ID
Params:
| Name | Type | Attribute | Description |
| pageId | * |
public makePageRoutesByIdSelector(pageId: *) source
import {makePageRoutesByIdSelector} from 'n2o/src/selectors/pages.js'Селектор-генератор для получения статуса загрузки по ID
Params:
| Name | Type | Attribute | Description |
| pageId | * |
public makePageStatusByIdSelected(pageId: *) source
import {makePageStatusByIdSelected} from 'n2o/src/selectors/pages.js'Получение свойсва status страницы по ee d
Params:
| Name | Type | Attribute | Description |
| pageId | * |
public makePageTitleByIdSelector(pageId: *) source
import {makePageTitleByIdSelector} from 'n2o/src/selectors/pages.js'Params:
| Name | Type | Attribute | Description |
| pageId | * |
public makePageToolbarByIdSelector(pageId: *) source
import {makePageToolbarByIdSelector} from 'n2o/src/selectors/pages.js'Params:
| Name | Type | Attribute | Description |
| pageId | * |
public makePageWidgetsByIdSelector(pageId: *) source
import {makePageWidgetsByIdSelector} from 'n2o/src/selectors/pages.js'Селектор-генератор для получения виджетов страницы по ID
Params:
| Name | Type | Attribute | Description |
| pageId | * |
public makeSelectedIdSelector(widgetId: *) source
import {makeSelectedIdSelector} from 'n2o/src/selectors/widgets.js'Params:
| Name | Type | Attribute | Description |
| widgetId | * |
public makeShowPromptByName(name: *) source
import {makeShowPromptByName} from 'n2o/src/selectors/modals.js'Params:
| Name | Type | Attribute | Description |
| name | * |
public makeTypeSelector(widgetId: *) source
import {makeTypeSelector} from 'n2o/src/selectors/widgets.js'Params:
| Name | Type | Attribute | Description |
| widgetId | * |
public makeWidgetByIdSelector(widgetId: *): * source
import {makeWidgetByIdSelector} from 'n2o/src/selectors/widgets.js'Селектор-генератор для получения виджета по ID
Params:
| Name | Type | Attribute | Description |
| widgetId | * |
Return:
| * |
public makeWidgetCountSelector(widgetId: *) source
import {makeWidgetCountSelector} from 'n2o/src/selectors/widgets.js'Селектор-генератор для получения свойства виджета - count
Params:
| Name | Type | Attribute | Description |
| widgetId | * |
public makeWidgetDataProviderSelector(widgetId: *) source
import {makeWidgetDataProviderSelector} from 'n2o/src/selectors/widgets.js'Params:
| Name | Type | Attribute | Description |
| widgetId | * |
public makeWidgetEnabledSelector(widgetId: *) source
import {makeWidgetEnabledSelector} from 'n2o/src/selectors/widgets.js'Селектор-генератор для получения свойства виджета - isEnabled
Params:
| Name | Type | Attribute | Description |
| widgetId | * |
public makeWidgetFilterVisibilitySelector(widgetId: *) source
import {makeWidgetFilterVisibilitySelector} from 'n2o/src/selectors/widgets.js'Селектор-генератор для получения свойства виджета - isFilterVisible
Params:
| Name | Type | Attribute | Description |
| widgetId | * |
public makeWidgetIsInitSelector(widgetId: *) source
import {makeWidgetIsInitSelector} from 'n2o/src/selectors/widgets.js'Селектор-генератор для получения свойства виджета - isInit
Params:
| Name | Type | Attribute | Description |
| widgetId | * |
public makeWidgetLoadingSelector(widgetId: *) source
import {makeWidgetLoadingSelector} from 'n2o/src/selectors/widgets.js'Селектор-генератор для получения свойства виджета - isLoading
Params:
| Name | Type | Attribute | Description |
| widgetId | * |
public makeWidgetMetadataSelector(pageId: *, widgetId: *) source
import {makeWidgetMetadataSelector} from 'n2o/src/selectors/pages.js'Params:
| Name | Type | Attribute | Description |
| pageId | * | ||
| widgetId | * |
public makeWidgetPageIdSelector(widgetId: *) source
import {makeWidgetPageIdSelector} from 'n2o/src/selectors/widgets.js'Params:
| Name | Type | Attribute | Description |
| widgetId | * |
public makeWidgetPageSelector(widgetId: *) source
import {makeWidgetPageSelector} from 'n2o/src/selectors/widgets.js'Селектор-генератор для получения свойства виджета - page
Params:
| Name | Type | Attribute | Description |
| widgetId | * |
public makeWidgetSizeSelector(widgetId: *) source
import {makeWidgetSizeSelector} from 'n2o/src/selectors/widgets.js'Селектор-генератор для получения свойства виджета - size
Params:
| Name | Type | Attribute | Description |
| widgetId | * |
public makeWidgetSortingSelector(widgetId: *) source
import {makeWidgetSortingSelector} from 'n2o/src/selectors/widgets.js'Селектор-генератор для получения свойства виджета - sorting
Params:
| Name | Type | Attribute | Description |
| widgetId | * |
public makeWidgetValidationSelector(widgetId: *) source
import {makeWidgetValidationSelector} from 'n2o/src/selectors/widgets.js'Селектор-генератор для получения свойства виджета - sorting
Params:
| Name | Type | Attribute | Description |
| widgetId | * |
public makeWidgetVisibleSelector(widgetId: *) source
import {makeWidgetVisibleSelector} from 'n2o/src/selectors/widgets.js'Селектор-генератор для получения свойства виджета - isVisible
Params:
| Name | Type | Attribute | Description |
| widgetId | * |
public mapProp(prop: *): * source
import mapProp from 'n2o/src/utils/mapProp.js'Params:
| Name | Type | Attribute | Description |
| prop | * |
Return:
| * |
public mapToDefaultTime(val: *, defaultTime: *, defaultName: *): * source
import {mapToDefaultTime} from 'n2o/src/components/controls/DatePicker/utils.js'Установаить дефолтное время
Params:
| Name | Type | Attribute | Description |
| val | * | ||
| defaultTime | * | ||
| defaultName | * |
Return:
| * |
public mapToNum(count: *, callback: *, objectPattern2: {"increment": *, "start": *, "inclusive": *}): * source
import {mapToNum} from 'n2o/src/components/controls/Rating/utils.js'Params:
| Name | Type | Attribute | Description |
| count | * | ||
| callback | * | ||
| objectPattern2 | {"increment": *, "start": *, "inclusive": *} |
|
Return:
| * |
public mapToNumOrStr(count: *, callback: *) source
import {mapToNumOrStr} from 'n2o/src/components/snippets/Placeholder/utils.js'Params:
| Name | Type | Attribute | Description |
| count | * | ||
| callback | * |
public mapToValue(val: *, defaultTime: *, dateFormat: *, locale: *, defaultName: *): * source
import {mapToValue} from 'n2o/src/components/controls/DatePicker/utils.js'Привести по пропсам к нужному формату
Params:
| Name | Type | Attribute | Description |
| val | * | ||
| defaultTime | * | ||
| dateFormat | * | ||
| locale | * | ||
| defaultName | * |
Return:
| * |
public mapUrl(pageId: *): * source
import {mapUrl} from 'n2o/src/actions/pages.js'Params:
| Name | Type | Attribute | Description |
| pageId | * |
Return:
| * |
public match(fieldId: *, values: *, options: *): boolean source
import {match} from 'n2o/src/core/validation/presets.js'Соответствие поля значению из метаданных
Params:
| Name | Type | Attribute | Description |
| fieldId | * | ||
| values | * | ||
| options | * |
public matchesWhiteList(val: *): * source
import {matchesWhiteList} from 'n2o/src/components/controls/InputNumber/utils.js'Params:
| Name | Type | Attribute | Description |
| val | * |
Return:
| * |
public maxLength(fieldId: *, values: *, options: *): boolean source
import {maxLength} from 'n2o/src/core/validation/presets.js'Валиадация максимальной длины
Params:
| Name | Type | Attribute | Description |
| fieldId | * | ||
| values | * | ||
| options | * |
public messageSelector(formName: *, fieldName: *) source
import {messageSelector} from 'n2o/src/selectors/formPlugin.js'Params:
| Name | Type | Attribute | Description |
| formName | * | ||
| fieldName | * |
public * messagesFormEffect(objectPattern: {"meta": *}) source
import {messagesFormEffect} from 'n2o/src/sagas/meta.js'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"meta": *} |
|
public metadataRequest(pageId: *, rootPage: *, pageUrl: *, mapping: *): * source
import {metadataRequest} from 'n2o/src/actions/pages.js'Запрос за метаданными страницы
Params:
| Name | Type | Attribute | Description |
| pageId | * | id страницы |
|
| rootPage | * | признак модального окна |
|
| pageUrl | * | url с возможностью плейсхолдерами из mapping |
|
| mapping | * | маппинг для плейсхолдеров pageUrl |
Return:
| * |
Example:
dispatch(metadataRequest("Page"))
public minLength(fieldId: *, values: *, options: *): boolean source
import {minLength} from 'n2o/src/core/validation/presets.js'Валидация минимальной длины
Params:
| Name | Type | Attribute | Description |
| fieldId | * | ||
| values | * | ||
| options | * |
public modals(state: *[], action: *): * source
import modals from 'n2o/src/reducers/modals.js'Редюсер экшенов модалок
Params:
| Name | Type | Attribute | Description |
| state | *[] |
|
|
| action | * |
Return:
| * |
public modalsSelector(state: *): * source
import {modalsSelector} from 'n2o/src/selectors/modals.js'селектор модольных окон
Params:
| Name | Type | Attribute | Description |
| state | * |
Return:
| * |
public modelsSelector(state: *): * source
import {modelsSelector} from 'n2o/src/selectors/models.js'Базовый селектор всех моделей
Params:
| Name | Type | Attribute | Description |
| state | * |
Return:
| * |
public * modify(values: *, formName: *, fieldName: *, type: *, options: {}) source
import {modify} from 'n2o/src/sagas/fieldDependency.js'Params:
| Name | Type | Attribute | Description |
| values | * | ||
| formName | * | ||
| fieldName | * | ||
| type | * | ||
| options | {} |
|
public moveCursorToEnd(el: *) source
import {moveCursorToEnd} from 'n2o/src/components/snippets/Typography/utils.js'Params:
| Name | Type | Attribute | Description |
| el | * |
public observeStore(store: Object, select: Function, onChange: Function): * source
import observeStore from 'n2o/src/utils/observeStore.js'Утилита позволяющая подписываться на изменения хранилища через селектор. В случае изменения вызывается callback
Return:
| * |
Example:
class MyObserveExample extends React.Component {
...
componentDidMount() {
observeStore(this.context.store, (state) => state.dataList, (state) =>
this.setState({
data: state
})
);
}
...
}
MyObserveExample.contextTypes = {
store: PropTypes.object,
};
public omitDeep(collection: *, excludeKeys: *): * source
import {omitDeep} from 'n2o/src/tools/helpers.js'Глубокое удаление ключей
Params:
| Name | Type | Attribute | Description |
| collection | * | ||
| excludeKeys | * |
Return:
| * |
public pagesSelector(state: *): * source
import {pagesSelector} from 'n2o/src/selectors/pages.js'Базовый селектор всех страниц
Params:
| Name | Type | Attribute | Description |
| state | * |
Return:
| * |
public parseDate(value: *, dateFormat: *): * source
import {parseDate} from 'n2o/src/components/controls/DatePicker/utils.js'преобразовать дату к moment-объекту
Params:
| Name | Type | Attribute | Description |
| value | * | ||
| dateFormat | * |
Return:
| * |
public parseExpression(value: *): * source
import {parseExpression} from 'n2o/src/utils/evalExpression.js'Проверяет и возвращает значение, если это js выражение
Params:
| Name | Type | Attribute | Description |
| value | * |
Return:
| * |
public parseFormatter(data: *, typeAndformat: *): * source
import parseFormatter from 'n2o/src/utils/parseFormatter.js'Преобразует строку по формату Примеры форматов: format="date DD.MM.YYYY HH:mm" format="date DD.MM.YYYY" format="dateFromNow" format="password" format="number 0,0.00" format="number 0,0.00[000]"
Params:
| Name | Type | Attribute | Description |
| data | * | исходная строка |
|
| typeAndformat | * | строка с типом данных и форматом |
Return:
| * |
public parseToFloat(value: *) source
import {parseToFloat} from 'n2o/src/components/controls/Slider/utils.js'Params:
| Name | Type | Attribute | Description |
| value | * |
public parseToInt(value: *) source
import {parseToInt} from 'n2o/src/components/controls/Slider/utils.js'Params:
| Name | Type | Attribute | Description |
| value | * |
public performAction(objectPattern: {"dispatch": *, "type": *, "payload": *, "meta": *, "actionId": *}) source
import performAction from 'n2o/src/impl/actions/perform/perform.js'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"dispatch": *, "type": *, "payload": *, "meta": *, "actionId": *} |
|
public placementwithTooltip(component: *, hint: *, hintPosition: *, id: *): * source
import placementwithTooltip from 'n2o/src/utils/withTooltip.js'Если есть подсказка, возвращаем с тултипом
Params:
| Name | Type | Attribute | Description |
| component | * | ||
| hint | * | ||
| hintPosition | * | ||
| id | * |
Return:
| * |
public post(url: *, file: *, onProgress: *, onUpload: *, onError: *) source
import {post} from 'n2o/src/components/controls/FileUploader/utils.js'Params:
| Name | Type | Attribute | Description |
| url | * | ||
| file | * | ||
| onProgress | * | ||
| onUpload | * | ||
| onError | * |
public preFilterIsFunction(value: *): * source
import {preFilterIsFunction} from 'n2o/src/tools/helpers.js'get func from preFilter
Params:
| Name | Type | Attribute | Description |
| value | * |
Return:
| * |
public prepareButton(buttons: *, payload: *): * source
import {prepareButton} from 'n2o/src/sagas/toolbar.js'Params:
| Name | Type | Attribute | Description |
| buttons | * | ||
| payload | * |
Return:
| * |
public * prepareFetch(widgetId: *): IterableIterator<*> source
import {prepareFetch} from 'n2o/src/sagas/widgets.js'Подготовка данных
Params:
| Name | Type | Attribute | Description |
| widgetId | * |
Return:
| IterableIterator<*> |
public prepareStyle(vertical: *, style: *): * source
import {prepareStyle} from 'n2o/src/components/controls/Slider/utils.js'Кастомный стиль если vertical=true
Params:
| Name | Type | Attribute | Description |
| vertical | * | установлен ли вертикальный режим |
|
| style | * | стили для мерджа |
Return:
| * |
public prepareValue(currentValue: *, id: *, multiSelect: *): * source
import {prepareValue} from 'n2o/src/components/controls/Pills/utils.js'Функция для подготовки выбранных данных
Params:
| Name | Type | Attribute | Description |
| currentValue | * | текущее значение |
|
| id | * | новое значение |
|
| multiSelect | * | флаг множественного выбора |
Return:
| * |
public propsResolver(props: Object, data: Object): Object source
import propsResolver from 'n2o/src/utils/propsResolver.js'Функция преобразует шаблоные props свойства вида `name` в константные данные из контекста
Example:
const props = {
fio: "`surname+' '+name+' '+middleName`"
}
const model = {
surname: "Иванов",
name: "Иван",
middleName: "Иванович",
}
console.log(propsResolver(props, model))
//- {fio: "Иванов Иван Иванович"}
public * redirectEffect(action: *) source
import {redirectEffect} from 'n2o/src/sagas/meta.js'Params:
| Name | Type | Attribute | Description |
| action | * |
public reduceFunction(isTrue: *, objectPattern1: {"model": *, "config": *}): * source
import {reduceFunction} from 'n2o/src/sagas/widgetDependency.js'Params:
| Name | Type | Attribute | Description |
| isTrue | * | ||
| objectPattern1 | {"model": *, "config": *} |
|
Return:
| * |
public reducers(history: *, customReducers: {}) source
import reducers from 'n2o/src/reducers.js'Params:
| Name | Type | Attribute | Description |
| history | * | ||
| customReducers | {} |
|
public * refreshEffect(action: *) source
import {refreshEffect} from 'n2o/src/sagas/meta.js'Params:
| Name | Type | Attribute | Description |
| action | * |
public registerButton(key: *, id: *, size: *, title: *, count: *, icon: *, color: *, visible: *, disabled: *, hint: *, className: *, style: *): * source
import {registerButton} from 'n2o/src/actions/toolbar.js'Экшен регистрации кнопки в редаксе
Params:
| Name | Type | Attribute | Description |
| key | * | ||
| id | * | ||
| size | * | ||
| title | * | ||
| count | * | ||
| icon | * | ||
| color | * | ||
| visible | * | ||
| disabled | * | ||
| hint | * | ||
| className | * | ||
| style | * |
Return:
| * |
public registerColumn(widgetId: *, columnId: *, label: *, disabled: *, visible: *): * source
import {registerColumn} from 'n2o/src/actions/columns.js'Зарегистрировать колонку в редаксе
Params:
| Name | Type | Attribute | Description |
| widgetId | * | ||
| columnId | * | ||
| label | * | ||
| disabled | * | ||
| visible | * |
Return:
| * |
public registerDependency(widgetId: *, dependency: *): * source
import {registerDependency} from 'n2o/src/actions/dependency.js'Регистрация зависимости
Params:
| Name | Type | Attribute | Description |
| widgetId | * | ||
| dependency | * |
Return:
| * |
public registerFieldDependency(form: *, name: *, dependency: *): * source
import {registerFieldDependency} from 'n2o/src/actions/formPlugin.js'Зарегестрировать зависимости поля от других полей
Params:
| Name | Type | Attribute | Description |
| form | * | ||
| name | * | ||
| dependency | * |
Return:
| * |
public registerFieldExtra(form: *, name: *, initialState: *): * source
import {registerFieldExtra} from 'n2o/src/actions/formPlugin.js'регистрирование дополнительных свойств у поля формы
Params:
| Name | Type | Attribute | Description |
| form | * | ||
| name | * | ||
| initialState | * |
Return:
| * |
public registerWidget(widgetId: *, initProps: *): * source
import {registerWidget} from 'n2o/src/actions/widgets.js'Регистрация виджета в хранилище
Params:
| Name | Type | Attribute | Description |
| widgetId | * | уникальный индефикатор виджета |
|
| initProps | * | стартовые свойства |
Return:
| * |
Example:
dispatch(registerWidget("Page.Widget", {isVisible: false}))
public registerWidgetDependency(widgetsDependencies: *, widgetId: *, dependency: *): {} source
import {registerWidgetDependency} from 'n2o/src/sagas/widgetDependency.js'Добавляет в хранилище новопришедший виджет с его widgetId и dependency
Params:
| Name | Type | Attribute | Description |
| widgetsDependencies | * | ||
| widgetId | * | ||
| dependency | * |
Return:
| {} |
public removeAlert(key: *, id: *): * source
import {removeAlert} from 'n2o/src/actions/alerts.js'Удалить предупреждение
Params:
| Name | Type | Attribute | Description |
| key | * | ||
| id | * |
Return:
| * |
public * removeAlertSideEffect(action: *, alert: *, timeout: *) source
import {removeAlertSideEffect} from 'n2o/src/sagas/alerts.js'Params:
| Name | Type | Attribute | Description |
| action | * | ||
| alert | * | ||
| timeout | * |
public removeAlerts(key: *): * source
import {removeAlerts} from 'n2o/src/actions/alerts.js'Удалить все предупреждения по ключу
Params:
| Name | Type | Attribute | Description |
| key | * |
Return:
| * |
public removeAllModel(key: *): * source
import {removeAllModel} from 'n2o/src/actions/models.js'Удаление всех моделей из хранилища
Params:
| Name | Type | Attribute | Description |
| key | * | уникальный ключ |
Return:
| * |
Example:
dispatch(removeModel("datasource", "Page.Widget"))
public removeFieldMessage(form: *, name: *): * source
import {removeFieldMessage} from 'n2o/src/actions/formPlugin.js'Удалить сообщение поля
Params:
| Name | Type | Attribute | Description |
| form | * | ||
| name | * |
Return:
| * |
public * removeMessage(action: *) source
import {removeMessage} from 'n2o/src/sagas/formPlugin.js'Params:
| Name | Type | Attribute | Description |
| action | * |
public removeModel(prefix: *, key: *): * source
import {removeModel} from 'n2o/src/actions/models.js'Удаление модели из хранилища
Params:
| Name | Type | Attribute | Description |
| prefix | * | префикс модели |
|
| key | * | уникальный ключ |
Return:
| * |
Example:
dispatch(removeModel("datasource", "Page.Widget"))
public removeWidget(widgetId: *): * source
import {removeWidget} from 'n2o/src/actions/widgets.js'Удаляет виджет из хранилища
Params:
| Name | Type | Attribute | Description |
| widgetId | * | уникальный индефикатор виджета |
Return:
| * |
Example:
dispatch(removeWidget("Page.Widget"))
public renderIcon(icon: *, label: *, type: *, sidebarOpen: *, subItems: *): * source
import {renderIcon} from 'n2o/src/plugins/SideBar/SidebarItemContainer.js'Рендер иконки
Params:
| Name | Type | Attribute | Description |
| icon | * | иконка |
|
| label | * | текст итема |
|
| type | * | тип итема |
|
| sidebarOpen | * | флаг сжатия сайдбара |
|
| subItems | * |
Return:
| * |
public replaceDictionary(tmp: *): undefined[] source
import {replaceDictionary} from 'n2o/src/components/controls/DatePicker/utils.js'Params:
| Name | Type | Attribute | Description |
| tmp | * |
public request(url: string, options: object): object source
import request from 'n2o/src/utils/request.js'Обрабытываемый запрос по URL через fetch. Через этот метод запросы проверяются на ошибки и преобразуют response в json.
public requestConfig(params: *): * source
import {requestConfig} from 'n2o/src/actions/global.js'Запрос за базовой настройкой приложения
Params:
| Name | Type | Attribute | Description |
| params | * |
Return:
| * |
public requestConfigFail(error: *): * source
import {requestConfigFail} from 'n2o/src/actions/global.js'Ошибки при запросе за настройкой приложения
Params:
| Name | Type | Attribute | Description |
| error | * |
Return:
| * |
public requestConfigSuccess(config: *): * source
import {requestConfigSuccess} from 'n2o/src/actions/global.js'Успешный вызов настройки приложения
Params:
| Name | Type | Attribute | Description |
| config | * |
Return:
| * |
public required(fieldId: *, values: *, options: *): * source
import {required} from 'n2o/src/core/validation/presets.js'Валидация того, что поле непустое
Params:
| Name | Type | Attribute | Description |
| fieldId | * | ||
| values | * | ||
| options | * |
Return:
| * |
public requiredSelector(formName: *, fieldName: *) source
import {requiredSelector} from 'n2o/src/selectors/formPlugin.js'Params:
| Name | Type | Attribute | Description |
| formName | * | ||
| fieldName | * |
public resetPage(pageId: *): * source
import {resetPage} from 'n2o/src/actions/pages.js'сбросить состояние страницы в дефолтное положение
Params:
| Name | Type | Attribute | Description |
| pageId | * |
Return:
| * |
public resetWidgetState(widgetId: *): * source
import {resetWidgetState} from 'n2o/src/actions/widgets.js'Params:
| Name | Type | Attribute | Description |
| widgetId | * |
Return:
| * |
public resolve(code: *): * source
import {resolve} from 'n2o/src/utils/propsResolver.js'Params:
| Name | Type | Attribute | Description |
| code | * |
Return:
| * |
public * resolveAuth(objectPattern: {"authProvider": *, "redirectPath": *, "externalLoginUrl": *}, objectPattern1: {"type": *, "payload": *}) source
import {resolveAuth} from 'n2o/src/sagas/auth.js'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"authProvider": *, "redirectPath": *, "externalLoginUrl": *} |
|
|
| objectPattern1 | {"type": *, "payload": *} |
|
public * resolveButton(button: *, model: *) source
import {resolveButton} from 'n2o/src/sagas/toolbar.js'резолв всех условий
Params:
| Name | Type | Attribute | Description |
| button | * | ||
| model | * |
public resolveChange(state: *, payload: *, meta: *): any source
import {resolveChange} from 'n2o/src/reducers/formPlugin.js'Резолв изменения поля в redux form с учетом keepDirty
Params:
| Name | Type | Attribute | Description |
| state | * | ||
| payload | * | ||
| meta | * |
Return:
| any |
public resolveConditions(conditions: *, model: *): boolean source
import {resolveConditions} from 'n2o/src/sagas/toolbar.js'резолв кондишена кнопки
Params:
| Name | Type | Attribute | Description |
| conditions | * | ||
| model | * |
public * resolveDependency(dependencyType: *, widgetId: *, model: *, isVisible: *, prevIsVisible: *): IterableIterator<*|CallEffect> source
import {resolveDependency} from 'n2o/src/sagas/widgetDependency.js'Резолв конкретной зависимости по типу
Params:
| Name | Type | Attribute | Description |
| dependencyType | * | ||
| widgetId | * | ||
| model | * | ||
| isVisible | * | ||
| prevIsVisible | * |
Return:
| IterableIterator<*|CallEffect> |
public * resolveDependency(action: *) source
import {resolveDependency} from 'n2o/src/sagas/fieldDependency.js'Params:
| Name | Type | Attribute | Description |
| action | * |
public * resolveEnabledDependency(widgetId: *, model: *): IterableIterator<*> source
import {resolveEnabledDependency} from 'n2o/src/sagas/widgetDependency.js'Резолв активности
Params:
| Name | Type | Attribute | Description |
| widgetId | * | ||
| model | * |
Return:
| IterableIterator<*> |
public resolveExportTable(dispatch: *, state: *, widgetId: *) source
import resolveExportTable from 'n2o/src/impl/actions/exportTable/exportTable.js'Экшен экспорта таблицы
Params:
| Name | Type | Attribute | Description |
| dispatch | * | ||
| state | * | ||
| widgetId | * |
public * resolveFetchDependency(widgetId: *): IterableIterator<*> source
import {resolveFetchDependency} from 'n2o/src/sagas/widgetDependency.js'Резолв запросов
Params:
| Name | Type | Attribute | Description |
| widgetId | * |
Return:
| IterableIterator<*> |
public resolveLink(state: *, links: *): * source
import {resolveLink} from 'n2o/src/tools/global.link.js'FORMAT { PREFIX -> WidgetLink : FieldId }
Params:
| Name | Type | Attribute | Description |
| state | * | ||
| links | * |
Return:
| * |
public * resolveMapping(dataProvider: *, state: *): * source
import {resolveMapping} from 'n2o/src/sagas/actionsImpl.js'Params:
| Name | Type | Attribute | Description |
| dataProvider | * | ||
| state | * |
Return:
| * |
public resolveSelector(state: *): * source
import {resolveSelector} from 'n2o/src/selectors/models.js'Селектор получения resolve моделей
Params:
| Name | Type | Attribute | Description |
| state | * |
Return:
| * |
public * resolveUrl(state: *, dataProvider: *, widgetState: *, options: *): IterableIterator<*> source
import {resolveUrl} from 'n2o/src/sagas/widgets.js'Получение basePath и baseQuery
Params:
| Name | Type | Attribute | Description |
| state | * | ||
| dataProvider | * | ||
| widgetState | * | ||
| options | * |
Return:
| IterableIterator<*> |
public * resolveVisibleDependency(widgetId: *, model: *): IterableIterator<*> source
import {resolveVisibleDependency} from 'n2o/src/sagas/widgetDependency.js'Резолв видимости
Params:
| Name | Type | Attribute | Description |
| widgetId | * | ||
| model | * |
Return:
| IterableIterator<*> |
public resolveWidget(widgetId: *): * source
import {resolveWidget} from 'n2o/src/actions/widgets.js'Вызывает действие разрешения виджета. Side-effect: зависимости, простановка в resolve-модель
Params:
| Name | Type | Attribute | Description |
| widgetId | * | уникальный индефикатор виджета |
Return:
| * |
public * resolveWidgetDependency(prevState: *, state: *, widgetsDependencies: *): IterableIterator<*|CallEffect> source
import {resolveWidgetDependency} from 'n2o/src/sagas/widgetDependency.js'Резолв всех зависимостей виджета
Params:
| Name | Type | Attribute | Description |
| prevState | * | ||
| state | * | ||
| widgetsDependencies | * |
Return:
| IterableIterator<*|CallEffect> |
public routerSelector(state: *) source
import {routerSelector} from 'n2o/src/selectors/global.js'Селектор роутинга
Params:
| Name | Type | Attribute | Description |
| state | * |
public * routesQueryMapping(state: *, routes: *, location: *) source
import {routesQueryMapping} from 'n2o/src/sagas/widgets.js'Params:
| Name | Type | Attribute | Description |
| state | * | ||
| routes | * | ||
| location | * |
public * runResolve(action: *) source
import {runResolve} from 'n2o/src/sagas/widgets.js'Params:
| Name | Type | Attribute | Description |
| action | * |
public setActive(widgetId: *): * source
import {setActive} from 'n2o/src/actions/widgets.js'Params:
| Name | Type | Attribute | Description |
| widgetId | * |
Return:
| * |
public setButtonDisabled(key: *): * source
import {setButtonDisabled} from 'n2o/src/actions/toolbar.js'Экшен блокирования кнопки
Params:
| Name | Type | Attribute | Description |
| key | * |
Return:
| * |
public setButtonEnabled(key: *): * source
import {setButtonEnabled} from 'n2o/src/actions/toolbar.js'Экшен разблокирования кнопки
Params:
| Name | Type | Attribute | Description |
| key | * |
Return:
| * |
public setButtonHidden(key: *): * source
import {setButtonHidden} from 'n2o/src/actions/toolbar.js'Экшен скрытия кнопки
Params:
| Name | Type | Attribute | Description |
| key | * |
Return:
| * |
public setButtonVisible(key: *): * source
import {setButtonVisible} from 'n2o/src/actions/toolbar.js'Экшен показа кнопки
Params:
| Name | Type | Attribute | Description |
| key | * |
Return:
| * |
public setColumnHidden(widgetId: *, columnId: *): * source
import {setColumnHidden} from 'n2o/src/actions/columns.js'Скрыть колонку
Params:
| Name | Type | Attribute | Description |
| widgetId | * | ||
| columnId | * |
Return:
| * |
public setColumnVisible(widgetId: *, columnId: *): * source
import {setColumnVisible} from 'n2o/src/actions/columns.js'Сделать колонку видимой
Params:
| Name | Type | Attribute | Description |
| widgetId | * | ||
| columnId | * |
Return:
| * |
public setFilterValue(form: *, name: *, filter: *): * source
import {setFilterValue} from 'n2o/src/actions/formPlugin.js'Params:
| Name | Type | Attribute | Description |
| form | * | ||
| name | * | ||
| filter | * |
Return:
| * |
public setIn(object: *, path: *, value: *): Object source
import {setIn} from 'n2o/src/tools/helpers.js'Не мутабельный set
Params:
| Name | Type | Attribute | Description |
| object | * | ||
| path | * | ||
| value | * |
public setModel(prefix: *, key: *, model: *): * source
import {setModel} from 'n2o/src/actions/models.js'Установка значений модели по префиксу и ключу
Params:
| Name | Type | Attribute | Description |
| prefix | * | префикс модели |
|
| key | * | уникальный ключ |
|
| model | * | значения модели |
Return:
| * |
Example:
dispatch(setModel("datasource", "Page.Widget", {id: 1, name: "Test"}))
public * setParentVisibleIfAllChildChangeVisible(key: *, id: *) source
import {setParentVisibleIfAllChildChangeVisible} from 'n2o/src/sagas/toolbar.js'Функция для мониторинга изменения видимости родителя списка
Params:
| Name | Type | Attribute | Description |
| key | * | ||
| id | * |
public setRequired(form: *, name: *): * source
import {setRequired} from 'n2o/src/actions/formPlugin.js'установить флаг обазяательного поля
Params:
| Name | Type | Attribute | Description |
| form | * | ||
| name | * |
Return:
| * |
public setStatus(pageId: *, status: *): * source
import {setStatus} from 'n2o/src/actions/pages.js'Присвоить статус запроса метаданных страницы
Params:
| Name | Type | Attribute | Description |
| pageId | * | ||
| status | * |
Return:
| * |
public setTableSelectedId(widgetId: *, selectedId: *): * source
import {setTableSelectedId} from 'n2o/src/actions/widgets.js'Изменить выбранную запись в виджете
Params:
| Name | Type | Attribute | Description |
| widgetId | * | ||
| selectedId | * |
Return:
| * |
public setWatchDependency(state: *, props: *, dependencyType: *): * source
import {setWatchDependency} from 'n2o/src/components/widgets/Form/utils.js'Params:
| Name | Type | Attribute | Description |
| state | * | ||
| props | * | ||
| dependencyType | * |
Return:
| * |
public * setWidgetDataSuccess(widgetId: *, widgetState: *, basePath: *, baseQuery: *, currentDatasource: *) source
import {setWidgetDataSuccess} from 'n2o/src/sagas/widgets.js'Params:
| Name | Type | Attribute | Description |
| widgetId | * | ||
| widgetState | * | ||
| basePath | * | ||
| baseQuery | * | ||
| currentDatasource | * |
public setWidgetMetadata(pageId: *, widgetId: *, metadata: *): * source
import {setWidgetMetadata} from 'n2o/src/actions/widgets.js'Params:
| Name | Type | Attribute | Description |
| pageId | * | ||
| widgetId | * | ||
| metadata | * |
Return:
| * |
public showField(form: *, name: *): * source
import {showField} from 'n2o/src/actions/formPlugin.js'экшен показа поля
Params:
| Name | Type | Attribute | Description |
| form | * | ||
| name | * |
Return:
| * |
public showFields(form: *, names: *): * source
import {showFields} from 'n2o/src/actions/formPlugin.js'экшен показа полей формы
Params:
| Name | Type | Attribute | Description |
| form | * | название формы |
|
| names | * | массив названия филдов формы |
Return:
| * |
public showModal(name: *): * source
import {showModal} from 'n2o/src/actions/modals.js'Показать модальное окно
Params:
| Name | Type | Attribute | Description |
| name | * |
Return:
| * |
public showPrompt(name: *): * source
import {showPrompt} from 'n2o/src/actions/modals.js'Показать подтверждение закрытия модального окна
Params:
| Name | Type | Attribute | Description |
| name | * |
Return:
| * |
public showWidget(widgetId: *): * source
import {showWidget} from 'n2o/src/actions/widgets.js'Сделать виджет видимым
Params:
| Name | Type | Attribute | Description |
| widgetId | * | уникальный индефикатор виджета |
Return:
| * |
Example:
dispatch(showWidget("Page.Widget"))
public showWidgetFilters(widgetId: *): * source
import {showWidgetFilters} from 'n2o/src/actions/widgets.js'Показать фильтры виджета
Params:
| Name | Type | Attribute | Description |
| widgetId | * |
Return:
| * |
public singleDoubleClickFilter(singleCallback: *, doubleCallback: *, timeout: *): * source
import {singleDoubleClickFilter} from 'n2o/src/components/widgets/Tree/until.js'Params:
| Name | Type | Attribute | Description |
| singleCallback | * | ||
| doubleCallback | * | ||
| timeout | * |
Return:
| * |
public sizeSelector(key: *) source
import {sizeSelector} from 'n2o/src/selectors/toolbar.js'селектор пазмера кнопки
Params:
| Name | Type | Attribute | Description |
| key | * |
public sortDependency(dependency: *): * source
import {sortDependency} from 'n2o/src/sagas/widgetDependency.js'Params:
| Name | Type | Attribute | Description |
| dependency | * |
Return:
| * |
public splitSearchText(text: *, searchText: *, filter: *): * source
import {splitSearchText} from 'n2o/src/components/widgets/Tree/until.js'Params:
| Name | Type | Attribute | Description |
| text | * | ||
| searchText | * | ||
| filter | * |
Return:
| * |
public startInvoke(widgetId: *, dataProvider: *, data: *, modelLink: *, meta: {"refresh": boolean}): * source
import {startInvoke} from 'n2o/src/actions/actionImpl.js'Params:
| Name | Type | Attribute | Description |
| widgetId | * | ||
| dataProvider | * | ||
| data | * | ||
| modelLink | * | ||
| meta | {"refresh": boolean} |
|
Return:
| * |
public stringConverter(convertProps: *): function source
import {stringConverter} from 'n2o/src/components/controls/Slider/utils.js'HOC для преобразования заданных пропсов из строки в число
Params:
| Name | Type | Attribute | Description |
| convertProps | * | список свойств |
public styleSelector(key: *) source
import {styleSelector} from 'n2o/src/selectors/toolbar.js'селектор стиля кнопки
Params:
| Name | Type | Attribute | Description |
| key | * |
public syncModel(prefix: *, keys: *, model: *): * source
import {syncModel} from 'n2o/src/actions/models.js'Установка значений в несколько моделей
Params:
| Name | Type | Attribute | Description |
| prefix | * | префикс модели |
|
| keys | * | массив уникальных ключей |
|
| model | * | модель |
Return:
| * |
public takeKeysWhenSearching(props: *): *[] source
import {takeKeysWhenSearching} from 'n2o/src/components/widgets/Tree/until.js'Params:
| Name | Type | Attribute | Description |
| props | * |
Return:
| *[] |
public titleSelector(key: *) source
import {titleSelector} from 'n2o/src/selectors/toolbar.js'селектор имени кнопки
Params:
| Name | Type | Attribute | Description |
| key | * |
public toggleButtonDisabled(key: *): * source
import {toggleButtonDisabled} from 'n2o/src/actions/toolbar.js'Экшен изменнения свойства блокировки на противоположенное
Params:
| Name | Type | Attribute | Description |
| key | * |
Return:
| * |
public toggleButtonVisiblity(key: *): * source
import {toggleButtonVisiblity} from 'n2o/src/actions/toolbar.js'Экшен изменения видимости кнопки на противоположенное
Params:
| Name | Type | Attribute | Description |
| key | * |
Return:
| * |
public toggleColumnVisiblity(widgetId: *, columnId: *): * source
import {toggleColumnVisiblity} from 'n2o/src/actions/columns.js'Поменять видимость колонки на противоположенную
Params:
| Name | Type | Attribute | Description |
| widgetId | * | ||
| columnId | * |
Return:
| * |
public toggleWidgetFilters(widgetId: *): * source
import {toggleWidgetFilters} from 'n2o/src/actions/widgets.js'Изменить видимость фильтров виджета на противоположенную
Params:
| Name | Type | Attribute | Description |
| widgetId | * |
Return:
| * |
public toolbarSelector(state: *): * source
import {toolbarSelector} from 'n2o/src/selectors/toolbar.js'Params:
| Name | Type | Attribute | Description |
| state | * |
Return:
| * |
public treeToCollection(tree: *, parentFieldId: *, valueFieldId: *): * source
import {treeToCollection} from 'n2o/src/components/widgets/Tree/until.js'Создаем коллекцию из дерева tree -> [{ id: ..., parentId: ... }, ...]
Params:
| Name | Type | Attribute | Description |
| tree | * | ||
| parentFieldId | * | ||
| valueFieldId | * |
Return:
| * |
public unloadingWidget(widgetId: *): * source
import {unloadingWidget} from 'n2o/src/actions/widgets.js'Деактивировать анимацию загрузки у виджета
Params:
| Name | Type | Attribute | Description |
| widgetId | * | уникальный индефикатор виджета |
Return:
| * |
Example:
dispatch(unloadingWidget("Page.Widget"))
public unsetRequired(form: *, name: *): * source
import {unsetRequired} from 'n2o/src/actions/formPlugin.js'снять флаг обазяательного поля
Params:
| Name | Type | Attribute | Description |
| form | * | ||
| name | * |
Return:
| * |
public updateMapModel(prefix: *, key: *, field: *, value: *, map: *): * source
import {updateMapModel} from 'n2o/src/actions/models.js'обновление массива с маппингом
Params:
| Name | Type | Attribute | Description |
| prefix | * | ||
| key | * | ||
| field | * | ||
| value | * | ||
| map | * |
Return:
| * |
public updateModel(prefix: *, key: *, field: *, value: *): * source
import {updateModel} from 'n2o/src/actions/models.js'Обновление значения в модели
Params:
| Name | Type | Attribute | Description |
| prefix | * | префикс модели |
|
| key | * | уникальный ключ |
|
| field | * | поле которое нужно изменить |
|
| value | * | новое значение |
Return:
| * |
public updateWidgetDependency(widgetId: *): * source
import {updateWidgetDependency} from 'n2o/src/actions/dependency.js'Запуск зависимости
Params:
| Name | Type | Attribute | Description |
| widgetId | * |
Return:
| * |
public * updateWidgetDependencyEffect(objectPattern: {"meta": *}) source
import {updateWidgetDependencyEffect} from 'n2o/src/sagas/meta.js'Params:
| Name | Type | Attribute | Description |
| objectPattern | {"meta": *} |
|
public userCheck(payload: *): {"type": *, "payload": *, "meta": *} source
import {userCheck} from 'n2o/src/actions/auth.js'Params:
| Name | Type | Attribute | Description |
| payload | * |
Return:
| {"type": *, "payload": *, "meta": *} |
public userCheckError(payload: *): {"type": *, "payload": *, "meta": *} source
import {userCheckError} from 'n2o/src/actions/auth.js'Params:
| Name | Type | Attribute | Description |
| payload | * |
Return:
| {"type": *, "payload": *, "meta": *} |
public userCheckSuccess(payload: *): {"type": *, "payload": *, "meta": *} source
import {userCheckSuccess} from 'n2o/src/actions/auth.js'Params:
| Name | Type | Attribute | Description |
| payload | * |
Return:
| {"type": *, "payload": *, "meta": *} |
public userLogin(payload: *): {"type": *, "payload": *, "meta": *} source
import {userLogin} from 'n2o/src/actions/auth.js'Params:
| Name | Type | Attribute | Description |
| payload | * |
Return:
| {"type": *, "payload": *, "meta": *} |
public userLoginError(payload: *): {"type": *, "payload": *, "meta": *} source
import {userLoginError} from 'n2o/src/actions/auth.js'Params:
| Name | Type | Attribute | Description |
| payload | * |
Return:
| {"type": *, "payload": *, "meta": *} |
public userLoginSuccess(payload: *): {"type": *, "payload": *, "meta": *} source
import {userLoginSuccess} from 'n2o/src/actions/auth.js'Params:
| Name | Type | Attribute | Description |
| payload | * |
Return:
| {"type": *, "payload": *, "meta": *} |
public userLogout(payload: *): {"type": *, "payload": *, "meta": *} source
import {userLogout} from 'n2o/src/actions/auth.js'Params:
| Name | Type | Attribute | Description |
| payload | * |
Return:
| {"type": *, "payload": *, "meta": *} |
public userLogoutError(payload: *): {"type": *, "payload": *, "meta": *} source
import {userLogoutError} from 'n2o/src/actions/auth.js'Params:
| Name | Type | Attribute | Description |
| payload | * |
Return:
| {"type": *, "payload": *, "meta": *} |
public userLogoutSuccess(payload: *): {"type": *, "payload": *, "meta": *} source
import {userLogoutSuccess} from 'n2o/src/actions/auth.js'Params:
| Name | Type | Attribute | Description |
| payload | * |
Return:
| {"type": *, "payload": *, "meta": *} |
public * validate(options: *): * source
import {validate} from 'n2o/src/sagas/actionsImpl.js'Params:
| Name | Type | Attribute | Description |
| options | * |
Return:
| * |
public validateField(validationConfig: *, formName: *, state: *, isTouched: *): Promise<any[]> source
import {validateField} from 'n2o/src/core/validation/createValidator.js'функция валидации
Params:
| Name | Type | Attribute | Description |
| validationConfig | * | ||
| formName | * | ||
| state | * | ||
| isTouched | * |
public visiblePartPopup(item: *, objectPattern1: {"prefixCls": *, "iconFieldId": *, "imageFieldId": *, "labelFieldId": *, "badgeFieldId": *, "badgeColorFieldId": *}) source
import {visiblePartPopup} from 'n2o/src/components/controls/InputSelectTree/until.js'Params:
| Name | Type | Attribute | Description |
| item | * | ||
| objectPattern1 | {"prefixCls": *, "iconFieldId": *, "imageFieldId": *, "labelFieldId": *, "badgeFieldId": *, "badgeColorFieldId": *} |
|
public * watchDependency(): IterableIterator<*> source
import {watchDependency} from 'n2o/src/sagas/widgetDependency.js'Наблюдение за регистрацией зависимостей виджетов и изменением модели
Return:
| IterableIterator<*> |
public * watchModel(buttons: *, objectPattern1: {"payload": *}) source
import {watchModel} from 'n2o/src/sagas/toolbar.js'Params:
| Name | Type | Attribute | Description |
| buttons | * | ||
| objectPattern1 | {"payload": *} |
|
public * watcherDefaultModels(config: *) source
import {watcherDefaultModels} from 'n2o/src/sagas/pages.js'Для закрытия канала используем race c экшеном сброса (обнуление) метаданных страницы
Params:
| Name | Type | Attribute | Description |
| config | * | конфиг для моделей по умолчанию, который прокидывается в сагу |
public weeks(firstDay: *): * source
import {weeks} from 'n2o/src/components/controls/DatePicker/utils.js'Возвращает массив из недель(каждая неделя - массив из дней)
Params:
| Name | Type | Attribute | Description |
| firstDay | * |
Return:
| * |
public widgetSelector(state: *, props: *): * source
import {widgetSelector} from 'n2o/src/components/widgets/selectors.js'селектор всего виджета
Params:
| Name | Type | Attribute | Description |
| state | * | ||
| props | * |
Return:
| * |
public widgetsSelector(state: *): * source
import {widgetsSelector} from 'n2o/src/selectors/widgets.js'Базовый селектор всех виджетов
Params:
| Name | Type | Attribute | Description |
| state | * |
Return:
| * |
public withActions(Component: *): * source
import withActions from 'n2o/src/components/core/withActions.js'Params:
| Name | Type | Attribute | Description |
| Component | * |
Return:
| * |
public withActionsEditableCell(EditableCell: *): * source
import withActionsEditableCell from 'n2o/src/components/widgets/Table/cells/EditableCell/withActionsEditableCell.js'Params:
| Name | Type | Attribute | Description |
| EditableCell | * |
Return:
| * |
public withAdvancedTableRef(Component: *): * source
import withAdvancedTableRef from 'n2o/src/components/widgets/AdvancedTable/withAdvancedTableRef.js'Params:
| Name | Type | Attribute | Description |
| Component | * |
Return:
| * |
public withCell(WrappedComponent: *): * source
import withCell from 'n2o/src/components/widgets/Table/withCell.js'HOC для оборачивания Cell Переопределяет свойство onClick в компонентах для посылки экшена
Params:
| Name | Type | Attribute | Description |
| WrappedComponent | * |
Return:
| * |
public withColumn(WrappedComponent: *): * source
import withColumn from 'n2o/src/components/widgets/Table/withColumn.js'колонка-контейнер
Params:
| Name | Type | Attribute | Description |
| WrappedComponent | * |
Return:
| * |
public withDependency(handleEventConfig: *): * source
import withDependency from 'n2o/src/core/dependencies/withDependency.js'Params:
| Name | Type | Attribute | Description |
| handleEventConfig | * |
Return:
| * |
public withFetchData(WrappedComponent: *, apiCaller: *): * source
import withFetchData from 'n2o/src/components/controls/withFetchData.js'HOC для работы с данными
Params:
| Name | Type | Attribute | Description |
| WrappedComponent | * | оборачиваемый компонент |
|
| apiCaller | * | promise для вызова апи |
Return:
| * |
public withFieldContainer(Field: *): * source
import withFieldContainer from 'n2o/src/components/widgets/Form/fields/withFieldContainer.js'HOC обертка для полей, в которой содержится мэппинг свойств редакса и регистрация дополнительных свойств полей
Params:
| Name | Type | Attribute | Description |
| Field | * |
Return:
| * |
public withGetWidget(WrappedComponent: *): * source
import withGetWidget from 'n2o/src/components/regions/withWidgetProps.js'HOC для работы с данными
Params:
| Name | Type | Attribute | Description |
| WrappedComponent | * | оборачиваемый компонент |
Return:
| * |
public withListContainer(WrappedComponent: *): * source
import withListContainer from 'n2o/src/components/controls/withListContainer.js'HOC для контейнеров {@Link InputSelectContainer} и {@Link N2OSelectContainer}
Params:
| Name | Type | Attribute | Description |
| WrappedComponent | * | оборачиваемый компонент |
Return:
| * |
public withLocale(date: *, locale: *): * source
import {withLocale} from 'n2o/src/components/controls/DatePicker/utils.js'добавть локаль
Params:
| Name | Type | Attribute | Description |
| date | * | ||
| locale | * |
Return:
| * |
public withObserveDependency(config: *): * source
import withObserveDependency from 'n2o/src/core/dependencies/withObserveDependency.js'Params:
| Name | Type | Attribute | Description |
| config | * |
Return:
| * |
public withRegisterDependency(Component: *): * source
import withRegisterDependency from 'n2o/src/core/dependencies/withRegisterDependency.js'Params:
| Name | Type | Attribute | Description |
| Component | * |
Return:
| * |
public withSecurity(WrappedComponent: *): * source
import withSecurity from 'n2o/src/core/auth/withSecurity.js'Params:
| Name | Type | Attribute | Description |
| WrappedComponent | * |
Return:
| * |