@skbkontur/react-ui 1.6.10 → 1.6.11

package/README.md

@@ -1,135 +1,135 @@
-# React UI
-
-[![Build Status](https://tc.skbkontur.ru/app/rest/builds/buildType:FrontendInfrastructure_Packages_RunAll/statusIcon)](https://tc.skbkontur.ru/project.html?projectId=FrontendInfrastructure_Packages_ReactUI&tab=projectOverview)
-
-- [Варианты использования](#Варианты-использования)
-  - [Квик-старт](#Квик-старт) **@skbkontur/react-ui** собранная версия библиотеки
-  - [Слоу-старт](#Слоу-старт) **retail-ui** исходники для самостоятельной сборки, для переопределения `.less`-переменных
-- [FAQ](#FAQ)
-
-## <a name="Варианты-использования"></a>Варианты использования
-
-### <a name="Квик-старт"></a>Квик-старт
-
-```bash
-yarn add @skbkontur/react-ui
-```
-
-И используем компонентики у себя в проекте:
-
-```jsx static
-import Button from '@skbkontur/react-ui/Button';
-import Toast from '@skbkontur/react-ui/Toast';
-
-const MyApp = () => (
-  <div>
-    Click this button <Button onClick={() => Toast.push('Hey!')}>Click me</Button>
-  </div>
-);
-```
-
-Если ругается, что `regeneratorRuntime` не определен, то необходимо подключить `regenerator-runtime` или `@babel/polyfill`, например в `index.html`
-
-Квик-старт подойдёт, если Вебпак настроен на сборку. Например, вы используете `create-react-app`. В противном случае добавьте в конфиг Вебпака `style-`, `css-` и `file-loader`
-
-### <a name="Слоу-старт"></a>Слоу-старт
-
-```bash
-yarn add retail-ui
-```
-
-Необходимо установить как зависимости и добавить в [конфиг Вебпака](https://webpack.js.org/configuration/) следующие лоадеры:
-
-```js static
-module: {
-  rules: [
-    {
-      test: /\.jsx?$/,
-      use: [
-        {
-          loader: 'babel-loader',
-          options: {
-            presets: ['@babel/preset-env', '@babel/preset-react', '@babel/preset-flow'],
-            plugins: ['@babel/plugin-proposal-class-properties', '@babel/plugin-proposal-object-rest-spread'],
-          },
-        },
-      ],
-      include: /retail-ui/,
-    },
-    {
-      test: /\.less$/,
-      use: [
-        'style-loader',
-        {
-          loader: 'css-loader',
-          options: { modules: 'global' },
-        },
-        'less-loader',
-      ],
-    },
-    {
-      test: /\.(png|woff|woff2|eot)$/,
-      use: ['file-loader'],
-    },
-  ];
-}
-```
-
-### Хотим другой цвет кнопки!
-
-Тут придется юзать слоу-старт. В конфиге нужно указать:
-
-```js static
-resolve: {
-  alias: {
-    'react-ui-theme': path.join(__dirname, 'path-to-my-theme-variables.less')
-  }
-}
-```
-
-Список переменных можно глянуть в `components/variables.less`
-
-### Глобальные css-стили приложения портят внешний вид контролов
-
-Если библиотека используется в проекте с легаси, где стилизация сделана прямо по названиям тегов, то внешний вид контролов из библиотеки может сильно испортиться
-
-Если нет возможности разобрать легаси, то можно увеличить специфичность селекторов в библиотеке, тогда стили контролов будут приоритетнее стилей из легаси проекта
-
-Специфичность достигается за счет n-кратного повторения css-класса `react-ui` в селекторе стилей. Количество повторений задается через переменную `@specificity-level`, значение по умолчанию равно нулю, то есть по умолчанию css-класс `react-ui` никак ни на что не будет влиять
-
-Чтобы специфичность заработала в легаси проекте, react-блок, в котором используются компоненты из библиотеки, должен быть обернут в тег с css-классом `react-ui`
-
-Пример настройки специфичности
-
-```less
-/* ... */
-@specificity-level: 5;
-/* ... */
-```
-
-## <a name="FAQ"></a>FAQ
-
-### Сломались стили при использовании css-loader 2.x (create-react-app/CRA 3.x)
-
-Во [2-й версии](https://github.com/webpack-contrib/css-loader/releases/tag/v2.0.0), `css-loader` отключили использование `css-modules` по умолчанию.
-**Решение**: В опциях к `css-loader` явно задать `modules: 'global'`.
-
-### Как использовать retail-ui с storybook 5.x?
-
-В 5-й версии изменилось [API сторибука для кастомизации настроек webpack](https://github.com/storybooks/storybook/blob/v5.0.0/MIGRATION.md#webpack-config-simplifcation).
-Кроме того был изменен дефолтный webpack конфиг. Это порождает проблемы вида [storybooks/storybook#4891](https://github.com/storybooks/storybook/issues/4891).
-**Решение**: Заменить лоадеры для `css/less`. Например [так](https://github.com/storybooks/storybook/issues/6319#issuecomment-477852640) на свои
-
-### Возникает ошибка `Error: Can't resolve 'mask-char-font/font.eot'`
-
-Ошибка проявляется при использовании `css-loader@1.x` с выставленой опцией `modules`.
-**Решение**: Обновить `css-loader` до 2-й версии или дополнительно указать опцию `url: false`
-
-### Не могу прокинуть css-класс компонентам. Как кастомизировать?
-
-Никак.
-
-### Помощь в развитии
-
-Мы рады любой сторонней помощи. Не стесняйтесь писать в [issues](https://github.com/skbkontur/retail-ui/issues)
-баги и идеи для развития библиотеки.<br />
+# React UI
+
+[![Build Status](https://tc.skbkontur.ru/app/rest/builds/buildType:FrontendInfrastructure_Packages_RunAll/statusIcon)](https://tc.skbkontur.ru/project.html?projectId=FrontendInfrastructure_Packages_ReactUI&tab=projectOverview)
+
+- [Варианты использования](#Варианты-использования)
+  - [Квик-старт](#Квик-старт) **@skbkontur/react-ui** собранная версия библиотеки
+  - [Слоу-старт](#Слоу-старт) **retail-ui** исходники для самостоятельной сборки, для переопределения `.less`-переменных
+- [FAQ](#FAQ)
+
+## <a name="Варианты-использования"></a>Варианты использования
+
+### <a name="Квик-старт"></a>Квик-старт
+
+```bash
+yarn add @skbkontur/react-ui
+```
+
+И используем компонентики у себя в проекте:
+
+```jsx static
+import Button from '@skbkontur/react-ui/Button';
+import Toast from '@skbkontur/react-ui/Toast';
+
+const MyApp = () => (
+  <div>
+    Click this button <Button onClick={() => Toast.push('Hey!')}>Click me</Button>
+  </div>
+);
+```
+
+Если ругается, что `regeneratorRuntime` не определен, то необходимо подключить `regenerator-runtime` или `@babel/polyfill`, например в `index.html`
+
+Квик-старт подойдёт, если Вебпак настроен на сборку. Например, вы используете `create-react-app`. В противном случае добавьте в конфиг Вебпака `style-`, `css-` и `file-loader`
+
+### <a name="Слоу-старт"></a>Слоу-старт
+
+```bash
+yarn add retail-ui
+```
+
+Необходимо установить как зависимости и добавить в [конфиг Вебпака](https://webpack.js.org/configuration/) следующие лоадеры:
+
+```js static
+module: {
+  rules: [
+    {
+      test: /\.jsx?$/,
+      use: [
+        {
+          loader: 'babel-loader',
+          options: {
+            presets: ['@babel/preset-env', '@babel/preset-react', '@babel/preset-flow'],
+            plugins: ['@babel/plugin-proposal-class-properties', '@babel/plugin-proposal-object-rest-spread'],
+          },
+        },
+      ],
+      include: /retail-ui/,
+    },
+    {
+      test: /\.less$/,
+      use: [
+        'style-loader',
+        {
+          loader: 'css-loader',
+          options: { modules: 'global' },
+        },
+        'less-loader',
+      ],
+    },
+    {
+      test: /\.(png|woff|woff2|eot)$/,
+      use: ['file-loader'],
+    },
+  ];
+}
+```
+
+### Хотим другой цвет кнопки!
+
+Тут придется юзать слоу-старт. В конфиге нужно указать:
+
+```js static
+resolve: {
+  alias: {
+    'react-ui-theme': path.join(__dirname, 'path-to-my-theme-variables.less')
+  }
+}
+```
+
+Список переменных можно глянуть в `components/variables.less`
+
+### Глобальные css-стили приложения портят внешний вид контролов
+
+Если библиотека используется в проекте с легаси, где стилизация сделана прямо по названиям тегов, то внешний вид контролов из библиотеки может сильно испортиться
+
+Если нет возможности разобрать легаси, то можно увеличить специфичность селекторов в библиотеке, тогда стили контролов будут приоритетнее стилей из легаси проекта
+
+Специфичность достигается за счет n-кратного повторения css-класса `react-ui` в селекторе стилей. Количество повторений задается через переменную `@specificity-level`, значение по умолчанию равно нулю, то есть по умолчанию css-класс `react-ui` никак ни на что не будет влиять
+
+Чтобы специфичность заработала в легаси проекте, react-блок, в котором используются компоненты из библиотеки, должен быть обернут в тег с css-классом `react-ui`
+
+Пример настройки специфичности
+
+```less
+/* ... */
+@specificity-level: 5;
+/* ... */
+```
+
+## <a name="FAQ"></a>FAQ
+
+### Сломались стили при использовании css-loader 2.x (create-react-app/CRA 3.x)
+
+Во [2-й версии](https://github.com/webpack-contrib/css-loader/releases/tag/v2.0.0), `css-loader` отключили использование `css-modules` по умолчанию.
+**Решение**: В опциях к `css-loader` явно задать `modules: 'global'`.
+
+### Как использовать retail-ui с storybook 5.x?
+
+В 5-й версии изменилось [API сторибука для кастомизации настроек webpack](https://github.com/storybooks/storybook/blob/v5.0.0/MIGRATION.md#webpack-config-simplifcation).
+Кроме того был изменен дефолтный webpack конфиг. Это порождает проблемы вида [storybooks/storybook#4891](https://github.com/storybooks/storybook/issues/4891).
+**Решение**: Заменить лоадеры для `css/less`. Например [так](https://github.com/storybooks/storybook/issues/6319#issuecomment-477852640) на свои
+
+### Возникает ошибка `Error: Can't resolve 'mask-char-font/font.eot'`
+
+Ошибка проявляется при использовании `css-loader@1.x` с выставленой опцией `modules`.
+**Решение**: Обновить `css-loader` до 2-й версии или дополнительно указать опцию `url: false`
+
+### Не могу прокинуть css-класс компонентам. Как кастомизировать?
+
+Никак.
+
+### Помощь в развитии
+
+Мы рады любой сторонней помощи. Не стесняйтесь писать в [issues](https://github.com/skbkontur/retail-ui/issues)
+баги и идеи для развития библиотеки.<br />

package/components/Autocomplete/Autocomplete.adapter.js.flow

@@ -1,4 +1,4 @@
-/* @flow */
-import Autocomplete from './Autocomplete.js';
-
-export default Autocomplete;
+/* @flow */
+import Autocomplete from './Autocomplete.js';
+
+export default Autocomplete;

package/components/Autocomplete/Autocomplete.js.flow

@@ -1,37 +1,37 @@
-/* @flow */
-import type { InputProps } from '../Input';
-
-export type AutocompleteProps = {
-  ...$Exact<InputProps>,
-  renderItem?: (item: string) => React$Node,
-  source?: string[] | ((patter: string) => Promise<string[]>),
-  disablePortal?: boolean,
-  hasShadow?: boolean,
-  menuAlign?: 'left' | 'right',
-  menuMaxHeight?: number | string,
-  menuWidth?: number | string,
-  preventWindowScroll?: boolean,
-  onChange: (
-    event: {
-      target: {
-        value: string,
-      },
-    },
-    value: string,
-  ) => void,
-  onBlur?: () => void,
-  size?: $PropertyType<InputProps, 'size'>,
-  value: string,
-};
-
-export type AutocomplpeteState = {|
-  items: void | null | string[],
-  selected: number,
-|};
-
-declare class Autocomplete extends React$Component<AutocompleteProps, AutocomplpeteState> {
-  focus(): void;
-  blur(): void;
-}
-
-export default Autocomplete;
+/* @flow */
+import type { InputProps } from '../Input';
+
+export type AutocompleteProps = {
+  ...$Exact<InputProps>,
+  renderItem?: (item: string) => React$Node,
+  source?: string[] | ((patter: string) => Promise<string[]>),
+  disablePortal?: boolean,
+  hasShadow?: boolean,
+  menuAlign?: 'left' | 'right',
+  menuMaxHeight?: number | string,
+  menuWidth?: number | string,
+  preventWindowScroll?: boolean,
+  onChange: (
+    event: {
+      target: {
+        value: string,
+      },
+    },
+    value: string,
+  ) => void,
+  onBlur?: () => void,
+  size?: $PropertyType<InputProps, 'size'>,
+  value: string,
+};
+
+export type AutocomplpeteState = {|
+  items: void | null | string[],
+  selected: number,
+|};
+
+declare class Autocomplete extends React$Component<AutocompleteProps, AutocomplpeteState> {
+  focus(): void;
+  blur(): void;
+}
+
+export default Autocomplete;

package/components/Autocomplete/README.md

@@ -1,7 +1,7 @@
-```js
-let items = ['Grey Face', 'Grey Space', 'Kappa', 'Keepo', 'Resident Sleeper'];
-
-let initialState = { value: 'Kappa' };
-
-<Autocomplete source={items} value={state.value} onChange={(_, value) => setState({ value })} />;
-```
+```js
+let items = ['Grey Face', 'Grey Space', 'Kappa', 'Keepo', 'Resident Sleeper'];
+
+let initialState = { value: 'Kappa' };
+
+<Autocomplete source={items} value={state.value} onChange={(_, value) => setState({ value })} />;
+```

package/components/Autocomplete/index.js.flow

@@ -1,2 +1,2 @@
-/* @flow */
-export { default, AutocompleteProps, AutocomplpeteState } from './Autocomplete';
+/* @flow */
+export { default, AutocompleteProps, AutocomplpeteState } from './Autocomplete';

package/components/Button/Button.adapter.js.flow

@@ -1,4 +1,4 @@
-/* @flow */
-import Button from './Button.js';
-
-export default Button;
+/* @flow */
+import Button from './Button.js';
+
+export default Button;

package/components/Button/Button.js.flow

@@ -1,58 +1,58 @@
-/* @flow */
-import * as CSS from 'csstype';
-import type { FocusEventHandler, MouseEventHandler, KeyboardEventHandler } from '../eventHandlers';
-
-export type ButtonSize = 'small' | 'medium' | 'large';
-export type ButtonType = 'button' | 'submit' | 'reset';
-export type ButtonArrow = boolean | 'left';
-export type ButtonUse = 'default' | 'primary' | 'success' | 'danger' | 'pay' | 'link';
-
-export type ButtonProps = {|
-  _noPadding?: boolean,
-  _noRightPadding?: boolean,
-  active?: boolean,
-  align?: CSS.TextAlignProperty,
-  arrow?: ButtonArrow,
-  autoFocus?: boolean,
-  borderless?: boolean,
-  checked?: boolean,
-  children?: React$Node,
-  corners?: number,
-  disabled?: boolean,
-  disableFocus?: boolean,
-  error?: boolean,
-  focused?: boolean,
-  // eslint-disable-next-line flowtype/no-weak-types
-  icon?: React$Element<any>,
-  loading?: boolean,
-  narrow?: boolean,
-  onBlur?: FocusEventHandler<HTMLButtonElement>,
-  onClick?: MouseEventHandler<HTMLButtonElement>,
-  onFocus?: FocusEventHandler<HTMLButtonElement>,
-  onKeyDown?: KeyboardEventHandler<HTMLButtonElement>,
-  onMouseEnter?: MouseEventHandler<HTMLButtonElement>,
-  onMouseLeave?: MouseEventHandler<HTMLButtonElement>,
-  onMouseOver?: MouseEventHandler<HTMLButtonElement>,
-  size?: ButtonSize,
-  type?: ButtonType,
-  use?: ButtonUse,
-  visuallyFocused?: boolean,
-  warning?: boolean,
-  width?: number | string,
-|};
-
-export type ButtonState = {|
-  focusedByTab: boolean,
-|};
-
-declare class Button extends React$Component<ButtonProps, ButtonState> {
-  static TOP_LEFT: number;
-  static TOP_RIGHT: number;
-  static BOTTOM_RIGHT: number;
-  static BOTTOM_LEFT: number;
-
-  focus(): void;
-  blur(): void;
-}
-
-export default Button;
+/* @flow */
+import * as CSS from 'csstype';
+import type { FocusEventHandler, MouseEventHandler, KeyboardEventHandler } from '../eventHandlers';
+
+export type ButtonSize = 'small' | 'medium' | 'large';
+export type ButtonType = 'button' | 'submit' | 'reset';
+export type ButtonArrow = boolean | 'left';
+export type ButtonUse = 'default' | 'primary' | 'success' | 'danger' | 'pay' | 'link';
+
+export type ButtonProps = {|
+  _noPadding?: boolean,
+  _noRightPadding?: boolean,
+  active?: boolean,
+  align?: CSS.TextAlignProperty,
+  arrow?: ButtonArrow,
+  autoFocus?: boolean,
+  borderless?: boolean,
+  checked?: boolean,
+  children?: React$Node,
+  corners?: number,
+  disabled?: boolean,
+  disableFocus?: boolean,
+  error?: boolean,
+  focused?: boolean,
+  // eslint-disable-next-line flowtype/no-weak-types
+  icon?: React$Element<any>,
+  loading?: boolean,
+  narrow?: boolean,
+  onBlur?: FocusEventHandler<HTMLButtonElement>,
+  onClick?: MouseEventHandler<HTMLButtonElement>,
+  onFocus?: FocusEventHandler<HTMLButtonElement>,
+  onKeyDown?: KeyboardEventHandler<HTMLButtonElement>,
+  onMouseEnter?: MouseEventHandler<HTMLButtonElement>,
+  onMouseLeave?: MouseEventHandler<HTMLButtonElement>,
+  onMouseOver?: MouseEventHandler<HTMLButtonElement>,
+  size?: ButtonSize,
+  type?: ButtonType,
+  use?: ButtonUse,
+  visuallyFocused?: boolean,
+  warning?: boolean,
+  width?: number | string,
+|};
+
+export type ButtonState = {|
+  focusedByTab: boolean,
+|};
+
+declare class Button extends React$Component<ButtonProps, ButtonState> {
+  static TOP_LEFT: number;
+  static TOP_RIGHT: number;
+  static BOTTOM_RIGHT: number;
+  static BOTTOM_LEFT: number;
+
+  focus(): void;
+  blur(): void;
+}
+
+export default Button;

package/components/Button/Corners.js.flow

@@ -1,12 +1,12 @@
-/* @flow */
-
-type Corners = {|
-  TOP_LEFT: number,
-  TOP_RIGHT: number,
-  BOTTOM_RIGHT: number,
-  BOTTOM_LEFT: number,
-|};
-
-var corners: Corners;
-
-export default corners;
+/* @flow */
+
+type Corners = {|
+  TOP_LEFT: number,
+  TOP_RIGHT: number,
+  BOTTOM_RIGHT: number,
+  BOTTOM_LEFT: number,
+|};
+
+var corners: Corners;
+
+export default corners;