@steroidsjs/core 2.3.0-beta.7 → 3.0.0-beta.10

package/ui/form/Button/Button.d.ts

@@ -1,191 +1,188 @@
-import * as React from 'react';
-interface IButtonBadge {
-    enable?: boolean;
-    value?: number;
-    color?: ColorName;
-    className?: CssClassName;
-}
-/**
- * Button
- * Кнопка или ссылка. Используется в интерфейсе для выполнения какого-либо действия по клику (onClick),
- * смена страницы в рамках роутинга (goToRoute), переход по внешней ссылке (url) или отправки формы (submit form)
- */
-export interface IButtonProps {
-    /**
-     * Текст кнопки или ссылки
-     * @example Save
-     */
-    label?: string | any;
-    /**
-     * Подсказка, отображается при наведении (через тег title)
-     * @example Save
-     */
-    hint?: string | any;
-    /**
-     * Должна ли показываться надпись на кнопке в состоянии загрузки
-     * @example true
-     */
-    showLabelOnLoading?: boolean;
-    /**
-     * HTML Тип
-     * @example submit
-     */
-    type?: 'button' | 'submit';
-    /**
-     * Цвет состояния
-     * @example success
-     */
-    color?: ColorName;
-    /**
-     * Отображать как ссылку?
-     * @example true
-     */
-    link?: boolean;
-    /**
-     * Иконка
-     */
-    icon?: string;
-    /**
-     * Цифра (к примеру, новые сообщения)
-     */
-    badge?: number | IButtonBadge;
-    /**
-     * Отображать индикатор загрузки?
-     * @example true
-     */
-    isLoading?: boolean;
-    /**
-     * Отобразить кнопку в состоянии неуспешного нажатия (например, при неуспешном ajax запросе)
-     * @example true
-     */
-    isFailed?: boolean;
-    /**
-     * Через сколько миллисекунд должно исчезнуть состояние "failed"
-     * @example 5000
-     */
-    resetFailedMs?: number;
-    /**
-     * Включает стиль `outline`, когда у кнопки остается только `border`, а цвет кнопки становится прозрачным
-     * @example true
-     */
-    outline?: boolean;
-    /**
-     * HTML аттрибут `target`, доступен только для ссылок
-     * @example _blank
-     */
-    target?: string;
-    /**
-     * Ссылка на внешнюю страницу, используется совместно с свойством `link`
-     * @example https://ya.ru
-     */
-    url?: string;
-    /**
-     * При указании данного свойства, после нажатия на кнопку и до выполнения действия будет отображено нативное
-     * окно с текстом подтверждения - `window.confirm('Ваш текст')`.
-     * @example Удалить запись #512?
-     */
-    confirm?: string;
-    /**
-     * Обработчик события нажатия. Для асинхронных событий вовзращяйте в обработчике `Promise`, тогда кнопка
-     * автоматически будет переключаться в режим загрузки (`loading`) на время выполнения `Promise`.
-     * @param e => fetch(...)
-     */
-    onClick?: (e: Event | React.MouseEvent) => Promise<any> | any;
-    /**
-     * Переводит кнопку в состояние "не активна"
-     * @example true
-     */
-    disabled?: boolean;
-    /**
-     * Включает стиль `block`, делая размер кнопки на 100% ширины блока
-     * @example true
-     */
-    block?: boolean;
-    /**
-     * Объект CSS стилей
-     * @example {width: '45%'}
-     */
-    style?: any;
-    /**
-     * Дополнительный CSS-класс для кнопки или ссылки
-     */
-    className?: CssClassName;
-    /**
-     * Переопределение view React компонента для кастомизации отображения
-     * @example MyCustomView
-     */
-    view?: React.ComponentType;
-    /**
-     * ID роута, на который необходимо перейти, указанный в дереве `steroids` роутинга. Для передачи параметров
-     * используйте свойство `toRouteParams`
-     * @example profile
-     */
-    toRoute?: string;
-    /**
-     * Параметры роута, на который необходимо перейти, см. свойство `toRoute`.
-     * @example {userId: 52}
-     */
-    toRouteParams?: Record<string, unknown>;
-    /**
-     * Выбор макета для распложения кнопки в форме. Если кнопка находится внутри `<Form>...</Form>`, то `layout` будет
-     * взят из контекста формы и автоматически применен при отораженн. Для его отключения укажите `false`.
-     * Данное свойство так же может принимать объект, если нужно прокинуть дополнительные свойства в шаблон макета.
-     * Пример: `{layout: 'horizontal', cols: [2,6]}`
-     * @example horizontal
-     */
-    layout?: FormLayout;
-    /**
-     * ID формы, для которой кнопка выполняет submit. При указании ID формы кнопка будет показывать состояние загрузки
-     * при отправке формы.
-     */
-    formId?: string | boolean;
-    /**
-     * Выбор html-тэга, который будет вставлен в DOM
-     * @example button
-     */
-    tag?: 'button' | 'a';
-    /**
-     * Размер
-     */
-    size?: Size;
-    /**
-     * Темная тема
-     */
-    dark?: boolean;
-    /**
-     * Цвет текста кнопки или ссылки
-     */
-    textColor?: any;
-    [key: string]: any;
-}
-export interface IButtonViewProps extends IButtonProps {
-    badge?: IButtonBadge;
-    url?: string;
-    formId?: string;
-    layout?: string;
-    disabled?: boolean;
-    onClick?: any;
-    submitting?: boolean;
-    showLabelOnLoading: boolean;
-}
-declare function Button(props: IButtonProps): JSX.Element;
-declare namespace Button {
-    var defaultProps: {
-        type: string;
-        color: string;
-        outline: boolean;
-        disabled: boolean;
-        submitting: boolean;
-        block: boolean;
-        size: string;
-        className: string;
-        resetFailedMs: number;
-        showLabelOnLoading: boolean;
-        badge: {
-            enable: boolean;
-            value: number;
-            color: string;
-        };
-    };
-}
-export default Button;
+import * as React from 'react';
+interface IButtonBadge {
+    enable?: boolean;
+    value?: number;
+    color?: ColorName;
+    className?: CssClassName;
+}
+/**
+ * Button
+ * Кнопка или ссылка. Используется в интерфейсе для выполнения какого-либо действия по клику (onClick),
+ * смена страницы в рамках роутинга (goToRoute), переход по внешней ссылке (url) или отправки формы (submit form)
+ */
+export interface IButtonProps {
+    /**
+     * Текст кнопки или ссылки
+     * @example Save
+     */
+    label?: string | any;
+    /**
+     * Подсказка, отображается при наведении (через тег title)
+     * @example Save
+     */
+    hint?: string | any;
+    /**
+     * HTML Тип
+     * @example submit
+     */
+    type?: 'button' | 'submit';
+    /**
+     * Цвет состояния
+     * @example success
+     */
+    color?: ColorName;
+    /**
+     * Отображать как ссылку?
+     * @example true
+     */
+    link?: boolean;
+    /**
+     * Иконка
+     */
+    icon?: string;
+    /**
+     * Цифра (к примеру, новые сообщения)
+     */
+    badge?: number | IButtonBadge;
+    /**
+     * Отображать индикатор загрузки?
+     * @example true
+     */
+    isLoading?: boolean;
+    /**
+     * Отобразить кнопку в состоянии неуспешного нажатия (например, при неуспешном ajax запросе)
+     * @example true
+     */
+    isFailed?: boolean;
+    /**
+     * Через сколько миллисекунд должно исчезнуть состояние "failed"
+     * @example 5000
+     */
+    resetFailedMs?: number;
+    /**
+     * Включает стиль `outline`, когда у кнопки остается только `border`, а цвет кнопки становится прозрачным
+     * @example true
+     */
+    outline?: boolean;
+    /**
+     * HTML аттрибут `target`, доступен только для ссылок
+     * @example _blank
+     */
+    target?: string;
+    /**
+     * Ссылка на внешнюю страницу, используется совместно с свойством `link`
+     * @example https://ya.ru
+     */
+    url?: string;
+    /**
+     * При указании данного свойства, после нажатия на кнопку и до выполнения действия будет отображено нативное
+     * окно с текстом подтверждения - `window.confirm('Ваш текст')`.
+     * @example Удалить запись #512?
+     */
+    confirm?: string;
+    /**
+     * Обработчик события нажатия. Для асинхронных событий вовзращяйте в обработчике `Promise`, тогда кнопка
+     * автоматически будет переключаться в режим загрузки (`loading`) на время выполнения `Promise`.
+     * @param e => fetch(...)
+     */
+    onClick?: (e: Event | React.MouseEvent) => Promise<any> | any;
+    /**
+     * Переводит кнопку в состояние "не активна"
+     * @example true
+     */
+    disabled?: boolean;
+    /**
+     * Включает стиль `block`, делая размер кнопки на 100% ширины блока
+     * @example true
+     */
+    block?: boolean;
+    /**
+     * Объект CSS стилей
+     * @example {width: '45%'}
+     */
+    style?: any;
+    /**
+     * Дополнительный CSS-класс для кнопки или ссылки
+     */
+    className?: CssClassName;
+    /**
+     * Переопределение view React компонента для кастомизации отображения
+     * @example MyCustomView
+     */
+    view?: React.ComponentType;
+    /**
+     * Вложенные элементы
+     */
+    children?: string | any;
+    /**
+     * ID роута, на который необходимо перейти, указанный в дереве `steroids` роутинга. Для передачи параметров
+     * используйте свойство `toRouteParams`
+     * @example profile
+     */
+    toRoute?: string;
+    /**
+     * Параметры роута, на который необходимо перейти, см. свойство `toRoute`.
+     * @example {userId: 52}
+     */
+    toRouteParams?: Record<string, unknown>;
+    /**
+     * Выбор макета для распложения кнопки в форме. Если кнопка находится внутри `<Form>...</Form>`, то `layout` будет
+     * взят из контекста формы и автоматически применен при отораженн. Для его отключения укажите `false`.
+     * Данное свойство так же может принимать объект, если нужно прокинуть дополнительные свойства в шаблон макета.
+     * Пример: `{layout: 'horizontal', cols: [2,6]}`
+     * @example horizontal
+     */
+    layout?: FormLayout;
+    /**
+     * ID формы, для которой кнопка выполняет submit. При указании ID формы кнопка будет показывать состояние загрузки
+     * при отправке формы.
+     */
+    formId?: string | boolean;
+    /**
+     * Выбор html-тэга, который будет вставлен в DOM
+     * @example button
+     */
+    tag?: 'button' | 'a';
+    /**
+     * Размер
+     */
+    size?: Size;
+    /**
+     * Темная тема
+     */
+    dark?: boolean;
+    /**
+     * Цвет текста кнопки или ссылки
+     */
+    textColor?: any;
+    [key: string]: any;
+}
+export interface IButtonViewProps extends IButtonProps {
+    badge?: IButtonBadge;
+    url?: string;
+    formId?: string;
+    layout?: string;
+    disabled?: boolean;
+    onClick?: any;
+    submitting?: boolean;
+}
+declare function Button(props: IButtonProps): JSX.Element;
+declare namespace Button {
+    var defaultProps: {
+        type: string;
+        color: string;
+        outline: boolean;
+        disabled: boolean;
+        submitting: boolean;
+        block: boolean;
+        size: string;
+        className: string;
+        resetFailedMs: number;
+        badge: {
+            enable: boolean;
+            value: number;
+            color: string;
+        };
+    };
+}
+export default Button;