diff --git a/README.md b/README.md index d14959db..aa9b347a 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,13 @@ # Native JavaScript for Bootstrap -This is a library developed with native JavaScript for **Bootstrap 4** series, featuring superior performance compared to the original jQuery Plugins. +The faster, lighter and more secure set of JavaScript components for **Bootstrap 4**, developed on modern ES6/ES7 standards. +The bootstrap.native library comes packed with build tools and well documented [![NPM Version](https://img.shields.io/npm/v/bootstrap.native.svg?style=flat-square)](https://www.npmjs.com/package/bootstrap.native) [![NPM Downloads](https://img.shields.io/npm/dm/bootstrap.native.svg?style=flat-square)](http://npm-stat.com/charts.html?package=bootstrap.native) [![jsDeliver](https://data.jsdelivr.com/v1/package/npm/bootstrap.native/badge)](https://www.jsdelivr.com/package/npm/bootstrap.native) [![CDNJS](https://img.shields.io/cdnjs/v/bootstrap.native.svg?style=flat-square)](https://cdnjs.com/libraries/bootstrap.native) - The library is around ***25Kb*** minified and ***7.5Kb*** gZipped. See demo for scripting examples and instructions. + The library is around ***25Kb*** minified and ***7.5Kb*** gZipped. See the demo for components guidelines and examples, or the [Wiki/How to use](https://github.com/thednp/bootstrap.native/wiki/How-to-use) on how to use the library or create custom builds. If you use webpack, here is the accompanying [webpack loader](https://github.com/jonathanfleckenstein/bootstrap.native-loader). diff --git a/index.html b/index.html index 9c6f5825..7278c1ec 100644 --- a/index.html +++ b/index.html @@ -475,8 +475,8 @@

Carousel Options

5000 Sets the component's delay between transitions in miliseconds. Can be set via JavaScript or the data-interval="INTERVAL" attribute. If you want to disable the automatic transition, you can - set this option to false. Starting with version 2.0.19 the component will not automatically slide - if the element is not visible in the viewport. + set this option to false. However the component will not automatically slide if the element is + not visible in the viewport. @@ -1601,18 +1601,18 @@

Modal JavaScript API

); -

Starting with BSN v3.0, you can re-initialize your target elements very much like the original plugin, but +

Now you can re-initialize your target elements very much like the original plugin, but with native JavaScript syntax:

// re-initialize on a target with different options
-// also call the .show() method
+// also call the .show() method right away
 var myNewModalInstance = new BSN.Modal('#myModal', { backdrop: true }).show();
 

Keep in mind that re-initializing will make use of the .dispose() method to clear memory - allocated for previous initialization, which involves two things: reseting the options' values to the + allocated for previous initialization, which involves two things: reseting the other options' values to the DATA API specified, or default values if not specified on re-initialization AND lastly, if the modal - is open on re-initialization, it will be made hidden via .hide() and you can still access the + is open, on re-initialization the modal will be hidden via .hide(), but you can still access the .show() method right away.

In other cases you can designate one or multiple triggering elements to open your modal, they will be the target @@ -3144,13 +3144,13 @@

Tooltip Options

-

If a tooltip is a child element of a modal, a <nav class="navbar-fixed-top"> or a - <nav class="navbar-fixed-bottom">, the container option is set automatically to - target that specific parent starting with version 2.0.6.

-

Starting with version 2.0.19, in addition to automatic repositioning, the component will try to make sure the - tooltips are always in the viewport as some Popper.js functionality have been implemented into both V3 and V4 versions.

+

If your tooltip is a child element of a modal, a <nav class="navbar fixed-top"> or a + <nav class="navbar fixed-bottom">, the container option is set automatically to + target that specific parent.

+

The component also provides automatic repositioning, which means it will try to make sure the + tooltips are always in the viewport, somewhat similar to the + Popper.js functionality, check + right here.

@@ -3179,9 +3179,8 @@

Tooltip Methods

Tooltip Events

The component's original events are same as with the original jQuery Plugin, except - inserted.bs.tooltip, the way the component works makes that this event is not needed, as it would - fire - on every instance of the .show() method.

+ inserted.bs.tooltip, the way the component works makes that this event is not needed, + as it would fire on every instance of the .show() call.