Bootstrap 5
Admin pages built on Bootstrap 5 need the same few things: a way to show messages, tooltips on controls, and components such as tabs and modals. Unicorn JS provides these through one Bootstrap 5 integration. It installs a message theme for the UI helpers, and it exposes helpers for Bootstrap components.
Enabling Bootstrap 5
Call useUIBootstrap5() once at startup. The first argument installs the Bootstrap 5 theme. The second argument also exposes the Bootstrap module as window.bootstrap:
import { useUIBootstrap5 } from '@windwalker-io/unicorn-next';
await useUIBootstrap5(true, true);Calling the function without arguments returns the shared instance without installing it:
const bs5 = await useUIBootstrap5();
// The Bootstrap module bundled with the package.
const { Modal, Tooltip } = bs5.bootstrap;INFO
The bundled module is used by Unicorn JS. Your own scripts can use window.bootstrap only when the second argument is true.
Complete Example
The following entry file sets up Bootstrap 5 for a settings page. It adds tooltips, remembers the active tab, and shows a message after load:
import {
renderMessage,
useBs5KeepTab,
useBs5Tooltip,
useUIBootstrap5,
} from '@windwalker-io/unicorn-next';
await useUIBootstrap5(true, true);
await useBs5Tooltip();
await useBs5KeepTab('#settings-tabs');
renderMessage('Settings loaded.', 'success');Messages
With the Bootstrap 5 theme installed, renderMessage() and clearMessages() show alerts inside the element with the class c-messages-container. The message type becomes the alert class, such as success, info, warning, or danger:
<div class="c-messages-container"></div>import { renderMessage } from '@windwalker-io/unicorn-next';
renderMessage(['Upload failed.', 'File is too large.'], 'danger');WARNING
Each message is inserted as HTML. Do not pass user input or data from a request without escaping it first, because it can run scripts on the page.
INFO
When the page has no .c-messages-container element, the message is not shown and no error is raised.
The full set of message helpers, and how to replace the theme, is described in UI Helpers.
Tooltips
useBs5Tooltip() attaches Bootstrap tooltips to matching elements. The default selector is [data-bs-toggle="tooltip"]:
<button data-bs-toggle="tooltip" title="Save the draft">Save</button>import { useBs5Tooltip } from '@windwalker-io/unicorn-next';
await useBs5Tooltip();
// A custom selector and Bootstrap tooltip options.
await useBs5Tooltip('.js-help', { placement: 'right' });TIP
Each element keeps one tooltip instance. Call useBs5Tooltip() again after you add elements to the page, so the new elements get tooltips.
Components
Unicorn JS provides helpers for these Bootstrap components:
- Keep Tab: remembers the active tab across page loads.
- Button Radio: turns a radio group into buttons.
- Modal Alert: shows a confirmation in a Bootstrap modal.
- Iframe Modal: loads a page inside a modal.