NAME

Mojolicious::Plugin::Bootstrap3 - DEPRECATED

VERSION

3.3601

DESCRIPTION

Mojolicious::Plugin::Bootstrap3 will be DEPRECATED.

Use Mojolicious::Plugin::AssetPack directly instead:

Basic:

use Mojolicious::Lite;
plugin "AssetPack";

$self->asset->process(
  "bootstrap.css" => "http://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css"
);
$self->asset->process(
  "bootstrap.js" => "http://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js");
);

Sass support:

$self->asset->process(
  "bootstrap.css" => "https://github.com/twbs/bootstrap-sass/blob/master/assets/stylesheets/_bootstrap.scss"
);

The above will download all the included resources.

METHODS

asset_path

$path = Mojolicious::Plugin::Bootstrap3->asset_path($type);
$path = $self->asset_path($type);

Returns the base path to the assets bundled with this module.

Set $type to "sass" if you want a return value that is suitable for the SASS_PATH environment variable.

register

$app->plugin(
  bootstrap3 => {
    css    => [qw( bootstrap.scss )],
    js     => [qw( button.js collapse.js ... )],
    custom => 0,
    jquery => 1,
    theme  => undef,
  },
);

Default values:

  • css: bootstrap.scss

    The name of the files to include in the asset named bootstrap.css.

    Specify an empty list to disable building bootstrap.css.

  • js

    affix.js, alert.js, button.js, carousel.js, collapse.js, dropdown.js, modal.js, popover.js, scrollspy.js, tab.js, tooltip.js and transition.js.

    The name of the files to include in the asset named bootstrap.js.

    Specify an empty list to disable building bootstrap.js.

  • custom

    Disabled by default. Will copy sass/bootstrap.scss to your project if true and set SASS_PATH to the appropriate paths.

  • jquery

    This will include the bundled jQuery version in the bootstrap.js asset. Set this to 0 if you include your own jQuery.

  • theme

    Specifying a theme will override "custom" and "css".

    See "Themes".

CREDITS

bootstrap-sass has a number of major contributors:

Thomas McDonald
Tristan Harward
Peter Gumeson
Gleb Mazovetskiy

and a significant number of other contributors

LICENSE

Bootstrap is licensed under MIT

Mojolicious is licensed under Artistic License version 2.0 and so is this code.

AUTHOR

Jan Henning Thorsen - jhthorsen@cpan.org