Skip to content

Commit

Permalink
docs: Fix simple typo, dimentions -> dimensions (glidejs#521)
Browse files Browse the repository at this point in the history 
Co-authored-by: Jędrzej Chałubek <[email protected]>
  • Loading branch information
@timgates42 @jedrzejchalubek
timgates42 and jedrzejchalubek authored Nov 21, 2021
1 parent ef627bc commit 5e958de
Show file tree
Hide file tree
Showing 8 changed files with 316 additions and 316 deletions.
206 changes: 103 additions & 103 deletions dist/glide.esm.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -649,11 +649,11 @@ var EventsBus = /*#__PURE__*/function () {
}();

var Glide$1 = /*#__PURE__*/function () {
/**
* Construct glide.
*
* @param {String} selector
* @param {Object} options
/**
* Construct glide.
*
* @param {String} selector
* @param {Object} options
*/
function Glide(selector) {
var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
Expand All @@ -668,11 +668,11 @@ var Glide$1 = /*#__PURE__*/function () {
this.settings = mergeOptions(defaults, options);
this.index = this.settings.startAt;
}
/**
* Initializes glide.
*
* @param {Object} extensions Collection of extensions to initialize.
* @return {Glide}
/**
* Initializes glide.
*
* @param {Object} extensions Collection of extensions to initialize.
* @return {Glide}
*/


Expand All @@ -693,11 +693,11 @@ var Glide$1 = /*#__PURE__*/function () {

return this;
}
/**
* Collects an instance `translate` transformers.
*
* @param {Array} transformers Collection of transformers.
* @return {Void}
/**
* Collects an instance `translate` transformers.
*
* @param {Array} transformers Collection of transformers.
* @return {Void}
*/

}, {
Expand All @@ -713,11 +713,11 @@ var Glide$1 = /*#__PURE__*/function () {

return this;
}
/**
* Updates glide with specified settings.
*
* @param {Object} settings
* @return {Glide}
/**
* Updates glide with specified settings.
*
* @param {Object} settings
* @return {Glide}
*/

}, {
Expand All @@ -734,16 +734,16 @@ var Glide$1 = /*#__PURE__*/function () {

return this;
}
/**
* Change slide with specified pattern. A pattern must be in the special format:
* `>` - Move one forward
* `<` - Move one backward
* `={i}` - Go to {i} zero-based slide (eq. '=1', will go to second slide)
* `>>` - Rewinds to end (last slide)
* `<<` - Rewinds to start (first slide)
*
* @param {String} pattern
* @return {Glide}
/**
* Change slide with specified pattern. A pattern must be in the special format:
* `>` - Move one forward
* `<` - Move one backward
* `={i}` - Go to {i} zero-based slide (eq. '=1', will go to second slide)
* `>>` - Rewinds to end (last slide)
* `<<` - Rewinds to start (first slide)
*
* @param {String} pattern
* @return {Glide}
*/

}, {
Expand All @@ -753,11 +753,11 @@ var Glide$1 = /*#__PURE__*/function () {

return this;
}
/**
* Move track by specified distance.
*
* @param {String} distance
* @return {Glide}
/**
* Move track by specified distance.
*
* @param {String} distance
* @return {Glide}
*/

}, {
Expand All @@ -769,10 +769,10 @@ var Glide$1 = /*#__PURE__*/function () {

return this;
}
/**
* Destroy instance and revert all changes done by this._c.
*
* @return {Glide}
/**
* Destroy instance and revert all changes done by this._c.
*
* @return {Glide}
*/

}, {
Expand All @@ -782,11 +782,11 @@ var Glide$1 = /*#__PURE__*/function () {

return this;
}
/**
* Start instance autoplaying.
*
* @param {Boolean|Number} interval Run autoplaying with passed interval regardless of `autoplay` settings
* @return {Glide}
/**
* Start instance autoplaying.
*
* @param {Boolean|Number} interval Run autoplaying with passed interval regardless of `autoplay` settings
* @return {Glide}
*/

}, {
Expand All @@ -802,10 +802,10 @@ var Glide$1 = /*#__PURE__*/function () {

return this;
}
/**
* Stop instance autoplaying.
*
* @return {Glide}
/**
* Stop instance autoplaying.
*
* @return {Glide}
*/

}, {
Expand All @@ -815,10 +815,10 @@ var Glide$1 = /*#__PURE__*/function () {

return this;
}
/**
* Sets glide into a idle status.
*
* @return {Glide}
/**
* Sets glide into a idle status.
*
* @return {Glide}
*/

}, {
Expand All @@ -827,10 +827,10 @@ var Glide$1 = /*#__PURE__*/function () {
this.disabled = true;
return this;
}
/**
* Sets glide into a active status.
*
* @return {Glide}
/**
* Sets glide into a active status.
*
* @return {Glide}
*/

}, {
Expand All @@ -839,12 +839,12 @@ var Glide$1 = /*#__PURE__*/function () {
this.disabled = false;
return this;
}
/**
* Adds cuutom event listener with handler.
*
* @param {String|Array} event
* @param {Function} handler
* @return {Glide}
/**
* Adds cuutom event listener with handler.
*
* @param {String|Array} event
* @param {Function} handler
* @return {Glide}
*/

}, {
Expand All @@ -854,34 +854,34 @@ var Glide$1 = /*#__PURE__*/function () {

return this;
}
/**
* Checks if glide is a precised type.
*
* @param {String} name
* @return {Boolean}
/**
* Checks if glide is a precised type.
*
* @param {String} name
* @return {Boolean}
*/

}, {
key: "isType",
value: function isType(name) {
return this.settings.type === name;
}
/**
* Gets value of the core options.
*
* @return {Object}
/**
* Gets value of the core options.
*
* @return {Object}
*/

}, {
key: "settings",
get: function get() {
return this._o;
}
/**
* Sets value of the core options.
*
* @param {Object} o
* @return {Void}
/**
* Sets value of the core options.
*
* @param {Object} o
* @return {Void}
*/
,
set: function set(o) {
Expand All @@ -891,52 +891,52 @@ var Glide$1 = /*#__PURE__*/function () {
warn('Options must be an `object` instance.');
}
}
/**
* Gets current index of the slider.
*
* @return {Object}
/**
* Gets current index of the slider.
*
* @return {Object}
*/

}, {
key: "index",
get: function get() {
return this._i;
}
/**
* Sets current index a slider.
*
* @return {Object}
/**
* Sets current index a slider.
*
* @return {Object}
*/
,
set: function set(i) {
this._i = toInt(i);
}
/**
* Gets type name of the slider.
*
* @return {String}
/**
* Gets type name of the slider.
*
* @return {String}
*/

}, {
key: "type",
get: function get() {
return this.settings.type;
}
/**
* Gets value of the idle status.
*
* @return {Boolean}
/**
* Gets value of the idle status.
*
* @return {Boolean}
*/

}, {
key: "disabled",
get: function get() {
return this._d;
}
/**
* Sets value of the idle status.
*
* @return {Boolean}
/**
* Sets value of the idle status.
*
* @return {Boolean}
*/
,
set: function set(status) {
Expand Down Expand Up @@ -1400,7 +1400,7 @@ function Gaps (Glide, Components, Events) {
});
define(Gaps, 'grow', {
/**
* Gets additional dimentions value caused by gaps.
* Gets additional dimensions value caused by gaps.
* Used to increase width of the slides wrapper.
*
* @returns {Number}
Expand Down Expand Up @@ -1716,7 +1716,7 @@ function Move (Glide, Components, Events) {
function Sizes (Glide, Components, Events) {
var Sizes = {
/**
* Setups dimentions of slides.
* Setups dimensions of slides.
*
* @return {Void}
*/
Expand All @@ -1730,7 +1730,7 @@ function Sizes (Glide, Components, Events) {
},

/**
* Setups dimentions of slides wrapper.
* Setups dimensions of slides wrapper.
*
* @return {Void}
*/
Expand Down Expand Up @@ -1795,7 +1795,7 @@ function Sizes (Glide, Components, Events) {
});
/**
* Apply calculated glide's dimensions:
* - before building, so other dimentions (e.g. translate) will be calculated propertly
* - before building, so other dimensions (e.g. translate) will be calculated propertly
* - when resizing window to recalculate sildes dimensions
* - on updating via API, to calculate dimensions based on new options
*/
Expand Down Expand Up @@ -1882,7 +1882,7 @@ function Build (Glide, Components, Events) {
});
/**
* Remount component:
* - on resizing of the window to calculate new dimentions
* - on resizing of the window to calculate new dimensions
* - on updating settings via API
*/

Expand Down Expand Up @@ -1995,7 +1995,7 @@ function Clones (Glide, Components, Events) {
};
define(Clones, 'grow', {
/**
* Gets additional dimentions value caused by clones.
* Gets additional dimensions value caused by clones.
*
* @return {Number}
*/
Expand Down Expand Up @@ -2626,7 +2626,7 @@ function Transition (Glide, Components, Events) {
/**
* Disable transition:
* - before initial build to avoid transitioning from `0` to `startAt` index
* - while resizing window and recalculating dimentions
* - while resizing window and recalculating dimensions
* - on jumping from offset transition at start and end edges in `carousel` type
*/

Expand Down
Loading

0 comments on commit 5e958de

Please sign in to comment.