BootstrapPluginAsset

API reference › Bootstrap 6 › asset › BootstrapPluginAsset

final class	`yii2\extensions\bootstrap6\asset\BootstrapPluginAsset`
Extends	`AbstractNpmAsset` » `yii\web\AssetBundle` » `yii\base\BaseObject`
Implements	`yii\base\Configurable`
Source	`src/asset/BootstrapPluginAsset.php`

Delivers the Bootstrap 6 JavaScript bundle as an ES module, with Floating UI and Vanilla Calendar Pro inlined.

The bundle exposes no global; scripts access the plugins through import() of moduleUrl(), or through window.bootstrap when $exposeGlobal is enabled.

Properties

Property	Type	Description	Defined by
`$basePath`	`string\|null`	The Web-accessible directory that contains the asset files in this bundle. Default: `null`.	`yii\web\AssetBundle`
`$baseUrl`	`string\|null`	The base URL for the relative asset files listed in `$js` and `$css`. Default: `null`.	`yii\web\AssetBundle`
`$cdn`	`bool`	Whether to link the files from the CDN instead of publishing the local package. Default: `false`.	`AbstractNpmAsset`
`$cdnUrl`	`string`	Base URL of the CDN serving npm packages as `{cdnUrl}/{package}@{version}/{directory}/{file}`. Default: `'https://cdn.jsdelivr.net/npm'`.	`AbstractNpmAsset`
`$css`	`array<string\|array<array-key, mixed>>`	List of CSS files that this bundle contains. Default: `[]`.	`yii\web\AssetBundle`
`$cssOptions`	`yii\web\RegisterCssFileOptions`	The options that will be passed to `View::registerCssFile()` when registering the CSS files in this bundle. Default: `[]`.	`yii\web\AssetBundle`
`$depends`	`array<class-string>`	List of bundle class names that this bundle depends on. Default: `[]`.	`yii\web\AssetBundle`
`$exposeGlobal`	`bool`	Whether to assign the module namespace to `window.bootstrap` for scripts written against the global. Default: `false`.	`BootstrapPluginAsset`
`$js`	`array<string\|array<array-key, mixed>>`	List of JavaScript files that this bundle contains. Default: `[]`.	`yii\web\AssetBundle`
`$jsOptions`	`yii\web\RegisterJsFileOptions`	The options that will be passed to `View::registerJsFile()` when registering the JS files in this bundle. Default: `[]`.	`yii\web\AssetBundle`
`$minified`	`bool\|null`	Whether to serve the minified files, or `null` to serve them outside debug mode. Default: `null`.	`AbstractNpmAsset`
`$publishOptions`	`yii\web\PublishOptions`	The options to be passed to `AssetManager::publish()` when the asset bundle is being published. Default: `[]`.	`yii\web\AssetBundle`
`$sourcePath`	`string\|null`	The directory that contains the source asset files for this asset bundle. Default: `null`.	`yii\web\AssetBundle`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`yii\base\BaseObject`
`__get()`	Returns the value of an object property.	`yii\base\BaseObject`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\BaseObject`
`__set()`	Sets value of an object property.	`yii\base\BaseObject`
`__unset()`	Sets an object property to null.	`yii\base\BaseObject`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\BaseObject`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\BaseObject`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`dependencies()` static		`BootstrapPluginAsset`
`hasMethod()`	Returns a value indicating whether a method is defined.	`yii\base\BaseObject`
`hasProperty()`	Returns a value indicating whether a property is defined.	`yii\base\BaseObject`
`importJs()`	Returns JavaScript that imports the bundle module and runs the given code with the module namespace bound to `bootstrap`.	`BootstrapPluginAsset`
`init()`	Initializes the bundle and forces `type="module"` on its script tag, keeping the other configured options.	`BootstrapPluginAsset`
`moduleUrl()`	Returns the bundle script URL exactly as the view registers it, so `import()` evaluates the same module.	`BootstrapPluginAsset`
`publish()`	Publishes the asset bundle if its source code is not under Web-accessible directory.	`yii\web\AssetBundle`
`register()` static	Registers this asset bundle with a view.	`yii\web\AssetBundle`
`registerAssetFiles()`		`BootstrapPluginAsset`
`registerWith()` static	Registers the bundle, and its npm-backed dependencies, with the given delivery mode.	`AbstractNpmAsset`
`directory()` protected		`BootstrapPluginAsset`
`package()` protected		`BootstrapPluginAsset`
`publishPatterns()` protected	Returns additional publish patterns, relative to `directory()`, for files referenced by the stylesheets.	`AbstractNpmAsset`
`scripts()` protected		`BootstrapPluginAsset`
`styles()` protected	Returns the stylesheet paths relative to `directory()`, without the `.min` infix.	`AbstractNpmAsset`

Method details

dependencies()

public static function dependencies(): array

Returns

array

importJs()

public function importJs(yii\web\View $view, string $code): string

Returns JavaScript that imports the bundle module and runs the given code with the module namespace bound to bootstrap.

The module URL is a JSON string literal safe inside a <script> element, with forward slashes kept readable.

Parameters

Parameter	Type	Description
`$view`	`yii\web\View`	View the bundle is registered with.
`$code`	`string`	JavaScript statements that use the `bootstrap` namespace.

Returns

string: JavaScript in the form import("url").then((bootstrap) => { code });.

init()

public function init(): void

Initializes the bundle and forces type="module" on its script tag, keeping the other configured options.

moduleUrl()

public function moduleUrl(yii\web\View $view): string

Returns the bundle script URL exactly as the view registers it, so import() evaluates the same module.

Parameters

Parameter	Type	Description
`$view`	`yii\web\View`	View the bundle is registered with.

Returns

string: Script URL, including the timestamp query when the asset manager appends one.

Throws

yii\base\InvalidConfigException: if the bundle does not list a script.

registerAssetFiles()

public function registerAssetFiles(yii\web\View $view): void

Parameters

Parameter	Type	Description
`$view`	`yii\web\View`	View that renders the asset files.

directory()

protected function directory(): string

Returns

string

package()

protected function package(): string

Returns

string

scripts()

protected function scripts(): array

Returns

array