Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aggarwal-h/bulma-darkify
Your Bulma project, now with customizable dark-mode support.
https://github.com/aggarwal-h/bulma-darkify
bulma customizable dark-mode
Last synced: 28 days ago
JSON representation
Your Bulma project, now with customizable dark-mode support.
- Host: GitHub
- URL: https://github.com/aggarwal-h/bulma-darkify
- Owner: aggarwal-h
- License: mit
- Created: 2023-08-19T13:10:18.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-21T13:47:20.000Z (over 1 year ago)
- Last Synced: 2024-02-22T17:05:22.110Z (10 months ago)
- Topics: bulma, customizable, dark-mode
- Language: SCSS
- Homepage:
- Size: 81.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Bulma Darkify 🌗
Add a touch of darkness to your Bulma-powered websites. This project allows you to embrace the dark side of web design while maintaining the sleekness of Bulma's UI framework. Say goodbye to bright lights and welcome the relaxing warmth of dark mode.
## Features
- Fully customizable dark mode support.
- Ability to toggle between light and dark modes using the `[data-theme]` attribute.
- Compatibile with your existing Bulma styles.
## Getting Started
### Installation
```bash
pnpm add -D bulma-darkify
```
or
```bash
npm install bulma-darkify --save-dev
```
or
```bash
yarn add -D bulma-darkify
```
### Import
#### Full Import (Larger Bundle Size)
Include the provided SCSS file into your existing SASS/SCSS file:
```scss
@import "bulma/bulma";
// Import your own dark mode variables
@import "your-dark-mode-variables";
@import "bulma-darkify/bulma-darkify";
```
#### Modular Import (Smaller Bundle Size)
Include only the SCSS files that you need:
```scss
// Import the relevant Bulma files before importing from bulma-darkify
@import "bulma/sass/utilities/_all";
@import "bulma/sass/elements/button";
// Import your own dark mode variables
@import "your-dark-mode-variables";
// Import from bulma-darkify
@import "bulma-darkify/scss/utilities/_all";
@include color-mode(dark) {
@import "bulma-darkify/scss/elements/button";
}
```
### Use
To use the dark mode, add the `data-theme` attribute to your HTML tag. For example:
```html
```
### Toggle
To toggle between themes, simply change this attribute to `light`:
```html
```
### Customization
This library does not come with predefined styles for dark mode. This means that you will need to define how you want the dark mode styles to appear. To do this, follow Bulma's guide on customization using SASS variables: https://bulma.io/documentation/customize/variables/.
Then, append your style names with `-dark`.
For example, to change a button's default background color in light mode, you would normally define a variable like:
```scss
$button-background-color: #YOUR-COLOR-HERE
```
For dark mode, you can change the button's background color by simply adding `-dark` to this variable name:
```scss
$button-background-color-dark: #YOUR-COLOR-HERE
```
## Contributing
Contributions from the community are welcomed! If you encounter a bug, have a feature request, or want to enhance this library, please open a [pull request](https://github.com/aggarwal-h/bulma-darkify/pulls)
## License
This project is under the [MIT](LICENSE) license. Feel free to use, modify, and distribute it as you please.
---