From e769104eae5bebe455a5c50c9854192944f46273 Mon Sep 17 00:00:00 2001 From: addMoreScript Date: Fri, 30 Oct 2020 14:48:39 +0400 Subject: [PATCH] Update Readme, add .editorconfig --- .babelrc | 2 +- .editorconfig | 10 ++++++++++ README.md | 2 ++ README_ru.md | 15 +++++++++------ package.json | 6 +++++- 5 files changed, 27 insertions(+), 8 deletions(-) create mode 100644 .editorconfig diff --git a/.babelrc b/.babelrc index 977834f..2449942 100644 --- a/.babelrc +++ b/.babelrc @@ -12,7 +12,7 @@ "plugins": [ "@babel/plugin-transform-object-assign", - "@babel/plugin-proposal-class-properties", + "@babel/plugin-proposal-class-properties" // "@babel/plugin-proposal-private-methods" ] } \ No newline at end of file diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..7ef2eb1 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,10 @@ +# editorconfig.org + +root = true + +[*] +charset = utf-8 +indent_size = 4 +indent_style = space +insert_final_newline = true +trim_trailing_whitespace = true diff --git a/README.md b/README.md index 55d148f..5239370 100644 --- a/README.md +++ b/README.md @@ -73,6 +73,8 @@ Title of data-attribute, which opening the modals, is defined by value of the pr |closeOnButton|Boolean|true|Allow/disallow closing windows by click on element with attribute data-hystclose. If there are multiple selectors with this attribute, modal window will closed by click on any of this| |waitTransitions|Boolean|false|If true – modal window will be closed after ending of CSS-transition of elements .hystmodal__window. If false – modal window will be closed instantly. So that the opening also took place instantly – delete CSS property transition of .hystmodal__window and set the option waitTransitions:false.| |catchFocus|Boolean|true|If true – when modal window is opened, focus will looped on active elements inside modal. When modal window closing, focus returning on previous selector.| +|fixedSelectors|string|"*[data-hystfixed]"|Contains a css selector that adds an margin-right equal to the width of the scroll bar when opening a modal window. Useful for fixed elements on a page to avoid shifting them when opening a window. Works only if the property backscroll:true | +|backscroll|boolean|true|If true - the scrolling will be blocked when the window is opened. If false, scrolling is not blocked (if the modal window is high, double scrolling may occur)| |beforeOpen|function|Empty function|Callback function. Run before opening of the modal. A modal window object (see API) is passed to the function as argument.| |afterClose|function|Empty function|Callback function. Run after closing of the modal. A modal window object (see API) of the closed window is passed to the function as argument.| diff --git a/README_ru.md b/README_ru.md index a8bd07c..0b0ea64 100644 --- a/README_ru.md +++ b/README_ru.md @@ -62,11 +62,13 @@ |Название свойства|Тип|Начальное значение|Описание| |--|--|--|--| |linkAttributeName|String|"data-hystmodal"|Определяет data-атрибут элемента, клик по которому открывает модальное окно. Значение этого атрибута должно соответствовать селектору окна, которое необходимо открыть. Если не задано, то обработчики событий задействованы не будут.| -|closeOnOverlay|Bolean|true|Разрешает/запрещает закрывать окна кликом/тапом на оверлей. (элемент с классом .hystmodal__wrap )| -|closeOnEsc|Bolean|true|Разрешает/запрещает закрывать окна с клавиатуры, нажатием ESC.| -|closeOnButton|Bolean|true|Разрешает/запрещает закрывать окно по клику на элемент с атрибутом data-hystclose. Если имеется несколько элементов с этим атрибутом, окно закроется по клику на любой из них.| -|waitTransitions|Bolean|false|Если true – закрытие окна произойдёт после завершения css-перехода на элементе .hystmodal__window. Если false – закрытие окна будет мгновенным. Чтобы и открытие также проходимо мгновенно – удалите CSS свойство transition для .hystmodal__window и установите waitTransitions:false.| -|catchFocus|Bolean|true|Если true – при открытии зацикливает фокус на активных элементах внутри окна. При закрытии окна – фокус возвращается на предыдущий селектор.| +|closeOnOverlay|boolean|true|Разрешает/запрещает закрывать окна кликом/тапом на оверлей. (элемент с классом .hystmodal__wrap )| +|closeOnEsc|boolean|true|Разрешает/запрещает закрывать окна с клавиатуры, нажатием ESC.| +|closeOnButton|boolean|true|Разрешает/запрещает закрывать окно по клику на элемент с атрибутом data-hystclose. Если имеется несколько элементов с этим атрибутом, окно закроется по клику на любой из них.| +|waitTransitions|boolean|false|Если true – закрытие окна произойдёт после завершения css-перехода на элементе .hystmodal__window. Если false – закрытие окна будет мгновенным. Чтобы и открытие также проходимо мгновенно – удалите CSS свойство transition для .hystmodal__window и установите waitTransitions:false.| +|catchFocus|boolean|true|Если true – при открытии зацикливает фокус на активных элементах внутри окна. При закрытии окна – фокус возвращается на предыдущий селектор.| +|fixedSelectors|string|"*[data-hystfixed]"|Содержит css-селектор, к которому добавляется отступ равный ширине полосы прокрутки, при открытии модального окна. Полезно для fixed элементов на странице, чтобы избежать их сдвига при открытии окна. Работает только если свойство backscroll:true| +|backscroll|boolean|true|Если true - прокрутка страницы блокируется при открытии окна. Если false - прокрутка не блокируется (при высоком модальном окне, возможно появление двойного скрола)| |beforeOpen|function|Пустая функция|Функция обратного вызова. Запускается перед открытием окна. В функцию передаётся объект модального окна окна.| |afterClose|function|Пустая функция|Функция обратного вызова. Запускается после закрытия окна. В функцию передаётся объект последнего модального окна.| @@ -77,6 +79,7 @@ catchFocus: true, waitTransitions: true, closeOnEsc: false, + fixedSelectors: ".my-fixed-elems", beforeOpen: function(modal){ console.log('Message before opening the modal'); console.log(modal); //modal window object @@ -95,7 +98,7 @@ |Название свойства|Тип|Описание| |--|--|--| -|isOpened|Bolean|Индикатор открытия окна. True – окно открыто в текущий момент. По умолчанию – false. Некоторые приватные методы ориентируются на значение данного свойства.| +|isOpened|boolean|Индикатор открытия окна. True – окно открыто в текущий момент. По умолчанию – false. Некоторые приватные методы ориентируются на значение данного свойства.| |openedWindow|DOM node|Селектор открытого окна. Если окно закрыто – содержит селектор последнего открытого окна.| |starter|DOM node|Селектор с которого было открыто модальное окно. Используется для возвращения фокуса на элемент.| |config|object|Объект настроек. См. конфигурация.| diff --git a/package.json b/package.json index 70c33b5..a03d52d 100644 --- a/package.json +++ b/package.json @@ -41,5 +41,9 @@ "style-loader": "^1.2.1", "webpack": "^4.44.1", "webpack-cli": "^3.3.12" - } + }, + "browserslist": [ + "defaults", + "IE 11" + ] }