JavaScript

Bring CoreUI for Bootstrap to life with our optional JavaScript plugins. Learn about each plugin, our data and programmatic API options, and more.

🤖 Looking for the LLM-optimized version?View llm.md

On this page

Individual or compiled

Plugins can be included individually (using CoreUI’s individualjs/dist/*.js), or all at once usingcoreui.js or the minifiedcoreui.min.js (don’t include both).

If you use a bundler (Webpack, Rollup…), you can use/js/dist/*.js files which are UMD ready.

Usage with JavaScript frameworks

Using CoreUI for Bootstrap as a module

We provide a version of CoreUI for Bootstrap built asESM (coreui.esm.js andcoreui.esm.min.js) which allows you to use CoreUI for Bootstrap as a module in your browser, if yourtargeted browsers support it.

<scripttype="module">import{Toast}from'coreui.esm.min.js'Array.from(document.querySelectorAll('.toast')).forEach(toastNode=>newToast(toastNode))</script>

Compared to JS bundlers, using ESM in the browser requires you to use the full path and filename instead of the module name.Read more about JS modules in the browser. That’s why we use'coreui.esm.min.js' instead of'coreui' above. However, this is further complicated by our Popper dependency, which imports Popper into our JavaScript like so:

import*asPopperfrom"@popperjs/core"

If you try this as-is, you’ll see an error in the console like the following:

Uncaught TypeError: Failed to resolve module specifier "@popperjs/core". Relative references must start with either "/", "./", or "../".

To fix this, you can use animportmap to resolve the arbitrary module names to complete paths. If yourtargeted browsers do not supportimportmap, you’ll need to use thees-module-shims project. Here’s how it works for Bootstrap and Popper:

<!doctype html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1"><linkhref="https://cdn.jsdelivr.net/npm/@coreui/[email protected]/dist/css/coreui.min.css"rel="stylesheet"integrity="sha384-oMIIhJL1T5s+PxJr6+Qb0pO1IRFB6OGMM+J57UBT3UQKxSVsb++MkXpu9cLqaJxu"crossorigin="anonymous"><title>Hello, modularity!</title></head><body><h1>Hello, modularity!</h1><buttonid="popoverButton"type="button"class="btn btn-primary btn-lg"data-coreui-toggle="popover"title="ESM in Browser"data-coreui-content="Bang!">Custom popover</button><scriptasyncsrc="https://cdn.jsdelivr.net/npm/es-module-shims@1/dist/es-module-shims.min.js"crossorigin="anonymous"></script><scripttype="importmap">{"imports":{"@popperjs/core":"https://cdn.jsdelivr.net/npm/@popperjs/[email protected]/dist/esm/popper.min.js","coreui":"https://cdn.jsdelivr.net/npm/[email protected]/dist/js/coreui.esm.min.js"}}</script><scripttype="module">import*ascoreuifrom'@coreui/coreui'newcoreui.Popover(document.getElementById('popoverButton'))</script></body></html>

Dependencies

Some plugins and CSS components depend on other plugins. If you include plugins individually, make sure to check for these dependencies in the docs.

Our dropdowns, popovers and tooltips also depend onPopper.

Data attributes

Nearly all CoreUI for Bootstrap plugins can be enabled and configured through HTML alone with data attributes (our preferred way of using JavaScript functionality). Be sure toonly use one set of data attributes on a single element (e.g., you cannot trigger a tooltip and modal from the same button.)

Selectors

Currently to query DOM elements we use the native methodsquerySelector andquerySelectorAll for performance reasons, so you have to usevalid selectors.If you use special selectors, for example:collapse:Example be sure to escape them.

Events

CoreUI for Bootstrap provides custom events for most plugins’ unique actions. Generally, these come in an infinitive and past participle form - where the infinitive (ex.show) is triggered at the start of an event, and its past participle form (ex.shown) is triggered on the completion of an action.

All infinitive events providepreventDefault() functionality. This provides the ability to stop the execution of an action before it starts. Returning false from an event handler will also automatically callpreventDefault().

constmyModal=document.getElementById('myModal')myModal.addEventListener('show.coreui.modal',event=>{returnevent.preventDefault()// stops modal from being shown})

Programmatic API

All constructors accept an optional options object or nothing (which initiates a plugin with its default behavior):

constmyModalEl=document.querySelector('#myModal')constmodal=newcoreui.Modal(myModalEl)// initialized with defaultsconstconfigObject={keyboard:false}constmodal1=newcoreui.Modal(myModalEl,configObject)// initialized with no keyboard

If you’d like to get a particular plugin instance, each plugin exposes agetInstance method. For example, to retrieve an instance directly from an element:

coreui.Popover.getInstance(myPopoverEl)

This method will returnnull if an instance is not initiated over the requested element.

Alternatively,getOrCreateInstance can be used to get the instance associated with a DOM element, or create a new one in case it wasn’t initialized.

coreui.Popover.getOrCreateInstance(myPopoverEl,configObject)

In case an instance wasn’t initialized, it may accept and use an optional configuration object as second argument.

CSS selectors in constructors

In addition to thegetInstance andgetOrCreateInstance methods, all plugin constructors can accept a DOM element or a validCSS selector as the first argument. Plugin elements are found with thequerySelector method since our plugins only support a single element.

constmodal=newcoreui.Modal('#myModal')constdropdown=newcoreui.Dropdown('[data-coreui-toggle="dropdown"]')constoffcanvas=coreui.Offcanvas.getInstance('#myOffcanvas')constalert=coreui.Alert.getOrCreateInstance('#myAlert')

Asynchronous functions and transitions

All programmatic API methods areasynchronous and return to the caller once the transition is started butbefore it ends.

In order to execute an action once the transition is complete, you can listen to the corresponding event.

constmyCollapseEl=document.getElementById('myCollapse')myCollapseEl.addEventListener('shown.coreui.collapse',event=>{// Action to execute once the collapsible area is expanded})

In addition a method call on atransitioning component will be ignored.

constmyCarouselEl=document.getElementById('myCarousel')constcarousel=coreui.Carousel.getInstance(myCarouselEl)// Retrieve a Carousel instancemyCarouselEl.addEventListener('slid.coreui.carousel',event=>{carousel.to('2')// Will slide to the slide 2 as soon as the transition to slide 1 is finished})carousel.to('1')// Will start sliding to the slide 1 and returns to the callercarousel.to('2')// !! Will be ignored, as the transition to the slide 1 is not finished !!

`dispose` method

While it may seem correct to use thedispose method immediately afterhide(), it will lead to incorrect results. Here’s an example of the problem use:

constmyModal=document.querySelector('#myModal')myModal.hide()// it is asynchronousmyModal.addEventListener('shown.coreui.hidden',event=>{myModal.dispose()})

Default settings

You can change the default settings for a plugin by modifying the plugin’sConstructor.Default object:

// changes default for the modal plugin's `keyboard` option to falsecoreui.Modal.Default.keyboard=false

Methods and properties

Every CoreUI for Bootstrap plugin exposes the following methods and static properties.

Method	Description
`dispose`	Destroys an element’s modal. (Removes stored data on the DOM element)
`getInstance`	Static method which allows you to get the modal instance associated with a DOM element.
`getOrCreateInstance`	Static method which allows you to get the modal instance associated with a DOM element, or create a new one in case it wasn’t initialized.

Static property	Description
`NAME`	Returns the plugin name. (Example:`coreui.Tooltip.NAME`)
`VERSION`	The version of each of CoreUI for Bootstrap’s plugins can be accessed via the`VERSION` property of the plugin’s constructor (Example:`coreui.Tooltip.VERSION`)

Sanitizer

Tooltips, Popovers, and Ratings use our built-in sanitizer to sanitize options which accept HTML.

The defaultallowList value is the following:

js/src/util/sanitizer.js

constARIA_ATTRIBUTE_PATTERN=/^aria-[\w-]*$/iexportconstDefaultAllowlist={// Global attributes allowed on any supplied element below.'*':['class','dir','id','lang','role',ARIA_ATTRIBUTE_PATTERN],a:['target','href','title','rel'],area:[],b:[],br:[],col:[],code:[],dd:[],div:[],dl:[],dt:[],em:[],hr:[],h1:[],h2:[],h3:[],h4:[],h5:[],h6:[],i:[],img:['src','srcset','alt','title','width','height'],li:[],ol:[],p:[],pre:[],s:[],small:[],span:[],sub:[],sup:[],strong:[],u:[],ul:[]}

The defaultsvgAllowList value for Ratings is:

js/src/rating.js

exportconstsvgAllowList={...DefaultAllowlist,svg:['xmlns','version','baseprofile','width','height','viewbox','preserveaspectratio','aria-hidden','role','focusable'],g:['id','class','transform','style'],path:['id','class','d','fill','fill-opacity','fill-rule','stroke','stroke-width','stroke-linecap','stroke-linejoin','stroke-miterlimit','stroke-dasharray','stroke-dashoffset','stroke-opacity'],circle:['id','class','cx','cy','r','fill','fill-opacity','stroke','stroke-width','stroke-opacity'],rect:['id','class','x','y','width','height','rx','ry','fill','fill-opacity','stroke','stroke-width','stroke-opacity'],ellipse:['id','class','cx','cy','rx','ry','fill','fill-opacity','stroke','stroke-width','stroke-opacity'],line:['id','class','x1','y1','x2','y2','stroke','stroke-width','stroke-opacity'],polygon:['id','class','points','fill','fill-opacity','stroke','stroke-width','stroke-opacity'],polyline:['id','class','points','fill','fill-opacity','stroke','stroke-width','stroke-opacity'],text:['id','class','x','y','dx','dy','text-anchor','font-family','font-size','font-weight','fill','fill-opacity','stroke','stroke-width','stroke-opacity'],tspan:['id','class','x','y','dx','dy','text-anchor','font-family','font-size','font-weight','fill','fill-opacity','stroke','stroke-width','stroke-opacity'],defs:[],symbol:['id','class','viewbox','preserveaspectratio'],use:['id','class','x','y','width','height','href'],image:['id','class','x','y','width','height','href','preserveaspectratio','xlink:href'],pattern:['id','class','x','y','width','height','patternunits','patterncontentunits','patterntransform','preserveaspectratio'],lineargradient:['id','class','gradientunits','x1','y1','x2','y2','spreadmethod','gradienttransform'],radialgradient:['id','class','gradientunits','cx','cy','r','fx','fy','spreadmethod','gradienttransform'],mask:['id','class','x','y','width','height','maskunits','maskcontentunits','masktransform'],clippath:['id','class','clippathunits'],marker:['id','class','markerunits','markerwidth','markerheight','orient','preserveaspectratio','viewbox','refx','refy'],title:[],desc:[]}

If you want to add new values to this defaultallowList you can do the following:

constmyDefaultAllowList=coreui.Tooltip.Default.allowList// To allow table elementsmyDefaultAllowList.table=[]// To allow td elements and data-coreui-option attributes on td elementsmyDefaultAllowList.td=['data-coreui-option']// You can push your custom regex to validate your attributes.// Be careful about your regular expressions being too laxconstmyCustomRegex=/^data-my-app-[\w-]+/myDefaultAllowList['*'].push(myCustomRegex)

If you want to bypass our sanitizer because you prefer to use a dedicated library, for exampleDOMPurify, you should do the following:

constyourTooltipEl=document.querySelector('#yourTooltip')consttooltip=newcoreui.Tooltip(yourTooltipEl,{sanitizeFn(content){returnDOMPurify.sanitize(content)}})

Optionally using jQuery

You don’t need jQuery in CoreUI for Bootstrap, but it’s still possible to use our components with jQuery. If CoreUI for Bootstrap detectsjQuery in thewindow object, it’ll add all of our components in jQuery’s plugin system. This allows you to do the following:

// to enable tooltips with the default configuration$('[data-coreui-toggle="tooltip"]').tooltip()// to initialize tooltips with given configuration$('[data-coreui-toggle="tooltip"]').tooltip({boundary:'clippingParents',customClass:'myClass'})// to trigger the `show` method$('#myTooltip').tooltip('show')

The same goes for our other components.

No conflict

Sometimes it is necessary to use CoreUI for Bootstrap plugins with other UI frameworks. In these circumstances, namespace collisions can occasionally occur. If this happens, you may call.noConflict on the plugin you wish to revert the value of.

constcoreuiButton=$.fn.button.noConflict()// return $.fn.button to previously assigned value$.fn.coreuiBtn=coreuiButton// give $().coreuiBtn the CoreUI for Bootstrap functionality

CoreUI for Bootstrap does not officially support third-party JavaScript libraries like Prototype or jQuery UI. Despite.noConflict and namespaced events, there may be compatibility problems that you need to fix on your own.

jQuery events

CoreUI for Bootstrap will detect jQuery ifjQuery is present in thewindow object and there is nodata-coreui-no-jquery attribute set on<body>. If jQuery is found, CoreUI for Bootstrap will emit events thanks to jQuery’s event system. So if you want to listen to CoreUI for Bootstrap’s events, you’ll have to use the jQuery methods (.on,.one) instead ofaddEventListener.

$('#myTab a').on('shown.coreui.tab',()=>{// do something...})

Disabled JavaScript

CoreUI for Bootstrap’s plugins have no special fallback when JavaScript is disabled. If you care about the user experience in this case, use<noscript> to explain the situation (and how to re-enable JavaScript) to your users, and/or add your own custom fallbacks.

Movatterモバイル変換