bootstrap-auto-dark-mode/README.md
2025-01-11 21:08:33 +01:00

31 lines
1,008 B
Markdown

# bootstrap-auto-dark-mode
This script adds the missing auto-dark mode to the new theme feature of Bootstrap 5.3.
It switches the Bootstrap theme automatically between light and dark mode, depending on the system settings, if you set the `data-bs-theme` attribute of your <html> to `auto`.
## References
- [Demo page](https://shaack.com/projekte/bootstrap-auto-dark-mode/)
- [GitHub repository](https://github.com/shaack/bootstrap-auto-dark-mode)
- [npm package](https://www.npmjs.com/package/bootstrap-auto-dark-mode)
## Usage
Use it by just including `bootstrap-auto-dark-mode.js` in your header and setting `data-bs-theme` to `auto`.
```html
<html lang="en" data-bs-theme="auto">
<head>
<!-- your code -->
<script src="./src/bootstrap-auto-dark-mode.js"></script>
</head>
<!-- your code -->
<!-- […] -->
```
---
Find more high quality modules from [shaack.com](https://shaack.com)
on [our projects page](https://shaack.com/works).