Newer
Older
Florent Torregrosa
committed
A site-builder friendly [Bootstrap](https://getbootstrap.com/) theme for
Florent Torregrosa
committed
Drupal, using the [UI Suite](https://www.drupal.org/project/ui_suite) approach.
Florent Torregrosa
committed
Use Bootstrap directly from Drupal backoffice (layout builder, manage display,
Florent Torregrosa
committed
views, blocks...).
Florent Torregrosa
committed
See the [docs](./docs) folder for more detailed documentation on:
- [details element](./docs/Details.md)
- [form API](./docs/Forms.md)
- [modal](./docs/Modal.md)
- [what is out of scope](./docs/Out-of-scope.md)
Florent Torregrosa
committed
## Requirements
Florent Torregrosa
committed
This theme requires the following modules:
- [Layout Options](https://www.drupal.org/project/layout_options)
Florent Torregrosa
committed
- [UI Patterns](https://www.drupal.org/project/ui_patterns)
Florent Torregrosa
committed
- [UI Styles](https://www.drupal.org/project/ui_styles)
Florent Torregrosa
committed
This theme requires the Bootstrap library to be placed in the `libraries`
folder.
Florent Torregrosa
committed
Optionally, this theme provides integration with
[Bootstrap icons](https://icons.getbootstrap.com), icons needs to be placed in
the `libraries` folder.
Florent Torregrosa
committed
### Install libraries manually
Florent Torregrosa
committed
You can download the Bootstrap library on its
[GitHub](https://github.com/twbs/bootstrap) page.
Florent Torregrosa
committed
You can download the Bootstrap icons library on its
[GitHub](https://github.com/twbs/icons) page.
### Install libraries with Composer
Florent Torregrosa
committed
#### With Asset Packagist
Florent Torregrosa
committed
If you are using the website [Asset Packagist](https://asset-packagist.org), the
composer.json can be like:
```json
{
Florent Torregrosa
committed
"require": {
"composer/installers": "2.*",
"oomphinc/composer-installers-extender": "2.*",
Florent Torregrosa
committed
"npm-asset/bootstrap": "5.3.3",
"npm-asset/bootstrap-icons": "1.11.3"
Florent Torregrosa
committed
},
"repositories": {
"asset-packagist": {
"type": "composer",
"url": "https://asset-packagist.org"
}
Florent Torregrosa
committed
},
Florent Torregrosa
committed
"extra": {
"installer-paths": {
"app/libraries/{$name}": [
"type:drupal-library",
"type:bower-asset",
"type:npm-asset"
]
},
"installer-types": [
"bower-asset",
"npm-asset"
]
}
Florent Torregrosa
committed
}
```
Florent Torregrosa
committed
This version of Bootstrap will only contain compiled CSS/JS and SASS files.
Florent Torregrosa
committed
#### With a package repository
Florent Torregrosa
committed
You can declare a custom [package repositories](https://getcomposer.org/doc/05-repositories.md#package-2),
Example:
```json
{
Florent Torregrosa
committed
"require": {
Florent Torregrosa
committed
"asset/bootstrap": "5.3.3",
Florent Torregrosa
committed
"asset/bootstrap-icons": "1.11.3",
Florent Torregrosa
committed
"composer/installers": "2.*"
},
"repositories": {
"asset-bootstrap": {
"type": "package",
"package": {
"name": "asset/bootstrap",
"version": "5.3.3",
Florent Torregrosa
committed
"type": "drupal-library",
"extra": {
"installer-name": "bootstrap"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/twbs/bootstrap/zipball/6e1f75f420f68e1d52733b8e407fc7c3766c9dba",
"reference": "6e1f75f420f68e1d52733b8e407fc7c3766c9dba"
Florent Torregrosa
committed
}
}
Florent Torregrosa
committed
},
"asset-bootstrap-icons": {
"type": "package",
"package": {
"name": "asset/bootstrap-icons",
"version": "1.11.3",
"type": "drupal-library",
"extra": {
"installer-name": "bootstrap-icons"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/twbs/icons/zipball/8d88686c03c3768a2d82ba4f20c3c4e1b100fa29",
"reference": "8d88686c03c3768a2d82ba4f20c3c4e1b100fa29"
}
}
Florent Torregrosa
committed
}
},
"extra": {
"installer-paths": {
"app/libraries/{$name}": [
"type:drupal-library"
]
}
}
}
```
Florent Torregrosa
committed
This version will contain compiled CSS/JS and SASS files as well as all the
files used on for the development of Bootstrap.
Florent Torregrosa
committed
## Installation
Install as you would normally install a contributed Drupal theme. For further
information, see
[Installing Drupal Themes](https://www.drupal.org/docs/extending-drupal/themes/installing-themes).
## Configuration
The theme has no menu or modifiable settings on its own.
Configuration is provided by the UI Suite ecosystem modules.
## Maintainers
Current maintainers:
- Florent Torregrosa - [Grimreaper](https://www.drupal.org/user/2388214)
- Pierre Dureau - [pdureau](https://www.drupal.org/user/1903334)
- Michael Fanini - [G4MBINI](https://www.drupal.org/user/2533498)
Supporting organizations:
- [Smile](https://www.drupal.org/smile)