Class Yiisoft\Assets\AssetBundle

If {@see $sourcePath} is set, this property will be overwritten by {@see \Yiisoft\Assets\AssetManager} when it publishes the asset files from {@see $sourcePath}.

You can use either a directory or an alias of the directory.

If {@see $sourcePath} is set, this property will be overwritten by {@see \Yiisoft\Assets\AssetManager} when it publishes the asset files from {@see $sourcePath}.

You can use either a URL or an alias of the URL.

Example: Dart SASS CSS minifier.

public array $converterOptions = [

 'scss' => [
     'command' => '-I {path} --style compressed',
     'path' => '@root/tests/public/sourcepath/sass'
 ],

];

• An absolute URL representing an external asset. For example, https://cdn.jsdelivr.net/npm/bulma@0.9.2/css/bulma.min.css or //cdn.jsdelivr.net/npm/bulma@0.9.2/css/bulma.min.css.
• A relative path representing a local asset (e.g. css/main.css). The actual file path of a local asset can be determined by prefixing {@see $basePath} to the relative path, and the actual URL of the asset can be determined by prefixing {@see $baseUrl} to the relative path.
• An array, with the first entry being the URL or relative path as described before, and a list of key/value pairs that will be used to overwrite {@see $cssOptions} settings for this entry.

Note that only / should be used as directory separator.

Optionally, string keys could be used for CSS file identifiers. If key is not set, full CSS file URL is used as the key.

Example:

public array $css = [
    'https://cdn.jsdelivr.net/npm/bulma@0.9.2/css/bulma.min.css',
    'css/main.css',
    ['css/a.css'],
    ['css/b.css', 3],
    ['css/c.css', 3, 'crossorigin' => 'any'],
    'key' => 'css/d.css',
]

When this package is used with yiisoft/view, the possible values are:

• {@see \Yiisoft\View\WebView::POSITION_HEAD} - in the head section. This is the default value.
• {@see \Yiisoft\View\WebView::POSITION_BEGIN} - at the beginning of the body section.
• {@see \Yiisoft\View\WebView::POSITION_END} - at the end of the body section.

• CSS block string. For example, a { color: red; }.
• An array, with CSS block string as the first element and, optionally, position on the page as the second element. Additionally, extra options could be specified. Position will overwrite {@see $cssPosition}. A list of key-value options will overwrite {@see $cssOptions} for this CSS block.

Optionally, string keys could be used for CSS blocks.

Example:

public array $cssString = [
    'a { color: red; }',
    ['a { color: red; }'],
    ['a { color: red; }', 3],
    ['a { color: red; }', 3, 'crossorigin' => 'any'],
    'key1' => 'a { color: red; }',
    'key2' => ['a { color: red; }'],
    'key3' => ['a { color: red; }', 3],
    'key4' => ['a { color: red; }', 3, 'crossorigin' => 'any'],
];

For example:

public array $depends = [
    Yiisoft\Yii\Bootstrap5\Assets\BootstrapAsset:class,
    Yiisoft\Yii\Bulma\Asset\BulmaAsset:class,
]:

If the array is empty, the file paths from the {@see $css} and {@see $js} will be exported. See {@see \Yiisoft\Assets\AssetUtil::extractFilePathsForExport()}.

For example:

public array $export = [
    'img/image.png',
    'css/style.css',
    'js/script.js',
]:

Each JavaScript file can be specified in one of the following formats:

• an absolute URL representing an external asset. For example, https://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js or //ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js.
• a relative path representing a local asset (e.g. js/main.js). The actual file path of a local asset can be determined by prefixing {@see $basePath} to the relative path, and the actual URL of the asset can be determined by prefixing {@see $baseUrl} to the relative path.
• an array, with the first entry being the URL or relative path as described before, and a list of key => value pairs that will be used to overwrite {@see $jsOptions} settings for this entry.

Note that only a forward slash "/" should be used as directory separator.

When this package is used with yiisoft/view, the possible values are:

• {@see \Yiisoft\View\WebView::POSITION_HEAD} - in the head section. This is the default value for JavaScript variables.
• {@see \Yiisoft\View\WebView::POSITION_BEGIN} - at the beginning of the body section.
• {@see \Yiisoft\View\WebView::POSITION_END} - at the end of the body section. This is the default value for JavaScript files and blocks.
• {@see \Yiisoft\View\WebView::POSITION_READY} - at the end of the body section (only for JavaScript strings and variables). This means the JavaScript code block will be executed when HTML document composition is ready.
• {@see \Yiisoft\View\WebView::POSITION_LOAD} - at the end of the body section (only for JavaScript strings and variables). This means the JavaScript code block will be executed when HTML page is completely loaded.

• JS block string. For example, alert(42);.
• An array, with JS block string as the first element and, optionally, position on the page as the second element. Additionally, extra options could be specified. Position will overwrite {@see $jsPosition}. A list of key-value options will overwrite {@see $jsOptions} for this JS block.

Optionally, string keys could be used for JS blocks.

Example:

public array $jsStrings = [
    'alert(1);',
    ['alert(2);'],
    ['alert(3);', 3],
    ['alert(4);', 3, 'id' => 'main'],
    'key1' => 'alert(5);',
    'key2' => ['alert(6);'],
    'key3' => ['alert(7);', 3],
    'key4' => ['alert(8);', 3, 'id' => 'second'],
];

• A key/value pair where the key is variable name and the value is variable value.
• An array, with the variable name as the first element and, optionally, position on the page as the second element. Position will overwrite {@see $jsPosition} for this set of variables.

Example:

public array $jsVars = [
    'var1' => 'value1',
    ['var2', 'value2', 3],
];

Available options:

• forceCopy (bool)
• afterCopy (callable)
• beforeCopy (callable)
• filter (PathMatcherInterface)
• recursive (bool)

A source asset file is a file that is part of your source code repository of your Web application. You must set this property if the directory containing the source asset files is not Web accessible.

If a publisher is set via {@see \Yiisoft\Assets\AssetManager::withPublisher()}, {@see \Yiisoft\Assets\AssetManager} will publish the source asset files to a Web-accessible directory automatically when the asset bundle is registered on a page.

If you do not set this property, it means the source asset files are located under {@see $basePath}.

You can use either a directory or an alias of the directory.

{@see $publishOptions}