Skip to content

Commit

Permalink
Update Readme, add .editorconfig
Browse files Browse the repository at this point in the history
  • Loading branch information
AddMoreScripts committed Oct 30, 2020
1 parent 5ab372d commit e769104
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .babelrc
Original file line number Diff line number Diff line change
Expand Up @@ -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"
]
}
10 changes: 10 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -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
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.|

Expand Down
15 changes: 9 additions & 6 deletions README_ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -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|Пустая функция|Функция обратного вызова. Запускается после закрытия окна. В функцию передаётся объект последнего модального окна.|

Expand All @@ -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
Expand All @@ -95,7 +98,7 @@

|Название свойства|Тип|Описание|
|--|--|--|
|isOpened|Bolean|Индикатор открытия окна. True – окно открыто в текущий момент. По умолчанию – false. Некоторые приватные методы ориентируются на значение данного свойства.|
|isOpened|boolean|Индикатор открытия окна. True – окно открыто в текущий момент. По умолчанию – false. Некоторые приватные методы ориентируются на значение данного свойства.|
|openedWindow|DOM node|Селектор открытого окна. Если окно закрыто – содержит селектор последнего открытого окна.|
|starter|DOM node|Селектор с которого было открыто модальное окно. Используется для возвращения фокуса на элемент.|
|config|object|Объект настроек. См. конфигурация.|
Expand Down
6 changes: 5 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,9 @@
"style-loader": "^1.2.1",
"webpack": "^4.44.1",
"webpack-cli": "^3.3.12"
}
},
"browserslist": [
"defaults",
"IE 11"
]
}

0 comments on commit e769104

Please sign in to comment.